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

問題を報告 ソースを表示

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 のルールでは、プラットフォームを使用してツールチェーンを選択します。

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

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

Android

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

つまり、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. 使用するツールチェーンが存在している必要があります。ストック ツールチェーンを使用する場合は、言語の所有者にその登録方法の説明を含める必要があります。独自のカスタム ツールチェーンを作成する場合は、WORKSPACE 内または --extra_toolchains でregisterする必要があります。

  3. select() と構成の遷移を適切に解決する必要があります。select() と遷移をご覧ください。

  4. プラットフォームをサポートしている言語とサポートしていない言語がビルドに混在している場合は、以前の言語を新しい API で機能させるために、プラットフォーム マッピングが必要になることがあります。詳しくは、プラットフォーム マッピングをご覧ください。

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

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

プロジェクト オーナーは、ビルドの対象となるアーキテクチャを記述するための明示的なプラットフォームを定義する必要があります。その後、これらは --platforms でトリガーされます。

--platforms が設定されていない場合、Bazel はデフォルトでローカル ビルドマシンを表す platform になります。これは @local_config_platform//:host に自動生成されるため、明示的に定義する必要はありません。ローカルマシンの 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. ルールロジックでツールチェーン API を使用してツールチェーンを解決します。ツールチェーン 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" など）を宣言します。プロバイダは、これらのツールでビルドする必要があるルールにこの情報を渡します。

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

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

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

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

質問

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

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

関連情報