azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

JVM_IR prefer loop with inclusive bound for unsigned integer ranges

Browse Source 
In general, we would rather prefer a range-based for loop to look like
a counter loop in Java ('for (i = start; i < end; ++i) { <BODY> }').
This corresponds to

    i = start;
    do {
        if (i >= end) break;
        <BODY>
    } while ( { ++i; true } )

However, HotSpot doesn't recognize Kotlin unsigned integer comparison
in 'if (i >= end) break;' as a counter loop condition. Thus, the loop
doesn't get optimized as a counter loop, resulting in a performance
regression.
If we use exclusive range-based for loop instead, then we actually use
unsigned integer equality instead of unsigned integer comparison, which
is Ok for HotSpot.

KT-49444
This commit is contained in:
Dmitry Petrov
2021-11-08 14:40:35 +03:00
committed by teamcity
parent a207a3e8fa
commit 271368ac53
7 changed files with 108 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
compiler/fir/fir2ir/tests-gen/org/jetbrains/kotlin/test/runners/codegen/FirBytecodeTextTestGenerated.java
Generated
+6
View File
@@ -3089,6 +3089,12 @@ public class FirBytecodeTextTestGenerated extends AbstractFirBytecodeTextTest {
KtTestUtil.assertAllTestsPresentByMetadataWithExcluded(this.getClass(), new File("compiler/testData/codegen/bytecodeText/forLoop/unsigned"), Pattern.compile("^(.+)\\.kt$"), null, TargetBackend.JVM_IR, true);
}
@Test
@TestMetadata("forInConstBoundUnsignedRange.kt")
public void testForInConstBoundUnsignedRange() throws Exception {
runTest("compiler/testData/codegen/bytecodeText/forLoop/unsigned/forInConstBoundUnsignedRange.kt");
}
@Test
@TestMetadata("forInDownToUIntMinValue.kt")
public void testForInDownToUIntMinValue() throws Exception {
compiler/ir/backend.common/src/org/jetbrains/kotlin/backend/common/lower/loops/HeaderProcessor.kt
+10 -2
View File
@@ -314,8 +314,11 @@ class ProgressionLoopHeader(
override fun buildLoop(builder: DeclarationIrBuilder, oldLoop: IrLoop, newBody: IrExpression?) =
with(builder) {
if (headerInfo.canOverflow) {
// If the induction variable CAN overflow, we cannot use it in the loop condition. Loop is lowered into something like:
if (headerInfo.canOverflow ||
preferJavaLikeCounterLoop && headerInfo.progressionType is UnsignedProgressionType && headerInfo.isLastInclusive
) {
// If the induction variable CAN overflow, we cannot use it in the loop condition.
// Loop is lowered into something like:
//
// if (inductionVar <= last) {
// // Loop is not empty
@@ -325,6 +328,11 @@ class ProgressionLoopHeader(
// // Loop body
// } while (loopVar != last)
// }
//
// This loop form is also preferable for loops over unsigned progressions on JVM,
// because HotSpot doesn't recognize unsigned integer comparison as a counter loop condition.
// Unsigned integer equality is fine, though.
// See KT-49444 for performance comparison example.
val newLoopOrigin = if (preferJavaLikeCounterLoop)
this@ProgressionLoopHeader.context.doWhileCounterLoopOrigin
else
compiler/ir/backend.common/src/org/jetbrains/kotlin/backend/common/lower/loops/handlers/DownToHandler.kt
+2 -1
View File
@@ -63,7 +63,8 @@ internal class DownToHandler(private val context: CommonBackendContext) :
private fun IrExpression.convertToExclusiveLowerBound(progressionType: ProgressionType): IrExpression? {
if (progressionType is UnsignedProgressionType) {
if (this.constLongValue == 0L) return null
// On JVM, prefer unsigned counter loop with inclusive bound
if (preferJavaLikeCounterLoop || this.constLongValue == 0L) return null
}
val irConst = this as? IrConst<*> ?: return null
compiler/ir/backend.common/src/org/jetbrains/kotlin/backend/common/lower/loops/handlers/RangeToHandler.kt
+2 -1
View File
@@ -63,7 +63,8 @@ internal class RangeToHandler(private val context: CommonBackendContext) :
private fun IrExpression.convertToExclusiveUpperBound(progressionType: ProgressionType): IrExpression? {
if (progressionType is UnsignedProgressionType) {
if (this.constLongValue == -1L) return null
// On JVM, prefer unsigned counter loop with inclusive bound
if (preferJavaLikeCounterLoop || this.constLongValue == -1L) return null
}
val irConst = this as? IrConst<*> ?: return null
compiler/testData/codegen/bytecodeText/forLoop/unsigned/forInConstBoundUnsignedRange.kt
Vendored
+76
View File
@@ -0,0 +1,76 @@
// WITH_RUNTIME
// IMPORTANT!
// Please, when your changes cause failures in bytecodeText tests for 'for' loops,
// examine the resulting bytecode shape carefully.
// Range and progression-based loops generated with Kotlin compiler should be
// as close as possible to Java counter loops ('for (int i = a; i < b; ++i) { ... }').
// Otherwise it may result in performance regression due to missing HotSpot optimizations.
// Run Kotlin compiler benchmarks (https://github.com/Kotlin/kotlin-benchmarks)
// with compiler built from your changes if you are not sure.
fun testUIntRangeLiteral(a: UInt): Int {
var s = 0
for (x in a .. 10u) {
s += x.toInt()
}
return s
}
fun testULongRangeLiteral(a: ULong): Int {
var s = 0
for (x in a .. 10u) {
s += x.toInt()
}
return s
}
fun testUIntUntil(a: UInt): Int {
var s = 0
for (x in a until 10u) {
s += x.toInt()
}
return s
}
fun testULongUntil(a: ULong): Int {
var s = 0
for (x in a until 10u) {
s += x.toInt()
}
return s
}
fun testUIntDownTo(a: UInt): Int {
var s = 0
for (x in a downTo 10u) {
s += x.toInt()
}
return s
}
fun testULongDownTo(a: ULong): Int {
var s = 0
for (x in a downTo 10u) {
s += x.toInt()
}
return s
}
// 0 iterator
// 0 hasNext
// 0 next
// 0 getStart
// 0 getEnd
// 0 getFirst
// 0 getLast
// 0 getStep
// 0 INVOKESTATIC kotlin/U(Int|Long).constructor-impl
// 0 INVOKE\w+ kotlin/U(Int|Long).(un)?box-impl
// JVM_IR_TEMPLATES
// 31 ILOAD
// 21 ISTORE
// 6 IADD
// 0 ISUB
// 3 IINC
compiler/tests-common-new/tests-gen/org/jetbrains/kotlin/test/runners/codegen/BytecodeTextTestGenerated.java
Generated
+6
View File
@@ -2981,6 +2981,12 @@ public class BytecodeTextTestGenerated extends AbstractBytecodeTextTest {
KtTestUtil.assertAllTestsPresentByMetadataWithExcluded(this.getClass(), new File("compiler/testData/codegen/bytecodeText/forLoop/unsigned"), Pattern.compile("^(.+)\\.kt$"), null, TargetBackend.JVM, true);
}
@Test
@TestMetadata("forInConstBoundUnsignedRange.kt")
public void testForInConstBoundUnsignedRange() throws Exception {
runTest("compiler/testData/codegen/bytecodeText/forLoop/unsigned/forInConstBoundUnsignedRange.kt");
}
@Test
@TestMetadata("forInDownToUIntMinValue.kt")
public void testForInDownToUIntMinValue() throws Exception {
compiler/tests-common-new/tests-gen/org/jetbrains/kotlin/test/runners/codegen/IrBytecodeTextTestGenerated.java
Generated
+6
View File
@@ -3089,6 +3089,12 @@ public class IrBytecodeTextTestGenerated extends AbstractIrBytecodeTextTest {
KtTestUtil.assertAllTestsPresentByMetadataWithExcluded(this.getClass(), new File("compiler/testData/codegen/bytecodeText/forLoop/unsigned"), Pattern.compile("^(.+)\\.kt$"), null, TargetBackend.JVM_IR, true);
}
@Test
@TestMetadata("forInConstBoundUnsignedRange.kt")
public void testForInConstBoundUnsignedRange() throws Exception {
runTest("compiler/testData/codegen/bytecodeText/forLoop/unsigned/forInConstBoundUnsignedRange.kt");
}
@Test
@TestMetadata("forInDownToUIntMinValue.kt")
public void testForInDownToUIntMinValue() throws Exception {