[GR-71042] Espresso: Introduce --java.NativeBackend=nfi-staticlib on Darwin (default for JVM mode)

PullRequest: graal/22455

Author: lewurm

espresso-compiler-stub/mx.espresso-compiler-stub/mx_espresso_compiler_stub.py

@@ -64,10 +64,15 @@ def create_ni_standalone(base_standalone_name, register_distribution):
                 f'dependency:espresso:{base_standalone_name}/languages/java/lib/<lib:javavm>'
             ]
         else:
-            idx = layout['languages/java/lib/'].index('dependency:espresso:com.oracle.truffle.espresso.mokapot/*/<multitarget_libc_selection>/<lib:jvm>')
-            layout['languages/java/lib/'][idx] = f'dependency:espresso:{base_standalone_name}/languages/java/lib/<lib:jvm>'
+            idx = layout['languages/java/lib/'].index('dependency:espresso:ESPRESSO_JVM_STANDALONE_MOKAPOT_SUPPORT/*')
+            if mx.is_darwin():
+                layout['languages/java/lib/'][idx] = f'dependency:espresso:{base_standalone_name}/languages/java/lib/fatpot/<lib:jvm>'
+            else:
+                layout['languages/java/lib/'][idx] = f'dependency:espresso:{base_standalone_name}/languages/java/lib/<lib:jvm>'
+
             idx = layout['bin/'].index('dependency:espresso:espresso')
             del layout['bin/'][idx]
+
             layout['bin/<exe:espresso>'] = f'dependency:espresso:{base_standalone}/bin/<exe:espresso>'
             layout['bin/<exe:java>'] = 'link:<exe:espresso>'
             layout['./'][0]['exclude'].append("bin/<exe:java>")
@@ -86,14 +91,16 @@ def create_ni_standalone(base_standalone_name, register_distribution):
             if espresso_java_home.java_home != mx_sdk_vm.base_jdk(stage1=False).home:
                 mx.abort(f"ESPRESSO_JAVA_HOME(={espresso_java_home.java_home}) must match JAVA_HOME (={mx_sdk_vm.base_jdk(stage1=True).home}) (or FINAL_STAGE_JAVA_HOME (={mx_sdk_vm.base_jdk(stage1=False).home}) if set)")
 
+            prefix = '*/Contents/Home/' if mx.is_darwin() else '*/'
+
             # substratevm is available and ESPRESSO_JAVA_HOME is JAVA_HOME, use GraalVM
             layout['./'][0]['source_type'] = 'extracted-dependency'
             layout['./'][0]['dependency'] = get_final_graalvm_distribution().qualifiedName()
-            layout['./'][0]['path'] = '*/*'
+            layout['./'][0]['path'] = prefix + '*'
             layout['./'][0]['exclude'] += [
-                '*/languages/elau',
-                '*/languages/java',
-                '*/bin/espresso'
+                prefix + 'languages/elau',
+                prefix + 'languages/java',
+                prefix + 'bin/espresso'
             ]
         else:
             layout = None

espresso/docs/hacking.md

@@ -165,9 +165,14 @@ $ LD_DEBUG=unused mx espresso -cp mxbuild/dists/jdk1.8/espresso-playground.jar c
 
 ### macOS
 
-On macOS there is nothing like `dlmopen` available, therefore `jvm-ce` does not work.
+Nothing like `dlmopen` is available on macOS. Instead we default to `nfi-staticlib` for the JVM mode, which statically links in (most) of the OpenJDK libraries into `libjvm.dylib`.
+A notable exception is `libawt.dylib` and its related libraries, which only work via dynamic loading.
+This means in practice only the host _or_ the guest can use AWT, but not both at the same time.
 
 
+Currently `nfi-staticlib` only works for one Espresso context. Using `nfi-staticlib` with more than one context will likely result in a SIGSEGV in `libtrufflenfi.dylib`.
+We are exploring how to implement support for multiple contexts (GR-71082).
+
 ## _Espressoⁿ_ Java-ception
 
 Espresso can run itself. **Self-hosting requires a Linux distribution with an up-to-date glibc.**

