Skip to content

Commit a195452

Browse files
Elena LepilkinaLepilkinaElena
Elena Lepilkina
authored and
LepilkinaElena
committed
Renamed several variables
1 parent 6c62950 commit a195452

File tree

11 files changed

+31
-46
lines changed

11 files changed

+31
-46
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Available configuration options:
146146
* `iterationTimeUnit` – time unit for `iterationTime` (default is seconds)
147147
* `outputTimeUnit` – time unit for results output
148148
* `mode` – "thrpt" for measuring operations per time, or "avgt" for measuring time per operation
149-
* `iterationMode` – "external" for iterating in gradle in order to get correct Kotlin/Native runtime input in measurement,
149+
* `nativeIterationMode` – "external" for iterating in gradle in order to get correct Kotlin/Native runtime input in measurement,
150150
"internal" can be used if it's known that measured code have no calls in K/N runtime that can influence on measurement unrepeatedly.
151151
* `include("…")` – regular expression to include benchmarks with fully qualified names matching it, as a substring
152152
* `exclude("…")` – regular expression to exclude benchmarks with fully qualified names matching it, as a substring

‎examples/kotlin-multiplatform/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ benchmark {
9898
iterationTime = 300 // time in ms per iteration
9999
iterationTimeUnit = "ms" // time in ms per iteration
100100
advanced("forks", 1)
101-
iterationMode = "internal"
101+
nativeIterationMode = "internal"
102102
}
103103

