Use profileAndReportLoopCount() instead of reportLoopCount() and LoopConditionProfile#profile and check with CheckStyle

eregon · eregon · commit 232ef50ca202 · 2021-07-21T16:15:09.000+02:00
diff --git a/src/main/.checkstyle_checks.xml b/src/main/.checkstyle_checks.xml
@@ -234,6 +234,14 @@
       <property name="format" value='Collections\.newSetFromMap\(new ConcurrentHashMap'/>
       <property name="message" value="Use ConcurrentHashMap.newKeySet() instead."/>
     </module>
+    <module name="RegexpSinglelineJava">
+      <property name="format" value='LoopNode\.reportLoopCount\('/>
+      <property name="message" value="Use profileAndReportLoopCount() instead."/>
+    </module>
+    <module name="RegexpSinglelineJava">
+      <property name="format" value='\.profileCounted\('/>
+      <property name="message" value="Use profileAndReportLoopCount() instead."/>
+    </module>
     <module name="IllegalType">
       <!-- Use PrintStream instead of PrintWriter, PrintWriter does not consistently flush, even when writing \n.-->
       <property name="illegalClassNames" value="TruffleObject,DynamicObject,PrintWriter"/>
diff --git a/src/main/java/org/truffleruby/core/encoding/EncodingLeftCharHeadNode.java b/src/main/java/org/truffleruby/core/encoding/EncodingLeftCharHeadNode.java
@@ -12,7 +12,6 @@
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.Specialization;
-import com.oracle.truffle.api.nodes.LoopNode;
 import com.oracle.truffle.api.profiles.LoopConditionProfile;
 import org.truffleruby.language.RubyBaseNode;
 
