detect libs in dyld cache on macOS >= 11 (inspired by python/cpython@4176193 )

Author: lewurm

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2021, 2022, 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
@@ -163,6 +163,7 @@
 import com.oracle.truffle.api.dsl.UnsupportedSpecializationException;
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.interop.ArityException;
+import com.oracle.truffle.api.interop.InteropException;
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.interop.InvalidArrayIndexException;
 import com.oracle.truffle.api.interop.TruffleObject;
@@ -799,6 +800,70 @@ Object py_dl_sym(VirtualFrame frame, Object obj, Object name,
         }
     }
 
+    @Builtin(name = "_dyld_shared_cache_contains_path", minNumOfPositionalArgs = 1)
+    @GenerateNodeFactory
+    protected abstract static class DyldSharedCacheConstainsPath extends PythonBinaryBuiltinNode {
+        private static boolean hasDynamicLoaderCacheValue = false;
+        private static boolean hasDynamicLoaderCacheInit = false;
+
+        private static boolean hasDynamicLoaderCache() {
+            if (hasDynamicLoaderCacheInit) {
+                return hasDynamicLoaderCacheValue;
+            }
+
+            CompilerDirectives.transferToInterpreter();
+            if (System.getProperty("os.name").contains("Mac")) {
+                String osVersion = System.getProperty("os.version");
+                // dynamic linker cache support on os.version >= 11.x
+                int major = 11;
+                int i = osVersion.indexOf('.');
+                try {
+                    major = Integer.parseInt(i < 0 ? osVersion : osVersion.substring(0, i));
+                } catch (NumberFormatException e) {
+                }
+                hasDynamicLoaderCacheValue = major >= 11;
+            } else {
+                hasDynamicLoaderCacheValue = false;
+            }
+            hasDynamicLoaderCacheInit = true;
+            return hasDynamicLoaderCacheValue;
+        }
+
+        @Specialization
+        Object py_dyld_shared_pstring(VirtualFrame frame, PString ppath,
+                        @CachedLibrary(limit = "1") InteropLibrary ilib) {
+            return py_dyld_shared_cache_contains_path(frame, ppath.getValue(), ilib);
+        }
+
+        @CompilationFinal Object cachedFunction = null;
+
+        // TODO: 'path' might need to be processed using FSConverter.
+        @Specialization
+        Object py_dyld_shared_cache_contains_path(VirtualFrame frame, String path,
+                        @CachedLibrary(limit = "1") InteropLibrary ilib) {
+            if (!hasDynamicLoaderCache()) {
+                throw raise(NotImplementedError, "_dyld_shared_cache_contains_path symbol is missing");
+            }
+
+            try {
+                if (cachedFunction == null) {
+                    String name = "_dyld_shared_cache_contains_path";
+                    CompilerDirectives.transferToInterpreter();
+                    DLHandler handle = DlOpenNode.loadNFILibrary(getContext(), NFIBackend.NATIVE, "", RTLD_LOCAL.getValueIfDefined());
+                    Object sym = ilib.readMember(handle.getLibrary(), name);
+                    // bool _dyld_shared_cache_contains_path(const char* path)
+                    Source source = Source.newBuilder(NFI_LANGUAGE, "(string):sint32", name).build();
+                    Object nfiSignature = getContext().getEnv().parseInternal(source).call();
+                    cachedFunction = SignatureLibrary.getUncached().bind(nfiSignature, sym);
+                    assert ilib.isExecutable(cachedFunction);
+                }
+                return (int) ilib.execute(cachedFunction, path) != 0;
+            } catch (InteropException e) {
+                return false;
+            }
+        }
+    }
+
     @Builtin(name = "alignment", minNumOfPositionalArgs = 1)
     @GenerateNodeFactory
     protected abstract static class AlignmentNode extends PythonUnaryBuiltinNode {

graalpython/lib-python/3/ctypes/macholib/dyld.py

@@ -6,6 +6,12 @@
 from ctypes.macholib.framework import framework_info
 from ctypes.macholib.dylib import dylib_info
 from itertools import *
+try:
+    from _ctypes import _dyld_shared_cache_contains_path
+except ImportError:
+    def _dyld_shared_cache_contains_path(*args):
+        print("dyld_shared_cached_contains_path not implemented")
+        raise NotImplementedError
 
 __all__ = [
     'dyld_find', 'framework_find',
@@ -122,8 +128,15 @@ def dyld_find(name, executable_path=None, env=None):
                 dyld_executable_path_search(name, executable_path),
                 dyld_default_search(name, env),
             ), env):
+
         if os.path.isfile(path):
             return path
+        try:
+            if _dyld_shared_cache_contains_path(path):
+                return path
+        except NotImplementedError:
+            pass
+
     raise ValueError("dylib %s could not be found" % (name,))
 
 def framework_find(fn, executable_path=None, env=None):