[GR-64087] Turn truffle-enterprise into an optional dependency.

tzezula · tzezula · commit aefacfb7d2d6 · 2025-06-12T15:07:19.000Z
PullRequest: graal/20992
diff --git a/espresso/mx.espresso/suite.py b/espresso/mx.espresso/suite.py
@@ -882,7 +882,7 @@
             "maven": False,
         },
 
-        "JAVA_COMMUNITY": {
+        "JAVA_POM": {
             "class": "DynamicPOMDistribution",
             "description": "Java on Truffle (aka Espresso): a Java bytecode interpreter",
             "distDependencies": [
@@ -891,7 +891,7 @@
                 "truffle:TRUFFLE_NFI_LIBFFI",
                 "truffle:TRUFFLE_RUNTIME",
                 # sulong is not strictly required, but it'll work out of the box in more cases if it's there
-                "sulong:LLVM_NATIVE_COMMUNITY",
+                "sulong:LLVM_NATIVE_POM",
             ],
             # optionally provides:
             # - ESPRESSO_RUNTIME_RESOURCES
diff --git a/sdk/CHANGELOG.md b/sdk/CHANGELOG.md
@@ -13,6 +13,7 @@ This changelog summarizes major changes between GraalVM SDK versions. The main f
 * GR-55223 The option sandbox.MaxStackFrames is no longer mandatory for the UNTRUSTED polyglot sandbox policy thanks to improved deoptimization handling of compiled code.
 * GR-64488 FileSystem implementations can now provide disk-related metadata, including [total space](https://www.graalvm.org/truffle/javadoc/org/graalvm/polyglot/io/FileSystem.html##getFileStoreTotalSpace(java.nio.file.Path)), [usable space](https://www.graalvm.org/truffle/javadoc/org/graalvm/polyglot/io/FileSystem.html#getFileStoreUsableSpace(java.nio.file.Path)), [unallocated space](https://www.graalvm.org/truffle/javadoc/org/graalvm/polyglot/io/FileSystem.html#getFileStoreUnallocatedSpace(java.nio.file.Path)), [block size](https://www.graalvm.org/truffle/javadoc/org/graalvm/polyglot/io/FileSystem.html#getFileStoreBlockSize(java.nio.file.Path)), and [read-only status](https://www.graalvm.org/truffle/javadoc/org/graalvm/polyglot/io/FileSystem.html#isFileStoreReadOnly(java.nio.file.Path)).
 * GR-22699(EE-only) Added the ability to spawn `Engine` or `Context` isolated in a separate process by setting `Context.Builder.option("engine.IsolateMode", "external").`.
+* GR-64087 Removed the dependency on `org.graalvm.truffle:truffle-enterprise` from all language and tool POM artifacts. As a result, the community Maven artifacts (those with an artifact ID ending in `-community`) are now identical to their corresponding non-community artifacts. Consequently, all community language and tool POM artifacts have been deprecated. The only exception is `org.graalvm.truffle:java-community` vs. `org.graalvm.truffle:java`, which differ in the bundled Java runtime. Embedders using auxiliary engine caching, polyglot isolates, a isolated/untrusted sandbox policy, or the sandbox resource limits must now explicitly add the `org.graalvm.truffle:truffle-enterprise` Maven artifact to the classpath or module path.
 
 ## Version 24.2.0
 * GR-54905 When using Truffle NFI with the Panama backend, native access must now be granted to the Truffle module instead of the NFI Panama module. Use the `--enable-native-access=org.graalvm.truffle` Java command line option to enable the native access for the NFI Panama backend.
diff --git a/sulong/mx.sulong/suite.py b/sulong/mx.sulong/suite.py
@@ -1749,7 +1749,7 @@
       "noMavenJavadoc": True,
     },
 
-    "LLVM_NATIVE_COMMUNITY": {
+    "LLVM_NATIVE_POM": {
       "type": "pom",
       "runtimeDependencies": [
         "SULONG_CORE",
@@ -1759,23 +1759,36 @@
         "truffle:TRUFFLE_RUNTIME",
       ],
       "maven": {
-        "artifactId": "llvm-native-community",
+        "artifactId": "llvm-native",
         "tag": ["default", "public"],
       },
       "description": "Graal native LLVM engine.",
       "license": "BSD-new",
     },
+    # GR-64088: Remove when changes in language repositories are merged
+    "LLVM_NATIVE_COMMUNITY": {
+      "type": "pom",
+      "runtimeDependencies": [
+        "LLVM_NATIVE_POM",
+      ],
+      "maven": {
+        "artifactId": "llvm-native-transient",
+        "tag": ["default", "public"],
+      },
+      "description": "Temporary module to overcome cross-repository merge.",
+      "license": "BSD-new",
+    },
 
-    "LLVM_COMMUNITY": {
+    "LLVM_POM": {
       "type": "pom",
       "runtimeDependencies": [
-        "LLVM_NATIVE_COMMUNITY",
+        "LLVM_NATIVE_POM",
       ],
       "maven": {
         "artifactId": "llvm-community",
         "tag": ["default", "public"],
       },
-      "description": "Graal LLVM engine.",
+      "description": "Deprecated: Please use the \'llvm-native\' Maven artifact instead.",
       "license": "BSD-new",
     },
 
diff --git a/tools/mx.tools/suite.py b/tools/mx.tools/suite.py
@@ -391,15 +391,15 @@
             },
             "description" : "The core module of the polyglot debugging backend for chrome inspector.",
         },
-        "INSPECT_COMMUNITY": {
+        "INSPECT_POM": {
             "type": "pom",
             "runtimeDependencies": [
                 "CHROMEINSPECTOR",
                 "truffle:TRUFFLE_RUNTIME",
             ],
             "maven": {
               "groupId" : "org.graalvm.polyglot",
-              "artifactId": "inspect-community",
+              "artifactId": "inspect",
               "tag": ["default", "public"],
             },
             "description": "The polyglot debugging backend for chrome inspector.",
@@ -454,15 +454,15 @@
             },
             "description" : "The core module of the Insights Gathering Platform",
         },
-        "INSIGHT_COMMUNITY": {
+        "INSIGHT_POM": {
             "type": "pom",
             "runtimeDependencies": [
                 "INSIGHT",
                 "truffle:TRUFFLE_RUNTIME",
             ],
             "maven": {
               "groupId" : "org.graalvm.polyglot",
-              "artifactId": "insight-community",
+              "artifactId": "insight",
               "tag": ["default", "public"],
             },
             "description": "The Ultimate Insights Gathering Platform",
@@ -491,15 +491,15 @@
             },
             "description" : "The core module of Heap Dump for Insight",
         },
-        "HEAP_COMMUNITY": {
+        "HEAP_POM": {
             "type": "pom",
             "runtimeDependencies": [
                 "INSIGHT_HEAP",
                 "truffle:TRUFFLE_RUNTIME",
             ],
             "maven": {
               "groupId" : "org.graalvm.polyglot",
-              "artifactId": "heap-community",
+              "artifactId": "heap",
               "tag": ["default", "public"],
             },
             "description": "The Heap Dump for the Insights Gathering Platform",
@@ -564,15 +564,15 @@
             "javadocType" : "api",
             "description" : "The core module of the Truffle profiler"
         },
-        "PROFILER_COMMUNITY": {
+        "PROFILER_POM": {
             "type": "pom",
             "runtimeDependencies": [
                 "TRUFFLE_PROFILER",
                 "truffle:TRUFFLE_RUNTIME",
             ],
             "maven": {
               "groupId" : "org.graalvm.polyglot",
-              "artifactId": "profiler-community",
+              "artifactId": "profiler",
               "tag": ["default", "public"],
             },
             "description": "The truffle profiler, supporting CPU sampling and tracing. Memory tracing support is experimental"
@@ -624,15 +624,15 @@
             "description" : "Core module of the Truffle code coverage tool",
             "javadocType" : "api",
         },
-        "COVERAGE_COMMUNITY": {
+        "COVERAGE_POM": {
             "type": "pom",
             "runtimeDependencies": [
                 "TRUFFLE_COVERAGE",
                 "truffle:TRUFFLE_RUNTIME",
             ],
             "maven": {
               "groupId" : "org.graalvm.polyglot",
-              "artifactId": "coverage-community",
+              "artifactId": "coverage",
               "tag": ["default", "public"],
             },
             "description": "The Truffle code coverage tool"
@@ -685,15 +685,15 @@
             },
             "description" : "Core module of the polyglot debugging backend for the Debug Adapter Protocol",
         },
-        "DAP_COMMUNITY": {
+        "DAP_POM": {
             "type": "pom",
             "runtimeDependencies": [
                 "DAP",
                 "truffle:TRUFFLE_RUNTIME",
             ],
             "maven": {
               "groupId" : "org.graalvm.polyglot",
-              "artifactId": "dap-community",
+              "artifactId": "dap",
               "tag": ["default", "public"],
             },
             "description": "The polyglot debugging backend for the Debug Adapter Protocol"
@@ -776,15 +776,15 @@
             },
             "description" : "Core module of the polyglot Language Server backend",
         },
-        "LSP_COMMUNITY": {
+        "LSP_POM": {
             "type": "pom",
             "runtimeDependencies": [
                 "LSP",
                 "truffle:TRUFFLE_RUNTIME",
             ],
             "maven": {
               "groupId" : "org.graalvm.polyglot",
-              "artifactId": "lsp-community",
+              "artifactId": "lsp",
               "tag": ["default", "public"],
             },
             "description": "The polyglot Language Server backend"
diff --git a/truffle/mx.truffle/suite.py b/truffle/mx.truffle/suite.py
@@ -1658,7 +1658,7 @@
         "TRUFFLE_API",
         "TRUFFLE_COMPILER",
       ],
-      "description" : "The community edition of the Truffle runtime for Graal Languages. It is not recommended to depend on this artifact directly. Instead, use a POM dependency of one or more Graal Languages (for example `org.graalvm.polyglot:js-community`) to ensure all dependencies are pulled in correctly.", # pylint: disable=line-too-long
+      "description" : "The Truffle runtime for Graal Languages. It is not recommended to depend on this artifact directly. Instead, use a POM dependency of one or more Graal Languages (for example `org.graalvm.polyglot:js`) to ensure all dependencies are pulled in correctly.", # pylint: disable=line-too-long
       "useModulePath": True,
       "maven": {
           "artifactId": "truffle-runtime",
diff --git a/truffle/src/com.oracle.truffle.polyglot/src/com/oracle/truffle/polyglot/PolyglotImpl.java b/truffle/src/com.oracle.truffle.polyglot/src/com/oracle/truffle/polyglot/PolyglotImpl.java
@@ -62,14 +62,17 @@
 import java.nio.file.Path;
 import java.util.Collection;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Set;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.function.Consumer;
 import java.util.function.Function;
 import java.util.function.Predicate;
 import java.util.function.Supplier;
 import java.util.logging.Level;
+import java.util.stream.Collectors;
 
 import org.graalvm.options.OptionDescriptors;
 import org.graalvm.polyglot.Engine;
@@ -109,6 +112,14 @@
  */
 public final class PolyglotImpl extends AbstractPolyglotImpl {
 
+    private static final Set<String> TRUFFLE_ENTERPRISE_OPTIONS = Set.of(
+                    "engine.Cache",
+                    "engine.CacheLoad",
+                    "engine.CacheStore",
+                    "engine.DebugCacheLoad",
+                    "engine.DebugCacheStore",
+                    "engine.SpawnIsolate");
+
     /*
      * Used to prevent implementations of accessible API classes.
      */
@@ -277,6 +288,7 @@ public Engine buildEngine(String[] permittedLanguages, SandboxPolicy sandboxPoli
                     boolean registerInActiveEngines, Object polyglotHostService) {
         PolyglotEngineImpl impl = null;
         try {
+            validateVendorOptions(options);
             validateSandbox(sandboxPolicy);
             if (TruffleOptions.AOT) {
                 EngineAccessor.ACCESSOR.initializeNativeImageTruffleLocator();
@@ -406,6 +418,27 @@ private static void logTruffleRuntimeWarning(Map<String, String> options, Option
 
     }
 
+    private void validateVendorOptions(Map<String, String> options) {
+        if (this != this.getRootImpl()) {
+            return;
+        }
+        Set<String> usedEnterpriseOptions = new HashSet<>();
+        for (String key : options.keySet()) {
+            if (TRUFFLE_ENTERPRISE_OPTIONS.contains(key) || key.startsWith("sandbox.") || key.equals("sandbox")) {
+                usedEnterpriseOptions.add(key);
+            }
+        }
+        if (!usedEnterpriseOptions.isEmpty()) {
+            String optionNames = usedEnterpriseOptions.stream().map((s) -> '\'' + s + '\'').collect(Collectors.joining(", "));
+            throw PolyglotEngineException.illegalArgument(String.format(
+                            "The following options %s require Truffle Enterprise Extensions to be available on the classpath or module path. " +
+                                            "Please ensure that the 'org.graalvm.truffle:truffle-enterprise' Maven artifact is correctly included in your build configuration. " +
+                                            "Note that Truffle Enterprise Extensions are only supported when running on Oracle GraalVM or Oracle JDK. " +
+                                            "Remove these option or add the 'org.graalvm.truffle:truffle-enterprise' artefact to resolve this issue.",
+                            optionNames));
+        }
+    }
+
     private void validateSandbox(SandboxPolicy sandboxPolicy) {
         // When The PolyglotImpl is used as a root polyglot it supports at most the CONSTRAINED
         // sandboxing policy . When it's used as a delegate of other polyglot it needs to support
diff --git a/vm/mx.vm/mx_vm.py b/vm/mx.vm/mx_vm.py
diff --git a/wasm/mx.wasm/suite.py b/wasm/mx.wasm/suite.py
