Throw permanent bailout if parsing generated intrinsics outside snippets

The bailout can then be ignored in CTW

Author: c-refice

compiler/mx.compiler/mx_compiler.py

@@ -275,9 +275,16 @@ def ctw(args, extraVMarguments=None):
     parser.add_argument('--limitmods', action='store', help='limits the set of compiled classes to only those in the listed modules', metavar='<modulename>[,<modulename>...]')
 
     args, vmargs = parser.parse_known_args(args)
-
     vmargs.extend(_remove_empty_entries(extraVMarguments))
 
+    # Enable jvmci by default if not specified
+    if _get_XX_option_value(vmargs, 'EnableJVMCI', None) is None:
+        vmargs.append('-XX:+EnableJVMCI')
+
+    # Disable JVMCICompiler by default if not specified
+    if _get_XX_option_value(vmargs, 'UseJVMCICompiler', None) is None:
+        vmargs.append('-XX:-UseJVMCICompiler')
+
     if mx.get_os() == 'darwin':
         # suppress menubar and dock when running on Mac
         vmargs.append('-Djava.awt.headless=true')
@@ -515,7 +522,7 @@ def compiler_gate_runner(suites, unit_test_runs, bootstrap_tests, tasks, extraVM
 
     # Run ctw against rt.jar on hosted
     ctw_flags = [
-        '-DCompileTheWorld.Config=Inline=false CompilationFailureAction=ExitVM CompilationBailoutAsFailure=false', '-esa', '-XX:-UseJVMCICompiler', '-XX:+EnableJVMCI',
+        '-DCompileTheWorld.Config=Inline=false CompilationFailureAction=ExitVM CompilationBailoutAsFailure=false', '-ea', '-esa',
         '-DCompileTheWorld.MultiThreaded=true', '-Djdk.graal.InlineDuringParsing=false', '-Djdk.graal.TrackNodeSourcePosition=true',
         '-DCompileTheWorld.Verbose=false', '-XX:ReservedCodeCacheSize=300m',
     ]

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/hotspot/test/CompileTheWorld.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2024, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -90,6 +90,7 @@
 import jdk.graal.compiler.hotspot.CompilationTask;
 import jdk.graal.compiler.hotspot.CompileTheWorldFuzzedSuitesCompilationTask;
 import jdk.graal.compiler.hotspot.GraalHotSpotVMConfig;
+import jdk.graal.compiler.hotspot.HotSpotBytecodeParser;
 import jdk.graal.compiler.hotspot.HotSpotGraalCompiler;
 import jdk.graal.compiler.hotspot.HotSpotGraalRuntime;
 import jdk.graal.compiler.hotspot.HotSpotGraalRuntimeProvider;
@@ -102,6 +103,7 @@
 import jdk.graal.compiler.options.OptionsParser;
 import jdk.vm.ci.hotspot.HotSpotCodeCacheProvider;
 import jdk.vm.ci.hotspot.HotSpotCompilationRequest;
+import jdk.vm.ci.hotspot.HotSpotCompilationRequestResult;
 import jdk.vm.ci.hotspot.HotSpotJVMCIRuntime;
 import jdk.vm.ci.hotspot.HotSpotResolvedJavaMethod;
 import jdk.vm.ci.hotspot.HotSpotResolvedObjectType;
@@ -938,6 +940,18 @@ private void printSuspiciousThreads() {
         }
     }
 
