[GR-45043] Cleanup after migrating to Prism. Part 2

andrykonchin · andrykonchin · commit 6ab9956c686b · 2024-02-13T10:43:43.000Z
PullRequest: truffleruby/4153
diff --git a/doc/user/compatibility.md b/doc/user/compatibility.md
@@ -121,6 +121,10 @@ The JVM enforces a maximum array size of 2<sup>31</sup>-1 (by storing the size i
 That is, Strings must be smaller than 2GB. This is the same restriction as JRuby.
 A possible workaround could be to use natively-allocated strings, but it would be a large effort to support every Ruby String operation on native strings.
 
+### Strings in UTF-16 and UTF-32 encoding
+
+TruffleRuby does not support UTF-16 strings with an odd number of bytes (in native endianness). Similarly, with UTF-32 it needs to be a multiple of 4. This is necessary for optimizations, compression, invariants, etc.
+
 ### Threads detect interrupts at different points
 
 TruffleRuby threads may detect that they have been interrupted at different points in the program compared to where they would on MRI.
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_else_branch.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_else_branch.yaml
@@ -95,8 +95,8 @@ ast: |
                                           attributes:
                                               flags = 0
                                               frameSlot = 2 # %case_0
-                                              sourceCharIndex = 0
-                                              sourceLength = 89
+                                              sourceCharIndex = -1
+                                              sourceLength = 0
                                               type = FRAME_LOCAL
                       elseBody =
                           IfElseNodeGen
@@ -127,8 +127,8 @@ ast: |
                                                       attributes:
                                                           flags = 0
                                                           frameSlot = 2 # %case_0
-                                                          sourceCharIndex = 0
-                                                          sourceLength = 89
+                                                          sourceCharIndex = -1
+                                                          sourceLength = 0
                                                           type = FRAME_LOCAL
                                   elseBody =
                                       StringLiteralNode
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_multiple_values.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_multiple_values.yaml
@@ -95,8 +95,8 @@ ast: |
                                                       attributes:
                                                           flags = 0
                                                           frameSlot = 2 # %case_0
-                                                          sourceCharIndex = 0
-                                                          sourceLength = 39
+                                                          sourceCharIndex = -1
+                                                          sourceLength = 0
                                                           type = FRAME_LOCAL
                                   right =
                                       InlinedCaseEqualNodeGen
@@ -120,8 +120,8 @@ ast: |
                                                       attributes:
                                                           flags = 0
                                                           frameSlot = 2 # %case_0
-                                                          sourceCharIndex = 0
-                                                          sourceLength = 39
+                                                          sourceCharIndex = -1
+                                                          sourceLength = 0
                                                           type = FRAME_LOCAL
                       elseBody =
                           NilLiteralNode
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_single_value.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_single_value.yaml
@@ -94,8 +94,8 @@ ast: |
                                           attributes:
                                               flags = 0
                                               frameSlot = 2 # %case_0
-                                              sourceCharIndex = 0
-                                              sourceLength = 74
+                                              sourceCharIndex = -1
+                                              sourceLength = 0
                                               type = FRAME_LOCAL
                       elseBody =
                           IfElseNodeGen
@@ -126,8 +126,8 @@ ast: |
                                                       attributes:
                                                           flags = 0
                                                           frameSlot = 2 # %case_0
-                                                          sourceCharIndex = 0
-                                                          sourceLength = 74
+                                                          sourceCharIndex = -1
+                                                          sourceLength = 0
                                                           type = FRAME_LOCAL
                                   elseBody =
                                       NilLiteralNode
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator.yaml
@@ -71,8 +71,8 @@ ast: |
                               attributes:
                                   flags = 0
                                   frameSlot = 2 # %case_0
-                                  sourceCharIndex = 0
-                                  sourceLength = 28
+                                  sourceCharIndex = -1
+                                  sourceLength = 0
                                   type = FRAME_LOCAL
                       ]
                       receiver =
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_following_element.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_following_element.yaml
@@ -94,8 +94,8 @@ ast: |
                               attributes:
                                   flags = 0
                                   frameSlot = 2 # %case_0
