プラットフォームへの移行

Bazel には、マルチアーキテクチャとクロスコンパイル ビルドのプラットフォームとツールチェーンのモデリングに対する高度なサポートがあります。

このページでは、このサポートのステータスについて説明します。

関連項目:

• プラットフォーム
• ツールチェーン
• 背景

ステータス

C++

C++ ルールでは、--incompatible_enable_cc_toolchain_resolution が設定されている場合、プラットフォームを使用してツールチェーンを選択します。

つまり、以下を使用して C++ プロジェクトを構成できます。

bazel build //:my_cpp_project --platforms=//:myplatform

に置き換えます。

bazel build //:my_cpp_project` --cpu=... --crosstool_top=...  --compiler=...

これは Bazel 7.0 でデフォルトで有効になります（#7260）。

プラットフォームで C++ プロジェクトをテストするには、プロジェクトの移行と C++ ツールチェーンの構成をご覧ください。

Java

Java ルールは、プラットフォームを使用して toolchain を選択します。

これは、従来のフラグ --java_toolchain、--host_java_toolchain、--javabase、--host_javabase に代わるものです。

詳しくは、Java と Bazel をご覧ください。

Android

Android ルールは、--incompatible_enable_android_toolchain_resolution が設定されている場合にプラットフォームを使用して toolchain を選択します。

つまり、Android プロジェクトは次のもので構成できます。

bazel build //:my_android_project --android_platforms=//:my_android_platform

--android_crosstool_top、--android_cpu、--fat_apk_cpu などの従来のフラグではなく、

これは Bazel 7.0 でデフォルトで有効になります（#16285）。

複数のプラットフォームで Android プロジェクトをテストするには、プロジェクトの移行をご覧ください。

Apple

Apple のルールはプラットフォームをサポートしていないため、まだサポートはスケジュールされていません。

プラットフォーム マッピングを使用すると、Apple ビルドでプラットフォーム API を引き続き使用できます（Apple ルールと純粋な C++ を組み合わせてビルドする場合など）。

その他の言語

• Go ルールがプラットフォームを完全にサポートしている
• Rust ルールはプラットフォームを完全にサポートしています。

言語ルールセットをお持ちの場合は、ルールセットの移行でサポートを追加する方法をご覧ください。

背景

プラットフォームとツールチェーンが導入され、ソフトウェア プロジェクトがさまざまなアーキテクチャをターゲットにしてクロスコンパイルする方法を標準化しました。

これは、言語メンテナンス担当者がすでに、互換性のないアドホックな方法でこの作業を行っているという観察に基づいています。たとえば、C++ ルールでは --cpu と --crosstool_top を使用して、ターゲット CPU とツールチェーンを宣言していました。どちらも「プラットフォーム」を正しくモデル化していません。これにより、不適切で不適切なビルドが発生しました。

Java、Android、その他の言語では、同様の目的のために独自のフラグが進化しましたが、相互運用は行われませんでした。これにより、クロス ランゲージ ビルドが混乱し、複雑になりました。

Bazel は、大規模なマルチ言語マルチプラットフォーム プロジェクトを対象としています。そのためには、明確な標準 API など、これらのコンセプトをより原則的にサポートする必要があります。

移行の必要性

新しい API へのアップグレードには、API のリリースと、それを使用するためのルールロジックのアップグレードの 2 つの作業が必要です。

1 つ目は完了しましたが、2 つ目はまだ進行中です。これには、言語固有のプラットフォームとツールチェーンが定義されていること、言語ロジックが --crosstool_top などの古いフラグではなく新しい API を介してツールチェーンを読み取ること、config_setting が古いフラグではなく新しい API で選択されることが含まれます。

この作業は簡単ですが、言語ごとに個別の作業が必要であり、今後の変更に対してテストを行うようプロジェクト オーナーに十分な警告が必要です。

そのため、この移行は継続的に行われます。

目標

すべてのプロジェクトが次の形式でビルドされたら、この移行は完了です。

bazel build //:myproject --platforms=//:myplatform

これは以下を意味します。

1. プロジェクトのルールによって、//:myplatform に適したツールチェーンが選択されます。
2. プロジェクトの依存関係によって、//:myplatform に適したツールチェーンが選択されます。
3. //:myplatform は、CPU、OS、その他の汎用で言語に依存しないプロパティの共通宣言を参照します。
4. 関連するすべての select() が //:myplatform と適切に一致している。
5. //:myplatform は、明確でアクセス可能な場所で定義されます。つまり、プラットフォームがプロジェクトに固有の場合はプロジェクトのリポジトリ、またはすべての使用プロジェクトが見つけられる共通の場所です。

