[GR-64610] Add multitarget support for libffi

PullRequest: graal/20776

Author: lewurm

substratevm/src/com.oracle.svm.truffle.nfi/src/com/oracle/svm/truffle/nfi/libffi/LibFFIHeaderDirectives.java

@@ -27,7 +27,11 @@
 import java.io.File;
 import java.util.Collections;
 import java.util.List;
+import java.util.function.Function;
 
+import com.oracle.svm.core.OS;
+import com.oracle.svm.core.SubstrateOptions;
+import com.oracle.svm.core.SubstrateUtil;
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.c.CContext;
 
@@ -46,10 +50,32 @@ public List<String> getHeaderFiles() {
         return Collections.singletonList("<svm_libffi.h>");
     }
 
+    private static String basePath() {
+        /* Find location of library directory based on known header name */
+        String libffiHeader = ProjectHeaderFile.resolve("com.oracle.svm.libffi", "include/svm_libffi.h");
+        File libffiHeaderPath = new File(libffiHeader.substring(1));
+
+        return libffiHeaderPath.getParentFile().getParent();
+    }
+
+    private static String multitargetSuffix() {
+        String os = OS.getCurrent().asPackageName();
+        String arch = SubstrateUtil.getArchitectureName();
+        String libc = OS.LINUX.isCurrent() ? SubstrateOptions.UseLibC.getValue() : "default";
+
+        return os + "-" + arch + File.separator + libc;
+    }
+
     @Override
     public List<String> getOptions() {
-        String libffiHeader = ProjectHeaderFile.resolve("com.oracle.svm.libffi", "include/svm_libffi.h");
-        String libffiPath = new File(libffiHeader.substring(1)).getParent();
-        return Collections.singletonList("-I" + libffiPath);
+        /* Add base and target specific include directories */
+        Function<String, String> bp = multitarget -> "-I" + basePath() + File.separator + multitarget + "include";
+        return List.of(bp.apply(""), bp.apply(multitargetSuffix() + File.separator));
+    }
+
+    @Override
+    public List<String> getLibraryPaths() {
+        /* Add multitarget style path */
+        return List.of(basePath() + File.separator + multitargetSuffix());
     }
 }

truffle/mx.truffle/mx_truffle.py

