gh-117657: Make frame clearing thread-safe

Lib/test/test_free_threading/test_frame.py

@@ -0,0 +1,31 @@
+import sys
+import unittest
+import threading
+
+from test.support import threading_helper
+
+NTHREADS = 6
+
+@threading_helper.requires_working_threading()
+class TestFrame(unittest.TestCase):
+    def test_frame_clear_simultaneous(self):
+
+        def gen():
+            for _ in range(10000):
+                return sys._getframe()
+
+        foo = gen()
+        def work():
+            for _ in range(4000):
+                frame1 = foo
+                frame1.clear()
+
+
+        threads = []
+        for i in range(NTHREADS):
+            thread = threading.Thread(target=work)
+            thread.start()
+            threads.append(thread)
+
+        for thread in threads:
+            thread.join()

Objects/frameobject.c

@@ -7,7 +7,7 @@
 #include "pycore_moduleobject.h"  // _PyModule_GetDict()
 #include "pycore_object.h"        // _PyObject_GC_UNTRACK()
 #include "pycore_opcode_metadata.h" // _PyOpcode_Deopt, _PyOpcode_Caches
-
+#include "pycore_critical_section.h" // Py_BEGIN_CRITICAL_SECTION
 
 #include "frameobject.h"          // PyFrameObject
 #include "pycore_frame.h"
@@ -1662,7 +1662,7 @@ frame_tp_clear(PyFrameObject *f)
 }
 
 static PyObject *
-frame_clear(PyFrameObject *f, PyObject *Py_UNUSED(ignored))
+frame_clear_unlocked(PyFrameObject *f, PyObject *Py_UNUSED(ignored))
 {
     if (f->f_frame->owner == FRAME_OWNED_BY_GENERATOR) {
         PyGenObject *gen = _PyFrame_GetGenerator(f->f_frame);
@@ -1692,6 +1692,17 @@ frame_clear(PyFrameObject *f, PyObject *Py_UNUSED(ignored))
     return NULL;
 }
 
+static PyObject *
+frame_clear(PyFrameObject *f, PyObject *Py_UNUSED(ignored))
+{
+    PyObject *res;
+    // Another materialized frame might be racing on clearing the frame.
+    Py_BEGIN_CRITICAL_SECTION(f);
+    res = frame_clear_unlocked(f, NULL);
+    Py_END_CRITICAL_SECTION();
+    return res;
+}
+
 PyDoc_STRVAR(clear__doc__,
 "F.clear(): clear most references held by the frame");
 

Objects/genobject.c

@@ -14,6 +14,7 @@
 #include "pycore_pyatomic_ft_wrappers.h" // FT_ATOMIC_*
 #include "pycore_pyerrors.h"      // _PyErr_ClearExcState()
 #include "pycore_pystate.h"       // _PyThreadState_GET()
+#include "pycore_critical_section.h" // Py_BEGIN_CRITICAL_SECTION
 
 #include "pystats.h"
 
@@ -119,7 +120,7 @@ _PyGen_Finalize(PyObject *self)
 }
 
 static void
-gen_dealloc(PyGenObject *gen)
+gen_dealloc_no_lock(PyGenObject *gen)
 {
     PyObject *self = (PyObject *) gen;
 
@@ -158,6 +159,15 @@ gen_dealloc(PyGenObject *gen)
     PyObject_GC_Del(gen);
 }
 
+static void
+gen_dealloc(PyGenObject *gen)
+{
+    // Another generator's finalizer might race on clearing the frame.
+    Py_BEGIN_CRITICAL_SECTION(gen);
+    gen_dealloc_no_lock(gen);
+    Py_END_CRITICAL_SECTION();
+}
+
 static PySendResult
 gen_send_ex2(PyGenObject *gen, PyObject *arg, PyObject **presult,
              int exc, int closing)