[GR-44829] TruffleStrings: introduce specialized TruffleStringBuilder types for better performance on UTF encodings.

PullRequest: graal/14397

Author: djoooooe

truffle/CHANGELOG.md

@@ -2,21 +2,19 @@
 
 This changelog summarizes major changes between Truffle versions relevant to languages implementors building upon the Truffle framework. The main focus is on APIs exported by Truffle.
 
-## 23.1.0
+## Version 23.1.0
 
 * GR-45123 Added `GenerateInline#inlineByDefault` to force usage of inlined node variant even when the node has also a cached variant (`@GenerateCached(true)`).
 * GR-45036 Improved IGV IR dumping. Dump folders for Truffle now include the compilation tier to differentiate compilations better. Inlined IR graphs are now additionally dumped in separate folders if dump level is >= 2.
 * GR-45036 Improved IGV AST dumping. The Truffle AST is now dumped as part of the IR dump folder. The dumped AST tree now shows all inlined ASTS in a single tree. Individual functions can be grouped using the "Cluster nodes" function in IGV (top status bar). Root nodes now display their name e.g. `SLFunctionBody (root add)`. Every AST node now has a property `graalIRNode` that allows to find the corresponding Graal IR constant if there is one. 
 * GR-45284 Added Graal debug options `TruffleTrustedNonNullCast` and `TruffleTrustedTypeCast` that allow disabling trusted non-null and type casts in Truffle, respectively. Note that disabling trusted type casts effectively disables non-null casts, too.
-## Version 23.1.0
-
 * GR-44211 Added `TruffleLanguage.Env#newTruffleThreadBuilder(Runnable)` to create a builder for threads that have access to the appropriate `TruffleContext`. All existing `TruffleLanguage.Env#createThread` methods have been deprecated. On top of what the deprecated methods provided, the builder now allows to specify `beforeEnter` and `afterLeave` callbacks for the created threads.
 * GR-44211 Added `TruffleContext#leaveAndEnter(Node, Interrupter, InterruptibleFunction, Object)` to be able to interrupt the function run when the context is not entered. The exisiting API `TruffleContext#leaveAndEnter(Node, Supplier)` is deprecated.
 * GR-44211 Removed the deprecated method `TruffleSafepoint#setBlocked(Node, Interrupter, Interruptible, Object, Runnable, Runnable)`.
 * GR-44211 Added `TruffleSafepoint#setBlocked(Node, Interrupter, Interruptible, Object, Runnable, Consumer)`. It replaces the method `TruffleSafepoint#setBlockedWithException(Node, Interrupter, Interruptible, Object, Runnable, Consumer)` that is now deprecated.
 * GR-44211 Added `TruffleSafepoint#setBlockedFunction(Node, Interrupter, InterruptibleFunction, Object, Runnable, Consumer)` to be able to return an object from the interruptible functional method.
 * GR-44211 Added `TruffleSafepoint#setBlockedThreadInterruptibleFunction(Node, InterruptibleFunction, Object)` as a short-cut method to allow setting the blocked status for methods that throw `InterruptedException` and support interrupting using `Thread#interrupt()`.
-
+* GR-44829 TruffleStrings: added specialized TruffleStringBuilder types for better performance on UTF encodings.
 
 
 ## Version 23.0.0

truffle/src/com.oracle.truffle.api.strings.test/src/com/oracle/truffle/api/strings/test/TStringUTF16Tests.java

@@ -47,6 +47,8 @@
 import org.junit.Test;
 
 import com.oracle.truffle.api.strings.TruffleString;
+import com.oracle.truffle.api.strings.TruffleStringBuilder;
+import com.oracle.truffle.api.strings.TruffleStringBuilderUTF16;
 import com.oracle.truffle.api.strings.TruffleStringIterator;
 
 public class TStringUTF16Tests extends TStringTestBase {
@@ -132,4 +134,10 @@ public void testBrokenUTF16ToUTF8() {
         byte[] actualUTF8Bytes = utf8.copyToByteArrayUncached(TruffleString.Encoding.UTF_8);
         Assert.assertArrayEquals(Arrays.toString(actualUTF8Bytes), expectedUTF8Bytes, actualUTF8Bytes);
     }
+
+    @Test(expected = OutOfMemoryError.class)
+    public void testStringBuilderAppendCodePoint() {
+        TruffleStringBuilderUTF16 sb = TruffleStringBuilder.createUTF16();
+        sb.appendCodePointUncached(Character.MAX_CODE_POINT, Integer.MAX_VALUE - 10, false);
+    }
 }

truffle/src/com.oracle.truffle.api.strings.test/src/com/oracle/truffle/api/strings/test/TStringUTF8Tests.java

@@ -46,6 +46,8 @@
 
 import java.nio.charset.StandardCharsets;
 
+import com.oracle.truffle.api.strings.TruffleStringBuilder;
+import com.oracle.truffle.api.strings.TruffleStringBuilderUTF8;
 import org.graalvm.shadowed.org.jcodings.specific.UTF8Encoding;
 import org.junit.Assert;
 import org.junit.Assume;
