自动执行组为每种工具链类型选择一个执行平台。换言之,一个目标可以有多个执行平台,而无需定义执行组。
快速摘要
自动执行组与工具链密切相关。如果您使用的是工具链,则需要添加 toolchain
参数,在受影响的操作(使用工具链中的可执行文件或工具的操作)上进行设置。例如:
ctx.actions.run(
...,
executable = ctx.toolchain['@bazel_tools//tools/jdk:toolchain_type'].tool,
...,
toolchain = '@bazel_tools//tools/jdk:toolchain_type',
)
如果操作不使用工具链中的工具或可执行文件,并且 Blaze 未检测到(引发错误),您可以设置 toolchain = None
。
如果您需要在单个执行平台上使用多个工具链(操作使用两个或多个工具链中的可执行文件或工具),则需要手动定义 exec_groups(请参阅何时应该使用自定义 exec_group?部分)。
历史记录
在 AEG 之前,执行平台是在规则级别选择的。例如:
my_rule = rule(
_impl,
toolchains = ['//tools:toolchain_type_1', '//tools:toolchain_type_2'],
)
规则 my_rule
注册了两种工具链类型。这意味着,工具链解析用于查找支持这两种工具链类型的执行平台。除非通过 exec_groups 另有规定,否则所选执行平台会用于规则内每个已注册的操作。换言之,规则中的所有操作都过去只使用一个执行平台,即使它们使用了不同工具链中的工具(为每个目标选择执行平台)。当没有支持所有工具链的执行平台时,这会导致失败。
当前状态
使用 AEG 时,系统会为每种工具链类型选择执行平台。之前示例 my_rule
的实现函数如下所示:
def _impl(ctx):
ctx.actions.run(
mnemonic = "First action",
executable = ctx.toolchain['//tools:toolchain_type_1'].tool,
toolchain = '//tools:toolchain_type_1',
)
ctx.actions.run(
mnemonic = "Second action",
executable = ctx.toolchain['//tools:toolchain_type_2'].tool,
toolchain = '//tools:toolchain_type_2',
)
此规则会创建两项操作:First action
(使用 //tools:toolchain_type_1
中的可执行文件)和 Second action
(使用 //tools:toolchain_type_2
中的可执行文件)。在 AEG 之前,这两项操作都将在支持两种工具链类型的单个执行平台上执行。使用 AEG 时,通过在操作内添加 toolchain
参数,每个操作都会在提供工具链的执行平台上执行。可以在不同的执行平台上执行这些操作。
这同样适用于 ctx.actions.run_shell,其中当 tools
来自工具链时,应添加 toolchain
参数。
自定义执行组与自动执行组之间的区别
顾名思义,AEG 是为规则中注册的每种工具链类型自动创建的执行组。与“经典”exec 组不同,您无需手动指定它们。
何时应使用自定义 exec_group?
只有当多个工具链需要在单个执行平台上执行时,才需要自定义 exec_groups。在所有其他情况下,无需定义自定义 exec_groups。例如:
def _impl(ctx):
ctx.actions.run(
...,
executable = ctx.toolchain['//tools:toolchain_type_1'].tool,
tools = [ctx.toolchain['//tools:toolchain_type_2'].tool],
exec_group = 'two_toolchains',
)
my_rule = rule(
_impl,
exec_groups = {
"two_toolchains": exec_group(
toolchains = ['//tools:toolchain_type_1', '//tools:toolchain_type_2'],
),
}
)
AEG 迁移
在内部,Blaze 已在使用 AEG。在外部,对 Bazel,迁移正在进行中。部分规则(例如 Java 和 C++ 规则)已使用此功能。
哪些 Bazel 版本支持此迁移?
Bazel 7 完全支持 AEG。
如何启用 AEG?
将 --incompatible_auto_exec_groups
设置为 true。如需详细了解该标志,请参阅 GitHub 问题。
如何在特定规则中启用 AEG?
为规则设置 _use_auto_exec_groups
属性。
my_rule = rule(
_impl,
attrs = {
"_use_auto_exec_groups": attr.bool(default = True),
}
)
这样,仅在 my_rule
中启用 AEG,并且其操作会在选择执行平台时开始使用新逻辑。不兼容的标志会被此属性替换。
发生错误时如何停用 AEG?
将 --incompatible_auto_exec_groups
设置为 false 可在项目中完全停用 AEG(标志的 GitHub 问题),或通过将 _use_auto_exec_groups
属性设置为 False
(详细了解该属性)来停用特定规则。
迁移到 AEG 时出现的错误消息
无法确定工具是来自隐式依赖项还是工具链。请设置工具链参数。如果您不使用工具链,请将其设置为“None”。
- 在这种情况下,您会在错误发生之前获得一堆调用,并且可以清楚地看到哪个确切操作需要工具链参数。请检查此操作使用的工具链,并使用 toolchain 参数进行设置。如果未在工具或可执行文件的操作中使用工具链,请将其设置为
None
。
针对不存在的工具链“[toolchain_type]”声明了操作。
- 这意味着,您已在操作上设置了工具链参数,但未在规则中注册它。在操作中注册工具链或设置
None
。
其他资料
如需了解详情,请参阅设计文档:工具链的自动执行组。