การออกแบบไดเรกทอรีเอาต์พุต

หน้านี้ครอบคลุมข้อกำหนดและเลย์เอาต์สำหรับไดเรกทอรีเอาต์พุต

ข้อกำหนด

ข้อกำหนดสำหรับเลย์เอาต์ไดเรกทอรีเอาต์พุต

• ไม่ขัดแย้งกันหากมีผู้ใช้หลายคนสร้างบนกล่องเดียวกัน
• รองรับการสร้างในพื้นที่ทำงานหลายแห่งพร้อมกัน
• รองรับการสร้างสำหรับการกำหนดค่าเป้าหมายหลายรายการในพื้นที่ทำงานเดียวกัน
• ไม่ทับซ้อนกับเครื่องมืออื่นๆ
• เข้าถึงได้ง่าย
• ทำความสะอาดได้ง่าย แม้จะเป็นแบบเลือกทำความสะอาด
• ชัดเจน แม้ว่าผู้ใช้จะใช้ลิงก์สัญลักษณ์เมื่อเปลี่ยนเป็นไดเรกทอรีไคลเอ็นต์
• สถานะบิลด์ทั้งหมดต่อผู้ใช้ควรอยู่ในไดเรกทอรีเดียว ("ฉันต้องการ ล้างไฟล์ .o ทั้งหมดจากไคลเอ็นต์ของฉันทั้งหมด")

เลย์เอาต์ปัจจุบัน

โซลูชันที่นำมาใช้ในปัจจุบัน:

• คุณต้องเรียกใช้ Bazel จากไดเรกทอรีที่มีไฟล์ WORKSPACE ("ไดเรกทอรีเวิร์กสเปซ") หรือไดเรกทอรีย่อยของไดเรกทอรีนั้น โดยจะรายงานข้อผิดพลาด ไม่
• ไดเรกทอรี outputRoot จะมีค่าเริ่มต้นเป็น ~/.cache/bazel บน Linux /private/var/tmp ใน macOS และ Windows จะมีค่าเริ่มต้นเป็น %HOME% หากตั้งค่าไว้ อื่นๆ %USERPROFILE% หากตั้งค่าไว้ นอกเหนือจากนั้นจะเป็นผลของการโทร SHGetKnownFolderPath() ที่มีการตั้งค่าแฟล็ก FOLDERID_Profile หากมีการตั้งค่าตัวแปรสภาพแวดล้อม $TEST_TMPDIR ไว้ เช่น ในการทดสอบ Bazel เอง ค่าดังกล่าวจะลบล้างค่าเริ่มต้น
• สถานะบิลด์ของผู้ใช้ Bazel อยู่ใต้ outputRoot/_bazel_$USER ซึ่งเรียกว่าไดเรกทอรี outputUserRoot
• ใต้ไดเรกทอรี outputUserRoot จะมีไดเรกทอรี install และใน เป็นไดเรกทอรี installBase ที่ชื่อเป็นแฮช MD5 ของ Bazel ไฟล์ Manifest การติดตั้ง
• ใต้ไดเรกทอรี outputUserRoot ไดเรกทอรี outputBase ก็สร้างขึ้นโดยใช้แฮช MD5 ของชื่อเส้นทางของพื้นที่ทำงานด้วย ไดเรกทอรี ตัวอย่างเช่น หาก Bazel ทำงานอยู่ในไดเรกทอรีพื้นที่ทำงาน /home/user/src/my-project (หรือในไดเรกทอรีที่ลิงก์กับไดเรกทอรีนั้น) จากนั้น ระบบจะสร้างไดเรกทอรีฐานเอาต์พุตชื่อ /home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113 คุณ และยังสามารถเรียกใช้ echo -n $(pwd) | md5sum ในพื้นที่ทำงานของ Bazel เพื่อรับ MD5
• คุณสามารถใช้--output_baseตัวเลือกการเริ่มต้นของ Bazel เพื่อลบล้างไดเรกทอรีฐานเอาต์พุตเริ่มต้นได้ ตัวอย่างเช่น bazel --output_base=/tmp/bazel/output build x/y:z
• นอกจากนี้ คุณยังใช้--output_user_rootตัวเลือกการเริ่มต้นของ Bazel เพื่อลบล้างไดเรกทอรีฐานการติดตั้งและฐานเอาต์พุตเริ่มต้นได้ด้วย ตัวอย่างเช่น bazel --output_user_root=/tmp/bazel build x/y:z

ลิงก์สัญลักษณ์สำหรับ "bazel-<workspace-name>", "bazel-out", "bazel-testlogs" และ "bazel-bin" ไว้ในไดเรกทอรีของ Workspace ลิงก์สัญลักษณ์เหล่านี้จะชี้ไปยัง ไดเรกทอรีภายในไดเรกทอรีเป้าหมายเฉพาะภายในไดเรกทอรีเอาต์พุต ลิงก์สัญลักษณ์เหล่านี้มีไว้เพื่ออำนวยความสะดวกแก่ผู้ใช้เท่านั้น เนื่องจาก Bazel ไม่ได้ใช้ลิงก์เหล่านี้ นอกจากนี้ จะทำได้ต่อเมื่อไดเรกทอรีพื้นที่ทำงานเขียนได้เท่านั้น

แผนภาพเลย์เอาต์

ไดเรกทอรีจะมีรูปแบบดังนี้

<workspace-name>/                         <== The workspace directory
  bazel-my-project => <...my-project>     <== Symlink to execRoot
  bazel-out => <...bin>                   <== 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 directory (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.
      action_outs/                        <== Action output directory. This contains a file with the
                                              stdout/stderr for every action from the most recent
                                              bazel run that produced output.
      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.
        <workspace-name>/                 <== 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
            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
                  <workspace-name>/
                    ...
              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

การออกแบบของไดเรกทอรี *.runfiles จะแสดงรายละเอียดเพิ่มเติมในตำแหน่งที่ RunfilesSupport ชี้ไป

bazel clean

bazel clean ทำการrm -rfใน outputPath และไดเรกทอรี action_cache รวมถึงนำลิงก์สัญลักษณ์ของพื้นที่ทำงานออกด้วย ตัวเลือก --expunge จะล้าง outputBase ทั้งหมด