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

問題を報告 ソースを表示

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

ルール

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 アーキテクチャをターゲットとするプラットフォームを定義できます。

引数

属性
name

名前（必須）

このターゲットの一意の名前。
default_constraint_value

Name: 構成不可、デフォルトは None

この設定のデフォルト値のラベル。値が指定されていない場合に使用されます。この属性が存在する場合、それがポイントする constraint_value を、この constraint_setting と同じパッケージで定義する必要があります。

制約設定にデフォルト値がある場合、その設定の制約値が含まれていないプラットフォームは、プラットフォームがデフォルト値を指定している場合と同じになります。デフォルト値がない場合、そのプラットフォームでは制約設定が未指定とみなされます。その場合、その設定に特定の値を必要とする制約リスト（config_setting のリストなど）とは一致しません。

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",
)
これにより、プラットフォームは x86_64、arm などの代わりに、mips アーキテクチャを持つことを宣言できます。

引数

属性
name

名前（必須）

このターゲットの一意の名前。
constraint_setting

ラベル、設定不可、必須

この constraint_value が有効な選択肢の constraint_setting。

プラットフォーム

ルールのソースを表示 
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 属性はリストを受け取りますが、現在サポートされている値は 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」を継承します。独自の「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

名前（必須）

このターゲットの一意の名前。
constraint_values

ラベルのリスト。構成できません。デフォルトは [] です。

このプラットフォームに含まれる制約の選択肢の組み合わせ。プラットフォームを特定の環境に適用するには、少なくともこのリストにある値が環境に設定されている必要があります。

このリストの各 constraint_value は、異なる constraint_setting 用である必要があります。たとえば、CPU アーキテクチャが @platforms//cpu:x86_64 と @platforms//cpu:arm の両方であることを必要とするプラットフォームは定義できません。
exec_properties

辞書: 文字列 -> 文字列、設定不可、デフォルトは {}

アクションをリモートで実行する方法に影響を与える文字列のマップ。Bazel はこれを解釈しようとせず、リモート実行プロトコルの Platform フィールドを介して転送される不透明データとして扱われます。これには、親プラットフォームの exec_properties 属性のデータが含まれます。子と親プラットフォームで同じキーを定義している場合、子の値は保持されます。空の文字列の値に関連付けられているキーは、辞書から削除されます。この属性は、サポートが終了した remote_execution_properties に代わるものです。
parents

ラベルのリスト。構成できません。デフォルトは [] です。

このプラットフォームが継承する platform ターゲットのラベル。この属性にはリストを指定できますが、複数のプラットフォームを指定することはできません。このプラットフォームで直接設定されていない constraint_settings は、親プラットフォームで検出されます。 詳しくは、プラットフォームの継承をご覧ください。
remote_execution_properties

文字列、設定不可、デフォルトは ""

非推奨。代わりに exec_properties 属性を使用してください。 リモート実行プラットフォームを構成するために使用される文字列。実際のビルドでは、この解釈は試みられず、特定の SpawnRunner が使用できる不透明なデータとして扱われます。これには、マクロ「{PARENT_REMOTE_EXECUTION_PROPERTIES}」を使用して、親プラットフォームの「remote_execution_properties」属性のデータを含めることができます。詳しくは、プラットフォームの継承をご覧ください。

ツールチェーン

ルールのソースを表示 
toolchain(name, deprecation, distribs, exec_compatible_with, features, licenses, tags, target_compatible_with, target_settings, testonly, toolchain, toolchain_type, visibility)

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

引数

属性
name

名前（必須）

このターゲットの一意の名前。
exec_compatible_with

ラベルのリスト。構成できません。デフォルトは [] です。

プラットフォーム上のターゲット ビルドにツールチェーンを選択するために実行プラットフォームが満たす必要がある constraint_value のリスト。
target_compatible_with

ラベルのリスト。構成できません。デフォルトは [] です。

プラットフォームのターゲット ビルドにツールチェーンを選択するためにターゲット プラットフォームが満たす必要がある constraint_value のリスト。
target_settings

ラベルのリスト。デフォルトは [] です。

ツールチェーンの解決時にこのツールチェーンを選択するためにターゲット構成で満たす必要がある config_setting のリスト。
toolchain

名前（必須）

このツールチェーンが選択されたときに使用可能になる実際のツールまたはツールスイートを表すターゲット。
toolchain_type

ラベル、設定不可、必須

このツールチェーンが果たすロールを表す 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

名前（必須）

このターゲットの一意の名前。