Added iteration mode to configuration

Author: Elena Lepilkina

README.md

@@ -150,6 +150,8 @@ Available configuration options:
 * `iterationTimeUnit` – time unit for `iterationTime` (default is seconds)
 * `outputTimeUnit` – time unit for results output
 * `mode` – "thrpt" for measuring operations per time, or "avgt" for measuring time per operation
+* `iterationMode` – "external" for iterating in gradle in order to get correct Kotlin/Native runtime input in measurement,
+ "internal" can be used if it's known that measured code have no calls in K/N runtime that can influence on measurement unrepeatedly.
 * `include("…")` – regular expression to include benchmarks with fully qualified names matching it, as a substring
 * `exclude("…")` – regular expression to exclude benchmarks with fully qualified names matching it, as a substring
 * `param("name", "value1", "value2")` – specify a parameter for a public mutable property `name` annotated with `@Param`

examples/kotlin-multiplatform/src/commonMain/kotlin/CommonBenchmark.kt

@@ -6,7 +6,7 @@ import kotlin.math.*
 @State(Scope.Benchmark)
 @Measurement(iterations = 3, time = 1, timeUnit = BenchmarkTimeUnit.SECONDS)
 @OutputTimeUnit(BenchmarkTimeUnit.MILLISECONDS)
-@BenchmarkMode(Mode.Throughput)
+@BenchmarkMode(Mode.AverageTime)
 class CommonBenchmark {
     private var data = 0.0
     private lateinit var text : String 

plugin/main/src/kotlinx/benchmark/gradle/BenchmarkConfiguration.kt

@@ -9,6 +9,7 @@ open class BenchmarkConfiguration(val extension: BenchmarksExtension, val name:
     var iterationTime: Long? = null
     var iterationTimeUnit: String? = null
     var mode: String? = null
+    var iterationMode: String? = null
     var outputTimeUnit: String? = null
     var reportFormat: String? = null
 

plugin/main/src/kotlinx/benchmark/gradle/SuiteSourceGenerator.kt

@@ -269,7 +269,7 @@ class SuiteSourceGenerator(val title: String, val module: ModuleDescriptor, val
 
                         val hasABlackholeParameter = fn.valueParameters.singleOrNull()?.type.toString() == "Blackhole"
                         if (hasABlackholeParameter) {
-                            println("WARNING: Blackhole works correctly only on JVM")
+                            println("WARNING: Blackhole works incorrectly on JS")
 
                             addStatement(
                                 "descriptor.add(%T(%S, descriptor, %N(%T::%N, %T())))",

plugin/main/src/kotlinx/benchmark/gradle/Utils.kt

@@ -94,6 +94,7 @@ fun writeParameters(
         config.iterationTimeUnit?.let { appendln("iterationTimeUnit:$it") }
         config.outputTimeUnit?.let { appendln("outputTimeUnit:$it") }
         config.mode?.let { appendln("mode:$it") }
+        config.iterationMode?.let { appendln("iterationMode:$it") }
 
         config.includes.forEach {
             appendln("include:$it")

runtime/commonMain/src/kotlinx/benchmark/CommonBenchmarkAnnotations.kt

@@ -24,6 +24,10 @@ expect enum class Mode {
     Throughput, AverageTime
 }
 
+enum class IterationMode {
+    Internal, External
+}
+
 @Target(AnnotationTarget.CLASS)
 expect annotation class OutputTimeUnit(val value: BenchmarkTimeUnit)
 
@@ -48,6 +52,13 @@ fun Mode.toText() = when (this) {
     else -> throw UnsupportedOperationException("$this is not supported")
 }
 
+@Suppress("REDUNDANT_ELSE_IN_WHEN")
+fun IterationMode.toText() = when (this) {
+    IterationMode.External -> "external"
+    IterationMode.Internal -> "internal"
+    else -> throw UnsupportedOperationException("$this is not supported")
+}
+
 @Suppress("REDUNDANT_ELSE_IN_WHEN")
 fun BenchmarkTimeUnit.toMultiplier() = when (this) {
     BenchmarkTimeUnit.NANOSECONDS -> 1

runtime/commonMain/src/kotlinx/benchmark/ExecutorConfiguration.kt

@@ -7,4 +7,5 @@ class BenchmarkConfiguration(val runner: RunnerConfiguration, val suite: SuiteDe
     val iterationTimeUnit: BenchmarkTimeUnit get() = runner.iterationTimeUnit ?: suite.iterationTime.timeUnit
     val outputTimeUnit: BenchmarkTimeUnit get() = runner.outputTimeUnit ?: suite.outputTimeUnit
     val mode: Mode get() = runner.mode ?: suite.mode
+    val iterationMode: IterationMode = runner.iterationMode ?: IterationMode.External
 }

runtime/commonMain/src/kotlinx/benchmark/RunnerConfiguration.kt

@@ -68,6 +68,10 @@ class RunnerConfiguration(config: String) {
         "mode"
     ) { Mode.valueOf(it) }
 
+    val iterationMode = singleValueOrNull(
+        "iterationMode"
+    ) { IterationMode.valueOf(it) }
+
 
     private fun parseTimeUnit(text: String) = when (text) {
         BenchmarkTimeUnit.SECONDS.name, "s", "sec" -> BenchmarkTimeUnit.SECONDS
@@ -88,7 +92,8 @@ warmups: $warmups
 iterationTime: $iterationTime            
 iterationTimeUnit: $iterationTimeUnit            
 outputTimeUnit: $outputTimeUnit            
-mode: $mode            
+mode: $mode
+iterationMode: $iterationMode
 """
     }
 }

runtime/jvmMain/src/kotlinx/benchmark/JvmBenchmarkAnnotations.kt

@@ -27,4 +27,4 @@ actual typealias Warmup = org.openjdk.jmh.annotations.Warmup
 actual typealias Measurement = org.openjdk.jmh.annotations.Measurement
 
 @Suppress("NO_ACTUAL_CLASS_MEMBER_FOR_EXPECTED_CLASS")
-actual typealias Param = org.openjdk.jmh.annotations.Param
+actual typealias Param = org.openjdk.jmh.annotations.Param