このページでは、出力ディレクトリの要件とレイアウトについて説明します。
要件
出力ディレクトリのレイアウトの要件:
- 複数のユーザーが同じボックスでビルドする場合でも競合しない。
- 複数のワークスペースで同時にビルドできる。
- 同じワークスペースで複数のターゲット構成のビルドをサポートする。
- 他のツールと競合しない。
- 簡単にアクセスできる。
- 選択的に簡単にクリーンアップできる。
- ユーザーがクライアント ディレクトリに切り替えるときにシンボリック リンクに依存する場合でも、曖昧さがない。
- ユーザーごとのすべてのビルド状態は 1 つのディレクトリの下にある必要がある（「すべてのクライアントからすべての .o ファイルを削除したい」）。
現在のレイアウト
現在実装されているソリューション:
- Bazel は、リポジトリ境界ファイルを含むディレクトリまたはそのサブディレクトリから呼び出す必要があります。つまり、Bazel は リポジトリ内から呼び出す必要があります。そうでない場合は、エラーが報告されます。
- outputRoot ディレクトリのデフォルトは、Linux では ~/.cache/bazel、macOS では
~/Library/Caches/bazel（Bazel 9 以降を使用する場合）、Windows では、設定されている場合は%HOME%、設定されていない場合は%USERPROFILE%、設定されていない場合はFOLDERID_Profileフラグを設定してSHGetKnownFolderPath()を呼び出した結果になります。Linux または macOS で環境変数$XDG_CACHE_HOMEが設定されている場合、値${XDG_CACHE_HOME}/bazelがデフォルトをオーバーライドします。Bazel 自体のテストのように、環境変数$TEST_TMPDIRが設定されている場合、その値はデフォルトをオーバーライドします。- macOS の Bazel 8.x 以前では、
/private/var/tmpが outputRoot として使用され、$XDG_CACHE_HOMEは無視されていました。
- macOS の Bazel 8.x 以前では、
- Bazel ユーザーのビルド状態は
outputRoot/_bazel_$USERの下にあります。 これは outputUserRoot ディレクトリと呼ばれます。 outputUserRootディレクトリの下にinstallディレクトリがあり、その中にinstallBaseディレクトリがあります。このディレクトリの名前は、Bazel インストール マニフェストの MD5 ハッシュです。outputUserRootディレクトリの下に、ワークスペース ルートのパスの MD5 ハッシュを名前とするoutputBaseディレクトリも作成されます。たとえば、Bazel がワークスペース ルート/home/user/src/my-project（またはそのディレクトリにシンボリック リンクされているディレクトリ）で実行されている場合、/home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113という出力ベース ディレクトリが作成されます。ワークスペース ルートでecho -n $(pwd) | md5sumを実行して MD5 を取得することもできます。- Bazel の
--output_base起動オプションを使用して、デフォルトの出力ベース ディレクトリをオーバーライドできます。例:bazel --output_base=/tmp/bazel/output build x/y:z。 - Bazel の
--output_user_root起動オプションを使用して、デフォルトのインストール ベース ディレクトリと出力ベース ディレクトリをオーバーライドすることもできます。例:bazel --output_user_root=/tmp/bazel build x/y:z。
「bazel-<workspace-name>」、「bazel-out」、「bazel-testlogs」、「bazel-bin」のシンボリック リンクはワークスペース ディレクトリに配置されます。これらのシンボリック リンクは、出力ディレクトリ内のターゲット固有のディレクトリ内のディレクトリを指します。 これらのシンボリック リンクは、Bazel 自体では使用されないため、ユーザーの便宜のためにのみ使用されます。また、これはワークスペース ルートが書き込み可能である場合にのみ行われます。
レイアウト図
ディレクトリは次のように配置されます。
<workspace-name>/ <== The workspace root
bazel-my-project => <..._main> <== Symlink to execRoot
bazel-out => <...bazel-out> <== Convenience symlink to outputPath
bazel-bin => <...bin> <== Convenience symlink to most recent written bin dir $(BINDIR)
bazel-testlogs => <...testlogs> <== Convenience symlink to the test logs directory
/home/user/.cache/bazel/ <== Root for all Bazel output on a machine: outputRoot
_bazel_$USER/ <== Top level directory for a given user depends on the user name:
outputUserRoot
install/
fba9a2c87ee9589d72889caf082f1029/ <== Hash of the Bazel install manifest: installBase
A-server.jar <== The main Bazel server Java application, unpacked
from the data section of the bazel executable on first run.
linux-sandbox <== Sandboxing helper binary (platform-specific).
process-wrapper <== Process wrapper binary for action execution.
embedded_tools/ <== Contains the bundled JDK, build tool sources,
and other resources needed by the server.
7ffd56a6e4cb724ea575aba15733d113/ <== Hash of the client's workspace root (such as
/home/user/src/my-project): outputBase
action_cache/ <== Action cache directory hierarchy
This contains the persistent record of the file
metadata (timestamps, and perhaps eventually also MD5
sums) used by the FilesystemValueChecker.
command.log <== A copy of the stdout/stderr output from the most
recent bazel command.
external/ <== The directory that remote repositories are
downloaded/symlinked into.
server/ <== The Bazel server puts all server-related files here
(such as the server PID, the TCP command port,
request/response cookies, and JVM logs).
jvm.out <== The debugging output for the server.
execroot/ <== The working directory for all actions. For special
cases such as sandboxing and remote execution, the
actions run in a directory that mimics execroot.
Implementation details, such as where the directories
are created, are intentionally hidden from the action.
Every action can access its inputs and outputs relative
to the execroot directory.
_main/ <== Working tree for the Bazel build & root of symlink forest: execRoot
_bin/ <== Helper tools are linked from or copied to here.
bazel-out/ <== All actual output of the build is under here: outputPath
_tmp/actions/ <== Action output directory. This contains a file with the
stdout/stderr for every action from the most recent
bazel run that produced output.
k8-fastbuild/ <== One subdirectory per unique target BuildConfiguration instance;
named by a mnemonic encoding the CPU and compilation mode
(such as k8-fastbuild, k8-opt, or k8-dbg). Configurations
with Starlark transitions append an ST-hash suffix
(such as k8-fastbuild-ST-abc123).
bin/ <== Bazel outputs binaries for target configuration here: $(BINDIR)
foo/bar/_objs/baz/ <== Object files for a cc_* rule named //foo/bar:baz
foo/bar/baz1.o <== Object files from source //foo/bar:baz1.cc
other_package/other.o <== Object files from source //other_package:other.cc
foo/bar/baz <== foo/bar/baz might be the artifact generated by a cc_binary named
//foo/bar:baz
foo/bar/baz.runfiles/ <== The runfiles symlink farm for the //foo/bar:baz executable.
MANIFEST
_main/
...
testlogs/ <== Bazel internal test runner puts test log files here
foo/bartest.log such as foo/bar.log might be an output of the //foo:bartest test with
foo/bartest.status foo/bartest.status containing exit status of the test (such as
PASSED or FAILED (Exit 1), etc)
k8-opt-exec/ <== BuildConfiguration for the exec platform, used for
building prerequisite tools (such as the Protocol Compiler)
that will be used in later stages of the build.
<packages>/ <== Packages referenced in the build appear as if under a regular workspace
*.runfiles ディレクトリのレイアウトについては、RunfilesSupport で示されている場所で詳しく説明しています。
bazel clean
bazel clean は、ディスク上のアクション キャッシュをクリアし、execroot ディレクトリ全体（シンボリック リンク フォレストとすべてのビルド出力を含む）を削除します。また、ワークスペース ディレクトリから便利なシンボリック リンクも削除します。--expunge オプションを使用すると、outputBase 全体がクリーンアップされます。