Windows での Bazel の使用

問題を報告 ソースを表示

このページでは、Windows で Bazel を使用する際のベスト プラクティスについて説明します。インストール手順については、Windows に Bazel をインストールするをご覧ください。

既知の問題

Windows 関連の Bazel の問題は、GitHub で「team-Windows」というラベルが付いています。未解決の問題はこちらで確認できます。

ベスト プラクティス

長いパスの問題を回避する

MSVC コンパイラなど、一部のツールには Windows の最大パス長の制限があります。この問題を回避するには、--output_user_root フラグを使用して Bazel の短い出力ディレクトリを指定します。

たとえば、bazelrc ファイルに次の行を追加します。

startup --output_user_root=C:/tmp

ファイル名のサポート 8.3 を有効にする

Bazel は、長いファイルパスに対して短縮名バージョンを作成しようとします。ただし、これを行うには、長いパスを含むファイルが存在するボリュームで 8.3 ファイル名のサポートを有効にする必要があります。次のコマンドを実行して、すべてのボリュームで 8.3 の名前の作成を有効にできます。

fsutil 8dot3name set 0

一部の機能では、デベロッパー モード（Windows 10 バージョン 1703 以降）を有効にするか、管理者として Bazel を実行して、Windows で Bazel がファイルのシンボリック リンクを作成できるようにする必要があります。これにより、次の機能が有効になります。

より簡単にするために、次の行を bazelrc ファイルに追加します。

startup --windows_enable_symlinks
build --enable_runfiles

注: Windows でのシンボリック リンクの作成は負荷の高いオペレーションです。--enable_runfiles フラグを使用すると、大量のファイルのシンボリック リンクが作成される可能性があります。この機能は、必要な場合にのみ有効にしてください。

Bazel の実行: MSYS2 シェル、コマンド プロンプト、PowerShell

おすすめの方法: コマンド プロンプト（cmd.exe）または PowerShell から Bazel を実行します。

2020-01-15 の時点では、bash から Bazel を実行しないでください（MSYS2 シェル、Git Bash、Cygwin、その他の Bash バリアントから）。Bazel はほとんどのユースケースで機能しますが、MSYS2 から Ctrl+C キーでビルドを中断するなど、一部の動作が破損しています。また、MSYS2 で実行する場合は、MSYS2 の自動パス変換を無効にする必要があります。無効にしないと、MSYS は Unix パス（//foo:bar など）のようなコマンドライン引数（//foo:bar など）を Windows パスに変換します。詳しくは、こちらの StackOverflow の回答をご覧ください。

Bash なしで Bazel を使用する（MSYS2）

Bash を使用せずに bazel ビルドを使用する

1.0 より前のバージョンの Bazel では、Bash で一部のルールをビルドする必要がありました。

Bazel 1.0 以降では、次の場合を除き、Bash を使用せずに任意のルールをビルドできます。

  • genrule（genrules が Bash コマンドを実行するため）
  • sh_binary ルールまたは sh_test ルール（本質的に Bash が必要なため）
  • ctx.actions.run_shell() または ctx.resolve_command() を使用する Starlark ルール

ただし、genrule は、ファイルのコピーやテキスト ファイルの書き込みなどの単純なタスクでよく使用されます。genrule（および Bash によって異なります）を使用する代わりに、bazel-skylib リポジトリに適切なルールがあります。Windows 上でビルドされている場合、これらのルールに Bash は必要ありません。

Bash を使用せずに bazel テストを使用する

1.0 より前のバージョンの Bazel では、Bash で bazel test が必要でした。

Bazel 1.0 以降では、以下を除き、Bash を使用せずにあらゆるルールをテストできます。

  • --run_under を使用する場合
  • テストルール自体には Bash が必要です（実行ファイルがシェル スクリプトであるため）

Bash を使用せずに bazel を実行する

1.0 より前のバージョンの Bazel では、Bash で bazel run が必要でした。

Bazel 1.0 以降では、以下を除き、Bash を使用せずにあらゆるルールを実行できます。

  • --run_under または --script_path を使用する場合
  • テストルール自体には Bash が必要です（実行ファイルがシェル スクリプトであるため）