@@ -40,11 +39,11 @@ protected int leftAdjustCharHeadUtf8(RubyEncoding enc, byte[] bytes, int p, int
         }
         int i = s;
         try {
-            while (loopProfile.profile(!utf8IsLead(bytes[i] & 0xff) && i > p)) {
+            while (loopProfile.inject(!utf8IsLead(bytes[i] & 0xff) && i > p)) {
                 i--;
             }
         } finally {
-            LoopNode.reportLoopCount(this, s - i);
+            profileAndReportLoopCount(loopProfile, s - i);
         }
         return i;
 
diff --git a/src/main/java/org/truffleruby/core/format/control/RepeatLoopNode.java b/src/main/java/org/truffleruby/core/format/control/RepeatLoopNode.java
@@ -9,16 +9,17 @@
  */
 package org.truffleruby.core.format.control;
 
+import com.oracle.truffle.api.profiles.LoopConditionProfile;
 import org.truffleruby.core.format.FormatNode;
 
 import com.oracle.truffle.api.frame.VirtualFrame;
-import com.oracle.truffle.api.nodes.LoopNode;
 
 public class RepeatLoopNode extends FormatNode {
 
     private final int count;
 
     @Child private FormatNode child;
+    private final LoopConditionProfile loopProfile = LoopConditionProfile.create();
 
     public RepeatLoopNode(int count, FormatNode child) {
         this.count = count;
@@ -27,12 +28,13 @@ public RepeatLoopNode(int count, FormatNode child) {
 
     @Override
     public Object execute(VirtualFrame frame) {
+        int i = 0;
         try {
-            for (int i = 0; i < count; i++) {
+            for (; loopProfile.inject(i < count); i++) {
                 child.execute(frame);
             }
         } finally {
-            LoopNode.reportLoopCount(this, count);
+            profileAndReportLoopCount(loopProfile, i);
         }
 
         return null;
diff --git a/src/main/java/org/truffleruby/core/format/control/SequenceNode.java b/src/main/java/org/truffleruby/core/format/control/SequenceNode.java
@@ -13,7 +13,6 @@
 
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.nodes.ExplodeLoop;
-import com.oracle.truffle.api.nodes.LoopNode;
 
 public class SequenceNode extends FormatNode {
 
@@ -26,12 +25,8 @@ public SequenceNode(FormatNode[] children) {
     @ExplodeLoop
     @Override
     public Object execute(VirtualFrame frame) {
-        try {
-            for (FormatNode child : children) {
-                child.execute(frame);
-            }
-        } finally {
-            LoopNode.reportLoopCount(this, children.length);
+        for (FormatNode child : children) {
+            child.execute(frame);
         }
 
         return null;
diff --git a/src/main/java/org/truffleruby/core/string/StringNodes.java b/src/main/java/org/truffleruby/core/string/StringNodes.java
@@ -78,7 +78,6 @@
 import com.oracle.truffle.api.dsl.Bind;
 import com.oracle.truffle.api.dsl.Cached.Exclusive;
 import com.oracle.truffle.api.dsl.Cached.Shared;
-import com.oracle.truffle.api.nodes.LoopNode;
 import com.oracle.truffle.api.profiles.LoopConditionProfile;
 import org.graalvm.collections.Pair;
 import org.jcodings.Config;
@@ -4549,8 +4548,7 @@ protected RubyNode coercePatternToRope(RubyNode pattern) {
         protected Object singleByteOptimizable(Rope stringRope, Rope patternRope, int offset,
                 @Cached @Shared("stringBytesNode") BytesNode stringBytesNode,
                 @Cached @Shared("patternBytesNode") BytesNode patternBytesNode,
-                @Cached LoopConditionProfile loopProfile,
-                @Cached("createCountingProfile()") ConditionProfile matchProfile) {
+                @Cached LoopConditionProfile loopProfile) {
 
             assert offset >= 0;
             assert offset + patternRope.byteLength() <= stringRope
@@ -4565,13 +4563,13 @@ protected Object singleByteOptimizable(Rope stringRope, Rope patternRope, int of
             final byte[] patternBytes = patternBytesNode.execute(patternRope);
 
             try {
-                for (; loopProfile.profile(p < l); p++) {
-                    if (matchProfile.profile(ArrayUtils.regionEquals(stringBytes, p, patternBytes, 0, pe))) {
+                for (; loopProfile.inject(p < l); p++) {
+                    if (ArrayUtils.regionEquals(stringBytes, p, patternBytes, 0, pe)) {
                         return p;
                     }
                 }
             } finally {
-                LoopNode.reportLoopCount(this, p - offset);
+                profileAndReportLoopCount(loopProfile, p - offset);
             }
 
             return nil;
@@ -4658,8 +4656,7 @@ protected Object patternTooLarge(Rope stringRope, Rope patternRope, int offset)
         protected Object singleByteOptimizable(Rope stringRope, Rope patternRope, int offset,
                 @Cached @Shared("stringBytesNode") BytesNode stringBytesNode,
                 @Cached @Shared("patternBytesNode") BytesNode patternBytesNode,
-                @Cached LoopConditionProfile loopProfile,
-                @Cached("createCountingProfile()") ConditionProfile matchProfile) {
+                @Cached LoopConditionProfile loopProfile) {
 
             assert offset >= 0;
             int p = offset;
@@ -4671,13 +4668,13 @@ protected Object singleByteOptimizable(Rope stringRope, Rope patternRope, int of
             final byte[] patternBytes = patternBytesNode.execute(patternRope);
 
             try {
-                for (; loopProfile.profile(p < l); p++) {
-                    if (matchProfile.profile(ArrayUtils.regionEquals(stringBytes, p, patternBytes, 0, pe))) {
+                for (; loopProfile.inject(p < l); p++) {
+                    if (ArrayUtils.regionEquals(stringBytes, p, patternBytes, 0, pe)) {
                         return p;
                     }
                 }
             } finally {
-                LoopNode.reportLoopCount(this, p - offset);
+                profileAndReportLoopCount(loopProfile, p - offset);
             }
 
             return nil;
diff --git a/src/main/java/org/truffleruby/language/RubyBaseNode.java b/src/main/java/org/truffleruby/language/RubyBaseNode.java
@@ -45,23 +45,31 @@ public static Object nullToNil(Object value) {
     /** Variants for {@link com.oracle.truffle.api.library.Library}. The node argument should typically be
      * {@code node.getNode()} with {@code @CachedLibrary("this") ArrayStoreLibrary node} */
     public static void profileAndReportLoopCount(Node node, LoopConditionProfile loopProfile, int count) {
+        // Checkstyle: stop
         loopProfile.profileCounted(count);
         LoopNode.reportLoopCount(node, count);
+        // Checkstyle: resume
     }
 
     public void profileAndReportLoopCount(LoopConditionProfile loopProfile, int count) {
+        // Checkstyle: stop
         loopProfile.profileCounted(count);
         LoopNode.reportLoopCount(this, count);
+        // Checkstyle: resume
     }
 
     public void profileAndReportLoopCount(LoopConditionProfile loopProfile, long count) {
+        // Checkstyle: stop
         loopProfile.profileCounted(count);
         reportLongLoopCount(count);
+        // Checkstyle: resume
     }
 
     protected void reportLongLoopCount(long count) {
         assert count >= 0L;
+        // Checkstyle: stop
         LoopNode.reportLoopCount(this, count > Integer.MAX_VALUE ? Integer.MAX_VALUE : (int) count);
+        // Checkstyle: resume
     }
 
     protected Node getNode() {

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@`
`12`	`12`	`import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;`
`13`	`13`	`import com.oracle.truffle.api.dsl.Cached;`
`14`	`14`	`import com.oracle.truffle.api.dsl.Specialization;`
`15`		`-import com.oracle.truffle.api.nodes.LoopNode;`
`16`	`15`	`import com.oracle.truffle.api.profiles.LoopConditionProfile;`
`17`	`16`	`import org.truffleruby.language.RubyBaseNode;`
`18`	`17`
`@@ -40,11 +39,11 @@ protected int leftAdjustCharHeadUtf8(RubyEncoding enc, byte[] bytes, int p, int`
`40`	`39`	`}`
`41`	`40`	`int i = s;`
`42`	`41`	`try {`
`43`		`- while (loopProfile.profile(!utf8IsLead(bytes[i] & 0xff) && i > p)) {`
	`42`	`+ while (loopProfile.inject(!utf8IsLead(bytes[i] & 0xff) && i > p)) {`
`44`	`43`	`i--;`
`45`	`44`	`}`
`46`	`45`	`} finally {`
`47`		`- LoopNode.reportLoopCount(this, s - i);`
	`46`	`+ profileAndReportLoopCount(loopProfile, s - i);`
`48`	`47`	`}`
`49`	`48`	`return i;`
`50`	`49`