[GR-49560] [GR-49497] [GR-50157] Refactor Python native wrapper hierarchy.

PullRequest: graalpython/3049

Author: fangerer

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

@@ -456,7 +456,7 @@ PyAPI_FUNC(Py_ssize_t) PyTruffle_bulk_DEALLOC(intptr_t ptrArray[], int64_t len)
 
 /** to be used from Java code only and only at exit; calls _Py_Dealloc */
 PyAPI_FUNC(Py_ssize_t) PyTruffle_shutdown_bulk_DEALLOC(intptr_t ptrArray[], int64_t len) {
-    /* some objects depends on others which might get deallocated in the process 
+    /* some objects depends on others which might get deallocated in the process
         of an earlier deallocation of the other object. To avoid double deallocations,
         we, temporarly, make all objects immortal artificially */
 	for (int i = 0; i < len; i++) {
@@ -883,12 +883,41 @@ So we rebind them to no-ops when exiting.
 Py_ssize_t nop_GraalPy_get_PyObject_ob_refcnt(PyObject* obj) {
  return 100; // large dummy refcount
 }
+
 void nop_GraalPy_set_PyObject_ob_refcnt(PyObject* obj, Py_ssize_t refcnt) {
  // do nothing
 }
-PyAPI_FUNC(void) finalizeCAPI() {
- GraalPy_get_PyObject_ob_refcnt = nop_GraalPy_get_PyObject_ob_refcnt;
- GraalPy_set_PyObject_ob_refcnt = nop_GraalPy_set_PyObject_ob_refcnt;
+
+/*
+ * This array contains pairs of variable address and "reset value".
+ * The variable location is usually the address of a function pointer variable
+ * and the reset value is a new value to set at VM shutdown.
+ * For further explanation why this is required, see Java method
+ * 'CApiContext.ensureCapiWasLoaded'.
+ *
+ * Array format: [ var_addr, reset_val, var_addr1, reset_val1, ..., NULL ]
+ *
+ * ATTENTION: If the structure of the array's content is changed, method
+ *            'CApiContext.addNativeFinalizer' *MUST BE* adopted.
+ *
+ * ATTENTION: the array is expected to be NULL-terminated !
+ *
+ */
+static int64_t reset_func_ptrs[] = {
+        &GraalPy_get_PyObject_ob_refcnt,
+        nop_GraalPy_get_PyObject_ob_refcnt,
+        &GraalPy_set_PyObject_ob_refcnt,
+        nop_GraalPy_set_PyObject_ob_refcnt,
+        /* sentinel (required) */
+        NULL
+};
+
+/*
+ * This function is called from Java during C API initialization to get the
+ * pointer to array 'reset_func_pts'.
+ */
+PyAPI_FUNC(int64_t *) GraalPy_get_finalize_capi_pointer_array() {
+    return reset_func_ptrs;
 }
 
 static void unimplemented(const char* name) {

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/GraalPythonModuleBuiltins.java

@@ -49,7 +49,6 @@
 import static com.oracle.graal.python.nodes.SpecialMethodNames.T_INSERT;
 import static com.oracle.graal.python.nodes.StringLiterals.J_LLVM_LANGUAGE;
 import static com.oracle.graal.python.nodes.StringLiterals.T_COLON;
-import static com.oracle.graal.python.nodes.StringLiterals.T_EMPTY_STRING;
 import static com.oracle.graal.python.nodes.StringLiterals.T_LLVM_LANGUAGE;
 import static com.oracle.graal.python.nodes.StringLiterals.T_NATIVE;
 import static com.oracle.graal.python.nodes.StringLiterals.T_PATH;
@@ -805,7 +804,7 @@ abstract static class StorageToNative extends PythonUnaryBuiltinNode {
         @Specialization
         @TruffleBoundary
         Object toNative(PBytesLike bytes) {
-            ensureCapi();
+            CApiContext.ensureCapiWasLoaded();
             NativeSequenceStorage newStorage = ToNativeStorageNode.executeUncached(bytes.getSequenceStorage(), true);
             bytes.setSequenceStorage(newStorage);
             return bytes;
@@ -814,7 +813,7 @@ Object toNative(PBytesLike bytes) {
         @Specialization
         @TruffleBoundary
         Object toNative(PArray array) {
-            ensureCapi();
+            CApiContext.ensureCapiWasLoaded();
             NativeSequenceStorage newStorage = ToNativeStorageNode.executeUncached(array.getSequenceStorage(), true);
             array.setSequenceStorage(newStorage);
             return array;
@@ -823,19 +822,11 @@ Object toNative(PArray array) {
         @Specialization
         @TruffleBoundary
         Object toNative(PSequence sequence) {
-            ensureCapi();
+            CApiContext.ensureCapiWasLoaded();
             NativeSequenceStorage newStorage = ToNativeStorageNode.executeUncached(sequence.getSequenceStorage(), false);
             sequence.setSequenceStorage(newStorage);
             return sequence;
         }
-
-        private void ensureCapi() {
-            try {
-                CApiContext.ensureCapiWasLoaded(null, getContext(), T_EMPTY_STRING, T_EMPTY_STRING);
-            } catch (Exception e) {
-                throw CompilerDirectives.shouldNotReachHere(e);
-            }
-        }
     }
 
     @Builtin(name = J_EXTEND, minNumOfPositionalArgs = 1, doc = "Extends Java class and return HostAdapterCLass")

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/SysModuleBuiltins.java

@@ -165,7 +165,7 @@
 import com.oracle.graal.python.builtins.objects.PNone;
 import com.oracle.graal.python.builtins.objects.PythonAbstractObject;
 import com.oracle.graal.python.builtins.objects.cext.PythonAbstractNativeObject;
-import com.oracle.graal.python.builtins.objects.cext.capi.PythonNativeWrapper;
+import com.oracle.graal.python.builtins.objects.cext.capi.PythonNativeWrapper.PythonAbstractObjectNativeWrapper;
 import com.oracle.graal.python.builtins.objects.cext.structs.CStructAccess;
 import com.oracle.graal.python.builtins.objects.common.EconomicMapStorage;
 import com.oracle.graal.python.builtins.objects.common.HashingStorageNodes.HashingStorageSetItem;
@@ -934,13 +934,13 @@ private static String defaultCharsetName() {
     public abstract static class GetrefcountNode extends PythonUnaryBuiltinNode {
 
         @Specialization
-        protected long doGeneric(PythonAbstractObject object,
+        static long doGeneric(PythonAbstractObject object,
                         @Cached CStructAccess.ReadI64Node read) {
             if (object instanceof PythonAbstractNativeObject nativeKlass) {
                 return read.readFromObj(nativeKlass, PyObject__ob_refcnt);
             }
 
-            PythonNativeWrapper wrapper = object.getNativeWrapper();
+            PythonAbstractObjectNativeWrapper wrapper = object.getNativeWrapper();
             if (wrapper == null) {
                 return -1;
             } else {

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/cext/PythonCextObjectBuiltins.java

@@ -82,8 +82,8 @@
 import com.oracle.graal.python.builtins.objects.bytes.PBytesLike;
 import com.oracle.graal.python.builtins.objects.cext.capi.CApiContext;
 import com.oracle.graal.python.builtins.objects.cext.capi.CApiGuards;
-import com.oracle.graal.python.builtins.objects.cext.capi.CExtNodes.ResolveHandleNode;
-import com.oracle.graal.python.builtins.objects.cext.capi.PythonNativeWrapper;
+import com.oracle.graal.python.builtins.objects.cext.capi.PythonNativeWrapper.PythonAbstractObjectNativeWrapper;
+import com.oracle.graal.python.builtins.objects.cext.capi.CExtNodes.ResolvePointerNode;
 import com.oracle.graal.python.builtins.objects.cext.capi.transitions.CApiTransitions.NativeToPythonNode;
 import com.oracle.graal.python.builtins.objects.cext.capi.transitions.CApiTransitions.PythonToNativeNode;
 import com.oracle.graal.python.builtins.objects.cext.common.GetNextVaArgNode;
@@ -142,7 +142,10 @@
 import com.oracle.truffle.api.profiles.InlinedBranchProfile;
 import com.oracle.truffle.api.strings.TruffleString;
 
-public class PythonCextObjectBuiltins {
+public abstract class PythonCextObjectBuiltins {
+
+    private PythonCextObjectBuiltins() {
+    }
 
     @CApiBuiltin(ret = PyObjectTransfer, args = {PyObject, PyObject, PyObject, Int}, call = Direct)
     abstract static class _PyTruffleObject_Call1 extends CApiQuaternaryBuiltinNode {
@@ -592,13 +595,12 @@ int doGeneric(Object ptrObject,
              * At this point we don't know if the pointer is invalid, so we try to resolve it to an
              * object.
              */
-            Object resolved = isWrapper ? ptrObject : ResolveHandleNode.executeUncached(ptrObject);
+            Object resolved = isWrapper ? ptrObject : ResolvePointerNode.executeUncached(ptrObject);
             Object pythonObject;
             long refCnt;
             // We need again check if 'resolved' is a wrapper in case we resolved a handle.
-            if (CApiGuards.isNativeWrapper(resolved)) {
-                PythonNativeWrapper wrapper = (PythonNativeWrapper) resolved;
-                refCnt = wrapper.getRefCount();
+            if (resolved instanceof PythonAbstractObjectNativeWrapper objectNativeWrapper) {
+                refCnt = objectNativeWrapper.getRefCount();
             } else {
                 refCnt = readI64.read(PythonToNativeNode.executeUncached(resolved), CFields.PyObject__ob_refcnt);
             }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/cext/PythonCextSlotBuiltins.java

@@ -110,6 +110,7 @@
 import com.oracle.graal.python.builtins.objects.cext.capi.PyProcsWrapper;
 import com.oracle.graal.python.builtins.objects.cext.capi.PySequenceArrayWrapper;
 import com.oracle.graal.python.builtins.objects.cext.capi.PythonNativeWrapper;
+import com.oracle.graal.python.builtins.objects.cext.capi.PythonNativeWrapper.PythonAbstractObjectNativeWrapper;
 import com.oracle.graal.python.builtins.objects.cext.capi.UnicodeObjectNodes.UnicodeAsWideCharNode;
 import com.oracle.graal.python.builtins.objects.cext.capi.transitions.CApiTransitions;
 import com.oracle.graal.python.builtins.objects.cext.common.CArrayWrappers.CStringWrapper;
@@ -668,7 +669,7 @@ static Object get(PythonModule object) {
     abstract static class Py_get_PyObject_ob_refcnt extends CApiUnaryBuiltinNode {
 
         @Specialization
-        static Object get(PythonNativeWrapper wrapper) {
+        static Object get(PythonAbstractObjectNativeWrapper wrapper) {
             return wrapper.getRefCount();
         }
     }
@@ -777,7 +778,7 @@ static Object set(PythonModule object, Object value) {
     abstract static class Py_set_PyObject_ob_refcnt extends CApiBinaryBuiltinNode {
 
         @Specialization
-        static Object set(PythonNativeWrapper wrapper, long value) {
+        static Object set(PythonAbstractObjectNativeWrapper wrapper, long value) {
             CApiTransitions.setRefCount(wrapper, value);
             return PNone.NONE;
         }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/ctypes/CDataObject.java

@@ -44,7 +44,7 @@
 import com.oracle.graal.python.builtins.modules.ctypes.memory.PointerNodes;
 import com.oracle.graal.python.builtins.objects.buffer.PythonBufferAccessLibrary;
 import com.oracle.graal.python.builtins.objects.buffer.PythonBufferAcquireLibrary;
-import com.oracle.graal.python.builtins.objects.cext.capi.PythonNativeWrapper;
+import com.oracle.graal.python.builtins.objects.cext.capi.PythonNativeWrapper.PythonStructNativeWrapper;
 import com.oracle.graal.python.builtins.objects.cext.capi.transitions.CApiTransitions;
 import com.oracle.graal.python.builtins.objects.object.PythonBuiltinObject;
 import com.oracle.graal.python.nodes.util.CastToJavaStringNode;
@@ -142,7 +142,7 @@ void writeFromByteArray(int destOffset, byte[] src, int srcOffset, int length,
 
     @SuppressWarnings("static-method")
     @ExportLibrary(InteropLibrary.class)
-    public static class CDataObjectWrapper extends PythonNativeWrapper {
+    public static final class CDataObjectWrapper extends PythonStructNativeWrapper {
 
         final byte[] storage;
         final StgDictObject stgDict;
@@ -192,13 +192,13 @@ boolean isMemberReadable(String member,
         }
 
         @ExportMessage
-        final boolean isMemberModifiable(String member,
+        boolean isMemberModifiable(String member,
                         @Shared @Cached CastToJavaStringNode toJavaStringNode) {
             return isMemberReadable(member, toJavaStringNode);
         }
 
         @ExportMessage
-        final boolean isMemberInsertable(@SuppressWarnings("unused") String member) {
+        boolean isMemberInsertable(@SuppressWarnings("unused") String member) {
             return false;
         }
 

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/ctypes/memory/PointerNodes.java

@@ -851,7 +851,7 @@ static Object doPythonObject(@SuppressWarnings("unused") MemoryBlock memory, Pyt
         @Fallback
         static Object doGeneric(Node inliningTarget, MemoryBlock memory, Storage storage, int offset,
                         @Cached GetPointerValueAsObjectNode getPointerValueAsObjectNode,
-                        @Cached CExtNodes.ResolveHandleNode resolveHandleNode,
+                        @Cached CExtNodes.ResolvePointerNode resolveHandleNode,
                         @Cached(inline = false) CApiTransitions.NativeToPythonNode nativeToPythonNode) {
             /*
              * We might get a pointer to a PyObject as a long when calling Python C API functions

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/PythonAbstractObject.java

@@ -71,7 +71,7 @@
 import com.oracle.graal.python.builtins.objects.PythonAbstractObjectFactory.PInteropGetAttributeNodeGen;
 import com.oracle.graal.python.builtins.objects.bytes.PBytes;
 import com.oracle.graal.python.builtins.objects.cext.capi.CApiGuards;
-import com.oracle.graal.python.builtins.objects.cext.capi.PythonNativeWrapper;
+import com.oracle.graal.python.builtins.objects.cext.capi.PythonNativeWrapper.PythonAbstractObjectNativeWrapper;
 import com.oracle.graal.python.builtins.objects.common.DynamicObjectStorage;
 import com.oracle.graal.python.builtins.objects.common.HashingStorage;
 import com.oracle.graal.python.builtins.objects.common.HashingStorageNodes.HashingStorageGetIterator;
@@ -174,7 +174,7 @@ public abstract class PythonAbstractObject extends DynamicObject implements Truf
 
     private static final TruffleString T_PRIVATE_PREFIX = tsLiteral("__");
     private static final int PRIVATE_PREFIX_LENGTH = T_PRIVATE_PREFIX.codePointLengthUncached(TS_ENCODING);
-    private PythonNativeWrapper nativeWrapper;
+    private PythonAbstractObjectNativeWrapper nativeWrapper;
 
     // @ImportStatic doesn't work for this for some reason
     protected static final SpecialMethodSlot Iter = SpecialMethodSlot.Iter;
@@ -191,11 +191,11 @@ protected PythonAbstractObject() {
         super(ABSTRACT_SHAPE);
     }
 
-    public final PythonNativeWrapper getNativeWrapper() {
+    public final PythonAbstractObjectNativeWrapper getNativeWrapper() {
         return nativeWrapper;
     }
 
-    public final void setNativeWrapper(PythonNativeWrapper nativeWrapper) {
+    public final void setNativeWrapper(PythonAbstractObjectNativeWrapper nativeWrapper) {
         assert this.nativeWrapper == null;
 
         // we must not set the native wrapper for one of the context-insensitive singletons