Tata Letak Direktori Output

Halaman ini membahas persyaratan dan tata letak untuk direktori output.

Persyaratan

Persyaratan untuk tata letak direktori output:

• Tidak akan bentrok jika beberapa pengguna mem-build di kotak yang sama.
• Mendukung pembuatan di beberapa ruang kerja secara bersamaan.
• Mendukung build untuk beberapa konfigurasi target di ruang kerja yang sama.
• Tidak bertentangan dengan alat lain.
• Mudah diakses.
• Mudah dibersihkan, bahkan secara selektif.
• Tidak ambigu, meskipun pengguna mengandalkan link simbolis saat beralih ke direktori klien mereka.
• Semua status build per pengguna harus berada di bawah satu direktori ("Saya ingin menghapus semua file .o dari semua klien saya").

Tata letak saat ini

Solusi yang saat ini diterapkan:

• Bazel harus dipanggil dari direktori yang berisi file batas repo, atau subdirektorinya. Dengan kata lain, Bazel harus dipanggil dari dalam repositori. Jika tidak, error akan dilaporkan.
• Direktori outputRoot secara default adalah ${XDG_CACHE_HOME}/bazel (atau ~/.cache/bazel, jika variabel lingkungan XDG_CACHE_HOME tidak ditetapkan) di Linux, /private/var/tmp di macOS, dan di Windows secara default adalah %HOME% jika ditetapkan, atau %USERPROFILE% jika ditetapkan, atau hasil dari memanggil SHGetKnownFolderPath() dengan tanda FOLDERID_Profile ditetapkan. Jika variabel lingkungan $TEST_TMPDIR ditetapkan, seperti dalam pengujian Bazel itu sendiri, nilai tersebut akan menggantikan nilai default.
• Status build pengguna Bazel terletak di bawah outputRoot/_bazel_$USER. Ini disebut direktori outputUserRoot.
• Di bawah direktori outputUserRoot, terdapat direktori install, dan di dalamnya terdapat direktori installBase yang namanya adalah hash MD5 manifes penginstalan Bazel.
• Di bawah direktori outputUserRoot, direktori outputBase juga dibuat yang namanya adalah hash MD5 dari nama jalur root ruang kerja. Jadi, misalnya, jika Bazel berjalan di root workspace /home/user/src/my-project (atau di direktori yang di-symlink ke direktori tersebut), maka direktori dasar output akan dibuat dan disebut: /home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113. Anda juga dapat menjalankan echo -n $(pwd) | md5sum di root ruang kerja untuk mendapatkan MD5.
• Anda dapat menggunakan opsi startup --output_base Bazel untuk mengganti direktori dasar output default. Misalnya, bazel --output_base=/tmp/bazel/output build x/y:z.
• Anda juga dapat menggunakan opsi startup --output_user_root Bazel untuk mengganti direktori dasar penginstalan dan direktori dasar output default. Contoh: bazel --output_user_root=/tmp/bazel build x/y:z.

Symlink untuk "bazel-<nama-ruang-kerja>", "bazel-out", "bazel-testlogs", dan "bazel-bin" ditempatkan di direktori ruang kerja; symlink ini mengarah ke beberapa direktori di dalam direktori khusus target di dalam direktori output. Symlink ini hanya untuk memudahkan pengguna, karena Bazel itu sendiri tidak menggunakannya. Selain itu, hal ini hanya dilakukan jika root ruang kerja dapat ditulis.

Diagram tata letak

Direktori tersebut ditata sebagai berikut:

<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

Tata letak direktori *.runfiles didokumentasikan secara lebih mendetail di tempat yang ditunjuk oleh RunfilesSupport.

bazel clean

bazel clean melakukan rm -rf pada direktori outputPath dan action_cache. Tindakan ini juga akan menghapus symlink ruang kerja. Opsi --expunge akan membersihkan seluruh outputBase.