@@ -999,6 +999,9 @@
 
     "libffi" : {
       "class" : "LibffiBuilderProject",
+      "multitarget": {
+         "libc": ["glibc", "musl", "default"],
+      },
       "dependencies" : [
         "LIBFFI_SOURCES",
       ],
@@ -1008,8 +1011,10 @@
     "com.oracle.truffle.nfi.native" : {
       "subDir" : "src",
       "native" : "shared_lib",
-      "toolchain" : "sdk:LLVM_NINJA_TOOLCHAIN",
       "deliverable" : "trufflenfi",
+      "multitarget": {
+        "libc": ["glibc", "musl", "default"],
+      },
       "use_jdk_headers" : True,
       "buildDependencies" : [
         "libffi",
@@ -1034,12 +1039,6 @@
             "ldlibs" : ["-ldl"],
           },
         },
-        "linux-musl" : {
-          "<others>" : {
-            "cflags" : ["-g", "-O3", "-Wall", "-Werror", "-fvisibility=hidden"],
-            "ldlibs" : ["-ldl"],
-          },
-        },
         "<others>" : {
           "<others>" : {
             "cflags" : ["-g", "-O3", "-Wall", "-Werror", "-fvisibility=hidden"],
@@ -1920,7 +1919,7 @@
           "darwin-aarch64",
       ],
       "layout" : {
-        "bin/" : "dependency:com.oracle.truffle.nfi.native",
+        "bin/" : "dependency:com.oracle.truffle.nfi.native/*",
         "include/" : "dependency:com.oracle.truffle.nfi.native/include/*.h",
       },
       "include_dirs" : ["include"],
@@ -1944,8 +1943,18 @@
           "windows-amd64",
           "windows-aarch64",
       ],
-      "layout" : {
-        "META-INF/resources/nfi-native/libnfi/<os>/<arch>/bin/" : "dependency:com.oracle.truffle.nfi.native",
+      "os": {
+        "linux": {
+          "layout": {
+            # only glibc.
+            "META-INF/resources/nfi-native/libnfi/<os>/<arch>/bin/" : "dependency:com.oracle.truffle.nfi.native/linux-*/glibc/*"
+          },
+        },
+        "<others>": {
+          "layout": {
+            "META-INF/resources/nfi-native/libnfi/<os>/<arch>/bin/" : "dependency:com.oracle.truffle.nfi.native/*/*/*",
+          },
+        },
       },
       "description" : "Contains the native library needed by the libffi NFI backend.",
       "maven": False,
@@ -2291,8 +2300,18 @@
       "native" : True,
       "platformDependent" : True,
       "description" : "Truffle NFI support distribution for the GraalVM",
-      "layout" : {
-        "./" : ["dependency:com.oracle.truffle.nfi.native"],
+      "os": {
+        "linux": {
+          "layout": {
+            # only glibc.
+            "./" : "dependency:com.oracle.truffle.nfi.native/linux-*/glibc/*"
+          },
+        },
+        "<others>": {
+          "layout": {
+            "./" : "dependency:com.oracle.truffle.nfi.native/*/*/*",
+          },
+        },
       },
       "maven" : False,
       "graalCompilerSourceEdition": "ignore",

truffle/mx.truffle/suite.py

@@ -41,11 +41,28 @@
 #ifndef __TRUFFLE_INTERNAL_H
 #define __TRUFFLE_INTERNAL_H
 
-#if defined(__linux__) && defined(_GNU_SOURCE)
+#if defined(__linux__)
+
+#if !defined(_GNU_SOURCE)
+#error "expected to be set via CLFAGS.  required for detection below"
+#endif
+
+/* musl does not set __USE_GNU in features.h
+ * source: https://stackoverflow.com/a/70211227
+ */
+#include <features.h>
+
+#ifdef __USE_GNU
+/* glibc */
 #define ENABLE_ISOLATED_NAMESPACE
 #define ISOLATED_NAMESPACE 0x10000
 #include <dlfcn.h>
-#endif
+
+#else  // !__USE_GNU
+/* musl. dlmopen not available */
+#endif // !__USE_GNU
+
+#endif // __linux__
 
 #include "native.h"
 #include "trufflenfi.h"

truffle/src/com.oracle.truffle.nfi.native/src/internal.h

@@ -0,0 +1,33 @@
+From 7c9a81783f63d37fb68131d6e0621e9476e7b11c Mon Sep 17 00:00:00 2001
+From: =?UTF-8?q?Aleksandar=20Pejovi=C4=87?= <[email protected]>
+Date: Tue, 15 Jan 2019 00:40:01 +0100
+Subject: [PATCH] Add mx bootstrap Makefile
+
+---
+ Makefile | 14 ++++++++++++++
+ 1 file changed, 14 insertions(+)
+ create mode 100644 Makefile
+
+diff --git a/Makefile b/Makefile
+new file mode 100644
+index 0000000..da887c1
+--- /dev/null
++++ b/Makefile
+@@ -0,0 +1,14 @@
++# This Makefile is used by mx to bootstrap libffi build.
++
++# `make MX_VERBOSE=y` will report all lines executed. The actual value doesn't
++# matter as long as it's not empty.
++QUIETLY$(MX_VERBOSE) = @
++
++.PHONY: default
++
++default:
++	$(QUIETLY) echo CONFIGURE libffi
++	$(QUIETLY) mkdir ../$(OUTPUT)
++	$(QUIETLY) cd ../$(OUTPUT) && ../$(SOURCES)/configure $(CONFIGURE_ARGS) > ../libffi.configure.log
++	$(QUIETLY) echo MAKE libffi
++	$(QUIETLY) $(MAKE) -C ../$(OUTPUT) > ../libffi.build.log
+-- 
+2.38.4
+

truffle/src/libffi/patches/linux-amd64-musl-swcfi/0001-Add-mx-bootstrap-Makefile.patch

@@ -0,0 +1,72 @@
+From 3aa0ebdd2ee6b5634443d7464f1e37be5c20786e Mon Sep 17 00:00:00 2001
+From: Gilles Duboscq <[email protected]>
+Date: Wed, 23 Apr 2025 18:42:40 +0200
+Subject: [PATCH 1/3] If other methods fail, attempt to use mprotect in
+ ffi_tramp_init_os
+
+---
+ src/tramp.c | 39 ++++++++++++++++++++++++++++-----------
+ 1 file changed, 28 insertions(+), 11 deletions(-)
+
+diff --git a/src/tramp.c b/src/tramp.c
+index 8ec0848..7edaebc 100644
+--- a/src/tramp.c
++++ b/src/tramp.c
+@@ -289,7 +289,10 @@ ffi_tramp_init_os (void)
+ {
+   if (ffi_tramp_get_libffi ())
+     return 1;
+-  return ffi_tramp_get_temp_file ();
++  if (ffi_tramp_get_temp_file ())
++    return 1;
++  // try to allocate with the mprotect fall-back
++  return tramp_table_alloc ();
+ }
+ 
+ #endif /* defined (__linux__) || defined (__CYGWIN__) */
+@@ -347,18 +350,32 @@ tramp_table_map (struct tramp_table *table)
+   if (addr == MAP_FAILED)
+     return 0;
+ 
+-  /*
+-   * Replace the top half of the anonymous mapping with the code table mapping.
+-   */
+-  table->code_table = mmap (addr, tramp_globals.map_size, PROT_READ | PROT_EXEC,
+-    MAP_PRIVATE | MAP_FIXED, tramp_globals.fd, tramp_globals.offset);
+-  if (table->code_table == MAP_FAILED)
++  if (tramp_globals.fd != -1)
+     {
+-      (void) munmap (addr, tramp_globals.map_size * 2);
+-      return 0;
++      /*
++       * Replace the top half of the anonymous mapping with the code table mapping.
++       */
++      table->code_table = mmap(addr, tramp_globals.map_size, PROT_READ | PROT_EXEC,
++                               MAP_PRIVATE | MAP_FIXED, tramp_globals.fd, tramp_globals.offset);
++      if (table->code_table != MAP_FAILED) {
++        table->parm_table = table->code_table + tramp_globals.map_size;
++        return 1;
++      }
+     }
+-  table->parm_table = table->code_table + tramp_globals.map_size;
+-  return 1;
++
++  /*
++   * Try to copy the trampolines and mprotect
++   */
++  memcpy(addr, tramp_globals.text, tramp_globals.map_size);
++  if (mprotect(addr, tramp_globals.map_size, PROT_READ | PROT_EXEC) == 0)
++  {
++    table->code_table = addr;
++    table->parm_table = table->code_table + tramp_globals.map_size;
++    return 1;
++  }
++
++  (void) munmap (addr, tramp_globals.map_size * 2);
++  return 0;
+ }
+ 
+ static void
+-- 
+2.43.0
+