sh_binary と sh_* のルール、および Bash を使用せずに datastore.actions.run_shell() を使用する

sh_* ルールをビルドしてテストし、ctx.actions.run_shell() と ctx.resolve_command() を使用する Starlark ルールをビルドしてテストするには、Bash が必要です。これは、プロジェクト内のルールだけでなく、プロジェクトが依存している任意の外部リポジトリのルール（推移的であっても）に適用されます。

将来的には、Linux 用 Windows サブシステム（WSL）を使用してこれらのルールを作成するオプションになる可能性がありますが、現時点では Bazel-on-Windows サブチームの優先事項ではありません。

環境変数を設定する

Windows コマンド プロンプト（cmd.exe）で設定した環境変数は、そのコマンド プロンプト セッションでのみ設定されます。新しい cmd.exe を開始する場合は、変数を再度設定する必要があります。cmd.exe の起動時に変数を常に設定するには、Control Panel > System Properties > Advanced > Environment Variables... ダイアログ ボックスで変数をユーザー変数またはシステム変数に追加します。

Windows でビルドする

MSVC を使用して C++ をビルドする

MSVC を使用して C++ ターゲットをビルドするには、次のものが必要です。

  • Visual C++ コンパイラ。

  • （省略可）BAZEL_VC 環境変数と BAZEL_VC_FULL_VERSION 環境変数。

    Bazel は、システム上の Visual C++ コンパイラを自動的に検出します。Bazel に特定の VC インストールを使用するように指示するには、次の環境変数を設定します。

    Visual Studio 2017 と 2019 の場合は、BAZEL_VC のいずれかを設定します。また、BAZEL_VC_FULL_VERSION を設定することもできます。

    • BAZEL_VC: Visual C++ Build Tools のインストール ディレクトリ

      set BAZEL_VC=C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\VC

    • BAZEL_VC_FULL_VERSION（省略可）Visual Studio 2017 と 2019 の場合のみ、Visual C++ Build Tools の完全なバージョン番号。複数のバージョンがインストールされている場合は、BAZEL_VC_FULL_VERSION を使用して Visual C++ Build Tools の正確なバージョンを選択できます。それ以外の場合は、Bazel が最新バージョンを選択します。

      set BAZEL_VC_FULL_VERSION=14.16.27023

    Visual Studio 2015 以前の場合は、BAZEL_VC を設定します。（BAZEL_VC_FULL_VERSION はサポートされていません）。

    • BAZEL_VC: Visual C++ Build Tools のインストール ディレクトリ

      set BAZEL_VC=C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC

  • Windows SDK。

    Windows SDK には、Bazel 自体を含め、Windows アプリケーションのビルドに必要なヘッダー ファイルとライブラリが含まれています。デフォルトでは、インストールされている最新の Windows SDK が使用されます。BAZEL_WINSDK_FULL_VERSION を設定して Windows SDK のバージョンを指定することもできます。Windows 10 SDK の完全な番号（10.0.10240.0 など）を使用することも、Windows 8.1 SDK を使用するために 8.1 を指定することもできます（Windows 8.1 SDK は 1 つのバージョンのみを使用できます）。指定の Windows SDK がインストールされていることを確認してください。

    要件: これは VC 2017 と 2019 でサポートされています。スタンドアロンの VC 2015 ビルドツールは、Windows SDK の選択をサポートしていません。Visual Studio 2015 の完全なインストールが必要です。インストールされていない場合、BAZEL_WINSDK_FULL_VERSION は無視されます。

    set BAZEL_WINSDK_FULL_VERSION=10.0.10240.0

すべての設定が完了したら、C++ ターゲットをビルドできます。

サンプル プロジェクトの 1 つからターゲットを作成してみましょう。

bazel build //examples/cpp:hello-world
bazel-bin\examples\cpp\hello-world.exe

デフォルトでは、ビルドされたバイナリのターゲットは x64 アーキテクチャです。別のターゲット アーキテクチャを指定するには、ターゲット アーキテクチャの --cpu ビルド オプションを設定します。 * x64（デフォルト）: --cpu=x64_windows またはオプションなし * x86: --cpu=x64_x86_windows * ARM: --cpu=x64_arm_windows * ARM64: --cpu=arm64_windows

