Add branch.unaligned to allow users to branch to locations with lower…

… stack pointers
oracle · May 29, 2024 · a0befe1 · a0befe1
1 parent f676e4f
commit a0befe1
Show file tree

Hide file tree

Showing 8 changed files with 225 additions and 173 deletions.
diff --git a/...acle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/DeadCodeTest.java b/...acle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/DeadCodeTest.java
@@ -563,7 +563,7 @@ public void testUnreachableBranch() {
         }).getRootNode();
 
         assertInstructions(node,
-                        "branch",
+                        "branch.unaligned",
                         "load.constant",
                         "return");
 

diff --git a/...om.oracle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/TagTest.java b/...om.oracle.truffle.api.bytecode.test/src/com/oracle/truffle/api/bytecode/test/TagTest.java
@@ -1248,7 +1248,7 @@ public void testImplicitJumpAfterReturn() {
         });
 
         assertInstructions(node,
-                        "branch",
+                        "branch.unaligned",
                         "load.constant",
                         "return");
 
@@ -1259,7 +1259,7 @@ public void testImplicitJumpAfterReturn() {
                         "tag.enter",
                         "tag.enter",
                         "tag.leaveVoid",
-                        "branch",
+                        "branch.unaligned",
                         "tag.leaveVoid",
                         "load.constant",
                         "tag.leave",
@@ -1271,10 +1271,10 @@ public void testImplicitJumpAfterReturn() {
         // instrumentation events should be correct even if we hit a trap
         assertEvents(node,
                         events,
-                        new Event(EventKind.ENTER, 0x0000, 0x0012, null, RootTag.class),
-                        new Event(EventKind.ENTER, 0x0002, 0x0008, null, ExpressionTag.class),
-                        new Event(EventKind.RETURN_VALUE, 0x0002, 0x0008, null, ExpressionTag.class),
-                        new Event(EventKind.RETURN_VALUE, 0x0000, 0x0012, null, RootTag.class));
+                        new Event(EventKind.ENTER, 0x0000, 0x0013, null, RootTag.class),
+                        new Event(EventKind.ENTER, 0x0002, 0x0009, null, ExpressionTag.class),
+                        new Event(EventKind.RETURN_VALUE, 0x0002, 0x0009, null, ExpressionTag.class),
+                        new Event(EventKind.RETURN_VALUE, 0x0000, 0x0013, null, RootTag.class));
 
     }
 
@@ -1363,7 +1363,7 @@ public void testImplicitJump() {
         });
 
         assertInstructions(node,
-                        "branch",
+                        "branch.unaligned",
                         "load.constant",
                         "return");
 
@@ -1376,7 +1376,7 @@ public void testImplicitJump() {
                         "tag.enter",
                         "tag.enter",
                         "tag.leaveVoid",
-                        "branch",
+                        "branch.unaligned",
                         "tag.leaveVoid",
                         "load.constant",
                         "tag.leave",
@@ -1388,10 +1388,10 @@ public void testImplicitJump() {
 
         assertEvents(node,
                         events,
-                        new Event(EventKind.ENTER, 0x0000, 0x0010, null, RootTag.class),
-                        new Event(EventKind.ENTER, 0x0002, 0x0008, null, ExpressionTag.class),
-                        new Event(EventKind.RETURN_VALUE, 0x0002, 0x0008, null, ExpressionTag.class),
-                        new Event(EventKind.RETURN_VALUE, 0x0000, 0x0010, 42, RootTag.class));
+                        new Event(EventKind.ENTER, 0x0000, 0x0011, null, RootTag.class),
+                        new Event(EventKind.ENTER, 0x0002, 0x0009, null, ExpressionTag.class),
+                        new Event(EventKind.RETURN_VALUE, 0x0002, 0x0009, null, ExpressionTag.class),
+                        new Event(EventKind.RETURN_VALUE, 0x0000, 0x0011, 42, RootTag.class));
     }
 
     @Test

diff --git a/....bytecode.test/src/com/oracle/truffle/api/bytecode/test/basic_interpreter/BranchTest.java b/....bytecode.test/src/com/oracle/truffle/api/bytecode/test/basic_interpreter/BranchTest.java
@@ -42,6 +42,7 @@
 
 import static org.junit.Assert.assertEquals;
 
