Skip to content

Commit

Permalink
Fix data races reported by TSAN on interp->threads.main
Browse files Browse the repository at this point in the history
Use relaxed loads/stores when reading/writing to this field.

This fixes races like https://gist.github.com/mpage/e07497ad8dd444a789ff306cb7996acc
  • Loading branch information
mpage committed May 9, 2024
1 parent 8af84b5 commit 50cf12b
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions Python/pystate.c
Original file line number Diff line number Diff line change
Expand Up @@ -1038,6 +1038,17 @@ _PyInterpreterState_DeleteExceptMain(_PyRuntimeState *runtime)
}
#endif

static inline void
set_main_thread(PyInterpreterState *interp, PyThreadState *tstate)
{
_Py_atomic_store_ptr_relaxed(&interp->threads.main, tstate);
}

static inline PyThreadState *
get_main_thread(PyInterpreterState *interp)
{
return _Py_atomic_load_ptr_relaxed(&interp->threads.main);
}

int
_PyInterpreterState_SetRunningMain(PyInterpreterState *interp)
Expand All @@ -1052,21 +1063,22 @@ _PyInterpreterState_SetRunningMain(PyInterpreterState *interp)
"current tstate has wrong interpreter");
return -1;
}
interp->threads.main = tstate;
set_main_thread(interp, tstate);

return 0;
}

void
_PyInterpreterState_SetNotRunningMain(PyInterpreterState *interp)
{
assert(interp->threads.main == current_fast_get());
interp->threads.main = NULL;
assert(get_main_thread(interp) == current_fast_get());
set_main_thread(interp, NULL);
}

int
_PyInterpreterState_IsRunningMain(PyInterpreterState *interp)
{
if (interp->threads.main != NULL) {
if (get_main_thread(interp) != NULL) {
return 1;
}
// Embedders might not know to call _PyInterpreterState_SetRunningMain(),
Expand All @@ -1082,18 +1094,15 @@ int
_PyThreadState_IsRunningMain(PyThreadState *tstate)
{
PyInterpreterState *interp = tstate->interp;
if (interp->threads.main != NULL) {
return tstate == interp->threads.main;
}
// See the note in _PyInterpreterState_IsRunningMain() about
// possible false negatives here for embedders.
return 0;
return get_main_thread(interp) == tstate;
}

int
_PyInterpreterState_FailIfRunningMain(PyInterpreterState *interp)
{
if (interp->threads.main != NULL) {
if (get_main_thread(interp) != NULL) {
PyErr_SetString(PyExc_InterpreterError,
"interpreter already running");
return -1;
Expand All @@ -1105,8 +1114,8 @@ void
_PyInterpreterState_ReinitRunningMain(PyThreadState *tstate)
{
PyInterpreterState *interp = tstate->interp;
if (interp->threads.main != tstate) {
interp->threads.main = NULL;
if (get_main_thread(interp) != tstate) {
set_main_thread(interp, NULL);
}
}

Expand Down

0 comments on commit 50cf12b

Please sign in to comment.