+    @Override
+    protected void handleFailure(HotSpotCompilationRequestResult result) {
+        /*
+         * Ignore bailouts caused by calling node intrinsics outside a Snippet. Since in CTW we try
+         * to compile all methods as compilation roots indiscriminately, we may hit upon a helper
+         * method that expects to only be inlined into a snippet.
+         */
+        if (!result.getFailureMessage().startsWith(HotSpotBytecodeParser.BAD_NODE_INTRINSIC_PLUGIN_CONTEXT)) {
+            super.handleFailure(result);
+        }
+    }
+
     /**
      * Prepares a compilation of the methods in the classes in {@link #inputClassPath}. If
      * {@link #inputClassPath} equals {@link #SUN_BOOT_CLASS_PATH} the boot classes are used.

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/hotspot/test/LibGraalCompilationDriver.java

@@ -571,6 +571,7 @@ protected CompilationResult compileWithLibGraal(Compilation compilation, LibGraa
                     TTY.println("%s : Error compiling method: %s", compilation.testName(), compilation);
                     TTY.println(stackTrace);
                 }
+                failedCompilations.getAndAdd(1);
                 return null;
             }
             return new CompilationResult(installedCode, memTimeBuffer.readTimeElapsed(), memTimeBuffer.readBytesAllocated());
@@ -598,6 +599,11 @@ protected final CompilationTask createCompilationTask(HotSpotResolvedJavaMethod
         return createCompilationTask(jvmciRuntime, compiler, request, useProfilingInfo, installAsDefault);
     }
 
+    protected void handleFailure(HotSpotCompilationRequestResult result) {
+        failedCompilations.getAndAdd(1);
+        throw new GraalError("Compilation request failed: %s", result.getFailureMessage());
+    }
+
     /**
      * Compiles a method using {@link HotSpotCompilationRequest}.
      *
@@ -624,14 +630,13 @@ protected CompilationResult compileWithJarGraal(Compilation compilation, OptionV
             CompilationTask task = createCompilationTask(method, useProfilingInfo, installAsDefault);
             HotSpotCompilationRequestResult result = task.runCompilation(compileOptions);
             if (result.getFailure() != null) {
-                var error = new GraalError("Compilation request failed: %s", result.getFailureMessage());
                 if (result.getRetry() && !retried) {
-                    error.printStackTrace(TTY.out);
-                    TTY.println("Retrying...");
+                    TTY.println("Retrying %s after transient failure...", task);
                     retried = true;
                     continue;
                 }
-                throw error;
+                handleFailure(result);
+                return null;
             }
             HotSpotInstalledCode installedCode = task.getInstalledCode();
             assert installedCode != null : "installed code is null yet no failure detected";
@@ -715,7 +720,6 @@ private void compileAndRecord(Compilation task, LibGraalParams libgraal, OptionV
                     Map<ResolvedJavaMethod, CompilationResult> results) {
         CompilationResult result = compile(task, libgraal, options);
         if (result == null) {
-            failedCompilations.getAndAdd(1);
             return;
         }
         compileTime.getAndAdd(result.compileTime());

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/hotspot/HotSpotBytecodeParser.java

@@ -24,19 +24,27 @@
  */
 package jdk.graal.compiler.hotspot;
 
+import static org.graalvm.nativeimage.ImageInfo.inImageRuntimeCode;
+
+import jdk.graal.compiler.api.replacements.Snippet;
+import jdk.graal.compiler.core.common.PermanentBailoutException;
 import jdk.graal.compiler.java.BytecodeParser;
 import jdk.graal.compiler.java.GraphBuilderPhase.Instance;
+import jdk.graal.compiler.nodes.CallTargetNode;
 import jdk.graal.compiler.nodes.DeoptimizeNode;
 import jdk.graal.compiler.nodes.FixedGuardNode;
 import jdk.graal.compiler.nodes.LogicNode;
 import jdk.graal.compiler.nodes.StructuredGraph;
+import jdk.graal.compiler.nodes.ValueNode;
 import jdk.graal.compiler.nodes.extended.GuardingNode;
+import jdk.graal.compiler.nodes.graphbuilderconf.GeneratedNodeIntrinsicInvocationPlugin;
 import jdk.graal.compiler.nodes.graphbuilderconf.GraphBuilderContext;
 import jdk.graal.compiler.nodes.graphbuilderconf.IntrinsicContext;
-
+import jdk.graal.compiler.nodes.graphbuilderconf.InvocationPlugin;
 import jdk.vm.ci.hotspot.HotSpotResolvedJavaField;
 import jdk.vm.ci.meta.DeoptimizationAction;
 import jdk.vm.ci.meta.DeoptimizationReason;
+import jdk.vm.ci.meta.JavaKind;
 import jdk.vm.ci.meta.ResolvedJavaField;
 import jdk.vm.ci.meta.ResolvedJavaMethod;
 
@@ -69,6 +77,21 @@ public GuardingNode intrinsicRangeCheck(LogicNode condition, boolean negated) {
         return doIntrinsicRangeCheck(this, condition, negated);
     }
 
+    public static final String BAD_NODE_INTRINSIC_PLUGIN_CONTEXT = "@NodeIntrinsic plugin can't be used outside of Snippet context: ";
+
+    @Override
+    protected boolean applyInvocationPlugin(CallTargetNode.InvokeKind invokeKind, ValueNode[] args, ResolvedJavaMethod targetMethod, JavaKind resultType, InvocationPlugin plugin) {
+        // It's an error to call generated invocation plugins outside of snippets.
+        if (plugin instanceof GeneratedNodeIntrinsicInvocationPlugin nodeIntrinsicPlugin) {
+            // Snippets are never parsed in libgraal, and they are the root of the compilation
+            // in jargraal, so check the root method for the Snippet annotation.
+            if (inImageRuntimeCode() || graph.method().getAnnotation(Snippet.class) == null) {
+                throw new PermanentBailoutException(BAD_NODE_INTRINSIC_PLUGIN_CONTEXT + nodeIntrinsicPlugin.getSource().getSimpleName());
+            }
+        }
+        return super.applyInvocationPlugin(invokeKind, args, targetMethod, resultType, plugin);
+    }
+
     public static FixedGuardNode doIntrinsicRangeCheck(GraphBuilderContext context, LogicNode condition, boolean negated) {
         /*
          * On HotSpot it's simplest to always deoptimize. We could dispatch to the fallback code