执行组

执行组允许在单个目标中使用多个执行平台。 每个执行组都有自己的 工具链 依赖项,并 执行自己的 工具链解析

当前状态

对于某些原生声明的操作(例如 CppLink),可以在 exec_properties 中使用执行组来设置每个操作、每个目标的执行 要求。如需了解详情,请参阅 默认执行组部分。

背景

执行组允许规则作者定义一组操作,每个操作可能具有 不同的执行平台。多个执行平台可以允许 操作以不同的方式执行,例如在远程 (Linux) 工作器上编译 iOS 应用,然后在本地 Mac 工作器上进行链接/代码签名。

能够定义操作组还有助于减少使用操作 助记符作为指定操作的代理。助记符不能保证是 唯一的,并且只能引用单个操作。这对于为特定的内存和处理密集型操作(例如 C++ 构建中的链接)分配额外资源非常有用,而不会过度分配给要求较低的任务。

定义执行组

在规则定义期间,规则作者可以 声明 一组执行组。在每个执行组中,规则作者可以指定 为该执行组选择执行平台所需的一切内容, 即通过 exec_compatible_with 指定的任何限制条件,以及通过 toolchain 指定的工具链类型。

# foo.bzl
my_rule = rule(
    _impl,
    exec_groups = {
        "link": exec_group(
            exec_compatible_with = ["@platforms//os:linux"],
            toolchains = ["//foo:toolchain_type"],
        ),
        "test": exec_group(
            toolchains = ["//foo_tools:toolchain_type"],
        ),
    },
    attrs = {
        "_compiler": attr.label(cfg = config.exec("link"))
    },
)

在上面的代码段中,您可以看到工具依赖项还可以使用 为执行组指定转换,使用 cfg 属性参数和 config 模块。该模块公开了一个 exec 函数,该函数接受一个字符串 参数,该参数是应为其构建依赖项的执行组的名称 。

与原生规则一样,test 执行组默认存在于 Starlark 测试规则中。

访问执行组

在规则实现中,您可以声明应在 执行组的执行平台上运行操作。您可以使用操作生成方法(具体而言是 ctx.actions.runctx.actions.run_shell)的 exec_group param 来执行此操作。

# foo.bzl
def _impl(ctx):
  ctx.actions.run(
     inputs = [ctx.attr._some_tool, ctx.srcs[0]]
     exec_group = "compile",
     # ...
  )

规则作者还可以访问执行组的已解析工具链 ,类似于您 访问目标的已解析工具链的方式:

# foo.bzl
def _impl(ctx):
  foo_info = ctx.exec_groups["link"].toolchains["//foo:toolchain_type"].fooinfo
  ctx.actions.run(
     inputs = [foo_info, ctx.srcs[0]]
     exec_group = "link",
     # ...
  )

默认执行组

预定义的执行组如下:

  • test:测试运行器操作(如需了解详情,请参阅 测试百科全书的执行平台部分)。
  • cpp_link:C++ 链接操作。

使用执行组设置执行属性

执行组与每个规则中存在的 exec_properties 属性集成,允许目标编写者指定一个 属性的字符串字典,然后将其传递给执行机制。例如,如果您想为目标设置一些属性(例如内存),并为 某些操作分配更高的内存,则可以编写一个带有执行组扩充键的 exec_properties 条目,例如:

# BUILD
my_rule(
    name = 'my_target',
    exec_properties = {
        'mem': '12g',
        'link.mem': '16g'
    }
    
)

所有带有 exec_group = "link" 的操作都会将执行属性 字典视为 {"mem": "16g"}。如您所见,执行组级 设置会替换目标级设置。

使用执行组设置平台限制条件

执行组还与 exec_compatible_withexec_group_compatible_with 属性集成,这些属性存在于每个规则中,允许目标编写者指定 必须由为目标操作选择的执行平台满足的其他限制条件。

例如,如果规则 my_test 除了默认执行组和 test 执行组之外还定义了 link 执行组,则以下对这些属性的使用将在具有大量 CPU 的平台上运行默认执行组中的操作,在 Linux 上运行测试操作,并在默认执行平台上运行链接操作:

# BUILD
constraint_setting(name = "cpu")
constraint_value(name = "high_cpu", constraint_setting = ":cpu")

platform(
  name = "high_cpu_platform",
  constraint_values = [":high_cpu"],
  exec_properties = {
    "cpu": "256",
  },
)

my_test(
  name = "my_test",
  exec_compatible_with = ["//constraints:high_cpu"],
  exec_group_compatible_with = {
    "test": ["@platforms//os:linux"],
  },
  ...
)

原生规则的执行组

以下执行组可用于原生 规则定义的操作:

  • test:测试运行器操作。
  • cpp_link:C++ 链接操作。

执行组和平台执行属性

可以在 平台目标上为任意执行组定义 exec_properties(与直接在目标上设置的 exec_properties 不同,后者会拒绝未知执行组的属性)。然后,目标会继承影响默认执行组 和任何其他相关执行组的 执行平台的 exec_properties

例如,假设在执行平台上运行测试需要提供某些资源 ,但编译和链接不需要;这可以按如下方式 建模:

constraint_setting(name = "resource")
constraint_value(name = "has_resource", constraint_setting = ":resource")

platform(
    name = "platform_with_resource",
    constraint_values = [":has_resource"],
    exec_properties = {
        "test.resource": "...",
    },
)

cc_test(
    name = "my_test",
    srcs = ["my_test.cc"],
    exec_compatible_with = [":has_resource"],
)

exec_properties 直接在目标上定义的优先于从执行平台继承的 。