[GR-57553] Delay the canonicalization of TestDeoptimizeNode

PullRequest: graal/18647

Author: d-kozak

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/nodes/TestDeoptimizeNode.java renamed to substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/nodes/TestDeoptimizeNode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2014, 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
@@ -22,9 +22,11 @@
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
-package com.oracle.svm.hosted.nodes;
+package com.oracle.svm.core.graal.nodes;
 
-import com.oracle.svm.hosted.code.SubstrateCompilationDirectives;
+import com.oracle.svm.core.BuildPhaseProvider;
+import com.oracle.svm.core.SubstrateUtil;
+import com.oracle.svm.core.util.VMError;
 
 import jdk.graal.compiler.core.common.type.StampFactory;
 import jdk.graal.compiler.graph.Node;
@@ -40,8 +42,8 @@
 import jdk.vm.ci.meta.DeoptimizationReason;
 
 /**
- * For deoptimzation testing. The node performs a deoptimization in a normally compiled method, but
- * is a no-op in the deoptimization target method.
+ * For deoptimization testing. The node performs a deoptimization, but the lowering to
+ * DeoptimizeNode is delayed, so that the analysis sees a return from original method.
  */
 @NodeInfo(cycles = NodeCycles.CYCLES_IGNORED, size = NodeSize.SIZE_IGNORED)
 public class TestDeoptimizeNode extends FixedWithNextNode implements Canonicalizable {
@@ -53,12 +55,12 @@ public TestDeoptimizeNode() {
 
     @Override
     public Node canonical(CanonicalizerTool tool) {
-        if (SubstrateCompilationDirectives.isDeoptTarget(graph().method())) {
-            /* no-op for deoptimization target methods. */
-            return null;
-        } else {
-            /* deoptimization for all other methods. */
+        if (SubstrateUtil.HOSTED) {
+            if (!BuildPhaseProvider.isAnalysisFinished()) {
+                return this;
+            }
             return new DeoptimizeNode(DeoptimizationAction.None, DeoptimizationReason.TransferToInterpreter);
         }
+        throw VMError.shouldNotReachHere("Should only be used in hosted.");
     }
 }

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/heap/PodFactorySubstitutionMethod.java

@@ -43,12 +43,12 @@
 import com.oracle.svm.core.graal.nodes.DeoptProxyAnchorNode;
 import com.oracle.svm.core.graal.nodes.LoweredDeadEndNode;
 import com.oracle.svm.core.graal.nodes.NewPodInstanceNode;
+import com.oracle.svm.core.graal.nodes.TestDeoptimizeNode;
 import com.oracle.svm.core.heap.Pod;
 import com.oracle.svm.core.heap.Pod.RuntimeSupport.PodFactory;
 import com.oracle.svm.hosted.annotation.CustomSubstitutionMethod;
 import com.oracle.svm.hosted.code.SubstrateCompilationDirectives;
 import com.oracle.svm.hosted.nodes.DeoptProxyNode;
-import com.oracle.svm.hosted.nodes.TestDeoptimizeNode;
 import com.oracle.svm.hosted.phases.HostedGraphKit;
 
 import jdk.graal.compiler.core.common.type.StampFactory;
@@ -133,7 +133,9 @@ public StructuredGraph buildGraph(DebugContext debug, AnalysisMethod method, Hos
         int nextDeoptIndex = startMethod(kit, deoptInfo, 0);
         instantiatePod(kit, factoryType, podConcreteType, instanceLocal);
         if (isAnnotationPresent(DeoptTest.class)) {
-            kit.append(new TestDeoptimizeNode());
+            if (!SubstrateCompilationDirectives.isDeoptTarget(method)) {
+                kit.append(new TestDeoptimizeNode());
+            }
         }
         nextDeoptIndex = invokeConstructor(kit, deoptInfo, nextDeoptIndex, targetCtor, instanceLocal);
 

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/snippets/SubstrateGraphBuilderPlugins.java

@@ -74,6 +74,7 @@
 import com.oracle.svm.core.graal.nodes.SubstrateCompressionNode;
 import com.oracle.svm.core.graal.nodes.SubstrateNarrowOopStamp;
 import com.oracle.svm.core.graal.nodes.SubstrateReflectionGetCallerClassNode;
+import com.oracle.svm.core.graal.nodes.TestDeoptimizeNode;
 import com.oracle.svm.core.graal.stackvalue.LateStackValueNode;
 import com.oracle.svm.core.graal.stackvalue.StackValueNode;
 import com.oracle.svm.core.graal.stackvalue.UnsafeLateStackValue;
@@ -100,7 +101,6 @@
 import com.oracle.svm.hosted.code.SubstrateCompilationDirectives;
 import com.oracle.svm.hosted.nodes.DeoptProxyNode;
 import com.oracle.svm.hosted.nodes.ReadReservedRegister;
-import com.oracle.svm.hosted.nodes.TestDeoptimizeNode;
 import com.oracle.svm.hosted.substitute.AnnotationSubstitutionProcessor;
 
 import jdk.graal.compiler.core.common.CompressEncoding;
@@ -951,7 +951,9 @@ public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Rec
         r.register(new RequiredInvocationPlugin("testDeoptimize") {
             @Override
             public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver) {
-                b.add(new TestDeoptimizeNode());
+                if (!SubstrateCompilationDirectives.isDeoptTarget(b.getMethod())) {
+                    b.add(new TestDeoptimizeNode());
+                }
                 return true;
             }
         });