หน้านี้ครอบคลุมข้อกำหนดและเลย์เอาต์สำหรับไดเรกทอรีเอาต์พุต
ข้อกำหนด
ข้อกำหนดสำหรับเลย์เอาต์ไดเรกทอรีเอาต์พุตมีดังนี้
- ไม่ขัดแย้งกันหากผู้ใช้หลายคนสร้างในกล่องเดียวกัน
- รองรับการสร้างในหลายพื้นที่ทำงานพร้อมกัน
- รองรับการสร้างสำหรับการกำหนดค่าเป้าหมายหลายรายการในพื้นที่ทํางานเดียวกัน
- ไม่ขัดแย้งกับเครื่องมืออื่นๆ
- เข้าถึงได้ง่าย
- ทำความสะอาดง่าย แม้จะเลือกทำความสะอาดเฉพาะจุดก็ตาม
- มีความชัดเจน แม้ว่าผู้ใช้จะใช้ลิงก์สัญลักษณ์เมื่อเปลี่ยนเป็น ไดเรกทอรีไคลเอ็นต์ก็ตาม
- สถานะการสร้างทั้งหมดต่อผู้ใช้ควรอยู่ภายใต้ไดเรกทอรีเดียว ("ฉันต้องการล้างไฟล์ .o ทั้งหมดจากไคลเอ็นต์ทั้งหมดของฉัน")
เลย์เอาต์ปัจจุบัน
โซลูชันที่ใช้อยู่ในปัจจุบัน
- ต้องเรียกใช้ Bazel จากไดเรกทอรีที่มีไฟล์ขอบเขตของที่เก็บ หรือไดเรกทอรีย่อยของไฟล์ดังกล่าว กล่าวอีกนัยหนึ่งคือต้องเรียกใช้ Bazel จากภายในที่เก็บ ไม่เช่นนั้น ระบบจะรายงานข้อผิดพลาด
- โดยค่าเริ่มต้น ไดเรกทอรี outputRoot จะเป็น ~/.cache/bazel ใน Linux
~/Library/Caches/bazelใน macOS (เมื่อใช้ Bazel 9 ขึ้นไป) และใน Windows จะเป็น%HOME%หากตั้งค่าไว้ หรือ%USERPROFILE%หากตั้งค่าไว้ หรือผลลัพธ์ของการเรียกSHGetKnownFolderPath()โดยตั้งค่าแฟล็กFOLDERID_Profileหากตั้งค่าตัวแปรสภาพแวดล้อม$XDG_CACHE_HOMEใน Linux หรือ macOS ค่า${XDG_CACHE_HOME}/bazelจะ ลบล้างค่าเริ่มต้น หากมีการตั้งค่าตัวแปรสภาพแวดล้อม$TEST_TMPDIRเช่น ในการทดสอบ Bazel เอง ค่าดังกล่าวจะลบล้างค่าเริ่มต้น- โปรดทราบว่า Bazel 8.x และเวอร์ชันก่อนหน้าใน macOS ใช้
/private/var/tmpเป็น outputRoot และไม่สนใจ$XDG_CACHE_HOME
- โปรดทราบว่า Bazel 8.x และเวอร์ชันก่อนหน้าใน macOS ใช้
- สถานะการสร้างของผู้ใช้ 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
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
เลย์เอาต์ของไดเรกทอรี *.runfiles มีการบันทึกรายละเอียดเพิ่มเติมในตำแหน่งที่ RunfilesSupport ชี้ไป
bazel clean
bazel clean จะล้างแคชการดำเนินการในดิสก์ แล้วนำไดเรกทอรี execroot ทั้งหมดออก (ซึ่งมีป่าลิงก์สัญลักษณ์และเอาต์พุตบิลด์ทั้งหมด) นอกจากนี้ยังนำลิงก์สัญลักษณ์ที่สะดวกออกจากไดเรกทอรีพื้นที่ทำงานด้วย
ตัวเลือก --expunge จะล้าง outputBase ทั้งหมด