[Native][tests] Improve clang invocation

* Wrap it into a proper TestCompilationResult
* Pass additional flags in case of dynamic library test
This commit is contained in:
Sergey Bogolepov
2023-12-09 14:11:50 +02:00
committed by Space Team
parent 2ed84f6a11
commit 96e5b2be79
4 changed files with 104 additions and 27 deletions
@@ -6,6 +6,7 @@
package org.jetbrains.kotlin.konan.test.blackbox package org.jetbrains.kotlin.konan.test.blackbox
import com.intellij.testFramework.TestDataFile import com.intellij.testFramework.TestDataFile
import org.jetbrains.kotlin.konan.target.Family
import org.jetbrains.kotlin.konan.test.blackbox.support.* import org.jetbrains.kotlin.konan.test.blackbox.support.*
import org.jetbrains.kotlin.konan.test.blackbox.support.PackageName import org.jetbrains.kotlin.konan.test.blackbox.support.PackageName
import org.jetbrains.kotlin.konan.test.blackbox.support.TestCase import org.jetbrains.kotlin.konan.test.blackbox.support.TestCase
@@ -20,6 +21,7 @@ import org.jetbrains.kotlin.konan.test.blackbox.support.compilation.TestCompilat
import org.jetbrains.kotlin.konan.test.blackbox.support.runner.TestExecutable import org.jetbrains.kotlin.konan.test.blackbox.support.runner.TestExecutable
import org.jetbrains.kotlin.konan.test.blackbox.support.runner.TestRunCheck import org.jetbrains.kotlin.konan.test.blackbox.support.runner.TestRunCheck
import org.jetbrains.kotlin.konan.test.blackbox.support.runner.TestRunChecks import org.jetbrains.kotlin.konan.test.blackbox.support.runner.TestRunChecks
import org.jetbrains.kotlin.konan.test.blackbox.support.settings.KotlinNativeTargets
import org.jetbrains.kotlin.konan.test.blackbox.support.settings.Timeouts import org.jetbrains.kotlin.konan.test.blackbox.support.settings.Timeouts
import org.jetbrains.kotlin.konan.test.blackbox.support.settings.configurables import org.jetbrains.kotlin.konan.test.blackbox.support.settings.configurables
import org.jetbrains.kotlin.konan.test.blackbox.support.util.ClangDistribution import org.jetbrains.kotlin.konan.test.blackbox.support.util.ClangDistribution
@@ -38,7 +40,7 @@ abstract class AbstractNativeCExportTest(
STATIC, DYNAMIC STATIC, DYNAMIC
} }
protected open val kindSpecificClangFlags: List<String> = emptyList() internal open fun getKindSpecificClangFlags(binaryLibrary: TestCompilationArtifact.BinaryLibrary): List<String> = emptyList()
private val testCompilationFactory = TestCompilationFactory() private val testCompilationFactory = TestCompilationFactory()
@@ -68,19 +70,19 @@ abstract class AbstractNativeCExportTest(
val executableFile = File(buildDir, clangExecutableName) val executableFile = File(buildDir, clangExecutableName)
val includeDirectories = binaryLibrary.headerFile?.let { listOf(it.parentFile) } ?: emptyList() val includeDirectories = binaryLibrary.headerFile?.let { listOf(it.parentFile) } ?: emptyList()
val libraryName = binaryLibrary.libraryFile.nameWithoutExtension.substringAfter("lib") val libraryName = binaryLibrary.libraryFile.nameWithoutExtension.substringAfter("lib")
compileWithClang( val clangResult = compileWithClang(
clangDistribution = ClangDistribution.LlvmDistribution, clangDistribution = ClangDistribution.Llvm,
sourceFiles = cSources, sourceFiles = cSources,
includeDirectories = includeDirectories, includeDirectories = includeDirectories,
outputFile = executableFile, outputFile = executableFile,
libraryDirectories = listOf(binaryLibrary.libraryFile.parentFile), libraryDirectories = listOf(binaryLibrary.libraryFile.parentFile),
libraries = listOf(libraryName), libraries = listOf(libraryName),
additionalLinkerFlags = kindSpecificClangFlags, additionalClangFlags = getKindSpecificClangFlags(binaryLibrary),
) ).assertSuccess()
val testExecutable = TestExecutable( val testExecutable = TestExecutable(
TestCompilationArtifact.Executable(executableFile), clangResult.resultingArtifact,
loggedCompilationToolCall = LoggedData.NoopCompilerCall(buildDir), loggedCompilationToolCall = clangResult.loggedData,
testNames = listOf(TestName("TMP")), testNames = listOf(TestName("TMP")),
) )
@@ -118,7 +120,16 @@ abstract class AbstractNativeCExportTest(
} }
abstract class AbstractNativeCExportStaticTest() : AbstractNativeCExportTest(libraryKind = BinaryLibraryKind.STATIC) { abstract class AbstractNativeCExportStaticTest() : AbstractNativeCExportTest(libraryKind = BinaryLibraryKind.STATIC) {
override val kindSpecificClangFlags: List<String> override fun getKindSpecificClangFlags(binaryLibrary: TestCompilationArtifact.BinaryLibrary): List<String> =
get() = testRunSettings.configurables.linkerKonanFlags.flatMap { listOf("-Xlinker", it) } testRunSettings.configurables.linkerKonanFlags.flatMap { listOf("-Xlinker", it) }
} }
abstract class AbstractNativeCExportDynamicTest() : AbstractNativeCExportTest(libraryKind = BinaryLibraryKind.DYNAMIC) abstract class AbstractNativeCExportDynamicTest() : AbstractNativeCExportTest(libraryKind = BinaryLibraryKind.DYNAMIC) {
override fun getKindSpecificClangFlags(binaryLibrary: TestCompilationArtifact.BinaryLibrary): List<String> =
if (testRunSettings.get<KotlinNativeTargets>().testTarget.family != Family.MINGW) {
listOf("-rpath", binaryLibrary.libraryFile.parentFile.absolutePath)
} else {
// --allow-multiple-definition is needed because finalLinkCommands statically links a lot of MinGW-specific libraries,
// that are already included in DLL produced by Kotlin/Native.
listOf("-Wl,--allow-multiple-definition")
}
}
@@ -224,19 +224,19 @@ class ObjCToKotlinSteppingInLLDBTest : AbstractNativeSimpleTest() {
val clangExecutableName = "clangMain" val clangExecutableName = "clangMain"
val executableFile = File(buildDir, clangExecutableName) val executableFile = File(buildDir, clangExecutableName)
compileWithClang( val clangResult = compileWithClang(
// This code was initially written against clang from toolchain. // This code was initially written against clang from toolchain.
// Changing it to another one probably won't hurt, but it was not tested. // Changing it to another one probably won't hurt, but it was not tested.
clangDistribution = ClangDistribution.Toolchain, clangDistribution = ClangDistribution.Toolchain,
sourceFiles = listOf(clangFile), sourceFiles = listOf(clangFile),
outputFile = executableFile, outputFile = executableFile,
frameworkDirectories = listOf(buildDir), frameworkDirectories = listOf(buildDir),
) ).assertSuccess()
// 4. Generate the test case // 4. Generate the test case
val testExecutable = TestExecutable( val testExecutable = TestExecutable(
TestCompilationArtifact.Executable(executableFile), clangResult.resultingArtifact,
loggedCompilationToolCall = LoggedData.NoopCompilerCall(buildDir), loggedCompilationToolCall = clangResult.loggedData,
testNames = listOf(TestName(testName)), testNames = listOf(TestName(testName)),
) )
val spec = LLDBSessionSpec.parse(lldbSpec) val spec = LLDBSessionSpec.parse(lldbSpec)
@@ -224,6 +224,7 @@ internal abstract class LoggedData {
return this return this
} }
@JvmStatic
protected fun StringBuilder.appendArguments(header: String, args: Iterable<String>): StringBuilder { protected fun StringBuilder.appendArguments(header: String, args: Iterable<String>): StringBuilder {
appendLine(header) appendLine(header)
@@ -5,9 +5,14 @@
package org.jetbrains.kotlin.konan.test.blackbox.support.util package org.jetbrains.kotlin.konan.test.blackbox.support.util
import org.jetbrains.kotlin.cli.common.ExitCode
import org.jetbrains.kotlin.konan.test.blackbox.AbstractNativeSimpleTest import org.jetbrains.kotlin.konan.test.blackbox.AbstractNativeSimpleTest
import org.jetbrains.kotlin.konan.test.blackbox.support.LoggedData
import org.jetbrains.kotlin.konan.test.blackbox.support.compilation.TestCompilationArtifact
import org.jetbrains.kotlin.konan.test.blackbox.support.compilation.TestCompilationResult
import org.jetbrains.kotlin.konan.test.blackbox.support.settings.configurables import org.jetbrains.kotlin.konan.test.blackbox.support.settings.configurables
import java.io.File import java.io.File
import kotlin.time.measureTime
/** /**
* Specifies which Clang should be used for compilation. * Specifies which Clang should be used for compilation.
@@ -23,27 +28,36 @@ internal enum class ClangDistribution {
/** /**
* Use Clang from Kotlin/Native LLVM distribution. * Use Clang from Kotlin/Native LLVM distribution.
*/ */
LlvmDistribution Llvm
}
internal enum class ClangMode {
C, CXX
} }
// FIXME: absoluteTargetToolchain might not work correctly with KONAN_USE_INTERNAL_SERVER because // FIXME: absoluteTargetToolchain might not work correctly with KONAN_USE_INTERNAL_SERVER because
// :kotlin-native:dependencies:update is not a dependency of :native:native.tests:test where this test runs // :kotlin-native:dependencies:update is not a dependency of :native:native.tests:test where this test runs
internal fun AbstractNativeSimpleTest.compileWithClang( internal fun AbstractNativeSimpleTest.compileWithClang(
clangDistribution: ClangDistribution = ClangDistribution.LlvmDistribution, clangDistribution: ClangDistribution = ClangDistribution.Llvm,
clangMode: ClangMode = ClangMode.C,
sourceFiles: List<File>, sourceFiles: List<File>,
outputFile: File, outputFile: File,
includeDirectories: List<File> = emptyList(), includeDirectories: List<File> = emptyList(),
frameworkDirectories: List<File> = emptyList(), frameworkDirectories: List<File> = emptyList(),
libraryDirectories: List<File> = emptyList(), libraryDirectories: List<File> = emptyList(),
libraries: List<String> = emptyList(), libraries: List<String> = emptyList(),
additionalLinkerFlags: List<String> = emptyList(), additionalClangFlags: List<String> = emptyList(),
) { ): TestCompilationResult<out TestCompilationArtifact.Executable> {
val clang = when (clangDistribution) { val clangExecutableName = when (clangMode) {
ClangDistribution.Toolchain -> "${testRunSettings.configurables.absoluteTargetToolchain}/bin/clang" ClangMode.C -> "clang"
ClangDistribution.LlvmDistribution -> "${testRunSettings.configurables.absoluteLlvmHome}/bin/clang" ClangMode.CXX -> "clang++"
}
val clangPath = when (clangDistribution) {
ClangDistribution.Toolchain -> "${testRunSettings.configurables.absoluteTargetToolchain}/bin/$clangExecutableName"
ClangDistribution.Llvm -> "${testRunSettings.configurables.absoluteLlvmHome}/bin/$clangExecutableName"
} }
val process = ProcessBuilder( val process = ProcessBuilder(
clang, clangPath,
*sourceFiles.map { it.absolutePath }.toTypedArray(), *sourceFiles.map { it.absolutePath }.toTypedArray(),
*includeDirectories.flatMap { listOf("-I", it.absolutePath) }.toTypedArray(), *includeDirectories.flatMap { listOf("-I", it.absolutePath) }.toTypedArray(),
"-isysroot", testRunSettings.configurables.absoluteTargetSysRoot, "-isysroot", testRunSettings.configurables.absoluteTargetSysRoot,
@@ -52,12 +66,63 @@ internal fun AbstractNativeSimpleTest.compileWithClang(
*frameworkDirectories.flatMap { listOf("-F", it.absolutePath) }.toTypedArray(), *frameworkDirectories.flatMap { listOf("-F", it.absolutePath) }.toTypedArray(),
*libraryDirectories.flatMap { listOf("-L", it.absolutePath) }.toTypedArray(), *libraryDirectories.flatMap { listOf("-L", it.absolutePath) }.toTypedArray(),
*libraries.map { "-l$it" }.toTypedArray(), *libraries.map { "-l$it" }.toTypedArray(),
*additionalLinkerFlags.toTypedArray(), *additionalClangFlags.toTypedArray(),
"-o", outputFile.absolutePath "-o", outputFile.absolutePath
).redirectErrorStream(true).start() ).start()
val exitCode: Int
val duration = measureTime {
exitCode = process.waitFor()
}
val clangErrorOutput = process.errorStream.readBytes()
val clangOutput = process.inputStream.readBytes() val clangOutput = process.inputStream.readBytes()
check( val parameters = ClangParameters(
process.waitFor() == 0 clangPath,
) { clangOutput.decodeToString() } sourceFiles,
outputFile,
includeDirectories,
frameworkDirectories,
libraryDirectories,
libraries,
additionalClangFlags
)
val loggedData = LoggedData.CompilationToolCall(
toolName = "CLANG",
parameters = parameters,
exitCode = if (exitCode == 0) ExitCode.OK else ExitCode.COMPILATION_ERROR,
toolOutput = clangOutput.decodeToString() + clangErrorOutput.decodeToString(),
toolOutputHasErrors = clangErrorOutput.isNotEmpty(),
duration = duration,
input = null,
)
return if (exitCode != 0) {
TestCompilationResult.CompilationToolFailure(loggedData)
} else {
val executable = TestCompilationArtifact.Executable(outputFile)
TestCompilationResult.Success(executable, loggedData)
}
}
internal class ClangParameters(
private val clangPath: String,
private val sourceFiles: List<File>,
private val outputFile: File,
private val includeDirectories: List<File> = emptyList(),
private val frameworkDirectories: List<File> = emptyList(),
private val libraryDirectories: List<File> = emptyList(),
private val libraries: List<String> = emptyList(),
private val additionalClangFlags: List<String> = emptyList(),
) : LoggedData() {
override fun computeText(): String = buildString {
appendLine("CLANG")
appendLine("- $clangPath")
appendLine("OUTPUT FILE")
appendLine("- ${outputFile.absolutePath}")
appendArguments("SOURCES", sourceFiles.map { it.absolutePath })
appendArguments("INCLUDE DIRECTORIES", includeDirectories.map { it.absolutePath })
appendArguments("LIBRARY DIRECTORIES", libraryDirectories.map { it.absolutePath })
appendArguments("FRAMEWORK DIRECTORIES", frameworkDirectories.map { it.absolutePath })
appendArguments("LIBRARIES", libraries)
appendArguments("ADDITIONAL CLANG FLAGS", additionalClangFlags)
}
} }