Bố cục thư mục đầu ra

Trang này trình bày các yêu cầu và bố cục cho thư mục đầu ra.

Yêu cầu

Yêu cầu đối với bố cục thư mục đầu ra:

  • Không xung đột nếu nhiều người dùng đang tạo trên cùng một hộp.
  • Hỗ trợ tạo trong nhiều không gian làm việc cùng lúc.
  • Hỗ trợ tạo cho nhiều cấu hình mục tiêu trong cùng một không gian làm việc.
  • Không xung đột với bất kỳ công cụ nào khác.
  • Dễ truy cập.
  • Dễ dọn dẹp, ngay cả khi chọn lọc.
  • Không mơ hồ, ngay cả khi người dùng dựa vào các đường liên kết tượng trưng khi chuyển sang thư mục máy khách.
  • Tất cả trạng thái bản dựng cho mỗi người dùng phải nằm trong một thư mục ("Tôi muốn dọn dẹp tất cả các tệp .o từ tất cả máy khách của mình").

Bố cục hiện tại

Giải pháp hiện đang được triển khai:

  • Bạn phải gọi Bazel từ một thư mục chứa tệp ranh giới kho lưu trữ hoặc một thư mục con của tệp đó. Nói cách khác, bạn phải gọi Bazel từ bên trong một kho lưu trữ. Nếu không, một lỗi sẽ được báo cáo.
  • Thư mục outputRoot mặc định là ~/.cache/bazel trên Linux, ~/Library/Caches/bazel trên macOS (khi sử dụng Bazel 9 trở lên) và trên Windows, thư mục này mặc định là %HOME% nếu được đặt, nếu không thì là %USERPROFILE% nếu được đặt, nếu không thì là kết quả của việc gọi SHGetKnownFolderPath() với cờ FOLDERID_Profile được đặt. Nếu biến môi trường $XDG_CACHE_HOME được đặt trên Linux hoặc macOS, thì giá trị ${XDG_CACHE_HOME}/bazel sẽ ghi đè giá trị mặc định. Nếu biến môi trường $TEST_TMPDIR được đặt, như trong một bài kiểm thử của chính Bazel, thì giá trị đó sẽ ghi đè mọi giá trị mặc định.
    • Xin lưu ý rằng Bazel 8.x trở về trước trên macOS đã sử dụng /private/var/tmp làm outputRoot và bỏ qua $XDG_CACHE_HOME.
  • Trạng thái bản dựng của người dùng Bazel nằm bên dưới outputRoot/_bazel_$USER. Đây được gọi là thư mục outputUserRoot.
  • Bên dưới thư mục outputUserRoot có một thư mục install và trong đó có một thư mục installBase có tên là hàm băm MD5 của tệp kê khai cài đặt Bazel.
  • Bên dưới thư mục outputUserRoot, một thư mục outputBase cũng được tạo có tên là hàm băm MD5 của đường dẫn đến thư mục gốc của không gian làm việc. Vì vậy, ví dụ: nếu Bazel đang chạy trong thư mục gốc của không gian làm việc /home/user/src/my-project (hoặc trong một thư mục được liên kết tượng trưng với thư mục đó), thì một thư mục cơ sở đầu ra sẽ được tạo có tên là: /home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113. Bạn cũng có thể chạy echo -n $(pwd) | md5sum trong thư mục gốc của không gian làm việc để lấy MD5.
  • Bạn có thể sử dụng tuỳ chọn khởi động --output_base của Bazel để ghi đè thư mục cơ sở đầu ra mặc định. Ví dụ: bazel --output_base=/tmp/bazel/output build x/y:z.
  • Bạn cũng có thể sử dụng tuỳ chọn khởi động --output_user_root của Bazel để ghi đè thư mục cơ sở cài đặt và thư mục cơ sở đầu ra mặc định. Ví dụ: bazel --output_user_root=/tmp/bazel build x/y:z.

Các đường liên kết tượng trưng cho "bazel-<workspace-name>", "bazel-out", "bazel-testlogs" và "bazel-bin" được đặt trong thư mục không gian làm việc; các đường liên kết tượng trưng này trỏ đến một số thư mục bên trong một thư mục dành riêng cho mục tiêu bên trong thư mục đầu ra. Các đường liên kết tượng trưng này chỉ nhằm mang lại sự thuận tiện cho người dùng, vì chính Bazel không sử dụng các đường liên kết này. Ngoài ra, thao tác này chỉ được thực hiện nếu thư mục gốc của không gian làm việc có thể ghi.

Sơ đồ bố cục

Các thư mục được bố trí như sau:

<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

Bố cục của các thư mục *.runfiles được ghi lại chi tiết hơn ở những vị trí được RunfilesSupport trỏ đến.

bazel clean

bazel clean sẽ xoá bộ nhớ đệm hành động trên đĩa, sau đó xoá toàn bộ thư mục execroot (chứa rừng liên kết tượng trưng và tất cả đầu ra bản dựng). Thao tác này cũng sẽ xoá các đường liên kết tượng trưng tiện lợi khỏi thư mục không gian làm việc. Tuỳ chọn --expunge sẽ dọn dẹp toàn bộ outputBase.