espresso/mx.espresso/mx_espresso.py

@@ -28,6 +28,7 @@
 import subprocess
 import argparse
 import sys
+import re
 from abc import ABCMeta, abstractmethod
 
 import mx
@@ -44,6 +45,7 @@
 from os.path import join, exists, dirname, relpath
 from import_order import verify_order, validate_format
 from mx_truffle import resolve_truffle_dist_names
+from mx_native import DefaultNativeProject
 
 _suite = mx.suite('espresso')
 
@@ -637,6 +639,74 @@ def register_espresso_runtime_resources(register_project, register_distribution,
             register_distribution(extra_llvm_java_home_dep)
         register_espresso_runtime_resource(extra_java_home_dep, extra_llvm_java_home_dep, register_project, register_distribution, suite, False)
 
+class CustomLibJVMLinking(DefaultNativeProject):
+    def __init__(self, suite, name, deps, workingSets, **kwargs):
+        subDir = kwargs.pop('subDir')
+        d = join(suite.dir, subDir, kwargs.pop('dir'))
+        super(CustomLibJVMLinking, self).__init__(suite, name, subDir, [], deps, workingSets, d, 'shared_lib', **kwargs)
+
+    @staticmethod
+    def _extract_loaded_by_espresso():
+        source_path = join(_suite.dir, 'src', 'com.oracle.truffle.espresso', 'src', 'com', 'oracle', 'truffle', 'espresso', 'ffi', 'nfi', 'NFIStaticLibNativeAccess.java')
+        with open(source_path, "r", encoding="utf-8") as f:
+            # look for:
+            #    private static final Set<String> LOADED_BY_ESPRESSO = Set.of(...);
+            m = re.search(r'\bLOADED_BY_ESPRESSO\s*=\s*Set\.of\s*\(([a-z",\s]*)\)', f.read())
+            if not m:
+                raise RuntimeError("Could not find LOADED_BY_ESPRESSO = Set.of(")
+
+            # collect quoted strings from Set
+            return set(re.findall(r'\"([a-z]+)\"', m.group(1)))
+
+    @property
+    def ldflags(self):
+        platform = mx.get_os() + '-' + mx.get_arch()
+
+        assert mx.is_darwin(), "not supported yet: " + platform
+
+        # Most OpenJDK libraries are suitable for static linking, with the exception of
+        # libawt and related libs.
+        #
+        # This is also the minimum set of libraries required to make this approach work, as HotSpot
+        # always will load these and it would result into a namespace clash otherwise. Depending
+        # on the application ran by the host (next to Espresso) and by the guest, other libraries
+        # such as libmanagement make sense to include as well.
+        #
+        # As noted above, libawt only works with dynamic loading and thus only the host or the
+        # guest will be able to use it.
+        #
+        # Some libraries are not included as they are VM implementation specific (e.g. libsaproc).
+        #
+        #
+        # Hints for debugging on Darwin:
+        # - --log.level=ALL: Prints the reason why a library could not be loaded.
+        # - DYLD_PRINT_LIBRARIES=1: Verbose output of the dynamic linker, e.g. prints the full
+        #                           path of libraries that are attempted to be loaded.
+        # - breakpoint on dlopen/dlsym
+
+        darwin_linked_in_libs = {"attach", "extnet", "freetype", "j2gss", "j2pcsc", "j2pkcs11", "jaas",
+                                "java", "javajpeg", "jimage", "management_agent", "management_ext",
+                                "management", "mlib_image", "net", "nio", "osxkrb5", "prefs", "rmi", "sleef",
+                                "syslookup", "verify", "zip"}
+
+        expected_by_VM = CustomLibJVMLinking._extract_loaded_by_espresso()
+        missing_libs = expected_by_VM - darwin_linked_in_libs
+        assert not missing_libs, "missing libraries expected by the VM: " + str(missing_libs)
+
+        static_lib_dir = os.path.join(get_java_home_dep().java_home, "lib", "static", platform)
+        ldf = []
+
+        for jdk_static_lib in os.listdir(static_lib_dir):
+            if not jdk_static_lib.endswith('.a'):
+                continue
+
+            if jdk_static_lib[3:-2] not in darwin_linked_in_libs:
+                continue
+
+            ldf.append(f'-Wl,-force_load,{os.path.join(static_lib_dir, jdk_static_lib)}')
+
+        return ldf + super(CustomLibJVMLinking, self).ldflags
+
 
 def register_espresso_runtime_resource(java_home_dep, llvm_java_home_dep, register_project, register_distribution, suite, is_main):
     is_ee_suite = suite != _suite

espresso/mx.espresso/suite.py

@@ -405,6 +405,38 @@
             },
         },
 
