Implement RootNode#prepareForCall in Bytecode DSL interpreters

Author: DSouzaM

truffle/src/com.oracle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/basic_interpreter/BasicInterpreterTest.java

@@ -3196,6 +3196,26 @@ public void testTags() {
         assertEquals(3L, root.call());
     }
 
+    @Test
+    public void testPrepareForCall() {
+        assertThrows(IllegalStateException.class, () -> parse("getCallTargetDuringParse", b -> {
+            b.beginRoot();
+            b.beginReturn();
+            b.emitLoadConstant(42L);
+            b.endReturn();
+            BasicInterpreter root = b.endRoot();
+            root.getCallTarget();
+        }));
+
+        assertTrue(parse("getCallTargetAfterParse", b -> {
+            b.beginRoot();
+            b.beginReturn();
+            b.emitLoadConstant(42L);
+            b.endReturn();
+            b.endRoot();
+        }) != null);
+    }
+
     @Test
     public void testCloneUninitializedAdd() {
         // return arg0 + arg1;

truffle/src/com.oracle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/error_tests/ErrorTests.java

@@ -361,37 +361,86 @@ protected BadOverrides(ErrorLanguage language, FrameDescriptor frameDescriptor)
             super(language, frameDescriptor);
         }
 
-        @ExpectError("This method is overridden by the generated Bytecode DSL class, so it cannot be declared final. Since it is overridden, the definition is unreachable and can be removed.")
+        private static final String ERROR_MESSAGE = "This method is overridden by the generated Bytecode DSL class, so it cannot be declared final. " +
+                        "You can remove the final modifier to resolve this issue, but since the override will make this method unreachable, it is recommended to simply remove it.";
+
+        @ExpectError(ERROR_MESSAGE)
         @Override
         public final Object execute(VirtualFrame frame) {
             return null;
         }
 
-        @ExpectError("This method is overridden by the generated Bytecode DSL class, so it cannot be declared final. Since it is overridden, the definition is unreachable and can be removed.")
+        @ExpectError(ERROR_MESSAGE)
+        @Override
+        public final int computeSize() {
+            return 0;
+        }
+
+        @ExpectError(ERROR_MESSAGE)
+        @Override
+        public final int findBytecodeIndex(Node node, Frame frame) {
+            return 0;
+        }
+
+        @ExpectError(ERROR_MESSAGE)
+        @Override
+        public final Node findInstrumentableCallNode(Node callNode, Frame frame, int bytecodeIndex) {
+            return null;
+        }
+
+        @ExpectError(ERROR_MESSAGE)
+        @Override
+        public final boolean isInstrumentable() {
+            return false;
+        }
+
+        @ExpectError(ERROR_MESSAGE)
+        @Override
+        public final boolean isCaptureFramesForTrace(boolean compiledFrame) {
+            return false;
+        }
+
+        @ExpectError(ERROR_MESSAGE)
+        @Override
+        public final void prepareForCall() {
+        }
+
+        @ExpectError(ERROR_MESSAGE)
+        @Override
+        public final boolean prepareForCompilation(boolean rootCompilation, int compilationTier, boolean lastTier) {
+            return false;
+        }
+
+        @ExpectError(ERROR_MESSAGE)
+        @Override
+        public final void prepareForInstrumentation(Set<Class<?>> tags) {
+        }
+
+        @ExpectError(ERROR_MESSAGE)
         public final Object getOSRMetadata() {
             return null;
         }
 
-        @ExpectError("This method is overridden by the generated Bytecode DSL class, so it cannot be declared final. Since it is overridden, the definition is unreachable and can be removed.")
+        @ExpectError(ERROR_MESSAGE)
         public final void setOSRMetadata(Object osrMetadata) {
         }
 
-        @ExpectError("This method is overridden by the generated Bytecode DSL class, so it cannot be declared final. Since it is overridden, the definition is unreachable and can be removed.")
+        @ExpectError(ERROR_MESSAGE)
         public final Object[] storeParentFrameInArguments(VirtualFrame parentFrame) {
             return null;
         }
 
-        @ExpectError("This method is overridden by the generated Bytecode DSL class, so it cannot be declared final. Since it is overridden, the definition is unreachable and can be removed.")
+        @ExpectError(ERROR_MESSAGE)
         public final Frame restoreParentFrameFromArguments(Object[] arguments) {
             return null;
         }
 
-        @ExpectError("This method is overridden by the generated Bytecode DSL class, so it cannot be declared final. Since it is overridden, the definition is unreachable and can be removed.")
+        @ExpectError(ERROR_MESSAGE)
         public final BytecodeNode getBytecodeNode() {
             return null;
         }
 
-        @ExpectError("This method is overridden by the generated Bytecode DSL class, so it cannot be declared final. Since it is overridden, the definition is unreachable and can be removed.")
+        @ExpectError(ERROR_MESSAGE)
         public final BytecodeRootNodes<?> getRootNodes() {
             return null;
         }
@@ -417,11 +466,13 @@ static int add(int x, int y) {
             }
         }
 
+        @ExpectWarning("This method is overridden by the generated Bytecode DSL class, so this definition is unreachable and can be removed.")
         @Override
         public int findBytecodeIndex(Node node, Frame frame) {
             return super.findBytecodeIndex(node, frame);
         }
 
