[3.13] gh-120838: Add _PyThreadState_WHENCE_FINI (gh-121013)

We also add _PyThreadState_NewBound() and drop _PyThreadState_SetWhence().
This change only affects internal API.
(cherry picked from commit a905721, AKA gh-121010)
Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>

Author: miss-islington

Include/cpython/pystate.h

@@ -97,10 +97,11 @@ struct _ts {
 #ifdefPy_BUILD_CORE
 # define_PyThreadState_WHENCE_NOTSET -1
 # define_PyThreadState_WHENCE_UNKNOWN 0
-# define_PyThreadState_WHENCE_INTERP 1
-# define_PyThreadState_WHENCE_THREADING 2
-# define_PyThreadState_WHENCE_GILSTATE 3
-# define_PyThreadState_WHENCE_EXEC 4
+# define_PyThreadState_WHENCE_INIT 1
+# define_PyThreadState_WHENCE_FINI 2
+# define_PyThreadState_WHENCE_THREADING 3
+# define_PyThreadState_WHENCE_GILSTATE 4
+# define_PyThreadState_WHENCE_EXEC 5
 #endif
 int_whence;
 

Include/internal/pycore_pystate.h

@@ -217,10 +217,14 @@ static inline PyInterpreterState* _PyInterpreterState_GET(void) {
 
 // PyThreadState functions
 
-externPyThreadState*_PyThreadState_New(
+// Export for _testinternalcapi
+PyAPI_FUNC(PyThreadState*) _PyThreadState_New(
 PyInterpreterState*interp,
 intwhence);
 externvoid_PyThreadState_Bind(PyThreadState*tstate);
+PyAPI_FUNC(PyThreadState*) _PyThreadState_NewBound(
+PyInterpreterState*interp,
+intwhence);
 externPyThreadState*_PyThreadState_RemoveExcept(PyThreadState*tstate);
 externvoid_PyThreadState_DeleteList(PyThreadState*list);
 externvoid_PyThreadState_ClearMimallocHeaps(PyThreadState*tstate);

Include/internal/pycore_tstate.h

@@ -14,13 +14,6 @@ extern "C" {
 #include"pycore_qsbr.h"// struct qsbr
 
 
-staticinlinevoid
-_PyThreadState_SetWhence(PyThreadState*tstate, intwhence)
-{
-tstate->_whence=whence;
-}
-
-
 // Every PyThreadState is actually allocated as a _PyThreadStateImpl. The
 // PyThreadState fields are exposed as part of the C API, although most fields
 // are intended to be private. The _PyThreadStateImpl fields not exposed.

Modules/_testinternalcapi.c

@@ -1585,8 +1585,8 @@ exec_interpreter(PyObject *self, PyObject *args, PyObject *kwargs)
  }
 
 PyObject*res=NULL;
-PyThreadState*tstate=PyThreadState_New(interp);
-_PyThreadState_SetWhence(tstate, _PyThreadState_WHENCE_EXEC);
+PyThreadState*tstate=
+_PyThreadState_NewBound(interp, _PyThreadState_WHENCE_EXEC);
 
 PyThreadState*save_tstate=PyThreadState_Swap(tstate);
 

Python/crossinterp.c

@@ -1544,8 +1544,7 @@ _enter_session(_PyXI_session *session, PyInterpreterState *interp)
 PyThreadState*tstate=PyThreadState_Get();
 PyThreadState*prev=tstate;
 if (interp!=tstate->interp) {
-tstate=PyThreadState_New(interp);
-_PyThreadState_SetWhence(tstate, _PyThreadState_WHENCE_EXEC);
+tstate=_PyThreadState_NewBound(interp, _PyThreadState_WHENCE_EXEC);
 // XXX Possible GILState issues?
 session->prev_tstate=PyThreadState_Swap(tstate);
 assert(session->prev_tstate==prev);
@@ -1895,8 +1894,7 @@ _PyXI_EndInterpreter(PyInterpreterState *interp,
 tstate=cur_tstate;
  }
 else {
-tstate=PyThreadState_New(interp);
-_PyThreadState_SetWhence(tstate, _PyThreadState_WHENCE_INTERP);
+tstate=_PyThreadState_NewBound(interp, _PyThreadState_WHENCE_FINI);
 assert(tstate!=NULL);
 save_tstate=PyThreadState_Swap(tstate);
  }

Python/import.c

@@ -1518,11 +1518,11 @@ switch_to_main_interpreter(PyThreadState *tstate)
 if (_Py_IsMainInterpreter(tstate->interp)) {
 returntstate;
  }
-PyThreadState*main_tstate=PyThreadState_New(_PyInterpreterState_Main());
+PyThreadState*main_tstate=_PyThreadState_NewBound(
+_PyInterpreterState_Main(), _PyThreadState_WHENCE_EXEC);
 if (main_tstate==NULL) {
 returnNULL;
  }
-main_tstate->_whence=_PyThreadState_WHENCE_EXEC;
 #ifndefNDEBUG
 PyThreadState*old_tstate=PyThreadState_Swap(main_tstate);
 assert(old_tstate==tstate);

Python/pylifecycle.c

@@ -677,7 +677,7 @@ pycore_create_interpreter(_PyRuntimeState *runtime,
  }
 
 PyThreadState*tstate=_PyThreadState_New(interp,
-_PyThreadState_WHENCE_INTERP);
+_PyThreadState_WHENCE_INIT);
 if (tstate==NULL) {
 return_PyStatus_ERR("can't make first thread");
  }
@@ -2233,7 +2233,7 @@ new_interpreter(PyThreadState **tstate_p,
  goto error;
  }
 
-tstate=_PyThreadState_New(interp, _PyThreadState_WHENCE_INTERP);
+tstate=_PyThreadState_New(interp, _PyThreadState_WHENCE_INIT);
 if (tstate==NULL) {
 status=_PyStatus_NO_MEMORY();
  goto error;

Python/pystate.c

@@ -1293,9 +1293,8 @@ _PyInterpreterState_IDDecref(PyInterpreterState *interp)
 PyThread_release_lock(interp->id_mutex);
 
 if (refcount==0&&interp->requires_idref) {
-PyThreadState*tstate=_PyThreadState_New(interp,
-_PyThreadState_WHENCE_INTERP);
-_PyThreadState_Bind(tstate);
+PyThreadState*tstate=
+_PyThreadState_NewBound(interp, _PyThreadState_WHENCE_FINI);
 
 // XXX Possible GILState issues?
 PyThreadState*save_tstate=_PyThreadState_Swap(runtime, tstate);
@@ -1603,8 +1602,13 @@ new_threadstate(PyInterpreterState *interp, int whence)
 PyThreadState*
 PyThreadState_New(PyInterpreterState*interp)
 {
-PyThreadState*tstate=new_threadstate(interp,
-_PyThreadState_WHENCE_UNKNOWN);
+return_PyThreadState_NewBound(interp, _PyThreadState_WHENCE_UNKNOWN);
+}
+
+PyThreadState*
+_PyThreadState_NewBound(PyInterpreterState*interp, intwhence)
+{
+PyThreadState*tstate=new_threadstate(interp, whence);
 if (tstate) {
 bind_tstate(tstate);
 // This makes sure there's a gilstate tstate bound