+import org.junit.Ignore;
 import org.junit.Test;
 
 import com.oracle.truffle.api.RootCallTarget;
@@ -123,15 +124,15 @@ public void testBranchBackward() {
     }
 
     @Test
-    public void testBranchOutwardValid() {
+    public void testBranchOutwardBalanced() {
         // {
         //   if(arg0 < 0) goto lbl;
         //   return 123;
         // }
         // lbl:
         // return 42;
 
-        RootCallTarget root = parse("branchOutwardValid", b -> {
+        RootCallTarget root = parse("branchOutwardBalanced", b -> {
             b.beginRoot(LANGUAGE);
 
             BytecodeLabel lbl = b.createLabel();
@@ -153,7 +154,7 @@ public void testBranchOutwardValid() {
 
             b.emitLabel(lbl);
 
-            emitReturn(b, 42);
+            emitReturn(b, 42L);
 
             b.endRoot();
         });
@@ -163,14 +164,12 @@ public void testBranchOutwardValid() {
     }
 
     @Test
-    public void testBranchOutwardInvalid() {
+    public void testBranchOutwardUnbalanced() {
         // return 1 + { goto lbl; 2 }
         // lbl:
-        // return 0;
+        // return 42;
 
-        thrown.expect(IllegalStateException.class);
-        thrown.expectMessage("BytecodeLabel was emitted at a position with a different stack height than a branch instruction that targets it. Expected stack height 1, but was 0. Branches must be balanced.");
-        parse("branchOutwardInvalid", b -> {
+        RootCallTarget root = parse("branchOutwardUnbalanced", b -> {
             b.beginRoot(LANGUAGE);
 
             BytecodeLabel lbl = b.createLabel();
@@ -187,11 +186,12 @@ public void testBranchOutwardInvalid() {
 
             b.emitLabel(lbl);
 
-            emitReturn(b, 0);
+            emitReturn(b, 42L);
 
             b.endRoot();
         });
 
+        assertEquals(42L, root.call());
     }
 
     @Test
@@ -234,7 +234,7 @@ public void testBranchBalancedStack() {
         //   result
         // };
 
-        RootCallTarget root = parse("branchInvalidStack", b -> {
+        RootCallTarget root = parse("branchBalancedStack", b -> {
             b.beginRoot(LANGUAGE);
             b.beginReturn();
             b.beginAddOperation();

diff --git a/...ecode.test/src/com/oracle/truffle/api/bytecode/test/basic_interpreter/FinallyTryTest.java b/...ecode.test/src/com/oracle/truffle/api/bytecode/test/basic_interpreter/FinallyTryTest.java
@@ -352,7 +352,6 @@ public void testFinallyTryBranchForwardOutOfHandler() {
     }
 
     @Test
-    @Ignore("unbalanced branches not yet supported")
     public void testFinallyTryBranchForwardOutOfHandlerUnbalanced() {
         /**
          * This test is the same as the previous, but because of the "return 0",
@@ -1074,7 +1073,6 @@ public void testFinallyTryBranchIntoOuterFinally() {
 
 
     @Test
-    @Ignore("unbalanced branches not yet supported")
     public void testFinallyTryBranchIntoOuterFinallyUnbalanced() {
         /**
          * This test is the same as the previous, but because of the "return 0"'s,
@@ -1215,7 +1213,6 @@ public void testFinallyTryBranchIntoOuterFinallyNestedInAnotherFinally() {
     }
 
     @Test
-    @Ignore("unbalanced branches not yet supported")
     public void testFinallyTryBranchIntoOuterFinallyNestedInAnotherFinallyUnbalanced() {
         /**
          * This test is the same as the previous, but because of the "return 0"'s in handlers b and c,
@@ -1299,7 +1296,7 @@ public void testFinallyTryBranchIntoOuterFinallyNestedInAnotherFinallyUnbalanced
             b.endRoot();
         });
 
-        testOrdering(false, root, 1L, 3L, 5L, 6L, 8L, 11L, 12L);
+        testOrdering(false, root, 1L, 3L, 5L, 6L, 8L, 11L);
     }
 
     @Test