Regions: Migrate descriptor objects

xFrednet · xFrednet · commit 9618e73ab35c · 2026-04-02T22:01:40.000+02:00
diff --git a/Include/descrobject.h b/Include/descrobject.h
@@ -87,7 +87,16 @@ struct PyMemberDef {
 // TODO(Immutable): Could use this to mark members as needing a lock.
 
 PyAPI_FUNC(PyObject *) PyMember_GetOne(const char *, PyMemberDef *);
+
+// TODO(regions): xFrednet: This function is used to modify Python objects
+//      but we can't really add a region write barrier, because we don't
+//      have the reference source.
+//      I see two solutions:
+//      (1) Break the public API (Which I'm doing in this patch)
+//      (2) Deprecate this function in favor of a new one. Usage of this
+//          old API will result in regions being marked as dirty.
 PyAPI_FUNC(int) PyMember_SetOne(char *, PyMemberDef *, PyObject *);
+PyAPI_FUNC(int) PyMember_SetOneOn(PyObject* obj, char *, PyMemberDef *, PyObject *);
 
 #ifndef Py_LIMITED_API
 #  define Py_CPYTHON_DESCROBJECT_H
diff --git a/Modules/_testlimitedcapi/heaptype_relative.c b/Modules/_testlimitedcapi/heaptype_relative.c
@@ -217,7 +217,7 @@ static PyObject *
 heaptype_with_member_set_memb(PyObject *self, PyObject *value)
 {
     PyMemberDef *def = heaptype_with_member_extract_and_check_memb(self);
-    int r = PyMember_SetOne((char *)self, def, value);
+    int r = PyMember_SetOneOn(self, (char *)self, def, value);
     if (r < 0) {
         return NULL;
     }
@@ -242,7 +242,7 @@ static PyObject *
 heaptype_with_member_set_memb_relative(PyObject *self, PyObject *value)
 {
     PyMemberDef def = {"memb", Py_T_BYTE, sizeof(PyObject), Py_RELATIVE_OFFSET};
-    int r = PyMember_SetOne((char *)self, &def, value);
+    int r = PyMember_SetOneOn(self, (char *)self, &def, value);
     if (r < 0) {
         return NULL;
     }
diff --git a/Objects/descrobject.c b/Objects/descrobject.c
@@ -139,7 +139,7 @@ method_get(PyObject *self, PyObject *obj, PyObject *type)
 {
     PyMethodDescrObject *descr = (PyMethodDescrObject *)self;
     if (obj == NULL) {
-        return Py_NewRef(descr);
+        return PyRegion_NewRef(descr);
     }
     if (descr_check((PyDescrObject *)descr, obj) < 0) {
         return NULL;
@@ -164,7 +164,7 @@ member_get(PyObject *self, PyObject *obj, PyObject *type)
 {
     PyMemberDescrObject *descr = (PyMemberDescrObject *)self;
     if (obj == NULL) {
-        return Py_NewRef(descr);
+        return PyRegion_NewRef(descr);
     }
     if (descr_check((PyDescrObject *)descr, obj) < 0) {
         return NULL;
@@ -242,7 +242,7 @@ member_set(PyObject *self, PyObject *obj, PyObject *value)
     if (descr_setcheck((PyDescrObject *)descr, obj, value) < 0) {
         return -1;
     }
-    return PyMember_SetOne((char *)obj, descr->d_member, value);
+    return PyMember_SetOneOn(obj, (char *)obj, descr->d_member, value);
 }
 
 static int
@@ -519,7 +519,7 @@ classmethoddescr_call(PyObject *_descr, PyObject *args,
     }
     PyObject *res = PyObject_VectorcallDict(bound, _PyTuple_ITEMS(args)+1,
                                            argc-1, kwds);
-    Py_DECREF(bound);
+    PyRegion_CLEARLOCAL(bound);
     return res;
 }
 
@@ -540,6 +540,13 @@ wrapperdescr_raw_call(PyWrapperDescrObject *descr, PyObject *self,
                      descr->d_base->name);
         return NULL;
     }
+
+    if (descr->d_common.d_type) {
+        PyRegion_NotifyTypeUse(descr->d_common.d_type);
+    } else {
+        PyRegion_DirtyAllRegions("A descriptor without a type was called");
+    }
+
     return (*wrapper)(self, args, descr->d_wrapped);
 }
 
@@ -579,7 +586,7 @@ wrapperdescr_call(PyObject *_descr, PyObject *args, PyObject *kwds)
         return NULL;
     }
     result = wrapperdescr_raw_call(descr, self, args, kwds);
-    Py_DECREF(args);
+    PyRegion_CLEARLOCAL(args);
     return result;
 }
 
@@ -619,12 +626,12 @@ calculate_qualname(PyDescrObject *descr)
     if (!PyUnicode_Check(type_qualname)) {
         PyErr_SetString(PyExc_TypeError, "<descriptor>.__objclass__."
                         "__qualname__ is not a unicode object");
-        Py_XDECREF(type_qualname);
+        PyRegion_CLEARLOCAL(type_qualname);
         return NULL;
     }
 
     res = PyUnicode_FromFormat("%S.%S", type_qualname, descr->d_name);
-    Py_DECREF(type_qualname);
+    PyRegion_CLEARLOCAL(type_qualname);
     return res;
 }
 
