Initial support for GraalPy

msimacek · msimacek · commit c1fd3c937044 · 2024-09-19T15:56:49.000+02:00
diff --git a/include/pybind11/cast.h b/include/pybind11/cast.h
@@ -343,7 +343,7 @@ class type_caster<bool> {
 #else
             // Alternate approach for CPython: this does the same as the above, but optimized
             // using the CPython API so as to avoid an unneeded attribute lookup.
-            else if (auto *tp_as_number = src.ptr()->ob_type->tp_as_number) {
+            else if (auto *tp_as_number = Py_TYPE(src.ptr())->tp_as_number) {
                 if (PYBIND11_NB_BOOL(tp_as_number)) {
                     res = (*PYBIND11_NB_BOOL(tp_as_number))(src.ptr());
                 }
diff --git a/include/pybind11/detail/common.h b/include/pybind11/detail/common.h
@@ -299,7 +299,7 @@ PYBIND11_WARNING_DISABLE_MSVC(4505)
 #    define PYBIND11_INTERNAL_NUMPY_1_ONLY_DETECTED
 #endif
 
-#if defined(PYPY_VERSION) && !defined(PYBIND11_SIMPLE_GIL_MANAGEMENT)
+#if (defined(PYPY_VERSION) || defined(GRAALVM_PYTHON)) && !defined(PYBIND11_SIMPLE_GIL_MANAGEMENT)
 #    define PYBIND11_SIMPLE_GIL_MANAGEMENT
 #endif
 
diff --git a/include/pybind11/detail/internals.h b/include/pybind11/detail/internals.h
@@ -454,7 +454,7 @@ inline void translate_local_exception(std::exception_ptr p) {
 
 inline object get_python_state_dict() {
     object state_dict;
-#if PYBIND11_INTERNALS_VERSION <= 4 || defined(PYPY_VERSION)
+#if PYBIND11_INTERNALS_VERSION <= 4 || defined(PYPY_VERSION) || defined(GRAALVM_PYTHON)
     state_dict = reinterpret_borrow<object>(PyEval_GetBuiltins());
 #else
 #    if PY_VERSION_HEX < 0x03090000
diff --git a/include/pybind11/detail/type_caster_base.h b/include/pybind11/detail/type_caster_base.h
@@ -459,7 +459,7 @@ PYBIND11_NOINLINE handle get_object_handle(const void *ptr, const detail::type_i
 }
 
 inline PyThreadState *get_thread_state_unchecked() {
-#if defined(PYPY_VERSION)
+#if defined(PYPY_VERSION) || defined(GRAALVM_PYTHON)
     return PyThreadState_GET();
 #elif PY_VERSION_HEX < 0x030D0000
     return _PyThreadState_UncheckedGet();
diff --git a/include/pybind11/eval.h b/include/pybind11/eval.h
@@ -94,18 +94,18 @@ void exec(const char (&s)[N], object global = globals(), object local = object()
     eval<eval_statements>(s, std::move(global), std::move(local));
 }
 
-#if defined(PYPY_VERSION)
+#if defined(PYPY_VERSION) || defined(GRAALVM_PYTHON)
 template <eval_mode mode = eval_statements>
 object eval_file(str, object, object) {
-    pybind11_fail("eval_file not supported in PyPy3. Use eval");
+    pybind11_fail("eval_file not supported in PyPy3 or GraalPy. Use eval");
 }
 template <eval_mode mode = eval_statements>
 object eval_file(str, object) {
-    pybind11_fail("eval_file not supported in PyPy3. Use eval");
+    pybind11_fail("eval_file not supported in PyPy3 or GraalPy. Use eval");
 }
 template <eval_mode mode = eval_statements>
 object eval_file(str) {
-    pybind11_fail("eval_file not supported in PyPy3. Use eval");
+    pybind11_fail("eval_file not supported in PyPy3 or GraalPy. Use eval");
 }
 #else
 template <eval_mode mode = eval_statements>
diff --git a/include/pybind11/pybind11.h b/include/pybind11/pybind11.h
@@ -573,8 +573,7 @@ class cpp_function : public function {
                 // chain.
                 chain_start = rec;
                 rec->next = chain;
-                auto rec_capsule
-                    = reinterpret_borrow<capsule>(((PyCFunctionObject *) m_ptr)->m_self);
+                auto rec_capsule = reinterpret_borrow<capsule>(PyCFunction_GetSelf(m_ptr));
                 rec_capsule.set_pointer(unique_rec.release());
                 guarded_strdup.release();
             } else {
@@ -636,10 +635,16 @@ class cpp_function : public function {
 
         /* Install docstring */
         auto *func = (PyCFunctionObject *) m_ptr;
+#ifndef GRAALVM_PYTHON
         std::free(const_cast<char *>(func->m_ml->ml_doc));
         // Install docstring if it's non-empty (when at least one option is enabled)
         func->m_ml->ml_doc
             = signatures.empty() ? nullptr : PYBIND11_COMPAT_STRDUP(signatures.c_str());
+#else
+        std::free(const_cast<char *>(GraalPyCFunction_GetDoc(m_ptr)));
+        GraalPyCFunction_SetDoc(
+            m_ptr, signatures.empty() ? nullptr : PYBIND11_COMPAT_STRDUP(signatures.c_str()));
+#endif
 
         if (rec->is_method) {
             m_ptr = PYBIND11_INSTANCE_METHOD_NEW(m_ptr, rec->scope.ptr());
@@ -2780,8 +2785,8 @@ get_type_override(const void *this_ptr, const type_info *this_type, const char *
     }
 
     /* Don't call dispatch code if invoked from overridden function.
-       Unfortunately this doesn't work on PyPy. */
-#if !defined(PYPY_VERSION)
+       Unfortunately this doesn't work on PyPy and GraalPy. */
+#if !defined(PYPY_VERSION) && !defined(GRAALVM_PYTHON)
 #    if PY_VERSION_HEX >= 0x03090000
     PyFrameObject *frame = PyThreadState_GetFrame(PyThreadState_Get());
     if (frame != nullptr) {
diff --git a/include/pybind11/pytypes.h b/include/pybind11/pytypes.h
@@ -643,7 +643,7 @@ struct error_fetch_and_normalize {
 
         bool have_trace = false;
         if (m_trace) {
-#if !defined(PYPY_VERSION)
+#if !defined(PYPY_VERSION) && !defined(GRAALVM_PYTHON)
             auto *tb = reinterpret_cast<PyTracebackObject *>(m_trace.ptr());
 
             // Get the deepest trace possible.
@@ -1356,7 +1356,7 @@ inline bool PyUnicode_Check_Permissive(PyObject *o) {
 #    define PYBIND11_STR_CHECK_FUN PyUnicode_Check
 #endif
 
-inline bool PyStaticMethod_Check(PyObject *o) { return o->ob_type == &PyStaticMethod_Type; }
+inline bool PyStaticMethod_Check(PyObject *o) { return Py_TYPE(o) == &PyStaticMethod_Type; }
 
 class kwargs_proxy : public handle {
 public:
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -28,8 +28,8 @@
 
 @pytest.fixture(scope="session", autouse=True)
 def use_multiprocessing_forkserver_on_linux():
-    if sys.platform != "linux":
-        # The default on Windows and macOS is "spawn": If it's not broken, don't fix it.
+    if sys.platform != "linux" or sys.implementation.name == "graalpy":
+        # The default on Windows, macOS and GraalPy is "spawn": If it's not broken, don't fix it.
         return
 
     # Full background: https://github.com/pybind/pybind11/issues/4105#issuecomment-1301004592
diff --git a/tests/env.py b/tests/env.py
@@ -12,6 +12,7 @@
 
 CPYTHON = platform.python_implementation() == "CPython"
 PYPY = platform.python_implementation() == "PyPy"
+GRAALPY = sys.implementation.name == "graalpy"
 PY_GIL_DISABLED = bool(sysconfig.get_config_var("Py_GIL_DISABLED"))
 
 
diff --git a/tests/test_buffers.py b/tests/test_buffers.py
@@ -70,6 +70,7 @@ def test_format_descriptor_format_buffer_info_equiv(cpp_name, np_dtype):
             assert not np_array_is_matching
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_from_python():
     with pytest.raises(RuntimeError) as excinfo:
         m.Matrix(np.array([1, 2, 3]))  # trying to assign a 1D array
@@ -98,6 +99,7 @@ def test_from_python():
 @pytest.mark.xfail(
     env.PYPY, reason="PyPy 7.3.7 doesn't clear this anymore", strict=False
 )
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_to_python():
     mat = m.Matrix(5, 4)
     assert memoryview(mat).shape == (5, 4)
diff --git a/tests/test_call_policies.cpp b/tests/test_call_policies.cpp
@@ -95,8 +95,8 @@ TEST_SUBMODULE(call_policies, m) {
         },
         py::call_guard<DependentGuard, CustomGuard>());
 
-#if !defined(PYPY_VERSION)
-    // `py::call_guard<py::gil_scoped_release>()` should work in PyPy as well,
+#if !defined(PYPY_VERSION) && !defined(GRAALVM_PYTHON)
+    // `py::call_guard<py::gil_scoped_release>()` should work in PyPy/GraalPy as well,
     // but it's unclear how to test it without `PyGILState_GetThisThreadState`.
     auto report_gil_status = []() {
         auto is_gil_held = false;
diff --git a/tests/test_call_policies.py b/tests/test_call_policies.py
@@ -8,6 +8,7 @@
 
 
 @pytest.mark.xfail("env.PYPY", reason="sometimes comes out 1 off on PyPy", strict=False)
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_keep_alive_argument(capture):
     n_inst = ConstructorStats.detail_reg_inst()
     with capture:
@@ -60,6 +61,7 @@ def test_keep_alive_argument(capture):
     assert str(excinfo.value) == "Could not activate keep_alive!"
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_keep_alive_return_value(capture):
     n_inst = ConstructorStats.detail_reg_inst()
     with capture:
@@ -118,6 +120,7 @@ def test_keep_alive_return_value(capture):
 
 # https://foss.heptapod.net/pypy/pypy/-/issues/2447
 @pytest.mark.xfail("env.PYPY", reason="_PyObject_GetDictPtr is unimplemented")
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_alive_gc(capture):
     n_inst = ConstructorStats.detail_reg_inst()
     p = m.ParentGC()
@@ -137,6 +140,7 @@ def test_alive_gc(capture):
     )
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_alive_gc_derived(capture):
     class Derived(m.Parent):
         pass
@@ -159,6 +163,7 @@ class Derived(m.Parent):
     )
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_alive_gc_multi_derived(capture):
     class Derived(m.Parent, m.Child):
         def __init__(self):
diff --git a/tests/test_callbacks.py b/tests/test_callbacks.py
@@ -90,6 +90,7 @@ def f(*args, **kwargs):
     )
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_lambda_closure_cleanup():
     m.test_lambda_closure_cleanup()
     cstats = m.payload_cstats()
@@ -98,6 +99,7 @@ def test_lambda_closure_cleanup():
     assert cstats.move_constructions >= 1
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_cpp_callable_cleanup():
     alive_counts = m.test_cpp_callable_cleanup()
     assert alive_counts == [0, 1, 2, 1, 2, 1, 0]
diff --git a/tests/test_class.py b/tests/test_class.py
@@ -361,7 +361,7 @@ def test_brace_initialization():
     assert b.vec == [123, 456]
 
 
-@pytest.mark.xfail("env.PYPY")
+@pytest.mark.xfail("env.PYPY or env.GRAALPY")
 def test_class_refcount():
     """Instances must correctly increase/decrease the reference count of their types (#1029)"""
     from sys import getrefcount
diff --git a/tests/test_cmake_build/CMakeLists.txt b/tests/test_cmake_build/CMakeLists.txt
@@ -55,8 +55,10 @@ possibly_uninitialized(PYTHON_MODULE_EXTENSION Python_INTERPRETER_ID)
 
 pybind11_add_build_test(subdirectory_function)
 pybind11_add_build_test(subdirectory_target)
-if("${PYTHON_MODULE_EXTENSION}" MATCHES "pypy" OR "${Python_INTERPRETER_ID}" STREQUAL "PyPy")
-  message(STATUS "Skipping embed test on PyPy")
+if("${PYTHON_MODULE_EXTENSION}" MATCHES "pypy"
+   OR "${Python_INTERPRETER_ID}" STREQUAL "PyPy"
+   OR "${PYTHON_MODULE_EXTENSION}" MATCHES "graalpy")
+  message(STATUS "Skipping embed test on PyPy or GraalPy")
 else()
   pybind11_add_build_test(subdirectory_embed)
 endif()
@@ -68,8 +70,10 @@ if(PYBIND11_INSTALL)
 
   pybind11_add_build_test(installed_function INSTALL)
   pybind11_add_build_test(installed_target INSTALL)
-  if(NOT ("${PYTHON_MODULE_EXTENSION}" MATCHES "pypy" OR "${Python_INTERPRETER_ID}" STREQUAL "PyPy"
-         ))
+  if(NOT
+     ("${PYTHON_MODULE_EXTENSION}" MATCHES "pypy"
+      OR "${Python_INTERPRETER_ID}" STREQUAL "PyPy"
+      OR "${PYTHON_MODULE_EXTENSION}" MATCHES "graalpy"))
     pybind11_add_build_test(installed_embed INSTALL)
   endif()
 endif()
diff --git a/tests/test_custom_type_setup.py b/tests/test_custom_type_setup.py
@@ -34,15 +34,15 @@ def add_ref(obj):
 
 
 # PyPy does not seem to reliably garbage collect.
-@pytest.mark.skipif("env.PYPY")
+@pytest.mark.skipif("env.PYPY or env.GRAALPY")
 def test_self_cycle(gc_tester):
     obj = m.OwnsPythonObjects()
     obj.value = obj
     gc_tester(obj)
 
 
 # PyPy does not seem to reliably garbage collect.
-@pytest.mark.skipif("env.PYPY")
+@pytest.mark.skipif("env.PYPY or env.GRAALPY")
 def test_indirect_cycle(gc_tester):
     obj = m.OwnsPythonObjects()
     obj_list = [obj]
diff --git a/tests/test_eigen_matrix.py b/tests/test_eigen_matrix.py
@@ -2,6 +2,7 @@
 
 import pytest
 
+import env  # noqa: F401
 from pybind11_tests import ConstructorStats
 
 np = pytest.importorskip("numpy")
@@ -409,6 +410,7 @@ def assert_keeps_alive(cl, method, *args):
     assert cstats.alive() == start_with
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_eigen_keepalive():
     a = m.ReturnTester()
     cstats = ConstructorStats.get(m.ReturnTester)
diff --git a/tests/test_eigen_tensor.py b/tests/test_eigen_tensor.py
@@ -4,6 +4,8 @@
 
 import pytest
 
+import env  # noqa: F401
+
 np = pytest.importorskip("numpy")
 eigen_tensor = pytest.importorskip("pybind11_tests.eigen_tensor")
 submodules = [eigen_tensor.c_style, eigen_tensor.f_style]
@@ -61,6 +63,7 @@ def assert_equal_tensor_ref(mat, writeable=True, modified=None):
 
 @pytest.mark.parametrize("m", submodules)
 @pytest.mark.parametrize("member_name", ["member", "member_view"])
+@pytest.mark.skipif("env.GRAALPY", reason="Different refcounting mechanism")
 def test_reference_internal(m, member_name):
     if not hasattr(sys, "getrefcount"):
         pytest.skip("No reference counting")
diff --git a/tests/test_embed/CMakeLists.txt b/tests/test_embed/CMakeLists.txt
@@ -1,8 +1,10 @@
 possibly_uninitialized(PYTHON_MODULE_EXTENSION Python_INTERPRETER_ID)
 
-if("${PYTHON_MODULE_EXTENSION}" MATCHES "pypy" OR "${Python_INTERPRETER_ID}" STREQUAL "PyPy")
-  message(STATUS "Skipping embed test on PyPy")
-  add_custom_target(cpptest) # Dummy target on PyPy. Embedding is not supported.
+if("${PYTHON_MODULE_EXTENSION}" MATCHES "pypy"
+   OR "${Python_INTERPRETER_ID}" STREQUAL "PyPy"
+   OR "${PYTHON_MODULE_EXTENSION}" MATCHES "graalpy")
+  message(STATUS "Skipping embed test on PyPy or GraalPy")
+  add_custom_target(cpptest) # Dummy target on PyPy or GraalPy. Embedding is not supported.
   set(_suppress_unused_variable_warning "${DOWNLOAD_CATCH}")
   return()
 endif()
diff --git a/tests/test_eval.py b/tests/test_eval.py
@@ -19,7 +19,7 @@ def test_evals(capture):
     assert m.test_eval_failure()
 
 
-@pytest.mark.xfail("env.PYPY", raises=RuntimeError)
+@pytest.mark.xfail("env.PYPY or env.GRAALPY", raises=RuntimeError)
 def test_eval_file():
     filename = os.path.join(os.path.dirname(__file__), "test_eval_call.py")
     assert m.test_eval_file(filename)
diff --git a/tests/test_factory_constructors.py b/tests/test_factory_constructors.py
@@ -4,11 +4,13 @@
 
 import pytest
 
+import env  # noqa: F401
 from pybind11_tests import ConstructorStats
 from pybind11_tests import factory_constructors as m
 from pybind11_tests.factory_constructors import tag
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_init_factory_basic():
     """Tests py::init_factory() wrapper around various ways of returning the object"""
 
@@ -102,6 +104,7 @@ def test_init_factory_signature(msg):
     )
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_init_factory_casting():
     """Tests py::init_factory() wrapper with various upcasting and downcasting returns"""
 
@@ -150,6 +153,7 @@ def test_init_factory_casting():
     ]
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_init_factory_alias():
     """Tests py::init_factory() wrapper with value conversions and alias types"""
 
diff --git a/tests/test_kwargs_and_defaults.py b/tests/test_kwargs_and_defaults.py
@@ -2,6 +2,7 @@
 
 import pytest
 
+import env  # noqa: F401
 from pybind11_tests import kwargs_and_defaults as m
 
 
@@ -378,6 +379,7 @@ def test_signatures():
     )
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Different refcounting mechanism")
 def test_args_refcount():
     """Issue/PR #1216 - py::args elements get double-inc_ref()ed when combined with regular
     arguments"""
diff --git a/tests/test_methods_and_attributes.py b/tests/test_methods_and_attributes.py
@@ -19,6 +19,7 @@
 )
 
 
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_methods_and_attributes():
     instance1 = m.ExampleMandA()
     instance2 = m.ExampleMandA(32)
@@ -295,6 +296,7 @@ def test_property_rvalue_policy():
 
 # https://foss.heptapod.net/pypy/pypy/-/issues/2447
 @pytest.mark.xfail("env.PYPY")
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_dynamic_attributes():
     instance = m.DynamicClass()
     assert not hasattr(instance, "foo")
@@ -337,6 +339,7 @@ class PythonDerivedDynamicClass(m.DynamicClass):
 
 # https://foss.heptapod.net/pypy/pypy/-/issues/2447
 @pytest.mark.xfail("env.PYPY")
+@pytest.mark.skipif("env.GRAALPY", reason="Cannot reliably trigger GC")
 def test_cyclic_gc():
     # One object references itself
     instance = m.DynamicClass()
diff --git a/tests/test_modules.py b/tests/test_modules.py
diff --git a/tests/test_multiple_inheritance.py b/tests/test_multiple_inheritance.py
diff --git a/tests/test_numpy_array.py b/tests/test_numpy_array.py
diff --git a/tests/test_pickling.py b/tests/test_pickling.py
diff --git a/tests/test_pytypes.py b/tests/test_pytypes.py
diff --git a/tests/test_sequences_and_iterators.py b/tests/test_sequences_and_iterators.py
diff --git a/tests/test_smart_ptr.py b/tests/test_smart_ptr.py
diff --git a/tests/test_stl.py b/tests/test_stl.py
diff --git a/tests/test_type_caster_pyobject_ptr.cpp b/tests/test_type_caster_pyobject_ptr.cpp
diff --git a/tests/test_virtual_functions.py b/tests/test_virtual_functions.py

Original file line number	Diff line number	Diff line change
`@@ -343,7 +343,7 @@ class type_caster<bool> {`
`343`	`343`	`#else`
`344`	`344`	`// Alternate approach for CPython: this does the same as the above, but optimized`
`345`	`345`	`// using the CPython API so as to avoid an unneeded attribute lookup.`
`346`		`- else if (auto *tp_as_number = src.ptr()->ob_type->tp_as_number) {`
	`346`	`+ else if (auto *tp_as_number = Py_TYPE(src.ptr())->tp_as_number) {`
`347`	`347`	`if (PYBIND11_NB_BOOL(tp_as_number)) {`
`348`	`348`	`res = (*PYBIND11_NB_BOOL(tp_as_number))(src.ptr());`
`349`	`349`	`}`
Original file line number	Diff line number	Diff line change
`@@ -459,7 +459,7 @@ PYBIND11_NOINLINE handle get_object_handle(const void *ptr, const detail::type_i`
`459`	`459`	`}`
`460`	`460`
`461`	`461`	`inline PyThreadState *get_thread_state_unchecked() {`
`462`		`-#if defined(PYPY_VERSION)`
	`462`	`+#if defined(PYPY_VERSION) \|\| defined(GRAALVM_PYTHON)`
`463`	`463`	`return PyThreadState_GET();`
`464`	`464`	`#elif PY_VERSION_HEX < 0x030D0000`
`465`	`465`	`return _PyThreadState_UncheckedGet();`
Original file line number	Diff line number	Diff line change
`@@ -94,18 +94,18 @@ void exec(const char (&s)[N], object global = globals(), object local = object()`
`94`	`94`	`eval<eval_statements>(s, std::move(global), std::move(local));`
`95`	`95`	`}`
`96`	`96`
`97`		`-#if defined(PYPY_VERSION)`
	`97`	`+#if defined(PYPY_VERSION) \|\| defined(GRAALVM_PYTHON)`
`98`	`98`	`template <eval_mode mode = eval_statements>`
`99`	`99`	`object eval_file(str, object, object) {`
`100`		`- pybind11_fail("eval_file not supported in PyPy3. Use eval");`
	`100`	`+ pybind11_fail("eval_file not supported in PyPy3 or GraalPy. Use eval");`
`101`	`101`	`}`
`102`	`102`	`template <eval_mode mode = eval_statements>`
`103`	`103`	`object eval_file(str, object) {`
`104`		`- pybind11_fail("eval_file not supported in PyPy3. Use eval");`
	`104`	`+ pybind11_fail("eval_file not supported in PyPy3 or GraalPy. Use eval");`
`105`	`105`	`}`
`106`	`106`	`template <eval_mode mode = eval_statements>`
`107`	`107`	`object eval_file(str) {`
`108`		`- pybind11_fail("eval_file not supported in PyPy3. Use eval");`
	`108`	`+ pybind11_fail("eval_file not supported in PyPy3 or GraalPy. Use eval");`
`109`	`109`	`}`
`110`	`110`	`#else`
`111`	`111`	`template <eval_mode mode = eval_statements>`