[GR-57999] Replace JVMCI API with Native Image API.

PullRequest: graal/18863

Author: dougxc

compiler/mx.compiler/suite.py

@@ -164,6 +164,7 @@
       "dependencies" : [
         "sdk:WORD",
         "sdk:COLLECTIONS",
+        "sdk:NATIVEIMAGE",
         "truffle:TRUFFLE_COMPILER",
       ],
       "requires" : [
@@ -582,6 +583,7 @@
       "distDependencies" : [
         "sdk:COLLECTIONS",
         "sdk:WORD",
+        "sdk:NATIVEIMAGE",
         "truffle:TRUFFLE_COMPILER",
       ],
       "allowsJavadocWarnings": True,

compiler/src/jdk.graal.compiler.processor/src/jdk/graal/compiler/replacements/processor/GeneratedFoldPlugin.java

@@ -176,7 +176,7 @@ protected void createExecute(AbstractProcessor processor, PrintWriter out, Injec
     protected void createHelpers(AbstractProcessor processor, PrintWriter out, InjectedDependencies deps) {
         out.printf("\n");
         out.printf("    @Override\n");
-        out.printf("    public boolean replace(GraphBuilderContext b, GeneratedPluginInjectionProvider injection, Stamp stamp, NodeInputList<ValueNode> args) {\n");
+        out.printf("    public boolean replace(GraphBuilderContext b, Replacements injection, Stamp stamp, NodeInputList<ValueNode> args) {\n");
 
         List<? extends VariableElement> params = intrinsicMethod.getParameters();
 

compiler/src/jdk.graal.compiler.processor/src/jdk/graal/compiler/replacements/processor/GeneratedNodeIntrinsicPlugin.java

@@ -247,7 +247,7 @@ protected void createHelpers(AbstractProcessor processor, PrintWriter out, Injec
         }
         out.printf("\n");
         out.printf("    @Override\n");
-        out.printf("    public boolean replace(GraphBuilderContext b, GeneratedPluginInjectionProvider injection, Stamp stamp, NodeInputList<ValueNode> args) {\n");
+        out.printf("    public boolean replace(GraphBuilderContext b, Replacements injection, Stamp stamp, NodeInputList<ValueNode> args) {\n");
 
         List<? extends VariableElement> params = getParameters();
 

compiler/src/jdk.graal.compiler.processor/src/jdk/graal/compiler/replacements/processor/PluginGenerator.java

@@ -177,6 +177,7 @@ protected static void createImports(PrintWriter out, AbstractProcessor processor
             if (plugin.needsReplacement(processor)) {
                 extra.add("jdk.graal.compiler.options.ExcludeFromJacocoGeneratedReport");
                 extra.add("jdk.graal.compiler.graph.NodeInputList");
+                extra.add("jdk.graal.compiler.nodes.spi.Replacements");
                 if (plugin.isWithExceptionReplacement(processor)) {
                     extra.add("jdk.graal.compiler.nodes.PluginReplacementWithExceptionNode");
                 } else {

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/core/test/CheckGraalInvariants.java

@@ -325,6 +325,7 @@ public static void runTest(InvariantsTool tool) {
         verifiers.add(new VerifyDebugUsage());
         verifiers.add(new VerifyVirtualizableUsage());
         verifiers.add(new VerifyUpdateUsages());
+        verifiers.add(new VerifyLibGraalContextChecks());
         verifiers.add(new VerifyBailoutUsage());
         verifiers.add(new VerifySystemPropertyUsage());
         verifiers.add(new VerifyInstanceOfUsage());

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/core/test/VerifyLibGraalContextChecks.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package jdk.graal.compiler.core.test;
+
+import java.util.List;
+
+import jdk.graal.compiler.hotspot.HotSpotGraalCompilerFactory;
+import jdk.graal.compiler.nodes.StructuredGraph;
+import jdk.graal.compiler.nodes.java.LoadFieldNode;
+import jdk.graal.compiler.nodes.spi.CoreProviders;
+import jdk.graal.compiler.phases.VerifyPhase;
+import jdk.graal.compiler.serviceprovider.GraalServices;
+import jdk.vm.ci.meta.ResolvedJavaField;
+import jdk.vm.ci.meta.ResolvedJavaMethod;
+import jdk.vm.ci.meta.ResolvedJavaType;
+import jdk.vm.ci.services.Services;
+import org.graalvm.nativeimage.ImageInfo;
+
+/**
+ * Ensures that the only code directly accessing
+ * {@link jdk.vm.ci.services.Services#IS_IN_NATIVE_IMAGE} and
+ * {@link jdk.vm.ci.services.Services#IS_BUILDING_NATIVE_IMAGE} is in
+ * {@link jdk.graal.compiler.serviceprovider.GraalServices}. All other code must use one of the
+ * following methods:
+ * <ul>
+ * <li>{@link GraalServices#isBuildingLibgraal()}</li>
+ * <li>{@link GraalServices#isInLibgraal()}</li>
+ * <li>{@link ImageInfo#inImageCode()}</li>
+ * <li>{@link ImageInfo#inImageBuildtimeCode()}</li>
+ * <li>{@link ImageInfo#inImageRuntimeCode()}</li>
+ * </ul>
+ */
+public class VerifyLibGraalContextChecks extends VerifyPhase<CoreProviders> {
+
+    @Override
+    public boolean checkContract() {
+        return false;
+    }
+
+    static boolean isAllowedToAccess(ResolvedJavaMethod method) {
+        if (method.getDeclaringClass().toJavaName().equals(GraalServices.class.getName())) {
+            return method.getName().equals("isBuildingLibgraal") || method.getName().equals("isInLibgraal");
+        }
+        if (method.getDeclaringClass().toJavaName().equals(HotSpotGraalCompilerFactory.class.getName())) {
+            return method.getName().equals("createCompiler");
+        }
+        return false;
+    }
+
+    @Override
+    protected void verify(StructuredGraph graph, CoreProviders context) {
+
+        final ResolvedJavaType servicesType = context.getMetaAccess().lookupJavaType(Services.class);
+        servicesType.getStaticFields();
+
+        List<LoadFieldNode> loads = graph.getNodes().filter(LoadFieldNode.class).snapshot();
+        for (LoadFieldNode load : loads) {
+            ResolvedJavaField field = load.field();
+            if (field.getDeclaringClass().toJavaName().equals(Services.class.getName())) {
+                if (field.getName().equals("IS_BUILDING_NATIVE_IMAGE") || field.getName().equals("IS_IN_NATIVE_IMAGE")) {
+                    if (!isAllowedToAccess(graph.method())) {
+                        String recommendation = field.getName().equals("IS_BUILDING_NATIVE_IMAGE") ? "isBuildingLibgraal" : "isInLibgraal";
+                        throw new VerificationError("reading %s in %s is prohibited - use %s.%s() instead",
+                                        field.format("%H.%n"),
+                                        graph.method().format("%H.%n(%p)"),
+                                        GraalServices.class.getName(),
+                                        recommendation);
+
+                    }
+                }
+            }
+        }
+    }
+}

compiler/src/jdk.graal.compiler.test/src/jdk/graal/compiler/core/test/VerifySnippetProbabilities.java

@@ -52,6 +52,10 @@
 import jdk.vm.ci.meta.ResolvedJavaMethod;
 import jdk.vm.ci.meta.ResolvedJavaType;
 
+/**
+ * Checks that every {@link IfNode} in a {@linkplain StructuredGraph#isSubstitution() snippet or
+ * substitution} has a known probability.
+ */
 public class VerifySnippetProbabilities extends VerifyPhase<CoreProviders> {
 
     private static final Object[] KNOWN_PROFILE_INTRINSICS = {
@@ -123,9 +127,9 @@ protected void verify(StructuredGraph graph, CoreProviders context) {
                                     found = true;
                                     break;
                                 } else {
-                                    // some snippets have complex semantics separated in different
-                                    // method in the same class, allow such patterns they will be
-                                    // fully inlined
+                                    // Some snippets have complex semantics factored out into other
+                                    // methods in the same class. Allow such patterns as they will
+                                    // be inlined.
                                     if (targetMethod.getDeclaringClass().equals(method.getDeclaringClass())) {
                                         found = true;
                                         break;
@@ -141,7 +145,7 @@ protected void verify(StructuredGraph graph, CoreProviders context) {
                                 }
                             } else {
                                 // abstract / interface methods called in a snippet, most likely due
-                                // to overriden snippet logic that folds later, ignore
+                                // to overridden snippet logic that folds later, ignore
                                 found = true;
                                 break;
                             }
@@ -155,8 +159,8 @@ protected void verify(StructuredGraph graph, CoreProviders context) {
                         }
                     }
                     if (!found) {
-                        throw new VerificationError("Node %s in snippet %s has unknown probability %s (nsp %s) and does not call" +
-                                        "BranchProbabilityNode.probabiliy/GraalDirectives.inject<> on any of it's condition inputs.",
+                        throw new VerificationError("Node %s in snippet/substitution %s has unknown probability %s (nsp %s) and does not call" +
+                                        "BranchProbabilityNode.probability/GraalDirectives.inject<> on any of its condition inputs.",
                                         ifNode, graph, profile,
                                         ifNode.getNodeSourcePosition());
 

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/core/CompilationWatchDog.java

@@ -42,7 +42,7 @@
 import jdk.graal.compiler.serviceprovider.IsolateUtil;
 
 import jdk.vm.ci.common.NativeImageReinitialize;
-import jdk.vm.ci.services.Services;
+import org.graalvm.nativeimage.ImageInfo;
 
 /**
  * A watch dog for {@linkplain #watch watching} and reporting on long running compilations.
@@ -335,7 +335,7 @@ public Thread newThread(Runnable r) {
      */
     public static CompilationWatchDog watch(CompilationIdentifier compilation, OptionValues options, boolean singleShotExecutor, EventHandler eventHandler) {
         int delay = Options.CompilationWatchDogStartDelay.getValue(options);
-        if (Services.IS_BUILDING_NATIVE_IMAGE && !Options.CompilationWatchDogStartDelay.hasBeenSet(options)) {
+        if (ImageInfo.inImageBuildtimeCode() && !Options.CompilationWatchDogStartDelay.hasBeenSet(options)) {
             // Disable watch dog by default when building a native image
             delay = 0;
         }

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/core/common/util/CompilationAlarm.java

@@ -37,7 +37,7 @@
 import jdk.graal.compiler.options.OptionValues;
 import jdk.graal.compiler.phases.BasePhase;
 import jdk.graal.compiler.serviceprovider.GraalServices;
-import jdk.vm.ci.services.Services;
+import org.graalvm.nativeimage.ImageInfo;
 
 /**
  * Utility class that allows the compiler to monitor compilations that take a very long time.
@@ -61,7 +61,7 @@ public static class Options {
         // @formatter:on
     }
 
-    public static final boolean LOG_PROGRESS_DETECTION = !Services.IS_IN_NATIVE_IMAGE &&
+    public static final boolean LOG_PROGRESS_DETECTION = !ImageInfo.inImageRuntimeCode() &&
                     Boolean.parseBoolean(GraalServices.getSavedProperty("debug." + CompilationAlarm.class.getName() + ".logProgressDetection"));
 
     /**

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/debug/IgvDumpChannel.java

@@ -44,7 +44,7 @@
 
 import jdk.graal.compiler.serviceprovider.GraalServices;
 import jdk.vm.ci.common.NativeImageReinitialize;
-import jdk.vm.ci.services.Services;
+import org.graalvm.nativeimage.ImageInfo;
 
 final class IgvDumpChannel implements WritableByteChannel {
 
@@ -104,7 +104,7 @@ WritableByteChannel channel() throws IOException {
             if (target == PrintGraphTarget.File) {
                 sharedChannel = createFileChannel(pathProvider, null);
             } else if (target == PrintGraphTarget.Network) {
-                if (Services.IS_IN_NATIVE_IMAGE && !ENABLE_NETWORK_DUMPING) {
+                if (ImageInfo.inImageRuntimeCode() && !ENABLE_NETWORK_DUMPING) {
                     if (!networkDumpingUnsupportedWarned) {
                         // Ignore races or multiple isolates - an extra warning is ok
                         networkDumpingUnsupportedWarned = true;