Esta página aborda os requisitos e o layout para 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 construindo na mesma caixa.
- Permite a criação em vários espaços de trabalho ao mesmo tempo.
- Oferece suporte à criação de várias configurações de destino no mesmo espaço de trabalho.
- Não entre em conflito com outras ferramentas.
- seja fácil de acessar;
- É fácil de limpar, mesmo seletivamente.
- Não é ambíguo, mesmo que o usuário dependa de links simbólicos ao mudar para o diretório de cliente.
- Todo o estado do build por usuário precisa estar em um diretório ("Gostaria de limpar todos os arquivos .o de todos os meus clientes").
Layout atual
A solução atualmente implementada:
- O Bazel precisa ser invocado de um diretório que contém um arquivo de limite do 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 será definido como
${XDG_CACHE_HOME}/bazelpor padrão (ou~/.cache/bazel, se a variável de ambienteXDG_CACHE_HOMEnão estiver definida) no Linux,/private/var/tmpno macOS e no Windows como%HOME%se estiver definido. Caso contrário, será%USERPROFILE%se definido. Caso contrário, será o resultado da chamada deSHGetKnownFolderPath()com a sinalizaçãoFOLDERID_Profiledefinida. Se a variável de ambiente$TEST_TMPDIRfor definida, como em um teste do próprio Bazel, esse valor modificará o padrão. - O estado de build do usuário do Bazel fica abaixo de
outputRoot/_bazel_$USER. Isso é chamado de diretório outputUserRoot. - Abaixo do diretório
outputUserRoot, há um diretórioinstalle, nele, há um diretórioinstallBase, cujo nome é o hash MD5 do manifesto de instalação do Bazel. - Abaixo do diretório
outputUserRoot, também é criado um diretóriooutputBase, que tem como nome o hash MD5 do nome do caminho da raiz do espaço de trabalho. Por exemplo, se o Bazel estiver em execução na raiz do espaço de trabalho/home/user/src/my-project(ou em um diretório vinculado a esse), um diretório base de saída será criado chamado:/home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113. Também é possível executarecho -n $(pwd) | md5sumna raiz do espaço de trabalho para conseguir o MD5. - É possível 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. - Também é possível usar a opção de inicialização
--output_user_rootdo Bazel para substituir a base de instalação padrão e os diretórios básicos de saída. Por exemplo,bazel --output_user_root=/tmp/bazel build x/y:z.
Os links simbólicos de "bazel-<workspace-name>", "bazel-out", "bazel-testlogs" e "bazel-bin" são colocados no diretório do espaço de trabalho. Esses links simbólicos apontam para alguns diretórios dentro de um diretório específico de destino dentro do diretório de saída. Esses links simbólicos são apenas para conveniência do usuário, já que o próprio Bazel não os utiliza. Além disso, isso é feito apenas se a raiz do espaço de trabalho for gravável.
Diagrama do layout
Os diretórios são dispostos da seguinte maneira:
<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
O layout dos diretórios *.runfiles está documentado com mais detalhes nos locais indicados pelo RunfilesSupport.
bazel clean
bazel clean faz um rm -rf nos diretórios outputPath e
action_cache. Isso também remove os links simbólicos do espaço de trabalho. A opção --expunge
limpará todo o outputBase.