JVM_IR generate range-based loop closer to Java counter loop

KT-48435 KT-48507
2021-09-01 15:31:19 +03:00
parent 9ed08438d5
commit b669de1663
137 changed files with 1518 additions and 573 deletions
@@ -1,4 +1,14 @@
 // 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.
+
 const val M = UInt.MIN_VALUE

 fun f(a: UInt): Int {
@@ -1,4 +1,14 @@
 // 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.
+
 const val M = ULong.MIN_VALUE

 fun f(a: ULong): Int {
@@ -1,5 +1,14 @@
 // 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, b: UInt): Int {
    var s = 0
    for (x in a .. b) {
@@ -1,4 +1,14 @@
 // 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.
+
 const val M = UInt.MAX_VALUE

 fun f(a: UInt): Int {
@@ -1,4 +1,14 @@
 // 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.
+
 const val M = ULong.MAX_VALUE

 fun f(a: ULong): Int {
@@ -1,4 +1,14 @@
 // 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.
+
 const val M = UInt.MAX_VALUE

 fun f(a: UInt): Int {
@@ -1,4 +1,14 @@
 // 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.
+
 const val M = UInt.MIN_VALUE

 fun f(a: UInt): Int {
@@ -1,4 +1,14 @@
 // 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.
+
 const val M = ULong.MAX_VALUE

 fun f(a: ULong): Int {
@@ -1,4 +1,14 @@
 // 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.
+
 const val M = ULong.MIN_VALUE

 fun f(a: ULong): Int {
@@ -1,5 +1,15 @@
 // TARGET_BACKEND: JVM_IR
 // 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 box(): String {
    for (i in 1u..6u step 0) {
    }
@@ -9,23 +19,6 @@ fun box(): String {

 // For "step" progressions in JVM IR, if the step is constant and <= 0, the expression for step is replaced with an
 // IllegalArgumentException. The backend can then eliminate the entire loop and the rest of the function as dead code.
-//
-// Expected lowered form of loop (before bytecode optimization):
-//
-//   // Additional statements:
-//   throw IllegalArgumentException("Step must be positive, was: 0.")
-//
-//   // Standard form of loop over progression
-//   var inductionVar = 1u
-//   val last = getProgressionLastElement(1u, 6u, 0)
-//   if (inductionVar <= last) {
-//     // Loop is not empty
-//     do {
-//       val i = inductionVar
-//       inductionVar += 0
-//       // Loop body
-//     } while (i != last)
-//   }

 // 0 iterator
 // 0 getStart
@@ -1,5 +1,15 @@
 // TARGET_BACKEND: JVM_IR
 // 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 box(): String {
    for (i in (1u..8u).reversed() step 2) {
    }
@@ -10,22 +20,6 @@ fun box(): String {
 // For "step" progressions in JVM IR, a call to getProgressionLastElement() is made to compute the "last" value.
 // If the step is non-constant, there is a check that it is > 0, and if not, an IllegalArgumentException is thrown. However, when the
 // step is constant and > 0, this check does not need to be added.
-//
-// Expected lowered form of loop:
-//
-//   // Standard form of loop over progression
-//   val last = getProgressionLastElement(8u, 1u, -2)
-//   var inductionVar = 8u
-//   if (last <= inductionVar) {
-//     // Loop is not empty
-//     do {
-//       val i = inductionVar
-//       inductionVar += -2
-//       // Loop body
-//     } while (i != last)
-//   }
-//
-// We can't use "0 reversed" in the regex below because "reversed" is in the test filename.

 // 0 INVOKE.*reversed
 // 0 iterator
@@ -38,7 +32,12 @@ fun box(): String {
 // 0 NEW java/lang/IllegalArgumentException
 // 0 ATHROW
 // 1 IFGT
-// 1 IF_ICMPNE
+// 1 IF_ICMPEQ
 // 2 IF
 // 0 INVOKESTATIC kotlin/UInt.constructor-impl
 // 0 INVOKE\w+ kotlin/UInt.(un)?box-impl
+// 5 ILOAD
+// 3 ISTORE
+// 0 IADD
+// 0 ISUB
+// 1 IINC
@@ -13,25 +13,6 @@ fun box(): String {
 // If the step is non-constant, there is a check that it is > 0, and if not, an IllegalArgumentException is thrown. However, when the
 // step is constant and > 0, this check does not need to be added.
 //
-// Expected lowered form of loop:
-//
-//   // Additional statements:
-//   val nestedFirst = uintProgression.first
-//   val nestedLast = uintProgression.last
-//   val nestedStep = uintProgression.step
-//   val maybeNegatedStep = if (nestedStep <= 0) -2 else 2
-//
-//   // Standard form of loop over progression
-//   var inductionVar = nestedFirst
-//   val last = getProgressionLastElement(nestedFirst, nestedLast, maybeNegatedStep)
-//   if ((maybeNegatedStep > 0 && inductionVar <= last) || (maybeNegatedStep < 0 && last <= inductionVar)) {
-//     // Loop is not empty
-//     do {
-//       val i = inductionVar
-//       inductionVar += maybeNegatedStep
-//       // Loop body
-//     } while (i != last)
-//   }

 // 0 iterator
 // 0 getStart
@@ -44,10 +25,15 @@ fun box(): String {
 // 0 ATHROW
 // 2 INVOKESTATIC kotlin/UnsignedKt.uintCompare
 // 2 IFGT
-// 1 IF_ICMPNE
+// 1 IF_ICMPEQ
 // 2 IFLE
 // 1 IFGE
 // 6 IF
 // 0 INEG
 // 0 INVOKESTATIC kotlin/UInt.constructor-impl
 // 0 INVOKE\w+ kotlin/UInt.(un)?box-impl
+// 21 ILOAD
+// 13 ISTORE
+// 1 IADD
+// 0 ISUB
+// 0 IINC
@@ -1,5 +1,15 @@
 // TARGET_BACKEND: JVM_IR
 // 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 one() = 1

 fun box(): String {
@@ -13,28 +23,6 @@ fun box(): String {
 // For "step" progressions in JVM IR, a call to getProgressionLastElement() is made to compute the "last" value.
 // If "step" is called on a non-literal progression, there is a check to see if that progression's step value is < 0.
 // If the step is non-constant, there is a check that it is > 0, and if not, an IllegalArgumentException is thrown.
-//
-// Expected lowered form of loop:
-//
-//   // Additional statements:
-//   val nestedFirst = uintProgression.first
-//   val nestedLast = uintProgression.last
-//   val nestedStep = uintProgression.step
-//   var stepArg = one()
-//   if (stepArg <= 0) throw IllegalArgumentException("Step must be positive, was: $stepArg.")
-//   if (nestedStep <= 0) stepArg = -stepArg
-//
-//   // Standard form of loop over progression
-//   var inductionVar = nestedFirst
-//   val last = getProgressionLastElement(nestedFirst, nestedLast, stepArg)
-//   if ((stepArg > 0 && inductionVar <= last) || (stepArg < 0 && last <= inductionVar)) {
-//     // Loop is not empty
-//     do {
-//       val i = inductionVar
-//       inductionVar += stepArg
-//       // Loop body
-//     } while (i != last)
-//   }

 // 0 iterator
 // 0 getStart
@@ -47,10 +35,15 @@ fun box(): String {
 // 1 ATHROW
 // 2 INVOKESTATIC kotlin/UnsignedKt.uintCompare
 // 3 IFGT
-// 1 IF_ICMPNE
+// 1 IF_ICMPEQ
 // 2 IFLE
 // 1 IFGE
 // 7 IF
 // 1 INEG
 // 0 INVOKESTATIC kotlin/UInt.constructor-impl
 // 0 INVOKE\w+ kotlin/UInt.(un)?box-impl
+// 25 ILOAD
+// 15 ISTORE
+// 1 IADD
+// 0 ISUB
+// 0 IINC
@@ -1,5 +1,15 @@
 // TARGET_BACKEND: JVM_IR
 // 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 box(): String {
    val uintRange = 1u..7u
    for (i in uintRange step 2) {
@@ -13,23 +23,6 @@ fun box(): String {
 // However, if the progression is of type *Range (e.g., IntRange) instead of *Progression (e.g., IntProgression), this
 // check is not needed since *Range always has step == 1.
 //
-// Expected lowered form of loop:
-//
-//   // Additional statements:
-//   val nestedFirst = uintRange.first
-//   val nestedLast = uintRange.last
-//
-//   // Standard form of loop over progression
-//   var inductionVar = nestedFirst
-//   val last = getProgressionLastElement(nestedFirst, nestedLast, 2)
-//   if (inductionVar <= last) {
-//     // Loop is not empty
-//     do {
-//       val i = inductionVar
-//       inductionVar += 2
-//       // Loop body
-//     } while (i != last)
-//   }

 // 0 iterator
 // 0 getStart
@@ -42,8 +35,13 @@ fun box(): String {
 // 0 ATHROW
 // 1 INVOKESTATIC kotlin/UnsignedKt.uintCompare
 // 1 IFGT
-// 1 IF_ICMPNE
+// 1 IF_ICMPEQ
 // 2 IF
 // 0 INEG
 // 0 INVOKESTATIC kotlin/UInt.constructor-impl
 // 0 INVOKE\w+ kotlin/UInt.(un)?box-impl
+// 12 ILOAD
+// 9 ISTORE
+// 0 IADD
+// 0 ISUB
+// 1 IINC
@@ -1,5 +1,15 @@
 // TARGET_BACKEND: JVM_IR
 // 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 box(): String {
    for (i in 1u..7u step 3 step 2) {
    }
@@ -11,23 +21,6 @@ fun box(): String {
 // nested call to "step".
 // If the step is non-constant, there is a check that it is > 0, and if not, an IllegalArgumentException is thrown. However, when the
 // step is constant and > 0, this check does not need to be added.
-//
-// Expected lowered form of loop:
-//
-//   // Additional statements:
-//   val outerNestedLast = getProgressionLastElement(1u, 7u, 3)
-//
-//   // Standard form of loop over progression
-//   var inductionVar = 1u
-//   val last = getProgressionLastElement(1u, outerNestedLast, 2)
-//   if (inductionVar <= last) {
-//     // Loop is not empty
-//     do {
-//       val i = inductionVar
-//       inductionVar += 2
-//       // Loop body
-//     } while (i != last)
-//   }

 // 0 iterator
 // 0 getStart
@@ -40,7 +33,12 @@ fun box(): String {
 // 0 ATHROW
 // 1 INVOKESTATIC kotlin/UnsignedKt.uintCompare
 // 1 IFGT
-// 1 IF_ICMPNE
+// 1 IF_ICMPEQ
 // 2 IF
 // 0 INVOKESTATIC kotlin/UInt.constructor-impl
 // 0 INVOKE\w+ kotlin/UInt.(un)?box-impl
+// 6 ILOAD
+// 4 ISTORE
+// 0 IADD
+// 0 ISUB
+// 1 IINC