[Gradle] Cleanup: remove unused classes

- CompilationFreeArgsValidator got accidentally unused at some point,
and for now we don't see a reason to enable it back. A proper solution
includes exposing K/N linker options more explicitly via DSL, which
would address the initial problem of passing linker options to compiler
accidentally

- With ComplationFreeArgsValidator removal and migration of
DisabledNativeTargetsReporter to diagnostics infra, AggregateReporter
becomes unused so it can be removed as well
This commit is contained in:
Dmitry Savvinov
2023-04-19 19:09:16 +02:00
parent e74e6759ed
commit 66411a92f0
2 changed files with 0 additions and 165 deletions
@@ -1,137 +0,0 @@
/*
* Copyright 2010-2019 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
package org.jetbrains.kotlin.gradle.targets.native
import org.gradle.api.Project
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeCompilation
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
import org.jetbrains.kotlin.gradle.utils.appendLine
internal object CompilationFreeArgsValidator : AggregateReporter() {
private const val EXTRA_PROPERTY_NAME = "org.jetbrains.kotlin.native.incorrectFreeArgs"
private data class IncorrectArgumentsReport(val compilation: KotlinNativeCompilation, val incorrectArgs: List<String>) {
val target: KotlinNativeTarget
get() = compilation.target
val project: Project
get() = target.project
}
private fun String.startsWithIncorrectPrefix() = incorrectArgPrefixes.any { startsWith(it) }
private fun String.disablesDevirtualization() = startsWith("-Xdisable-phases=") && contains("Devirtualization")
private fun Project.getOrRegisterIncorrectArguments(): MutableList<IncorrectArgumentsReport> =
getOrRegisterData(this, EXTRA_PROPERTY_NAME)
private fun String.withIndent(indent: Int) = prependIndent(" ".repeat(indent))
fun validate(compilation: KotlinNativeCompilation) {
val incorrectArgs = compilation.kotlinOptions.freeCompilerArgs.filter { arg ->
arg.startsWithIncorrectPrefix() || arg.disablesDevirtualization()
}
if (incorrectArgs.isNotEmpty()) {
compilation.target.project
.getOrRegisterIncorrectArguments()
.add(IncorrectArgumentsReport(compilation, incorrectArgs))
}
}
/**
* The message format is the following:
*
* The following free compiler arguments must be specified for a binary instead of a compilation:
* * In project ':':
* * In target 'macos':
* Compilation: 'main', arguments: [-opt]
* * In project ':test':
* * In target 'macos':
* Compilation: 'main', arguments: [-opt, -g]
* Compilation: 'test', arguments: [-opt, -g, -Xdisable-phases=Devirtualization,BuildDFG]
*/
override fun printWarning(project: Project) {
// filterIsInstance helps against potential class loaders conflict or misconfiguration.
@Suppress("UselessCallOnCollection")
val incorrectArgs = project
.getOrRegisterIncorrectArguments()
.filterIsInstance<IncorrectArgumentsReport>()
.groupBy { it.project }
.toSortedMap(compareBy { it.path })
if (incorrectArgs.isEmpty()) {
return
}
val message = buildString {
appendLine()
appendLine("The following free compiler arguments must be specified for a binary instead of a compilation:")
incorrectArgs.forEach { (project, reports) ->
appendLine("* In project '${project.path}':".withIndent(1))
val groupedReports = reports
.groupBy { it.target }
.toSortedMap(compareBy { it.name })
groupedReports.forEach { (target, reports) ->
appendLine("* In target '${target.name}':".withIndent(2))
reports.forEach {
appendLine(
"* Compilation: '${it.compilation.name}', arguments: [${it.incorrectArgs.joinToString()}]".withIndent(3)
)
}
}
}
appendLine()
appendLine(
"""
Please move them into final binary declarations. E.g. binaries.executable { freeCompilerArgs += "..." }
See more about final binaries: https://kotlinlang.org/docs/reference/building-mpp-with-gradle.html#building-final-native-binaries.
""".trimIndent()
)
}
project.logger.warn(message)
}
private val incorrectArgPrefixes = listOf(
// Optimizations/debug info.
"-opt",
"-g",
"-ea",
"-enable-assertions",
// Test runners.
"-trn",
"-generate-no-exit-test-runner",
"-tr",
"-generate-test-runner",
"-trw",
"-generate-worker-test-runner",
// Linker parameters and entry point.
"-linker-option",
"-linker-options",
"-e",
"-entry",
"-nomain",
// Runtime settings.
"-memory-model",
// Coverage.
"-Xcoverage",
"-Xcoverage-file",
"-Xlibrary-to-cover",
// Reverse ObjC interop and framework producing.
"-Xembed-bitcode",
"-Xembed-bitcode-marker",
"-Xexport-library",
"-Xframework-import-header",
"-Xobjc-generics",
"-Xstatic-framework",
// Advanced debug info.
"-Xdebug-info-version",
"-Xg0",
// Other.
"-Xinclude",
"-Xruntime"
)
}
@@ -1,28 +0,0 @@
/*
* Copyright 2010-2019 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
package org.jetbrains.kotlin.gradle.targets.native
import org.gradle.api.Project
import org.gradle.api.plugins.ExtraPropertiesExtension
import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
import org.jetbrains.kotlin.gradle.utils.appendLine
import org.jetbrains.kotlin.konan.target.HostManager
import org.jetbrains.kotlin.konan.target.KonanTarget
internal abstract class AggregateReporter {
@Suppress("UNCHECKED_CAST")
protected fun <T> getOrRegisterData(project: Project, propertyName: String): MutableList<T> =
project.rootProject.extensions.getByType(ExtraPropertiesExtension::class.java).run {
if (!has(propertyName)) {
set(propertyName, mutableListOf<T>())
project.gradle.taskGraph.whenReady { printWarning(project) }
}
get(propertyName)
} as MutableList<T>
protected abstract fun printWarning(project: Project)
}