@@ -228,4 +230,10 @@ public void testIteratorPrev() {
         it.previousUncached();
         Assert.assertEquals(5, it.getByteIndex());
     }
+
+    @Test(expected = OutOfMemoryError.class)
+    public void testStringBuilderAppendCodePoint() {
+        TruffleStringBuilderUTF8 sb = TruffleStringBuilder.createUTF8();
+        sb.appendCodePointUncached(Character.MAX_CODE_POINT, Integer.MAX_VALUE - 10, false);
+    }
 }

truffle/src/com.oracle.truffle.api.strings/snapshot.sigtest

@@ -994,7 +994,7 @@ meth public static com.oracle.truffle.api.strings.TruffleString$WithMask$CreateU
 meth public static com.oracle.truffle.api.strings.TruffleString$WithMask$CreateUTF32Node getUncached()
 supr com.oracle.truffle.api.nodes.Node
 
-CLSS public final com.oracle.truffle.api.strings.TruffleStringBuilder
+CLSS public abstract com.oracle.truffle.api.strings.TruffleStringBuilder
 innr public abstract static AppendByteNode
 innr public abstract static AppendCharUTF16Node
 innr public abstract static AppendCodePointNode
@@ -1004,26 +1004,32 @@ innr public abstract static AppendLongNumberNode
 innr public abstract static AppendStringNode
 innr public abstract static AppendSubstringByteIndexNode
 innr public abstract static ToStringNode
-meth public boolean isEmpty()
-meth public com.oracle.truffle.api.strings.TruffleString toStringUncached()
-meth public int byteLength()
-meth public java.lang.String toString()
+meth public final boolean isEmpty()
+meth public final com.oracle.truffle.api.strings.TruffleString toStringUncached()
+meth public final int byteLength()
+meth public final java.lang.String toString()
+meth public final void appendByteUncached(byte)
+meth public final void appendCharUTF16Uncached(char)
+meth public final void appendCodePointUncached(int)
+meth public final void appendCodePointUncached(int,int)
+meth public final void appendCodePointUncached(int,int,boolean)
+meth public final void appendIntNumberUncached(int)
+meth public final void appendJavaStringUTF16Uncached(java.lang.String)
+meth public final void appendJavaStringUTF16Uncached(java.lang.String,int,int)
+meth public final void appendLongNumberUncached(long)
+meth public final void appendStringUncached(com.oracle.truffle.api.strings.TruffleString)
+meth public final void appendSubstringByteIndexUncached(com.oracle.truffle.api.strings.TruffleString,int,int)
 meth public static com.oracle.truffle.api.strings.TruffleStringBuilder create(com.oracle.truffle.api.strings.TruffleString$Encoding)
 meth public static com.oracle.truffle.api.strings.TruffleStringBuilder create(com.oracle.truffle.api.strings.TruffleString$Encoding,int)
-meth public void appendByteUncached(byte)
-meth public void appendCharUTF16Uncached(char)
-meth public void appendCodePointUncached(int)
-meth public void appendCodePointUncached(int,int)
-meth public void appendCodePointUncached(int,int,boolean)
-meth public void appendIntNumberUncached(int)
-meth public void appendJavaStringUTF16Uncached(java.lang.String)
-meth public void appendJavaStringUTF16Uncached(java.lang.String,int,int)
-meth public void appendLongNumberUncached(long)
-meth public void appendStringUncached(com.oracle.truffle.api.strings.TruffleString)
-meth public void appendSubstringByteIndexUncached(com.oracle.truffle.api.strings.TruffleString,int,int)
+meth public static com.oracle.truffle.api.strings.TruffleStringBuilderUTF16 createUTF16()
+meth public static com.oracle.truffle.api.strings.TruffleStringBuilderUTF16 createUTF16(int)
+meth public static com.oracle.truffle.api.strings.TruffleStringBuilderUTF32 createUTF32()
+meth public static com.oracle.truffle.api.strings.TruffleStringBuilderUTF32 createUTF32(int)
+meth public static com.oracle.truffle.api.strings.TruffleStringBuilderUTF8 createUTF8()
+meth public static com.oracle.truffle.api.strings.TruffleStringBuilderUTF8 createUTF8(int)
 supr java.lang.Object
-hfds buf,codePointLength,codeRange,encoding,length,stride
-hcls AppendArrayIntlNode,AppendCodePointIntlNode
+hfds DEFAULT_INITIAL_CAPACITY,buf,codePointLength,codeRange,encoding,length,stride
+hcls AppendCodePointIntlNode
 
 CLSS public abstract static com.oracle.truffle.api.strings.TruffleStringBuilder$AppendByteNode
  outer com.oracle.truffle.api.strings.TruffleStringBuilder
@@ -1095,8 +1101,16 @@ supr com.oracle.truffle.api.nodes.Node
 CLSS public final com.oracle.truffle.api.strings.TruffleStringBuilderFactory
 cons public init()
 supr java.lang.Object
