Fix handling of macros in SVM runtime compilations

Author: gergo-

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/replacements/nodes/MacroInvokable.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 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
@@ -26,6 +26,7 @@
 
 import static jdk.vm.ci.code.BytecodeFrame.isPlaceholderBci;
 
+import jdk.graal.compiler.core.common.type.ObjectStamp;
 import jdk.graal.compiler.core.common.type.StampPair;
 import jdk.graal.compiler.debug.Assertions;
 import jdk.graal.compiler.debug.DebugContext;
@@ -89,6 +90,13 @@ public interface MacroInvokable extends Invokable, Lowerable, StateSplit, Single
      */
     NodeInputList<ValueNode> getArguments();
 
+    /**
+     * Gets {@linkplain #getArguments() the arguments} for this macro node as an array.
+     */
+    default ValueNode[] toArgumentArray() {
+        return getArguments().toArray(ValueNode.EMPTY_ARRAY);
+    }
+
     /**
      * @see #getArguments()
      */
@@ -197,4 +205,21 @@ default MethodCallTargetNode createCallTarget() {
      * {@link Invoke} later.
      */
     void addMethodHandleInfo(ResolvedMethodHandleCallTargetNode methodHandle);
+
+    /**
+     * Build a new copy of the {@link MacroNode.MacroParams} stored in this node.
+     */
+    default MacroNode.MacroParams copyParams() {
+        return new MacroNode.MacroParams(getInvokeKind(), getContextMethod(), getTargetMethod(), bci(), getReturnStamp(), toArgumentArray());
+    }
+
+    /**
+     * Builds a new copy of this node's macro parameters, but with the return stamp replaced by the
+     * trusted {@code newStamp}.
+     */
+    default MacroNode.MacroParams copyParamsWithImprovedStamp(ObjectStamp newStamp) {
+        GraalError.guarantee(newStamp.join(getReturnStamp().getTrustedStamp()).equals(newStamp), "stamp should improve from %s to %s", getReturnStamp(), newStamp);
+        StampPair improvedReturnStamp = StampPair.createSingle(newStamp);
+        return new MacroNode.MacroParams(getInvokeKind(), getContextMethod(), getTargetMethod(), bci(), improvedReturnStamp, toArgumentArray());
+    }
 }

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/replacements/nodes/MacroNode.java

@@ -30,7 +30,6 @@
 
 import org.graalvm.word.LocationIdentity;
 
-import jdk.graal.compiler.core.common.type.ObjectStamp;
 import jdk.graal.compiler.core.common.type.StampPair;
 import jdk.graal.compiler.debug.DebugCloseable;
 import jdk.graal.compiler.debug.GraalError;
@@ -187,10 +186,6 @@ public NodeInputList<ValueNode> getArguments() {
         return arguments;
     }
 
-    public ValueNode[] toArgumentArray() {
-        return arguments.toArray(ValueNode.EMPTY_ARRAY);
-    }
-
     @Override
     public int bci() {
         return bci;
@@ -243,15 +238,6 @@ public final boolean hasSideEffect() {
         return true;
     }
 
-    /**
-     * Returns {@code true} if the lowered version of the macro, or the fallback invoke, can
-     * deoptimize in any way or throw any implicit or explicit exception. Such nodes should be
-     * represented as {@link MacroWithExceptionNode} in SVM runtime compilations.
-     */
-    public boolean canDeoptimizeOrThrow() {
-        return true;
-    }
-
     /**
      * Returns {@link LocationIdentity#any()}. This node needs to kill any location because it might
      * get {@linkplain MacroInvokable#replaceWithInvoke() replaced with an invoke} and
@@ -310,21 +296,4 @@ public void addMethodHandleInfo(ResolvedMethodHandleCallTargetNode methodHandle)
         originalTargetMethod = methodHandle.originalTargetMethod;
         originalArguments.addAll(methodHandle.originalArguments);
     }
-
-    /**
-     * Build a new copy of the {@link MacroParams} stored in this node.
-     */
-    public MacroParams copyParams() {
-        return new MacroParams(invokeKind, callerMethod, targetMethod, bci, returnStamp, toArgumentArray());
-    }
-
-    /**
-     * Builds a new copy of this node's macro parameters, but with the return stamp replaced by the
-     * trusted {@code newStamp}.
-     */
-    protected MacroParams copyParamsWithImprovedStamp(ObjectStamp newStamp) {
-        GraalError.guarantee(newStamp.join(returnStamp.getTrustedStamp()).equals(newStamp), "stamp should improve from %s to %s", returnStamp, newStamp);
-        StampPair improvedReturnStamp = StampPair.createSingle(newStamp);
-        return new MacroParams(invokeKind, callerMethod, targetMethod, bci, improvedReturnStamp, toArgumentArray());
-    }
 }

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/results/StrengthenGraphs.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2021, 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
@@ -117,7 +117,7 @@
 import jdk.graal.compiler.phases.common.CanonicalizerPhase.CustomSimplification;
 import jdk.graal.compiler.phases.common.inlining.InliningUtil;
 import jdk.graal.compiler.printer.GraalDebugHandlersFactory;
-import jdk.graal.compiler.replacements.nodes.MacroNode;
+import jdk.graal.compiler.replacements.nodes.MacroInvokable;
 import jdk.vm.ci.meta.Constant;
 import jdk.vm.ci.meta.JavaConstant;
 import jdk.vm.ci.meta.JavaKind;
@@ -406,7 +406,7 @@ protected TypeFlow<?> getNodeFlow(Node node) {
 
         @Override
         public void simplify(Node n, SimplifierTool tool) {
-            if (n instanceof ValueNode && !(n instanceof LimitedValueProxy) && !(n instanceof PhiNode) && !(n instanceof MacroNode)) {
+            if (n instanceof ValueNode && !(n instanceof LimitedValueProxy) && !(n instanceof PhiNode) && !(n instanceof MacroInvokable)) {
                 /*
                  * The stamp of proxy nodes and phi nodes is inferred automatically, so we do not
                  * need to improve them. Macro nodes prohibit changing their stamp because it is

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, 2025, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2023, 2023, 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
@@ -488,8 +488,7 @@ public static class ConvertMacroNodes extends Phase {
         @Override
         protected void run(StructuredGraph graph) {
             for (Node n : graph.getNodes().snapshot()) {
-                VMError.guarantee(!(n instanceof MacroNode macro && macro.canDeoptimizeOrThrow()), "DeoptTarget Methods do not support Macro Nodes that may deopt or throw: method %s, node %s",
-                                graph.method(), n);
+                VMError.guarantee(!(n instanceof MacroNode), "DeoptTarget Methods do not support Macro Nodes: method %s, node %s", graph.method(), n);
 
                 if (n instanceof MacroWithExceptionNode macro) {
                     macro.replaceWithInvoke();