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

シンボリック リンクのサポートを有効にする

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

• --windows_enable_symlinks
• --enable_runfiles

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

startup --windows_enable_symlinks
build --enable_runfiles

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

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

推奨: コマンド プロンプト（cmd.exe）または PowerShell から Bazel を実行します。

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

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

Bash を使用せずに bazel build を使用する

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 test を使用する

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 が必要（その実行ファイルがシェル スクリプトであるため）

Bash なしで shbinary および sh* ルール、および gsuite.actions.run_shell() を使用する

sh_* ルールのビルドとテスト、ctx.actions.run_shell() と ctx.resolve_command() を使用する Starlark ルールのビルドとテストには Bash が必要です。これは、プロジェクト内のルールだけでなく、プロジェクトが依存する外部リポジトリのルールにも適用されます（転送の場合も同様です）。

将来的には、Windows Subsystem for Linux（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++ コンパイラを自動的に検出します。特定の VC インストールを使用するように Bazel に指示するには、次の環境変数を設定します。

  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 バージョンを指定することもできます。10.0.10240.0 などの完全な Windows 10 SDK 番号を使用することも、8.1 を指定して Windows 8.1 SDK を使用することもできます（Windows 8.1 SDK のバージョンは 1 つだけ使用できます）。指定された Windows SDK がインストールされていることを確認してください。

  要件: これは VC 2017 および 2019 でサポートされています。スタンドアロンの VC 2015 Build Tools は Windows SDK の選択をサポートしていません。Visual Studio 2015 のフルインストールが必要です。そうしないと、BAZEL_WINSDK_FULL_VERSION は無視されます。

  set BAZEL_WINSDK_FULL_VERSION=10.0.10240.0
  

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

サンプル プロジェクトからターゲットを作成してみてください。

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 でビルドするには、コンパイラとして clang-cl.exe を使用しますが、Visual C++ ライブラリにリンクする必要があるため、LLVM と Visual C++ Build Tools の両方をインストールする必要があります。

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

• 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",
      ],
  )
  

  その後、次のいずれかの方法で 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 ターゲットをビルドするには、次が必要です。

• Java SE Development Kit

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

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

サンプル プロジェクトからターゲットを作成してみてください。

  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 ターゲットをビルドするには、次のものが必要です。

• Python インタープリタ

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

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

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

サンプル プロジェクトのいずれかからターゲットをビルドしてみます。

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

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