En esta página, se describen los requisitos y el diseño para los directorios de salida.
Requisitos
Requisitos para un diseño de directorio de salida:
- No colisione si varios usuarios compilan en la misma caja.
- Permite compilar en varios espacios de trabajo al mismo tiempo.
- Admite la compilación de varios parámetros de configuración de destino en el mismo espacio de trabajo.
- No colisiona con otras herramientas.
- Son de fácil acceso.
- Son fáciles de limpiar, incluso de manera selectiva.
- No genera ambigüedades, incluso si el usuario depende de vínculos simbólicos cuando cambia a su directorio de cliente.
- Todo el estado de compilación por usuario debe estar en un directorio ("quiero limpiar todos los archivos .o de todos mis clientes").
Diseño actual
La solución que se implementa actualmente es la siguiente:
- Se debe invocar Bazel desde un directorio que contenga un archivo de límite de repositorio o un subdirectorio de este. En otras palabras, Bazel debe invocarse desde un repositorio. De lo contrario, se informa un error.
- El directorio outputRoot es
${XDG_CACHE_HOME}/bazel(o~/.cache/bazel, si la variable de entornoXDG_CACHE_HOMEno está configurada) en Linux,/private/var/tmpen macOS y, en Windows, el valor predeterminado es%HOME%si está configurado, de lo contrario%USERPROFILE%si está configurado, o el resultado de la llamada aSHGetKnownFolderPath()con la marcaFOLDERID_Profileestablecida. Si se configura la variable de entorno$TEST_TMPDIR, como en una prueba de Bazel, ese valor anula el valor predeterminado. - El estado de compilación del usuario de Bazel se encuentra debajo de
outputRoot/_bazel_$USER. Esto se denomina directorio outputUserRoot. - Debajo del directorio
outputUserRoot, se encuentra el directorioinstall, que contiene un directorioinstallBasecuyo nombre es el hash MD5 del manifiesto de instalación de Bazel. - Debajo del directorio
outputUserRoot, también se crea un directoriooutputBasecuyo nombre es el hash MD5 del nombre de la ruta de acceso de la raíz del espacio de trabajo. Por ejemplo, si Bazel se ejecuta en la raíz/home/user/src/my-projectdel lugar de trabajo (o en un directorio con symlink a ese directorio), se crea un directorio base de salida llamado/home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113. También puedes ejecutarecho -n $(pwd) | md5sumen la raíz del lugar de trabajo para obtener el MD5. - Puedes usar la opción de inicio
--output_basede Bazel para anular el directorio base de salida predeterminado. Por ejemplo,bazel --output_base=/tmp/bazel/output build x/y:z - También puedes usar la opción de inicio
--output_user_rootde Bazel para anular los directorios base de instalación y base de salida predeterminados. Por ejemplo:bazel --output_user_root=/tmp/bazel build x/y:z
Los symlinks para “bazel-<workspace-name>”, “bazel-out”, “bazel-testlogs” y “bazel-bin” se colocan en el directorio del espacio de trabajo. Estos symlinks apuntan a algunos directorios dentro de un directorio específico de destino dentro del directorio de salida. Estos symlinks son solo para conveniencia del usuario, ya que Bazel no los usa. Además, esto se hace solo si la raíz del lugar de trabajo admite escritura.
Diagrama de diseño
Los directorios se presentan de la siguiente manera:
<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
El diseño de los directorios *.runfiles se documenta con más detalle en los lugares a los que hace referencia RunfilesSupport.
bazel clean
bazel clean realiza una rm -rf en el directorio outputPath y action_cache. También se quitarán los symlinks del espacio de trabajo. La opción --expunge limpiará toda la outputBase.