104104
csv {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ open class BenchmarkConfiguration(val extension: BenchmarksExtension, val name:
99
var iterationTime: Long? = null
1010
var iterationTimeUnit: String? = null
1111
var mode: String? = null
12-
var iterationMode: String? = null // TODO: where should warning about K/N specific of this parameter be shown?
12+
var nativeIterationMode: String? = null // TODO: where should warning about K/N specific of this parameter be shown?
1313
var outputTimeUnit: String? = null
1414
var reportFormat: String? = null
1515

‎plugin/main/src/kotlinx/benchmark/gradle/BenchmarksExtension.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ fun Project.benchmark(configure: Action<BenchmarksExtension>) {
1313
open class BenchmarksExtension(val project: Project) {
1414
var buildDir: String = "benchmarks"
1515
var reportsDir: String = "reports/benchmarks"
16-
var configsDir: String = "configs"
16+
var benchsDescriptionDir: String = "benchsDescription"
1717

1818
val version = BenchmarksPlugin.PLUGIN_VERSION
1919

‎plugin/main/src/kotlinx/benchmark/gradle/NativeMultiplatformTasks.kt

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ fun Project.processNativeCompilation(target: NativeBenchmarkTarget) {
1616
}
1717

1818
project.logger.info("Configuring benchmarks for '${target.name}' using Kotlin/Native")
19-
20-
configureMultiplatformNativeCompilation(target, compilation)
2119

2220
createNativeBenchmarkGenerateSourceTask(target)
2321

@@ -126,8 +124,8 @@ fun Project.createNativeBenchmarkExecTask(
126124
this.workingDir = target.workingDir?.let { File(it) }
127125

128126
onlyIf { executableFile.exists() }
129-
configDir = file(project.buildDir.resolve(target.extension.configsDir).resolve(config.name))
130-
configDir.mkdirs()
127+
benchsDescriptionDir = file(project.buildDir.resolve(target.extension.benchsDescriptionDir).resolve(config.name))
128+
benchsDescriptionDir.mkdirs()
131129

132130
val ideaActive = (extensions.extraProperties.get("idea.internal.test") as? String)?.toBoolean() ?: false
133131
configFile = writeParameters(target.name, reportFile, if (ideaActive) "xml" else "text", config)
@@ -160,7 +158,7 @@ open class NativeBenchmarkExec() : DefaultTask() {
160158
lateinit var reportFile: File
161159

162160
@Input
163-
lateinit var configDir: File
161+
lateinit var benchsDescriptionDir: File
164162

165163
private fun execute(args: Collection<String>) {
166164
project.exec {
@@ -175,8 +173,8 @@ open class NativeBenchmarkExec() : DefaultTask() {
175173
@TaskAction
176174
fun run() {
177175
// Get full list of running benchmarks
178-
execute(listOf(configFile.absolutePath, "--list", configDir.absolutePath))
179-
val detailedConfigFiles = project.fileTree(configDir).files.sortedBy { it.absolutePath }
176+
execute(listOf(configFile.absolutePath, "--list", benchsDescriptionDir.absolutePath))
177+
val detailedConfigFiles = project.fileTree(benchsDescriptionDir).files.sortedBy { it.absolutePath }
180178
val jsonReportParts = mutableListOf<File>()
181179

182180
detailedConfigFiles.forEach { runConfig ->
@@ -186,7 +184,7 @@ open class NativeBenchmarkExec() : DefaultTask() {
186184
val currentConfigDescription = lines[1]
187185

188186
// Execute benchmark
189-
if (config.iterationMode == "internal") {
187+
if (config.nativeIterationMode == "internal") {
190188
val jsonFile = createTempFile("bench", ".json").toFile()
191189
jsonReportParts.add(jsonFile)
192190
execute(listOf(configFile.absolutePath, "--internal", runConfigPath, jsonFile.absolutePath))
@@ -240,18 +238,3 @@ open class NativeBenchmarkExec() : DefaultTask() {
240238
}
241239
}
242240
}
243-
244-
private fun Project.configureMultiplatformNativeCompilation(
245-
target: NativeBenchmarkTarget,
246-
compilation: KotlinNativeCompilation
247-
) {
248-
val konanTarget = compilation.target.konanTarget
249-
250-
// Add runtime library as an implementation dependency to the specified compilation
251-
val runtime =
252-
dependencies.create("${BenchmarksPlugin.RUNTIME_DEPENDENCY_BASE}-${konanTarget.presetName}:${target.extension.version}")
253-
254-
compilation.dependencies {
255-
//implementation(runtime)
256-
}
257-
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ fun writeParameters(
9494
config.iterationTimeUnit?.let { appendln("iterationTimeUnit:$it") }
9595
config.outputTimeUnit?.let { appendln("outputTimeUnit:$it") }
9696
config.mode?.let { appendln("mode:$it") }
97-
config.iterationMode?.let { appendln("iterationMode:$it") }
97+
config.nativeIterationMode?.let { appendln("nativeIterationMode:$it") }
9898

9999
config.includes.forEach {
100100
appendln("include:$it")

‎runtime/commonMain/src/kotlinx/benchmark/BenchmarkReportFormatter.kt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ internal object TextBenchmarkReportFormatter : BenchmarkReportFormatter() {
2929
val paramLengths = paramNames.associateWith { paramName ->
3030
max(paramName.length + 2, results.mapNotNull { it.params[paramName] }.maxOf { it.length }) + padding
3131
}
32+
3233
val modeLength = columnLength("Mode") { it.config.mode.toText() } + padding
3334
val samplesLength = columnLength("Cnt") { it.values.size.toString() } + padding
3435
val scopeLength = columnLength("Score") { it.score.format(3, useGrouping = false) } + padding
@@ -156,12 +157,12 @@ private class CsvBenchmarkReportFormatter(val delimiter: String) : BenchmarkRepo
156157

157158
}
158159

159-
private object JsonBenchmarkReportFormatter : BenchmarkReportFormatter() {
160+
object JsonBenchmarkReportFormatter : BenchmarkReportFormatter() {
160161

161162
override fun format(results: Collection<ReportBenchmarkResult>): String =
162163
results.joinToString(",", prefix = "[", postfix = "\n]", transform = this::format)
163164

164-
private fun format(result: ReportBenchmarkResult): String =
165+
fun format(result: ReportBenchmarkResult): String =
165166
"""
166167
{
167168
"benchmark" : "${result.benchmark.name}",
@@ -173,6 +174,7 @@ private object JsonBenchmarkReportFormatter : BenchmarkReportFormatter() {
173174
"params" : {
174175
${result.params.entries.joinToString(separator = ",\n ") { "\"${it.key}\" : \"${it.value}\"" }}
175176
},
177+
"nativeIterationMode" : "${result.config.nativeIterationMode.toText()}",
176178
"primaryMetric" : {
177179
"score": ${result.score},
178180
"scoreError": ${result.error},

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ expect enum class Mode {
2424
Throughput, AverageTime
2525
}
2626

27-
enum class IterationMode {
27+
enum class NativeIterationMode {
2828
Internal, External
2929
}
3030

@@ -61,9 +61,9 @@ fun Mode.toText() = when (this) {
6161
}
6262

6363
@Suppress("REDUNDANT_ELSE_IN_WHEN")
64-
fun IterationMode.toText() = when (this) {
65-
IterationMode.External -> "external"
66-
IterationMode.Internal -> "internal"
64+
fun NativeIterationMode.toText() = when (this) {
65+
NativeIterationMode.External -> "external"
66+
NativeIterationMode.Internal -> "internal"
6767
else -> throw UnsupportedOperationException("$this is not supported")
6868
}
6969

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ class BenchmarkConfiguration private constructor(
77
val iterationTimeUnit: BenchmarkTimeUnit,
88
val outputTimeUnit: BenchmarkTimeUnit,
99
val mode: Mode,
10-
val iterationMode: IterationMode) {
10+
val nativeIterationMode: NativeIterationMode) {
1111

1212
constructor(runner: RunnerConfiguration, suite: SuiteDescriptor<*>) : this(
1313
runner.iterations ?: suite.iterations,
@@ -16,13 +16,13 @@ class BenchmarkConfiguration private constructor(
1616
runner.iterationTimeUnit ?: suite.iterationTime.timeUnit,
1717
runner.outputTimeUnit ?: suite.outputTimeUnit,
1818
runner.mode ?: suite.mode,
19-
runner.iterationMode ?: IterationMode.External
19+
runner.nativeIterationMode ?: NativeIterationMode.External
2020
)
2121

2222
override fun toString() =
2323
"iterations=$iterations, warmups=$warmups, iterationTime=$iterationTime, " +
2424
"iterationTimeUnit=${iterationTimeUnit.toText()}, outputTimeUnit=${outputTimeUnit.toText()}, " +
25-
"mode=${mode.toText()}, iterationMode=${iterationMode.toText()}"
25+
"mode=${mode.toText()}, nativeIterationMode=${nativeIterationMode.toText()}"
2626

2727
companion object {
2828
fun parse(description: String): BenchmarkConfiguration {
@@ -38,7 +38,7 @@ class BenchmarkConfiguration private constructor(
3838
parseTimeUnit(getParameterValue("iterationTimeUnit")),
3939
parseTimeUnit(getParameterValue("outputTimeUnit")),
4040
getParameterValue("mode").toMode(),
41-
IterationMode.valueOf(getParameterValue("iterationMode").capitalize())
41+
NativeIterationMode.valueOf(getParameterValue("nativeIterationMode").capitalize())
4242
)
4343
}
4444
}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ class RunnerConfiguration(config: String) {
6868
"mode"
6969
) { Mode.valueOf(it) }
7070

71-
val iterationMode = singleValueOrNull(
72-
"iterationMode"
73-
) { IterationMode.valueOf(it.capitalize()) }
71+
val nativeIterationMode = singleValueOrNull(
72+
"nativeIterationMode"
73+
) { NativeIterationMode.valueOf(it.capitalize()) }
7474

7575
override fun toString(): String {
7676
return """$name -> $reportFile ($traceFormat, $reportFormat)
@@ -83,7 +83,7 @@ iterationTime: $iterationTime
8383
iterationTimeUnit: $iterationTimeUnit
8484
outputTimeUnit: $outputTimeUnit
8585
mode: $mode
86-
iterationMode: $iterationMode
86+
nativeIterationMode: $nativeIterationMode
8787
"""
8888
}
8989
}

0 commit comments

Comments
 (0)