たとえば、ARM アーキテクチャのターゲットをビルドするには、次のコマンドを実行します。

bazel build //examples/cpp:hello-world --cpu=x64_arm_windows

動的リンク ライブラリ（DLL ファイル）を作成して使用するには、こちらの例をご覧ください。

コマンドラインの長さの上限: Windows のコマンドラインの長さの上限に関する問題を回避するには、--features=compiler_param_file を使用してコンパイラ パラメータ ファイル機能を有効にします。

Clang で C++ をビルドする

0.29.0 以降、Bazel は LLVM の MSVC 互換コンパイラ ドライバ（clang-cl.exe）を使用したビルドをサポートしています。

要件: Clang でビルドするには、LLVM と Visual C++ ビルドツールの両方をインストールする必要があります。これは、コンパイラとして clang-cl.exe を使用しますが、Visual C++ ライブラリへのリンクが必要になるためです。

Bazel では、システムへの LLVM のインストールを自動的に検出できます。また、BAZEL_LLVM によって LLVM のインストール場所を Bazel に明示的に指定することもできます。

  • BAZEL_LLVM: LLVM インストール ディレクトリ

    set BAZEL_LLVM=C:\Program Files\LLVM

C++ のビルドに Clang ツールチェーンを有効にする場合、いくつかの状況が考えられます。

  • bazel 0.28 以前: Clang はサポートされていません。

  • --incompatible_enable_cc_toolchain_resolution を使用しない場合: ビルドフラグ --compiler=clang-cl を使用して Clang ツールチェーンを有効にできます。

  • --incompatible_enable_cc_toolchain_resolution を使用する場合: プラットフォーム ターゲットを BUILD file に追加する必要があります（最上位の BUILD ファイルなど）。

    platform(
    name = "x64_windows-clang-cl",
    constraint_values = [
        "@platforms//cpu:x86_64",
        "@platforms//os:windows",
        "@bazel_tools//tools/cpp:clang-cl",
    ],
)

    その後、次の 2 つの方法のいずれかで Clang ツールチェーンを有効にします。

    • 次のビルドフラグを指定します。
    --extra_toolchains=@local_config_cc//:cc-toolchain-x64_windows-clang-cl --extra_execution_platforms=//:x64_windows-clang-cl
    • プラットフォームとツールチェーンを MODULE.bazel ファイルに登録します。
    register_execution_platforms(
    ":x64_windows-clang-cl"
)

register_toolchains(
    "@local_config_cc//:cc-toolchain-x64_windows-clang-cl",
)

    --incompatible_enable_cc_toolchain_resolution フラグは、今後の Bazel リリースでデフォルトで有効になる予定です。したがって、2 番目のアプローチでは Clang サポートを有効にすることをおすすめします。

Java をビルドする

Java ターゲットをビルドするには、次のものが必要です。

Windows では、Bazel は java_binary ルールに対して次の 2 つの出力ファイルをビルドします。

  • .jar ファイル
  • JVM の環境を設定してバイナリを実行できる .exe ファイル

サンプル プロジェクトの 1 つからターゲットを作成してみましょう。

  bazel build //examples/java-native/src/main/java/com/example/myproject:hello-world
  bazel-bin\examples\java-native\src\main\java\com\example\myproject\hello-world.exe

Python をビルドする

Python ターゲットをビルドするには、次のものが必要です。

Windows では、Bazel は py_binary ルールに対して次の 2 つの出力ファイルをビルドします。

  • 自己解凍形式の zip ファイル
  • 自己解凍形式の zip ファイルを引数として、Python インタープリタを起動できる実行可能ファイル。

実行可能ファイル（.exe 拡張子）を実行するか、自己解凍 zip ファイルを引数として Python を実行できます。

サンプル プロジェクトの 1 つからターゲットを作成してみましょう。

  bazel build //examples/py_native:bin
  bazel-bin\examples\py_native\bin.exe
  python bazel-bin\examples\py_native\bin.zip

Bazel が Windows で Python ターゲットをビルドする方法の詳細については、こちらの設計ドキュメントをご覧ください。