wip: fix _PyObject_GC_UNTRACK calls

These calls in tp_dealloc methods now need to be removed since _Py_Dealloc always does the untrack for GC objects
python · nascheme · Sep 27, 2024 · Sep 27, 2024 · Sep 27, 2024 · Sep 27, 2024
commit 73644a76b8313756d78eca64afc09df3d5c5267e
diff --git a/Modules/_io/bufferedio.c b/Modules/_io/bufferedio.c
@@ -412,9 +412,10 @@ buffered_dealloc(buffered *self)
 {
     PyTypeObject *tp = Py_TYPE(self);
     self->finalizing = 1;
-    if (_PyIOBase_finalize((PyObject *) self) < 0)
+    if (_PyIOBase_finalize((PyObject *) self) < 0) {
+        PyObject_GC_Track(self); // untracked by _Py_Dealloc
         return;
-    _PyObject_GC_UNTRACK(self);
+    }
     self->ok = 0;
     if (self->weakreflist != NULL)
         PyObject_ClearWeakRefs((PyObject *)self);
@@ -2298,7 +2299,6 @@ static void
 bufferedrwpair_dealloc(rwpair *self)
 {
     PyTypeObject *tp = Py_TYPE(self);
-    _PyObject_GC_UNTRACK(self);
     if (self->weakreflist != NULL)
         PyObject_ClearWeakRefs((PyObject *)self);
     (void)bufferedrwpair_clear(self);

diff --git a/Modules/_io/bytesio.c b/Modules/_io/bytesio.c
@@ -886,7 +886,6 @@ static void
 bytesio_dealloc(bytesio *self)
 {
     PyTypeObject *tp = Py_TYPE(self);
-    _PyObject_GC_UNTRACK(self);
     if (self->exports > 0) {
         PyErr_SetString(PyExc_SystemError,
                         "deallocated BytesIO object has exported buffers");

diff --git a/Modules/_io/fileio.c b/Modules/_io/fileio.c
@@ -558,9 +558,10 @@ fileio_dealloc(fileio *self)
 {
     PyTypeObject *tp = Py_TYPE(self);
     self->finalizing = 1;
-    if (_PyIOBase_finalize((PyObject *) self) < 0)
+    if (_PyIOBase_finalize((PyObject *) self) < 0) {
+        PyObject_GC_Track(self); // untracked by _Py_Dealloc
         return;
-    _PyObject_GC_UNTRACK(self);
+    }
     if (self->stat_atopen != NULL) {
         PyMem_Free(self->stat_atopen);
         self->stat_atopen = NULL;

diff --git a/Modules/_io/iobase.c b/Modules/_io/iobase.c
@@ -372,10 +372,10 @@ iobase_dealloc(iobase *self)
         if (_PyType_HasFeature(Py_TYPE(self), Py_TPFLAGS_HEAPTYPE)) {
             Py_INCREF(Py_TYPE(self));
         }
+        PyObject_GC_Track(self); // untracked by _Py_Dealloc
         return;
     }
     PyTypeObject *tp = Py_TYPE(self);
-    _PyObject_GC_UNTRACK(self);
     if (self->weakreflist != NULL)
         PyObject_ClearWeakRefs((PyObject *) self);
     Py_CLEAR(self->dict);

diff --git a/Modules/_io/stringio.c b/Modules/_io/stringio.c
@@ -609,7 +609,6 @@ static void
 stringio_dealloc(stringio *self)
 {
     PyTypeObject *tp = Py_TYPE(self);
-    _PyObject_GC_UNTRACK(self);
     self->ok = 0;
     if (self->buf) {
         PyMem_Free(self->buf);

diff --git a/Modules/_io/textio.c b/Modules/_io/textio.c
@@ -284,7 +284,6 @@ static void
 incrementalnewlinedecoder_dealloc(nldecoder_object *self)
 {
     PyTypeObject *tp = Py_TYPE(self);
-    _PyObject_GC_UNTRACK(self);
     (void)incrementalnewlinedecoder_clear(self);
     tp->tp_free((PyObject *)self);
     Py_DECREF(tp);
@@ -1456,10 +1455,11 @@ textiowrapper_dealloc(textio *self)
 {
     PyTypeObject *tp = Py_TYPE(self);
     self->finalizing = 1;
-    if (_PyIOBase_finalize((PyObject *) self) < 0)
+    if (_PyIOBase_finalize((PyObject *) self) < 0) {
+        PyObject_GC_Track(self); // untracked by _Py_Dealloc
         return;
+    }
     self->ok = 0;
-    _PyObject_GC_UNTRACK(self);
     if (self->weakreflist != NULL)
         PyObject_ClearWeakRefs((PyObject *)self);
     (void)textiowrapper_clear(self);

diff --git a/Modules/_io/winconsoleio.c b/Modules/_io/winconsoleio.c
@@ -463,9 +463,10 @@ winconsoleio_dealloc(winconsoleio *self)
 {
     PyTypeObject *tp = Py_TYPE(self);
     self->finalizing = 1;
-    if (_PyIOBase_finalize((PyObject *) self) < 0)
+    if (_PyIOBase_finalize((PyObject *) self) < 0) {
+        PyObject_GC_Track(self); // untracked by _Py_Dealloc
         return;
-    _PyObject_GC_UNTRACK(self);
+    }
     if (self->weakreflist != NULL)
         PyObject_ClearWeakRefs((PyObject *) self);
     Py_CLEAR(self->dict);

diff --git a/Objects/bytearrayobject.c b/Objects/bytearrayobject.c
@@ -2440,7 +2440,6 @@ typedef struct {
 static void
 bytearrayiter_dealloc(bytesiterobject *it)
 {
-    _PyObject_GC_UNTRACK(it);
     Py_XDECREF(it->it_seq);
     PyObject_GC_Del(it);
 }

diff --git a/Objects/bytesobject.c b/Objects/bytesobject.c
@@ -3223,7 +3223,6 @@ typedef struct {
 static void
 striter_dealloc(striterobject *it)
 {
-    _PyObject_GC_UNTRACK(it);
     Py_XDECREF(it->it_seq);
     PyObject_GC_Del(it);
 }

diff --git a/Objects/cellobject.c b/Objects/cellobject.c
@@ -74,7 +74,6 @@ PyCell_Set(PyObject *op, PyObject *value)
 static void
 cell_dealloc(PyCellObject *op)
 {
-    _PyObject_GC_UNTRACK(op);
     Py_XDECREF(op->ob_ref);
     PyObject_GC_Del(op);
 }

diff --git a/Objects/classobject.c b/Objects/classobject.c
@@ -237,7 +237,6 @@ method_new_impl(PyTypeObject *type, PyObject *function, PyObject *instance)
 static void
 method_dealloc(PyMethodObject *im)
 {
-    _PyObject_GC_UNTRACK(im);
     if (im->im_weakreflist != NULL)
         PyObject_ClearWeakRefs((PyObject *)im);
     Py_DECREF(im->im_func);
@@ -432,7 +431,6 @@ instancemethod_getattro(PyObject *self, PyObject *name)
 
 static void
 instancemethod_dealloc(PyObject *self) {
-    _PyObject_GC_UNTRACK(self);
     Py_DECREF(PyInstanceMethod_GET_FUNCTION(self));
     PyObject_GC_Del(self);
 }

diff --git a/Objects/descrobject.c b/Objects/descrobject.c
@@ -1186,7 +1186,6 @@ static void
 mappingproxy_dealloc(PyObject *self)
 {
     mappingproxyobject *pp = (mappingproxyobject *)self;
-    _PyObject_GC_UNTRACK(pp);
     Py_DECREF(pp->mapping);
     PyObject_GC_Del(pp);
 }
@@ -1632,7 +1631,6 @@ property_dealloc(PyObject *self)
 {
     propertyobject *gs = (propertyobject *)self;
 
-    _PyObject_GC_UNTRACK(self);
     Py_XDECREF(gs->prop_get);
     Py_XDECREF(gs->prop_set);
     Py_XDECREF(gs->prop_del);

@@ -5015,8 +5015,6 @@ static void
 dictiter_dealloc(PyObject *self)
 {
     dictiterobject *di = (dictiterobject *)self;
-    /* bpo-31095: UnTrack is needed before calling any callbacks */
-    _PyObject_GC_UNTRACK(di);
     Py_XDECREF(di->di_dict);
     Py_XDECREF(di->di_result);
     PyObject_GC_Del(di);
@@ -5815,8 +5813,6 @@ static void
 dictview_dealloc(PyObject *self)
 {
     _PyDictViewObject *dv = (_PyDictViewObject *)self;
-    /* bpo-31095: UnTrack is needed before calling any callbacks */
-    _PyObject_GC_UNTRACK(dv);
     Py_XDECREF(dv->dv_dict);
     PyObject_GC_Del(dv);
 }

@@ -698,7 +698,6 @@ SystemExit_clear(PySystemExitObject *self)
 static void
 SystemExit_dealloc(PySystemExitObject *self)
 {
-    _PyObject_GC_UNTRACK(self);
     SystemExit_clear(self);
     Py_TYPE(self)->tp_free((PyObject *)self);
 }
@@ -887,7 +886,6 @@ BaseExceptionGroup_clear(PyBaseExceptionGroupObject *self)
 static void
 BaseExceptionGroup_dealloc(PyBaseExceptionGroupObject *self)
 {
-    _PyObject_GC_UNTRACK(self);
     BaseExceptionGroup_clear(self);
     Py_TYPE(self)->tp_free((PyObject *)self);
 }
@@ -1605,7 +1603,6 @@ ImportError_clear(PyImportErrorObject *self)
 static void
 ImportError_dealloc(PyImportErrorObject *self)
 {
-    _PyObject_GC_UNTRACK(self);
     ImportError_clear(self);
     Py_TYPE(self)->tp_free((PyObject *)self);
 }
@@ -1995,7 +1992,6 @@ OSError_clear(PyOSErrorObject *self)
 static void
 OSError_dealloc(PyOSErrorObject *self)
 {
-    _PyObject_GC_UNTRACK(self);
     OSError_clear(self);
     Py_TYPE(self)->tp_free((PyObject *)self);
 }
@@ -2266,7 +2262,6 @@ NameError_clear(PyNameErrorObject *self)
 static void
 NameError_dealloc(PyNameErrorObject *self)
 {
-    _PyObject_GC_UNTRACK(self);
     NameError_clear(self);
     Py_TYPE(self)->tp_free((PyObject *)self);
 }
@@ -2342,7 +2337,6 @@ AttributeError_clear(PyAttributeErrorObject *self)
 static void
 AttributeError_dealloc(PyAttributeErrorObject *self)
 {
-    _PyObject_GC_UNTRACK(self);
     AttributeError_clear(self);
     Py_TYPE(self)->tp_free((PyObject *)self);
 }
@@ -2480,7 +2474,6 @@ SyntaxError_clear(PySyntaxErrorObject *self)
 static void
 SyntaxError_dealloc(PySyntaxErrorObject *self)
 {
-    _PyObject_GC_UNTRACK(self);
     SyntaxError_clear(self);
     Py_TYPE(self)->tp_free((PyObject *)self);
 }
@@ -2930,7 +2923,6 @@ UnicodeError_clear(PyUnicodeErrorObject *self)
 static void
 UnicodeError_dealloc(PyUnicodeErrorObject *self)
 {
-    _PyObject_GC_UNTRACK(self);
     UnicodeError_clear(self);
     Py_TYPE(self)->tp_free((PyObject *)self);
 }
@@ -3389,8 +3381,6 @@ _PyErr_NoMemory(PyThreadState *tstate)
 static void
 MemoryError_dealloc(PyBaseExceptionObject *self)
 {
-    _PyObject_GC_UNTRACK(self);
-
     BaseException_clear(self);
 
     /* If this is a subclass of MemoryError, we don't need to

@@ -1637,10 +1637,6 @@ frame_dealloc(PyFrameObject *f)
     /* It is the responsibility of the owning generator/coroutine
      * to have cleared the generator pointer */
 
-    if (_PyObject_GC_IS_TRACKED(f)) {
-        _PyObject_GC_UNTRACK(f);
-    }
-
     Py_TRASHCAN_BEGIN(f, frame_dealloc);
     /* GH-106092: If f->f_frame was on the stack and we reached the maximum
      * nesting depth for deallocations, the trashcan may have delayed this

diff --git a/Objects/funcobject.c b/Objects/funcobject.c
@@ -1049,10 +1049,10 @@ func_dealloc(PyFunctionObject *op)
     handle_func_event(PyFunction_EVENT_DESTROY, op, NULL);
     if (Py_REFCNT(op) > 1) {
         Py_SET_REFCNT(op, Py_REFCNT(op) - 1);
+        _PyObject_GC_TRACK(op); // untracked by _Py_Dealloc
         return;
     }
     Py_SET_REFCNT(op, 0);
-    _PyObject_GC_UNTRACK(op);
     if (op->func_weakreflist != NULL) {
         PyObject_ClearWeakRefs((PyObject *) op);
     }
@@ -1254,7 +1254,6 @@ typedef struct {
 static void
 cm_dealloc(classmethod *cm)
 {
-    _PyObject_GC_UNTRACK((PyObject *)cm);
     Py_XDECREF(cm->cm_callable);
     Py_XDECREF(cm->cm_dict);
     Py_TYPE(cm)->tp_free((PyObject *)cm);
@@ -1473,7 +1472,6 @@ typedef struct {
 static void
 sm_dealloc(staticmethod *sm)
 {
-    _PyObject_GC_UNTRACK((PyObject *)sm);
     Py_XDECREF(sm->sm_callable);
     Py_XDECREF(sm->sm_dict);
     Py_TYPE(sm)->tp_free((PyObject *)sm);

diff --git a/Objects/genericaliasobject.c b/Objects/genericaliasobject.c
@@ -31,7 +31,6 @@ ga_dealloc(PyObject *self)
 {
     gaobject *alias = (gaobject *)self;
 
-    _PyObject_GC_UNTRACK(self);
     if (alias->weakreflist != NULL) {
         PyObject_ClearWeakRefs((PyObject *)alias);
     }

@@ -127,17 +127,15 @@ gen_dealloc(PyGenObject *gen)
 {
     PyObject *self = (PyObject *) gen;
 
-    _PyObject_GC_UNTRACK(gen);
-
     if (gen->gi_weakreflist != NULL)
         PyObject_ClearWeakRefs(self);
 
-    _PyObject_GC_TRACK(self);
+    _PyObject_GC_TRACK(self); // _Py_Dealloc calls untrack
 
     if (PyObject_CallFinalizerFromDealloc(self))
         return;                     /* resurrected.  :( */
 
-    _PyObject_GC_UNTRACK(self);
+    _PyObject_GC_UNTRACK(self); // tp_del requires this
     if (PyAsyncGen_CheckExact(gen)) {
         /* We have to handle this case for asynchronous generators
            right here, because this code has to be between UNTRACK
@@ -1222,7 +1220,6 @@ PyTypeObject PyCoro_Type = {
 static void
 coro_wrapper_dealloc(PyCoroWrapper *cw)
 {
-    _PyObject_GC_UNTRACK((PyObject *)cw);
     Py_CLEAR(cw->cw_coroutine);
     PyObject_GC_Del(cw);
 }
@@ -1691,7 +1688,6 @@ async_gen_asend_dealloc(PyAsyncGenASend *o)
         return;
     }
 
-    _PyObject_GC_UNTRACK((PyObject *)o);
     Py_CLEAR(o->ags_gen);
     Py_CLEAR(o->ags_sendval);
 
@@ -1913,7 +1909,6 @@ async_gen_asend_new(PyAsyncGenObject *gen, PyObject *sendval)
 static void
 async_gen_wrapped_val_dealloc(_PyAsyncGenWrappedValue *o)
 {
-    _PyObject_GC_UNTRACK((PyObject *)o);
     Py_CLEAR(o->agw_val);
     _Py_FREELIST_FREE(async_gens, o, PyObject_GC_Del);
 }
@@ -1998,10 +1993,10 @@ static void
 async_gen_athrow_dealloc(PyAsyncGenAThrow *o)
 {
     if (PyObject_CallFinalizerFromDealloc((PyObject *)o)) {
+        PyObject_GC_Track(o); // untracked by _Py_Dealloc
         return;
     }
 
-    _PyObject_GC_UNTRACK((PyObject *)o);
     Py_CLEAR(o->agt_gen);
     Py_CLEAR(o->agt_args);
     PyObject_GC_Del(o);

diff --git a/Objects/iterobject.c b/Objects/iterobject.c
@@ -33,7 +33,6 @@ PySeqIter_New(PyObject *seq)
 static void
 iter_dealloc(seqiterobject *it)
 {
-    _PyObject_GC_UNTRACK(it);
     Py_XDECREF(it->it_seq);
     PyObject_GC_Del(it);
 }
@@ -197,7 +196,6 @@ PyCallIter_New(PyObject *callable, PyObject *sentinel)
 static void
 calliter_dealloc(calliterobject *it)
 {
-    _PyObject_GC_UNTRACK(it);
     Py_XDECREF(it->it_callable);
     Py_XDECREF(it->it_sentinel);
     PyObject_GC_Del(it);
@@ -307,7 +305,6 @@ typedef struct {
 static void
 anextawaitable_dealloc(anextawaitableobject *obj)
 {
-    _PyObject_GC_UNTRACK(obj);
     Py_XDECREF(obj->wrapped);
     Py_XDECREF(obj->default_value);
     PyObject_GC_Del(obj);

diff --git a/Objects/listobject.c b/Objects/listobject.c
@@ -3854,7 +3854,6 @@ static void
 listiter_dealloc(PyObject *self)
 {
     _PyListIterObject *it = (_PyListIterObject *)self;
-    _PyObject_GC_UNTRACK(it);
     Py_XDECREF(it->it_seq);
     PyObject_GC_Del(it);
 }