このページは Cloud Translation API によって翻訳されました。

プラットフォーム

Bazel では、リンカーやコンパイラなどのさまざまなバージョンのビルドツールを使用して、さまざまなハードウェア、オペレーティングシステム、システム構成でコードのビルドとテストを行うことができます。このような複雑さを管理できるように、Bazel には制約とプラットフォームのコンセプトがあります。制約とは、CPU アーキテクチャ、GPU の有無、システムにインストールされているコンパイラのバージョンなど、ビルド環境または本番環境が異なる可能性がある要素です。プラットフォームは、これらの制約に対する選択肢の名前付き集合であり、一部の環境で使用可能な特定のリソースを表します。

環境をプラットフォームとしてモデル化すると、Bazel はビルドアクションに適したツールチェーンを自動的に選択できるようになります。プラットフォームを config_setting ルールと組み合わせて使用し、構成可能な属性を作成することもできます。

Bazel では、プラットフォームが提供できる次の 3 つのロールが認識されます。

ホスト - Bazel 自体が動作するプラットフォーム。
実行 - ビルドツールがビルドアクションを実行して、中間出力と最終出力を生成するプラットフォーム。
ターゲット - 最終出力が存在し、実行されるプラットフォーム。

Bazel は、プラットフォームに関する次のビルドシナリオをサポートしています。

単一プラットフォームビルド（デフォルト） - ホスト、実行、ターゲットプラットフォームは同じです。たとえば、Intel x64 CPU で動作する Ubuntu で Linux 実行可能ファイルをビルドする場合です。
クロスコンパイルビルド - ホストプラットフォームと実行プラットフォームは同じですが、ターゲットプラットフォームは異なります。たとえば、MacBook Pro で動作する macOS で iOS アプリを作成する場合です。
マルチプラットフォームビルド - ホスト、実行、ターゲットプラットフォームはすべて異なります。

制約とプラットフォームの定義

プラットフォームに選択できるスペースは、BUILD ファイル内の constraint_setting ルールと constraint_value ルールを使用して定義されます。constraint_setting は新しいディメンションを作成し、constraint_value は指定されたディメンションの新しい値を作成します。これらを組み合わせて、列挙型とその指定可能な値を効果的に定義します。たとえば、次の BUILD ファイルのスニペットでは、システムの glibc バージョンに 2 つの有効な値の制約を導入しています。

constraint_setting(name = "glibc_version")

constraint_value(
    name = "glibc_2_25",
    constraint_setting = ":glibc_version",
)

constraint_value(
    name = "glibc_2_26",
    constraint_setting = ":glibc_version",
)

制約とその値は、ワークスペース内のさまざまなパッケージで定義できます。これらはラベルで参照され、通常の公開設定が適用されます。可視性が許す場合は、独自の値を定義して既存の制約設定を拡張できます。

platform ルールは、制約値を特定の選択肢とする新しいプラットフォームを導入します。次の例では、linux_x86 という名前のプラットフォームが作成され、glibc バージョン 2.25 の x86_64 アーキテクチャで Linux オペレーティングシステムを実行する環境が記述されています。（Bazel の組み込み制約について詳しくは、以下をご覧ください）。

platform(
    name = "linux_x86",
    constraint_values = [
        "@platforms//os:linux",
        "@platforms//cpu:x86_64",
        ":glibc_2_25",
    ],
)

一般的に有用な制約とプラットフォーム

エコシステムの一貫性を維持するため、Bazel チームは、最も一般的な CPU アーキテクチャとオペレーティングシステムの制約定義を含むリポジトリを維持しています。これらはすべて https://github.com/bazelbuild/platforms にあります。

Bazel には、特別なプラットフォーム定義（@local_config_platform//:host）が搭載されています。これは自動検出されたホストプラットフォームの値で、Bazel が実行されているシステムで自動検出されたプラットフォームを表します。

ビルドのプラットフォームの指定

次のコマンドラインフラグを使用して、ビルドのホストプラットフォームとターゲットプラットフォームを指定できます。

--host_platform - デフォルトは @bazel_tools//platforms:host_platform です。
--platforms - デフォルトは @bazel_tools//platforms:target_platform です。

互換性のないターゲットのスキップ

