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 を実行します。これにより、次の機能が有効になります。

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

startup --windows_enable_symlinks
build --enable_runfiles

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

Bazel の実行: MSYS2 シェルとコマンド プロンプト vs. 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）のコマンドライン引数を Windows パスに変換します。詳しくは、Stack Overflow の回答をご覧ください。

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 バージョンでは、bazel test で Bash を使用する必要がありました。

Bazel 1.0 以降では、以下の場合を除き、Bash なしで任意のルールをテストできます。

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

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

1.0 より前の Bazel バージョンでは、bazel run で Bash を使用する必要がありました。

Bazel 1.0 以降では、以下の場合を除き、Bash なしで任意のルールを実行できます。

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

shbinary ルールと sh* ルール、Bash なしの ctx.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++ ビルドツールのフルバージョン番号。複数のバージョンがインストールされている場合は、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 ビルドツールは、Windows SDK の選択をサポートしていません。Visual Studio 2015 を完全にインストールする必要があります。そうしないと、BAZEL_WINSDK_FULL_VERSION は無視されます。

    set BAZEL_WINSDK_FULL_VERSION=10.0.10240.0

すべての設定が完了すると、C++ ターゲットを今すぐ構築できます。

Google のサンプル プロジェクトからターゲットをビルドします。

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

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

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

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

    --compatible_enable_cc_toolchain_resolution フラグは、今後の Bazel リリースでデフォルトで有効になる予定です。そのため、2 番目の方法で Clang のサポートを有効にすることをおすすめします。

Java をビルドする

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

Windows では、Bazel によって java_binary ルール用の 2 つの出力ファイルがビルドされます。

  • .jar ファイル
  • .exe ファイル。JVM 用の環境を設定し、バイナリを実行できます。

Google のサンプル プロジェクトからターゲットをビルドします。

  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 を実行します。

Google のサンプル プロジェクトからターゲットをビルドします。

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

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