feat: Kotlin/Native Windows compilation (#152)

Author: ianbotsf

.github/scripts/run-container-test.py

@@ -23,6 +23,7 @@
 import subprocess
 import shlex
 import shutil
+import textwrap
 
 VERBOSE = False
 
@@ -32,6 +33,10 @@
     "al2": "public.ecr.aws/amazonlinux/amazonlinux:2"
 }
 
+DISTRO_TO_PACKAGES = {
+    "al2023": [ "libxcrypt-compat" ],
+}
+
 DOCKER_PLATFORM_BY_ARCH = {
     "x64": "linux/amd64",
     "arm64": "linux/arm64"
@@ -83,17 +88,67 @@ def oci_executable():
     exit(1)
 
 
-def run_docker_test(opts): 
+def create_docker_image(opts, oci_exe, base_image_name, packages):
+    lines = []
+
+    # Set base image
+    lines.append(f"FROM {base_image_name}")
+
+    # Install extra packages if necessary
+    if packages:
+        cmd = [
+            "RUN yum -y install",
+            *packages,
+        ]
+        lines.append(' '.join(cmd))
+
+    # Compile the contents
+    content = '\n'.join(lines) + '\n'
+
+    # Write the Dockerfile
+    with open("Dockerfile", "w") as f:
+        f.write(content)
+
+    # Build the image
+    image_name = f"container-test-{opts.distro}:latest"
+    platform = DOCKER_PLATFORM_BY_ARCH[opts.arch]
+    cmd = shlex.join([
+        oci_exe,
+        "build",
+        "-t",
+        image_name,
+        "--platform",
+        platform,
+        ".",
+    ])
+    shell(cmd)
+
+    print(f"Created Docker image {image_name}. Listing hosted images to be certain:")
+    shell("docker image ls --all")
+
+    return image_name
+
+
+def get_docker_image(opts, oci_exe):
+    base_image_name = DISTRO_TO_IMAGE_NAME[opts.distro]
+    packages = DISTRO_TO_PACKAGES.get(opts.distro)
+    if packages:
+        return create_docker_image(opts, oci_exe, base_image_name, packages)
+    else:
+        return base_image_name
+
+
+def run_docker_test(opts):
     """
     Run a docker test for a precompiled Kotlin/Native binary
 
     :param opts: the parsed command line options
     """
     platform = DOCKER_PLATFORM_BY_ARCH[opts.arch]
     oci_exe = oci_executable()
+    image_name = get_docker_image(opts, oci_exe)
 
     test_bin_dir = os.path.abspath(opts.test_bin_dir)
-    image_name = DISTRO_TO_IMAGE_NAME[opts.distro]
     path_to_exe = f'./linux{opts.arch.capitalize()}/debugTest/test.kexe'
 
     cmd = [

.github/workflows/ci.yaml

@@ -34,7 +34,7 @@ jobs:
         shell: bash
         run: |
           ./gradlew jvmApiCheck
-          ./gradlew -Ptest.java.version=${{ matrix.java-version }} -Paws.sdk.kotlin.crt.disableCrossCompile=true jvmTest --stacktrace 
+          ./gradlew -Ptest.java.version=${{ matrix.java-version }} jvmTest --stacktrace
       - name: Save Test Reports
         if: failure()
         uses: actions/upload-artifact@v4
@@ -58,7 +58,7 @@ jobs:
         uses: ./.github/actions/setup-build
       - name: Build and Test ${{ env.PACKAGE_NAME }}
         run: |
-          ./gradlew -Paws.sdk.kotlin.crt.disableCrossCompile=true build
+          ./gradlew build
       - name: Save Test Reports
         if: failure()
         uses: actions/upload-artifact@v4
@@ -68,7 +68,6 @@ jobs:
 
   # build and test for targets: jvm, linuxX64
   # cross compile for: linuxX64, linuxArm64
-  # TODO - add mingw as cross compile target
   linux:
     runs-on: ubuntu-22.04
     steps:
@@ -79,7 +78,7 @@ jobs:
         uses: ./.github/actions/setup-build
       - name: Configure Docker Images
         run: |
-          ./docker-images/build-all.sh
+          ./docker-images/build-images.sh linux-x64 linux-arm64
       - name: Build and Test ${{ env.PACKAGE_NAME }}
         run: |
           ./gradlew build
@@ -97,7 +96,7 @@ jobs:
         if: failure()
         uses: actions/upload-artifact@v4
         with:
-          name: test-reports-linux
+          name: test-reports-linux-jvm
           path: '**/build/reports'
           retention-days: 15
 
@@ -130,18 +129,26 @@ jobs:
           RUN_CONTAINER_TEST=./native-test-binaries/.github/scripts/run-container-test.py 
           $RUN_CONTAINER_TEST --distro ${{ matrix.distro }} --arch ${{ matrix.arch }} --test-bin-dir ./native-test-binaries/aws-crt-kotlin/build/bin
 
-  # windows JVM
+  # windows JVM & native
   windows:
     runs-on: windows-2022
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: true
+      - name: Set up MSYS2
+        uses: msys2/setup-msys2@v2
+        with:
+          msystem: MINGW64
+          install: >-
+            mingw-w64-x86_64-cmake
+            mingw-w64-x86_64-gcc
       - name: Setup build environment
         uses: ./.github/actions/setup-build
       - name: Build and Test ${{ env.PACKAGE_NAME }}
+        shell: msys2 {0}
         run: |
-          ./gradlew -P"aws.sdk.kotlin.crt.disableCrossCompile"=true build
+          ./gradlew build -Paws.crt.disableContainerTargets=mingw_x64
       - name: Save Test Reports
         if: failure()
         uses: actions/upload-artifact@v4
@@ -150,5 +157,3 @@ jobs:
           path: '**/build/reports'
 
 # TODO - native test reports?
-# TODO - windows native
-

CMakeLists.txt

@@ -162,8 +162,22 @@ function(bundle_static_library name deps)
             COMMENT "Bundling ${name}"
             VERBATIM
         )
+
+    elseif (CMAKE_C_COMPILER_ID MATCHES "^MSVC$")
+        foreach(tgt IN LISTS deps)
+            list(APPEND static_libs_full_names $<TARGET_FILE:${tgt}>)
+        endforeach()
+
+        add_custom_command(
+            COMMAND ${CMAKE_AR} /OUT:${tgt_full_name} ${static_libs_full_names}
+            OUTPUT ${tgt_full_name}
+            COMMENT "Bundling ${name}"
+            VERBATIM
+            COMMAND_EXPAND_LISTS
+        )
+
     else()
-        message(FATAL_ERROR "Unknown bundling!")
+        message(FATAL_ERROR "Unknown bundling for C compiler ${CMAKE_C_COMPILER_ID}!")
     endif()
 
     add_custom_target(bundling_target ALL DEPENDS ${tgt_full_name})

aws-crt-kotlin/build.gradle.kts

@@ -5,7 +5,6 @@
 import aws.sdk.kotlin.gradle.crt.CMakeBuildType
 import aws.sdk.kotlin.gradle.crt.cmakeInstallDir
 import aws.sdk.kotlin.gradle.crt.configureCrtCMakeBuild
-import aws.sdk.kotlin.gradle.crt.disableCrossCompileTargets
 import aws.sdk.kotlin.gradle.dsl.configurePublishing
 import aws.sdk.kotlin.gradle.kmp.configureIosSimulatorTasks
 import aws.sdk.kotlin.gradle.kmp.configureKmpTargets
@@ -115,12 +114,6 @@ tasks.register("linuxTestBinaries") {
     }
 }
 
