Implement C API symbol cache using an array

Author: fangerer

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/PythonLanguage.java

@@ -364,9 +364,6 @@ public boolean isSingleContext() {
     @CompilationFinal(dimensions = 1) private volatile Object[] engineOptionsStorage;
     @CompilationFinal private volatile OptionValues engineOptions;
 
-    /** A shared shape for the C symbol cache (lazily initialized). */
-    private Shape cApiSymbolCache;
-
     /** For fast access to the PythonThreadState object by the owning thread. */
     private final ContextThreadLocal<PythonThreadState> threadState = locals.createContextThreadLocal(PythonContext.PythonThreadState::new);
 
@@ -984,17 +981,6 @@ public Shape getBuiltinTypeInstanceShape(PythonBuiltinClassType type) {
         return shape;
     }
 
-    /**
-     * Returns the shape used for the C API symbol cache.
-     */
-    @TruffleBoundary
-    public synchronized Shape getCApiSymbolCacheShape() {
-        if (cApiSymbolCache == null) {
-            cApiSymbolCache = Shape.newBuilder().build();
-        }
-        return cApiSymbolCache;
-    }
-
     /**
      * Cache call targets that are created for every new context, based on a single key.
      */

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

@@ -79,7 +79,6 @@
 import com.oracle.graal.python.builtins.objects.cext.capi.ExternalFunctionNodes.SetterRoot;
 import com.oracle.graal.python.builtins.objects.cext.common.CArrayWrappers.CArrayWrapper;
 import com.oracle.graal.python.builtins.objects.cext.common.CExtContext;
-import com.oracle.graal.python.builtins.objects.cext.common.CExtContext.Store;
 import com.oracle.graal.python.builtins.objects.common.DynamicObjectStorage;
 import com.oracle.graal.python.builtins.objects.dict.PDict;
 import com.oracle.graal.python.builtins.objects.function.PBuiltinFunction;
@@ -120,6 +119,8 @@
 import com.oracle.truffle.api.library.CachedLibrary;
 import com.oracle.truffle.api.nodes.Node;
 import com.oracle.truffle.api.nodes.RootNode;
+import com.oracle.truffle.api.object.DynamicObject;
+import com.oracle.truffle.api.object.Shape;
 import com.oracle.truffle.api.profiles.InlinedExactClassProfile;
 import com.oracle.truffle.api.strings.TruffleString;
 import com.oracle.truffle.api.utilities.CyclicAssumption;
@@ -164,14 +165,20 @@ static Object doIt(PythonNativeClass self, TruffleString className) {
         }
     }
 
