[GR-69495] Bytecode DSL: Implement ability to configure whether the bytecode index is stored.

PullRequest: graal/22145

Author: chumer

truffle/CHANGELOG.md

@@ -15,6 +15,8 @@ This changelog summarizes major changes between Truffle versions relevant to lan
 * GR-69188: Added `@HostCompilerDirectives.InliningRoot` to explicitly trigger host inlining for a method designed for partial evaluation. Note that on SubstrateVM, host inlining is automatically enabled for all runtime-compilable methods, while on HotSpot you must add either `@HostCompilerDirectives.InliningRoot` or `@HostCompilerDirectives.BytecodeInterpreterSwitch` to enable it. Host inlining is only enabled if Graal is enabled as a Java host compiler. 
 * GR-67146: Specialization DSL: Added `@Bind` support for frames (including materialized frames).
 * GR-67146: Bytecode DSL: Added support for user-defined yield operations using `@Yield`. These operations behave like the built-in yield but allow you to customize the yield result or perform custom logic on yield.
+* GR-69495: Bytecode DSL: Added a new `storeBytecodeIndex` attribute to all operation annotations to configure whether the bytecode index needs to be stored. When `@GenerateBytecode(storeBytecodeIndexInFrame = true)` is set and the attribute is left at its default, the DSL will emit a warning recommending explicit configuration. Additionally, introduced the `@StoreBytecodeIndex` annotation, which lets you specify bytecode index updates for individual specializations or fallbacks.
+
 
 ## Version 25.0
 * GR-31495 Added ability to specify language and instrument specific options using `Source.Builder.option(String, String)`. Languages may describe available source options by implementing `TruffleLanguage.getSourceOptionDescriptors()` and `TruffleInstrument.getSourceOptionDescriptors()` respectively.

truffle/src/com.oracle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/ExternalProxyNode.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * The Universal Permissive License (UPL), Version 1.0
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.oracle.truffle.api.bytecode.test;
+
+import com.oracle.truffle.api.bytecode.OperationProxy;
+import com.oracle.truffle.api.dsl.Bind;
+import com.oracle.truffle.api.dsl.GenerateInline;
+import com.oracle.truffle.api.dsl.GenerateUncached;
+import com.oracle.truffle.api.dsl.Specialization;
+import com.oracle.truffle.api.frame.VirtualFrame;
+import com.oracle.truffle.api.nodes.Node;
+
+@GenerateUncached
+@GenerateInline(false)
+@OperationProxy.Proxyable(allowUncached = true)
+public abstract class ExternalProxyNode extends Node {
+    public abstract boolean execute(VirtualFrame frame, Object object);
+
+    @SuppressWarnings("unused")
+    @Specialization
+    public static boolean doBoolean(boolean object, @Bind Node node) {
+        return object;
+    }
+
+}

truffle/src/com.oracle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/InheritanceTest.java

@@ -147,8 +147,6 @@ protected InheritanceError1Node(BytecodeDSLTestLanguage language, FrameDescripto
             super(language, frameDescriptor);
         }
 
-        @ExpectError("All super types of operation classes must be declared as static nested classes of the operation root node. " +
-                        "Modify the super class 'BaseBaseClass' to be an inner class of type 'InheritanceError1Node' to resolve this or use @OperationProxy instead.")
         static class BaseClass extends BaseBaseClass {
             @Specialization(guards = "guard1(v)")
             public static Object s0(int v) {
@@ -160,6 +158,8 @@ static boolean guard1(int v) {
             }
         }
 
+        @ExpectError("All super types of operation classes must be declared as static nested classes of the operation root node. " +
+                        "Modify the super class 'BaseBaseClass' to be an inner class of type 'InheritanceError1Node' to resolve this or use @OperationProxy instead.")
         @Operation
         public static final class SubClass extends BaseClass {
             @Specialization(guards = "v >= 3")

truffle/src/com.oracle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/ReadBytecodeLocationTest.java

@@ -284,29 +284,29 @@ public String getSourceCharacters() {
         }
     }
 
-    @Prolog
+    @Prolog(storeBytecodeIndex = false)
     public static final class DoNothingProlog {
         @Specialization
         public static void doNothing() {
         }
     }
 
-    @EpilogReturn
+    @EpilogReturn(storeBytecodeIndex = false)
     public static final class DoNothingEpilog {
         @Specialization
         public static Object doNothing(Object returnValue) {
             return returnValue;
         }
     }
 
-    @EpilogExceptional
+    @EpilogExceptional(storeBytecodeIndex = false)
     public static final class DoNothingEpilogExceptional {
         @Specialization
         public static void doNothing(@SuppressWarnings("unused") AbstractTruffleException ex) {
         }
     }
 
-    @Operation
+    @Operation(storeBytecodeIndex = true)
     public static final class MakeRootAndFrame {
         @Specialization
         public static BytecodeAndFrame perform(VirtualFrame frame,
@@ -316,15 +316,15 @@ public static BytecodeAndFrame perform(VirtualFrame frame,
         }
     }
 
-    @Operation
+    @Operation(storeBytecodeIndex = false)
     public static final class GetSourceCharacters {
         @Specialization
         public static String perform(@SuppressWarnings("unused") VirtualFrame frame, BytecodeAndFrame rootAndFrame) {
             return rootAndFrame.getSourceCharacters();
         }
     }
 
-    @Operation
+    @Operation(storeBytecodeIndex = false)
     public static final class Throw {
         @Specialization
         public static Object perform(Object result) {

truffle/src/com.oracle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/StackTraceTest.java

@@ -386,7 +386,7 @@ static void doDefault() {
             }
         }
 
-        @Operation
+        @Operation(storeBytecodeIndex = true)
         @ConstantOperand(type = CallTarget.class)
         static final class Call {
             @Specialization
@@ -395,7 +395,8 @@ static Object doDefault(CallTarget target, @Bind Node node) {
             }
         }
 
-        @Operation
+        @SuppressWarnings("truffle-interpreted-performance")
+        @Operation(storeBytecodeIndex = true)
         @ConstantOperand(type = CallTarget.class)
         static final class CallNoLocation {
             @Specialization
@@ -404,7 +405,7 @@ static Object doDefault(CallTarget target) {
             }
         }
 
-        @Operation
+        @Operation(storeBytecodeIndex = true)
         static final class ThrowErrorBehindInterop {
 
             @Specialization(limit = "1")
@@ -417,7 +418,7 @@ static Object doDefault(Object executable, @CachedLibrary("executable") InteropL
             }
         }
 
-        @Operation
+        @Operation(storeBytecodeIndex = true)
         static final class ThrowError {
 
             @Specialization
@@ -426,7 +427,7 @@ static Object doDefault(@Bind Node node) {
             }
         }
 
-        @Operation
+        @Operation(storeBytecodeIndex = false)
         static final class ThrowErrorNoLocation {
 
             @Specialization
@@ -435,7 +436,7 @@ static Object doDefault() {
             }
         }
 
-        @Operation
+        @Operation(storeBytecodeIndex = true)
         static final class CaptureStack {
 
             @Specialization