@@ -763,6 +770,7 @@ PyTypeObject PyMethodDescr_Type = {
     method_get,                                 /* tp_descr_get */
     0,                                          /* tp_descr_set */
     .tp_reachable = _PyObject_ReachableVisitType,
+    .tp_flags2 = Py_TPFLAGS2_REGION_AWARE,
 };
 
 /* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */
@@ -802,6 +810,7 @@ PyTypeObject PyClassMethodDescr_Type = {
     classmethod_get,                            /* tp_descr_get */
     0,                                          /* tp_descr_set */
     .tp_reachable = _PyObject_ReachableVisitType,
+    .tp_flags2 = Py_TPFLAGS2_REGION_AWARE,
 };
 
 PyTypeObject PyMemberDescr_Type = {
@@ -840,6 +849,7 @@ PyTypeObject PyMemberDescr_Type = {
     member_get,                                 /* tp_descr_get */
     member_set,                                 /* tp_descr_set */
     .tp_reachable = _PyObject_ReachableVisitType,
+    .tp_flags2 = Py_TPFLAGS2_REGION_AWARE,
 };
 
 PyTypeObject PyGetSetDescr_Type = {
@@ -879,6 +889,7 @@ PyTypeObject PyGetSetDescr_Type = {
     getset_set,                                 /* tp_descr_set */
     .tp_reachable = _PyObject_ReachableVisitType,
     .tp_flags2 = Py_TPFLAGS2_REGION_AWARE
+    .tp_flags2 = Py_TPFLAGS2_REGION_AWARE,
 };
 
 PyTypeObject PyWrapperDescr_Type = {
@@ -918,6 +929,7 @@ PyTypeObject PyWrapperDescr_Type = {
     wrapperdescr_get,                           /* tp_descr_get */
     0,                                          /* tp_descr_set */
     .tp_reachable = _PyObject_ReachableVisitType,
+    .tp_flags2 = Py_TPFLAGS2_REGION_AWARE,
 };
 
 static PyDescrObject *
@@ -1533,7 +1545,7 @@ PyWrapper_New(PyObject *d, PyObject *self)
     wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type);
     if (wp == NULL)
         return NULL;
-    if (PyRegion_AddRef(wp, descr)){
+    if (PyRegion_AddRefs(wp, descr, self)){
         Py_DECREF(wp);
         return NULL;
     }
diff --git a/Objects/methodobject.c b/Objects/methodobject.c
@@ -94,6 +94,10 @@ PyCMethod_New(PyMethodDef *ml, PyObject *self, PyObject *module, PyTypeObject *c
                 return NULL;
             }
         }
+        if (PyRegion_AddRef(om, cls)) {
+            Py_DECREF(om);
+            return NULL;
+        }
         om->mm_class = (PyTypeObject*)Py_NewRef(cls);
         op = (PyCFunctionObject *)om;
     } else {
@@ -112,6 +116,10 @@ PyCMethod_New(PyMethodDef *ml, PyObject *self, PyObject *module, PyTypeObject *c
         }
     }
 
+    if (PyRegion_AddRefs(op, self, module)) {
+        Py_DECREF(op);
+        return NULL;
+    }
     op->m_weakreflist = NULL;
     op->m_ml = ml;
     op->m_self = Py_XNewRef(self);
diff --git a/Python/structmember.c b/Python/structmember.c
@@ -95,6 +95,9 @@ PyMember_GetOne(const char *obj_addr, PyMemberDef *l)
                 Py_END_CRITICAL_SECTION();
             }
 #else