+        # same as mokapot, but with statically linked OpenJDK libraries.
+        "com.oracle.truffle.espresso.fatpot": {
+            "class": "CustomLibJVMLinking",
+            "subDir": "src",
+            "dir": "com.oracle.truffle.espresso.mokapot",
+            "native": "shared_lib",
+            "deliverable": "jvm",
+            "platformDependent": True,
+            "os_arch": {
+                "darwin": {
+                    "<others>": {
+                        "cflags": ["-Wall", "-Werror", "-std=c11", "-DESPRESSO_NFI_STATIC"],
+                        "ldflags": [
+                            "-Wl,-install_name,@rpath/libjvm.dylib",
+                            "-Wl,-rpath,@loader_path/.",
+                            "-Wl,-rpath,@loader_path/..",
+                            "-Wl,-current_version,1.0.0",
+                            "-Wl,-compatibility_version,1.0.0"
+                        ],
+                        "multitarget": {
+                            "compiler": ["host", "*"]
+                        },
+                    },
+                },
+                "<others>": {
+                    "<others>": {
+                        "ignore": "GR-66340: Darwin only for now",
+                    },
+                },
+            },
+        },
+
         "com.oracle.truffle.espresso.shadowed.asm" : {
             # Shadowed ASM library (org.ow2.asm:asm)
             "subDir" : "src",
@@ -654,6 +686,29 @@
             "maven": False,
         },
 
+        "ESPRESSO_JVM_STANDALONE_MOKAPOT_SUPPORT": {
+            "type": "dir",
+            "platformDependent": True,
+            "platforms": "local",
+            "os": {
+                "darwin": {
+                    "layout": {
+                        "./fatpot/": [
+                            "dependency:espresso:com.oracle.truffle.espresso.fatpot/*/<multitarget_libc_selection>/<lib:jvm>",
+                        ]
+                    },
+                },
+                "<others>": {
+                    "layout": {
+                        "./": [
+                            "dependency:espresso:com.oracle.truffle.espresso.mokapot/*/<multitarget_libc_selection>/<lib:jvm>",
+                        ]
+                    },
+                },
+            },
+            "maven": False,
+        },
+
         "ESPRESSO_JVM_STANDALONE": {
             "type": "dir",
             "pruning_mode": "optional",
@@ -683,7 +738,7 @@
                 ],
                 "languages/java/lib/": [
                     # Copy of libjvm.so, accessible by Sulong via the default Truffle file system.
-                    "dependency:espresso:com.oracle.truffle.espresso.mokapot/*/<multitarget_libc_selection>/<lib:jvm>",
+                    "dependency:espresso:ESPRESSO_JVM_STANDALONE_MOKAPOT_SUPPORT/*",
                 ],
                 "languages/java/": [
                     {
@@ -765,11 +820,20 @@
                 "darwin-aarch64",
                 "windows-amd64",
             ],
+            "pruning_mode": "optional",
             "layout": {
                 "META-INF/resources/java/espresso-libs/<os>/<arch>/lib/": [
                     # Copy of libjvm.so, accessible by Sulong via the default Truffle file system.
                     "dependency:espresso:com.oracle.truffle.espresso.mokapot/*/<multitarget_libc_selection>/<lib:jvm>",
                 ],
+                "META-INF/resources/java/espresso-libs/<os>/<arch>/lib/fatpot/": [
+                    {
+                        'source_type': 'dependency',
+                        'dependency': 'espresso:com.oracle.truffle.espresso.fatpot',
+                        'path': '*/<multitarget_libc_selection>/<lib:jvm>',
+                        'optional': True,
+                    },
+                ],
                 "META-INF/resources/java/espresso-libs/<os>/<arch>/": "dependency:espresso:ESPRESSO_SUPPORT/*",
             },
             "maven": False,
@@ -841,7 +905,15 @@
                 "lib/": [
                     # Copy of libjvm.so, accessible by Sulong via the default Truffle file system.
                     "dependency:espresso:com.oracle.truffle.espresso.mokapot/*/<multitarget_libc_selection>/<lib:jvm>",
-                ]
+                ],
+                "lib/fatpot/": [
+                    {
+                        'source_type': 'dependency',
+                        'dependency': 'espresso:com.oracle.truffle.espresso.fatpot',
+                        'path': '*/<multitarget_libc_selection>/<lib:jvm>',
+                        'optional': True,
+                    },
+                ],
             },
             "maven": False,
         },
