[GR-52183] Re-add aliases for internal functions we used in our PyO3 branches

PullRequest: graalpython/3200

Author: timfel

graalpython/com.oracle.graal.python.cext/CMakeLists.txt

@@ -35,6 +35,8 @@ function(require_var var)
     endif()
 endfunction()
 
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
 if(MSVC)
     message(FATAL_ERROR "C API cannot be built with MSVC")
 endif()

graalpython/com.oracle.graal.python.cext/src/listobject.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2024, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * The Universal Permissive License (UPL), Version 1.0
@@ -40,3 +40,7 @@
  */
 #include "capi.h"
 
+// alias for internal function, currently used in PyO3
+void _PyList_SET_ITEM(PyObject* a, Py_ssize_t b, PyObject* c) {
+    return PyTruffleList_SET_ITEM(a, b, c);
+}

graalpython/com.oracle.graal.python.cext/src/object.c

@@ -799,6 +799,11 @@ Py_ssize_t PyTruffle_REFCNT(PyObject *obj) {
 #endif /* GRAALVM_PYTHON_LLVM_MANAGED */
 }
 
+// alias, currently used in PyO3
+Py_ssize_t _Py_REFCNT(PyObject *obj) {
+    return PyTruffle_REFCNT(obj);
+}
+
 void PyTruffle_SET_REFCNT(PyObject* obj, Py_ssize_t cnt) {
 #ifndef GRAALVM_PYTHON_LLVM_MANAGED
     PyObject *dest;
@@ -843,6 +848,11 @@ PyTypeObject* PyTruffle_TYPE(PyObject *a) {
 #endif /* GRAALVM_PYTHON_LLVM_MANAGED */
 }
 
+// alias, currently used in PyO3
+PyTypeObject* _Py_TYPE(PyObject *obj) {
+    return PyTruffle_TYPE(obj);
+}
+
 Py_ssize_t PyTruffle_SIZE(PyObject *ob) {
     PyVarObject* a = (PyVarObject*)ob;
 #ifdef GRAALVM_PYTHON_LLVM_MANAGED
@@ -878,6 +888,11 @@ Py_ssize_t PyTruffle_SIZE(PyObject *ob) {
 #endif /* GRAALVM_PYTHON_LLVM_MANAGED */
 }
 
+// alias, currently used in PyO3
+Py_ssize_t _Py_SIZE(PyObject *obj) {
+    return PyTruffle_SIZE(obj);
+}
+
 void PyTruffle_SET_TYPE(PyObject *a, PyTypeObject *b) {
 	if (points_to_py_handle_space(a)) {
 		printf("changing the type of an object is not supported\n");

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_public_symbols.py

@@ -0,0 +1,98 @@
+# Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
+# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+#
+# The Universal Permissive License (UPL), Version 1.0
+#
+# Subject to the condition set forth below, permission is hereby granted to any
+# person obtaining a copy of this software, associated documentation and/or
+# data (collectively the "Software"), free of charge and under any and all
+# copyright rights in the Software, and any and all patent rights owned or
+# freely licensable by each licensor hereunder covering either (i) the
+# unmodified Software as contributed to or provided by such licensor, or (ii)
+# the Larger Works (as defined below), to deal in both
+#
+# (a) the Software, and
+#
+# (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+# one is included with the Software each a "Larger Work" to which the Software
+# is contributed by such licensors),
+#
+# without restriction, including without limitation the rights to copy, create
+# derivative works of, display, perform, and distribute the Software and make,
+# use, sell, offer for sale, import, export, have made, and have sold the
+# Software and the Larger Work(s), and to sublicense the foregoing rights on
+# either these or other terms.
+#
+# This license is subject to the following condition:
+#
+# The above copyright notice and either this complete permission notice or at a
+# minimum a reference to the UPL must be included in all copies or substantial
+# portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+import sys
+from unittest import skipUnless
+from . import CPyExtTestCase, CPyExtFunction, unhandled_error_compare, GRAALPYTHON
+
+
+# Test for the presence of a few custom symbols we have that are considered
+# "public" because we use them in our patches to C extensions
+class TestPublicSymbols(CPyExtTestCase):
+    def compile_module(self, name):
+        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
+        super().compile_module(name)
+
+    test_PyO3_symbols = CPyExtFunction(
+        lambda args: True,
+        lambda: (
+            ((
+                "_Py_FalseStructReference",
+                "_Py_TrueStructReference",
+                "_Py_EllipsisObjectReference",
+                "_Py_SIZE",
+                "_Py_REFCNT",
+                "_Py_TYPE",
+                "_Py_NoneStructReference",
+                "_Py_NotImplementedStructReference",
+                "_PyList_SET_ITEM",
+            ),),
+        ),
+        code='''
+        #include <dlfcn.h>
+
+        PyObject* use_symbols_in_pyo3(PyObject* symbols) {
+            void *sym;
+            Py_ssize_t len = PyObject_Size(symbols);
+            for (Py_ssize_t i = 0; i < len; i++) {
+                sym = NULL;
+                PyObject *o = PySequence_GetItem(symbols, i);
+                const char* s = PyUnicode_AsUTF8(o);
+                sym = dlsym(RTLD_DEFAULT, s);
+                PyObject *r;
+                if (sym == NULL) {
+                    r = PyUnicode_FromFormat("Missing %s symbol in global namespace", s);
+                }
+                Py_DECREF(o);
+                if (sym == NULL) {
+                    return r;
+                }
+            }
+            Py_RETURN_TRUE;
+        }
+        ''',
+        resultspec="O",
+        argspec='O',
+        callfunction="use_symbols_in_pyo3",
+        arguments=["PyObject* a"],
+        cmpfunc=unhandled_error_compare
+    )
+
+    if not GRAALPYTHON or sys.platform != "linux":
+        del test_PyO3_symbols