TranslatorEnvironment#newFrameDescriptorBuilder separated into two functions

Author: horakivo

src/main/java/org/truffleruby/RubyLanguage.java

@@ -189,8 +189,8 @@ public final class RubyLanguage extends TruffleLanguage<RubyContext> {
     public static final TruffleLogger LOGGER = TruffleLogger.getLogger(TruffleRuby.LANGUAGE_ID);
 
     /** This is a truly empty frame descriptor and should only by dummy root nodes which require no variables. Any other
-     * root nodes should should use
-     * {@link TranslatorEnvironment#newFrameDescriptorBuilder(BlockFrameDescriptorInfo, boolean)}. */
+     * root nodes should should use either {@link TranslatorEnvironment#newFrameDescriptorBuilderForMethod()} or
+     * {@link TranslatorEnvironment#newFrameDescriptorBuilderForBlock(BlockFrameDescriptorInfo)}. */
     public static final FrameDescriptor EMPTY_FRAME_DESCRIPTOR = new FrameDescriptor(nil);
 
     private RubyThread getOrCreateForeignThread(RubyContext context, Thread thread) {
@@ -336,7 +336,7 @@ private RubyThread getOrCreateForeignThread(RubyContext context, Thread thread)
      * special variable storage. This frame descriptor should be used for those frames to provide a constant frame
      * descriptor in those cases. */
     public final FrameDescriptor emptyDeclarationDescriptor = TranslatorEnvironment
-            .newFrameDescriptorBuilder(null, true).build();
+            .newFrameDescriptorBuilderForMethod().build();
 
     public MaterializedFrame createEmptyDeclarationFrame(Object[] packedArgs, SpecialVariableStorage variables) {
         // createVirtualFrame().materialize() compiles better if this is in PE code

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

@@ -81,7 +81,7 @@ public static RubyBinding createBinding(RubyContext context, RubyLanguage langua
     public static FrameDescriptor newFrameDescriptor(RubyBinding binding) {
         FrameDescriptor parentDescriptor = binding.getFrame().getFrameDescriptor();
         var ref = new BlockFrameDescriptorInfo(parentDescriptor);
-        return TranslatorEnvironment.newFrameDescriptorBuilder(ref, false).build();
+        return TranslatorEnvironment.newFrameDescriptorBuilderForBlock(ref).build();
     }
 
     static final int NEW_VAR_INDEX = 1;
@@ -91,7 +91,7 @@ public static FrameDescriptor newFrameDescriptor(FrameDescriptor parentDescripto
         assert name != null && !name.isEmpty();
 
         var ref = new BlockFrameDescriptorInfo(parentDescriptor);
-        var builder = TranslatorEnvironment.newFrameDescriptorBuilder(ref, false);
+        var builder = TranslatorEnvironment.newFrameDescriptorBuilderForBlock(ref);
         int index = builder.addSlot(FrameSlotKind.Illegal, name, null);
         if (index != NEW_VAR_INDEX) {
             throw CompilerDirectives.shouldNotReachHere("new binding variable not at index 1");

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

@@ -67,9 +67,8 @@ public static Object eval(RubyContext context, String code, Object... arguments)
                 RubyNode.EMPTY_ARGUMENTS);
 
 
-        var builder = TranslatorEnvironment.newFrameDescriptorBuilder(
-                new BlockFrameDescriptorInfo(currentFrameDescriptor),
-                false);
+        var builder = TranslatorEnvironment
+                .newFrameDescriptorBuilderForBlock(new BlockFrameDescriptorInfo(currentFrameDescriptor));
 
         for (int i = 0; i < nArgs; i++) {
             final Object identifier = arguments[i * 2];

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

@@ -81,10 +81,13 @@ public TranslatorEnvironment(
         this.parent = parent;
 
         if (descriptor == null) {
-            BlockFrameDescriptorInfo parentDescriptor = blockDepth > 0
-                    ? Objects.requireNonNull(parent.blockFrameDescriptorInfo)
-                    : null;
-            this.frameDescriptorBuilder = newFrameDescriptorBuilder(parentDescriptor, blockDepth == 0);
+            if (blockDepth > 0) {
+                BlockFrameDescriptorInfo parentBlockDescriptor = Objects
+                        .requireNonNull(parent.blockFrameDescriptorInfo);
+                this.frameDescriptorBuilder = newFrameDescriptorBuilderForBlock(parentBlockDescriptor);
+            } else {
+                this.frameDescriptorBuilder = newFrameDescriptorBuilderForMethod();
+            }
             this.blockFrameDescriptorInfo = new BlockFrameDescriptorInfo();
         } else {
             this.frameDescriptor = descriptor;
@@ -143,36 +146,42 @@ public boolean isTopLevelObjectScope() {
     }
 
     // region frame descriptor
-    public static FrameDescriptor.Builder newFrameDescriptorBuilder(BlockFrameDescriptorInfo parentDescriptor,
-            boolean canHaveSpecialVariables) {
-        if ((parentDescriptor != null) == canHaveSpecialVariables) {
+    public static FrameDescriptor.Builder newFrameDescriptorBuilderForBlock(BlockFrameDescriptorInfo parentBlockInfo) {
+        if (parentBlockInfo == null) {
             throw CompilerDirectives.shouldNotReachHere(
-                    "A descriptor should either be a method and have special variables, or be a block and have no special variables");
+                    "Frame descriptor for block has to have parent");
         }
 
         var builder = FrameDescriptor.newBuilder().defaultValue(Nil.INSTANCE);
+        builder.info(parentBlockInfo);
 
-        if (parentDescriptor != null) {
-            builder.info(parentDescriptor);
-        } else if (canHaveSpecialVariables) {
-            // We need to access this Assumption from the FrameDescriptor,
-            // and there is no way to get a RootNode from a FrameDescriptor, so we store it in the descriptor info.
-            // We do not store it as slot info for footprint, to avoid needing an info array per FrameDescriptor.
-            final Assumption doesNotNeedSpecialVariableStorageAssumption = Assumption
-                    .create(SpecialVariableStorage.ASSUMPTION_NAME);
-            builder.info(doesNotNeedSpecialVariableStorageAssumption);
+        int selfIndex = builder.addSlot(FrameSlotKind.Illegal, SelfNode.SELF_IDENTIFIER, null);
+        if (selfIndex != SelfNode.SELF_INDEX) {
+            throw CompilerDirectives.shouldNotReachHere("(self) should be at index 0");
         }
 
+        return builder;
+    }
+
+    public static FrameDescriptor.Builder newFrameDescriptorBuilderForMethod() {
+
+        var builder = FrameDescriptor.newBuilder().defaultValue(Nil.INSTANCE);
+        // We need to access this Assumption from the FrameDescriptor,
+        // and there is no way to get a RootNode from a FrameDescriptor, so we store it in the descriptor info.
+        // We do not store it as slot info for footprint, to avoid needing an info array per FrameDescriptor.
+        final Assumption doesNotNeedSpecialVariableStorageAssumption = Assumption
+                .create(SpecialVariableStorage.ASSUMPTION_NAME);
+        builder.info(doesNotNeedSpecialVariableStorageAssumption);
+
+
         int selfIndex = builder.addSlot(FrameSlotKind.Illegal, SelfNode.SELF_IDENTIFIER, null);
         if (selfIndex != SelfNode.SELF_INDEX) {
             throw CompilerDirectives.shouldNotReachHere("(self) should be at index 0");
         }
 
-        if (canHaveSpecialVariables) {
-            int svarsSlot = builder.addSlot(FrameSlotKind.Illegal, SpecialVariableStorage.SLOT_NAME, null);
-            if (svarsSlot != SpecialVariableStorage.SLOT_INDEX) {
-                throw CompilerDirectives.shouldNotReachHere("svars should be at index 1");
-            }
+        int svarsSlot = builder.addSlot(FrameSlotKind.Illegal, SpecialVariableStorage.SLOT_NAME, null);
+        if (svarsSlot != SpecialVariableStorage.SLOT_INDEX) {
+            throw CompilerDirectives.shouldNotReachHere("svars should be at index 1");
         }
 
         return builder;

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

@@ -166,7 +166,7 @@ public YARPTranslator(
 
     public RubyRootNode translate(Nodes.Node node) {
         var body = node.accept(this);
-        var frameDescriptor = TranslatorEnvironment.newFrameDescriptorBuilder(null, true).build();
+        var frameDescriptor = TranslatorEnvironment.newFrameDescriptorBuilderForMethod().build();
         var sourceSection = CoreLibrary.JAVA_CORE_SOURCE_SECTION;
         var sharedMethodInfo = new SharedMethodInfo(sourceSection, null, Arity.NO_ARGUMENTS, "<main>", 0, "<main>",
                 null, null);