-                                  sourceCharIndex = 0
-                                  sourceLength = 32
+                                  sourceCharIndex = -1
+                                  sourceLength = 0
                                   type = FRAME_LOCAL
                       ]
                       receiver =
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_following_elements.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_following_elements.yaml
@@ -100,8 +100,8 @@ ast: |
                               attributes:
                                   flags = 0
                                   frameSlot = 2 # %case_0
-                                  sourceCharIndex = 0
-                                  sourceLength = 40
+                                  sourceCharIndex = -1
+                                  sourceLength = 0
                                   type = FRAME_LOCAL
                       ]
                       receiver =
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_preceding_and_following_element.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_preceding_and_following_element.yaml
@@ -109,8 +109,8 @@ ast: |
                               attributes:
                                   flags = 0
                                   frameSlot = 2 # %case_0
-                                  sourceCharIndex = 0
-                                  sourceLength = 40
+                                  sourceCharIndex = -1
+                                  sourceLength = 0
                                   type = FRAME_LOCAL
                       ]
                       receiver =
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_preceding_and_following_elements.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_preceding_and_following_elements.yaml
@@ -123,8 +123,8 @@ ast: |
                               attributes:
                                   flags = 0
                                   frameSlot = 2 # %case_0
-                                  sourceCharIndex = 0
-                                  sourceLength = 54
+                                  sourceCharIndex = -1
+                                  sourceLength = 0
                                   type = FRAME_LOCAL
                       ]
                       receiver =
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_preceding_element.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_preceding_element.yaml
@@ -94,8 +94,8 @@ ast: |
                               attributes:
                                   flags = 0
                                   frameSlot = 2 # %case_0
-                                  sourceCharIndex = 0
-                                  sourceLength = 32
+                                  sourceCharIndex = -1
+                                  sourceLength = 0
                                   type = FRAME_LOCAL
                       ]
                       receiver =
diff --git a/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_preceding_elements.yaml b/spec/truffle/parsing/fixtures/case/with_expression_and_when/with_splat_operator_and_preceding_elements.yaml
@@ -100,8 +100,8 @@ ast: |
                               attributes:
                                   flags = 0
                                   frameSlot = 2 # %case_0
-                                  sourceCharIndex = 0
-                                  sourceLength = 40
+                                  sourceCharIndex = -1
+                                  sourceLength = 0
                                   type = FRAME_LOCAL
                       ]
                       receiver =
diff --git a/spec/truffle/parsing/fixtures/method_calls/primitive.yaml b/spec/truffle/parsing/fixtures/method_calls/primitive.yaml
@@ -59,7 +59,7 @@ ast: |
                                                           sourceLength = 0
                           TypeNodesFactory$IsNilNodeFactory$IsNilNodeGen
                               attributes:
-                                  flags = 0
+                                  flags = 1
                                   sourceCharIndex = 32
                                   sourceLength = 18
                               children:
diff --git a/spec/truffle/parsing/fixtures/operators/match/=~_with_regexp_without_interpolation_with_named_capture_groups_as_receiver.yaml b/spec/truffle/parsing/fixtures/operators/match/=~_with_regexp_without_interpolation_with_named_capture_groups_as_receiver.yaml
@@ -109,7 +109,7 @@ ast: |
                                           attributes:
                                               flags = 0
                                               frameSlot = 3 # %match_data_0
-                                              sourceCharIndex = 0
-                                              sourceLength = 24
+                                              sourceCharIndex = -1
+                                              sourceLength = 0
                                               type = FRAME_LOCAL
           ]
diff --git a/src/main/java/org/truffleruby/builtins/PrimitiveNodeConstructor.java b/src/main/java/org/truffleruby/builtins/PrimitiveNodeConstructor.java
@@ -9,17 +9,14 @@
  */
 package org.truffleruby.builtins;
 
-import org.truffleruby.RubyLanguage;
 import org.truffleruby.annotations.Primitive;
 import org.truffleruby.core.array.ArrayUtils;
 import org.truffleruby.core.numeric.FixnumLowerNodeGen.FixnumLowerASTNodeGen;
 import org.truffleruby.core.support.TypeNodes;
 import org.truffleruby.language.RubyBaseNode;
 import org.truffleruby.language.RubyNode;
