Esta página aborda os requisitos e o layout dos diretórios de saída.
Requisitos
Requisitos para um layout de diretório de saída:
- Não entra em conflito se vários usuários estiverem criando na mesma caixa.
- Permite criar em vários espaços de trabalho ao mesmo tempo.
- Permite criar para várias configurações de destino no mesmo espaço de trabalho.
- Não entra em conflito com outras ferramentas.
- É fácil de acessar.
- É fácil de limpar, até mesmo seletivamente.
- É inequívoco, mesmo que o usuário dependa de links simbólicos ao mudar para o diretório do cliente.
- Todo o estado de build por usuário precisa estar em um diretório ("Quero limpar todos os arquivos .o de todos os meus clientes").
Layout atual
A solução implementada no momento:
- O Bazel precisa ser invocado de um diretório que contenha um arquivo de limite de repositório ou um subdiretório dele. Em outras palavras, o Bazel precisa ser invocado de dentro de um repositório. Caso contrário, um erro será informado.
- O diretório outputRoot usa como padrão ~/.cache/bazel no Linux,
~/Library/Caches/bazelno macOS (ao usar o Bazel 9 e versões mais recentes) e no Windows usa como padrão%HOME%se definido, caso contrário,%USERPROFILE%se definido, caso contrário, o resultado da chamada deSHGetKnownFolderPath()com a sinalizaçãoFOLDERID_Profiledefinida. Se a variável de ambiente$XDG_CACHE_HOMEestiver definida no Linux ou no macOS, o valor${XDG_CACHE_HOME}/bazelvai substituir o padrão. Se a variável de ambiente$TEST_TMPDIRestiver definida, como em um teste do próprio Bazel, esse valor vai substituir todos os padrões.- O Bazel 8.x e versões anteriores no macOS usavam
/private/var/tmpcomo outputRoot e ignoravam$XDG_CACHE_HOME.
- O Bazel 8.x e versões anteriores no macOS usavam
- O estado de build do usuário do Bazel está localizado em
outputRoot/_bazel_$USER. Esse é o diretório outputUserRoot. - Abaixo do diretório
outputUserRoot, há um diretórioinstall, e nele há um diretórioinstallBasecujo nome é o hash MD5 do manifesto de instalação do Bazel. - Abaixo do diretório
outputUserRoot, também é criado um diretóriooutputBasecujo nome é o hash MD5 do caminho da raiz do espaço de trabalho. Por exemplo, se o Bazel estiver sendo executado na raiz do espaço de trabalho/home/user/src/my-project(ou em um diretório com link simbólico para ele), um diretório base de saída será criado chamado:/home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113. Você também pode executarecho -n $(pwd) | md5sumna raiz do espaço de trabalho para receber o MD5. - Você pode usar a opção de inicialização
--output_basedo Bazel para substituir o diretório base de saída padrão. Por exemplo,bazel --output_base=/tmp/bazel/output build x/y:z. - Você também pode usar a opção de inicialização
--output_user_rootdo Bazel para substituir os diretórios padrão de base de instalação e base de saída. Por exemplo,bazel --output_user_root=/tmp/bazel build x/y:z.
Os links simbólicos para "bazel-<workspace-name>", "bazel-out", "bazel-testlogs" e "bazel-bin" são colocados no diretório do espaço de trabalho. Esses links apontam para alguns diretórios dentro de um diretório específico do destino no diretório de saída. Esses links simbólicos são apenas para conveniência do usuário, já que o Bazel não os usa. E isso só acontece se a raiz do espaço de trabalho puder ser gravada.
Diagrama de layout
Os diretórios são organizados da seguinte forma:
<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
O layout dos diretórios *.runfiles é documentado em mais detalhes nos locais indicados por RunfilesSupport.
bazel clean
bazel clean limpa o cache de ações no disco e remove todo o diretório
execroot (que contém a floresta de symlinks e todas as saídas de
build). Ele também remove os symlinks de conveniência do diretório do espaço de trabalho. A opção --expunge limpa todo o outputBase.