Layout do diretório de saída

Informar um problema Acessar a origem

Esta página aborda os requisitos e o layout de diretórios de saída.

Requisitos

Requisitos para um layout de diretório de saída:

  • não colide se vários usuários estiverem criando na mesma caixa.
  • Oferece suporte à criação em vários espaços de trabalho ao mesmo tempo.
  • Compatível com a criação de várias configurações de destino no mesmo espaço de trabalho.
  • Não colidir com nenhuma outra ferramenta.
  • é fácil de acessar;
  • É fácil de limpar, mesmo que seja seletivamente seletiva.
  • seja não ambíguo, 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 ("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 contenha um arquivo de limite do repositório ou um subdiretório dele. Em outras palavras, o Bazel precisa ser invocado dentro de um repositório. Caso contrário, um erro será informado.
  • O diretório outputRoot é definido por padrão como ~/.cache/bazel no Linux e /private/var/tmp no macOS. No Windows, ele é definido como %HOME% por padrão, ou %USERPROFILE%, se definido. Caso contrário, o resultado da chamada de SHGetKnownFolderPath() com a sinalização FOLDERID_Profile definida é %HOME%. Se a variável de ambiente $TEST_TMPDIR estiver definida, como em um teste do próprio Bazel, esse valor modificará o padrão.
  • O estado do 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ório install e, nele, há um diretório installBase com o nome do hash MD5 do manifesto de instalação do Bazel.
  • Abaixo do diretório outputUserRoot, também é criado um diretório outputBase 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 /home/user/src/my-project do espaço de trabalho (ou em um diretório simbólico), um diretório base de saída será criado chamado: /home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113. Também é possível executar echo -n $(pwd) | md5sum na raiz do espaço de trabalho para conseguir o MD5.
  • Use a opção de inicialização --output_base do 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_root do Bazel para substituir os diretórios base de instalação e saída padrão. 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 workspace. Esses links simbólicos apontam para alguns diretórios dentro de um diretório específico do destino dentro do diretório de saída. Esses links simbólicos são apenas para conveniência do usuário, porque o próprio Bazel não os usa. 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 é documentado com mais detalhes nos locais indicados pelo RunfilesSupport.

bazel clean

bazel clean faz um rm -rf no outputPath e no diretório action_cache. Ele também remove os links simbólicos do espaço de trabalho. A opção --expunge limpará todo o outputBase.