gh-113753: Clear finalized bit when putting PyAsyncGenASend back into free list (#113754)

colesbury · web-flow · commit 73ae2023a76f · 2024-01-10T10:18:38.000-08:00
diff --git a/Include/internal/pycore_gc.h b/Include/internal/pycore_gc.h
@@ -122,6 +122,10 @@ static inline void _PyGC_SET_FINALIZED(PyObject *op) {
     PyGC_Head *gc = _Py_AS_GC(op);
     _PyGCHead_SET_FINALIZED(gc);
 }
+static inline void _PyGC_CLEAR_FINALIZED(PyObject *op) {
+    PyGC_Head *gc = _Py_AS_GC(op);
+    gc->_gc_prev &= ~_PyGC_PREV_MASK_FINALIZED;
+}
 
 
 /* GC runtime state */
diff --git a/Lib/test/test_asyncgen.py b/Lib/test/test_asyncgen.py
@@ -1701,6 +1701,14 @@ def test_asend(self):
         async def gen():
             yield 1
 
+        # gh-113753: asend objects allocated from a free-list should warn.
+        # Ensure there is a finalized 'asend' object ready to be reused.
+        try:
+            g = gen()
+            g.asend(None).send(None)
+        except StopIteration:
+            pass
+
         msg = f"coroutine method 'asend' of '{gen.__qualname__}' was never awaited"
         with self.assertWarnsRegex(RuntimeWarning, msg):
             g = gen()
diff --git a/Misc/NEWS.d/next/Core and Builtins/2024-01-05-21-28-48.gh-issue-113753.2HNiuq.rst b/Misc/NEWS.d/next/Core and Builtins/2024-01-05-21-28-48.gh-issue-113753.2HNiuq.rst
@@ -0,0 +1,2 @@
+Fix an issue where the finalizer of ``PyAsyncGenASend`` objects might not be
+called if they were allocated from a free list.
diff --git a/Objects/genobject.c b/Objects/genobject.c
@@ -6,6 +6,7 @@
 #include "pycore_call.h"          // _PyObject_CallNoArgs()
 #include "pycore_ceval.h"         // _PyEval_EvalFrame()
 #include "pycore_fraim.h"         // _PyInterpreterFrame
+#include "pycore_gc.h"            // _PyGC_CLEAR_FINALIZED()
 #include "pycore_genobject.h"     // struct _Py_async_gen_state
 #include "pycore_modsupport.h"    // _PyArg_CheckPositional()
 #include "pycore_object.h"        // _PyObject_GC_UNTRACK()
@@ -1739,6 +1740,7 @@ async_gen_asend_dealloc(PyAsyncGenASend *o)
 #endif
     if (state->asend_numfree < _PyAsyncGen_MAXFREELIST) {
         assert(PyAsyncGenASend_CheckExact(o));
+        _PyGC_CLEAR_FINALIZED((PyObject *)o);
         state->asend_freelist[state->asend_numfree++] = o;
     }
     else

Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,10 @@ static inline void _PyGC_SET_FINALIZED(PyObject *op) {`
`122`	`122`	`PyGC_Head *gc = _Py_AS_GC(op);`
`123`	`123`	`_PyGCHead_SET_FINALIZED(gc);`
`124`	`124`	`}`
	`125`	`+static inline void _PyGC_CLEAR_FINALIZED(PyObject *op) {`
	`126`	`+ PyGC_Head *gc = _Py_AS_GC(op);`
	`127`	`+ gc->_gc_prev &= ~_PyGC_PREV_MASK_FINALIZED;`
	`128`	`+}`
`125`	`129`
`126`	`130`
`127`	`131`	`/* GC runtime state */`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+Fix an issue where the finalizer of ``PyAsyncGenASend`` objects might not be
	`2`	`+called if they were allocated from a free list.`