このページでは、出力ディレクトリの要件とレイアウトについて説明します。
要件
出力ディレクトリ レイアウトの要件:
- 複数のユーザーが同じボックス上でビルドを行っても競合しません。
- 複数のワークスペースで同時に構築できます。
- 同じワークスペースで複数のターゲット構成を構築できます。
- 他のツールと競合しません。
- アクセスしやすい。
- 一部でもお手入れが簡単。
- ユーザーがクライアント ディレクトリに移動したときにシンボリック リンクを使用しても、あいまいさがなくなります。
- ユーザーごとのビルド状態はすべて 1 つのディレクトリの下に配置する必要があります(「すべてのクライアントからすべての .o ファイルを消去したい」)。
現在のレイアウト
現在実装されているソリューション:
- Bazel は、リポジトリ境界ファイルを含むディレクトリまたはそのサブディレクトリから呼び出す必要があります。つまり、Bazel はリポジトリ内から呼び出す必要があります。それ以外の場合は、エラーが報告されます。
- outputRoot ディレクトリのデフォルトは
${XDG_CACHE_HOME}/bazel
(XDG_CACHE_HOME
環境変数が設定されていない場合は~/.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
という出力ベース ディレクトリが作成されます。ワークスペースのルートで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 _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) 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 全体を消去します。