--cpu、--crosstool_top、--fat_apk_cpu などの古いフラグは非推奨となり、安全に行える状態になり次第削除されます。

最終的には、これがアーキテクチャを構成する唯一の方法になります。

プロジェクトの移行

プラットフォームをサポートする言語でビルドする場合、ビルドはすでに次のような呼び出しで機能しているはずです。

bazel build //:myproject --platforms=//:myplatform

正確な詳細については、ステータスとご使用の言語のドキュメントをご覧ください。

言語でプラットフォームのサポートを有効にするためにフラグが必要な場合は、そのフラグも設定する必要があります。詳しくは、ステータスをご覧ください。

プロジェクトをビルドするには、次の点を確認する必要があります。

1. //:myplatform が存在している必要があります。プロジェクトによってターゲットとするマシンが異なるため、通常、プラットフォームを定義するのはプロジェクト オーナーの責任です。デフォルトのプラットフォームをご覧ください。

2. 使用する toolchain が存在している必要があります。標準のツールチェーンを使用する場合は、言語オーナーがツールチェーンを登録する手順を記載する必要があります。独自のカスタム ツールチェーンを作成する場合は、WORKSPACE または --extra_toolchains でregisterする必要があります。

3. select() と構成遷移が正しく解決されている必要があります。select() と遷移をご覧ください。

4. ビルドでプラットフォームをサポートする言語とサポートしない言語が混在している場合は、レガシー言語が新しい API と連携できるように、プラットフォームのマッピングが必要になることがあります。詳細については、プラットフォームのマッピングをご覧ください。

それでも問題が解決しない場合は、お問い合わせください。

デフォルトのプラットフォーム

プロジェクト オーナーは、明示的なプラットフォームを定義して、構築するアーキテクチャを記述する必要があります。これらは --platforms でトリガーされます。

--platforms が設定されていない場合、Bazel はデフォルトでローカルビルドマシンを表す platform になります。これは @platforms//host（@bazel_tools//tools:host_platform というエイリアス）で自動生成されるため、明示的に定義する必要はありません。ローカルマシンの OS と CPU を、@platforms で宣言された constraint_value にマッピングします。

select()

プロジェクトは constraint_value ターゲットで select() できますが、完全なプラットフォームでは行えません。これは、select() が可能な限り幅広いマシンをサポートできるように意図されています。ARM 固有のソースを含むライブラリは、より具体的な理由がない限り、ARM を搭載したすべてのマシンをサポートする必要があります。

1 つ以上の constraint_value を選択するには、次を使用します。

config_setting(
    name = "is_arm",
    constraint_values = [
        "@platforms//cpu:arm",
    ],
)

これは、従来どおり --cpu で選択するのと同じです。

config_setting(
    name = "is_arm",
    values = {
        "cpu": "arm",
    },
)

詳しくはこちらをご覧ください。

--cpu、--crosstool_top などの select が --platforms を認識しない。プロジェクトをプラットフォームに移行する場合は、プロジェクトを constraint_values に変換するか、プラットフォーム マッピングを使用して、移行中に両方のスタイルをサポートする必要があります。

切り替え効果

Starlark 遷移は、ビルドグラフの一部でフラグを変更します。プロジェクトで --cpu、--crossstool_top、またはその他の以前のフラグを設定する遷移を使用している場合、--platforms を読み取るルールではこれらの変更は検出されません。

プロジェクトをプラットフォームに移行する場合は、return { "//command_line_option:cpu": "arm" } などの変更を return { "//command_line_option:platforms": "//:my_arm_platform" } に変換するか、プラットフォーム マッピングを使用して、移行中に両方のスタイルをサポートする必要があります。

ルールセットの移行

ルールセットを所有していてプラットフォームをサポートする場合は、次の操作を行う必要があります。

1. ルールロジックで toolchain API を使用して toolchain を解決します。Toolchain API（ctx.toolchains）をご覧ください。

2. 省略可: --incompatible_enable_platforms_for_my_language フラグを定義すると、移行テスト中にルール ロジックが新しい API または古いフラグ（--crosstool_top など）を使用してツールチェーンを交互に解決できるようになります。