+    static final class NativeTypeDictStorage extends DynamicObject {
+        public NativeTypeDictStorage(Shape shape) {
+            super(shape);
+        }
+    }
+
     @CApiBuiltin(ret = PyObjectTransfer, args = {PyTypeObject}, call = Ignored)
     abstract static class PyTruffle_NewTypeDict extends CApiUnaryBuiltinNode {
 
         @Specialization
         @TruffleBoundary
         static PDict doGeneric(PythonNativeClass nativeClass) {
             PythonLanguage language = PythonLanguage.get(null);
-            Store nativeTypeStore = new Store(language.getEmptyShape());
+            NativeTypeDictStorage nativeTypeStore = new NativeTypeDictStorage(language.getEmptyShape());
             PDict dict = PythonObjectFactory.getUncached().createDict(new DynamicObjectStorage(nativeTypeStore));
             HiddenAttr.WriteNode.executeUncached(dict, HiddenAttr.INSTANCESHAPE, language.getShapeForClass(nativeClass));
             return dict;

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/capi/CApiContext.java

@@ -126,8 +126,6 @@
 import com.oracle.truffle.api.library.ExportLibrary;
 import com.oracle.truffle.api.library.ExportMessage;
 import com.oracle.truffle.api.nodes.Node;
-import com.oracle.truffle.api.object.DynamicObjectLibrary;
-import com.oracle.truffle.api.object.Shape;
 import com.oracle.truffle.api.source.Source;
 import com.oracle.truffle.api.source.Source.SourceBuilder;
 import com.oracle.truffle.api.strings.TruffleString;
@@ -201,6 +199,9 @@ public final class CApiContext extends CExtContext {
     public Object timezoneType;
     private PyCapsule pyDateTimeCAPICapsule;
 
+    /** A cache for C symbols. */
+    private final Object[] nativeSymbolCache;
+
     private record ClosureInfo(Object closure, Object delegate, Object executable, long pointer) {
     }
 
@@ -239,6 +240,7 @@ public static TruffleLogger getLogger(Class<?> clazz) {
 
     public CApiContext(PythonContext context, Object llvmLibrary, boolean useNativeBackend) {
         super(context, llvmLibrary, useNativeBackend);
+        this.nativeSymbolCache = new Object[NativeCAPISymbol.values().length];
 
         // initialize primitive native wrapper cache
         primitiveNativeWrapperCache = new PrimitiveNativeWrapper[262];
@@ -382,27 +384,32 @@ private void freeSmallInts() {
         }
     }
 
-    @TruffleBoundary
-    @Override
-    protected Store initializeSymbolCache() {
-        PythonLanguage language = getContext().getLanguage();
-        Shape symbolCacheShape = language.getCApiSymbolCacheShape();
-        // We will always get an empty shape from the language and we do always add same key-value
-        // pairs (in the same order). So, in the end, each context should get the same shape.
-        Store s = new Store(symbolCacheShape);
-        for (NativeCAPISymbol sym : NativeCAPISymbol.getValues()) {
-            DynamicObjectLibrary.getUncached().put(s, sym, PNone.NO_VALUE);
-        }
-        return s;
-    }
-
     public Object getModuleByIndex(int i) {
         if (i < modulesByIndex.size()) {
             return modulesByIndex.get(i);
         }
         return null;
     }
 
+    public Object getNativeSymbol(NativeCAPISymbol symbol) {
+        Object result = nativeSymbolCache[symbol.ordinal()];
+        if (CompilerDirectives.injectBranchProbability(CompilerDirectives.SLOWPATH_PROBABILITY, result == null)) {
+            result = lookupNativeSymbol(symbol);
+        }
+        return result;
+    }
+
+    @TruffleBoundary
+    private Object lookupNativeSymbol(NativeCAPISymbol symbol) {
+        String name = symbol.getName();
+        try {
+            Object nativeSymbol = InteropLibrary.getUncached().readMember(getLLVMLibrary(), name);
+            return nativeSymbolCache[symbol.ordinal()] = CExtContext.ensureExecutable(nativeSymbol, symbol);
+        } catch (UnsupportedMessageException | UnknownIdentifierException e) {
+            throw CompilerDirectives.shouldNotReachHere(e);
+        }
+    }
+
     @TruffleBoundary
     public AllocInfo traceFree(Object ptr, @SuppressWarnings("unused") PFrame.Reference curFrame, @SuppressWarnings("unused") TruffleString clazzName) {
         if (allocatedNativeMemory == null) {

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/common/CExtCommonNodes.java

@@ -59,8 +59,10 @@
 import com.oracle.graal.python.builtins.objects.PNone;
 import com.oracle.graal.python.builtins.objects.bytes.BytesCommonBuiltins;
 import com.oracle.graal.python.builtins.objects.cext.PythonNativeVoidPtr;
+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.FromCharPointerNode;
+import com.oracle.graal.python.builtins.objects.cext.capi.NativeCAPISymbol;
 import com.oracle.graal.python.builtins.objects.cext.capi.PrimitiveNativeWrapper;
 import com.oracle.graal.python.builtins.objects.cext.common.CArrayWrappers.CByteArrayWrapper;
 import com.oracle.graal.python.builtins.objects.cext.common.CExtCommonNodesFactory.GetIndexNodeGen;
@@ -93,7 +95,6 @@
 import com.oracle.graal.python.runtime.object.PythonObjectFactory;
 import com.oracle.graal.python.util.OverflowException;
 import com.oracle.graal.python.util.PythonUtils;
-import com.oracle.truffle.api.CompilerAsserts;
 import com.oracle.truffle.api.CompilerDirectives;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.HostCompilerDirectives.InliningCutoff;
@@ -108,13 +109,10 @@
 import com.oracle.truffle.api.dsl.Specialization;
 import com.oracle.truffle.api.interop.InteropException;
 import com.oracle.truffle.api.interop.InteropLibrary;
-import com.oracle.truffle.api.interop.UnknownIdentifierException;
 import com.oracle.truffle.api.interop.UnsupportedMessageException;
 import com.oracle.truffle.api.library.CachedLibrary;
 import com.oracle.truffle.api.nodes.Node;
 import com.oracle.truffle.api.nodes.UnexpectedResultException;
-import com.oracle.truffle.api.object.DynamicObject;
-import com.oracle.truffle.api.object.DynamicObjectLibrary;
 import com.oracle.truffle.api.profiles.InlinedBranchProfile;
 import com.oracle.truffle.api.profiles.InlinedConditionProfile;
 import com.oracle.truffle.api.strings.TruffleString;
@@ -155,55 +153,22 @@ public static void fatalError(Node location, PythonContext context, String prefi
     @GenerateCached(false)
     public abstract static class ImportCExtSymbolNode extends PNodeWithContext {
 
-        public abstract Object execute(Node inliningTarget, CExtContext nativeContext, NativeCExtSymbol symbol);
-
-        @Specialization(guards = {"isSingleContext()", "cachedSymbol == symbol"}, limit = "1")
-        static Object doSymbolCached(@SuppressWarnings("unused") Node inliningTarget, @SuppressWarnings("unused") CExtContext nativeContext, @SuppressWarnings("unused") NativeCExtSymbol symbol,
-                        @Cached("symbol") @SuppressWarnings("unused") NativeCExtSymbol cachedSymbol,
-                        @Cached("importCAPISymbolUncached(inliningTarget, nativeContext, symbol)") Object llvmSymbol) {
-            return llvmSymbol;
+        public final Object execute(Node inliningTarget, NativeCAPISymbol symbol) {
+            return execute(inliningTarget, PythonContext.get(inliningTarget).getCApiContext(), symbol);
         }
 
-        // n.b. if 'singleContextAssumption' is valid, we may also cache the native context
-        @Specialization(guards = {"isSingleContext()", "nativeContext == cachedNativeContext"}, limit = "1", //
-                        replaces = "doSymbolCached")
-        static Object doWithSymbolCacheSingleContext(Node inliningTarget, @SuppressWarnings("unused") CExtContext nativeContext, NativeCExtSymbol symbol,
-                        @Cached("nativeContext") CExtContext cachedNativeContext,
-                        @Cached("nativeContext.getSymbolCache()") DynamicObject cachedSymbolCache,
-                        @CachedLibrary("cachedSymbolCache") DynamicObjectLibrary dynamicObjectLib) {
-            return doWithSymbolCache(inliningTarget, cachedNativeContext, symbol, cachedSymbolCache, dynamicObjectLib);
-        }
-
-        @Specialization(replaces = {"doSymbolCached", "doWithSymbolCacheSingleContext"}, limit = "1")
-        static Object doWithSymbolCache(Node inliningTarget, CExtContext nativeContext, NativeCExtSymbol symbol,
-                        @Bind("nativeContext.getSymbolCache()") DynamicObject symbolCache,
-                        @CachedLibrary("symbolCache") DynamicObjectLibrary dynamicObjectLib) {
-            Object nativeSymbol = dynamicObjectLib.getOrDefault(symbolCache, symbol, PNone.NO_VALUE);
-            if (nativeSymbol == PNone.NO_VALUE) {
-                nativeSymbol = importCAPISymbolUncached(inliningTarget, nativeContext, symbol, symbolCache, dynamicObjectLib);
-            }
-            return nativeSymbol;
-        }
+        public abstract Object execute(Node inliningTarget, CApiContext nativeContext, NativeCExtSymbol symbol);
 
-        protected static Object importCAPISymbolUncached(Node location, CExtContext nativeContext, NativeCExtSymbol symbol) {
-            CompilerAsserts.neverPartOfCompilation();
-            return importCAPISymbolUncached(location, nativeContext, symbol, nativeContext.getSymbolCache(), DynamicObjectLibrary.getUncached());
+        @Specialization(guards = {"isSingleContext()", "cachedSymbol == symbol"}, limit = "1")
+        static Object doCached(@SuppressWarnings("unused") Node inliningTarget, @SuppressWarnings("unused") CApiContext nativeContext, @SuppressWarnings("unused") NativeCAPISymbol symbol,
+                        @Cached("symbol") @SuppressWarnings("unused") NativeCAPISymbol cachedSymbol,
+                        @Cached(value = "nativeContext.getNativeSymbol(symbol)", weak = true) Object llvmSymbol) {
+            return llvmSymbol;
         }
 
-        @TruffleBoundary
-        protected static Object importCAPISymbolUncached(Node location, CExtContext nativeContext, NativeCExtSymbol symbol, DynamicObject symbolCache, DynamicObjectLibrary dynamicObjectLib) {
-            Object llvmLibrary = nativeContext.getLLVMLibrary();
-            String name = symbol.getName();
-            try {
-                Object nativeSymbol = InteropLibrary.getUncached().readMember(llvmLibrary, name);
-                nativeSymbol = CExtContext.ensureExecutable(nativeSymbol, symbol);
-                dynamicObjectLib.put(symbolCache, symbol, nativeSymbol);
-                return nativeSymbol;
-            } catch (UnknownIdentifierException e) {
-                throw PRaiseNode.raiseUncached(location, PythonBuiltinClassType.SystemError, ErrorMessages.INVALID_CAPI_FUNC, symbol.getTsName());
-            } catch (UnsupportedMessageException e) {
-                throw PRaiseNode.raiseUncached(location, PythonBuiltinClassType.SystemError, ErrorMessages.CORRUPTED_CAPI_LIB_OBJ, llvmLibrary);
-            }
+        @Specialization(replaces = "doCached")
+        static Object doGeneric(CApiContext nativeContext, NativeCAPISymbol symbol) {
+            return nativeContext.getNativeSymbol(symbol);
         }
     }
 

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/common/CExtContext.java

@@ -89,8 +89,6 @@
 import com.oracle.truffle.api.interop.UnsupportedMessageException;
 import com.oracle.truffle.api.interop.UnsupportedTypeException;
 import com.oracle.truffle.api.nodes.Node;
-import com.oracle.truffle.api.object.DynamicObject;
-import com.oracle.truffle.api.object.Shape;
 import com.oracle.truffle.api.source.Source;
 import com.oracle.truffle.api.strings.TruffleString;
 import com.oracle.truffle.api.strings.TruffleString.CodeRange;
@@ -128,9 +126,6 @@ private static TruffleLogger getLogger() {
     /** The LLVM bitcode library object representing 'libpython.*.so' or similar. */
     private final Object llvmLibrary;
 
-    /** A cache for C symbols. */
-    private DynamicObject symbolCache;
-
     /**
      * The native API implementation was loaded as native code (as opposed to bitcode via Sulong).
      */
@@ -186,21 +181,6 @@ public static boolean isClassOrStaticMethod(int flags) {
         return flags > 0 && (flags & (METH_CLASS | METH_STATIC)) != 0;
     }
 
-    public static final class Store extends DynamicObject {
-        public Store(Shape shape) {
-            super(shape);
-        }
-    }
-
-    public final DynamicObject getSymbolCache() {
-        if (symbolCache == null) {
-            symbolCache = initializeSymbolCache();
-        }
-        return symbolCache;
-    }
-
-    protected abstract Store initializeSymbolCache();
-
     /**
      * A simple helper object that just remembers the name and the path of the original module spec
      * object and also keeps a reference to it. This should avoid redundant attribute reads.

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/hpy/GraalHPyContext.java

@@ -1192,12 +1192,6 @@ private ReferenceQueue<Object> createReferenceQueue() {
         return referenceQueue;
     }
 
-    @Override
-    protected Store initializeSymbolCache() {
-
-        return null;
-    }
-
     public int getCTypeSize(HPyContextSignatureType ctype) {
         return backend.getCTypeSize(ctype);
     }