EnsureNode is converted to DSL node

Author: horakivo

src/main/java/org/truffleruby/core/exception/ExceptionOperations.java

@@ -12,6 +12,7 @@
 import com.oracle.truffle.api.CompilerDirectives;
 import com.oracle.truffle.api.exception.AbstractTruffleException;
 import com.oracle.truffle.api.profiles.ConditionProfile;
+import com.oracle.truffle.api.profiles.InlinedConditionProfile;
 import org.truffleruby.RubyContext;
 import org.truffleruby.RubyLanguage;
 import org.truffleruby.core.kernel.KernelNodes;
@@ -85,6 +86,7 @@ public static Object getExceptionObject(AbstractTruffleException exception) {
         }
     }
 
+    // TODO remove when TryNode is refactored
     public static Object getExceptionObject(AbstractTruffleException exception,
             ConditionProfile raiseExceptionProfile) {
         assert !(exception instanceof KillException)
@@ -96,6 +98,17 @@ public static Object getExceptionObject(AbstractTruffleException exception,
         }
     }
 
+    public static Object getExceptionObject(Node node, AbstractTruffleException exception,
+            InlinedConditionProfile raiseExceptionProfile) {
+        assert !(exception instanceof KillException)
+                : "KillException should not be used as an exception object: " + exception;
+        if (raiseExceptionProfile.profile(node, exception instanceof RaiseException)) {
+            return ((RaiseException) exception).getException();
+        } else {
+            return exception;
+        }
+    }
+
     @TruffleBoundary
     public static String getMessage(Throwable throwable) {
         return throwable.getMessage();

src/main/java/org/truffleruby/language/exceptions/EnsureNode.java

@@ -9,47 +9,53 @@
  */
 package org.truffleruby.language.exceptions;
 
+import com.oracle.truffle.api.dsl.Cached;
+import com.oracle.truffle.api.dsl.Specialization;
 import com.oracle.truffle.api.exception.AbstractTruffleException;
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.nodes.ControlFlowException;
-import com.oracle.truffle.api.profiles.ConditionProfile;
+import com.oracle.truffle.api.profiles.InlinedBranchProfile;
+import com.oracle.truffle.api.profiles.InlinedConditionProfile;
 import org.truffleruby.core.exception.ExceptionOperations;
 import org.truffleruby.language.RubyContextSourceNode;
 import org.truffleruby.language.RubyNode;
 
 import com.oracle.truffle.api.frame.VirtualFrame;
-import com.oracle.truffle.api.profiles.BranchProfile;
 import org.truffleruby.language.control.KillException;
 import org.truffleruby.language.threadlocal.ThreadLocalGlobals;
 
-public class EnsureNode extends RubyContextSourceNode {
+public abstract class EnsureNode extends RubyContextSourceNode {
 
     @Child private RubyNode tryPart;
     @Child private RubyNode ensurePart;
 
-    private final BranchProfile killExceptionProfile = BranchProfile.create();
-    private final BranchProfile guestExceptionProfile = BranchProfile.create();
-    private final BranchProfile controlFlowExceptionProfile = BranchProfile.create();
-    private final ConditionProfile raiseExceptionProfile = ConditionProfile.create();
-
     public EnsureNode(RubyNode tryPart, RubyNode ensurePart) {
         this.tryPart = tryPart;
         this.ensurePart = ensurePart;
     }
 
+
     @Override
-    public Object execute(VirtualFrame frame) {
+    public final Object execute(VirtualFrame frame) {
         return executeCommon(frame, false);
     }
 
     @Override
-    public void doExecuteVoid(VirtualFrame frame) {
+    public final void doExecuteVoid(VirtualFrame frame) {
         executeCommon(frame, true);
     }
 
+    protected abstract Object executeCommon(VirtualFrame frame, boolean executeVoid);
+
+
     /** Based on {@link InteropLibrary#throwException(Object)}'s {@code TryCatchNode}. It only runs code in ensure for
      * guest exceptions (AbstractTruffleException), ControlFlowException or no exception. */
-    public Object executeCommon(VirtualFrame frame, boolean executeVoid) {
+    @Specialization
+    protected Object ensure(VirtualFrame frame, boolean executeVoid,
+            @Cached InlinedBranchProfile killExceptionProfile,
+            @Cached InlinedBranchProfile guestExceptionProfile,
+            @Cached InlinedBranchProfile controlFlowExceptionProfile,
+            @Cached InlinedConditionProfile raiseExceptionProfile) {
         Object value = nil;
         RuntimeException rethrowException = null;
         AbstractTruffleException guestException = null;
@@ -61,22 +67,22 @@ public Object executeCommon(VirtualFrame frame, boolean executeVoid) {
                 value = tryPart.execute(frame);
             }
         } catch (KillException e) { // an AbstractTruffleException but must not set $!
-            killExceptionProfile.enter();
+            killExceptionProfile.enter(this);
             rethrowException = e;
         } catch (AbstractTruffleException e) {
-            guestExceptionProfile.enter();
+            guestExceptionProfile.enter(this);
             guestException = e;
             rethrowException = e;
         } catch (ControlFlowException e) {
-            controlFlowExceptionProfile.enter();
+            controlFlowExceptionProfile.enter(this);
             rethrowException = e;
         }
 
         ThreadLocalGlobals threadLocalGlobals = null;
         Object previousException = null;
 
         if (guestException != null) {
-            var exceptionObject = ExceptionOperations.getExceptionObject(guestException, raiseExceptionProfile);
+            var exceptionObject = ExceptionOperations.getExceptionObject(this, guestException, raiseExceptionProfile);
             threadLocalGlobals = getLanguage().getCurrentThread().threadLocalGlobals;
             previousException = threadLocalGlobals.getLastException();
             threadLocalGlobals.setLastException(exceptionObject);
@@ -96,9 +102,10 @@ public Object executeCommon(VirtualFrame frame, boolean executeVoid) {
         }
     }
 
+
     @Override
     public RubyNode cloneUninitialized() {
-        var copy = new EnsureNode(
+        var copy = EnsureNodeGen.create(
                 tryPart.cloneUninitialized(),
                 ensurePart.cloneUninitialized());
         return copy.copyFlags(this);

src/main/java/org/truffleruby/parser/BodyTranslator.java

@@ -94,7 +94,7 @@
 import org.truffleruby.language.defined.DefinedNode;
 import org.truffleruby.language.defined.DefinedWrapperNode;
 import org.truffleruby.language.dispatch.RubyCallNodeParameters;
-import org.truffleruby.language.exceptions.EnsureNode;
+import org.truffleruby.language.exceptions.EnsureNodeGen;
 import org.truffleruby.language.exceptions.RescueStandardErrorNode;
 import org.truffleruby.language.exceptions.RescueClassesNode;
 import org.truffleruby.language.exceptions.RescueNode;
@@ -1435,7 +1435,7 @@ public RubyNode visitEncodingNode(EncodingParseNode node) {
     public RubyNode visitEnsureNode(EnsureParseNode node) {
         final RubyNode tryPart = node.getBodyNode().accept(this);
         final RubyNode ensurePart = node.getEnsureNode().accept(this);
-        final RubyNode ret = new EnsureNode(tryPart, ensurePart);
+        final RubyNode ret = EnsureNodeGen.create(tryPart, ensurePart);
         ret.unsafeSetSourceSection(node.getPosition());
         return addNewlineIfNeeded(node, ret);
     }