@@ -854,6 +926,14 @@
                 "truffle/": [
                     "dependency:espresso:com.oracle.truffle.espresso.mokapot/*/<multitarget_libc_selection>/<lib:jvm>",
                 ],
+                "truffle/fatpot/": [
+                    {
+                        'source_type': 'dependency',
+                        'dependency': 'espresso:com.oracle.truffle.espresso.fatpot',
+                        'path': '*/<multitarget_libc_selection>/<lib:jvm>',
+                        'optional': True,
+                    },
+                ],
             },
             "maven": False,
         },

espresso/src/com.oracle.truffle.espresso.mokapot/src/mokapot.c

@@ -1730,7 +1730,11 @@ JNIEXPORT jboolean JNICALL JVM_IsForeignLinkerSupported(void) {
 JNIEXPORT jboolean JNICALL
 JVM_IsStaticallyLinked(void) {
   IMPLEMENTED(JVM_IsStaticallyLinked);
+#ifdef ESPRESSO_NFI_STATIC
+  return JNI_TRUE;
+#else
   return JNI_FALSE;
+#endif
 }
 
 JNIEXPORT void JNICALL JVM_VirtualThreadStart(JNIEnv* env, jobject vthread) {

espresso/src/com.oracle.truffle.espresso/src/com/oracle/truffle/espresso/EspressoLanguage.java

@@ -71,6 +71,7 @@
 import com.oracle.truffle.espresso.ffi.NoNativeAccess;
 import com.oracle.truffle.espresso.ffi.nfi.NFIIsolatedNativeAccess;
 import com.oracle.truffle.espresso.ffi.nfi.NFINativeAccess;
+import com.oracle.truffle.espresso.ffi.nfi.NFIStaticLibNativeAccess;
 import com.oracle.truffle.espresso.ffi.nfi.NFISulongNativeAccess;
 import com.oracle.truffle.espresso.impl.EspressoType;
 import com.oracle.truffle.espresso.impl.SuppressFBWarnings;
@@ -345,6 +346,8 @@ private static String setNativeBackendId(final TruffleLanguage.Env env) {
             if (isInPreInit || !EspressoOptions.RUNNING_ON_SVM) {
                 if (OS.getCurrent() == OS.Linux) {
                     nativeBackend = NFIIsolatedNativeAccess.Provider.ID;
+                } else if (OS.getCurrent() == OS.Darwin) {
+                    nativeBackend = NFIStaticLibNativeAccess.Provider.ID;
                 } else {
                     nativeBackend = NFISulongNativeAccess.Provider.ID;
                 }