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

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

ข้อกำหนด

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

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

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

โซลูชันที่ใช้อยู่ในปัจจุบัน:

• ต้องเรียกใช้ Bazel จากไดเรกทอรีที่มีไฟล์ขอบเขตที่เก็บหรือไดเรกทอรีย่อย กล่าวคือ ต้องเรียกใช้ Bazel จากในที่เก็บ ไม่เช่นนั้นระบบจะ รายงานข้อผิดพลาด
• ไดเรกทอรี outputRoot จะมีค่าเริ่มต้นเป็น ${XDG_CACHE_HOME}/bazel (หรือ ~/.cache/bazel หากไม่ได้ตั้งค่าตัวแปรสภาพแวดล้อม XDG_CACHE_HOME ไว้) ใน Linux, /private/var/tmp ใน macOS และใน Windows จะมีค่าเริ่มต้นเป็น %HOME% หากตั้งค่าไว้ หากตั้งค่าอื่นๆ ไว้ %USERPROFILE% หากตั้งค่าไว้ ก็จะทำให้ผลลัพธ์ของการเรียกใช้ SHGetKnownFolderPath() ที่ตั้งค่าแฟล็ก FOLDERID_Profile ไว้ หากมีการตั้งค่าตัวแปรสภาพแวดล้อม $TEST_TMPDIR อย่างเช่นในการทดสอบของ Bazel ค่านั้นจะแทนที่ค่าเริ่มต้น
• สถานะบิลด์ของผู้ใช้ Bazel อยู่ด้านล่าง outputRoot/_bazel_$USER ซึ่งเรียกว่าไดเรกทอรี outputUserRoot
• ใต้ไดเรกทอรี outputUserRoot จะมีไดเรกทอรี install และในไดเรกทอรี installBase ที่มีชื่อเป็นแฮช MD5 ของไฟล์ Manifest สำหรับการติดตั้ง Bazel
• ใต้ไดเรกทอรี outputUserRoot ไดเรกทอรี outputBase จะสร้างขึ้นด้วยที่มีชื่อเป็นแฮช MD5 ของชื่อเส้นทางของรูทพื้นที่ทำงาน ตัวอย่างเช่น หาก Bazel กำลังทำงานในรูทของพื้นที่ทำงาน /home/user/src/my-project (หรือในไดเรกทอรี SymLink ดังกล่าว) ระบบจะสร้างไดเรกทอรีฐานเอาต์พุตชื่อ /home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113 นอกจากนี้คุณยังเรียกใช้ echo -n $(pwd) | md5sum ในรูทของพื้นที่ทำงานเพื่อรับ 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" ไว้ในไดเรกทอรีพื้นที่ทำงาน ลิงก์สัญลักษณ์เหล่านี้จะชี้ไปยังบางไดเรกทอรีภายในไดเรกทอรีเป้าหมายภายในไดเรกทอรีเอาต์พุต ลิงก์สัญลักษณ์เหล่านี้มีไว้เพื่ออำนวยความสะดวกของผู้ใช้เท่านั้น เนื่องจาก Bazel ไม่ได้ใช้ลิงก์ดังกล่าว และจะทำได้ก็ต่อเมื่อรูทของพื้นที่ทำงานเขียนได้

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

ไดเรกทอรีมีโครงสร้างดังนี้

<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

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

bazel clean

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