Refactor LocalVariableGetNode node to support DSL inlining

Author: horakivo

src/main/java/org/truffleruby/core/binding/BindingNodes.java

@@ -41,7 +41,6 @@
 import org.truffleruby.language.arguments.RubyArguments;
 import org.truffleruby.language.control.RaiseException;
 import org.truffleruby.language.locals.FindDeclarationVariableNodes;
-import org.truffleruby.language.locals.FindDeclarationVariableNodes.FindAndReadDeclarationVariableNode;
 import org.truffleruby.language.locals.FindDeclarationVariableNodes.FrameSlotAndDepth;
 import org.truffleruby.language.locals.FrameDescriptorNamesIterator;
 import org.truffleruby.language.locals.WriteFrameSlotNode;
@@ -278,24 +277,12 @@ public RubyNode cloneUninitialized() {
 
     }
 
-    @GenerateUncached
     @GenerateNodeFactory
     @CoreMethod(names = "local_variable_get", required = 1)
     @NodeChild(value = "bindingNode", type = RubyNode.class)
     @NodeChild(value = "nameNode", type = RubyBaseNodeWithExecute.class)
     @ImportStatic(BindingNodes.class)
-    public abstract static class LocalVariableGetNode extends RubySourceNode {
-
-        @NeverDefault
-        public static LocalVariableGetNode create() {
-            return BindingNodesFactory.LocalVariableGetNodeFactory.create(null, null);
-        }
-
-        public static LocalVariableGetNode create(RubyNode bindingNode, RubyBaseNodeWithExecute nameNode) {
-            return BindingNodesFactory.LocalVariableGetNodeFactory.create(bindingNode, nameNode);
-        }
-
-        public abstract Object execute(RubyBinding binding, String name);
+    public abstract static class BindingLocalVariableGetNode extends RubySourceNode {
 
         abstract RubyNode getBindingNode();
 
@@ -306,29 +293,10 @@ protected RubyBaseNodeWithExecute coerceToString(RubyBaseNodeWithExecute name) {
             return NameToJavaStringNode.create(name);
         }
 
-        @Specialization(guards = "!isHiddenVariable(name)")
+        @Specialization
         protected Object localVariableGet(RubyBinding binding, String name,
-                @Cached FindAndReadDeclarationVariableNode readNode) {
-            MaterializedFrame frame = binding.getFrame();
-            Object result = readNode.execute(frame, name, null);
-            if (result == null) {
-                throw new RaiseException(
-                        getContext(),
-                        coreExceptions().nameErrorLocalVariableNotDefined(name, binding, this));
-            }
-            return result;
-        }
-
-        @TruffleBoundary
-        @Specialization(guards = "isHiddenVariable(name)")
-        protected Object localVariableGetLastLine(RubyBinding binding, String name) {
-            throw new RaiseException(
-                    getContext(),
-                    coreExceptions().nameError("Bad local variable name", binding, name, this));
-        }
-
-        protected int getCacheLimit() {
-            return getLanguage().options.BINDING_LOCAL_VARIABLE_CACHE;
+                @Cached LocalVariableGetNode localVariableGetNode) {
+            return localVariableGetNode.execute(binding, name);
         }
 
         private RubyBaseNodeWithExecute getNameNodeBeforeCasting() {
@@ -337,11 +305,10 @@ private RubyBaseNodeWithExecute getNameNodeBeforeCasting() {
 
         @Override
         public RubyNode cloneUninitialized() {
-            return create(
+            return BindingNodesFactory.BindingLocalVariableGetNodeFactory.create(
                     getBindingNode().cloneUninitialized(),
                     getNameNodeBeforeCasting().cloneUninitialized()).copyFlags(this);
         }
-
     }
 
     @ReportPolymorphism

src/main/java/org/truffleruby/core/binding/LocalVariableGetNode.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2013, 2023 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.core.binding;
+
+import com.oracle.truffle.api.dsl.Cached;
+import com.oracle.truffle.api.dsl.GenerateUncached;
+import com.oracle.truffle.api.dsl.ImportStatic;
+import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
+import com.oracle.truffle.api.dsl.Specialization;
+import com.oracle.truffle.api.frame.MaterializedFrame;
+import org.truffleruby.language.RubyBaseNode;
+import org.truffleruby.language.control.RaiseException;
+import org.truffleruby.language.locals.FindDeclarationVariableNodes;
+
+@GenerateUncached
+@ImportStatic(BindingNodes.class)
+public abstract class LocalVariableGetNode extends RubyBaseNode {
+
+    public abstract Object execute(RubyBinding binding, String name);
+
+    @Specialization(guards = "!isHiddenVariable(name)")
+    protected Object localVariableGet(RubyBinding binding, String name,
+            @Cached FindDeclarationVariableNodes.FindAndReadDeclarationVariableNode readNode) {
+        MaterializedFrame frame = binding.getFrame();
+        Object result = readNode.execute(frame, name, null);
+        if (result == null) {
+            throw new RaiseException(
+                    getContext(),
+                    coreExceptions().nameErrorLocalVariableNotDefined(name, binding, this));
+        }
+        return result;
+    }
+
+    @TruffleBoundary
+    @Specialization(guards = "isHiddenVariable(name)")
+    protected Object localVariableGetLastLine(RubyBinding binding, String name) {
+        throw new RaiseException(
+                getContext(),
+                coreExceptions().nameError("Bad local variable name", binding, name, this));
+    }
+}

src/main/java/org/truffleruby/debug/BindingLocalVariablesObject.java

@@ -12,6 +12,7 @@
 import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
 import com.oracle.truffle.api.library.CachedLibrary;
 import org.truffleruby.core.binding.BindingNodes;
+import org.truffleruby.core.binding.LocalVariableGetNode;
 import org.truffleruby.core.binding.RubyBinding;
 import org.truffleruby.core.string.StringUtils;
 import org.truffleruby.language.control.RaiseException;
@@ -55,7 +56,7 @@ protected Object getMembers(boolean includeInternal) {
 
     @ExportMessage
     protected Object readMember(String member,
-            @Cached @Exclusive BindingNodes.LocalVariableGetNode localVariableGetNode)
+            @Cached @Exclusive LocalVariableGetNode localVariableGetNode)
             throws UnknownIdentifierException {
         try {
             return localVariableGetNode.execute(binding, member);

src/main/java/org/truffleruby/debug/RubyScope.java

@@ -27,6 +27,7 @@
 import org.truffleruby.RubyContext;
 import org.truffleruby.RubyLanguage;
 import org.truffleruby.core.binding.BindingNodes;
+import org.truffleruby.core.binding.LocalVariableGetNode;
 import org.truffleruby.core.binding.RubyBinding;
 import org.truffleruby.core.string.StringUtils;
 import org.truffleruby.language.RubyNode;
@@ -125,7 +126,7 @@ protected static Object readSelf(RubyScope scope, String member) {
 
         @Specialization(guards = "!RECEIVER_MEMBER.equals(member)")
         protected static Object read(RubyScope scope, String member,
-                @Cached @Exclusive BindingNodes.LocalVariableGetNode localVariableGetNode)
+                @Cached @Exclusive LocalVariableGetNode localVariableGetNode)
                 throws UnknownIdentifierException {
             try {
                 return localVariableGetNode.execute(scope.binding, member);