-hfds COMPACTION_LEVEL_VALUES
-hcls AppendArrayIntlNodeGen,AppendByteNodeGen,AppendCharUTF16NodeGen,AppendCodePointIntlNodeGen,AppendCodePointNodeGen,AppendIntNumberNodeGen,AppendJavaStringUTF16NodeGen,AppendLongNumberNodeGen,AppendStringNodeGen,AppendSubstringByteIndexNodeGen,ToStringNodeGen
+hcls AppendByteNodeGen,AppendCharUTF16NodeGen,AppendCodePointIntlNodeGen,AppendCodePointNodeGen,AppendIntNumberNodeGen,AppendJavaStringUTF16NodeGen,AppendLongNumberNodeGen,AppendStringNodeGen,AppendSubstringByteIndexNodeGen,ToStringNodeGen
+
+CLSS public final com.oracle.truffle.api.strings.TruffleStringBuilderUTF16
+supr com.oracle.truffle.api.strings.TruffleStringBuilder
+
+CLSS public final com.oracle.truffle.api.strings.TruffleStringBuilderUTF32
+supr com.oracle.truffle.api.strings.TruffleStringBuilder
+
+CLSS public final com.oracle.truffle.api.strings.TruffleStringBuilderUTF8
+supr com.oracle.truffle.api.strings.TruffleStringBuilder
 
 CLSS public final com.oracle.truffle.api.strings.TruffleStringFactory
 cons public init()

truffle/src/com.oracle.truffle.api.strings/src/com/oracle/truffle/api/strings/AbstractTruffleString.java

@@ -462,6 +462,22 @@ static int rawIndex(int byteIndex, TruffleString.Encoding expectedEncoding) {
         return byteIndex >> expectedEncoding.naturalStride;
     }
 
+    static int rawIndexUTF16(int byteIndex) {
+        if ((byteIndex & 1) != 0) {
+            CompilerDirectives.transferToInterpreterAndInvalidate();
+            throw InternalErrors.illegalArgument("misaligned byte index on UTF-16 string");
+        }
+        return byteIndex >> Encoding.UTF_16.naturalStride;
+    }
+
+    static int rawIndexUTF32(int byteIndex) {
+        if ((byteIndex & 3) != 0) {
+            CompilerDirectives.transferToInterpreterAndInvalidate();
+            throw InternalErrors.illegalArgument("misaligned byte index on UTF-32 string");
+        }
+        return byteIndex >> Encoding.UTF_32.naturalStride;
+    }
+
     static int byteIndex(int rawIndex, TruffleString.Encoding expectedEncoding) {
         assert rawIndex < 0 || (rawIndex << expectedEncoding.naturalStride) >= 0;
         assert rawIndex >= 0 || (rawIndex << expectedEncoding.naturalStride) < 0;

truffle/src/com.oracle.truffle.api.strings/src/com/oracle/truffle/api/strings/TStringGuards.java

@@ -99,10 +99,6 @@ static boolean isBrokenMultiByte(int codeRange) {
         return TSCodeRange.isBrokenMultiByte(codeRange);
     }
 
-    static boolean isBrokenMultiByte(TruffleStringBuilder sb) {
-        return TSCodeRange.isBrokenMultiByte(sb.getCodeRange());
-    }
-
     public static boolean isValidOrBrokenMultiByte(int codeRange) {
         return TSCodeRange.isValidOrBrokenMultiByte(codeRange);
     }
@@ -180,10 +176,6 @@ static boolean isUTF16(Encoding enc) {
         return enc == Encoding.UTF_16;
     }
 
-    static boolean isUTF16(TruffleStringBuilder sb) {
-        return isUTF16(sb.getEncoding());
-    }
-
     static boolean isUTF32(int enc) {
         return enc == Encoding.UTF_32.id;
     }
@@ -238,18 +230,6 @@ static boolean isStride2(AbstractTruffleString a) {
         return a.stride() == 2;
     }
 
-    static boolean isStride0(TruffleStringBuilder sb) {
-        return sb.getStride() == 0;
-    }
-
-    static boolean isStride1(TruffleStringBuilder sb) {
-        return sb.getStride() == 1;
-    }
-
-    static boolean isStride2(TruffleStringBuilder sb) {
-        return sb.getStride() == 2;
-    }
-
     static boolean is7BitCompatible(Encoding encoding) {
         return encoding.is7BitCompatible();
     }

truffle/src/com.oracle.truffle.api.strings/src/com/oracle/truffle/api/strings/TStringOpsNodes.java

@@ -57,8 +57,6 @@ final class TStringOpsNodes {
      */
     static final String LIMIT_STRIDE = "9";
 
-    static final String SINGLE_LIMIT_STRIDE = "3";
-
     abstract static class RawReadValueNode extends AbstractInternalNode {
 
         abstract int execute(Node node, AbstractTruffleString a, Object arrayA, int i);