-import org.truffleruby.language.SourceIndexLength;
 
 import com.oracle.truffle.api.dsl.NodeFactory;
-import com.oracle.truffle.api.source.Source;
 
 public final class PrimitiveNodeConstructor {
 
@@ -39,13 +36,7 @@ public NodeFactory<? extends RubyBaseNode> getFactory() {
         return factory;
     }
 
-    public RubyNode createInvokePrimitiveNode(Source source, SourceIndexLength sourceSection, RubyNode[] arguments) {
-        if (arguments.length != getPrimitiveArity()) {
-            throw new Error(
-                    "Incorrect number of arguments (expected " + getPrimitiveArity() + ") at " +
-                            RubyLanguage.getCurrentContext().fileLine(sourceSection.toSourceSection(source)));
-        }
-
+    public RubyNode createInvokePrimitiveNode(RubyNode[] arguments) {
         for (int n = 0; n < arguments.length; n++) {
             if (ArrayUtils.contains(annotation.lowerFixnum(), n)) {
                 arguments[n] = FixnumLowerASTNodeGen.create(arguments[n]);
@@ -58,9 +49,7 @@ public RubyNode createInvokePrimitiveNode(Source source, SourceIndexLength sourc
             }
         }
 
-        final RubyNode primitiveNode = (RubyNode) CoreMethodNodeManager.createNodeFromFactory(factory, arguments);
-        primitiveNode.unsafeSetSourceSection(sourceSection);
-        return primitiveNode;
+        return (RubyNode) CoreMethodNodeManager.createNodeFromFactory(factory, arguments);
     }
 
 }
diff --git a/src/main/java/org/truffleruby/language/RubyNode.java b/src/main/java/org/truffleruby/language/RubyNode.java
@@ -57,6 +57,7 @@ public abstract class RubyNode extends RubyBaseNodeWithExecute implements Instru
     private static final byte FLAG_ROOT = 3;          // 1<<3 = 8
 
     protected static final int NO_SOURCE = -1;
+    private static final int UNAVAILABLE_SOURCE_SECTION_LENGTH = -1;
 
     // Used when the return value of a node is ignored syntactically.
     // Returns Nil instead of void to force RubyNodeWrapper to call `delegateNode.executeVoid(frame)`, otherwise
@@ -85,21 +86,13 @@ public boolean hasSource() {
         return isAdoptable() && getSourceCharIndex() != NO_SOURCE;
     }
 
-    public void unsafeSetSourceSection(SourceIndexLength sourceIndexLength) {
-        assert !hasSource();
-
-        if (sourceIndexLength != null) {
-            unsafeSetSourceSection(sourceIndexLength.getCharIndex(), sourceIndexLength.getLength());
-        }
-    }
-
     public void unsafeSetSourceSection(SourceSection sourceSection) {
         assert !hasSource();
 
         if (sourceSection.isAvailable()) {
             unsafeSetSourceSection(sourceSection.getCharIndex(), sourceSection.getCharLength());
         } else {
-            unsafeSetSourceSection(0, SourceIndexLength.UNAVAILABLE);
+            unsafeSetSourceSection(0, UNAVAILABLE_SOURCE_SECTION_LENGTH);
         }
     }
 
@@ -121,14 +114,6 @@ public RubyNode copySourceSection(RubyNode from) {
         return this;
     }
 
-    public SourceIndexLength getSourceIndexLength() {
-        if (!hasSource()) {
-            return null;
-        } else {
-            return new SourceIndexLength(getSourceCharIndex(), getSourceLength());
-        }
-    }
-
     @Override
     @TruffleBoundary
     public SourceSection getSourceSection() {
@@ -141,7 +126,7 @@ public SourceSection getSourceSection() {
             }
 
             int sourceLength = getSourceLength();
-            if (sourceLength == SourceIndexLength.UNAVAILABLE) {
+            if (sourceLength == UNAVAILABLE_SOURCE_SECTION_LENGTH) {
                 return source.createUnavailableSection();
             } else {
                 return source.createSection(getSourceCharIndex(), sourceLength);
@@ -166,23 +151,6 @@ private Source getSource() {
         return sourceSection.getSource();
     }
 
-    public SourceIndexLength getEncapsulatingSourceIndexLength() {
-        Node node = this;
-        while (node != null) {
-            if (node instanceof RubyNode && ((RubyNode) node).hasSource()) {
-                return ((RubyNode) node).getSourceIndexLength();
-            }
-
-            if (node instanceof RootNode) {
-                return SourceIndexLength.fromSourceSection(node.getSourceSection());
-            }
-
-            node = node.getParent();
-        }
-
-        return null;
-    }
-
     @Override
     public String toString() {
         return super.toString() + " at " + RubyLanguage.fileLineRange(getSourceSection());
diff --git a/src/main/java/org/truffleruby/language/SourceIndexLength.java b/src/main/java/org/truffleruby/language/SourceIndexLength.java
diff --git a/src/main/java/org/truffleruby/language/objects/DefineClassNode.java b/src/main/java/org/truffleruby/language/objects/DefineClassNode.java
@@ -22,6 +22,7 @@
 import com.oracle.truffle.api.profiles.BranchProfile;
 import com.oracle.truffle.api.profiles.ConditionProfile;
 
+/** Defines a new class or returns an existing one found by name in a parent lexical scope. */
 public final class DefineClassNode extends RubyContextSourceNode {
 
     private final String name;
diff --git a/src/main/java/org/truffleruby/language/objects/DefineModuleNode.java b/src/main/java/org/truffleruby/language/objects/DefineModuleNode.java
@@ -23,6 +23,7 @@
 import com.oracle.truffle.api.profiles.BranchProfile;
 import com.oracle.truffle.api.profiles.ConditionProfile;
 
+/** Defines a new module or returns an existing one found by name in a parent lexical scope. */
 @NodeChild(value = "lexicalParentModuleNode", type = RubyNode.class)
 public abstract class DefineModuleNode extends RubyContextSourceNode {
 
diff --git a/src/main/java/org/truffleruby/language/objects/RunModuleDefinitionNode.java b/src/main/java/org/truffleruby/language/objects/RunModuleDefinitionNode.java
@@ -21,6 +21,7 @@
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.nodes.IndirectCallNode;
 
+/** Defines a new class or module (or gets an existing one) and executes its body. */
 public final class RunModuleDefinitionNode extends RubyContextSourceNode {
 
     @Child private RubyNode definingModule;
diff --git a/src/main/java/org/truffleruby/language/objects/SingletonClassNode.java b/src/main/java/org/truffleruby/language/objects/SingletonClassNode.java
@@ -27,6 +27,7 @@
 import com.oracle.truffle.api.dsl.NodeChild;
 import com.oracle.truffle.api.dsl.Specialization;
 
+/** Get a Ruby object's singleton class */
 // Specializations are order by their frequency on railsbench using --engine.SpecializationStatistics
 @GenerateUncached
 public abstract class SingletonClassNode extends RubyBaseNode {
diff --git a/src/main/java/org/truffleruby/parser/TranslatorEnvironment.java b/src/main/java/org/truffleruby/parser/TranslatorEnvironment.java
diff --git a/src/main/java/org/truffleruby/parser/YARPLoadArgumentsTranslator.java b/src/main/java/org/truffleruby/parser/YARPLoadArgumentsTranslator.java
diff --git a/src/main/java/org/truffleruby/parser/YARPMultiTargetNodeTranslator.java b/src/main/java/org/truffleruby/parser/YARPMultiTargetNodeTranslator.java
diff --git a/src/main/java/org/truffleruby/parser/YARPMultiWriteNodeTranslator.java b/src/main/java/org/truffleruby/parser/YARPMultiWriteNodeTranslator.java
diff --git a/src/main/java/org/truffleruby/parser/YARPReloadArgumentsTranslator.java b/src/main/java/org/truffleruby/parser/YARPReloadArgumentsTranslator.java
diff --git a/src/main/java/org/truffleruby/parser/YARPTranslator.java b/src/main/java/org/truffleruby/parser/YARPTranslator.java
diff --git a/src/main/java/org/truffleruby/parser/YARPTranslatorDriver.java b/src/main/java/org/truffleruby/parser/YARPTranslatorDriver.java
