-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
End-to-end support of SDK clang and swift modules (#901)
### What * Reimplemented sdk_clang_module to support interdependency among sdk_clang_modules * Adds rule sdk_swiftmodule_import to support SDK swift modules * Updates xcode_sdk_frameworks to allow a swift_binary to build with explicit SDK modules. Also updates the explicit_modules example to build with SDK modules. ### Test `bazel run --config=explicit_modules example/explicit_module:hello_world`
- Loading branch information
Showing
9 changed files
with
212 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,12 @@ | ||
| load("@build_bazel_rules_swift//swift:swift.bzl", "swift_binary") | ||
| load("//rules/explicit_module:sdk_clang_module.bzl", "sdk_clang_module") | ||
|
|
||
| sdk_clang_module( | ||
| name = "swift_concurrency_shims", | ||
| module_map = "__BAZEL_XCODE_SDKROOT__/usr/lib/swift/shims/module.modulemap", | ||
| module_name = "_SwiftConcurrencyShims", | ||
| ) | ||
|
|
||
| sdk_clang_module( | ||
| name = "shims", | ||
| module_map = "__BAZEL_XCODE_SDKROOT__/usr/lib/swift/shims/module.modulemap", | ||
| module_name = "SwiftShims", | ||
| load( | ||
| "@build_bazel_rules_swift//swift:swift.bzl", | ||
| "swift_binary", | ||
| ) | ||
|
|
||
| swift_binary( | ||
| name = "hello_world", | ||
| srcs = ["main.swift"], | ||
| deps = [ | ||
| ":shims", | ||
| ":swift_concurrency_shims", | ||
| "@xcode_sdk_frameworks//version15_4_0_15F31d/MacOSX:Foundation_swift", | ||
| ], | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,3 @@ | ||
| import Foundation | ||
|
|
||
| print("Hello world") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| load( | ||
| "@build_bazel_rules_swift//swift:swift.bzl", | ||
| "swift_binary", | ||
| "swift_library", | ||
| ) | ||
|
|
||
| swift_binary( | ||
| name = "car", | ||
| srcs = ["main.swift"], | ||
| deps = [":car_module_library"], | ||
| ) | ||
|
|
||
| swift_library( | ||
| name = "car_module_library", | ||
| srcs = ["CarModule.swift"], | ||
| module_name = "CarModule", | ||
| deps = [ | ||
| "@xcode_sdk_frameworks//version15_4_0_15F31d/MacOSX:Foundation_swift", | ||
| ], | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import Foundation | ||
|
|
||
| public struct CarInfo { | ||
| private let number: Int | ||
| private let color: String | ||
|
|
||
|
|
||
| public init(number: Int, color: String) { | ||
| self.number = number | ||
| self.color = color | ||
| } | ||
|
|
||
| public func description() -> String { | ||
| "\(color) \(number)" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| import CarModule | ||
|
|
||
| let car = CarInfo(number: 10, color: "Grey") | ||
| print(car.description()) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,103 @@ | ||
| load("@bazel_skylib//lib:dicts.bzl", "dicts") | ||
| load("@build_bazel_rules_swift//swift/internal:compiling.bzl", "precompile_clang_module") | ||
| load("@build_bazel_rules_swift//swift/internal:feature_names.bzl", "SWIFT_FEATURE_SYSTEM_MODULE") | ||
| load("@build_bazel_rules_swift//swift/internal:providers.bzl", "create_swift_info") | ||
| load( | ||
| "@build_bazel_rules_swift//swift/internal:providers.bzl", | ||
| "SwiftInfo", | ||
| "SwiftToolchainInfo", | ||
| "create_clang_module", | ||
| "create_module", | ||
| "create_swift_info", | ||
| ) | ||
| load("@build_bazel_rules_swift//swift/internal:swift_common.bzl", "swift_common") | ||
| load( | ||
| "@build_bazel_rules_swift//swift/internal:utils.bzl", | ||
| "compilation_context_for_explicit_module_compilation", | ||
| "get_providers", | ||
| ) | ||
|
|
||
| def _sdk_clang_module_impl(ctx): | ||
| compilation_context = cc_common.create_compilation_context() | ||
| compilation_context_to_compile = ( | ||
| compilation_context_for_explicit_module_compilation( | ||
| compilation_contexts = ( | ||
| [compilation_context] | ||
| ), | ||
| deps = ctx.attr.deps, | ||
| ) | ||
| ) | ||
|
|
||
| swift_toolchain = ctx.attr._toolchain[SwiftToolchainInfo] | ||
| requested_features = ctx.features + [SWIFT_FEATURE_SYSTEM_MODULE] | ||
| feature_configuration = swift_common.configure_features( | ||
| ctx = ctx, | ||
| requested_features = requested_features, | ||
| swift_toolchain = swift_toolchain, | ||
| unsupported_features = ctx.disabled_features, | ||
| ) | ||
|
|
||
| swift_infos = get_providers(ctx.attr.deps, SwiftInfo) | ||
|
|
||
| precompiled_module = precompile_clang_module( | ||
| actions = ctx.actions, | ||
| cc_compilation_context = compilation_context_to_compile, | ||
| feature_configuration = feature_configuration, | ||
| module_map_file = ctx.attr.module_map, | ||
| module_name = ctx.attr.module_name, | ||
| swift_infos = swift_infos, | ||
| swift_toolchain = swift_toolchain, | ||
| target_name = ctx.attr.name, | ||
| ) | ||
|
|
||
| return [ | ||
| swift_common.create_swift_interop_info( | ||
| module_map = ctx.attr.module_map, | ||
| module_name = ctx.attr.module_name, | ||
| requested_features = [SWIFT_FEATURE_SYSTEM_MODULE], | ||
| create_swift_info( | ||
| modules = [ | ||
| create_module( | ||
| name = ctx.attr.module_name, | ||
| clang = create_clang_module( | ||
| compilation_context = compilation_context, | ||
| module_map = ctx.attr.module_map, | ||
| precompiled_module = precompiled_module, | ||
| ), | ||
| ), | ||
| ], | ||
| swift_infos = swift_infos, | ||
| ), | ||
| OutputGroupInfo( | ||
| swift_explicit_module = depset([precompiled_module]), | ||
| ), | ||
| # We need to return CcInfo and its compilation_context. We may also consider to update swift_clang_module_aspect. | ||
| # See https://github.com/bazelbuild/rules_swift/blob/d68b21471e4e9d922b75e2b0621082b8ce017d11/swift/internal/swift_clang_module_aspect.bzl#L548 | ||
| CcInfo(compilation_context = cc_common.create_compilation_context()), | ||
| # Required to add sdk_clang_module targets to the deps of swift_module_alias. | ||
| # TODO(cshi): create the SwiftInfo correctly | ||
| create_swift_info(), | ||
| ] | ||
|
|
||
| sdk_clang_module = rule( | ||
| attrs = { | ||
| "deps": attr.label_list( | ||
| doc = "The deps of the SDK clang module", | ||
| ), | ||
| "module_map": attr.string( | ||
| doc = """\ | ||
| The path to a SDK framework module map. | ||
| Variables `__BAZEL_XCODE_SDKROOT__` and `__BAZEL_XCODE_DEVELOPER_DIR__` will be substitued | ||
| appropriately for, i.e. | ||
| `/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk` | ||
| and | ||
| `/Applications/Xcode.app/Contents/Developer` respectively. | ||
| """, | ||
| mandatory = True, | ||
| ), | ||
| "module_name": attr.string( | ||
| doc = """\ | ||
| The name of the top-level module in the module map that this target represents. | ||
| """, | ||
| mandatory = True, | ||
| ), | ||
| }, | ||
| implementation = _sdk_clang_module_impl, | ||
| fragments = ["cpp"], | ||
| attrs = dicts.add( | ||
| swift_common.toolchain_attrs(), | ||
| { | ||
| "deps": attr.label_list( | ||
| doc = "The deps of the SDK clang module", | ||
| providers = [[SwiftInfo]], | ||
| ), | ||
| "module_map": attr.string( | ||
| doc = """\ | ||
| The path to a SDK framework module map. | ||
| Variables `__BAZEL_XCODE_SDKROOT__` and `__BAZEL_XCODE_DEVELOPER_DIR__` will be substitued | ||
| appropriately for, i.e. | ||
| `/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk` | ||
| and | ||
| `/Applications/Xcode.app/Contents/Developer` respectively. | ||
| """, | ||
| mandatory = True, | ||
| ), | ||
| "module_name": attr.string( | ||
| doc = """\ | ||
| The name of the top-level module in the module map that this target represents. | ||
| """, | ||
| mandatory = True, | ||
| ), | ||
| }, | ||
| ), | ||
| doc = """\ | ||
| A rule representing a SDK clang module. It's required for explicit module builds. | ||
| """, | ||
| implementation = _sdk_clang_module_impl, | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| def _sdk_swiftmodule_import_impl(ctx): | ||
| input_swiftmodule = ctx.attr.swiftmodule_path | ||
| if not input_swiftmodule.startswith("/"): | ||
| fail("The swiftmodule_path must be an absolute path") | ||
| if not input_swiftmodule.endswith(".swiftmodule"): | ||
| fail("Expect a .swiftmodule file, but got {}".format(input_swiftmodule)) | ||
|
|
||
| swfitmodule_name = "{}.swiftmodule".format(ctx.attr.module_name) | ||
| output_swiftmodule = ctx.actions.declare_file(swfitmodule_name) | ||
| ctx.actions.run_shell( | ||
| outputs = [output_swiftmodule], | ||
| command = "cp -f \"$1\" \"$2\"", | ||
| arguments = [input_swiftmodule, output_swiftmodule.path], | ||
| execution_requirements = {"no-remote-exec": "1"}, | ||
| mnemonic = "ImportSDKSwiftModule", | ||
| progress_message = "Import SDK swift module {}".format(swfitmodule_name), | ||
| ) | ||
| return [DefaultInfo(files = depset([output_swiftmodule]))] | ||
|
|
||
| sdk_swiftmodule_import = rule( | ||
| implementation = _sdk_swiftmodule_import_impl, | ||
| attrs = { | ||
| "swiftmodule_path": attr.string( | ||
| doc = """\ | ||
| The absolute path to the SDK swiftmodule, e.g., | ||
| /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/iphoneos/prebuilt-modules/17.5/UIKit.swiftmodule. | ||
| """, | ||
| mandatory = True, | ||
| ), | ||
| "module_name": attr.string( | ||
| doc = "The swift module name", | ||
| mandatory = True, | ||
| ), | ||
| }, | ||
| doc = """\ | ||
| A rule imports a SDK swift module and outputs it as a file. It's required for explicit module builds. | ||
| """, | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters