Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow the Swift toolchain to be associated with an execution group and pass an optional execution group name down to actions that use it #1318

Merged
merged 1 commit into from
Oct 1, 2024
Merged

Allow the Swift toolchain to be associated with an execution group and pass an optional execution group name down to actions that use it #1318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions doc/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,11 @@ A new attribute dictionary that can be added to the attributes of a
## swift_common.compile

<pre>
swift_common.compile(<a href="#swift_common.compile-actions">actions</a>, <a href="#swift_common.compile-additional_inputs">additional_inputs</a>, <a href="#swift_common.compile-cc_infos">cc_infos</a>, <a href="#swift_common.compile-copts">copts</a>, <a href="#swift_common.compile-defines">defines</a>, <a href="#swift_common.compile-extra_swift_infos">extra_swift_infos</a>,
<a href="#swift_common.compile-feature_configuration">feature_configuration</a>, <a href="#swift_common.compile-generated_header_name">generated_header_name</a>, <a href="#swift_common.compile-is_test">is_test</a>, <a href="#swift_common.compile-include_dev_srch_paths">include_dev_srch_paths</a>,
<a href="#swift_common.compile-module_name">module_name</a>, <a href="#swift_common.compile-objc_infos">objc_infos</a>, <a href="#swift_common.compile-package_name">package_name</a>, <a href="#swift_common.compile-plugins">plugins</a>, <a href="#swift_common.compile-private_swift_infos">private_swift_infos</a>, <a href="#swift_common.compile-srcs">srcs</a>,
<a href="#swift_common.compile-swift_infos">swift_infos</a>, <a href="#swift_common.compile-swift_toolchain">swift_toolchain</a>, <a href="#swift_common.compile-target_name">target_name</a>, <a href="#swift_common.compile-workspace_name">workspace_name</a>)
swift_common.compile(<a href="#swift_common.compile-actions">actions</a>, <a href="#swift_common.compile-additional_inputs">additional_inputs</a>, <a href="#swift_common.compile-cc_infos">cc_infos</a>, <a href="#swift_common.compile-copts">copts</a>, <a href="#swift_common.compile-defines">defines</a>, <a href="#swift_common.compile-exec_group">exec_group</a>,
<a href="#swift_common.compile-extra_swift_infos">extra_swift_infos</a>, <a href="#swift_common.compile-feature_configuration">feature_configuration</a>, <a href="#swift_common.compile-generated_header_name">generated_header_name</a>, <a href="#swift_common.compile-is_test">is_test</a>,
<a href="#swift_common.compile-include_dev_srch_paths">include_dev_srch_paths</a>, <a href="#swift_common.compile-module_name">module_name</a>, <a href="#swift_common.compile-objc_infos">objc_infos</a>, <a href="#swift_common.compile-package_name">package_name</a>, <a href="#swift_common.compile-plugins">plugins</a>,
<a href="#swift_common.compile-private_swift_infos">private_swift_infos</a>, <a href="#swift_common.compile-srcs">srcs</a>, <a href="#swift_common.compile-swift_infos">swift_infos</a>, <a href="#swift_common.compile-swift_toolchain">swift_toolchain</a>, <a href="#swift_common.compile-target_name">target_name</a>,
<a href="#swift_common.compile-workspace_name">workspace_name</a>)
</pre>

Compiles a Swift module.
Expand All @@ -104,6 +105,7 @@ Compiles a Swift module.
| <a id="swift_common.compile-cc_infos"></a>cc_infos | A list of `CcInfo` providers that represent C/Objective-C requirements of the target being compiled, such as Swift-compatible preprocessor defines, header search paths, and so forth. These are typically retrieved from a target's dependencies. | none |
| <a id="swift_common.compile-copts"></a>copts | A list of compiler flags that apply to the target being built. These flags, along with those from Bazel's Swift configuration fragment (i.e., `--swiftcopt` command line flags) are scanned to determine whether whole module optimization is being requested, which affects the nature of the output files. | `[]` |
| <a id="swift_common.compile-defines"></a>defines | Symbols that should be defined by passing `-D` to the compiler. | `[]` |
| <a id="swift_common.compile-exec_group"></a>exec_group | Runs the Swift compilation action under the given execution group's context. If `None`, the default execution group is used. | `None` |
| <a id="swift_common.compile-extra_swift_infos"></a>extra_swift_infos | Extra `SwiftInfo` providers that aren't contained by the `deps` of the target being compiled but are required for compilation. | `[]` |
| <a id="swift_common.compile-feature_configuration"></a>feature_configuration | A feature configuration obtained from `swift_common.configure_features`. | none |
| <a id="swift_common.compile-generated_header_name"></a>generated_header_name | The name of the Objective-C generated header that should be generated for this module. If omitted, no header will be generated. | `None` |
Expand Down Expand Up @@ -161,9 +163,9 @@ A `struct` with the following fields:
## swift_common.compile_module_interface

<pre>
swift_common.compile_module_interface(<a href="#swift_common.compile_module_interface-actions">actions</a>, <a href="#swift_common.compile_module_interface-compilation_contexts">compilation_contexts</a>, <a href="#swift_common.compile_module_interface-feature_configuration">feature_configuration</a>,
<a href="#swift_common.compile_module_interface-module_name">module_name</a>, <a href="#swift_common.compile_module_interface-swiftinterface_file">swiftinterface_file</a>, <a href="#swift_common.compile_module_interface-swift_infos">swift_infos</a>, <a href="#swift_common.compile_module_interface-swift_toolchain">swift_toolchain</a>,
<a href="#swift_common.compile_module_interface-target_name">target_name</a>)
swift_common.compile_module_interface(<a href="#swift_common.compile_module_interface-actions">actions</a>, <a href="#swift_common.compile_module_interface-compilation_contexts">compilation_contexts</a>, <a href="#swift_common.compile_module_interface-exec_group">exec_group</a>,
<a href="#swift_common.compile_module_interface-feature_configuration">feature_configuration</a>, <a href="#swift_common.compile_module_interface-module_name">module_name</a>, <a href="#swift_common.compile_module_interface-swiftinterface_file">swiftinterface_file</a>,
<a href="#swift_common.compile_module_interface-swift_infos">swift_infos</a>, <a href="#swift_common.compile_module_interface-swift_toolchain">swift_toolchain</a>, <a href="#swift_common.compile_module_interface-target_name">target_name</a>)
</pre>

Compiles a Swift module interface.
Expand All @@ -175,6 +177,7 @@ Compiles a Swift module interface.
| :------------- | :------------- | :------------- |
| <a id="swift_common.compile_module_interface-actions"></a>actions | The context's `actions` object. | none |
| <a id="swift_common.compile_module_interface-compilation_contexts"></a>compilation_contexts | A list of `CcCompilationContext`s that represent C/Objective-C requirements of the target being compiled, such as Swift-compatible preprocessor defines, header search paths, and so forth. These are typically retrieved from the `CcInfo` providers of a target's dependencies. | none |
| <a id="swift_common.compile_module_interface-exec_group"></a>exec_group | Runs the Swift compilation action under the given execution group's context. If `None`, the default execution group is used. | `None` |
| <a id="swift_common.compile_module_interface-feature_configuration"></a>feature_configuration | A feature configuration obtained from `swift_common.configure_features`. | none |
| <a id="swift_common.compile_module_interface-module_name"></a>module_name | The name of the Swift module being compiled. This must be present and valid; use `swift_common.derive_module_name` to generate a default from the target's label if needed. | none |
| <a id="swift_common.compile_module_interface-swiftinterface_file"></a>swiftinterface_file | The Swift module interface file to compile. | none |
Expand Down Expand Up @@ -578,7 +581,7 @@ Extracts the symbol graph from a Swift module.
## swift_common.get_toolchain

<pre>
swift_common.get_toolchain(<a href="#swift_common.get_toolchain-ctx">ctx</a>, <a href="#swift_common.get_toolchain-attr">attr</a>)
swift_common.get_toolchain(<a href="#swift_common.get_toolchain-ctx">ctx</a>, <a href="#swift_common.get_toolchain-exec_group">exec_group</a>, <a href="#swift_common.get_toolchain-attr">attr</a>)
</pre>

Gets the Swift toolchain associated with the rule or aspect.
Expand All @@ -589,6 +592,7 @@ Gets the Swift toolchain associated with the rule or aspect.
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="swift_common.get_toolchain-ctx"></a>ctx | The rule or aspect context. | none |
| <a id="swift_common.get_toolchain-exec_group"></a>exec_group | The name of the execution group that should contain the toolchain. If this is provided and the toolchain is not declared in that execution group, it will be looked up from `ctx` as a fallback instead. If this argument is `None` (the default), then the toolchain will only be looked up from `ctx.` | `None` |
| <a id="swift_common.get_toolchain-attr"></a>attr | The name of the attribute on the calling rule or aspect that should be used to retrieve the toolchain if it is not provided by the `toolchains` argument of the rule/aspect. Note that this is only supported for legacy/migration purposes and will be removed once migration to toolchains is complete. | `"_toolchain"` |

**RETURNS**
Expand Down Expand Up @@ -680,9 +684,9 @@ A new attribute dictionary that can be added to the attributes of a
## swift_common.precompile_clang_module

<pre>
swift_common.precompile_clang_module(<a href="#swift_common.precompile_clang_module-actions">actions</a>, <a href="#swift_common.precompile_clang_module-cc_compilation_context">cc_compilation_context</a>, <a href="#swift_common.precompile_clang_module-feature_configuration">feature_configuration</a>,
<a href="#swift_common.precompile_clang_module-module_map_file">module_map_file</a>, <a href="#swift_common.precompile_clang_module-module_name">module_name</a>, <a href="#swift_common.precompile_clang_module-swift_toolchain">swift_toolchain</a>, <a href="#swift_common.precompile_clang_module-target_name">target_name</a>,
<a href="#swift_common.precompile_clang_module-swift_infos">swift_infos</a>)
swift_common.precompile_clang_module(<a href="#swift_common.precompile_clang_module-actions">actions</a>, <a href="#swift_common.precompile_clang_module-cc_compilation_context">cc_compilation_context</a>, <a href="#swift_common.precompile_clang_module-exec_group">exec_group</a>,
<a href="#swift_common.precompile_clang_module-feature_configuration">feature_configuration</a>, <a href="#swift_common.precompile_clang_module-module_map_file">module_map_file</a>, <a href="#swift_common.precompile_clang_module-module_name">module_name</a>,
<a href="#swift_common.precompile_clang_module-swift_toolchain">swift_toolchain</a>, <a href="#swift_common.precompile_clang_module-target_name">target_name</a>, <a href="#swift_common.precompile_clang_module-swift_infos">swift_infos</a>)
</pre>

Precompiles an explicit Clang module that is compatible with Swift.
Expand All @@ -694,6 +698,7 @@ Precompiles an explicit Clang module that is compatible with Swift.
| :------------- | :------------- | :------------- |
| <a id="swift_common.precompile_clang_module-actions"></a>actions | The context's `actions` object. | none |
| <a id="swift_common.precompile_clang_module-cc_compilation_context"></a>cc_compilation_context | A `CcCompilationContext` that contains headers and other information needed to compile this module. This compilation context should contain all headers required to compile the module, which includes the headers for the module itself *and* any others that must be present on the file system/in the sandbox for compilation to succeed. The latter typically refers to the set of headers of the direct dependencies of the module being compiled, which Clang needs to be physically present before it detects that they belong to one of the precompiled module dependencies. | none |
| <a id="swift_common.precompile_clang_module-exec_group"></a>exec_group | Runs the Swift compilation action under the given execution group's context. If `None`, the default execution group is used. | `None` |
| <a id="swift_common.precompile_clang_module-feature_configuration"></a>feature_configuration | A feature configuration obtained from `swift_common.configure_features`. | none |
| <a id="swift_common.precompile_clang_module-module_map_file"></a>module_map_file | A textual module map file that defines the Clang module to be compiled. | none |
| <a id="swift_common.precompile_clang_module-module_name"></a>module_name | The name of the top-level module in the module map that will be compiled. | none |
Expand Down Expand Up @@ -775,7 +780,7 @@ toolchains = swift_common.use_toolchain() + [other toolchains...]

**RETURNS**

A list of toolchain types that should be passed to `rule()` or
`aspect()`.
A list of toolchain types that should be passed to `rule()`, `aspect()`,
or `exec_group`.


5 changes: 5 additions & 0 deletions swift/internal/actions.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,10 @@ def is_action_enabled(action_name, swift_toolchain):
return bool(tool_config)

def run_toolchain_action(
*,
actions,
action_name,
exec_group = None,
feature_configuration,
prerequisites,
swift_toolchain,
Expand All @@ -133,6 +135,8 @@ def run_toolchain_action(
actions: The rule context's `Actions` object, which will be used to
create `Args` objects.
action_name: The name of the action that should be run.
exec_group: Runs the Swift compilation action under the given execution
group's context. If `None`, the default execution group is used.
feature_configuration: A feature configuration obtained from
`swift_common.configure_features`.
mnemonic: The mnemonic to associate with the action. If not provided,
Expand Down Expand Up @@ -206,6 +210,7 @@ def run_toolchain_action(
actions.run(
arguments = [tool_executable_args, args],
env = tool_config.env,
exec_group = exec_group,
executable = executable,
execution_requirements = execution_requirements,
inputs = depset(
Expand Down
17 changes: 17 additions & 0 deletions swift/internal/compiling.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,7 @@ def compile_module_interface(
*,
actions,
compilation_contexts,
exec_group = None,
feature_configuration,
module_name,
swiftinterface_file,
Expand All @@ -219,6 +220,8 @@ def compile_module_interface(
Swift-compatible preprocessor defines, header search paths, and so
forth. These are typically retrieved from the `CcInfo` providers of
a target's dependencies.
exec_group: Runs the Swift compilation action under the given execution
group's context. If `None`, the default execution group is used.
feature_configuration: A feature configuration obtained from
`swift_common.configure_features`.
module_name: The name of the Swift module being compiled. This must be
Expand Down Expand Up @@ -327,6 +330,7 @@ def compile_module_interface(
run_toolchain_action(
actions = actions,
action_name = SWIFT_ACTION_COMPILE_MODULE_INTERFACE,
exec_group = exec_group,
feature_configuration = feature_configuration,
outputs = [swiftmodule_file],
prerequisites = prerequisites,
Expand Down Expand Up @@ -360,6 +364,7 @@ def compile(
cc_infos,
copts = [],
defines = [],
exec_group = None,
extra_swift_infos = [],
feature_configuration,
generated_header_name = None,
Expand Down Expand Up @@ -392,6 +397,8 @@ def compile(
determine whether whole module optimization is being requested,
which affects the nature of the output files.
defines: Symbols that should be defined by passing `-D` to the compiler.
exec_group: Runs the Swift compilation action under the given execution
group's context. If `None`, the default execution group is used.
extra_swift_infos: Extra `SwiftInfo` providers that aren't contained
by the `deps` of the target being compiled but are required for
compilation.
Expand Down Expand Up @@ -708,6 +715,7 @@ to use swift_common.compile(include_dev_srch_paths = ...) instead.\
run_toolchain_action(
actions = actions,
action_name = SWIFT_ACTION_COMPILE,
exec_group = exec_group,
feature_configuration = feature_configuration,
outputs = all_compile_outputs,
prerequisites = prerequisites,
Expand Down Expand Up @@ -753,6 +761,7 @@ to use swift_common.compile(include_dev_srch_paths = ...) instead.\
precompiled_module = _precompile_clang_module(
actions = actions,
cc_compilation_context = compilation_context_to_compile,
exec_group = exec_group,
feature_configuration = feature_configuration,
is_swift_generated_header = True,
module_map_file = compile_outputs.generated_module_map_file,
Expand Down Expand Up @@ -836,6 +845,7 @@ def precompile_clang_module(
*,
actions,
cc_compilation_context,
exec_group = None,
feature_configuration,
module_map_file,
module_name,
Expand All @@ -855,6 +865,8 @@ def precompile_clang_module(
of headers of the direct dependencies of the module being compiled,
which Clang needs to be physically present before it detects that
they belong to one of the precompiled module dependencies.
exec_group: Runs the Swift compilation action under the given execution
group's context. If `None`, the default execution group is used.
feature_configuration: A feature configuration obtained from
`swift_common.configure_features`.
module_map_file: A textual module map file that defines the Clang module
Expand All @@ -875,6 +887,7 @@ def precompile_clang_module(
return _precompile_clang_module(
actions = actions,
cc_compilation_context = cc_compilation_context,
exec_group = exec_group,
feature_configuration = feature_configuration,
is_swift_generated_header = False,
module_map_file = module_map_file,
Expand All @@ -888,6 +901,7 @@ def _precompile_clang_module(
*,
actions,
cc_compilation_context,
exec_group = None,
feature_configuration,
is_swift_generated_header,
module_map_file,
Expand All @@ -908,6 +922,8 @@ def _precompile_clang_module(
of headers of the direct dependencies of the module being compiled,
which Clang needs to be physically present before it detects that
they belong to one of the precompiled module dependencies.
exec_group: Runs the Swift compilation action under the given execution
group's context. If `None`, the default execution group is used.
feature_configuration: A feature configuration obtained from
`swift_common.configure_features`.
is_swift_generated_header: If True, the action is compiling the
Expand Down Expand Up @@ -989,6 +1005,7 @@ def _precompile_clang_module(
run_toolchain_action(
actions = actions,
action_name = SWIFT_ACTION_PRECOMPILE_C_MODULE,
exec_group = exec_group,
feature_configuration = feature_configuration,
outputs = [precompiled_module],
prerequisites = prerequisites,
Expand Down
Loading