平台和工具链规则

这组规则旨在让您能够为正在构建的特定硬件平台建模，并指定可能需要用于为这些平台编译代码的特定工具。用户应熟悉此处说明的概念。

规则

• constraint_setting
• constraint_value
• 平台
• toolchain
• toolchain_type

constraint_setting

constraint_setting(name, default_constraint_value, deprecation, distribs, features, licenses, tags, testonly, visibility)

此规则用于引入平台可以指定值的新约束类型。例如，您可以定义一个名为“glibc_version”的 constraint_setting，以表示平台安装了不同版本的 glibc 库。如需了解详情，请参阅平台页面。

每个 constraint_setting 都有一组可扩展的关联 constraint_value。通常，这些值是在同一软件包中定义的，但有时不同的软件包会为现有设置引入新值。例如，预定义设置 @platforms//cpu:cpu 可以通过自定义值进行扩展，以定义以不常见的 CPU 架构为目标的平台。

参数

constraint_value

constraint_value(name, constraint_setting, deprecation, distribs, features, licenses, tags, testonly, visibility)

示例

以下示例为预定义的 constraint_value（表示 CPU 架构）创建了一个新的可能值。

constraint_value(
    name = "mips",
    constraint_setting = "@platforms//cpu:cpu",
)

参数

平台

platform(name, constraint_values, deprecation, distribs, exec_properties, features, flags, licenses, parents, remote_execution_properties, required_settings, tags, testonly, visibility)

此规则定义了一个新平台，即一组命名的限制选择项（例如 CPU 架构或编译器版本），用于描述部分 build 可能运行的环境。 如需了解详情，请参阅平台页面。

示例

这定义了一个平台，用于描述在 ARM 上运行 Linux 的任何环境。

platform(
    name = "linux_arm",
    constraint_values = [
        "@platforms//os:linux",
        "@platforms//cpu:arm",
    ],
)

平台标志

平台可以使用 flags 属性来指定一个标志列表，每当平台用作目标平台（即作为 --platforms 标志的值）时，这些标志都会添加到配置中。

从平台设置的标志实际上具有最高优先级，并会覆盖该标志的任何先前值（来自命令行、rc 文件或过渡）。

示例

platform(
    name = "foo",
    flags = [
        "--dynamic_mode=fully",
        "--//bool_flag",
        "--no//package:other_bool_flag",
    ],
)

这会定义一个名为 foo 的平台。如果这是目标平台（无论是由于用户指定了 --platforms//:foo，还是由于某个过渡将 //command_line_option:platforms 标志设置为 ["//:foo"]，还是由于 //:foo 被用作执行平台），那么系统会在配置中设置给定的标志。

平台和可重复标志

有些标志在重复使用时会累积值，例如 --features、--copt、以 config.string(repeatable = True) 形式创建的任何 Starlark 标志。 这些标志与从平台设置标志不兼容：相反，所有之前的值都将被移除，并被平台中的值覆盖。

举例来说，假设有以下平台，调用 build --platforms=//:repeat_demo --features feature_a --features feature_b 将导致 --feature 标志的值为 ["feature_c", "feature_d"]，从而移除在命令行中设置的功能。

platform(
    name = "repeat_demo",
    flags = [
        "--features=feature_c",
        "--features=feature_d",
    ],
)

因此，不建议在 flags 属性中使用可重复的标志。

平台继承

平台可以使用 parents 属性来指定它们将从中继承限制值的另一个平台。虽然 parents 属性接受列表，但目前仅支持单个值，指定多个父级会出错。

在平台中检查限制设置的值时，系统会先检查直接设置的值（通过 constraint_values 属性），然后再检查父级上的限制值。此过程会以递归方式继续向上遍历父平台链。这样一来，直接在平台中设置的任何值都会覆盖在父级中设置的值。

