gh-128360: Add _Py_AssertHoldsTstate as assertion for holding a thread state (#128361)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
This commit is contained in:
Peter Bierma 2025-01-20 06:34:35 -05:00 committed by GitHub
parent c6b570e5e3
commit 4d0a6595a0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 48 additions and 32 deletions

View file

@ -995,7 +995,7 @@ _Py_unset_eval_breaker_bit_all(PyInterpreterState *interp, uintptr_t bit)
void
_Py_FinishPendingCalls(PyThreadState *tstate)
{
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
assert(_PyThreadState_CheckConsistency(tstate));
struct _pending_calls *pending = &tstate->interp->ceval.pending;
@ -1056,7 +1056,7 @@ _PyEval_MakePendingCalls(PyThreadState *tstate)
int
Py_MakePendingCalls(void)
{
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
PyThreadState *tstate = _PyThreadState_GET();
assert(_PyThreadState_CheckConsistency(tstate));

View file

@ -314,8 +314,8 @@ _PyErr_SetLocaleString(PyObject *exception, const char *string)
PyObject* _Py_HOT_FUNCTION
PyErr_Occurred(void)
{
/* The caller must hold the GIL. */
assert(PyGILState_Check());
/* The caller must hold a thread state. */
_Py_AssertHoldsTstate();
PyThreadState *tstate = _PyThreadState_GET();
return _PyErr_Occurred(tstate);

View file

@ -1,6 +1,7 @@
#include "Python.h"
#include "pycore_fileutils.h" // fileutils definitions
#include "pycore_runtime.h" // _PyRuntime
#include "pycore_pystate.h" // _Py_AssertHoldsTstate()
#include "osdefs.h" // SEP
#include <stdlib.h> // mbstowcs()
@ -1311,7 +1312,7 @@ _Py_fstat(int fd, struct _Py_stat_struct *status)
{
int res;
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
Py_BEGIN_ALLOW_THREADS
res = _Py_fstat_noraise(fd, status);
@ -1691,7 +1692,7 @@ int
_Py_open(const char *pathname, int flags)
{
/* _Py_open() must be called with the GIL held. */
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
return _Py_open_impl(pathname, flags, 1);
}
@ -1766,7 +1767,7 @@ _Py_wfopen(const wchar_t *path, const wchar_t *mode)
FILE*
Py_fopen(PyObject *path, const char *mode)
{
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
if (PySys_Audit("open", "Osi", path, mode, 0) < 0) {
return NULL;
@ -1881,7 +1882,7 @@ _Py_read(int fd, void *buf, size_t count)
int err;
int async_err = 0;
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
/* _Py_read() must not be called with an exception set, otherwise the
* caller may think that read() was interrupted by a signal and the signal
@ -2047,7 +2048,7 @@ _Py_write_impl(int fd, const void *buf, size_t count, int gil_held)
Py_ssize_t
_Py_write(int fd, const void *buf, size_t count)
{
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
/* _Py_write() must not be called with an exception set, otherwise the
* caller may think that write() was interrupted by a signal and the signal
@ -2675,7 +2676,7 @@ _Py_dup(int fd)
HANDLE handle;
#endif
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
#ifdef MS_WINDOWS
handle = _Py_get_osfhandle(fd);

View file

@ -491,8 +491,8 @@ int
_PyEval_SetProfile(PyThreadState *tstate, Py_tracefunc func, PyObject *arg)
{
assert(is_tstate_valid(tstate));
/* The caller must hold the GIL */
assert(PyGILState_Check());
/* The caller must hold a thread state */
_Py_AssertHoldsTstate();
/* Call _PySys_Audit() in the context of the current thread state,
even if tstate is not the current thread state. */
@ -586,8 +586,8 @@ int
_PyEval_SetTrace(PyThreadState *tstate, Py_tracefunc func, PyObject *arg)
{
assert(is_tstate_valid(tstate));
/* The caller must hold the GIL */
assert(PyGILState_Check());
/* The caller must hold a thread state */
_Py_AssertHoldsTstate();
/* Call _PySys_Audit() in the context of the current thread state,
even if tstate is not the current thread state. */

View file

@ -2897,7 +2897,6 @@ _PyInterpreterState_GetConfigCopy(PyConfig *config)
const PyConfig*
_Py_GetConfig(void)
{
assert(PyGILState_Check());
PyThreadState *tstate = current_fast_get();
_Py_EnsureTstateNotNULL(tstate);
return _PyInterpreterState_GetConfig(tstate->interp);

View file

@ -1,5 +1,6 @@
#include "Python.h"
#include "pycore_time.h" // PyTime_t
#include "pycore_pystate.h" // _Py_AssertHoldsTstate()
#include <time.h> // gmtime_r()
#ifdef HAVE_SYS_TIME_H
@ -897,14 +898,14 @@ _PyTime_AsTimespec(PyTime_t t, struct timespec *ts)
#endif
// N.B. If raise_exc=0, this may be called without the GIL.
// N.B. If raise_exc=0, this may be called without a thread state.
static int
py_get_system_clock(PyTime_t *tp, _Py_clock_info_t *info, int raise_exc)
{
assert(info == NULL || raise_exc);
if (raise_exc) {
// raise_exc requires to hold the GIL
assert(PyGILState_Check());
// raise_exc requires to hold a thread state
_Py_AssertHoldsTstate();
}
#ifdef MS_WINDOWS
@ -1142,14 +1143,14 @@ py_mach_timebase_info(_PyTimeFraction *base, int raise_exc)
#endif
// N.B. If raise_exc=0, this may be called without the GIL.
// N.B. If raise_exc=0, this may be called without a thread state.
static int
py_get_monotonic_clock(PyTime_t *tp, _Py_clock_info_t *info, int raise_exc)
{
assert(info == NULL || raise_exc);
if (raise_exc) {
// raise_exc requires to hold the GIL
assert(PyGILState_Check());
// raise_exc requires to hold a thread state
_Py_AssertHoldsTstate();
}
#if defined(MS_WINDOWS)

View file

@ -367,7 +367,7 @@ traceback_new(void)
traceback_t *traceback;
_Py_hashtable_entry_t *entry;
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
/* get frames */
traceback = tracemalloc_traceback;
@ -749,7 +749,7 @@ static void
tracemalloc_clear_traces_unlocked(void)
{
// Clearing tracemalloc_filenames requires the GIL to call Py_DECREF()
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
set_reentrant(1);
@ -1302,7 +1302,7 @@ PyTraceMalloc_Untrack(unsigned int domain, uintptr_t ptr)
void
_PyTraceMalloc_Fini(void)
{
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
tracemalloc_deinit();
}
@ -1323,7 +1323,7 @@ _PyTraceMalloc_TraceRef(PyObject *op, PyRefTracerEvent event,
return 0;
}
assert(PyGILState_Check());
_Py_AssertHoldsTstate();
TABLES_LOCK();
if (!tracemalloc_config.tracing) {