+        @ExpectWarning("This method is overridden by the generated Bytecode DSL class, so this definition is unreachable and can be removed.")
         @Override
         public boolean isCaptureFramesForTrace(boolean compiledFrame) {
             return super.isCaptureFramesForTrace(compiledFrame);
@@ -777,7 +828,7 @@ public Object fallback(Object a, Object b) {
 
     /**
      * These specializations should not be a problem. See
-     * {@link OperationErrorTests.PackagePrivateSpecializationOperation}
+     * {@link ErrorTests.BadSpecializationTests.PackagePrivateSpecializationOperation}
      */
     @OperationProxy.Proxyable
     public abstract static class PackagePrivateSpecializationOperationProxy extends Node {

truffle/src/com.oracle.truffle.dsl.processor/src/com/oracle/truffle/dsl/processor/bytecode/generator/BytecodeRootNodeElement.java

@@ -385,6 +385,7 @@ final class BytecodeRootNodeElement extends CodeTypeElement {
 
         // Other root node overrides.
         this.add(createIsInstrumentable());
+        this.add(createPrepareForCall());
         this.addOptional(createPrepareForInstrumentation());
         this.addOptional(createPrepareForCompilation());
 
@@ -1622,6 +1623,15 @@ private CodeExecutableElement createIsInstrumentable() {
         return ex;
     }
 
+    private CodeExecutableElement createPrepareForCall() {
+        CodeExecutableElement ex = overrideImplementRootNodeMethod(model, "prepareForCall");
+        CodeTreeBuilder b = ex.createBuilder();
+        b.startIf().string("!this.nodes.isParsed()").end().startBlock();
+        emitThrowIllegalStateException(ex, b, "A call target cannot be created until bytecode parsing completes. Request a call target after the parse is complete instead.");
+        b.end();
+        return ex;
+    }
+
     private CodeExecutableElement createPrepareForInstrumentation() {
         if (!model.enableTagInstrumentation) {
             return null;
@@ -8393,6 +8403,7 @@ void lazyInit() {
             this.add(createGetParserImpl());
             this.add(createValidate());
             this.add(createGetLanguage());
+            this.add(createIsParsed());
 
             if (model.enableSerialization) {
                 this.add(createSerialize());
@@ -8618,6 +8629,13 @@ private CodeExecutableElement createGetLanguage() {
             return ex;
         }
 
+        public CodeExecutableElement createIsParsed() {
+            CodeExecutableElement ex = new CodeExecutableElement(Set.of(PRIVATE), type(boolean.class), "isParsed");
+            CodeTreeBuilder b = ex.createBuilder();
+            b.startReturn().string("nodes != null").end();
+            return ex;
+        }
+
         private CodeExecutableElement createSerialize() {
             CodeExecutableElement ex = GeneratorUtils.override(types.BytecodeRootNodes, "serialize", new String[]{"buffer", "callback"});
             mergeSuppressWarnings(ex, "cast");

truffle/src/com.oracle.truffle.dsl.processor/src/com/oracle/truffle/dsl/processor/bytecode/parser/BytecodeDSLParser.java

@@ -376,15 +376,23 @@ private void parseBytecodeDSLModel(TypeElement typeElement, BytecodeDSLModel mod
         model.interceptTruffleException = ElementUtils.findMethod(typeElement, "interceptTruffleException");
 
         // Detect method implementations that will be overridden by the generated class.
-        List<ExecutableElement> overrides = List.of(
+        List<ExecutableElement> overrides = new ArrayList<>(List.of(
                         ElementUtils.findMethod(types.RootNode, "execute"),
+                        ElementUtils.findMethod(types.RootNode, "computeSize"),
+                        ElementUtils.findMethod(types.RootNode, "findBytecodeIndex"),
+                        ElementUtils.findMethod(types.RootNode, "findInstrumentableCallNode"),
+                        ElementUtils.findMethod(types.RootNode, "isInstrumentable"),
+                        ElementUtils.findMethod(types.RootNode, "isCaptureFramesForTrace"),
+                        ElementUtils.findMethod(types.RootNode, "prepareForCall"),
+                        ElementUtils.findMethod(types.RootNode, "prepareForCompilation"),
+                        ElementUtils.findMethod(types.RootNode, "prepareForInstrumentation"),
                         ElementUtils.findMethod(types.BytecodeRootNode, "getBytecodeNode"),
                         ElementUtils.findMethod(types.BytecodeRootNode, "getRootNodes"),
                         ElementUtils.findMethod(types.BytecodeOSRNode, "executeOSR"),
                         ElementUtils.findMethod(types.BytecodeOSRNode, "getOSRMetadata"),
                         ElementUtils.findMethod(types.BytecodeOSRNode, "setOSRMetadata"),
                         ElementUtils.findMethod(types.BytecodeOSRNode, "storeParentFrameInArguments"),
-                        ElementUtils.findMethod(types.BytecodeOSRNode, "restoreParentFrameFromArguments"));
+                        ElementUtils.findMethod(types.BytecodeOSRNode, "restoreParentFrameFromArguments")));
 
         for (ExecutableElement override : overrides) {
             ExecutableElement declared = ElementUtils.findMethod(typeElement, override.getSimpleName().toString());
@@ -394,7 +402,8 @@ private void parseBytecodeDSLModel(TypeElement typeElement, BytecodeDSLModel mod
 
             if (declared.getModifiers().contains(Modifier.FINAL)) {
                 model.addError(declared,
-                                "This method is overridden by the generated Bytecode DSL class, so it cannot be declared final. Since it is overridden, the definition is unreachable and can be removed.");
+                                "This method is overridden by the generated Bytecode DSL class, so it cannot be declared final. " +
+                                                "You can remove the final modifier to resolve this issue, but since the override will make this method unreachable, it is recommended to simply remove it.");
             } else {
                 model.addWarning(declared, "This method is overridden by the generated Bytecode DSL class, so this definition is unreachable and can be removed.");
             }