特定のターゲットプラットフォーム向けにビルドする場合、そのプラットフォームで動作しないターゲットはスキップするのが望ましい場合がよくあります。たとえば、//... を使用して Linux マシンでビルドすると、Windows デバイスドライバによって多くのコンパイラエラーが発生する可能性が高くなります。target_compatible_with 属性を使用して、コードのターゲットプラットフォームの制約を Bazel に伝えます。

この属性の最も簡単な使用方法は、ターゲットを 1 つのプラットフォームに制限することです。すべての制約を満たさないプラットフォームにはターゲットがビルドされません。次の例では、win_driver_lib.cc を 64 ビット Windows に制限しています。

cc_library(
    name = "win_driver_lib",
    srcs = ["win_driver_lib.cc"],
    target_compatible_with = [
        "@platforms//cpu:x86_64",
        "@platforms//os:windows",
    ],
)

:win_driver_lib は、64 ビット Windows でのビルドにのみ互換性があり、他のすべてとは互換性がありません。非互換性は推移的です。互換性のないターゲットに推移的に依存するターゲット自体は、互換性がないとみなされます。

ターゲットがスキップされるのはどのような場合ですか？

互換性がないと見なされ、ターゲットパターン拡張の一部としてビルドに含まれる場合、ターゲットはスキップされます。たとえば、次の 2 つの呼び出しでは、ターゲットパターンの展開で検出された互換性のないターゲットがスキップされます。

$ bazel build --platforms=//:myplatform //...

$ bazel build --platforms=//:myplatform //:all

同様に、コマンドラインで --expand_test_suites で test_suite が指定されている場合、test_suite 内の互換性のないテストはスキップされます。つまり、コマンドラインの test_suite ターゲットは :all や ... のように動作します。--noexpand_test_suites を使用すると、拡張が行われず、互換性のないテストがある test_suite ターゲットも互換性がなくなります。

コマンドラインで互換性のないターゲットを明示的に指定すると、エラーメッセージが表示され、ビルドが失敗します。

$ bazel build --platforms=//:myplatform //:target_incompatible_with_myplatform
...
ERROR: Target //:target_incompatible_with_myplatform is incompatible and cannot be built, but was explicitly requested.
...
FAILED: Build did NOT complete successfully

表現力の高い制約

制約をより柔軟に表現するには、どのプラットフォームでも一致しない @platforms//:incompatible constraint_value を使用します。

select() を @platforms//:incompatible と組み合わせて使用すると、より複雑な制限を表現できます。たとえば、基本的な OR ロジックを実装するために使用します。次の例では、ライブラリは macOS と Linux と互換性がありますが、他のプラットフォームと互換性はありません。

cc_library(
    name = "unixish_lib",
    srcs = ["unixish_lib.cc"],
    target_compatible_with = select({
        "@platforms//os:osx": [],
        "@platforms//os:linux": [],
        "//conditions:default": ["@platforms//:incompatible"],
    }),
)

上記は次のように解釈できます。

macOS をターゲットとする場合、ターゲットに制約はありません。
Linux をターゲットにしている場合、ターゲットに制約はありません。
それ以外の場合、ターゲットには @platforms//:incompatible 制約が適用されます。@platforms//:incompatible はどのプラットフォームにも属していないため、ターゲットは互換性がないと見なされます。

制約を読みやすくするには、skylib の selects.with_or() を使用します。

逆互換性も同様の方法で表現できます。次の例は、ARM 以外のすべてと互換性のあるライブラリを示しています。

cc_library(
    name = "non_arm_lib",
    srcs = ["non_arm_lib.cc"],
    target_compatible_with = select({
        "@platforms//cpu:arm": ["@platforms//:incompatible"],
        "//conditions:default": [],
    ],
)

`bazel cquery` を使用した互換性のないターゲットの検出

bazel cquery の Starlark 出力形式で IncompatiblePlatformProvider を使用すると、互換性のないターゲットと互換性のあるターゲットを区別できます。

これを使用して、互換性のないターゲットを除外できます。次の例では、互換性のあるターゲットのラベルのみが出力されます。互換性のないターゲットは出力されません。

$ cat example.cquery

def format(target):
  if "IncompatiblePlatformProvider" not in providers(target):
    return target.label
  return ""


$ bazel cquery //... --output=starlark --starlark:file=example.cquery

既知の問題

互換性のないターゲットは、公開設定の制限を無視します。