执行组

<ph type="x-smartling-placeholder"></ph> 报告问题 查看来源 敬上 每晚 · 7.3。 · 7.2 条 · 7.1。 · 7.0。 · 6.5

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

背景

执行组允许规则作者定义一系列操作,其中每个操作都有 可能不同的执行平台。多个执行平台 让操作以不同的方式执行,例如通过遥控器编译 iOS 应用 (linux) 工作器,然后使用本地 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 函数 参数,这是应为其指定依赖项的执行组的名称 。

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

执行组继承

除了定义自己的约束条件和工具链之外,新的执行 组可以声明它想继承规则的默认执行方案 方法是传递 copy_from_rule = True 参数。设置错误 copy_from_rule 设为 true,并同时传递 exec_compatible_withtoolchains

从默认执行组继承的执行组会复制 限制条件、工具链和执行属性。这个 包括在目标级别设置的约束条件和执行属性,而不仅仅是在 规则本身指定的规则也就是说,假设存在以下情况:

# foo.bzl
my_rule = rule(
    _impl,
    exec_groups = {
        copied: exec_group(
            copy_from_rule = True,
            # This will inherit exec_compatible_with and toolchains.
            # Setting them here directly would be an error, however.
        ),
    },
    toolchains = ["//foo_tools:toolchain_type"],
    exec_compatible_with = ["@platforms//os:linux"],
)

# BUILD

my_rule(
    name = "demo",
    exec_compatible_with = [":local_constraint"],
)

已配置目标“demo”的“copied”执行组将包含全部 / - //fool_tools:toolchain_type - @platforms//os:linux - :local_constraint

访问执行组

在规则实施中,您可以声明应在 一个执行组的执行平台为此,您可以使用 exec_group 操作生成方法的参数,具体来说是 ctx.actions.runctx.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++ 链接操作。

创建执行组以设置执行属性

有时,您想要使用执行组为具体操作指定不同的执行 属性,但实际上并不需要与 规则。对于这些情况,您可以使用 copy_from_rule 创建执行组 参数:

# foo.bzl

# Creating an exec group with `copy_from_rule=True` is the same as explicitly
# setting the exec group's toolchains and constraints to the same values as the
# rule's respective parameters.
my_rule = rule(
    _impl,
    exec_compatible_with = ["@platforms//os:linux"],
    toolchains = ["//foo:toolchain_type"],
    exec_groups = {
        # The following two groups have the same toolchains and constraints:
        foo: exec_group(copy_from_rule = True),
        "bar": exec_group(
            exec_compatible_with = ["@platforms//os:linux"],
            toolchains = ["//foo:toolchain_type"],
        ),
    },
)

#

执行组和平台执行属性

可以在以下位置为任意执行组定义 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 的优先级高于 均从执行平台继承