Move BytecodeDebugListener to the bytecode DSL API.

Author: chumer

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

@@ -43,11 +43,12 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 import com.oracle.truffle.api.TruffleLanguage;
+import com.oracle.truffle.api.bytecode.debug.BytecodeDebugListener;
 import com.oracle.truffle.api.bytecode.introspection.Instruction;
 import com.oracle.truffle.api.frame.FrameDescriptor;
 import com.oracle.truffle.api.nodes.RootNode;
 
-public abstract class DebugBytecodeRootNode extends RootNode implements SpecializationDebugListener {
+public abstract class DebugBytecodeRootNode extends RootNode implements BytecodeDebugListener {
 
     static boolean traceQuickening = false;
 

truffle/src/com.oracle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/SpecializationDebugListener.java renamed to truffle/src/com.oracle.truffle.api.bytecode/src/com/oracle/truffle/api/bytecode/debug/BytecodeDebugListener.java

@@ -38,15 +38,15 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package com.oracle.truffle.api.bytecode.test;
+package com.oracle.truffle.api.bytecode.debug;
 
 import com.oracle.truffle.api.bytecode.introspection.Instruction;
 
 /**
  * Subclass this bytecode node to get additional debug event that are normally not available. Useful
  * for testing and debugging.
  */
-public interface SpecializationDebugListener {
+public interface BytecodeDebugListener {
 
     @SuppressWarnings("unused")
     default void onSpecialize(Instruction instruction, String specialization) {

truffle/src/com.oracle.truffle.api.bytecode/src/com/oracle/truffle/api/bytecode/debug/BytecodeDebugTraceListener.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2023, 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.debug;
+
+import java.io.PrintStream;
+
+import com.oracle.truffle.api.bytecode.introspection.Instruction;
+
+public interface BytecodeDebugTraceListener extends BytecodeDebugListener {
+
+    default void onQuicken(Instruction before, Instruction after) {
+        PrintStream out = System.out;
+        out.printf("Quicken %s: %n     %s%n  -> %s%n", before.getName(), before, after);
+    }
+
+    default void onQuickenOperand(Instruction base, int operandIndex, Instruction operandBefore, Instruction operandAfter) {
+        PrintStream out = System.out;
+        out.printf("Quicken operand index %s for %s: %n     %s%n  -> %s%n", operandIndex, base.getName(),
+                        operandBefore, operandAfter);
+    }
+
+    @Override
+    default void onSpecialize(Instruction instruction, String specialization) {
+        PrintStream out = System.out;
+        out.printf("Specialize %s: %n     %s%n", specialization, instruction);
+    }
+
+}

truffle/src/com.oracle.truffle.dsl.processor/src/com/oracle/truffle/dsl/processor/TruffleTypes.java

@@ -87,7 +87,7 @@ public class TruffleTypes {
         }
         ExpectErrorTypes = Collections.unmodifiableList(types);
     }
-    public final DeclaredType SpecializationDebugListener = c.getDeclaredTypeOptional("com.oracle.truffle.api.bytecode.test.SpecializationDebugListener");
+    public final DeclaredType BytecodeDebugListener = c.getDeclaredTypeOptional("com.oracle.truffle.api.bytecode.debug.BytecodeDebugListener");
 
     // Graal SDK
     public static final String OptionCategory_Name = "org.graalvm.options.OptionCategory";