平台会从父平台继承 exec_properties 属性。 父平台和子平台的 exec_properties 中的字典条目将被合并。 如果父级和子级的 exec_properties 中都出现了相同的键，系统将使用子级的值。如果子平台将空字符串指定为值，则相应属性将被取消设置。

平台还可以从父平台继承（已弃用）remote_execution_properties 属性。注意：新代码应改用 exec_properties。以下所述的逻辑是为了与旧版行为保持兼容性，但未来会移除。 当存在父平台时，设置 remote_execution_platform 的逻辑如下：

1. 如果未在子平台中设置 remote_execution_property，则使用父平台的 remote_execution_properties。
2. 如果子平台中设置了 remote_execution_property，并且其中包含字面值字符串 {PARENT_REMOTE_EXECUTION_PROPERTIES}，则该宏将被替换为父平台的 remote_execution_property 属性的内容。
3. 如果子平台设置了 remote_execution_property，且不包含该宏，则子平台的 remote_execution_property 将保持不变。

由于 remote_execution_properties 已被废弃并将逐步淘汰，因此不允许在同一继承链中混合使用 remote_execution_properties 和 exec_properties。 建议使用 exec_properties，而不是已弃用的 remote_execution_properties。

示例：限制值

platform(
    name = "parent",
    constraint_values = [
        "@platforms//os:linux",
        "@platforms//cpu:arm",
    ],
)
platform(
    name = "child_a",
    parents = [":parent"],
    constraint_values = [
        "@platforms//cpu:x86_64",
    ],
)
platform(
    name = "child_b",
    parents = [":parent"],
)

在此示例中，子平台的属性如下：

• child_a 具有约束值 @platforms//os:linux（从父级继承）和 @platforms//cpu:x86_64（直接在平台上设置）。
• child_b 从父级继承所有限制值，并且不设置任何自己的限制值。

示例：执行属性

platform(
    name = "parent",
    exec_properties = {
      "k1": "v1",
      "k2": "v2",
    },
)
platform(
    name = "child_a",
    parents = [":parent"],
)
platform(
    name = "child_b",
    parents = [":parent"],
    exec_properties = {
      "k1": "child"
    }
)
platform(
    name = "child_c",
    parents = [":parent"],
    exec_properties = {
      "k1": ""
    }
)
platform(
    name = "child_d",
    parents = [":parent"],
    exec_properties = {
      "k3": "v3"
    }
)

在此示例中，子平台的属性如下：

• child_a 继承父级的“exec_properties”，而不设置自己的“exec_properties”。
• child_b 继承父级的 exec_properties 并替换 k1 的值。其 exec_properties 将为： { "k1": "child", "k2": "v2" }。
• child_c 继承父级的 exec_properties 并取消设置 k1。其 exec_properties 将为： { "k2": "v2" }。
• child_d 继承了父级的 exec_properties 并添加了一个新属性。其 exec_properties 将为： { "k1": "v1", "k2": "v2", "k3": "v3" }。

参数

工具链

toolchain(name, deprecation, distribs, exec_compatible_with, features, licenses, tags, target_compatible_with, target_settings, testonly, toolchain, toolchain_type, visibility)

此规则声明了特定工具链的类型和限制条件，以便在工具链解析期间可以选择该工具链。如需了解详情，请参阅工具链页面。

参数

toolchain_type

toolchain_type(name, compatible_with, deprecation, features, restricted_to, tags, target_compatible_with, testonly, visibility)

此规则定义了一种新的工具链 - 一个简单的目标，表示一类在不同平台上发挥相同作用的工具。

如需了解详情，请参阅工具链页面。

示例

此属性用于为自定义规则定义工具链类型。

toolchain_type(
    name = "bar_toolchain_type",
)

这可以在 bzl 文件中使用。

bar_binary = rule(
    implementation = _bar_binary_impl,
    attrs = {
        "srcs": attr.label_list(allow_files = True),
        ...
        # No `_compiler` attribute anymore.
    },
    toolchains = ["//bar_tools:toolchain_type"]
)

参数