このページでは、出力ディレクトリの要件とレイアウトについて説明します。
要件
出力ディレクトリ レイアウトの要件:
- 複数のユーザーが同じボックスでビルドしても競合しません。
- 複数のワークスペースでの同時ビルドをサポートします。
- 同じワークスペースで複数のターゲット構成のビルドをサポートします。
- 他のツールと競合しない。
- 簡単にアクセスできます。
- 選択的に簡単にクリーニングできます。
- ユーザーがクライアント ディレクトリに移動する際にシンボリック リンクを使用する場合でも、曖昧さがない。
- ユーザーごとのすべてのビルド状態は 1 つのディレクトリの下にある必要があります(「すべてのクライアントからすべての .o ファイルを削除したい」)。
現在のレイアウト
現在実装されているソリューション:
- Bazel は、リポジトリ境界ファイルを含むディレクトリまたはそのサブディレクトリから呼び出す必要があります。つまり、Bazel はリポジトリ内から呼び出す必要があります。それ以外の場合は、エラーが報告されます。
- outputRoot ディレクトリのデフォルトは、Linux では
~/.cache/bazel
、macOS では/private/var/tmp
です。Windows では、設定されている場合は%HOME%
、設定されていない場合は%USERPROFILE%
、設定されていない場合はFOLDERID_Profile
フラグを設定してSHGetKnownFolderPath()
を呼び出した結果になります。Linux または macOS で環境変数$XDG_CACHE_HOME
が設定されている場合、値${XDG_CACHE_HOME}/bazel
はデフォルトをオーバーライドします。環境変数$TEST_TMPDIR
が設定されている場合(Bazel 自体のテストなど)、その値はデフォルトをオーバーライドします。 - Bazel ユーザーのビルド状態は
outputRoot/_bazel_$USER
の下にあります。これは outputUserRoot ディレクトリと呼ばれます。 outputUserRoot
ディレクトリの下にinstall
ディレクトリがあり、その中に Bazel インストール マニフェストの MD5 ハッシュを名前とするinstallBase
ディレクトリがあります。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-<ワークスペース名>」、「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 _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 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 (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. 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. 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 _main/ ... 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) 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 全体をクリーンアップします。