プラットフォーム ルール

ルール

• constraint_setting
• constraint_value
• プラットフォーム
• ツールチェーン
• ツールチェーン_type

constraint_setting

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

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

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

引数

属性
name	Name; required このターゲットの一意の名前。
default_constraint_value	Name; optional; nonconfigurable この設定のデフォルト値のラベル。値が指定されていない場合に使用されます。この属性が存在する場合、それが指す constraint_value は、この constraint_setting と同じパッケージ内で定義する必要があります。 制約設定にデフォルト値がある場合、プラットフォームにその設定の制約値が含まれていない場合は、プラットフォームがデフォルト値を指定した場合と同じになります。デフォルト値がない場合、制約の設定はプラットフォームで指定されていないとみなされます。この場合、プラットフォームはその設定に特定の値を必要とする制約リスト（config_setting など）とは一致しません。

constraint_value

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

このルールでは、特定の制約タイプに対して新しい値を導入します。 詳細については、プラットフォーム ページをご覧ください。

例

以下では、CPU アーキテクチャを表す事前定義された constraint_value に新しい有効な値を作成します。

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

これにより、x86_64 や arm などの代わりに、mips アーキテクチャを使用するプラットフォームを宣言できるようになります。

引数

属性
name	Name; required このターゲットの一意の名前。
constraint_setting	Label; required; nonconfigurable この constraint_value が使用可能な constraint_setting。

プラットフォーム

platform(name, constraint_values, deprecation, distribs, exec_compatible_with, 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 属性にはリストを指定できますが、現時点でサポートされている値は 1 つのみであり、複数の親を指定するとエラーになります。

プラットフォームの制約設定の値をチェックする場合は、まず（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" } になります。

引数

属性
name	Name; required このターゲットの一意の名前。
constraint_values	List of labels; optional このプラットフォームに含まれる制約の選択肢の組み合わせ。プラットフォームを特定の環境に適用するには、環境に少なくともこのリストにある値が含まれている必要があります。 このリストの各 constraint_value は、異なる constraint_setting に対応する必要があります。たとえば、CPU アーキテクチャが @platforms//cpu:x86_64 と @platforms//cpu:arm の両方である必要があるプラットフォームは定義できません。
exec_properties	Dictionary: String -> String; optional アクションのリモート実行方法に影響する文字列のマップ。Bazel はこれを解釈せず、リモート実行プロトコルのプラットフォーム フィールドを介して転送される不透明なデータとして扱われます。これには、親プラットフォームの exec_properties 属性のデータが含まれます。子と親のプラットフォームで同じキーを定義している場合、子の値は保持されます。空の文字列の値に関連付けられたキーは、辞書から削除されます。 この属性は、サポートが終了した remote_execution_properties の完全な代替となります。
parents	List of labels; optional このプラットフォームの継承元となる platform ターゲットのラベル。この属性はリストを受け取りますが、複数のプラットフォームを指定することはできません。このプラットフォームで直接設定されていない constraint_settings は、親プラットフォームで確認できます。詳しくは、プラットフォームの継承をご覧ください。
remote_execution_properties	String; optional 非推奨。代わりに exec_properties 属性を使用してください。 リモート実行プラットフォームを構成するために使用される文字列。実際のビルドではこれを解釈せず、特定の SpawnRunner で使用できる不透明なデータとして扱われます。マクロ「{PARENT_REMOTE_EXECUTION_PROPERTIES}」を使用して、親プラットフォームの「remote_execution_properties」属性のデータを含めることができます。詳しくは、プラットフォームの継承のセクションをご覧ください。

ツールチェーン

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

このルールでは、特定のツールチェーンの型と制約を宣言して、ツールチェーンの解決時に選択できるようにします。詳しくは、ツールチェーンのページをご覧ください。

引数

属性
name	Name; required このターゲットの一意の名前。
exec_compatible_with	List of labels; optional; nonconfigurable constraint_value のリスト。プラットフォーム上のターゲット ビルドでこのツールチェーンを選択するには、実行プラットフォームが満たす必要があります。
target_compatible_with	List of labels; optional; nonconfigurable そのプラットフォームのターゲット ビルドでこのツールチェーンを選択するには、そのプラットフォームが満たす必要がある constraint_value のリストです。
target_settings	List of labels; optional ツールチェーンの解決時にこのツールチェーンを選択するには、ターゲット構成で満たす必要がある config_setting のリストです。
toolchain	Name; required このツールチェーンが選択されたときに使用可能になる実際のツールまたはツールスイートを表すターゲット。
toolchain_type	Label; required; nonconfigurable このツールチェーンが果たす役割を表す toolchain_type ターゲットのラベル。

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"]
)

引数

属性
name	Name; required このターゲットの一意の名前。