summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2020-06-03 18:16:39 (GMT)
committerGitHub <noreply@github.com>2020-06-03 18:16:39 (GMT)
commit6d62dc1ea4e191b8486e80a85ca0694215375424 (patch)
treec8e424712610a6f281e4b566e5e854103eea9ecb
parent5d2396c8cf68fba0a949c6ce474a505e3aba9c1f (diff)
downloadcpython-6d62dc1ea4e191b8486e80a85ca0694215375424.zip
cpython-6d62dc1ea4e191b8486e80a85ca0694215375424.tar.gz
cpython-6d62dc1ea4e191b8486e80a85ca0694215375424.tar.bz2
[3.9] bpo-40826: PyOS_InterruptOccurred() requires GIL (GH-20578) (GH-20618)
* bpo-40826: Add _Py_EnsureTstateNotNULL() macro (GH-20571) Add _Py_EnsureTstateNotNULL(tstate) macro: call Py_FatalError() if tstate is NULL, the error message contains the current function name. (cherry picked from commit 3026cad59b87751a9215111776cac8e819458fce) * bpo-40826: PyOS_InterruptOccurred() requires GIL (GH-20578) PyOS_InterruptOccurred() now fails with a fatal error if it is called with the GIL released. (cherry picked from commit cbe129692293251e7fbcea9ff0d822824d90c140)
-rw-r--r--Include/internal/pycore_pystate.h19
-rw-r--r--Lib/test/test_capi.py5
-rw-r--r--Misc/NEWS.d/next/C API/2020-06-01-16-12-37.bpo-40826.zQzFoK.rst2
-rw-r--r--Modules/signalmodule.c2
-rw-r--r--Python/ceval.c24
-rw-r--r--Python/errors.c2
-rw-r--r--Python/pystate.c18
-rw-r--r--Python/sysmodule.c2
8 files changed, 43 insertions, 31 deletions
diff --git a/Include/internal/pycore_pystate.h b/Include/internal/pycore_pystate.h
index a9515b4..835d6e0 100644
--- a/Include/internal/pycore_pystate.h
+++ b/Include/internal/pycore_pystate.h
@@ -74,6 +74,21 @@ _PyThreadState_GET(void)
#undef PyThreadState_GET
#define PyThreadState_GET() _PyThreadState_GET()
+PyAPI_FUNC(void) _Py_NO_RETURN _Py_FatalError_TstateNULL(const char *func);
+
+static inline void
+_Py_EnsureFuncTstateNotNULL(const char *func, PyThreadState *tstate)
+{
+ if (tstate == NULL) {
+ _Py_FatalError_TstateNULL(func);
+ }
+}
+
+// Call Py_FatalError() if tstate is NULL
+#define _Py_EnsureTstateNotNULL(tstate) \
+ _Py_EnsureFuncTstateNotNULL(__func__, tstate)
+
+
/* Get the current interpreter state.
The macro is unsafe: it does not check for error and it can return NULL.
@@ -84,7 +99,9 @@ _PyThreadState_GET(void)
and _PyGILState_GetInterpreterStateUnsafe(). */
static inline PyInterpreterState* _PyInterpreterState_GET(void) {
PyThreadState *tstate = _PyThreadState_GET();
- assert(tstate != NULL);
+#ifdef Py_DEBUG
+ _Py_EnsureTstateNotNULL(tstate);
+#endif
return tstate->interp;
}
diff --git a/Lib/test/test_capi.py b/Lib/test/test_capi.py
index 5c7526a..aad9239 100644
--- a/Lib/test/test_capi.py
+++ b/Lib/test/test_capi.py
@@ -67,7 +67,10 @@ class CAPITest(unittest.TestCase):
self.assertTrue(err.rstrip().startswith(
b'Fatal Python error: '
b'PyThreadState_Get: '
- b'current thread state is NULL (released GIL?)'))
+ b'the function must be called with the GIL held, '
+ b'but the GIL is released '
+ b'(the current Python thread state is NULL)'),
+ err)
def test_memoryview_from_NULL_pointer(self):
self.assertRaises(ValueError, _testcapi.make_memoryview_from_NULL_pointer)
diff --git a/Misc/NEWS.d/next/C API/2020-06-01-16-12-37.bpo-40826.zQzFoK.rst b/Misc/NEWS.d/next/C API/2020-06-01-16-12-37.bpo-40826.zQzFoK.rst
new file mode 100644
index 0000000..0d7a36c
--- /dev/null
+++ b/Misc/NEWS.d/next/C API/2020-06-01-16-12-37.bpo-40826.zQzFoK.rst
@@ -0,0 +1,2 @@
+:c:func:`PyOS_InterruptOccurred` now fails with a fatal error if it is
+called with the GIL released.
diff --git a/Modules/signalmodule.c b/Modules/signalmodule.c
index b3f5904..9041848 100644
--- a/Modules/signalmodule.c
+++ b/Modules/signalmodule.c
@@ -1784,7 +1784,7 @@ PyOS_FiniInterrupts(void)
int
_PyOS_InterruptOccurred(PyThreadState *tstate)
{
- assert(tstate != NULL);
+ _Py_EnsureTstateNotNULL(tstate);
if (!_Py_ThreadCanHandleSignals(tstate->interp)) {
return 0;
}
diff --git a/Python/ceval.c b/Python/ceval.c
index ff67c83..3392cd0 100644
--- a/Python/ceval.c
+++ b/Python/ceval.c
@@ -240,13 +240,13 @@ UNSIGNAL_ASYNC_EXC(PyInterpreterState *interp)
#endif
#include "ceval_gil.h"
-static void
-ensure_tstate_not_null(const char *func, PyThreadState *tstate)
+void _Py_NO_RETURN
+_Py_FatalError_TstateNULL(const char *func)
{
- if (tstate == NULL) {
- _Py_FatalErrorFunc(func,
- "current thread state is NULL (released GIL?)");
- }
+ _Py_FatalErrorFunc(func,
+ "the function must be called with the GIL held, "
+ "but the GIL is released "
+ "(the current Python thread state is NULL)");
}
@@ -346,7 +346,7 @@ PyEval_AcquireLock(void)
{
_PyRuntimeState *runtime = &_PyRuntime;
PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
- ensure_tstate_not_null(__func__, tstate);
+ _Py_EnsureTstateNotNULL(tstate);
take_gil(tstate);
}
@@ -375,7 +375,7 @@ _PyEval_ReleaseLock(PyThreadState *tstate)
void
PyEval_AcquireThread(PyThreadState *tstate)
{
- ensure_tstate_not_null(__func__, tstate);
+ _Py_EnsureTstateNotNULL(tstate);
take_gil(tstate);
@@ -410,7 +410,7 @@ void
_PyEval_ReInitThreads(_PyRuntimeState *runtime)
{
PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
- ensure_tstate_not_null(__func__, tstate);
+ _Py_EnsureTstateNotNULL(tstate);
struct _gil_runtime_state *gil = &runtime->ceval.gil;
if (!gil_created(gil)) {
@@ -445,7 +445,7 @@ PyEval_SaveThread(void)
{
_PyRuntimeState *runtime = &_PyRuntime;
PyThreadState *tstate = _PyThreadState_Swap(&runtime->gilstate, NULL);
- ensure_tstate_not_null(__func__, tstate);
+ _Py_EnsureTstateNotNULL(tstate);
struct _ceval_runtime_state *ceval = &runtime->ceval;
struct _ceval_state *ceval2 = &tstate->interp->ceval;
@@ -457,7 +457,7 @@ PyEval_SaveThread(void)
void
PyEval_RestoreThread(PyThreadState *tstate)
{
- ensure_tstate_not_null(__func__, tstate);
+ _Py_EnsureTstateNotNULL(tstate);
take_gil(tstate);
@@ -889,7 +889,7 @@ eval_frame_handle_pending(PyThreadState *tstate)
PyObject* _Py_HOT_FUNCTION
_PyEval_EvalFrameDefault(PyThreadState *tstate, PyFrameObject *f, int throwflag)
{
- ensure_tstate_not_null(__func__, tstate);
+ _Py_EnsureTstateNotNULL(tstate);
#ifdef DXPAIRS
int lastopcode = 0;
diff --git a/Python/errors.c b/Python/errors.c
index 70365aa..5d17256 100644
--- a/Python/errors.c
+++ b/Python/errors.c
@@ -1426,7 +1426,7 @@ void
_PyErr_WriteUnraisableMsg(const char *err_msg_str, PyObject *obj)
{
PyThreadState *tstate = _PyThreadState_GET();
- assert(tstate != NULL);
+ _Py_EnsureTstateNotNULL(tstate);
PyObject *err_msg = NULL;
PyObject *exc_type, *exc_value, *exc_tb;
diff --git a/Python/pystate.c b/Python/pystate.c
index dd95750..071b976 100644
--- a/Python/pystate.c
+++ b/Python/pystate.c
@@ -39,16 +39,6 @@ extern "C" {
_Py_atomic_store_relaxed(&(gilstate)->tstate_current, \
(uintptr_t)(value))
-static void
-ensure_tstate_not_null(const char *func, PyThreadState *tstate)
-{
- if (tstate == NULL) {
- _Py_FatalErrorFunc(func,
- "current thread state is NULL (released GIL?)");
- }
-}
-
-
/* Forward declarations */
static PyThreadState *_PyGILState_GetThisThreadState(struct _gilstate_runtime_state *gilstate);
static void _PyThreadState_Delete(PyThreadState *tstate, int check_current);
@@ -431,7 +421,7 @@ PyInterpreterState *
PyInterpreterState_Get(void)
{
PyThreadState *tstate = _PyThreadState_GET();
- ensure_tstate_not_null(__func__, tstate);
+ _Py_EnsureTstateNotNULL(tstate);
PyInterpreterState *interp = tstate->interp;
if (interp == NULL) {
Py_FatalError("no current interpreter");
@@ -846,7 +836,7 @@ static void
tstate_delete_common(PyThreadState *tstate,
struct _gilstate_runtime_state *gilstate)
{
- ensure_tstate_not_null(__func__, tstate);
+ _Py_EnsureTstateNotNULL(tstate);
PyInterpreterState *interp = tstate->interp;
if (interp == NULL) {
Py_FatalError("NULL interpreter");
@@ -897,7 +887,7 @@ PyThreadState_Delete(PyThreadState *tstate)
void
_PyThreadState_DeleteCurrent(PyThreadState *tstate)
{
- ensure_tstate_not_null(__func__, tstate);
+ _Py_EnsureTstateNotNULL(tstate);
struct _gilstate_runtime_state *gilstate = &tstate->interp->runtime->gilstate;
tstate_delete_common(tstate, gilstate);
_PyRuntimeGILState_SetThreadState(gilstate, NULL);
@@ -967,7 +957,7 @@ PyThreadState *
PyThreadState_Get(void)
{
PyThreadState *tstate = _PyThreadState_GET();
- ensure_tstate_not_null(__func__, tstate);
+ _Py_EnsureTstateNotNULL(tstate);
return tstate;
}
diff --git a/Python/sysmodule.c b/Python/sysmodule.c
index 914beb7..e3fe143 100644
--- a/Python/sysmodule.c
+++ b/Python/sysmodule.c
@@ -457,7 +457,7 @@ static PyObject *
sys_audit(PyObject *self, PyObject *const *args, Py_ssize_t argc)
{
PyThreadState *tstate = _PyThreadState_GET();
- assert(tstate != NULL);
+ _Py_EnsureTstateNotNULL(tstate);
if (argc == 0) {
_PyErr_SetString(tstate, PyExc_TypeError,