执行组

报告问题 查看源代码

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

背景

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

能够定义操作组还有助于减少将操作助记符用作指定操作的代理的情况。助记符不一定是唯一的，只能引用单个操作。这对于将额外的资源分配给特定内存和处理密集型操作（例如在 C++ build 中进行链接）特别有帮助，而不会过度分配给要求不太严格的任务。

定义执行组

在规则定义期间，规则作者可以声明一组执行组。在每个执行组上，规则作者可以指定为该执行组选择执行平台所需的一切信息，即通过 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 函数，该函数接受一个字符串参数，该参数是应为其构建依赖项的 exec 组的名称。

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

访问执行组

在规则实现中，您可以声明操作应在执行组的执行平台上运行。为此，您可以使用操作生成方法的 exec_group 参数，具体来说就是 ctx.actions.run 和 ctx.actions.run_shell。

# 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",
     # ...
  )

使用执行组设置执行属性

执行组与每条规则中存在的 exec_properties 属性集成，并允许目标写入者指定随后传递给执行机器的属性的字符串字典。例如，如果要为目标设置某个属性（例如内存）并为某些操作分配更高的内存分配，您可以写入带有执行组增强键的 exec_properties 条目，例如：

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

具有 exec_group = "link" 的所有操作都将执行属性字典显示为 {"mem": "16g"}。如此处所示，执行组级别的设置会覆盖目标级别的设置。

原生规则的执行组

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

  • test：测试运行程序操作。
  • cpp_link：C++ 链接操作。

执行组和平台执行属性

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

例如，假设运行 C++ 测试需要一些可用的资源，但编译和链接时不需要该资源；可以按以下方式建模：

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 直接在目标上定义的内容优先于从执行平台继承的对象。