+            if (PyRegion_AddLocalRef(v)) {
+                return NULL;
+            }
             Py_INCREF(v);
 #endif
         }
@@ -105,6 +108,9 @@ PyMember_GetOne(const char *obj_addr, PyMemberDef *l)
     case Py_T_OBJECT_EX:
         v = member_get_object(addr, obj_addr, l);
 #ifndef Py_GIL_DISABLED
+        if (PyRegion_AddLocalRef(v)) {
+            return NULL;
+        }
         Py_XINCREF(v);
 #else
         if (v != NULL) {
@@ -141,7 +147,12 @@ PyMember_GetOne(const char *obj_addr, PyMemberDef *l)
     } while (0)
 
 int
-PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v)
+PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v) {
+    return PyMember_SetOneOn(NULL, addr, l, v);
+}
+
+int
+PyMember_SetOneOn(PyObject* target, char *addr, PyMemberDef *l, PyObject *v)
 {
     PyObject *oldv;
     if (l->flags & Py_RELATIVE_OFFSET) {
@@ -244,7 +255,7 @@ PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v)
         }
         if (_PyLong_IsNegative((PyLongObject *)v)) {
             long long_val = PyLong_AsLong(v);
-            Py_DECREF(v);
+            PyRegion_CLEARLOCAL(v);
             if (long_val == -1 && PyErr_Occurred()) {
                 return -1;
             }
@@ -253,7 +264,7 @@ PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v)
         }
         else {
             unsigned long ulong_val = PyLong_AsUnsignedLong(v);
-            Py_DECREF(v);
+            PyRegion_CLEARLOCAL(v);
             if (ulong_val == (unsigned long)-1 && PyErr_Occurred()) {
                 return -1;
             }
@@ -280,7 +291,7 @@ PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v)
         }
         if (_PyLong_IsNegative((PyLongObject *)v)) {
             long long_val = PyLong_AsLong(v);
-            Py_DECREF(v);
+            PyRegion_CLEARLOCAL(v);
             if (long_val == -1 && PyErr_Occurred()) {
                 return -1;
             }
@@ -289,7 +300,7 @@ PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v)
         }
         else {
             unsigned long ulong_val = PyLong_AsUnsignedLong(v);
-            Py_DECREF(v);
+            PyRegion_CLEARLOCAL(v);
             if (ulong_val == (unsigned long)-1 && PyErr_Occurred()) {
                 return -1;
             }
@@ -320,6 +331,12 @@ PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v)
     }
     case _Py_T_OBJECT:
     case Py_T_OBJECT_EX:
+
+        if (target == NULL) {
+            PyRegion_DirtyAllRegions("Call of `PyMember_SetOne`");
+        } else if (PyRegion_AddRef(target, v)) {
+            return -1;
+        }
         Py_BEGIN_CRITICAL_SECTION(obj);
         oldv = *(PyObject **)addr;
         FT_ATOMIC_STORE_PTR_RELEASE(*(PyObject **)addr, Py_XNewRef(v));
