Add xid_state structs and lifecycle funcs.

python · ericsnowcurrently · Nov 1, 2023 · Oct 24, 2023 · Oct 25, 2023 · Oct 25, 2023
commit a230f7786d9b6ead45fb2562d7d360e47b08cc93
@@ -139,6 +139,26 @@ PyAPI_FUNC(int) _PyCrossInterpreterData_UnregisterClass(PyTypeObject *);
 PyAPI_FUNC(crossinterpdatafunc) _PyCrossInterpreterData_Lookup(PyObject *);
 
 
+/*************************/
+/* runtime state */
+/*************************/
+
+struct _xi_runtime_state {
+    // builtin types
+    // XXX Remove this field once we have a tp_* slot.
+    struct _xidregistry registry;
+};
+
+struct _xi_state {
+    // heap types
+    // XXX Remove this field once we have a tp_* slot.
+    struct _xidregistry registry;
+};
+
+extern PyStatus _PyXI_Init(PyInterpreterState *interp);
+extern void _PyXI_Fini(PyInterpreterState *interp);
+
+
 /***************************/
 /* short-term data sharing */
 /***************************/

@@ -153,8 +153,8 @@ struct _is {
     Py_ssize_t co_extra_user_count;
     freefunc co_extra_freefuncs[MAX_CO_EXTRA_USERS];
 
-    // XXX Remove this field once we have a tp_* slot.
-    struct _xidregistry xidregistry;
+    /* cross-interpreter data and utils */
+    struct _xi_state xi;
 
 #ifdef HAVE_FORK
     PyObject *before_forkers;

@@ -200,8 +200,8 @@ typedef struct pyruntimestate {
      possible to facilitate out-of-process observability
      tools. */
 
-    // XXX Remove this field once we have a tp_* slot.
-    struct _xidregistry xidregistry;
+    /* cross-interpreter data and utils */
+    struct _xi_runtime_state xi;
 
     struct _pymem_allocators allocators;
     struct _obmalloc_global_state obmalloc;

@@ -4,6 +4,7 @@
 #include "Python.h"
 #include "pycore_ceval.h"         // _Py_simple_func
 #include "pycore_crossinterp.h"   // struct _xid
+#include "pycore_initconfig.h"    // _PyStatus_OK()
 #include "pycore_pyerrors.h"      // _PyErr_Clear()
 #include "pycore_pystate.h"       // _PyInterpreterState_GET()
 #include "pycore_weakref.h"       // _PyWeakref_GET_REF()
@@ -352,6 +353,7 @@ _xidregistry_remove_entry(struct _xidregistry *xidregistry,
 }
 
 // This is used in pystate.c (for now).
+// XXX Call this is _PyXI_Fini() instead of _PyRuntimeState_Fini()?
 void
 _Py_xidregistry_clear(struct _xidregistry *xidregistry)
 {
@@ -394,10 +396,10 @@ _xidregistry_find_type(struct _xidregistry *xidregistry, PyTypeObject *cls)
 static inline struct _xidregistry *
 _get_xidregistry(PyInterpreterState *interp, PyTypeObject *cls)
 {
-    struct _xidregistry *xidregistry = &interp->runtime->xidregistry;
+    struct _xidregistry *xidregistry = &interp->runtime->xi.registry;
     if (cls->tp_flags & Py_TPFLAGS_HEAPTYPE) {
-        assert(interp->xidregistry.mutex == xidregistry->mutex);
-        xidregistry = &interp->xidregistry;
+        assert(interp->xi.registry.mutex == xidregistry->mutex);
+        xidregistry = &interp->xi.registry;
     }
     return xidregistry;
 }
@@ -407,8 +409,8 @@ static void _register_builtins_for_crossinterpreter_data(struct _xidregistry *xi
 static inline void
 _ensure_builtins_xid(PyInterpreterState *interp, struct _xidregistry *xidregistry)
 {
-    if (xidregistry != &interp->xidregistry) {
-        assert(xidregistry == &interp->runtime->xidregistry);
+    if (xidregistry != &interp->xi.registry) {
+        assert(xidregistry == &interp->runtime->xi.registry);
         if (xidregistry->head == NULL) {
             _register_builtins_for_crossinterpreter_data(xidregistry);
         }
@@ -433,6 +435,7 @@ _PyCrossInterpreterData_RegisterClass(PyTypeObject *cls,
     struct _xidregistry *xidregistry = _get_xidregistry(interp, cls);
     PyThread_acquire_lock(xidregistry->mutex, WAIT_LOCK);
 
+    // XXX Do this once in _PyXI_Init()?
     _ensure_builtins_xid(interp, xidregistry);
 
     struct _xidregitem *matched = _xidregistry_find_type(xidregistry, cls);
@@ -1274,3 +1277,20 @@ _PyXI_Exit(_PyXI_session *session)
     _capture_current_exception(session);
     _exit_session(session);
 }
+
+
+/*********************/
+/* runtime lifecycle */
+/*********************/
+
+PyStatus
+_PyXI_Init(PyInterpreterState *interp)
+{
+    return _PyStatus_OK();
+}
+
+void
+_PyXI_Fini(PyInterpreterState *interp)
+{
+    // For now we don't do anything.
+}
@@ -854,6 +854,11 @@ pycore_interp_init(PyThreadState *tstate)
         goto done;
     }
 
+    status = _PyXI_Init(interp);
+    if (_PyStatus_EXCEPTION(status)) {
+        goto done;
+    }
+
     const PyConfig *config = _PyInterpreterState_GetConfig(interp);
 
     status = _PyImport_InitCore(tstate, sysmod, config->_install_importlib);
@@ -1736,6 +1741,7 @@ finalize_interp_types(PyInterpreterState *interp)
 {
     _PyUnicode_FiniTypes(interp);
     _PySys_FiniTypes(interp);
+    _PyXI_Fini(interp);
     _PyExc_Fini(interp);
     _PyAsyncGen_Fini(interp);
     _PyContext_Fini(interp);

@@ -382,7 +382,7 @@ _Py_COMP_DIAG_POP
 #define LOCKS_INIT(runtime) \
     { \
         &(runtime)->interpreters.mutex, \
-        &(runtime)->xidregistry.mutex, \
+        &(runtime)->xi.registry.mutex, \
         &(runtime)->getargs.mutex, \
         &(runtime)->unicode_state.ids.lock, \
         &(runtime)->imports.extensions.mutex, \
@@ -505,7 +505,7 @@ _PyRuntimeState_Fini(_PyRuntimeState *runtime)
     assert(runtime->object_state.interpreter_leaks == 0);
 #endif
 
-    _Py_xidregistry_clear(&runtime->xidregistry);
+    _Py_xidregistry_clear(&runtime->xi.registry);
 
     if (gilstate_tss_initialized(runtime)) {
         gilstate_tss_fini(runtime);
@@ -556,7 +556,7 @@ _PyRuntimeState_ReInitThreads(_PyRuntimeState *runtime)
        _PyInterpreterState_DeleteExceptMain(), so we only need to update
        the main interpreter here. */
     assert(runtime->interpreters.main != NULL);
-    runtime->interpreters.main->xidregistry.mutex = runtime->xidregistry.mutex;
+    runtime->interpreters.main->xi.registry.mutex = runtime->xi.registry.mutex;
 
     PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
 
@@ -720,8 +720,8 @@ init_interpreter(PyInterpreterState *interp,
     }
     interp->f_opcode_trace_set = false;
 
-    assert(runtime->xidregistry.mutex != NULL);
-    interp->xidregistry.mutex = runtime->xidregistry.mutex;
+    assert(runtime->xi.registry.mutex != NULL);
+    interp->xi.registry.mutex = runtime->xi.registry.mutex;
 
     interp->_initialized = 1;
     return _PyStatus_OK();
@@ -948,9 +948,9 @@ interpreter_clear(PyInterpreterState *interp, PyThreadState *tstate)
     Py_CLEAR(interp->sysdict);
     Py_CLEAR(interp->builtins);
 
-    _Py_xidregistry_clear(&interp->xidregistry);
+    _Py_xidregistry_clear(&interp->xi.registry);
     /* The lock is owned by the runtime, so we don't free it here. */
-    interp->xidregistry.mutex = NULL;
+    interp->xi.registry.mutex = NULL;
 
     if (tstate->interp == interp) {
         /* We are now safe to fix tstate->_status.cleared. */