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

รายงานปัญหา ดูแหล่งที่มา Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

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

ข้อกำหนด

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

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

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

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

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

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

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

<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)
            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 ทั้งหมด