@@ -356,7 +373,7 @@ PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v)
         }
         if (_PyLong_IsNegative((PyLongObject *)v)) {
             long long_val = PyLong_AsLong(v);
-            Py_DECREF(v);
+            PyRegion_CLEARLOCAL(v);
             if (long_val == -1 && PyErr_Occurred()) {
                 return -1;
             }
@@ -365,7 +382,7 @@ PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v)
         }
         else {
             unsigned long long ulonglong_val = PyLong_AsUnsignedLongLong(v);
-            Py_DECREF(v);
+            PyRegion_CLEARLOCAL(v);
             if (ulonglong_val == (unsigned long long)-1 && PyErr_Occurred()) {
                 return -1;
             }
diff --git a/Python/sysmodule.c b/Python/sysmodule.c
@@ -278,7 +278,10 @@ sys_audit_tstate(PyThreadState *ts, const char *event,
         eventArgs = Py_VaBuildValue(argFormat, vargs);
         if (eventArgs && !PyTuple_Check(eventArgs)) {
             PyObject *argTuple = PyTuple_Pack(1, eventArgs);
-            Py_SETREF(eventArgs, argTuple);
+            if (PyRegion_XSETLOCALREF(eventArgs, argTuple)) {
+                Py_DECREF(argTuple);
+                goto exit;
+            }
         }
     }
     else {
@@ -294,6 +297,7 @@ sys_audit_tstate(PyThreadState *ts, const char *event,
      * since that would not leave is in an inconsistent state. */
     _Py_AuditHookEntry *e = is->runtime->audit_hooks.head;
     for (; e; e = e->next) {
+        PyRegion_DirtyAllRegions("Calling unknown `_Py_AuditHookEntry`");
         if (e->hookCFunction(event, eventArgs, e->userData) < 0) {
             goto exit;
         }
@@ -323,7 +327,7 @@ sys_audit_tstate(PyThreadState *ts, const char *event,
             int canTrace = PyObject_GetOptionalAttr(hook, &_Py_ID(__cantrace__), &o);
             if (o) {
                 canTrace = PyObject_IsTrue(o);
-                Py_DECREF(o);
+                PyRegion_CLEARLOCAL(o);
             }
             if (canTrace < 0) {
                 break;
@@ -339,8 +343,8 @@ sys_audit_tstate(PyThreadState *ts, const char *event,
             if (!o) {
                 break;
             }
-            Py_DECREF(o);
-            Py_CLEAR(hook);
+            PyRegion_CLEARLOCAL(o);
+            PyRegion_CLEARLOCAL(hook);
         }
         PyThreadState_LeaveTracing(ts);
         if (_PyErr_Occurred(ts)) {
@@ -351,17 +355,17 @@ sys_audit_tstate(PyThreadState *ts, const char *event,
     res = 0;
 
 exit:
-    Py_XDECREF(hook);
-    Py_XDECREF(hooks);
-    Py_XDECREF(eventName);
-    Py_XDECREF(eventArgs);
+    PyRegion_CLEARLOCAL(hook);
+    PyRegion_CLEARLOCAL(hooks);
+    PyRegion_CLEARLOCAL(eventName);
+    PyRegion_CLEARLOCAL(eventArgs);
 
     if (!res) {
         _PyErr_SetRaisedException(ts, exc);
     }
     else {
         assert(_PyErr_Occurred(ts));
-        Py_XDECREF(exc);
+        PyRegion_CLEARLOCAL(exc);
     }
 
     return res;

Original file line number	Diff line number	Diff line change
`@@ -217,7 +217,7 @@ static PyObject *`
`217`	`217`	`heaptype_with_member_set_memb(PyObject self, PyObject value)`
`218`	`218`	`{`
`219`	`219`	`PyMemberDef *def = heaptype_with_member_extract_and_check_memb(self);`
`220`		`- int r = PyMember_SetOne((char *)self, def, value);`
	`220`	`+ int r = PyMember_SetOneOn(self, (char *)self, def, value);`
`221`	`221`	`if (r < 0) {`
`222`	`222`	`return NULL;`
`223`	`223`	`}`
`@@ -242,7 +242,7 @@ static PyObject *`
`242`	`242`	`heaptype_with_member_set_memb_relative(PyObject self, PyObject value)`
`243`	`243`	`{`
`244`	`244`	`PyMemberDef def = {"memb", Py_T_BYTE, sizeof(PyObject), Py_RELATIVE_OFFSET};`
`245`		`- int r = PyMember_SetOne((char *)self, &def, value);`
	`245`	`+ int r = PyMember_SetOneOn(self, (char *)self, &def, value);`
`246`	`246`	`if (r < 0) {`
`247`	`247`	`return NULL;`
`248`	`248`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,10 @@ PyCMethod_New(PyMethodDef ml, PyObject self, PyObject module, PyTypeObject c`
`94`	`94`	`return NULL;`
`95`	`95`	`}`
`96`	`96`	`}`
	`97`	`+ if (PyRegion_AddRef(om, cls)) {`
	`98`	`+ Py_DECREF(om);`
	`99`	`+ return NULL;`
	`100`	`+ }`
`97`	`101`	`om->mm_class = (PyTypeObject*)Py_NewRef(cls);`
`98`	`102`	`op = (PyCFunctionObject *)om;`
`99`	`103`	`} else {`
`@@ -112,6 +116,10 @@ PyCMethod_New(PyMethodDef ml, PyObject self, PyObject module, PyTypeObject c`
`112`	`116`	`}`
`113`	`117`	`}`
`114`	`118`
	`119`	`+ if (PyRegion_AddRefs(op, self, module)) {`
	`120`	`+ Py_DECREF(op);`
	`121`	`+ return NULL;`
	`122`	`+ }`
`115`	`123`	`op->m_weakreflist = NULL;`
`116`	`124`	`op->m_ml = ml;`
`117`	`125`	`op->m_self = Py_XNewRef(self);`