自动执行组 (AEG)

报告问题 查看源代码 每夜 build · 8.2 · 8.1 · 8.0 · 7.6 · 7.5

自动执行组会为每个工具链类型选择一个执行平台。换句话说,一个目标可以有多个执行平台,而无需定义执行组。

快速摘要

自动执行组与工具链密切相关。如果使用工具链,则需要添加 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 是为在规则上注册的每个工具链类型自动创建的执行组。与“传统”执行组不同,您无需手动指定它们。此外,AEG 的名称会自动设置为其工具链类型(例如 //tools:toolchain_type_1)。

何时应使用自定义 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 的迁移

在 google3 内部,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”。

  • 在这种情况下,您会在错误发生之前获得调用堆栈,并且可以清楚地看到哪些确切操作需要工具链参数。检查该操作使用哪个工具链,并使用工具链参数进行设置。如果工具或可执行文件的操作内未使用工具链,请将其设置为 None

针对不存在的工具链“[toolchain_type]”声明了操作。

  • 这意味着您已为操作设置了工具链参数,但未在规则中注册该参数。注册工具链或在操作中设置 None

其他资料

如需了解详情,请参阅设计文档:工具链的自动执行组