Unstable C API tier: Add a test for the code API

Author: encukou

Modules/Setup.stdlib.in

@@ -169,7 +169,7 @@
 @MODULE__XXTESTFUZZ_TRUE@_xxtestfuzz _xxtestfuzz/_xxtestfuzz.c _xxtestfuzz/fuzzer.c
 @MODULE__TESTBUFFER_TRUE@_testbuffer _testbuffer.c
 @MODULE__TESTINTERNALCAPI_TRUE@_testinternalcapi _testinternalcapi.c
-@MODULE__TESTCAPI_TRUE@_testcapi _testcapimodule.c _testcapi/vectorcall.c _testcapi/vectorcall_limited.c _testcapi/heaptype.c _testcapi/unicode.c _testcapi/getargs.c _testcapi/pytime.c _testcapi/datetime.c _testcapi/docstring.c _testcapi/mem.c _testcapi/watchers.c _testcapi/long.c _testcapi/float.c _testcapi/structmember.c
+@MODULE__TESTCAPI_TRUE@_testcapi _testcapimodule.c _testcapi/vectorcall.c _testcapi/vectorcall_limited.c _testcapi/heaptype.c _testcapi/unicode.c _testcapi/getargs.c _testcapi/pytime.c _testcapi/datetime.c _testcapi/docstring.c _testcapi/mem.c _testcapi/watchers.c _testcapi/long.c _testcapi/float.c _testcapi/structmember.c _testcapi/code.c
 @MODULE__TESTCLINIC_TRUE@_testclinic _testclinic.c
 
 # Some testing modules MUST be built as shared libraries.

Modules/_testcapi/code.c

@@ -0,0 +1,115 @@
+#include "parts.h"
+
+static Py_ssize_t
+get_code_extra_index(PyInterpreterState* interp) {
+    Py_ssize_t result = -1;
+
+    static const char *key = "_testcapi.frame_evaluation.code_index";
+
+    PyObject *interp_dict = PyInterpreterState_GetDict(interp); // borrowed
+    assert(interp_dict);  // real users would handle missing dict... somehow
+
+    PyObject *index_obj = PyDict_GetItemString(interp_dict, key); // borrowed
+    Py_ssize_t index = 0;
+    if (!index_obj) {
+        if (PyErr_Occurred()) {
+            goto finally;
+        }
+        index = PyUnstable_Eval_RequestCodeExtraIndex(NULL);
+        if (index < 0 || PyErr_Occurred()) {
+            goto finally;
+        }
+        index_obj = PyLong_FromSsize_t(index); // strong ref
+        if (!index_obj) {
+            goto finally;
+        }
+        int res = PyDict_SetItemString(interp_dict, key, index_obj);
+        Py_DECREF(index_obj);
+        if (res < 0) {
+            goto finally;
+        }
+    }
+    else {
+        index = PyLong_AsSsize_t(index_obj);
+        if (index == -1 && PyErr_Occurred()) {
+            goto finally;
+        }
+    }
+
+    result = index;
+finally:
+    return result;
+}
+
+static PyObject *
+test_code_extra(PyObject* self, PyObject *Py_UNUSED(callable))
+{
+    PyObject *result = NULL;
+    PyObject *test_module = NULL;
+    PyObject *test_func = NULL;
+
+    // Get or initialize interpreter-specific code object storage index
+    PyInterpreterState *interp = PyInterpreterState_Get();
+    if (!interp) {
+        return NULL;
+    }
+    Py_ssize_t code_extra_index = get_code_extra_index(interp);
+    if (PyErr_Occurred()) {
+        goto finally;
+    }
+
+    // Get a function to test with
+    // This can be any Python function. Use `test.test_misc.testfunction`.
+    test_module = PyImport_ImportModule("test.test_capi.test_misc");
+    if (!test_module) {
+        goto finally;
+    }
+    test_func = PyObject_GetAttrString(test_module, "testfunction");
+    if (!test_func) {
+        goto finally;
+    }
+    PyObject *test_func_code = PyFunction_GetCode(test_func);  // borrowed
+    if (!test_func_code) {
+        goto finally;
+    }
+
+    // Check the value is initially NULL
+    void *extra;
+    int res = PyUnstable_Code_GetExtra(test_func_code, code_extra_index, &extra);
+    if (res < 0) {
+        goto finally;
+    }
+    assert (extra == NULL);
+
+    // Set another code extra value
+    res = PyUnstable_Code_SetExtra(test_func_code, code_extra_index, (void*)(uintptr_t)77);
+    if (res < 0) {
+        goto finally;
+    }
+    // Assert it was set correctly
+    res = PyUnstable_Code_GetExtra(test_func_code, code_extra_index, &extra);
+    if (res < 0) {
+        goto finally;
+    }
+    assert ((uintptr_t)extra == 77);
+
+    result = Py_NewRef(Py_None);
+finally:
+    Py_XDECREF(test_module);
+    Py_XDECREF(test_func);
+    return result;
+}
+
+static PyMethodDef TestMethods[] = {
+    {"test_code_extra", test_code_extra, METH_NOARGS},
+    {NULL},
+};
+
+int
+_PyTestCapi_Init_Code(PyObject *m) {
+    if (PyModule_AddFunctions(m, TestMethods) < 0) {
+        return -1;
+    }
+
+    return 0;
+}

Modules/_testcapi/parts.h

@@ -36,6 +36,7 @@ int _PyTestCapi_Init_Watchers(PyObject *module);
 int _PyTestCapi_Init_Long(PyObject *module);
 int _PyTestCapi_Init_Float(PyObject *module);
 int _PyTestCapi_Init_Structmember(PyObject *module);
+int _PyTestCapi_Init_Code(PyObject *module);
 
 #ifdef LIMITED_API_AVAILABLE
 int _PyTestCapi_Init_VectorcallLimited(PyObject *module);

Modules/_testcapimodule.c

@@ -4075,6 +4075,9 @@ PyInit__testcapi(void)
     if (_PyTestCapi_Init_Structmember(m) < 0) {
         return NULL;
     }
+    if (_PyTestCapi_Init_Code(m) < 0) {
+        return NULL;
+    }
 
 #ifndef LIMITED_API_AVAILABLE
     PyModule_AddObjectRef(m, "LIMITED_API_AVAILABLE", Py_False);

PCbuild/_testcapi.vcxproj

@@ -107,6 +107,7 @@
     <ClCompile Include="..\Modules\_testcapi\float.c" />
     <ClCompile Include="..\Modules\_testcapi\long.c" />
     <ClCompile Include="..\Modules\_testcapi\structmember.c" />
+    <ClCompile Include="..\Modules\_testcapi\code.c" />
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="..\PC\python_nt.rc" />

PCbuild/_testcapi.vcxproj.filters

@@ -51,6 +51,9 @@
     <ClCompile Include="..\Modules\_testcapi\structmember.c">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="..\Modules\_testcapi\code.c">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="..\PC\python_nt.rc">