pythongh-137400: Fix a crash when disabling profiling across all threads (pythongh-137471)

colesbury · miss-islington · commit 77f9ca63e340 · 2025-08-11T15:41:55.000Z
The `PyEval_SetProfileAllThreads` function and other related functions had a race condition on `tstate->c_profilefunc` that could lead to a crash when disable profiling or tracing on all threads while another thread is starting to profile or trace a a call. There are still potential crashes when threads exit concurrently with profiling or tracing be enabled/disabled across all threads. (cherry picked from commit 3626928) Co-authored-by: Sam Gross <colesbury@gmail.com>
diff --git a/Lib/test/test_free_threading/test_monitoring.py b/Lib/test/test_free_threading/test_monitoring.py
@@ -194,6 +194,40 @@ def during_threads(self):
         self.set = not self.set
 
 
+@threading_helper.requires_working_threading()
+class SetProfileAllMultiThreaded(TestCase):
+    def test_profile_all_threads(self):
+        done = threading.Event()
+
+        def func():
+            pass
+
+        def bg_thread():
+            while not done.is_set():
+                func()
+                func()
+                func()
+                func()
+                func()
+
+        def my_profile(frame, event, arg):
+            return None
+
+        bg_threads = []
+        for i in range(10):
+            t = threading.Thread(target=bg_thread)
+            t.start()
+            bg_threads.append(t)
+
+        for i in range(100):
+            threading.setprofile_all_threads(my_profile)
+            threading.setprofile_all_threads(None)
+
+        done.set()
+        for t in bg_threads:
+            t.join()
+
+
 class TraceBuf:
     def __init__(self):
         self.traces = []
diff --git a/Misc/NEWS.d/next/Core_and_Builtins/2025-08-06-15-39-54.gh-issue-137400.xIw0zs.rst b/Misc/NEWS.d/next/Core_and_Builtins/2025-08-06-15-39-54.gh-issue-137400.xIw0zs.rst
@@ -0,0 +1,4 @@
+Fix a crash in the :term:`free threading` build when disabling profiling or tracing
+across all threads with :c:func:`PyEval_SetProfileAllThreads` or
+:c:func:`PyEval_SetTraceAllThreads` or their Python equivalents
+:func:`threading.settrace_all_threads` and :func:`threading.setprofile_all_threads`.
diff --git a/Python/legacy_tracing.c b/Python/legacy_tracing.c
@@ -484,13 +484,16 @@ setup_profile(PyThreadState *tstate, Py_tracefunc func, PyObject *arg, PyObject
         }
     }
 
+    _PyEval_StopTheWorld(tstate->interp);
     int delta = (func != NULL) - (tstate->c_profilefunc != NULL);
     tstate->c_profilefunc = func;
     *old_profileobj = tstate->c_profileobj;
     tstate->c_profileobj = Py_XNewRef(arg);
     tstate->interp->sys_profiling_threads += delta;
     assert(tstate->interp->sys_profiling_threads >= 0);
-    return tstate->interp->sys_profiling_threads;
+    Py_ssize_t profiling_threads = tstate->interp->sys_profiling_threads;
+    _PyEval_StartTheWorld(tstate->interp);
+    return profiling_threads;
 }
 
 int
@@ -581,13 +584,16 @@ setup_tracing(PyThreadState *tstate, Py_tracefunc func, PyObject *arg, PyObject
         }
     }
 
+    _PyEval_StopTheWorld(tstate->interp);
     int delta = (func != NULL) - (tstate->c_tracefunc != NULL);
     tstate->c_tracefunc = func;
     *old_traceobj = tstate->c_traceobj;
     tstate->c_traceobj = Py_XNewRef(arg);
     tstate->interp->sys_tracing_threads += delta;
     assert(tstate->interp->sys_tracing_threads >= 0);
-    return tstate->interp->sys_tracing_threads;
+    Py_ssize_t tracing_threads = tstate->interp->sys_tracing_threads;
+    _PyEval_StartTheWorld(tstate->interp);
+    return tracing_threads;
 }
 
 int

Original file line number	Diff line number	Diff line change
`@@ -484,13 +484,16 @@ setup_profile(PyThreadState tstate, Py_tracefunc func, PyObject arg, PyObject`
`484`	`484`	`}`
`485`	`485`	`}`
`486`	`486`
	`487`	`+ _PyEval_StopTheWorld(tstate->interp);`
`487`	`488`	`int delta = (func != NULL) - (tstate->c_profilefunc != NULL);`
`488`	`489`	`tstate->c_profilefunc = func;`
`489`	`490`	`*old_profileobj = tstate->c_profileobj;`
`490`	`491`	`tstate->c_profileobj = Py_XNewRef(arg);`
`491`	`492`	`tstate->interp->sys_profiling_threads += delta;`
`492`	`493`	`assert(tstate->interp->sys_profiling_threads >= 0);`
`493`		`- return tstate->interp->sys_profiling_threads;`
	`494`	`+ Py_ssize_t profiling_threads = tstate->interp->sys_profiling_threads;`
	`495`	`+ _PyEval_StartTheWorld(tstate->interp);`
	`496`	`+ return profiling_threads;`
`494`	`497`	`}`
`495`	`498`
`496`	`499`	`int`
`@@ -581,13 +584,16 @@ setup_tracing(PyThreadState tstate, Py_tracefunc func, PyObject arg, PyObject`
`581`	`584`	`}`
`582`	`585`	`}`
`583`	`586`
	`587`	`+ _PyEval_StopTheWorld(tstate->interp);`
`584`	`588`	`int delta = (func != NULL) - (tstate->c_tracefunc != NULL);`
`585`	`589`	`tstate->c_tracefunc = func;`
`586`	`590`	`*old_traceobj = tstate->c_traceobj;`
`587`	`591`	`tstate->c_traceobj = Py_XNewRef(arg);`
`588`	`592`	`tstate->interp->sys_tracing_threads += delta;`
`589`	`593`	`assert(tstate->interp->sys_tracing_threads >= 0);`
`590`		`- return tstate->interp->sys_tracing_threads;`
	`594`	`+ Py_ssize_t tracing_threads = tstate->interp->sys_tracing_threads;`
	`595`	`+ _PyEval_StartTheWorld(tstate->interp);`
	`596`	`+ return tracing_threads;`
`591`	`597`	`}`
`592`	`598`
`593`	`599`	`int`