3. プラットフォーム コンポーネントを構成する関連プロパティを定義します。共通のプラットフォーム プロパティをご覧ください。

4. 標準ツールチェーンを定義し、ルールの登録手順を通じてユーザーがアクセスできるようにします（詳細）。

5. select() と構成の移行がプラットフォームをサポートしていることを確認します。これは最大の課題です特に、複数言語のプロジェクトでは困難です（すべての言語で --platforms を読み取れない場合は失敗する可能性があります）。

プラットフォームをサポートしていないルールと組み合わせる必要がある場合は、ギャップを埋めるためにプラットフォーム マッピングが必要になることがあります。

共通のプラットフォーム プロパティ

OS や CPU など、言語横断的な一般的なプラットフォーム プロパティは、@platforms で宣言する必要があります。これにより、共有、標準化、言語間の互換性が促進されます。

ルールに固有のプロパティは、ルールのリポジトリで宣言する必要があります。これにより、ルールが担当する特定のコンセプトに対する明確なオーナー権限を維持できます。

ルールでカスタム目的の OS または CPU を使用する場合は、@platforms ではなく、ルールのリポジトリで宣言する必要があります。

プラットフォームのマッピング

プラットフォーム マッピングは、プラットフォーム対応ロジックを同じビルドのレガシー ロジックと混在させることができる一時的な API です。これは、異なる移行期間の非互換性をスムーズにすることを目的とした、単純なツールです。

プラットフォーム マッピングは、platform() と、対応する以前のフラグのセット、またはその逆のマップです。例:

platforms:
  # Maps "--platforms=//platforms:ios" to "--cpu=ios_x86_64 --apple_platform_type=ios".
  //platforms:ios
    --cpu=ios_x86_64
    --apple_platform_type=ios

flags:
  # Maps "--cpu=ios_x86_64 --apple_platform_type=ios" to "--platforms=//platforms:ios".
  --cpu=ios_x86_64
  --apple_platform_type=ios
    //platforms:ios

  # Maps "--cpu=darwin_x86_64 --apple_platform_type=macos" to "//platform:macos".
  --cpu=darwin_x86_64
  --apple_platform_type=macos
    //platforms:macos

Bazel は、これを使用して、プラットフォームベースとレガシーの両方のすべての設定が、移行を含むビルド全体で一貫して適用されるようにします。

デフォルトでは、Bazel はワークスペースのルートにある platform_mappings ファイルからマッピングを読み取ります。--platform_mappings=//:my_custom_mapping を設定することもできます。

詳しくは、プラットフォーム マッピングの設計をご覧ください。

API による審査

platform は、constraint_value ターゲットのコレクションです。

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

constraint_value はマシンのプロパティです。同じ「種類」の値は、共通の constraint_setting の下にグループ化されます。

constraint_setting(name = "os")
constraint_value(
    name = "linux",
    constraint_setting = ":os",
)
constraint_value(
    name = "mac",
    constraint_setting = ":os",
)

toolchain は Starlark ルールです。属性は、言語のツール（compiler = "//mytoolchain:custom_gcc" など）を宣言します。プロバイダは、これらのツールでビルドする必要があるルールにこの情報を渡します。

ツールチェーンは、ターゲットにできるマシンの constraint_value（target_compatible_with = ["@platforms//os:linux"]）と、ツールを実行できるマシンの constraint_value（exec_compatible_with = ["@platforms//os:mac"]）を宣言します。

$ bazel build //:myproject --platforms=//:myplatform をビルドすると、Bazel はビルドマシンで実行できるツールチェーンを選択し、//:myplatform のバイナリをビルドします。これはツールチェーンの解決と呼ばれます。

使用可能な toolchain のセットは、WORKSPACE で register_toolchains を使用して登録するか、コマンドラインで --extra_toolchains を使用して登録できます。

詳しくは、こちらをご覧ください。

質問

一般的なサポートや移行のタイムラインに関する質問については、bazel-discuss または適切なルールのオーナーにお問い合わせください。

プラットフォーム/ツールチェーン API の設計と進化については、bazel-dev にお問い合わせください。

関連情報

• 構成可能なビルド - パート 1
• プラットフォーム
• ツールチェーン
• Bazel Platforms Cookbook
• プラットフォームの例
• C++ ツールチェーンの例