Small code tidy up and refactor to avoid code duplication.

aardvark179 · aardvark179 · commit 66c2be3586f6 · 2021-08-18T17:32:13.000+01:00
diff --git a/lib/truffle/truffle/cext_ruby.rb b/lib/truffle/truffle/cext_ruby.rb
@@ -38,7 +38,7 @@ def rb_define_method(mod, name, function, argc)
       # We must set block argument if given here so that the
       # `rb_block_*` functions will be able to find it by walking the
       # stack.
-      res = Primitive.cext_unwrap(Primitive.call_with_c_mutex_and_frame(function, args, Primitive.caller_special_variables_if_fast, block))
+      res = Primitive.cext_unwrap(Primitive.call_with_c_mutex_and_frame(function, args, Primitive.caller_special_variables_if_available, block))
       Primitive.thread_set_exception(exc)
       res
     end
diff --git a/src/main/java/org/truffleruby/core/kernel/TruffleKernelNodes.java b/src/main/java/org/truffleruby/core/kernel/TruffleKernelNodes.java
@@ -37,7 +37,7 @@
 import org.truffleruby.language.ReadOwnFrameAndVariablesNode;
 import org.truffleruby.language.RubyBaseNode;
 import org.truffleruby.language.RubyNode;
-import org.truffleruby.language.arguments.MaybeReadCallerVariablesNode;
+import org.truffleruby.language.arguments.ReadCallerVariablesIfAvailableNode;
 import org.truffleruby.language.arguments.ReadCallerVariablesNode;
 import org.truffleruby.language.arguments.RubyArguments;
 import org.truffleruby.language.control.RaiseException;
@@ -342,10 +342,10 @@ protected Object storage(VirtualFrame frame) {
         }
     }
 
