このページでは、出力ディレクトリの要件とレイアウトについて説明します。
要件
出力ディレクトリ レイアウトの要件:
- 複数のユーザーが同じボックスに構築されていても競合しません。
- 複数のワークスペースで同時に構築が可能。
- 同じワークスペースで複数のターゲット構成のビルドをサポートします。
- 他のツールとの衝突を起こさない。
- 簡単にアクセスできる。
- 選択的であっても簡単に洗浄できる。
- ユーザーがクライアント ディレクトリに移動するときにシンボリック リンクに依存している場合でも、あいまいにならないこと。
- ユーザーごとのすべてのビルド状態は 1 つのディレクトリ内に置く必要があります（「すべてのクライアントからすべての .o ファイルをクリーンアップしたいのですが」）。
現在のレイアウト
現在実装されているソリューションは次のとおりです。
- Bazel は、WORKSPACE ファイルを含むディレクトリ（「ワークスペース ディレクトリ」）またはそのサブディレクトリから呼び出す必要があります。有効になっていない場合はエラーが報告されます。
- outputRoot ディレクトリのデフォルトは、Linux では
~/.cache/bazel、macOS では/private/var/tmp、Windows ではデフォルトで%HOME%に設定され、設定されている場合は%USERPROFILE%になり、それ以外の場合は、FOLDERID_Profileフラグを設定してSHGetKnownFolderPath()を呼び出した結果になります。Bazel 自体のテストのように、環境変数$TEST_TMPDIRが設定されている場合、その値はデフォルトをオーバーライドします。 - Bazel ユーザーのビルド状態は、
outputRoot/_bazel_$USERの下にあります。 これを outputUserRoot ディレクトリといいます。 outputUserRootディレクトリの下にinstallディレクトリがあります。このディレクトリにはinstallBaseディレクトリがあり、名前は Bazel インストール マニフェストの MD5 ハッシュになっています。outputUserRootディレクトリの下にはoutputBaseディレクトリも作成されます。この名前は、ワークスペース ディレクトリのパス名の MD5 ハッシュになります。たとえば、Bazel がワークスペース ディレクトリ/home/user/src/my-project（またはそれにシンボリック リンクされたディレクトリ）で実行されている場合、/home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113という出力ベース ディレクトリが作成されます。- 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 directory
bazel-my-project => <...my-project> <== Symlink to execRoot
bazel-out => <...bin> <== 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
_embedded_binaries/ <== Contains binaries and scripts unpacked from the data section of
the bazel executable on first run (such as helper scripts and the
main Java file BazelServer_deploy.jar)
7ffd56a6e4cb724ea575aba15733d113/ <== Hash of the client's workspace directory (such as
/home/some-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.
action_outs/ <== Action output directory. This contains a file with the
stdout/stderr for every action from the most recent
bazel run that produced output.
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 (such
as socket file, logs, etc) here.
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.
All actions can access its inputs and outputs relative
to the execroot directory.
<workspace-name>/ <== 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
local_linux-fastbuild/ <== one subdirectory per unique target BuildConfiguration instance;
this is currently encoded
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
<workspace-name>/
...
genfiles/ <== Bazel puts generated source for the target configuration here:
$(GENDIR)
foo/bar.h such as foo/bar.h might be a headerfile generated by //foo:bargen
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)
include/ <== a tree with include symlinks, generated as needed. The
bazel-include symlinks point to here. This is used for
linkstamp stuff, etc.
host/ <== BuildConfiguration for build host (user's workstation), for
building prerequisite tools, that will be used in later stages
of the build (ex: Protocol Compiler)
<packages>/ <== Packages referenced in the build appear as if under a regular workspace
*.runfiles ディレクトリのレイアウトについては、RunfilesSupport が参照する場所を参照してください。
bazel clean
bazel clean は outputPath ディレクトリと action_cache ディレクトリに対して rm -rf を実行します。また、ワークスペースのシンボリック リンクも削除されます。--expunge オプションは、outputBase 全体をクリーンアップします。