[GR-19220] Split local and non-local returns (#1851).

aardvark179 · aardvark179 · commit 3a207a221b50 · 2019-12-17T17:28:03.000Z
PullRequest: truffleruby/1178
diff --git a/src/launcher/java/org/truffleruby/launcher/RubyLauncher.java b/src/launcher/java/org/truffleruby/launcher/RubyLauncher.java
@@ -234,6 +234,8 @@ private int runRubyMain(Context.Builder contextBuilder, CommandLineOptions confi
             Metrics.printTime("after-run");
             return exitCode;
         } catch (PolyglotException e) {
+            System.err.println(
+                    "truffleruby: an exception escaped out of the interpreter - this is an implementation bug");
             e.printStackTrace();
             return 1;
         }
diff --git a/src/main/java/org/truffleruby/core/fiber/FiberManager.java b/src/main/java/org/truffleruby/core/fiber/FiberManager.java
@@ -27,8 +27,8 @@
 import org.truffleruby.language.control.BreakException;
 import org.truffleruby.language.control.ExitException;
 import org.truffleruby.language.control.KillException;
+import org.truffleruby.language.control.DynamicReturnException;
 import org.truffleruby.language.control.RaiseException;
-import org.truffleruby.language.control.ReturnException;
 import org.truffleruby.language.control.TerminationException;
 import org.truffleruby.language.objects.ObjectIDOperations;
 
@@ -186,7 +186,7 @@ private void fiberMain(RubyContext context, DynamicObject fiber, DynamicObject b
                     fiber,
                     new RaiseException(context, context.getCoreExceptions().breakFromProcClosure(currentNode)),
                     currentNode);
-        } catch (ReturnException e) {
+        } catch (DynamicReturnException e) {
             sendExceptionToParentFiber(
                     fiber,
                     new RaiseException(context, context.getCoreExceptions().unexpectedReturn(currentNode)),
diff --git a/src/main/java/org/truffleruby/core/thread/ThreadManager.java b/src/main/java/org/truffleruby/core/thread/ThreadManager.java
@@ -33,8 +33,8 @@
 import org.truffleruby.language.SafepointManager;
 import org.truffleruby.language.control.ExitException;
 import org.truffleruby.language.control.KillException;
+import org.truffleruby.language.control.DynamicReturnException;
 import org.truffleruby.language.control.RaiseException;
-import org.truffleruby.language.control.ReturnException;
 import org.truffleruby.language.objects.AllocateObjectNode;
 import org.truffleruby.language.objects.ObjectIDOperations;
 import org.truffleruby.language.objects.ReadObjectFieldNodeGen;
@@ -286,7 +286,7 @@ private void threadMain(DynamicObject thread, Node currentNode, Supplier<Object>
             setThreadValue(context, thread, nil());
         } catch (RaiseException e) {
             setException(context, thread, e.getException(), currentNode);
-        } catch (ReturnException e) {
+        } catch (DynamicReturnException e) {
             setException(context, thread, context.getCoreExceptions().unexpectedReturn(currentNode), currentNode);
         } finally {
             assert Layouts.THREAD.getValue(thread) != null || Layouts.THREAD.getException(thread) != null;
diff --git a/src/main/java/org/truffleruby/language/control/DynamicReturnException.java b/src/main/java/org/truffleruby/language/control/DynamicReturnException.java
@@ -11,14 +11,14 @@
 
 import com.oracle.truffle.api.nodes.ControlFlowException;
 
-public final class ReturnException extends ControlFlowException {
+public final class DynamicReturnException extends ControlFlowException {
 
     private static final long serialVersionUID = -45053969587014940L;
 
     private final ReturnID returnID;
     private final Object value;
 
-    public ReturnException(ReturnID returnID, Object value) {
+    public DynamicReturnException(ReturnID returnID, Object value) {
         this.returnID = returnID;
         this.value = value;
     }
diff --git a/src/main/java/org/truffleruby/language/control/DynamicReturnNode.java b/src/main/java/org/truffleruby/language/control/DynamicReturnNode.java
@@ -13,20 +13,20 @@
 
 import com.oracle.truffle.api.frame.VirtualFrame;
 
-public class ReturnNode extends RubyNode {
+public class DynamicReturnNode extends RubyNode {
 
     private final ReturnID returnID;
 
     @Child private RubyNode value;
 
-    public ReturnNode(ReturnID returnID, RubyNode value) {
+    public DynamicReturnNode(ReturnID returnID, RubyNode value) {
         this.returnID = returnID;
         this.value = value;
     }
 
     @Override
     public Object execute(VirtualFrame frame) {
-        throw new ReturnException(returnID, value.execute(frame));
+        throw new DynamicReturnException(returnID, value.execute(frame));
     }
 
 }
diff --git a/src/main/java/org/truffleruby/language/control/LocalReturnException.java b/src/main/java/org/truffleruby/language/control/LocalReturnException.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2013, 2019 Oracle and/or its affiliates. All rights reserved. This
+ * code is released under a tri EPL/GPL/LGPL license. You can use it,
+ * redistribute it and/or modify it under the terms of the:
+ *
+ * Eclipse Public License version 2.0, or
+ * GNU General Public License version 2, or
+ * GNU Lesser General Public License version 2.1.
+ */
+package org.truffleruby.language.control;
+
+import com.oracle.truffle.api.nodes.ControlFlowException;
+
+public final class LocalReturnException extends ControlFlowException {
+
+    private static final long serialVersionUID = -98757896543565476L;
+
+    private final Object value;
+
+    public LocalReturnException(Object value) {
+        this.value = value;
+    }
+
+    public Object getValue() {
+        return value;
+    }
+
+}
diff --git a/src/main/java/org/truffleruby/language/control/LocalReturnNode.java b/src/main/java/org/truffleruby/language/control/LocalReturnNode.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2013, 2019 Oracle and/or its affiliates. All rights reserved. This
+ * code is released under a tri EPL/GPL/LGPL license. You can use it,
+ * redistribute it and/or modify it under the terms of the:
+ *
+ * Eclipse Public License version 2.0, or
+ * GNU General Public License version 2, or
+ * GNU Lesser General Public License version 2.1.
+ */
+package org.truffleruby.language.control;
+
+import com.oracle.truffle.api.frame.VirtualFrame;
+import org.truffleruby.language.RubyNode;
+
+public class LocalReturnNode extends RubyNode {
+
+    @Child private RubyNode value;
+
+    public LocalReturnNode(RubyNode value) {
+        this.value = value;
+    }
+
+    @Override
+    public Object execute(VirtualFrame frame) {
+        throw new LocalReturnException(value.execute(frame));
+    }
+
+}
diff --git a/src/main/java/org/truffleruby/language/methods/CatchForLambdaNode.java b/src/main/java/org/truffleruby/language/methods/CatchForLambdaNode.java
@@ -12,12 +12,13 @@
 import org.truffleruby.language.RubyNode;
 import org.truffleruby.language.control.BreakException;
 import org.truffleruby.language.control.BreakID;
+import org.truffleruby.language.control.LocalReturnException;
 import org.truffleruby.language.control.NextException;
+import org.truffleruby.language.control.DynamicReturnException;
+import org.truffleruby.language.control.ReturnID;
 import org.truffleruby.language.control.RaiseException;
 import org.truffleruby.language.control.RedoException;
 import org.truffleruby.language.control.RetryException;
-import org.truffleruby.language.control.ReturnException;
-import org.truffleruby.language.control.ReturnID;
 
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.profiles.BranchProfile;
@@ -30,6 +31,7 @@ public class CatchForLambdaNode extends RubyNode {
 
     @Child private RubyNode body;
 
+    private final BranchProfile localReturnProfile = BranchProfile.create();
     private final ConditionProfile matchingReturnProfile = ConditionProfile.createBinaryProfile();
     private final ConditionProfile matchingBreakProfile = ConditionProfile.createBinaryProfile();
     private final BranchProfile retryProfile = BranchProfile.create();
@@ -47,7 +49,10 @@ public Object execute(VirtualFrame frame) {
         while (true) {
             try {
                 return body.execute(frame);
-            } catch (ReturnException e) {
+            } catch (LocalReturnException e) {
+                localReturnProfile.enter();
+                return e.getValue();
+            } catch (DynamicReturnException e) {
                 if (matchingReturnProfile.profile(e.getReturnID() == returnID)) {
                     return e.getValue();
                 } else {
diff --git a/src/main/java/org/truffleruby/language/methods/CatchForMethodNode.java b/src/main/java/org/truffleruby/language/methods/CatchForMethodNode.java
@@ -10,10 +10,11 @@
 package org.truffleruby.language.methods;
 
 import org.truffleruby.language.RubyNode;
+import org.truffleruby.language.control.LocalReturnException;
+import org.truffleruby.language.control.DynamicReturnException;
+import org.truffleruby.language.control.ReturnID;
 import org.truffleruby.language.control.RaiseException;
 import org.truffleruby.language.control.RetryException;
-import org.truffleruby.language.control.ReturnException;
-import org.truffleruby.language.control.ReturnID;
 
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.profiles.BranchProfile;
@@ -25,6 +26,7 @@ public class CatchForMethodNode extends RubyNode {
 
     @Child private RubyNode body;
 
+    private final BranchProfile localReturnProfile = BranchProfile.create();
     private final ConditionProfile matchingReturnProfile = ConditionProfile.createBinaryProfile();
     private final BranchProfile retryProfile = BranchProfile.create();
 
@@ -37,7 +39,10 @@ public CatchForMethodNode(ReturnID returnID, RubyNode body) {
     public Object execute(VirtualFrame frame) {
         try {
             return body.execute(frame);
-        } catch (ReturnException e) {
+        } catch (LocalReturnException e) {
+            localReturnProfile.enter();
+            return e.getValue();
+        } catch (DynamicReturnException e) {
             if (matchingReturnProfile.profile(e.getReturnID() == returnID)) {
                 return e.getValue();
             } else {
diff --git a/src/main/java/org/truffleruby/language/methods/CatchReturnAsErrorNode.java b/src/main/java/org/truffleruby/language/methods/CatchReturnAsErrorNode.java
@@ -10,8 +10,9 @@
 package org.truffleruby.language.methods;
 
 import org.truffleruby.language.RubyNode;
+import org.truffleruby.language.control.LocalReturnException;
 import org.truffleruby.language.control.RaiseException;
-import org.truffleruby.language.control.ReturnException;
+import org.truffleruby.language.control.DynamicReturnException;
 
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.profiles.BranchProfile;
@@ -30,7 +31,7 @@ public CatchReturnAsErrorNode(RubyNode body) {
     public Object execute(VirtualFrame frame) {
         try {
             return body.execute(frame);
-        } catch (ReturnException e) {
+        } catch (LocalReturnException | DynamicReturnException e) {
             retryProfile.enter();
             throw new RaiseException(getContext(), coreExceptions().unexpectedReturn(this));
         }
diff --git a/src/main/java/org/truffleruby/parser/BodyTranslator.java b/src/main/java/org/truffleruby/parser/BodyTranslator.java
@@ -78,15 +78,16 @@
 import org.truffleruby.language.control.FrameOnStackNode;
 import org.truffleruby.language.control.IfElseNode;
 import org.truffleruby.language.control.IfNode;
+import org.truffleruby.language.control.LocalReturnNode;
 import org.truffleruby.language.control.NextNode;
+import org.truffleruby.language.control.ReturnID;
+import org.truffleruby.language.control.DynamicReturnNode;
 import org.truffleruby.language.control.NotNode;
 import org.truffleruby.language.control.OnceNode;
 import org.truffleruby.language.control.OrNode;
 import org.truffleruby.language.control.RaiseException;
 import org.truffleruby.language.control.RedoNode;
 import org.truffleruby.language.control.RetryNode;
-import org.truffleruby.language.control.ReturnID;
-import org.truffleruby.language.control.ReturnNode;
 import org.truffleruby.language.control.UnlessNode;
 import org.truffleruby.language.control.WhileNode;
 import org.truffleruby.language.defined.DefinedNode;
@@ -2960,7 +2961,14 @@ public RubyNode visitReturnNode(ReturnParseNode node) {
 
         RubyNode translatedChild = translateNodeOrNil(sourceSection, node.getValueNode());
 
-        final RubyNode ret = new ReturnNode(environment.getReturnID(), translatedChild);
+        final RubyNode ret;
+
+        if (environment.isBlock()) {
+            ret = new DynamicReturnNode(environment.getReturnID(), translatedChild);
+        } else {
+            ret = new LocalReturnNode(translatedChild);
+        }
+
         ret.unsafeSetSourceSection(sourceSection);
         return addNewlineIfNeeded(node, ret);
     }

Original file line number	Diff line number	Diff line change
`@@ -234,6 +234,8 @@ private int runRubyMain(Context.Builder contextBuilder, CommandLineOptions confi`
`234`	`234`	`Metrics.printTime("after-run");`
`235`	`235`	`return exitCode;`
`236`	`236`	`} catch (PolyglotException e) {`
	`237`	`+ System.err.println(`
	`238`	`+ "truffleruby: an exception escaped out of the interpreter - this is an implementation bug");`
`237`	`239`	`e.printStackTrace();`
`238`	`240`	`return 1;`
`239`	`241`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,20 +13,20 @@`
`13`	`13`
`14`	`14`	`import com.oracle.truffle.api.frame.VirtualFrame;`
`15`	`15`
`16`		`-public class ReturnNode extends RubyNode {`
	`16`	`+public class DynamicReturnNode extends RubyNode {`
`17`	`17`
`18`	`18`	`private final ReturnID returnID;`
`19`	`19`
`20`	`20`	`@Child private RubyNode value;`
`21`	`21`
`22`		`- public ReturnNode(ReturnID returnID, RubyNode value) {`
	`22`	`+ public DynamicReturnNode(ReturnID returnID, RubyNode value) {`
`23`	`23`	`this.returnID = returnID;`
`24`	`24`	`this.value = value;`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`@Override`
`28`	`28`	`public Object execute(VirtualFrame frame) {`
`29`		`- throw new ReturnException(returnID, value.execute(frame));`
	`29`	`+ throw new DynamicReturnException(returnID, value.execute(frame));`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`}`