-    @Primitive(name = "caller_special_variables_if_fast")
+    @Primitive(name = "caller_special_variables_if_available")
     public abstract static class GetCallerSpecialVariableStorageIfFast extends PrimitiveArrayArgumentsNode {
 
-        @Child MaybeReadCallerVariablesNode callerVariablesNode = new MaybeReadCallerVariablesNode();
+        @Child ReadCallerVariablesIfAvailableNode callerVariablesNode = new ReadCallerVariablesIfAvailableNode();
 
         @Specialization
         protected Object storage(VirtualFrame frame,
diff --git a/src/main/java/org/truffleruby/core/thread/TruffleThreadNodes.java b/src/main/java/org/truffleruby/core/thread/TruffleThreadNodes.java
@@ -17,6 +17,8 @@
 import org.truffleruby.core.array.library.ArrayStoreLibrary;
 import org.truffleruby.core.kernel.TruffleKernelNodes.GetSpecialVariableStorage;
 import org.truffleruby.core.MarkingServiceNodes;
+import org.truffleruby.language.arguments.CallerDataReadingNode;
+import org.truffleruby.language.arguments.ReadCallerDataNode;
 import org.truffleruby.language.FrameAndVariablesSendingNode;
 import org.truffleruby.language.RubyNode;
 
@@ -47,7 +49,7 @@ public FrameAndCallNode(Frame frame, Node callNode) {
 
     @CoreMethod(names = "ruby_caller_special_variables", onSingleton = true, required = 1)
     @ImportStatic(ArrayGuards.class)
-    public abstract static class FindRubyCallerSpecialStorage extends CoreMethodArrayArgumentsNode {
+    public abstract static class FindRubyCallerSpecialStorage extends CoreMethodArrayArgumentsNode implements CallerDataReadingNode {
 
         @TruffleBoundary
         @Specialization(limit = "storageStrategyLimit()")
@@ -65,30 +67,15 @@ protected Object findRubyCaller(RubyArray modules,
             if (data == null) {
                 return nil;
             } else {
-                notifyToStartSendingStorage(data.callNode);
+                CallerDataReadingNode.notifyCallerToSendData(getContext(), data.callNode, this);
                 Object variables = storageNode.execute(data.frame.materialize());
                 getDataNode.execute().getExtensionCallStack().setVariables(variables);
                 return variables;
             }
         }
 
-        private static boolean notifyToStartSendingStorage(Node callerNode) {
-            if (callerNode instanceof DirectCallNode || callerNode instanceof IndirectCallNode) {
-                Node parent = callerNode.getParent();
-                while (parent != null) {
-                    if (parent instanceof FrameAndVariablesSendingNode) {
-                        ((FrameAndVariablesSendingNode) parent).startSendingOwnVariables();
-                        return true;
-                    }
-                    if (parent instanceof RubyNode) {
-                        // A node with source info representing Ruby code, we could not find the FrameAndVariablesSendingNode
-                        return false;
-                    }
-                    parent = parent.getParent();
-                }
-            }
-
-            return false;
+        public void startSending(FrameAndVariablesSendingNode node) {
+            node.startSendingOwnVariables();
         }
     }
 }
diff --git a/src/main/java/org/truffleruby/language/CallStackManager.java b/src/main/java/org/truffleruby/language/CallStackManager.java
@@ -74,22 +74,6 @@ public Frame getNonJavaCoreCallerFrame(FrameAccess frameAccess) {
         }, frameAccess);
     }
 
-    @TruffleBoundary
-    public Frame getCallerFrameNotInModules(FrameAccess frameAccess, Object[] modules) {
-        final Memo<Boolean> skippedFirstFrameFound = new Memo<>(false);
-
-        return getCallerFrame(frameInstance -> {
-            final InternalMethod method = tryGetMethod(frameInstance.getFrame(FrameAccess.READ_ONLY));
-            if (method != null && !ArrayUtils.contains(modules, method.getDeclaringModule())) {
-                if (skippedFirstFrameFound.get()) {
-                    return true;
-                }
-                skippedFirstFrameFound.set(true);
-            }
-            return false;
-        }, frameAccess);
-    }
-
     @TruffleBoundary
     public <R> R iterateFrameNotInModules(Object[] modules, Function<FrameInstance, R> action) {
         final Memo<Boolean> skippedFirstFrameFound = new Memo<>(false);
diff --git a/src/main/java/org/truffleruby/language/arguments/ReadCallerDataNode.java b/src/main/java/org/truffleruby/language/arguments/ReadCallerDataNode.java
@@ -20,14 +20,15 @@
 import com.oracle.truffle.api.nodes.Node;
 import com.oracle.truffle.api.profiles.ConditionProfile;
 
+import org.truffleruby.RubyContext;
 import org.truffleruby.language.CallStackManager;
 import org.truffleruby.language.FrameAndVariablesSendingNode;
 import org.truffleruby.language.NotOptimizedWarningNode;
 import org.truffleruby.language.RubyBaseNode;
 import org.truffleruby.language.RubyNode;
 import org.truffleruby.language.control.RaiseException;
 
-public abstract class ReadCallerDataNode extends RubyBaseNode {
+public abstract class ReadCallerDataNode extends RubyBaseNode implements CallerDataReadingNode {
 
     private final ConditionProfile callerDataProfile = ConditionProfile.create();
     @Child private NotOptimizedWarningNode notOptimizedNode = null;
@@ -46,7 +47,8 @@ public Object execute(Frame frame) {
 
     @TruffleBoundary
     protected Object getCallerData() {
-        if (!notifyCallerToSendData()) {
+        final Node callerNode = getContext().getCallStack().getCallerNode(1, false);
+        if (!CallerDataReadingNode.notifyCallerToSendData(getContext(), callerNode, this)) {
             // If we fail to notify the call node (e.g., because it is a UncachedDispatchNode which is not handled yet),
             // we don't want to deoptimize this CallTarget on every call.
             getNotOptimizedNode().warn("Unoptimized reading of caller data.");
@@ -70,27 +72,7 @@ protected Object getCallerData() {
 
     protected abstract Object getDataFromFrame(MaterializedFrame frame);
 
-    private boolean notifyCallerToSendData() {
-        final Node callerNode = getContext().getCallStack().getCallerNode(1, false);
-        if (callerNode instanceof DirectCallNode || callerNode instanceof IndirectCallNode) {
-            Node parent = callerNode.getParent();
-            while (parent != null) {
-                if (parent instanceof FrameAndVariablesSendingNode) {
-                    startSending((FrameAndVariablesSendingNode) parent);
-                    return true;
-                }
-                if (parent instanceof RubyNode) {
-                    // A node with source info representing Ruby code, we could not find the FrameAndVariablesSendingNode
-                    return false;
-                }
-                parent = parent.getParent();
-            }
-        }
-
-        return false;
-    }
-
-    protected abstract void startSending(FrameAndVariablesSendingNode node);
+    public abstract void startSending(FrameAndVariablesSendingNode node);
 
     private NotOptimizedWarningNode getNotOptimizedNode() {
         if (notOptimizedNode == null) {
diff --git a/src/main/java/org/truffleruby/language/arguments/ReadCallerFrameNode.java b/src/main/java/org/truffleruby/language/arguments/ReadCallerFrameNode.java
@@ -31,7 +31,7 @@ protected MaterializedFrame getData(Frame frame) {
     }
 
     @Override
-    protected void startSending(FrameAndVariablesSendingNode node) {
+    public void startSending(FrameAndVariablesSendingNode node) {
         node.startSendingOwnFrame();
     }
 
diff --git a/src/main/java/org/truffleruby/language/arguments/ReadCallerVariablesIfAvailableNode.java b/src/main/java/org/truffleruby/language/arguments/ReadCallerVariablesIfAvailableNode.java
@@ -9,10 +9,10 @@
  */
 package org.truffleruby.language.arguments;
 
-public class MaybeReadCallerVariablesNode extends ReadCallerVariablesNode {
+public class ReadCallerVariablesIfAvailableNode extends ReadCallerVariablesNode {
 
-    public static MaybeReadCallerVariablesNode create() {
-        return new MaybeReadCallerVariablesNode();
+    public static ReadCallerVariablesIfAvailableNode create() {
+        return new ReadCallerVariablesIfAvailableNode();
     }
 
     @Override
diff --git a/src/main/java/org/truffleruby/language/arguments/ReadCallerVariablesNode.java b/src/main/java/org/truffleruby/language/arguments/ReadCallerVariablesNode.java
@@ -33,7 +33,7 @@ protected SpecialVariableStorage getData(Frame frame) {
     }
 
     @Override
-    protected void startSending(FrameAndVariablesSendingNode node) {
+    public void startSending(FrameAndVariablesSendingNode node) {
         node.startSendingOwnVariables();
     }
 

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ protected MaterializedFrame getData(Frame frame) {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`@Override`
`34`		`- protected void startSending(FrameAndVariablesSendingNode node) {`
	`34`	`+ public void startSending(FrameAndVariablesSendingNode node) {`
`35`	`35`	`node.startSendingOwnFrame();`
`36`	`36`	`}`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ protected SpecialVariableStorage getData(Frame frame) {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`@Override`
`36`		`- protected void startSending(FrameAndVariablesSendingNode node) {`
	`36`	`+ public void startSending(FrameAndVariablesSendingNode node) {`
`37`	`37`	`node.startSendingOwnVariables();`
`38`	`38`	`}`
`39`	`39`