-val disableCrossCompile = providers.gradleProperty("aws.sdk.kotlin.crt.disableCrossCompile").getOrNull() == "true"
-if (disableCrossCompile) {
-    logger.warn("aws.sdk.kotlin.crt.disableCrossCompile=true: Cross compilation is disabled.")
-    disableCrossCompileTargets()
-}
-
 // run tests on specific JVM version
 val testJavaVersion = typedProp<String>("test.java.version")?.let {
     JavaLanguageVersion.of(it)

aws-crt-kotlin/native/interop/crt.def

@@ -33,6 +33,7 @@ headerFilter = aws/common/* aws/io/* aws/http/* aws/compression/* aws/auth/* aws
 
 linkerOpts.osx = -framework Security -framework Network
 linkerOpts.ios = -framework Security -framework Network
+linkerOpts.mingw = -lcrypt32 -lsecur32 -lncrypt -lshlwapi
 
 # included libs are linked automatically, adding linkerOpts like `-laws-c-common` causes
 # issues downstream as it will search for that library still.

build-support/src/main/kotlin/aws/sdk/kotlin/gradle/crt/CMakeTasks.kt

@@ -11,6 +11,7 @@ import org.gradle.api.tasks.TaskProvider
 import org.gradle.kotlin.dsl.named
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
 import org.jetbrains.kotlin.konan.target.HostManager
+import org.jetbrains.kotlin.konan.target.KonanTarget
 
 /**
  * See [CMAKE_BUILD_TYPE](https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html)
@@ -79,8 +80,8 @@ private fun Project.registerCmakeConfigureTask(
     val cmakeBuildDir = project.cmakeBuildDir(knTarget)
     val installDir = project.cmakeInstallDir(knTarget)
 
-    val relativeBuildDir = cmakeBuildDir.relativeTo(project.rootDir).path
-    val relativeInstallDir = installDir.relativeTo(project.rootDir).path
+    val relativeBuildDir = cmakeBuildDir.relativeTo(project.rootDir).slashPath
+    val relativeInstallDir = installDir.relativeTo(project.rootDir).slashPath
     val cmakeLists = project.rootProject.projectDir.resolve("CMakeLists.txt")
 
     return project.tasks.register(knTarget.cmakeConfigureTaskName) {
@@ -141,7 +142,7 @@ private fun Project.registerCmakeBuildTask(
     buildType: CMakeBuildType,
 ): TaskProvider<Task> {
     val cmakeBuildDir = project.cmakeBuildDir(knTarget)
-    val relativeBuildDir = cmakeBuildDir.relativeTo(project.rootDir).path
+    val relativeBuildDir = cmakeBuildDir.relativeTo(project.rootDir).slashPath
 
     return project.tasks.register(knTarget.cmakeBuildTaskName) {
         group = "ffi"
@@ -187,7 +188,7 @@ private fun Project.registerCmakeInstallTask(
     buildType: CMakeBuildType,
 ): TaskProvider<Task> {
     val cmakeBuildDir = project.cmakeBuildDir(knTarget)
-    val relativeBuildDir = cmakeBuildDir.relativeTo(project.rootDir).path
+    val relativeBuildDir = cmakeBuildDir.relativeTo(project.rootDir).slashPath
     val installDir = project.cmakeInstallDir(knTarget)
 
     return project.tasks.register(knTarget.cmakeInstallTaskName) {
@@ -208,20 +209,51 @@ private fun Project.registerCmakeInstallTask(
     }
 }
 
+/**
+ * Konan targets for which a container will be used execute CMake tasks. Targets that do not appear in this list or are
+ * disabled by `aws.sdk.kotlin.crt.disableCrossCompile` will be compiled without using a container (i.e., in the same
+ * shell executing Gradle).
+ */
+private val containerCompileTargets = setOf(
+    KonanTarget.LINUX_X64,
+    KonanTarget.LINUX_ARM64,
+    KonanTarget.MINGW_X64,
+)
+
+/**
+ * Konan targets which require explicitly running CMake inside of Bash
+ */
+private val requiresExplicitBash = setOf(
+    KonanTarget.MINGW_X64,
+)
+
 private fun runCmake(project: Project, target: KotlinNativeTarget, cmakeArgs: List<String>) {
+    val disableContainerTargets = (project.properties["aws.crt.disableContainerTargets"] as? String ?: "")
+        .split(',')
+        .map { it.trim() }
+        .toSet()
+
+    val useContainer = target.konanTarget in containerCompileTargets &&
+        target.konanTarget.name !in disableContainerTargets
+
     project.exec {
         workingDir(project.rootDir)
         val exeArgs = cmakeArgs.toMutableList()
-        val exeName = when {
-            target.konanTarget in crossCompileTargets -> {
-                // cross compiling via dockcross - set the docker exe to cmake
-                val containerScriptArgs = listOf("--args", "--pull=missing", "--", "cmake")
-                exeArgs.addAll(0, containerScriptArgs)
-                val script = "dockcross-" + target.konanTarget.name.replace("_", "-")
-                validateCrossCompileScriptsAvailable(project, script)
+        val exeName = if (useContainer) {
+            // cross compiling via dockcross - set the docker exe to cmake
+            val containerScriptArgs = listOf("--args", "--pull=missing", "--", "cmake")
+            exeArgs.addAll(0, containerScriptArgs)
+            val script = "dockcross-" + target.konanTarget.name.replace("_", "-")
+            validateCrossCompileScriptsAvailable(project, script)
+
+            if (target.konanTarget in requiresExplicitBash) {
+                exeArgs.add(0, "./$script")
+                "bash"
+            } else {
                 "./$script"
             }
-            else -> "cmake"
+        } else {
+            "cmake"
         }
 
         project.logger.info("$exeName ${exeArgs.joinToString(separator = " ")}")
@@ -238,8 +270,6 @@ private fun validateCrossCompileScriptsAvailable(project: Project, script: Strin
         the cross compile scripts.
         
         e.g. `./docker-images/build-all.sh`
-        
-        Alternatively disable cross compilation by setting the property `-Paws.sdk.kotlin.crt.disableCrossCompile=true`
         """.trimIndent()
         error(message)
     }

build-support/src/main/kotlin/aws/sdk/kotlin/gradle/crt/CMakeUtils.kt

@@ -87,3 +87,6 @@ val KotlinNativeTarget.cmakeBuildTaskName: String
 
 val KotlinNativeTarget.cmakeInstallTaskName: String
     get() = namedSuffix("cmakeInstall", capitalized = true)
+
+val File.slashPath: String
+    get() = path.replace(File.separatorChar, '/')