Move bytecode dataflow analysis functionality from the compiler to SVM.

Author: Aca-S

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/java/BytecodeParser.java

@@ -269,7 +269,6 @@
 import java.util.function.IntConsumer;
 import java.util.function.Supplier;
 
-import jdk.graal.compiler.nodes.graphbuilderconf.MethodParsingPlugin;
 import org.graalvm.collections.EconomicMap;
 import org.graalvm.collections.Equivalence;
 import org.graalvm.word.LocationIdentity;
@@ -1102,10 +1101,6 @@ protected void build(FixedWithNextNode startInstruction, FrameStateBuilder start
                 graph.recordMethod(method);
             }
 
-            for (MethodParsingPlugin plugin : graphBuilderConfig.getPlugins().getMethodParsingPlugins()) {
-                plugin.execute(method, intrinsicContext);
-            }
-
             // compute the block map, setup exception handlers and get the entrypoint(s)
             this.blockMap = generateBlockMap();
             this.firstInstructionArray = new FixedWithNextNode[blockMap.getBlockCount()];

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/nodes/graphbuilderconf/GraphBuilderConfiguration.java

@@ -42,7 +42,6 @@ public static class Plugins {
         private TypePlugin[] typePlugins;
         private InlineInvokePlugin[] inlineInvokePlugins;
         private ClassInitializationPlugin classInitializationPlugin;
-        private MethodParsingPlugin[] methodPlugins;
 
         /**
          * Creates a copy of a given set of plugins. The {@link InvocationPlugins} in
@@ -56,7 +55,6 @@ public Plugins(Plugins copyFrom, InvocationPlugins invocationPlugins) {
             this.typePlugins = copyFrom.typePlugins;
             this.inlineInvokePlugins = copyFrom.inlineInvokePlugins;
             this.classInitializationPlugin = copyFrom.classInitializationPlugin;
-            this.methodPlugins = copyFrom.methodPlugins;
         }
 
         public Plugins(Plugins copyFrom) {
@@ -75,7 +73,6 @@ public Plugins(InvocationPlugins invocationPlugins) {
             this.parameterPlugins = new ParameterPlugin[0];
             this.typePlugins = new TypePlugin[0];
             this.inlineInvokePlugins = new InlineInvokePlugin[0];
-            this.methodPlugins = new MethodParsingPlugin[0];
         }
 
         public InvocationPlugins getInvocationPlugins() {
@@ -160,22 +157,6 @@ public StampPair getOverridingStamp(GraphBuilderTool b, JavaType type, boolean n
             }
             return null;
         }
-
-        public void appendMethodParsingPlugin(MethodParsingPlugin plugin) {
-            methodPlugins = Arrays.copyOf(methodPlugins, methodPlugins.length + 1);
-            methodPlugins[methodPlugins.length - 1] = plugin;
-        }
-
-        public void prependMethodParsingPlugin(MethodParsingPlugin plugin) {
-            MethodParsingPlugin[] newPlugins = new MethodParsingPlugin[methodPlugins.length + 1];
-            System.arraycopy(methodPlugins, 0, newPlugins, 1, methodPlugins.length);
-            newPlugins[0] = plugin;
-            methodPlugins = newPlugins;
-        }
-
-        public MethodParsingPlugin[] getMethodParsingPlugins() {
-            return methodPlugins;
-        }
     }
 
     private final boolean eagerResolving;

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/nodes/graphbuilderconf/GraphBuilderContext.java

@@ -291,7 +291,7 @@ default int getDepth() {
      *            returns true, the resulting call stack does not include the target of the
      *            invocation plugin.
      */
-    default List<StackTraceElement> getCallStack(boolean ignoreInvocationPluginTarget) {
+    default List<StackTraceElement> getInliningCallStack(boolean ignoreInvocationPluginTarget) {
         List<StackTraceElement> callStack = new ArrayList<>();
         for (GraphBuilderContext cur = this; cur != null; cur = cur.getParent()) {
             callStack.add(cur.getMethod().asStackTraceElement(cur.bci()));

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/replacements/IntrinsicGraphBuilder.java

@@ -329,7 +329,7 @@ public int getDepth() {
     }
 
     @Override
-    public List<StackTraceElement> getCallStack(boolean ignoreInvocationPluginTarget) {
+    public List<StackTraceElement> getInliningCallStack(boolean ignoreInvocationPluginTarget) {
         return new ArrayList<>();
     }
 

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/replacements/PEGraphDecoder.java

@@ -414,7 +414,7 @@ public int getDepth() {
         }
 
         @Override
-        public List<StackTraceElement> getCallStack(boolean ignoreInvocationPluginTarget) {
+        public List<StackTraceElement> getInliningCallStack(boolean ignoreInvocationPluginTarget) {
             StackTraceElement[] callStackArray = methodScope.getCallStack();
             List<StackTraceElement> callStack = new ArrayList<>(callStackArray.length);
             Collections.addAll(callStack, callStackArray);

substratevm/src/com.oracle.svm.graal/src/com/oracle/svm/graal/hosted/runtimecompilation/RuntimeCompiledMethodSupport.java

@@ -461,7 +461,7 @@ private static final class RuntimeBytecodeParser extends AnalysisGraphBuilderPha
 
         RuntimeBytecodeParser(GraphBuilderPhase.Instance graphBuilderInstance, StructuredGraph graph, BytecodeParser parent, ResolvedJavaMethod method, int entryBCI,
                         IntrinsicContext intrinsicContext, SVMHost svmHost) {
-            super(graphBuilderInstance, graph, parent, method, entryBCI, intrinsicContext, svmHost, false);
+            super(graphBuilderInstance, graph, parent, method, entryBCI, intrinsicContext, svmHost, false, null);
         }
 
         @Override

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/NativeImageGenerator.java

@@ -945,6 +945,7 @@ protected void setupNativeImage(String imageName, OptionValues options, Map<Meth
                 ImageSingletons.add(ClassLoaderSupport.class, classLoaderSupport);
                 ImageSingletons.add(LinkAtBuildTimeSupport.class, new LinkAtBuildTimeSupport(loader, classLoaderSupport));
                 ImageSingletons.add(ObservableImageHeapMapProvider.class, new ObservableImageHeapMapProviderImpl());
+                ImageSingletons.add(PreParseCallbackSupport.class, new PreParseCallbackSupport());
 
                 ClassInitializationSupport classInitializationSupport = new ClassInitializationSupport(originalMetaAccess, loader);
                 ImageSingletons.add(RuntimeClassInitializationSupport.class, classInitializationSupport);

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/nodes/graphbuilderconf/MethodParsingPlugin.java renamed to substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/PreParseCallback.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2025, 2025, 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
@@ -22,16 +22,21 @@
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
-package jdk.graal.compiler.nodes.graphbuilderconf;
+package com.oracle.svm.hosted;
 
+import jdk.graal.compiler.nodes.graphbuilderconf.IntrinsicContext;
 import jdk.vm.ci.meta.ResolvedJavaMethod;
 
 /**
- * Plugin for accessing the method currently being parsed. These plugins are executed before
- * invocation and other types of bytecode parser plugins and can be used for collecting certain
- * information from the parsed method that the other plugins may rely on.
+ * Callback executed at the start of method parsing. It is executed before any bytecode parser
+ * invocation plugin, and can as such be used to collect information from the method that the
+ * plugins may rely on.
  */
-public interface MethodParsingPlugin extends GraphBuilderPlugin {
+public interface PreParseCallback {
 
+    /**
+     * Execute the callback for {@code method}. {@code IntrinsicContext} is null if no intrinsic is
+     * currently being processed.
+     */
     void execute(ResolvedJavaMethod method, IntrinsicContext intrinsicContext);
 }

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/PreParseCallbackSupport.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2025, 2025, 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 com.oracle.svm.hosted;
+
+import jdk.graal.compiler.nodes.graphbuilderconf.IntrinsicContext;
+import jdk.vm.ci.meta.ResolvedJavaMethod;
+import org.graalvm.nativeimage.ImageSingletons;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Represents a hook for callbacks executed right before the start of method parsing by
+ * {@link com.oracle.svm.hosted.phases.SharedGraphBuilderPhase.SharedBytecodeParser}.
+ */
+public class PreParseCallbackSupport {
+
+    private final List<PreParseCallback> preParseCallbacks = new ArrayList<>();
+
+    public static PreParseCallbackSupport singleton() {
+        return ImageSingletons.lookup(PreParseCallbackSupport.class);
+    }
+
+    /**
+     * Add a {@link PreParseCallback} to be executed at the start of method parsing, i.e., before
+     * any invocation plugins are executed.
+     */
+    public void addCallback(PreParseCallback preParseCallback) {
+        preParseCallbacks.add(preParseCallback);
+    }
+
+    public void executeCallbacks(ResolvedJavaMethod method, IntrinsicContext intrinsicContext) {
+        preParseCallbacks.forEach(cb -> cb.execute(method, intrinsicContext));
+    }
+}

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/classinitialization/ClassInitializerGraphBuilderPhase.java

@@ -24,6 +24,7 @@
  */
 package com.oracle.svm.hosted.classinitialization;
 
+import com.oracle.svm.hosted.PreParseCallbackSupport;
 import com.oracle.svm.hosted.phases.SharedGraphBuilderPhase;
 
 import jdk.graal.compiler.java.BytecodeParser;
@@ -73,7 +74,7 @@ protected BytecodeParser createBytecodeParser(StructuredGraph graph, BytecodePar
     static class ClassInitializerBytecodeParser extends SharedBytecodeParser {
         ClassInitializerBytecodeParser(GraphBuilderPhase.Instance graphBuilderInstance, StructuredGraph graph, BytecodeParser parent, ResolvedJavaMethod method, int entryBCI,
                         IntrinsicContext intrinsicContext) {
-            super(graphBuilderInstance, graph, parent, method, entryBCI, intrinsicContext, true, false);
+            super(graphBuilderInstance, graph, parent, method, entryBCI, intrinsicContext, true, false, PreParseCallbackSupport.singleton());
         }
     }
 }

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/java/dataflow/AbstractFrame.java renamed to substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/dataflow/AbstractFrame.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2025, 2025, 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
@@ -22,9 +22,9 @@
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
-package jdk.graal.compiler.java.dataflow;
+package com.oracle.svm.hosted.dataflow;
 
-import jdk.graal.compiler.debug.GraalError;
+import com.oracle.svm.core.util.VMError;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -173,12 +173,12 @@ void push(ValueWithSlots<T> value) {
         }
 
         ValueWithSlots<T> pop() {
-            GraalError.guarantee(!stack.isEmpty(), "Cannot pop from empty stack");
+            VMError.guarantee(!stack.isEmpty(), "Cannot pop from empty stack");
             return stack.removeLast();
         }
 
         ValueWithSlots<T> peek(int depth) {
-            GraalError.guarantee(0 <= depth && depth < size(), "Operand stack doesn't contain enough values");
+            VMError.guarantee(0 <= depth && depth < size(), "Operand stack doesn't contain enough values");
             return stack.get(stack.size() - depth - 1);
         }
 
@@ -191,11 +191,11 @@ void clear() {
         }
 
         void mergeWith(OperandStack<T> other, BiFunction<T, T, T> mergeFunction) {
-            GraalError.guarantee(size() == other.size(), "Operand stack size must match upon merging");
+            VMError.guarantee(size() == other.size(), "Operand stack size must match upon merging");
             for (int i = 0; i < stack.size(); i++) {
                 ValueWithSlots<T> thisValue = stack.get(i);
                 ValueWithSlots<T> thatValue = other.stack.get(i);
-                GraalError.guarantee(thisValue.size() == thatValue.size(), "The size of operand stack values must match upon merging");
+                VMError.guarantee(thisValue.size() == thatValue.size(), "The size of operand stack values must match upon merging");
                 ValueWithSlots<T> mergedValue = new ValueWithSlots<>(mergeFunction.apply(thisValue.value(), thatValue.value()), thisValue.size());
                 stack.set(i, mergedValue);
             }
@@ -281,7 +281,7 @@ void put(int index, ValueWithSlots<T> value) {
         }
 
         ValueWithSlots<T> get(int index) {
-            GraalError.guarantee(variables.containsKey(index), "Attempted to access non-existent variable in local variable table");
+            VMError.guarantee(variables.containsKey(index), "Attempted to access non-existent variable in local variable table");
             return variables.get(index);
         }