build: Add WasmKit (a Wasm runtime) product

This patch adds a new product, WasmKit, which is a Wasm runtime that is
going to be used to run executable tests targeting Wasm. Note that the
product is not shipped as a part of the toolchain, but is used only for
testing purposes.

Author: kateinoigakukun

utils/build_swift/build_swift/driver_arguments.py

@@ -750,6 +750,8 @@ def create_argument_parser():
     option(['--build-wasm-stdlib'], toggle_true('build_wasmstdlib'),
            help='build the stdlib for WebAssembly target into a'
                 'separate build directory ')
+    option(['--wasmkit'], toggle_true('build_wasmkit'),
+           help='build WasmKit')
 
     option('--xctest', toggle_true('build_xctest'),
            help='build xctest')

utils/build_swift/tests/expected_options.py

@@ -129,6 +129,7 @@
     'build_watchos_simulator': False,
     'build_xctest': False,
     'build_wasmstdlib': False,
+    'build_wasmkit': False,
     'cmake_c_launcher': None,
     'cmake_cxx_launcher': None,
     'clang_compiler_version': None,
@@ -547,6 +548,7 @@ class BuildScriptImplOption(_BaseOption):
     SetTrueOption('--swiftdocc', dest='build_swiftdocc'),
     SetTrueOption('--build-minimal-stdlib', dest='build_minimalstdlib'),
     SetTrueOption('--build-wasm-stdlib', dest='build_wasmstdlib'),
+    SetTrueOption('--wasmkit', dest='build_wasmkit'),
     SetTrueOption('-B', dest='benchmark'),
     SetTrueOption('-S', dest='skip_build'),
     SetTrueOption('-b', dest='build_llbuild'),

utils/swift_build_support/swift_build_support/build_script_invocation.py

@@ -670,6 +670,8 @@ def compute_product_pipelines(self):
                             is_enabled=self.args.build_wasmstdlib)
         builder.add_product(products.WasmLLVMRuntimeLibs,
                             is_enabled=self.args.build_wasmstdlib)
+        builder.add_product(products.WasmKit,
+                            is_enabled=self.args.build_wasmkit)
         builder.add_product(products.WasmStdlib,
                             is_enabled=self.args.build_wasmstdlib)
 

utils/swift_build_support/swift_build_support/products/__init__.py

@@ -38,6 +38,7 @@
 from .swiftsyntax import SwiftSyntax
 from .tsan_libdispatch import TSanLibDispatch
 from .wasisysroot import WASILibc, WasmLLVMRuntimeLibs
+from .wasmkit import WasmKit
 from .wasmstdlib import WasmStdlib
 from .xctest import XCTest
 from .zlib import Zlib
@@ -74,5 +75,6 @@
     'SwiftDocCRender',
     'WASILibc',
     'WasmLLVMRuntimeLibs',
+    'WasmKit',
     'WasmStdlib'
 ]

utils/swift_build_support/swift_build_support/products/wasmkit.py

@@ -0,0 +1,93 @@
+# swift_build_support/products/wasmkit.py ------------------------------------
+#
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
+# Licensed under Apache License v2.0 with Runtime Library Exception
+#
+# See https://swift.org/LICENSE.txt for license information
+# See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+#
+# ----------------------------------------------------------------------------
+
+import os
+import shutil
+
+from . import product
+from .. import shell
+
+
+class WasmKit(product.Product):
+    """
+    A product for WasmKit, which is a WebAssembly runtime implementation
+    written in Swift.
+    """
+
+    @classmethod
+    def product_source_name(cls):
+        return "wasmkit"
+
+    @classmethod
+    def is_build_script_impl_product(cls):
+        return False
+
+    @classmethod
+    def is_before_build_script_impl_product(cls):
+        return True
+
+    @classmethod
+    def get_dependencies(cls):
+        return []
+
+    def should_build(self, host_target):
+        return self.args.build_wasmkit
+
+    def should_test(self, host_target):
+        return False
+
+    def should_install(self, host_target):
+        # Currently, it's only used for testing stdlib.
+        return False
+
+    def install(self, host_target):
+        pass
+
+    def build(self, host_target):
+        bin_path = run_swift_build(host_target, self, 'wasmkit-cli')
+        print("Built wasmkit-cli at: " + bin_path)
+        # Copy the built binary to ./bin
+        dest_bin_path = self.__class__.cli_file_path(self.build_dir)
+        print("Copying wasmkit-cli to: " + dest_bin_path)
+        os.makedirs(os.path.dirname(dest_bin_path), exist_ok=True)
+        shutil.copy(bin_path, dest_bin_path)
+
+    @classmethod
+    def cli_file_path(cls, build_dir):
+        return os.path.join(build_dir, 'bin', 'wasmkit-cli')
+
+
+def run_swift_build(host_target, product, swpft_package_product_name):
+    # Building with the host toolchain's SwiftPM
+    swiftc_path = os.path.abspath(product.toolchain.swiftc)
+    toolchain_path = os.path.dirname(os.path.dirname(swiftc_path))
+    swift_build = os.path.join(toolchain_path, 'bin', 'swift-build')
+
+    build_args = [
+        swift_build,
+        '--product', swpft_package_product_name,
+        '--package-path', os.path.join(product.source_dir),
+        '--build-path', product.build_dir,
+        '--configuration', 'release',
+    ]
+
+    if product.args.verbose_build:
+        build_args.append('--verbose')
+
+    env = dict(os.environ)
+    env['SWIFTCI_USE_LOCAL_DEPS'] = '1'
+
+    shell.call(build_args, env=env)
+
+    bin_dir_path = shell.capture(
+        build_args + ['--show-bin-path'], dry_run=False, echo=False).rstrip()
+    return os.path.join(bin_dir_path, swpft_package_product_name)

utils/update_checkout/update-checkout-config.json

@@ -85,6 +85,9 @@
             "remote": { "id": "apple/llvm-project" } },
         "wasi-libc": {
             "remote": { "id": "WebAssembly/wasi-libc" } },
+        "wasmkit": {
+          "remote": { "id": "swiftwasm/WasmKit" }
+        },
         "curl": {
           "remote": { "id": "curl/curl" }
         },
@@ -142,6 +145,7 @@
                 "swift-nio-ssl": "2.15.0",
                 "swift-experimental-string-processing": "swift/main",
                 "wasi-libc": "wasi-sdk-20",
+                "wasmkit": "0.0.3",
                 "curl": "curl-8_4_0",
                 "icu": "maint/maint-69",
                 "libxml2": "v2.11.5",
@@ -237,7 +241,8 @@
                 "swift-nio": "2.31.2",
                 "swift-nio-ssl": "2.15.0",
                 "swift-experimental-string-processing": "swift/main",
-                "wasi-libc": "wasi-sdk-20"
+                "wasi-libc": "wasi-sdk-20",
+                "wasmkit": "0.0.3"
             }
         },
         "release/5.9": {
@@ -606,6 +611,7 @@
                 "swift-installer-scripts": "main",
                 "swift-experimental-string-processing": "swift/main",
                 "wasi-libc": "wasi-sdk-20",
+                "wasmkit": "0.0.3",
                 "curl": "curl-8_4_0",
                 "icu": "maint/maint-69",
                 "libxml2": "v2.11.5",