プラットフォームとツールチェーンのルール

このルールセットは、ビルド対象の特定のハードウェア プラットフォームをモデル化し、それらのプラットフォームのコードをコンパイルするために必要な特定のツールを指定できるようにするために存在します。ユーザーは、こちらで説明されているコンセプトを理解している必要があります。

ルール

• constraint_setting
• constraint_value
• プラットフォーム
• toolchain
• toolchain_type

constraint_setting

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

このルールは、プラットフォームが値を指定できる新しい制約タイプを導入するために使用されます。たとえば、プラットフォームに異なるバージョンの glibc ライブラリをインストールする機能を表現するために、「glibc_version」という名前の constraint_setting を定義できます。詳細については、プラットフォームのページをご覧ください。

各 constraint_setting には、関連付けられた constraint_value の拡張可能なセットがあります。通常、これらは同じパッケージで定義されますが、別のパッケージで既存の設定に新しい値が導入されることもあります。たとえば、事前定義された設定 @platforms//cpu:cpu をカスタム値で拡張して、不明な CPU アーキテクチャをターゲットとするプラットフォームを定義できます。

引数

constraint_value

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

例

次の例では、CPU アーキテクチャを表す事前定義された constraint_value の新しい使用可能な値を作成します。

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

引数

プラットフォーム

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

このルールは、新しいプラットフォームを定義します。これは、ビルドの一部が実行される環境を記述する制約の選択肢（CPU アーキテクチャやコンパイラ バージョンなど）の名前付きコレクションです。詳細については、プラットフォームのページをご覧ください。

例

これは、ARM で Linux を実行する環境を記述するプラットフォームを定義します。

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

プラットフォームの継承

プラットフォームは、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 を混在させることはできません。非推奨の remote_execution_properties よりも exec_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」を継承し、独自のものを設定しません。
• 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"]
)

引数