เอกสารนี้เป็นคำอธิบายโค้ดเบสและโครงสร้างของ Bazel แพ็กเกจนี้มีไว้สำหรับผู้ที่ต้องการมีส่วนร่วมใน Bazel ไม่ใช่สำหรับผู้ใช้ปลายทาง
บทนำ
โค้ดเบสของ Bazel มีขนาดใหญ่ (โค้ดสำหรับใช้งานจริงประมาณ 350,000 บรรทัดโค้ดและโค้ดทดสอบประมาณ 260,000 บรรทัดโค้ด) และไม่มีใครคุ้นเคยกับภาพรวมทั้งหมด ทุกคนรู้จักหุบเขาของตัวเองเป็นอย่างดี แต่มีเพียงไม่กี่คนที่รู้ว่ามีอะไรอยู่หลังเนินเขาทุกทิศทาง
เอกสารนี้จึงพยายามแสดงภาพรวมของฐานของโค้ดเพื่อให้ง่ายต่อการเริ่มทำงา
ซอร์สโค้ดเวอร์ชันสาธารณะของ Bazel อยู่ใน GitHub ที่ github.com/bazelbuild/bazel ข้อมูลนี้ไม่ใช่ "แหล่งข้อมูลที่เป็นความจริง" แต่มาจากต้นไม้แหล่งที่มาภายในของ Google ซึ่งมีฟังก์ชันการทำงานเพิ่มเติมที่ใช้งานไม่ได้นอก Google เป้าหมายระยะยาวคือการทำให้ GitHub เป็นแหล่งข้อมูลที่เชื่อถือได้
เรายอมรับการมีส่วนร่วมผ่านกลไกการดึงคำขอ GitHub ปกติ และ Googler จะนำเข้าข้อมูลไปยังโครงสร้างซอร์สโค้ดภายในด้วยตนเอง จากนั้นจึงส่งออกกลับไปที่ GitHub อีกครั้ง
สถาปัตยกรรมไคลเอ็นต์/เซิร์ฟเวอร์
กลุ่ม Bazel จำนวนมากอยู่ในกระบวนการของเซิร์ฟเวอร์ที่ยังอยู่ใน RAM ระหว่างบิลด์ต่างๆ วิธีนี้ช่วยให้ Bazel รักษาสถานะระหว่างบิลด์ได้
และนี่คือเหตุผลที่บรรทัดคำสั่ง Bazel มีตัวเลือก 2 ประเภท ได้แก่ การเริ่มต้นและคำสั่ง ในบรรทัดคำสั่ง เช่น
bazel --host_jvm_args=-Xmx8G build -c opt //foo:bar
ตัวเลือกบางรายการ (--host_jvm_args=
) จะอยู่ก่อนชื่อคําสั่งที่จะเรียกใช้ และบางรายการจะอยู่หลัง (-c opt
) ตัวเลือกประเภทแรกเรียกว่า "ตัวเลือกการเริ่มต้น" และส่งผลต่อกระบวนการของเซิร์ฟเวอร์โดยรวม ส่วนตัวเลือกประเภทหลังหรือ "ตัวเลือกคําสั่ง" จะส่งผลต่อคําสั่งเดียวเท่านั้น
อินสแตนซ์เซิร์ฟเวอร์แต่ละรายการจะมีพื้นที่ทํางานที่เชื่อมโยงเพียงรายการเดียว (คอลเล็กชันของทรีซอร์สโค้ดที่เรียกว่า "ที่เก็บ") และโดยปกติแล้วพื้นที่ทํางานแต่ละรายการจะมีอินสแตนซ์เซิร์ฟเวอร์ที่ใช้งานอยู่เพียงรายการเดียว ปัญหานี้สามารถหลีกเลี่ยงได้โดยระบุฐานเอาต์พุตที่กำหนดเอง (ดูข้อมูลเพิ่มเติมได้ในส่วน "เลย์เอาต์ไดเรกทอรี")
Bazel มีการเผยแพร่เป็นไฟล์ ELF ปฏิบัติการไฟล์เดียวที่ยังเป็นไฟล์ .zip ที่ถูกต้องด้วย
เมื่อคุณพิมพ์ bazel
ไฟล์ ELF ที่เรียกใช้งานได้ข้างต้นซึ่งเขียนด้วย C++ ("ไคลเอ็นต์") จะควบคุม โดยจะตั้งค่ากระบวนการเซิร์ฟเวอร์ที่เหมาะสมโดยใช้ขั้นตอนต่อไปนี้
- ตรวจสอบว่ามีการแยกตัวเองแล้วหรือไม่ หากไม่ ระบบจะดำเนินการดังกล่าว การติดตั้งใช้งานเซิร์ฟเวอร์จึงเกิดขึ้นจากจุดนี้
- ตรวจสอบว่ามีอินสแตนซ์เซิร์ฟเวอร์ที่ใช้งานอยู่ที่ทำงานได้ไหม อินสแตนซ์นี้ทำงานอยู่ มีตัวเลือกการเริ่มต้นที่ถูกต้อง และใช้ไดเรกทอรีพื้นที่ทำงานที่ถูกต้อง โดยจะหาเซิร์ฟเวอร์ที่กำลังทำงานอยู่โดยดูที่ไดเรกทอรี
$OUTPUT_BASE/server
ซึ่งมีไฟล์ล็อกซึ่งมีพอร์ตที่เซิร์ฟเวอร์นั้นฟังอยู่ - ปิดกระบวนการของเซิร์ฟเวอร์เก่าหากจำเป็น
- หากจำเป็น ให้เริ่มกระบวนการของเซิร์ฟเวอร์ใหม่
หลังจากกระบวนการเซิร์ฟเวอร์ที่เหมาะสมพร้อมใช้งานแล้ว ระบบจะสื่อสารคำสั่งที่ต้องเรียกใช้กับเซิร์ฟเวอร์ผ่านอินเทอร์เฟซ gRPC จากนั้นระบบจะส่งออกของ Bazel กลับไปยังเทอร์มินัล คุณจะเรียกใช้คำสั่งได้ครั้งละ 1 รายการเท่านั้น ซึ่งติดตั้งใช้งานโดยใช้กลไกการล็อกที่ซับซ้อนซึ่งมีบางส่วนเป็น C++ และบางส่วนเป็น Java มีโครงสร้างพื้นฐานบางอย่างสําหรับการเรียกใช้คําสั่งหลายรายการพร้อมกัน เนื่องจากการที่เรียกใช้ bazel version
ควบคู่ไปกับคําสั่งอื่นไม่ได้นั้นเป็นเรื่องที่น่าอาย ปัญหาหลักคือวงจรชีวิตของ BlazeModule
s
และสถานะบางอย่างใน BlazeRuntime
เมื่อสิ้นสุดคําสั่ง เซิร์ฟเวอร์ Bazel จะส่งรหัสออกที่ไคลเอ็นต์ควรแสดง สิ่งที่น่าสนใจคือการใช้ bazel run
: หน้าที่ของคำสั่งนี้คือเรียกใช้สิ่งที่ Bazel เพิ่งสร้าง แต่ทําไม่ได้จากกระบวนการเซิร์ฟเวอร์เนื่องจากไม่มีเทอร์มินัล ดังนั้นจึงบอกไคลเอ็นต์ว่าควรujexec()
ไบนารีใดและด้วยอาร์กิวเมนต์ใดแทน
เมื่อกด Ctrl-C ไคลเอ็นต์จะแปลเป็นคําสั่งยกเลิกในการเชื่อมต่อ gRPC ซึ่งจะพยายามสิ้นสุดคําสั่งโดยเร็วที่สุด หลังจาก Ctrl-C ครั้งที่สาม ไคลเอ็นต์จะส่ง SIGKILL ไปยังเซิร์ฟเวอร์แทน
โค้ดต้นทางของไคลเอ็นต์อยู่ใน src/main/cpp
และโปรโตคอลที่ใช้สื่อสารกับเซิร์ฟเวอร์อยู่ใน src/main/protobuf/command_server.proto
จุดแรกเข้าหลักของเซิร์ฟเวอร์คือ BlazeRuntime.main()
และ GrpcServerImpl.run()
จะจัดการการเรียก gRPC จากไคลเอ็นต์
เลย์เอาต์ไดเรกทอรี
Bazel จะสร้างชุดไดเรกทอรีที่ค่อนข้างซับซ้อนระหว่างการบิลด์ มีคำอธิบายแบบเต็มอยู่ในเลย์เอาต์ไดเรกทอรีเอาต์พุต
"ที่เก็บหลัก" คือแผนผังต้นทาง Bazel ที่มีการเรียกใช้ โดยปกติแล้ว รายการดังกล่าวจะสอดคล้องกับสิ่งที่คุณตรวจสอบออกจากระบบควบคุมแหล่งที่มา รูทของไดเรกทอรีนี้เรียกว่า "รูทของพื้นที่ทำงาน"
Bazel จะจัดเก็บข้อมูลทั้งหมดไว้ภายใต้ "รูทผู้ใช้เอาต์พุต" โดยปกติแล้วจะเป็น $HOME/.cache/bazel/_bazel_${USER}
แต่สามารถลบล้างได้โดยใช้ตัวเลือกการเริ่มต้น --output_user_root
"ฐานการติดตั้ง" คือตำแหน่งที่จะแตกไฟล์ Bazel ระบบจะดำเนินการนี้โดยอัตโนมัติ และ Bazel แต่ละเวอร์ชันจะได้รับไดเรกทอรีย่อยตามการตรวจสอบผลรวมภายใต้ฐานการติดตั้ง โดยค่าเริ่มต้นจะมีค่าเป็น $OUTPUT_USER_ROOT/install
และสามารถเปลี่ยนแปลงได้โดยใช้ตัวเลือกบรรทัดคำสั่ง --install_base
"ฐานเอาต์พุต" คือตำแหน่งที่อินสแตนซ์ Bazel ที่แนบอยู่กับเวิร์กสเปซที่เฉพาะเจาะจงเขียนข้อมูล ฐานเอาต์พุตแต่ละฐานจะมีอินสแตนซ์เซิร์ฟเวอร์ Bazel ทำงานอยู่ได้สูงสุด 1 อินสแตนซ์ โดยปกติจะอยู่ที่ $OUTPUT_USER_ROOT/<checksum of the path
to the workspace>
ซึ่งสามารถเปลี่ยนแปลงได้โดยใช้--output_base
ตัวเลือกการเริ่มต้นใช้งาน ซึ่งมีประโยชน์ในการหลีกเลี่ยงข้อจำกัดที่ว่ามีเพียงอินสแตนซ์ Bazel เดียวเท่านั้นที่ทำงานได้ในเวิร์กスペースใดก็ตามในเวลาหนึ่งๆ
ไดเรกทอรีเอาต์พุตมีสิ่งต่างๆ ต่อไปนี้
- ที่เก็บข้อมูลภายนอกที่ดึงข้อมูลได้ที่
$OUTPUT_BASE/external
- รูท exec ซึ่งเป็นไดเรกทอรีที่มีลิงก์สัญลักษณ์ไปยังซอร์สโค้ดทั้งหมดของบิลด์ปัจจุบัน ซึ่งตั้งอยู่ที่
$OUTPUT_BASE/execroot
ในระหว่างการสร้าง ไดเรกทอรีที่ใช้งานอยู่คือ$EXECROOT/<name of main repository>
เราวางแผนที่จะเปลี่ยนค่านี้เป็น$EXECROOT
แม้ว่าจะเป็นแผนระยะยาวเนื่องจากเป็นการเปลี่ยนแปลงที่เข้ากันไม่ได้อย่างมาก - ไฟล์ที่สร้างระหว่างการบิลด์
กระบวนการเรียกใช้คําสั่ง
เมื่อเซิร์ฟเวอร์ Bazel ได้ควบคุมและได้รับทราบถึงคำสั่งที่ต้องใช้ในการปฏิบัติการแล้ว ลำดับเหตุการณ์ต่อไปนี้จะเกิดขึ้น
BlazeCommandDispatcher
ได้รับแจ้งเกี่ยวกับคำขอใหม่ โดยจะตัดสินใจว่าคำสั่งต้องใช้เวิร์กスペースเพื่อทำงานหรือไม่ (เกือบทุกคำสั่งยกเว้นคำสั่งที่ไม่มีส่วนเกี่ยวข้องกับซอร์สโค้ด เช่น เวอร์ชันหรือความช่วยเหลือ) และดูว่าคำสั่งอื่นกำลังทำงานอยู่หรือไม่พบคำสั่งที่ถูกต้อง แต่ละคําสั่งต้องใช้อินเทอร์เฟซ
BlazeCommand
และต้องมีคําอธิบายประกอบ@Command
(นี่ไม่ใช่รูปแบบที่แนะนำ วิธีที่ดีกว่าคือให้เมตาข้อมูลทั้งหมดที่คําสั่งต้องการอธิบายโดยเมธอดในBlazeCommand
)ตัวเลือกบรรทัดคำสั่งจะได้รับการแยกวิเคราะห์ แต่ละคําสั่งมีตัวเลือกบรรทัดคําสั่งที่แตกต่างกัน ซึ่งอธิบายไว้ในคำอธิบายประกอบ
@Command
ระบบจะสร้างบัสเหตุการณ์ รถบัสสำหรับงานกิจกรรมคือกิจกรรมที่เกิดขึ้น ระหว่างการสร้าง ระบบจะส่งออกข้อมูลบางส่วนเหล่านี้ไปยังภายนอก Bazel ภายใต้การอุปถัมภ์ของ Build Event Protocol เพื่อบอกให้โลกรู้ถึงสถานะการสร้าง
คำสั่งจะควบคุม คำสั่งที่น่าสนใจที่สุดคือคำสั่งที่ใช้เรียกใช้การสร้าง เช่น การสร้าง การทดสอบ การทำงาน ความครอบคลุม และอื่นๆ ฟังก์ชันการทำงานนี้ใช้
BuildTool
ระบบจะแยกวิเคราะห์ชุดรูปแบบเป้าหมายในบรรทัดคำสั่งและแก้ไขไวลด์การ์ด เช่น
//pkg:all
และ//pkg/...
ซึ่งจะนำไปใช้ในAnalysisPhaseRunner.evaluateTargetPatterns()
และได้รับการปรับแต่งใหม่ใน Skyframe เป็นTargetPatternPhaseValue
ขั้นตอนการโหลด/การวิเคราะห์จะทำงานเพื่อสร้างกราฟการดำเนินการ (กราฟแบบวนซ้ำของคำสั่งที่ต้องเรียกใช้สำหรับบิลด์)
ขั้นตอนการดำเนินการจะทำงาน ซึ่งหมายความว่าการเรียกใช้การกระทำทุกอย่างที่จำเป็นเพื่อสร้างเป้าหมายระดับบนสุดที่ขอนั้นจะทำงาน
ตัวเลือกบรรทัดคำสั่ง
ตัวเลือกบรรทัดคำสั่งสำหรับการเรียกใช้ Bazel จะอธิบายไว้ในออบเจ็กต์ OptionsParsingResult
ซึ่งจะมีแผนที่จาก "คลาสตัวเลือก" ไปยังค่าของตัวเลือก "คลาสตัวเลือก" เป็นคลาสย่อยของ OptionsBase
และจัดกลุ่มตัวเลือกบรรทัดคำสั่งที่เกี่ยวข้องไว้ด้วยกัน เช่น
- ตัวเลือกที่เกี่ยวข้องกับภาษาโปรแกรม (
CppOptions
หรือJavaOptions
) ตัวเลือกเหล่านี้ควรเป็นคลาสย่อยของFragmentOptions
และสุดท้ายจะรวมอยู่ในออบเจ็กต์BuildOptions
- ตัวเลือกที่เกี่ยวข้องกับวิธีที่ Bazel ดำเนินการ (
ExecutionOptions
)
ตัวเลือกเหล่านี้ออกแบบมาเพื่อใช้ในเฟสการวิเคราะห์และ (ผ่าน RuleContext.getFragment()
ใน Java หรือ ctx.fragments
ใน Starlark)
ระบบจะอ่านข้อมูลบางอย่าง (เช่น จะทำการสแกนรวม C++ หรือไม่) ในเฟสการดำเนินการ แต่จะต้องทำการเดินท่ออย่างชัดเจนเสมอเนื่องจากBuildConfiguration
ไม่พร้อมใช้งานในตอนนั้น สำหรับข้อมูลเพิ่มเติม โปรดดูส่วน "การกำหนดค่า"
คำเตือน: เราชอบที่จะสมมติว่าอินสแตนซ์ OptionsBase
เป็นแบบคงที่และใช้อินสแตนซ์ดังกล่าว (เช่น เป็นส่วนหนึ่งของ SkyKeys
) แต่ความจริงแล้วไม่ใช่เช่นนั้น และการแก้ไขอินสแตนซ์เป็นวิธีที่ยอดเยี่ยมในการทำให้ Bazel ทำงานผิดพลาดในลักษณะที่ละเอียดอ่อนซึ่งแก้ไขได้ยาก แต่การทำให้ข้อมูลเหล่านี้เป็นแบบคงที่จริงๆ นั้นเป็นเรื่องยาก
(การแก้ไข FragmentOptions
ทันทีหลังจากสร้างก่อนที่จะมีคนอื่นอ้างอิงถึง และก่อนที่ equals()
หรือ hashCode()
จะใช้ FragmentOptions
นั้นไม่มีปัญหา)
Bazel จะเรียนรู้เกี่ยวกับคลาสตัวเลือกด้วยวิธีต่อไปนี้
- บางรายการเชื่อมต่อกับ Bazel อย่างถาวร (
CommonCommandOptions
) - จากคำอธิบายประกอบ
@Command
ในคำสั่ง Bazel แต่ละรายการ - ตั้งแต่
ConfiguredRuleClassProvider
(ตัวเลือกเหล่านี้คือตัวเลือกบรรทัดคำสั่งที่เกี่ยวข้องกับภาษาโปรแกรมแต่ละภาษา) - กฎของ Starlark ยังกำหนดตัวเลือกของตัวเองได้อีกด้วย (ดูที่นี่)
ตัวเลือกแต่ละรายการ (ยกเว้นตัวเลือกที่ Starlark กำหนด) คือตัวแปรสมาชิกของFragmentOptions
ซับคลาสที่มีคำอธิบายประกอบ @Option
ซึ่งระบุชื่อและประเภทของตัวเลือกบรรทัดคำสั่งพร้อมกับข้อความความช่วยเหลือบางส่วน
โดยทั่วไปแล้ว ประเภท Java ของค่าตัวเลือกบรรทัดคำสั่งจะเป็นค่าง่ายๆ (สตริง จำนวนเต็ม บูลีน ป้ายกำกับ ฯลฯ) อย่างไรก็ตาม เรายังรองรับตัวเลือกประเภทที่ซับซ้อนมากขึ้นด้วย ในกรณีนี้ หน้าที่แปลงสตริงบรรทัดคำสั่งเป็นประเภทข้อมูลจะขึ้นอยู่กับการใช้งาน com.google.devtools.common.options.Converter
โครงสร้างซอร์สโค้ดตามที่ Bazel เห็น
Bazel อยู่ในธุรกิจการสร้างซอฟต์แวร์ ซึ่งเกิดขึ้นจากการอ่านและตีความซอร์สโค้ด จำนวนรวมของซอร์สโค้ดที่ Bazel ดำเนินการอยู่นี้เรียกว่า "พื้นที่ทำงาน" และจัดโครงสร้างให้กับที่เก็บ แพ็กเกจ และกฎต่างๆ
ที่เก็บ
"ที่เก็บ" คือแผนผังแหล่งที่มาที่นักพัฒนาซอฟต์แวร์ทำงาน โดยมักจะเป็นตัวแทนของโปรเจ็กต์เดี่ยว Blaze ซึ่งเป็นบรรพบุรุษของ Bazel ทำงานใน Monorepo ซึ่งก็คือสคีมาแหล่งที่มาเดียวที่มีซอร์สโค้ดทั้งหมดที่ใช้เพื่อเรียกใช้บิลด์ แต่ Bazel รองรับโปรเจ็กต์ที่มีซอร์สโค้ดอยู่ในที่เก็บหลายแห่ง ที่เก็บที่มีการเรียกใช้ Bazel เรียกว่า "ที่เก็บหลัก" ส่วนที่เก็บอื่นๆ เรียกว่า "ที่เก็บภายนอก"
ที่เก็บมีการทำเครื่องหมายโดยไฟล์ขอบเขตของที่เก็บ (MODULE.bazel
, REPO.bazel
หรือในบริบทเดิม WORKSPACE
หรือ WORKSPACE.bazel
) ในไดเรกทอรีราก Repo หลักคือต้นไม้แหล่งที่มาที่คุณเรียกใช้ Bazel รีพอสภายนอกมีการกำหนดได้หลายวิธี ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของทรัพยากรภายนอก
โค้ดของที่เก็บข้อมูลภายนอกจะลิงก์สัญลักษณ์หรือดาวน์โหลดในส่วน $OUTPUT_BASE/external
เมื่อเรียกใช้บิลด์ จะต้องรวบรวมซอร์สทรีทั้งหมดเข้าด้วยกัน ซึ่ง SymlinkForest
จะเป็นผู้ดำเนินการโดยลิงก์สัญลักษณ์แพ็กเกจทุกรายการในที่เก็บหลักกับ $EXECROOT
และที่เก็บภายนอกทุกรายการกับ $EXECROOT/external
หรือ $EXECROOT/..
แพ็กเกจ
ที่เก็บข้อมูลทุกแห่งประกอบด้วยแพ็กเกจ คอลเล็กชันไฟล์ที่เกี่ยวข้อง และข้อกำหนดของข้อกำหนดเบื้องต้น โดยระบุด้วยไฟล์ชื่อ BUILD
หรือ BUILD.bazel
หากมีทั้ง 2 ไฟล์ Bazel จะเลือก BUILD.bazel
เหตุผลที่ยังคงยอมรับไฟล์ BUILD
อยู่เนื่องจาก Blaze ซึ่งเป็นบรรพบุรุษของ Bazel ใช้ชื่อไฟล์นี้ แต่กลายเป็นกลุ่มเส้นทางที่ใช้กันโดยทั่วไป โดยเฉพาะใน Windows ที่ชื่อไฟล์ไม่คำนึงถึงตัวพิมพ์เล็กหรือใหญ่
แพ็กเกจแต่ละรายการจะแยกจากกัน การเปลี่ยนแปลงไฟล์ BUILD
ของแพ็กเกจหนึ่งจะไม่ทําให้แพ็กเกจอื่นๆ เปลี่ยนแปลง การเพิ่มหรือการนำไฟล์ BUILD
ออกอาจเปลี่ยนแปลงแพ็กเกจอื่นๆ ได้ เนื่องจากนิพจน์ทั่วไปแบบซ้ำซ้อนจะหยุดที่ขอบเขตของแพ็กเกจ และไฟล์ BUILD
จะหยุดการเรียกซ้ำ
การประเมินไฟล์ BUILD
เรียกว่า "การโหลดแพ็กเกจ" มีการนำมาใช้ในคลาส PackageFactory
โดยทํางานโดยการเรียกใช้โปรแกรมแปลภาษา Starlark และต้องใช้ความรู้เกี่ยวกับชุดคลาสกฎที่ใช้ได้ ผลลัพธ์ของการโหลดแพ็กเกจคือออบเจ็กต์ Package
โดยส่วนใหญ่จะเป็นแผนที่จากสตริง (ชื่อเป้าหมาย) ไปยังตัวเป้าหมายเอง
ความซับซ้อนส่วนใหญ่ระหว่างการโหลดแพ็กเกจคือรูปแบบทั่วไป: Bazel ไม่ได้กำหนดให้ต้องระบุไฟล์ต้นฉบับทุกไฟล์อย่างชัดเจน แต่สามารถเรียกใช้รูปแบบทั่วไป (เช่น glob(["**/*.java"])
) แทน ต่างจากเชลล์ตรงที่รองรับรูปแบบทั่วไปแบบซ้ำซ้อนที่ไปยังไดเรกทอรีย่อย (แต่ไม่ใช่ไปยังแพ็กเกจย่อย) การดำเนินการนี้ต้องเข้าถึงระบบไฟล์ และเนื่องจากอาจทำได้ช้า เราจึงใช้กลอุบายทั้งหมดเพื่อทำให้ระบบทำงานพร้อมกันและมีประสิทธิภาพมากที่สุด
การใช้ Globbing มีอยู่ในคลาสต่อไปนี้
LegacyGlobber
ผู้ใช้ Globber ที่รวดเร็วและไม่รู้เรื่อง SkyframeSkyframeHybridGlobber
ซึ่งเป็นเวอร์ชันที่ใช้ Skyframe และเปลี่ยนกลับไปใช้ Globber แบบเดิมเพื่อหลีกเลี่ยง "การรีสตาร์ท Skyframe" (อธิบายไว้ด้านล่าง)
คลาส Package
เองมีสมาชิกบางรายที่ใช้เฉพาะการแยกวิเคราะห์แพ็กเกจ "ภายนอก" (เกี่ยวข้องกับทรัพยากร Dependency ภายนอก) และสมาชิกที่ดูไม่เหมาะสมสำหรับแพ็กเกจจริง ข้อบกพร่องนี้เกิดจากการออกแบบ เนื่องจากออบเจ็กต์ที่อธิบายแพ็กเกจปกติไม่ควรมีช่องที่อธิบายสิ่งอื่น ซึ่งได้แก่
- การแมปที่เก็บ
- Toolchains ที่จดทะเบียน
- แพลตฟอร์มการดำเนินการที่ลงทะเบียนไว้
ตามหลักการแล้ว ควรแยกการแยกวิเคราะห์แพ็กเกจ "ภายนอก" ออกจากการแยกวิเคราะห์แพ็กเกจปกติเพื่อให้ Package
ไม่ต้องรองรับความต้องการทั้ง 2 อย่าง ขออภัยที่การดำเนินการนี้ทำได้ยาก เนื่องจาก 2 รายการนี้มีความเชื่อมโยงกันอย่างมาก
ป้ายกํากับ เป้าหมาย และกฎ
แพ็กเกจประกอบด้วยเป้าหมายซึ่งมีประเภทต่อไปนี้
- ไฟล์: สิ่งต่างๆ ที่เป็นอินพุตหรือเอาต์พุตของบิลด์ ในภาษาของ Bazel เราเรียกสิ่งเหล่านี้ว่า อาร์ติแฟกต์ (มีคำอธิบายไว้ที่อื่น) ไฟล์ที่สร้างขึ้นในระหว่างการบิลด์ไม่ใช่เป้าหมายทั้งหมด เป็นเรื่องปกติที่เอาต์พุตของ Bazel จะไม่มีป้ายกำกับที่เชื่อมโยง
- กฎ: ส่วนนี้จะอธิบายขั้นตอนการดึงเอาต์พุตจากอินพุต โดยทั่วไปแล้ว ตัวแปรเหล่านี้จะเชื่อมโยงกับภาษาโปรแกรม (เช่น
cc_library
,java_library
หรือpy_library
) แต่ก็มีบางรายการที่ไม่เกี่ยวข้องกับภาษา (เช่นgenrule
หรือfilegroup
) - กลุ่มแพ็กเกจ: อธิบายไว้ในส่วนระดับการเข้าถึง
ชื่อของเป้าหมายเรียกว่าป้ายกํากับ ไวยากรณ์ของป้ายกำกับคือ @repo//pac/kage:name
โดยที่ repo
คือชื่อของที่เก็บที่มีป้ายกำกับนั้น pac/kage
คือไดเรกทอรี BUILD
ของไฟล์ และ name
คือเส้นทางของไฟล์ (หากป้ายกำกับอ้างอิงไฟล์ต้นฉบับ) ที่สัมพันธ์กับไดเรกทอรีของแพ็กเกจ เมื่ออ้างอิงเป้าหมายในบรรทัดคำสั่ง คุณสามารถละเว้นส่วนต่างๆ ของป้ายกำกับได้ ดังนี้
- หากไม่ระบุที่เก็บ ระบบจะนำป้ายกำกับไปอยู่ในที่เก็บหลัก
- หากละเว้นส่วนแพ็กเกจ (เช่น
name
หรือ:name
) ระบบจะนำป้ายกำกับไปอยู่ในแพ็กเกจของไดเรกทอรีที่ใช้งานอยู่ปัจจุบัน (ไม่อนุญาตให้ใช้เส้นทางแบบสัมพัทธ์ที่มีการอ้างอิงระดับบน (..))
กฎประเภทหนึ่ง (เช่น "คลัง C++") เรียกว่า "คลาสกฎ" คลาสกฎอาจนำไปใช้ใน Starlark (ฟังก์ชัน rule()
) หรือใน Java (ที่เรียกว่า "กฎแบบเนทีฟ" ประเภท RuleClass
) ในระยะยาว กฎเฉพาะภาษาทุกกฎจะใช้ใน Starlark แต่บางตระกูลกฎเดิม (เช่น Java หรือ C++) จะยังคงอยู่ใน Java ต่อไป
คุณต้องนำเข้าคลาสกฎ Starlark ที่ส่วนต้นของไฟล์ BUILD
โดยใช้คำสั่ง load()
ส่วนคลาสกฎ Java นั้น Bazel จะรู้จัก "โดยกำเนิด" เนื่องจากมีการลงทะเบียนกับ ConfiguredRuleClassProvider
คลาสของกฎจะมีข้อมูลต่างๆ เช่น
- แอตทริบิวต์ (เช่น
srcs
,deps
): ประเภท ค่าเริ่มต้น ข้อจำกัด ฯลฯ - การเปลี่ยนการกำหนดค่าและลักษณะที่แนบมากับแอตทริบิวต์แต่ละรายการ หากมี
- การใช้กฎ
- ผู้ให้บริการข้อมูลแบบทรานซิทีฟที่กฎ "มักจะ" สร้าง
หมายเหตุเกี่ยวกับคําศัพท์: ในโค้ดเบส เรามักใช้คำว่า "กฎ" เพื่อหมายถึงเป้าหมายที่สร้างขึ้นโดยคลาสกฎ แต่ใน Starlark และในเอกสารที่แสดงต่อผู้ใช้
"กฎ" ควรใช้เพื่ออ้างอิงถึงคลาสของกฎโดยเฉพาะ กล่าวคือเป้าหมายเป็นเพียง "เป้าหมาย" เท่านั้น นอกจากนี้ โปรดทราบว่าแม้ว่า RuleClass
จะมี "class" ในชื่อ แต่คลาสกฎและเป้าหมายประเภทนั้นไม่มีความสัมพันธ์แบบรับช่วงของ Java
Skyframe
เฟรมเวิร์กการประเมินที่อยู่เบื้องหลัง Bazel เรียกว่า Skyframe โมเดลของเครื่องมือนี้คือทุกอย่างที่ต้องสร้างในระหว่างการสร้างจะจัดระเบียบเป็นกราฟแบบมีทิศทางที่ไม่เป็นวงจร โดยมีขอบที่ชี้จากข้อมูลหนึ่งๆ ไปยังข้อมูลที่เกี่ยวข้อง ซึ่งก็คือข้อมูลอื่นๆ ที่ต้องทราบเพื่อสร้างข้อมูลนั้น
โหนดในกราฟเรียกว่า SkyValue
และชื่อของโหนดเรียกว่า SkyKey
ทั้ง 2 อย่างนี้จะเปลี่ยนแปลงไม่ได้ มีเพียงวัตถุที่เปลี่ยนแปลงไม่ได้เท่านั้นที่เข้าถึงได้ ค่าคงที่นี้จะระงับไว้เกือบทุกครั้ง และในกรณีที่ไม่เป็นเช่นนั้น (เช่น สำหรับคลาสตัวเลือกแต่ละรายการ BuildOptions
ซึ่งเป็นสมาชิกของ BuildConfigurationValue
และ SkyKey
) เราพยายามอย่างมากที่จะไม่เปลี่ยนหรือเปลี่ยนแปลงตัวเลือกเหล่านั้นในลักษณะที่ไม่อาจสังเกตได้จากภายนอกเท่านั้น
จากข้อมูลนี้ ทุกอย่างที่ประมวลผลภายใน Skyframe (เช่น เป้าหมายที่กําหนดค่าไว้) จะต้องเป็นแบบคงที่ด้วย
วิธีที่สะดวกที่สุดในการดูกราฟ Skyframe คือให้เรียกใช้ bazel dump
--skyframe=deps
ซึ่งจะแสดงผลกราฟ 1 SkyValue
ต่อบรรทัด วิธีที่ดีที่สุดคือสร้าง
กับงานสร้างขนาดเล็กๆ เพราะอาจมีขนาดใหญ่พอสมควร
Skyframe อยู่ในแพ็กเกจ com.google.devtools.build.skyframe
แพ็กเกจ com.google.devtools.build.lib.skyframe
ที่มีชื่อคล้ายกันมีการติดตั้งใช้งาน Bazel ที่ด้านบนของ Skyframe ดูข้อมูลเพิ่มเติมเกี่ยวกับ Skyframe
ได้ที่นี่
หากต้องการประเมิน SkyKey
หนึ่งๆ เป็น SkyValue
Skyframe จะเรียกใช้ SkyFunction
ที่สอดคล้องกับประเภทของคีย์ ในระหว่างการประเมิน ฟังก์ชันอาจขอทรัพยากร Dependency อื่นๆ จาก Skyframe โดยการเรียกใช้ SkyFunction.Environment.getValue()
แบบโอเวอร์โหลดต่างๆ ซึ่งจะส่งผลข้างเคียงในการลงทะเบียนการพึ่งพาเหล่านั้นในกราฟภายในของ Skyframe เพื่อให้ Skyframe ทราบว่าต้องประเมินฟังก์ชันอีกครั้งเมื่อการพึ่งพาใดๆ เปลี่ยนแปลง กล่าวคือ การแคชและการประมวลผลแบบเพิ่มทีละน้อยของ Skyframe จะทำงานในระดับรายละเอียดของ SkyFunction
และ SkyValue
เมื่อใดก็ตามที่ SkyFunction
ขอทรัพยากร Dependency ที่ไม่มี getValue()
จะแสดงผลเป็น Null จากนั้นฟังก์ชันควรส่งการควบคุมกลับไปที่ Skyframe โดยแสดงผลเป็น Null ในภายหลัง Skyframe จะประเมินข้อกำหนดที่ไม่พร้อมใช้งาน จากนั้นจึงเริ่มฟังก์ชันใหม่ตั้งแต่ต้น เฉพาะครั้งนี้เท่านั้นที่การเรียก getValue()
จะสำเร็จโดยมีผลลัพธ์ที่ไม่ใช่ค่าว่าง
ผลที่ตามมาคือการคำนวณใดๆ ที่ดำเนินการภายใน SkyFunction
ก่อนการรีสตาร์ทจะต้องทำซ้ำ แต่จะไม่รวมงานที่ทําเพื่อประเมิน SkyValues
ที่เป็น Dependency ซึ่งมีการแคชไว้ ดังนั้น เรามักจะแก้ปัญหานี้ด้วยวิธีต่อไปนี้
- การประกาศการพึ่งพาแบบเป็นกลุ่ม (โดยใช้
getValuesAndExceptions()
) เพื่อจำกัดจำนวนการรีสตาร์ท - การแยก
SkyValue
ออกเป็นชิ้นส่วนที่แยกกันซึ่งประมวลผลโดยSkyFunction
ที่แตกต่างกัน เพื่อให้สามารถประมวลผลและแคชแยกกันได้ การดำเนินการนี้ควรทำอย่างมีกลยุทธ์ เนื่องจากมีแนวโน้มที่จะเพิ่มการใช้หน่วยความจำ - จัดเก็บสถานะระหว่างการรีสตาร์ท โดยใช้
SkyFunction.Environment.getState()
หรือเก็บแคชเฉพาะกิจแบบ "เบื้องหลัง Skyframe"
โดยพื้นฐานแล้ว เราต้องใช้วิธีแก้ปัญหาประเภทนี้เนื่องจากเรามีโหนด Skyframe ที่ใช้งานอยู่หลายแสนโหนดเป็นประจำ และ Java ไม่รองรับเธรดแบบเบา
Starlark
Starlark เป็นภาษาเฉพาะโดเมนที่ผู้ใช้ใช้เพื่อกําหนดค่าและขยายความสามารถของ Bazel ภาษานี้สร้างขึ้นเพื่อเป็นชุดย่อยของ Python ที่มีข้อจำกัดมาก มีประเภทน้อยกว่ามาก มีข้อจำกัดมากขึ้นเกี่ยวกับโฟลว์การควบคุม และที่สำคัญที่สุดคือรับประกันความคงที่แบบสมบูรณ์เพื่อเปิดใช้การอ่านพร้อมกัน ภาษานี้ไม่ใช่ภาษา Turing-complete ซึ่งทำให้ผู้ใช้บางราย (แต่ไม่ใช่ทั้งหมด) ไม่สามารถทำงานทั่วไปด้านการเขียนโปรแกรมในภาษานี้ได้
Starlark ติดตั้งใช้งานในแพ็กเกจ net.starlark.java
นอกจากนี้ยังมีการใช้งาน Go แบบอิสระที่นี่ด้วย ปัจจุบันการใช้งาน Java ที่ใช้ใน Bazel ยังเป็นโปรแกรมล่าม
Starlark ใช้ในบริบทต่างๆ ซึ่งรวมถึง
BUILD
ไฟล์ ที่นี่เป็นตําแหน่งที่จะกําหนดเป้าหมายการสร้างใหม่ โค้ด Starlark ที่ทำงานในบริบทนี้จะเข้าถึงได้เฉพาะเนื้อหาของไฟล์BUILD
เองและไฟล์.bzl
ที่โหลดโดยโค้ดดังกล่าว- ไฟล์
MODULE.bazel
ในส่วนนี้จะมีการกำหนดทรัพยากร Dependency ภายนอก โค้ด Starlark ที่ทำงานในบริบทนี้มีสิทธิ์เข้าถึงไดเรกทีฟที่กำหนดไว้ล่วงหน้าเพียงไม่กี่รายการเท่านั้น .bzl
ไฟล์ ซึ่งเป็นที่ที่มีการกำหนดกฎบิลด์ กฎที่เก็บ ส่วนขยายโมดูลใหม่ โค้ด Starlark ที่นี่จะกำหนดฟังก์ชันใหม่และโหลดจากไฟล์.bzl
อื่นๆ ได้
ภาษาที่ใช้ได้สำหรับไฟล์ BUILD
และ .bzl
จะแตกต่างกันเล็กน้อยเนื่องจากมีความหมายต่างกัน ดูรายการความแตกต่างได้ที่นี่
ดูข้อมูลเพิ่มเติมเกี่ยวกับ Starlark ได้ที่นี่
ระยะการโหลด/การวิเคราะห์
ขั้นตอนการโหลด/การวิเคราะห์คือจุดที่ Bazel จะพิจารณาว่าต้องดำเนินการใดบ้างเพื่อสร้างกฎหนึ่งๆ หน่วยพื้นฐานคือ "เป้าหมายที่กําหนดค่า" ซึ่งเป็นคู่ (เป้าหมาย การกําหนดค่า)
ขั้นตอนนี้เรียกว่า "ระยะการโหลด/การวิเคราะห์" เนื่องจากสามารถแบ่งออกเป็น 2 ส่วนที่แตกต่างกัน ซึ่งก่อนหน้านี้จะทำงานตามลําดับ แต่ตอนนี้สามารถซ้อนทับกันได้
- การโหลดแพ็กเกจ ซึ่งก็คือการเปลี่ยนไฟล์
BUILD
เป็นออบเจ็กต์Package
ที่แสดงถึงแพ็กเกจ - การวิเคราะห์เป้าหมายที่กําหนดค่าไว้ ซึ่งก็คือการเรียกใช้การติดตั้งใช้งานกฎเพื่อสร้างกราฟการดําเนินการ
เป้าหมายที่กำหนดค่าไว้แต่ละรายการในการปิดแบบทรานซิทีฟของเป้าหมายที่กำหนดค่าไว้ที่ขอในบรรทัดคำสั่งต้องได้รับการวิเคราะห์จากด้านล่างขึ้นบน กล่าวคือ ต้องวิเคราะห์โหนด Leaf ก่อน จากนั้นจึงจะวิเคราะห์จนถึงโหนดในบรรทัดคำสั่ง อินพุตสําหรับการวิเคราะห์เป้าหมายที่กําหนดค่าไว้รายการเดียวมีดังนี้
- การกำหนดค่า ("วิธี" สร้างกฎ เช่น แพลตฟอร์มเป้าหมาย รวมถึงสิ่งต่างๆ เช่น ตัวเลือกบรรทัดคำสั่งที่ผู้ใช้ต้องการให้ส่งไปยังคอมไพเลอร์ C++)
- Dependency โดยตรง ผู้ให้บริการข้อมูลทรานซิชันของพวกเขา จะพร้อมใช้งานกับกฎที่วิเคราะห์อยู่ ไฟล์เหล่านี้เรียกว่า "รวม" เนื่องจากให้ "การรวม" ข้อมูลใน Closure แบบทรานซิทีฟของเป้าหมายที่กําหนดค่า เช่น ไฟล์ .jar ทั้งหมดใน Classpath หรือไฟล์ .o ทั้งหมดที่ต้องลิงก์กับไบนารี C++)
- เป้าหมายเอง นี่เกิดจากการโหลดแพ็กเกจที่มีเป้าหมายอยู่ สําหรับกฎ ข้อมูลนี้รวมถึงแอตทริบิวต์ของกฎ ซึ่งมักจะเป็นสิ่งที่สําคัญ
- การใช้เป้าหมายที่กําหนดค่าไว้ สำหรับกฎ ข้อมูลนี้อาจเป็นสตาร์แลร์กหรือ Java ระบบจะใช้เป้าหมายที่กําหนดค่าไว้ซึ่งไม่ใช่กฎทั้งหมดใน Java
เอาต์พุตของการวิเคราะห์เป้าหมายที่กําหนดค่าไว้มีดังนี้
- ผู้ให้บริการข้อมูลแบบทรานซิทีฟที่กําหนดค่าเป้าหมายซึ่งใช้ข้อมูลดังกล่าวจะเข้าถึงได้
- อาร์ติแฟกต์ที่สามารถสร้างและการดำเนินการที่ทำให้เกิดอาร์ติแฟกต์
API ที่เสนอให้กับกฎ Java คือ RuleContext
ซึ่งเทียบเท่ากับอาร์กิวเมนต์ ctx
ของกฎ Starlark API ของ Bazel มีประสิทธิภาพมากกว่า แต่ขณะเดียวกันก็ทําให้เกิด "สิ่งเลวร้าย" ได้ง่ายขึ้น เช่น การเขียนโค้ดที่มีความซับซ้อนด้านเวลาหรือพื้นที่ทำงานเป็น 2 เท่า (หรือแย่กว่านั้น) ทําให้เซิร์ฟเวอร์ Bazel ขัดข้องด้วยข้อยกเว้น Java หรือละเมิดค่าคงที่ (เช่น การแก้ไขอินสแตนซ์ Options
โดยไม่ได้ตั้งใจ หรือทําให้เป้าหมายที่กําหนดค่าไว้มีการเปลี่ยนแปลงได้)
อัลกอริทึมที่กําหนดความเกี่ยวข้องโดยตรงของเป้าหมายที่กําหนดค่าไว้จะอยู่ในส่วนDependencyResolver.dependentNodeMap()
การกำหนดค่า
การกำหนดค่าคือ "วิธีการ" ของการสร้างเป้าหมาย สำหรับแพลตฟอร์มใด พร้อมตัวเลือกบรรทัดคำสั่งใด ฯลฯ
เป้าหมายเดียวกันนั้นสร้างขึ้นสำหรับการกำหนดค่าหลายรายการในบิลด์เดียวกันได้ การดำเนินการนี้มีประโยชน์ เช่น เมื่อใช้โค้ดเดียวกันกับเครื่องมือที่ทำงานระหว่างการสร้างและสำหรับโค้ดเป้าหมาย และเรากำลังคอมไพล์ข้าม หรือเมื่อเราสร้างแอป Android แบบรวม (แอปที่มีโค้ดเนทีฟสำหรับสถาปัตยกรรม CPU หลายแบบ)
การกำหนดค่าคืออินสแตนซ์ BuildOptions
ในทางแนวคิด อย่างไรก็ตาม ในทางปฏิบัติ BuildOptions
จะรวมอยู่ใน BuildConfiguration
ที่มีฟังก์ชันการทำงานอื่นๆ เพิ่มเติม โดยจะกระจายจากด้านบนของกราฟความเกี่ยวข้องไปทางด้านล่าง หากมีการเปลี่ยนแปลง จะต้องวิเคราะห์บิลด์อีกครั้ง
ซึ่งส่งผลให้เกิดความผิดปกติ เช่น ต้องมีการวิเคราะห์บิลด์ทั้งหมดอีกครั้งหากมีการเปลี่ยนแปลงจำนวนการเรียกใช้การทดสอบที่ขอ แม้ว่าจะส่งผลต่อเป้าหมายการทดสอบเท่านั้น (เรามีแผนที่จะ "ตัด" การกําหนดค่าเพื่อไม่ให้เกิดกรณีเช่นนี้ แต่ยังไม่พร้อมใช้งาน)
เมื่อการติดตั้งใช้งานกฎต้องใช้การกําหนดค่าบางส่วน จะต้องประกาศการกําหนดค่านั้นในคําจํากัดความโดยใช้ RuleClass.Builder.requiresConfigurationFragments()
การดำเนินการนี้ทั้งเพื่อหลีกเลี่ยงข้อผิดพลาด (เช่น กฎ Python ที่ใช้ข้อมูลโค้ด Java) และเพื่ออำนวยความสะดวกในการตัดแต่งการกำหนดค่า เช่น หากตัวเลือก Python เปลี่ยนแปลง ก็ไม่จำเป็นต้องวิเคราะห์เป้าหมาย C++ อีกครั้ง
การกำหนดค่าของกฎไม่จำเป็นต้องเหมือนกับการกำหนดค่าของกฎ "หลัก" กระบวนการเปลี่ยนการกําหนดค่าในขอบความเกี่ยวข้องเรียกว่า "การเปลี่ยนการกําหนดค่า" ซึ่งอาจเกิดขึ้นได้ 2 แห่ง ดังนี้
- บนขอบทรัพยากร Dependency การเปลี่ยนเหล่านี้จะระบุไว้ใน
Attribute.Builder.cfg()
และจะเป็นฟังก์ชันจากRule
(ตำแหน่งที่เกิดการเปลี่ยน) และBuildOptions
(การกำหนดค่าเดิม) ไปยังBuildOptions
อย่างน้อย 1 รายการ (การกำหนดค่าเอาต์พุต) - ใน Edge ขาเข้าไปยังเป้าหมายที่กำหนดค่าไว้ ซึ่งระบุไว้ใน
RuleClass.Builder.cfg()
ชั้นเรียนที่เกี่ยวข้องคือ TransitionFactory
และ ConfigurationTransition
การเปลี่ยนการกำหนดค่ามีการใช้งาน เช่น
- เพื่อประกาศว่าใช้ทรัพยากรบางอย่างในระหว่างการสร้าง และควรสร้างในสถาปัตยกรรมการดำเนินการ
- วิธีประกาศว่าต้องสร้างการพึ่งพาบางอย่างสำหรับสถาปัตยกรรมหลายแบบ (เช่น สําหรับโค้ดเนทีฟใน APK ของ Android แบบรวม)
หากการเปลี่ยนการกำหนดค่าส่งผลให้มีการกำหนดค่าหลายรายการ การเปลี่ยนดังกล่าวจะเรียกว่าการเปลี่ยนแบบแยก
คุณยังใช้การเปลี่ยนการกำหนดค่าใน Starlark ได้ด้วย (เอกสารประกอบที่นี่)
ผู้ให้บริการข้อมูลแบบเปลี่ยนผ่าน
ผู้ให้บริการข้อมูลแบบทรานซิชันคือวิธี (และ _only _way) สำหรับเป้าหมายที่กําหนดค่าไว้ ในการบอกสิ่งต่างๆ เกี่ยวกับเป้าหมายอื่นๆ ที่กําหนดค่าไว้ซึ่งจะขึ้นอยู่กับเป้าหมายนั้น สาเหตุที่ชื่อมีคำว่า "Transitive" อยู่ด้วยคือโดยปกติแล้วการรวมประเภทนี้จะเป็นการนำ Closure แบบทรานซิทีฟของเป้าหมายที่กําหนดค่าไว้มารวมกัน
โดยทั่วไปแล้ว ผู้ให้บริการข้อมูลแบบเปลี่ยนผ่านของ Java จะสอดคล้องกับผู้ให้บริการข้อมูลของ Starlark แบบ 1:1 (ยกเว้น DefaultInfo
ซึ่งเป็นการรวมกันของ FileProvider
, FilesToRunProvider
และ RunfilesProvider
เนื่องจาก API ดังกล่าวได้รับการพิจารณาว่ามีลักษณะเป็น Starlark มากกว่าการถอดเสียงโดยตรงจาก Java)
รหัสของผู้ใช้คือสิ่งใดสิ่งหนึ่งต่อไปนี้
- ออบเจ็กต์คลาส Java ตัวเลือกนี้ใช้ได้กับผู้ให้บริการที่เข้าถึงจาก Starlark ไม่ได้เท่านั้น ผู้ให้บริการเหล่านี้เป็นคลาสย่อยของ
TransitiveInfoProvider
- สตริง รูปแบบนี้เป็นรูปแบบเดิมที่เราไม่แนะนำให้ใช้เนื่องจากมีแนวโน้มที่จะเกิดการทับซ้อนของชื่อ ผู้ให้บริการข้อมูลแบบเปลี่ยนผ่านดังกล่าวเป็นคลาสย่อยโดยตรงของ
build.lib.packages.Info
- สัญลักษณ์ผู้ให้บริการ ซึ่งสร้างได้จาก Starlark โดยใช้ฟังก์ชัน
provider()
และเป็นวิธีที่แนะนำในการสร้างผู้ให้บริการใหม่ สัญลักษณ์จะแสดงโดยอินสแตนซ์Provider.Key
ใน Java
ผู้ให้บริการรายใหม่ที่ใช้งานใน Java ควรใช้งานโดยใช้ BuiltinProvider
NativeProvider
เลิกใช้งานแล้ว (เรายังไม่มีเวลาในการนำออก) และจะเข้าถึงคลาสย่อย TransitiveInfoProvider
จาก Starlark ไม่ได้
เป้าหมายที่กำหนดค่าแล้ว
ระบบจะใช้เป้าหมายที่กําหนดค่าเป็น RuleConfiguredTargetFactory
แต่ละคลาสกฎที่ติดตั้งใช้งานใน Java จะมีคลาสย่อย ระบบจะสร้างเป้าหมายที่กําหนดค่าด้วย Starlark ผ่าน StarlarkRuleConfiguredTargetUtil.buildRule()
โรงงานเป้าหมายที่กำหนดค่าไว้ควรใช้ RuleConfiguredTargetBuilder
เพื่อสร้างผลลัพธ์ ซึ่งประกอบด้วยสิ่งต่อไปนี้
filesToBuild
ของบุคคลนั้นๆ ซึ่งเป็นแนวคิดที่คลุมเครือเกี่ยวกับ "ชุดไฟล์ที่กฎนี้แสดงถึง" ไฟล์เหล่านี้คือไฟล์ที่ถูกสร้างขึ้นเมื่อเป้าหมายที่กำหนดค่าไว้อยู่ในบรรทัดคำสั่งหรือใน srcs ของ Genrule- ไฟล์รันไทม์ ไฟล์ปกติ และไฟล์ข้อมูล
- กลุ่มเอาต์พุต รายการเหล่านี้คือ "ชุดไฟล์อื่นๆ" ต่างๆ ที่กฎสามารถสร้างได้ โดยเข้าถึงได้โดยใช้แอตทริบิวต์ output_group ของกฎ filegroup ใน BUILD และใช้ผู้ให้บริการ
OutputGroupInfo
ใน Java
การเรียกใช้ไฟล์
ไฟล์ไบนารีบางไฟล์ต้องใช้ไฟล์ข้อมูลจึงจะทำงานได้ ตัวอย่างที่เห็นได้ชัดคือทดสอบที่ต้องใช้ไฟล์อินพุต ซึ่งใน Bazel จะใช้แนวคิด "runfiles" "ต้นไม้ runfiles" คือต้นไม้ไดเรกทอรีของไฟล์ข้อมูลสําหรับไบนารีหนึ่งๆ โดยจะสร้างขึ้นในระบบไฟล์เป็นแผนผังลิงก์สัญลักษณ์ซึ่งมีลิงก์สัญลักษณ์แต่ละลิงก์ชี้ไปยังไฟล์ในแหล่งที่มาของต้นไม้เอาต์พุต
ชุดไฟล์รันไทม์จะแสดงเป็นอินสแตนซ์ Runfiles
โดยแนวคิดแล้ว ไฟล์นี้เป็นการแมปจากเส้นทางของไฟล์ในโครงสร้าง runfiles ไปยังอินสแตนซ์ Artifact
ที่แสดงไฟล์นั้น การดำเนินการนี้มีความซับซ้อนกว่า Map
เดี่ยวเล็กน้อยเนื่องจากเหตุผล 2 ข้อต่อไปนี้
- ส่วนใหญ่แล้ว เส้นทาง runfiles ของไฟล์จะเหมือนกับ execpath ของไฟล์ เราใช้วิธีนี้เพื่อประหยัด RAM
- มีรายการเดิมหลายประเภทในแผนผัง Runfile ซึ่งต้องแสดงด้วย
ระบบจะรวบรวมไฟล์รันไทม์โดยใช้ RunfilesProvider
: อินสแตนซ์ของคลาสนี้แสดงไฟล์รันไทม์ของเป้าหมายที่กําหนดค่า (เช่น ไลบรารี) และความต้องการการปิดเชิงการเปลี่ยนผัน และรวบรวมไฟล์รันไทม์เหล่านั้นเหมือนชุดที่ฝังอยู่ (อันที่จริงแล้ว ระบบจะนําไปใช้งานโดยใช้ชุดที่ฝังอยู่โดยไม่ได้แสดง) แต่ละเป้าหมายจะรวมไฟล์รันไทม์ของ Dependency เพิ่มไฟล์รันไทม์ของตัวเองบางส่วน แล้วส่งชุดที่เป็นผลลัพธ์ขึ้นด้านบนในกราฟ Dependency อินสแตนซ์ RunfilesProvider
มีอินสแตนซ์ Runfiles
2 รายการ รายการหนึ่งสำหรับกรณีที่กฎใช้แอตทริบิวต์ "data" และอีกรายการสำหรับรายการอื่นๆ ทั้งหมดที่เข้ามา เนื่องจากบางครั้งเป้าหมายจะแสดงไฟล์รันไทม์ที่ต่างกันเมื่อมีการอ้างอิงผ่านแอตทริบิวต์ข้อมูล นี่เป็นลักษณะการทำงานเดิมที่ไม่พึงประสงค์ซึ่งเรายังไม่ได้นำออก
ไฟล์เรียกใช้ของไบนารีจะแสดงเป็นอินสแตนซ์ของ RunfilesSupport
สิ่งนี้แตกต่างจาก Runfiles
เนื่องจาก RunfilesSupport
มีความสามารถของสิ่งที่สร้างขึ้นมาได้จริง (ต่างจาก Runfiles
ซึ่งเป็นเพียงการแมปเท่านั้น) ซึ่งต้องใช้คอมโพเนนต์เพิ่มเติมต่อไปนี้
- ไฟล์ Manifest ของไฟล์รันไทม์อินพุต นี่คือคำอธิบายที่แปลงเป็นอนุกรมของต้นไม้ runfiles ไฟล์นี้ใช้เป็นพร็อกซีสําหรับเนื้อหาของต้นไม้ runfiles และ Bazel จะถือว่าต้นไม้ runfiles มีการเปลี่ยนแปลงก็ต่อเมื่อเนื้อหาของไฟล์ Manifest มีการเปลี่ยนแปลงเท่านั้น
- ไฟล์ Manifest ของการเรียกใช้ไฟล์เอาต์พุต ไลบรารีรันไทม์ที่ใช้จัดการต้นไม้ไฟล์รันไทม์จะใช้สิ่งนี้ โดยเฉพาะอย่างยิ่งใน Windows ซึ่งบางครั้งไม่รองรับลิงก์สัญลักษณ์
- สื่อกลางของ runfiles หากต้องการให้มีโครงสร้าง runfiles คุณต้องสร้างโครงสร้างลิงก์สัญลักษณ์ (Symlink) และอาร์ติแฟกต์ที่ลิงก์สัญลักษณ์ชี้ไป หากต้องการลดจำนวนขอบความเกี่ยวข้อง คุณสามารถใช้ตัวกลาง runfiles เพื่อแสดงรายการเหล่านี้ทั้งหมดได้
- อาร์กิวเมนต์บรรทัดคำสั่งสําหรับการเรียกใช้ไบนารีที่ออบเจ็กต์
RunfilesSupport
แสดงถึง
ลักษณะ
ส่วนต่างๆ เป็นวิธี "เผยแพร่การคํานวณไปตามกราฟทรัพยากร Dependency" เราได้อธิบายไว้ที่นี่สำหรับผู้ใช้ Bazel ตัวอย่างที่ดีในการกระตุ้นให้สร้างคือ Protocol Buffer: กฎ proto_library
ไม่ควรทราบเกี่ยวกับภาษาใดภาษาหนึ่ง แต่การสร้างการใช้งานข้อความ Protocol Buffer ("หน่วยพื้นฐาน" ของ Protocol Buffer) ในภาษาโปรแกรมใดก็ตามควรเชื่อมโยงกับกฎ proto_library
เพื่อให้หากมีเป้าหมาย 2 รายการในภาษาเดียวกันซึ่งใช้ Protocol Buffer เดียวกัน ระบบจะสร้างเพียงครั้งเดียว
เช่นเดียวกับเป้าหมายที่กําหนดค่าไว้ เป้าหมายเหล่านี้จะแสดงใน Skyframe เป็น SkyValue
และวิธีการสร้างจะคล้ายกับการสร้างเป้าหมายที่กําหนดค่าไว้มาก กล่าวคือ มีคลาสโรงงานชื่อ ConfiguredAspectFactory
ที่มีสิทธิ์เข้าถึง RuleContext
แต่ต่างจากโรงงานเป้าหมายที่กําหนดค่าไว้ตรงที่เป้าหมายเหล่านี้จะทราบเกี่ยวกับเป้าหมายที่กําหนดค่าไว้ซึ่งเชื่อมโยงอยู่และผู้ให้บริการของเป้าหมายนั้นด้วย
ชุดแง่มุมที่เผยแพร่ไปตามกราฟความเกี่ยวข้องจะระบุสำหรับแอตทริบิวต์แต่ละรายการโดยใช้ฟังก์ชัน Attribute.Builder.aspects()
มีคลาสที่มีชื่อสับสน 2-3 คลาสที่เข้าร่วมในกระบวนการนี้
AspectClass
คือการใช้งานแง่มุม อาจเป็นใน Java (ในกรณีนี้จะเป็นคลาสย่อย) หรือใน Starlark (ในกรณีนี้จะเป็นอินสแตนซ์ของStarlarkAspectClass
) ซึ่งคล้ายกับRuleConfiguredTargetFactory
AspectDefinition
คือคําจํากัดความของลักษณะ ซึ่งรวมถึงผู้ให้บริการที่จําเป็น ผู้ให้บริการที่มีให้ และมีการอ้างอิงถึงการใช้งาน เช่น อินสแตนซ์AspectClass
ที่เหมาะสม ซึ่งคล้ายกับRuleClass
AspectParameters
เป็นวิธีกำหนดพารามิเตอร์ของลักษณะที่ส่งต่อไปยังกราฟ Dependency ปัจจุบันเป็นแผนที่สตริงกับสตริง ตัวอย่างที่ดีที่แสดงให้เห็นว่าทำไมจึงมีประโยชน์คือ Protocol Buffer: หากภาษาหนึ่งมี API หลายรายการ ระบบควรเผยแพร่ข้อมูลเกี่ยวกับ API ที่ควรสร้าง Protocol Buffer ไปยังกราฟความเกี่ยวข้องAspect
แสดงข้อมูลทั้งหมดที่จําเป็นสําหรับคํานวณแง่มุมที่ส่งต่อไปยังกราฟความเกี่ยวข้อง ซึ่งประกอบด้วยคลาสการแสดงผล คำจำกัดความ และพารามิเตอร์RuleAspect
คือฟังก์ชันที่กําหนดว่ากฎหนึ่งๆ ควรเผยแพร่แง่มุมใด นั่นคือฟังก์ชันRule
->Aspect
ความซับซ้อนที่คาดไม่ถึงคือแง่มุมหนึ่งสามารถแนบไปกับแง่มุมอื่นได้ เช่น แง่มุมที่รวบรวม classpath สําหรับ Java IDE อาจต้องการทราบเกี่ยวกับไฟล์ .jar ทั้งหมดใน classpath แต่ไฟล์บางไฟล์เป็นบัฟเฟอร์โปรโตคอล ในกรณีนี้ ด้าน IDE จะต้องแนบกับคู่ (กฎ proto_library
+ มุมมอง Proto ของ Java)
ระบบจะบันทึกความซับซ้อนขององค์ประกอบในองค์ประกอบไว้ในคลาส
AspectCollection
แพลตฟอร์มและ Toolchain
Bazel รองรับการสร้างแบบหลายแพลตฟอร์ม ซึ่งก็คือการสร้างที่อาจมีสถาปัตยกรรมหลายแบบที่ใช้เรียกใช้การดำเนินการสร้าง และสถาปัตยกรรมหลายแบบที่ใช้สร้างโค้ด สถาปัตยกรรมเหล่านี้เรียกว่าแพลตฟอร์มในภาษาของ Bazel (ดูเอกสารประกอบฉบับเต็มที่นี่)
แพลตฟอร์มจะอธิบายด้วยการแมปคีย์-ค่าจากการตั้งค่าข้อจำกัด (เช่น แนวคิด "สถาปัตยกรรม CPU") ไปยังค่าข้อจำกัด (เช่น CPU บางรุ่น เช่น x86_64) เรามี "พจนานุกรม" ของการตั้งค่าและค่าข้อจำกัดที่ใช้กันมากที่สุดในที่เก็บข้อมูล @platforms
แนวคิดของ toolchain มาจากข้อเท็จจริงที่ว่าคุณอาจต้องใช้คอมไพเลอร์ที่แตกต่างกัน ทั้งนี้ขึ้นอยู่กับแพลตฟอร์มที่ใช้บิลด์และแพลตฟอร์มเป้าหมาย เช่น toolchain C++ บางรายการอาจทำงานบนระบบปฏิบัติการที่เฉพาะเจาะจงและสามารถกำหนดเป้าหมายไปยังระบบปฏิบัติการอื่นๆ ได้ Bazel ต้องกำหนดคอมไพเลอร์ C++ ที่ใช้ตามการเรียกใช้ที่กำหนดและแพลตฟอร์มเป้าหมาย (ดูเอกสารประกอบสำหรับชุดเครื่องมือที่นี่)
ในการทำเช่นนี้ เครื่องมือทางเทคนิคจะมีคำอธิบายประกอบชุดข้อจำกัดด้านการดำเนินการและแพลตฟอร์มเป้าหมายที่รองรับ ด้วยเหตุนี้ คําจํากัดความของเครื่องมือทางเทคนิคจึงแบ่งออกเป็น 2 ส่วน ดังนี้
- กฎ
toolchain()
ที่อธิบายชุดข้อจำกัดด้านการดำเนินการและเป้าหมายที่เครื่องมือทางเทคนิครองรับ และบอกประเภท (เช่น C++ หรือ Java) ของเครื่องมือทางเทคนิค (กฎหลังแสดงโดยกฎtoolchain_type()
) - กฎเฉพาะภาษาที่อธิบายเครื่องมือทางเทคนิคจริง (เช่น
cc_toolchain()
)
การดำเนินการนี้เกิดขึ้นเนื่องจากเราจำเป็นต้องทราบข้อจำกัดของเครื่องมือทุกชุดเพื่อทำการแก้ไขเครื่องมือและกฎ *_toolchain()
สำหรับภาษาใดภาษาหนึ่งจะมีข้อมูลมากกว่านั้นมาก จึงใช้เวลาโหลดนานกว่า
แพลตฟอร์มการเรียกใช้จะระบุด้วยวิธีใดวิธีหนึ่งต่อไปนี้
- ในไฟล์ MODULE.bazel โดยใช้ฟังก์ชัน
register_execution_platforms()
- ในบรรทัดคำสั่งโดยใช้ตัวเลือก บรรทัดคำสั่ง --extra_execution_platforms
ระบบจะคำนวณชุดแพลตฟอร์มการดำเนินการที่ใช้ได้ใน
RegisteredExecutionPlatformsFunction
แพลตฟอร์มเป้าหมายสําหรับเป้าหมายที่กําหนดค่าไว้จะกําหนดโดย
PlatformOptions.computeTargetPlatform()
รายการแพลตฟอร์มนี้เพราะเราต้องการรองรับแพลตฟอร์มเป้าหมายหลายแพลตฟอร์มในอนาคต แต่ยังไม่ได้ใช้งาน
ชุดเครื่องมือที่จะใช้กับเป้าหมายที่กําหนดค่าไว้จะกําหนดโดย
ToolchainResolutionFunction
ซึ่งขึ้นอยู่กับปัจจัยต่อไปนี้
- ชุดเครื่องมือทางเทคนิคที่ลงทะเบียน (ในไฟล์ MODULE.bazel และการกําหนดค่า)
- แพลตฟอร์มการดำเนินการและแพลตฟอร์มเป้าหมายที่ต้องการ (ในการกําหนดค่า)
- ชุดประเภทเครื่องมือทางเทคนิคที่จําเป็นสําหรับเป้าหมายที่กําหนดค่าไว้ (ใน
UnloadedToolchainContextKey)
- ชุดข้อจำกัดของแพลตฟอร์มการเรียกใช้ของเป้าหมายที่กําหนดค่าไว้ (แอตทริบิวต์
exec_compatible_with
) และการกําหนดค่า (--experimental_add_exec_constraints_to_targets
) ในUnloadedToolchainContextKey
ผลลัพธ์ที่ได้คือ UnloadedToolchainContext
ซึ่งโดยพื้นฐานแล้วคือการแมปจากประเภทเครื่องมือ (แสดงเป็นอินสแตนซ์ ToolchainTypeInfo
) กับป้ายกำกับของเครื่องมือที่เลือก วิธีนี้เรียกว่า "ยกเลิกการโหลด" เนื่องจากไม่มีเครื่องมือโซ่ในตัว แต่มีเพียงป้ายกำกับของโซ่เท่านั้น
จากนั้นระบบจะโหลด Toolchain จริงๆ โดยใช้ ResolvedToolchainContext.load()
และใช้โดยการใช้งานเป้าหมายที่กำหนดค่าไว้ซึ่งส่งคำขอ
นอกจากนี้ เรายังมีระบบเดิมที่อาศัยการกําหนดค่า "โฮสต์" รายการเดียวและการกําหนดค่าเป้าหมายที่แสดงโดย Flag การกําหนดค่าต่างๆ เช่น --cpu
เรากําลังค่อยๆ เปลี่ยนไปใช้ระบบข้างต้น เราได้ใช้การแมปแพลตฟอร์มเพื่อแปลค่าระหว่างแฟล็กเดิมกับข้อจำกัดแพลตฟอร์มรูปแบบใหม่ ในการจัดการกรณีที่ผู้คนใช้ค่าการกําหนดค่าเดิม
โค้ดของพวกเขาอยู่ใน PlatformMappingFunction
และใช้ "ภาษาง่ายๆ" ที่ไม่ใช่ Starlark
ข้อจำกัด
บางครั้งคุณอาจต้องการกำหนดเป้าหมายให้ใช้ได้กับแพลตฟอร์มเพียงไม่กี่แพลตฟอร์ม Bazel มีกลไกหลายอย่าง (ซึ่งน่าเสียดาย) ในการบรรลุเป้าหมายนี้ ดังนี้
- ข้อจำกัดเฉพาะกฎ
environment_group()
/environment()
- ข้อจำกัดของแพลตฟอร์ม
ข้อจำกัดเฉพาะกฎส่วนใหญ่ใช้ใน Google สำหรับกฎ Java ซึ่งกำลังจะเลิกใช้งานและไม่มีให้ใช้งานใน Bazel แต่ซอร์สโค้ดอาจมีการอ้างอิงถึงข้อจำกัดดังกล่าว แอตทริบิวต์ที่ควบคุมกระบวนการนี้เรียกว่า
constraints=
environment_group() และ environment()
กฎเหล่านี้เป็นกลไกเดิมและไม่มีการใช้งานอย่างกว้างขวาง
กฎการสร้างทั้งหมดสามารถประกาศ "สภาพแวดล้อม" ที่สามารถสร้างได้ โดยที่ "สภาพแวดล้อม" คืออินสแตนซ์ของกฎ environment()
คุณระบุสภาพแวดล้อมที่รองรับสำหรับกฎได้หลายวิธี ดังนี้
- ผ่านแอตทริบิวต์
restricted_to=
รูปแบบนี้เป็นรูปแบบที่ตรงที่สุดของข้อกําหนด ซึ่งจะประกาศชุดสภาพแวดล้อมที่แน่นอนที่กฎรองรับสําหรับกลุ่มนี้ - ผ่านแอตทริบิวต์
compatible_with=
คำสั่งนี้จะประกาศสภาพแวดล้อมที่กฎรองรับนอกเหนือจากสภาพแวดล้อม "มาตรฐาน" ที่รองรับโดยค่าเริ่มต้น - ผ่านแอตทริบิวต์ระดับแพ็กเกจ
default_restricted_to=
และdefault_compatible_with=
- ผ่านข้อกําหนดเริ่มต้นในกฎ
environment_group()
สภาพแวดล้อมทุกสภาพแวดล้อมจะอยู่ในกลุ่มของคู่แข่งที่เกี่ยวข้องตามธีม (เช่น "สถาปัตยกรรม CPU" "เวอร์ชัน JDK" หรือ "ระบบปฏิบัติการบนอุปกรณ์เคลื่อนที่") การกําหนดกลุ่มสภาพแวดล้อมจะระบุสภาพแวดล้อมที่ควรรองรับโดย "ค่าเริ่มต้น" หากไม่ได้ระบุไว้เป็นอย่างอื่นโดยแอตทริบิวต์restricted_to=
/environment()
กฎที่ไม่มีแอตทริบิวต์ดังกล่าวจะรับค่าเริ่มต้นทั้งหมด - ผ่านค่าเริ่มต้นของคลาสกฎ ซึ่งจะลบล้างค่าเริ่มต้นส่วนกลางสำหรับอินสแตนซ์ทั้งหมดของคลาสกฎที่ระบุ ตัวอย่างเช่น วิธีนี้จะช่วยให้กฎ
*_test
ทั้งหมดทดสอบได้โดยที่แต่ละอินสแตนซ์ไม่ต้องประกาศความสามารถนี้อย่างชัดแจ้ง
มีการใช้งาน environment()
เป็นกฎปกติ ส่วน environment_group()
เป็นทั้งคลาสย่อยของ Target
แต่ไม่ใช่ Rule
(EnvironmentGroup
) และฟังก์ชันที่พร้อมใช้งานโดยค่าเริ่มต้นจาก Starlark (StarlarkLibrary.environmentGroup()
) ซึ่งสุดท้ายแล้วจะสร้างเป้าหมายที่เป็นนามแฝง ทั้งนี้เพื่อหลีกเลี่ยงการขึ้นต่อกันแบบวนซ้ำที่จะเกิดขึ้นเนื่องจากแต่ละสภาพแวดล้อมต้องประกาศกลุ่มสภาพแวดล้อมที่กลุ่มสภาพแวดล้อมนั้นเป็นสมาชิกอยู่ และแต่ละกลุ่มสภาพแวดล้อมต้องประกาศสภาพแวดล้อมเริ่มต้น
คุณจำกัดบิลด์ให้ใช้ได้กับบางสภาพแวดล้อมได้โดยใช้ตัวเลือกบรรทัดคำสั่ง --target_environment
การใช้งานการตรวจสอบข้อจำกัดมีอยู่ใน RuleContextConstraintSemantics
และ TopLevelConstraintSemantics
ข้อจำกัดของแพลตฟอร์ม
ปัจจุบันวิธี "อย่างเป็นทางการ" ในการอธิบายแพลตฟอร์มที่เป้าหมายเข้ากันได้คือการใช้ข้อจำกัดเดียวกับที่ใช้อธิบายเครื่องมือและแพลตฟอร์ม อยู่ระหว่างตรวจสอบในคำขอดึงข้อมูล #10945
ระดับการแชร์
ถ้าคุณทำงานกับโค้ดเบสขนาดใหญ่กับนักพัฒนาซอฟต์แวร์จำนวนมาก (เช่นที่ Google) คุณต้องดูแลไม่ให้คนอื่นๆ พึ่งพาโค้ดของคุณโดยพลการ มิเช่นนั้น ผู้คนจะพึ่งพาลักษณะการทำงานที่คุณคิดว่าเป็นรายละเอียดการใช้งานตามกฎของ Hyrum
Bazel รองรับการดำเนินการนี้ด้วยกลไกที่เรียกว่าระดับการเข้าถึง ซึ่งคุณสามารถประกาศว่าเป้าหมายหนึ่งๆ ใช้ได้เฉพาะกับแอตทริบิวต์visibility เท่านั้น แอตทริบิวต์นี้มีความพิเศษเล็กน้อยเนื่องจากแม้ว่าจะมีรายการป้ายกำกับ แต่ป้ายกำกับเหล่านี้อาจเข้ารหัสรูปแบบเหนือชื่อแพ็กเกจแทนที่จะเป็นเคอร์เซอร์ไปยังเป้าหมายที่เฉพาะเจาะจง (ใช่ นี่ถือเป็นข้อบกพร่องในการออกแบบ)
ซึ่งติดตั้งใช้งานในตำแหน่งต่อไปนี้
- อินเทอร์เฟซ
RuleVisibility
แสดงประกาศการแสดงผล โดยอาจเป็นค่าคงที่ (สาธารณะทั้งหมดหรือส่วนตัวทั้งหมด) หรือรายการป้ายกำกับก็ได้ - ป้ายกำกับอาจหมายถึงกลุ่มแพ็กเกจ (รายการแพ็กเกจที่กำหนดไว้ล่วงหน้า) แพ็กเกจโดยตรง (
//pkg:__pkg__
) หรือแพ็กเกจย่อย (//pkg:__subpackages__
) ซึ่งแตกต่างจากไวยากรณ์บรรทัดคำสั่งที่ใช้//pkg:*
หรือ//pkg/...
- กลุ่มแพ็กเกจจะใช้เป็นเป้าหมายของตัวเอง (
PackageGroup
) และเป้าหมายที่กำหนดค่าไว้ (PackageGroupConfiguredTarget
) เราอาจแทนที่กลุ่มแพ็กเกจเหล่านี้ด้วยกฎง่ายๆ ได้หากต้องการ ระบบจะใช้ตรรกะเหล่านี้โดยได้รับความช่วยเหลือจากPackageSpecification
ซึ่งสอดคล้องกับรูปแบบเดียว เช่น//pkg/...
,PackageGroupContents
ซึ่งสอดคล้องกับแอตทริบิวต์packages
ของpackage_group
รายการเดียว และPackageSpecificationProvider
ซึ่งรวบรวมข้อมูลในpackage_group
และincludes
แบบเปลี่ยนผ่าน - การเปลี่ยนจากรายการป้ายกำกับระดับการเข้าถึงเป็นรายการทรัพยากรที่เกี่ยวข้องจะดำเนินการใน
DependencyResolver.visitTargetVisibility
และที่อื่นๆ อีกเล็กน้อย - การตรวจสอบจริงจะดำเนินการใน
CommonPrerequisiteValidator.validateDirectPrerequisiteVisibility()
ชุดที่ซ้อนกัน
บ่อยครั้ง เป้าหมายที่กําหนดค่าไว้จะรวบรวมชุดไฟล์จากข้อกําหนด เพิ่มไฟล์ของตัวเอง และรวมชุดข้อมูลรวมไว้ในผู้ให้บริการข้อมูลแบบเปลี่ยนผ่านเพื่อให้เป้าหมายที่กําหนดค่าไว้ซึ่งใช้ข้อมูลดังกล่าวทําสิ่งเดียวกันได้ ตัวอย่าง
- ไฟล์ส่วนหัว C++ ที่ใช้สำหรับบิลด์
- ไฟล์ออบเจ็กต์ที่แทนการปิดแบบทรานซิทีฟของ
cc_library
- ชุดของไฟล์ .jar ที่ต้องอยู่ในคลาสพาธเพื่อให้กฎ Java คอมไพล์หรือเรียกใช้
- ชุดไฟล์ Python ใน Closure แบบทรานซิทีฟของกฎ Python
หากทําด้วยวิธีที่ไม่ซับซ้อนโดยใช้ List
หรือ Set
ผลลัพธ์ที่ได้คือการใช้งานหน่วยความจําแบบสี่เหลี่ยมจัตุรัส กล่าวคือ หากมีกฎ N รายการและแต่ละกฎเพิ่มไฟล์ 1 ไฟล์ เราก็จะมีสมาชิกคอลเล็กชัน 1+2+...+N
ในการแก้ปัญหานี้ เราจึงคิดคอนเซ็ปต์ของ
NestedSet
ซึ่งเป็นโครงสร้างข้อมูลที่ประกอบด้วยอินสแตนซ์ NestedSet
อื่นๆ และสมาชิกบางส่วนของตนเอง จึงเป็นกราฟชุดแบบมีทิศทางแบบไม่มีวงวน รายการเหล่านี้เป็นแบบคงที่และสามารถวนซ้ำสมาชิกได้ เรากําหนดลําดับการวนซ้ำหลายรายการ (NestedSet.Order
) ได้แก่ ลําดับก่อน ลําดับหลัง ลําดับเชิง topologic (โหนดจะตามหลังบรรพบุรุษเสมอ) และ "ไม่สนใจ แต่ควรเหมือนกันทุกครั้ง"
โครงสร้างข้อมูลเดียวกันนี้เรียกว่า depset
ใน Starlark
รายการต่างๆ และการดำเนินการ
บิลด์จริงประกอบด้วยชุดคำสั่งที่ต้องเรียกใช้เพื่อสร้างเอาต์พุตที่ผู้ใช้ต้องการ คำสั่งจะแสดงเป็นอินสแตนซ์ของคลาส Action
และไฟล์จะแสดงเป็นอินสแตนซ์ของคลาส Artifact
โดยจัดเรียงเป็นกราฟแบบ 2 กลุ่มที่มีทิศทางและไม่วนซ้ำ ซึ่งเรียกว่า "กราฟการดำเนินการ"
ออบเจ็กต์โค้ดมี 2 ประเภท ได้แก่ ออบเจ็กต์โค้ดต้นทาง (ออบเจ็กต์โค้ดที่มีให้ใช้งานก่อน Bazel เริ่มดำเนินการ) และออบเจ็กต์โค้ดที่ดึงข้อมูล (ออบเจ็กต์โค้ดที่ต้องสร้าง) อาร์ติแฟกต์ที่ดึงข้อมูลมาอาจมีได้หลายประเภท ดังนี้
- **รายการทั่วไป **ระบบจะตรวจสอบความทันสมัยของไฟล์เหล่านี้โดยคํานวณการตรวจสอบผลรวมโดยใช้ mtime เป็นทางลัด เราจะไม่ตรวจสอบผลรวมของไฟล์หาก ctime ของไฟล์ไม่เปลี่ยนแปลง
- อาร์ติแฟกต์ลิงก์สัญลักษณ์ที่ยังไม่ได้รับการแก้ไข ระบบจะตรวจสอบว่าไฟล์เหล่านี้เป็นเวอร์ชันล่าสุดหรือไม่โดยเรียกใช้ readlink() ซึ่งต่างจากอาร์ติแฟกต์ทั่วไปตรงที่ไฟล์เหล่านี้อาจเป็น symlink ที่ไม่มีการอ้างอิง มักใช้ในกรณีที่จะแพ็กไฟล์บางไฟล์ลงในไฟล์เก็บถาวร
- อาร์ติแฟกต์ของต้นไม้ ไฟล์เหล่านี้ไม่ใช่ไฟล์เดี่ยว แต่เป็นแผนผังไดเรกทอรี ระบบจะตรวจสอบความเป็นปัจจุบันโดยตรวจสอบชุดของไฟล์และเนื้อหาในไฟล์ โดยจะแสดงเป็น
TreeArtifact
- อาร์ติแฟกต์ข้อมูลเมตาแบบคงที่ การเปลี่ยนแปลงอาร์ติแฟกต์เหล่านี้จะไม่ทริกเกอร์การสร้างใหม่ ข้อมูลนี้ใช้สำหรับข้อมูลการประทับเวลาของบิลด์เท่านั้น เราไม่ต้องการสร้างใหม่เพียงเพราะเวลาปัจจุบันมีการเปลี่ยนแปลง
ไม่มีเหตุผลพื้นฐานว่าทำไมอาร์ติแฟกต์ต้นฉบับไม่สามารถเป็นอาร์ติแฟกต์แบบต้นไม้หรืออาร์ติแฟกต์ลิงก์สัญลักษณ์ที่ยังไม่ได้รับการแก้ไข เพียงแต่เรายังไม่ได้นำอาร์ติแฟกต์ดังกล่าวมาใช้ (แต่เราควร การอ้างอิงไดเรกทอรีแหล่งที่มาในไฟล์ BUILD
เป็นหนึ่งในปัญหาความไม่ถูกต้องที่พบมาอย่างยาวนาน 2-3 ปัญหาของ Bazel เรามีการติดตั้งใช้งานประเภทดังกล่าวที่เปิดใช้งานโดยพร็อพเพอร์ตี้ JVM ของ BAZEL_TRACK_SOURCE_DIRECTORIES=1
)
Artifact
ประเภทหนึ่งที่น่าสนใจคือสื่อกลาง โดยจะมีเครื่องหมายเป็น Artifact
อินสแตนซ์ที่เป็นเอาต์พุตของ MiddlemanAction
คำสั่งเหล่านี้ใช้ในสถานการณ์
พิเศษ เช่น
- สื่อกลางการรวบรวมข้อมูลใช้เพื่อจัดกลุ่มรายการต่างๆ เข้าด้วยกัน กล่าวคือ หากการทำงานจำนวนมากใช้ชุดอินพุตขนาดใหญ่ชุดเดียวกัน เราจะไม่มีขอบเขตการขึ้นต่อกัน N*M และจะมีเฉพาะ N+M (แทนที่ด้วยชุดที่ซ้อนกัน)
- การกำหนดเวลาตัวกลางของความเกี่ยวข้องช่วยให้มั่นใจได้ว่าการดำเนินการหนึ่งจะทำงานก่อนการดำเนินการอื่น
โดยส่วนใหญ่มักใช้สำหรับการวิเคราะห์โค้ด แต่ใช้สำหรับการรวบรวม C++ ด้วย (ดูคำอธิบายใน
CcCompilationContext.createMiddleman()
) - คนกลางของ Runfile ใช้เพื่อให้แน่ใจว่ามีโครงสร้าง Runfile เพื่อที่จะได้ไม่ต้องพึ่งไฟล์ Manifest ของเอาต์พุตและอาร์ติแฟกต์ทั้งหมดที่โครงสร้าง Runfiles อ้างอิง
สิ่งที่ควรทราบคือคำสั่งที่ต้องเรียกใช้ สภาพแวดล้อมที่จำเป็น และชุดเอาต์พุตที่สร้างขึ้น องค์ประกอบหลักของคำอธิบายการดำเนินการมีดังนี้
- บรรทัดคำสั่งที่จำเป็นต้องเรียกใช้
- อาร์ติแฟกต์อินพุตที่จําเป็น
- ตัวแปรสภาพแวดล้อมที่ต้องตั้งค่า
- คําอธิบายประกอบที่อธิบายถึงสภาพแวดล้อม (เช่น แพลตฟอร์ม) ที่จําเป็นต้องใช้งาน \
นอกจากนี้ยังมีกรณีพิเศษอื่นๆ อีก 2-3 กรณี เช่น การเขียนไฟล์ที่ Bazel รู้จักเนื้อหา รายการเหล่านี้เป็นคลาสย่อยของ AbstractAction
การดำเนินการส่วนใหญ่จะเป็น SpawnAction
หรือ StarlarkAction
(เหมือนกัน กล่าวคือไม่ควรเป็นคลาสแยกกัน) แม้ว่า Java และ C++ จะมีประเภทการดำเนินการเป็นของตัวเอง (JavaCompileAction
, CppCompileAction
และ CppLinkAction
)
ในที่สุดเราก็อยากย้ายทุกอย่างไปยัง SpawnAction
JavaCompileAction
นั้นใกล้เคียงมากแล้ว แต่ C++ นั้นค่อนข้างพิเศษเนื่องจากมีการแยกวิเคราะห์ไฟล์ .d และการสแกนรวม
กราฟการดำเนินการส่วนใหญ่จะ "ฝัง" อยู่ในกราฟ Skyframe โดยแนวคิดคือการดำเนินการของการดำเนินการจะแสดงเป็นคําเรียกใช้ ActionExecutionFunction
การแมปจากขอบทรัพยากร Dependency ของกราฟการดำเนินการไปยังขอบทรัพยากร Dependency ของ Skyframe อธิบายไว้ใน ActionExecutionFunction.getInputDeps()
และ Artifact.key()
และมีการเพิ่มประสิทธิภาพบางอย่างเพื่อรักษาจำนวนขอบ Skyframe ให้ต่ำ
- อาร์ติแฟกต์ที่ดึงข้อมูลมาจะไม่มี
SkyValue
เป็นของตัวเอง แต่จะใช้Artifact.getGeneratingActionKey()
เพื่อค้นหาคีย์สําหรับการดําเนินการที่สร้างรายการนั้นแทน - ชุดที่ฝังจะมีคีย์ Skyframe ของตนเอง
การดำเนินการที่แชร์
การดำเนินการบางอย่างสร้างขึ้นโดยเป้าหมายที่กำหนดค่าไว้หลายรายการ กฎ Starlark จะจํากัดมากกว่าเนื่องจากได้รับอนุญาตให้วางการดำเนินการที่ดึงข้อมูลไว้ในไดเรกทอรีที่กําหนดโดยการกำหนดค่าและแพ็กเกจเท่านั้น (แต่ถึงอย่างนั้น กฎในแพ็กเกจเดียวกันก็อาจขัดแย้งกันได้) แต่กฎที่ติดตั้งใช้งานใน Java จะวางอาร์ติแฟกต์ที่ดึงข้อมูลไว้ที่ใดก็ได้
การดำเนินการนี้ถือว่าไม่ถูกต้อง แต่การกำจัดการดำเนินการนี้ออกนั้นทำได้ยากมากเนื่องจากช่วยประหยัดเวลาในการดำเนินการได้อย่างมาก เช่น เมื่อต้องประมวลผลไฟล์ต้นทางด้วยวิธีใดวิธีหนึ่งและไฟล์ดังกล่าวมีการอ้างอิงโดยกฎหลายข้อ (handwave-handwave) เรื่องนี้ขึ้นอยู่กับค่าใช้จ่ายของ RAM บางส่วน: อินสแตนซ์แต่ละรายการของการดำเนินการที่แชร์ต้องจัดเก็บไว้ในหน่วยความจำแยกกัน
หากการดำเนินการ 2 รายการสร้างไฟล์เอาต์พุตเดียวกัน การดำเนินการ 2 รายการจะต้องมีเหมือนกันทุกประการ กล่าวคือ มีอินพุตเหมือนกัน เอาต์พุตเดียวกัน และเรียกใช้บรรทัดคำสั่งเดียวกัน ความสัมพันธ์ที่เทียบเท่านี้ใช้ใน Actions.canBeShared()
และได้รับการยืนยันระหว่างระยะการวิเคราะห์และระยะดำเนินการโดยดูที่การดำเนินการแต่ละรายการ
การดำเนินการนี้ใช้ใน SkyframeActionExecutor.findAndStoreArtifactConflicts()
และเป็นหนึ่งในไม่กี่แห่งใน Bazel ที่กำหนดให้ต้องใช้มุมมอง "ส่วนกลาง" ของบิลด์
ระยะการดําเนินการ
ขั้นตอนนี้เป็นเวลาที่ Bazel เริ่มเรียกใช้การดำเนินการสร้างจริง เช่น คำสั่งที่ผลิตเอาต์พุต
สิ่งแรกที่ Bazel ทำหลังจากช่วงการวิเคราะห์คือการกำหนดสิ่งที่จำเป็นต้องสร้างอาร์ติแฟกต์ ตรรกะสำหรับการดำเนินการนี้ได้รับการเข้ารหัสใน TopLevelArtifactHelper
โดยคร่าวๆ ก็คือ filesToBuild
ของเป้าหมายที่กําหนดค่าไว้ในบรรทัดคําสั่งและเนื้อหาของกลุ่มเอาต์พุตพิเศษเพื่อวัตถุประสงค์ที่ชัดเจนในการระบุว่า "หากเป้าหมายนี้อยู่ในบรรทัดคําสั่ง ให้สร้างอาร์ติแฟกต์เหล่านี้"
ขั้นตอนถัดไปคือการสร้างรูทการดําเนินการ เนื่องจาก Bazel มีตัวเลือกในการอ่านแพ็กเกจซอร์สโค้ดจากตำแหน่งต่างๆ ในระบบไฟล์ (--package_path
) จึงต้องระบุการดำเนินการที่ดำเนินการในเครื่องด้วยสคีมาซอร์สโค้ดแบบสมบูรณ์ การดำเนินการนี้จัดการโดยคลาส SymlinkForest
และทำงานโดยการบันทึกเป้าหมายทั้งหมดที่ใช้ในระยะการวิเคราะห์ และสร้างต้นไม้ไดเรกทอรีเดียวซึ่งลิงก์สัญลักษณ์แพ็กเกจทั้งหมดที่มีเป้าหมายที่ใช้จากตำแหน่งจริง อีกทางเลือกหนึ่งคือการส่งเส้นทางที่ถูกต้องไปยังคําสั่ง (โดยคํานึงถึง --package_path
)
ซึ่งเป็นสิ่งที่ไม่พึงประสงค์เนื่องจากเหตุผลต่อไปนี้
- โดยเปลี่ยนบรรทัดคำสั่งการดำเนินการเมื่อมีการย้ายแพ็กเกจจากรายการเส้นทางแพ็กเกจไปยังรายการอื่น (เคยเกิดขึ้นบ่อย)
- ซึ่งจะส่งผลให้บรรทัดคำสั่งแตกต่างกันหากการดําเนินการทํางานจากระยะไกลหรือทํางานในเครื่อง
- จำเป็นต้องเปลี่ยนรูปแบบบรรทัดคำสั่งเฉพาะในเครื่องมือที่ใช้งานอยู่ (พิจารณาความแตกต่างระหว่างเส้นทาง เช่น Java classpaths และ C++ รวม)
- การเปลี่ยนบรรทัดคำสั่งของการดำเนินการจะทำให้รายการแคชการดำเนินการนั้นใช้งานไม่ได้
--package_path
เริ่มเลิกใช้งานอย่างช้าๆ และคงที่
จากนั้น Bazel เริ่มข้ามผ่านกราฟการกระทำ (กราฟสองพาร์ท กราฟทิศทางที่ประกอบด้วยการกระทำ และอาร์ติแฟกต์อินพุตและเอาต์พุต) และการเรียกใช้การกระทำ
การดำเนินการแต่ละรายการจะแสดงโดยอินสแตนซ์ของSkyValue
คลาส ActionExecutionValue
เนื่องจากการดำเนินการมีค่าใช้จ่ายสูง เราจึงมีการแคช 2-3 ชั้นที่เข้าถึงได้เบื้องหลัง Skyframe ดังนี้
ActionExecutionFunction.stateMap
มีข้อมูลที่จะทำให้การรีสตาร์ท Skyframe ของActionExecutionFunction
ราคาถูก- แคชการดำเนินการในเครื่องมีข้อมูลเกี่ยวกับสถานะของระบบไฟล์
- ระบบการดําเนินการจากระยะไกลมักจะมีแคชของตนเองด้วย
แคชการกระทําเกี่ยวกับสถานที่
แคชนี้เป็นอีกเลเยอร์หนึ่งที่อยู่หลัง Skyframe แม้ว่าจะมีการดำเนินการซ้ำใน Skyframe แล้ว แคชก็ยังคงสามารถถูกโจมตีในแคชการกระทำในเครื่องได้ ซึ่งแสดงสถานะของระบบไฟล์ในเครื่องและได้รับการจัดรูปแบบเป็นอนุกรมไปยังดิสก์ ซึ่งหมายความว่าเมื่อเริ่มต้นเซิร์ฟเวอร์ Bazel ใหม่ คุณจะได้รับ Hit ของแคชการดำเนินการในเครื่องแม้ว่ากราฟ Skyframe จะว่างเปล่าก็ตาม
ระบบจะตรวจสอบแคชนี้เพื่อหา Hit โดยใช้เมธอด ActionCacheChecker.getTokenIfNeedToExecute()
ซึ่งตรงข้ามกับชื่อที่เรียก เพราะเป็นแผนที่จากเส้นทางของอาร์ติแฟกต์ที่ดึงข้อมูลมายังการดำเนินการที่ทำให้เกิดอาร์ติแฟกต์ การดําเนินการมีคำอธิบายดังนี้
- ชุดไฟล์อินพุตและเอาต์พุต รวมถึงการตรวจสอบผลรวม
- "คีย์การดำเนินการ" ซึ่งมักจะเป็นบรรทัดคำสั่งที่เรียกใช้ แต่โดยทั่วไปจะแสดงทุกอย่างที่ไม่ได้บันทึกไว้โดย checksum ของไฟล์อินพุต (เช่น สำหรับ
FileWriteAction
คือ checksum ของข้อมูลที่เขียนไว้)
นอกจากนี้ ยังมี "แคชการดำเนินการจากด้านบน" ที่อยู่ระหว่างการพัฒนา ซึ่งใช้แฮชแบบทรานซิทีฟเพื่อหลีกเลี่ยงการไปยังแคชในหลายๆ ครั้ง
การค้นพบอินพุตและการกรองอินพุต
การดำเนินการบางอย่างมีความซับซ้อนมากกว่าการมีชุดอินพุต การเปลี่ยนแปลงชุดอินพุตของการดําเนินการมีอยู่ 2 รูปแบบ ดังนี้
- การดำเนินการอาจค้นพบอินพุตใหม่ก่อนดำเนินการ หรือตัดสินใจว่าอินพุตบางอย่างไม่จำเป็น ตัวอย่างมาตรฐานคือ C++ ซึ่งควรที่จะคาดเดาอย่างมีข้อมูลเกี่ยวกับไฟล์ส่วนหัวที่ไฟล์ C++ ใช้จาก Closure แบบทรานซิทีฟ เพื่อที่เราจะได้ไม่ต้องส่งไฟล์ทุกไฟล์ไปยังผู้ดำเนินการระยะไกล ดังนั้นเราจึงมีตัวเลือกที่จะไม่ลงทะเบียนไฟล์ส่วนหัวทุกไฟล์เป็น "อินพุต" แต่สแกนไฟล์ต้นฉบับเพื่อหาส่วนหัวที่รวมอยู่แบบทรานซิทีฟ และทําเครื่องหมายไฟล์ส่วนหัวเหล่านั้นเป็นอินพุตที่กล่าวถึงในคำสั่ง
#include
เท่านั้น (เราประเมินค่าสูงเกินจริงเพื่อที่จะไม่ต้องใช้โปรแกรมเตรียม C แบบสมบูรณ์) ปัจจุบันตัวเลือกนี้ได้รับการตั้งค่าเป็น "เท็จ" ใน Bazel และใช้ใน Google เท่านั้น - การดําเนินการอาจพบว่าไม่ได้ใช้ไฟล์บางไฟล์ในระหว่างการดําเนินการ ใน C++ สิ่งนี้เรียกว่า "ไฟล์ .d": คอมไพเลอร์จะบอกไฟล์ส่วนหัวที่ใช้หลังจากสร้างไปแล้ว และ Bazel ใช้ประโยชน์จากข้อเท็จจริงนี้เพื่อหลีกเลี่ยงความอับอายที่การปรับปรุงแย่กว่า Make ซึ่งจะประมาณได้ดีกว่าเครื่องมือสแกนรวม เนื่องจากใช้คอมไพเลอร์
การดำเนินการเหล่านี้จะใช้เมธอดในการดำเนินการ
Action.discoverInputs()
เรียก ซึ่งควรแสดงผลชุดอาร์ติแฟกต์ที่ซ้อนกันซึ่งพิจารณาแล้วว่าจำเป็น ตัวแปรเหล่านี้ต้องเป็นอาร์ติแฟกต์ต้นทางเพื่อไม่ให้มีขอบของทรัพยากร Dependency ในกราฟการดำเนินการที่ไม่มีสิ่งที่เทียบเท่ากันในกราฟเป้าหมายที่กําหนดค่าไว้- การดำเนินการจะดำเนินการโดยเรียกใช้
Action.execute()
- เมื่อจบ
Action.execute()
การดำเนินการจะเรียกใช้Action.updateInputs()
เพื่อบอก Bazel ว่าไม่จำเป็นต้องป้อนข้อมูลทั้งหมด ซึ่งอาจส่งผลให้มีการบิลด์ที่เพิ่มขึ้นไม่ถูกต้องหากมีการรายงานว่าอินพุตที่ใช้แล้วไม่ได้ใช้งาน
เมื่อแคชการดำเนินการแสดงผลลัพธ์ในอินสแตนซ์การดำเนินการใหม่ (เช่น สร้างขึ้นหลังจากรีสตาร์ทเซิร์ฟเวอร์) Bazel จะเรียกใช้ updateInputs()
เองเพื่อให้ชุดอินพุตแสดงผลลัพธ์ของการค้นพบและการตัดอินพุตที่ดำเนินการไปก่อนหน้านี้
การดำเนินการของ Starlark จะใช้ประโยชน์จากเครื่องมือเพื่อประกาศอินพุตบางรายการว่าไม่ได้ใช้งานโดยใช้อาร์กิวเมนต์ unused_inputs_list=
ของ ctx.actions.run()
วิธีต่างๆ ในการดำเนินการ: Strategies/ActionContexts
การดำเนินการบางอย่างสามารถเรียกใช้ได้หลายวิธี เช่น บรรทัดคำสั่งสามารถดำเนินการได้แบบในเครื่อง ดำเนินการในเครื่องแต่ในแซนด์บ็อกซ์ประเภทต่างๆ หรือดำเนินการจากระยะไกล แนวคิดที่รวมสิ่งนี้ไว้เรียกว่า ActionContext
(หรือ Strategy
เนื่องจากเราเปลี่ยนชื่อได้เพียงครึ่งทางเท่านั้น...)
วงจรชีวิตของบริบทการดำเนินการมีดังนี้
- เมื่อเริ่มระยะการดําเนินการ ระบบจะถามอินสแตนซ์
BlazeModule
ว่ามีบริบทการดําเนินการใดบ้าง ซึ่งเกิดขึ้นในคอนสตรัคเตอร์ของExecutionTool
ประเภทบริบทการดำเนินการจะระบุโดยอินสแตนซ์ JavaClass
ที่อ้างถึงอินเทอร์เฟซย่อยของActionContext
และอินเทอร์เฟซที่บริบทการดำเนินการต้องใช้ - ระบบจะเลือกบริบทการดำเนินการที่เหมาะสมจากบริบทที่มี แล้วส่งต่อไปยัง
ActionExecutionContext
และBlazeExecutor
- การดำเนินการจะขอบริบทโดยใช้
ActionExecutionContext.getContext()
และBlazeExecutor.getStrategy()
(จริงๆ แล้วควรมีวิธีเดียวเท่านั้น)
กลยุทธ์สามารถเรียกใช้กลยุทธ์อื่นๆ เพื่อทำตามหน้าที่ได้ ตัวอย่างเช่น กลยุทธ์แบบไดนามิกที่เริ่มการดำเนินการทั้งแบบในเครื่องและจากระยะไกล จากนั้นจะใช้กลยุทธ์ใดก็ตามที่เสร็จสิ้นก่อน
กลยุทธ์ที่เด่นอย่างหนึ่งคือกลยุทธ์ที่ใช้กระบวนการของผู้ปฏิบัติงานอย่างต่อเนื่อง (WorkerSpawnStrategy
) แนวคิดคือเครื่องมือบางอย่างมีระยะเวลาเริ่มต้นนาน จึงควรนำกลับมาใช้ใหม่ระหว่างการดำเนินการต่างๆ แทนการเริ่มต้นใหม่สำหรับการดำเนินการทุกอย่าง (ซึ่งแสดงถึงปัญหาความถูกต้องที่อาจเกิดขึ้น เนื่องจาก Bazel ยึดมั่นในคำมั่นสัญญาในกระบวนการของพนักงานว่าไม่มีสถานะที่สังเกตได้ระหว่างคำขอแต่ละรายการ)
หากเครื่องมือมีการเปลี่ยนแปลง จะต้องรีสตาร์ทกระบวนการทำงาน ระบบจะพิจารณาว่าจะใช้ผู้ดําเนินการซ้ำได้หรือไม่โดยคํานวณการตรวจสอบผลรวมของเครื่องมือที่ใช้โดยใช้ WorkerFilesHash
การดำเนินการนี้ขึ้นอยู่กับการทราบว่าอินพุตใดของการดำเนินการที่แสดงถึงส่วนหนึ่งของเครื่องมือและอินพุตใดที่แสดงถึงอินพุต ซึ่งจะกำหนดโดยผู้สร้างการดำเนินการ Spawn.getToolFiles()
และไฟล์รันไทม์ของ Spawn
จะนับเป็นส่วนหนึ่งของเครื่องมือ
ข้อมูลเพิ่มเติมเกี่ยวกับกลยุทธ์ (หรือบริบทการกระทํา)
- ดูข้อมูลเกี่ยวกับกลยุทธ์ต่างๆ ในการเรียกใช้การดำเนินการได้ที่นี่
- ข้อมูลเกี่ยวกับกลยุทธ์แบบไดนามิก ซึ่งเราเรียกใช้การดำเนินการทั้งจากเครื่องและจากระยะไกลเพื่อดูว่าการดำเนินการใดเสร็จสิ้นก่อนมีที่นี่
- ดูข้อมูลเกี่ยวกับความซับซ้อนของการดำเนินการในเครื่องได้ที่นี่
เครื่องมือจัดการทรัพยากรในเครื่อง
Bazel สามารถเรียกใช้การดำเนินการหลายรายการพร้อมกัน จํานวนการดําเนินการในเครื่องที่ควรทํางานพร้อมกันจะแตกต่างกันไปในแต่ละการดําเนินการ ยิ่งการดําเนินการต้องใช้ทรัพยากรมากเท่าใด ก็ควรมีอินสแตนซ์ที่ทํางานพร้อมกันน้อยลงเพื่อไม่ให้เครื่องทำงานหนักเกินไป
การดำเนินการนี้ใช้ในคลาส ResourceManager
: แต่ละการดำเนินการต้องมีการกำกับเนื้อหาโดยประมาณของทรัพยากรในเครื่องที่จําเป็นในรูปแบบอินสแตนซ์ ResourceSet
(CPU และ RAM) จากนั้นเมื่อบริบทการดำเนินการทําบางอย่างที่ต้องใช้ทรัพยากรในเครื่อง ระบบจะเรียกใช้ ResourceManager.acquireResources()
และระบบจะบล็อกจนกว่าจะมีทรัพยากรที่จําเป็น
ดูรายละเอียดเพิ่มเติมของการจัดการทรัพยากรท้องถิ่นได้ที่นี่
โครงสร้างของไดเรกทอรีเอาต์พุต
การดำเนินการแต่ละรายการต้องมีตำแหน่งแยกต่างหากในไดเรกทอรีเอาต์พุตที่จะวางเอาต์พุต โดยปกติแล้วตำแหน่งของอาร์ติแฟกต์ที่ดึงข้อมูลจะมีดังนี้
$EXECROOT/bazel-out/<configuration>/bin/<package>/<artifact name>
ระบบกำหนดชื่อไดเรกทอรีที่เชื่อมโยงกับการกำหนดค่าหนึ่งๆ อย่างไร มีพร็อพเพอร์ตี้ที่ต้องการที่ขัดแย้งกัน 2 รายการ ดังนี้
- หากการกําหนดค่า 2 รายการเกิดขึ้นในบิลด์เดียวกัน ก็ควรมีไดเรกทอรีต่างกันเพื่อให้ทั้ง 2 รายการมีการดำเนินการเดียวกันในเวอร์ชันของตัวเอง มิเช่นนั้นหากการกําหนดค่า 2 รายการขัดแย้งกัน เช่น บรรทัดคําสั่งของการดำเนินการที่สร้างไฟล์เอาต์พุตเดียวกัน Bazel จะไม่ทราบว่าควรเลือกการดำเนินการใด ("การดำเนินการขัดแย้งกัน")
- หากการกําหนดค่า 2 รายการแสดงถึงสิ่งเดียวกัน "โดยประมาณ" ก็ควรมีชื่อเดียวกันเพื่อให้ใช้การดําเนินการที่ทำในรายการหนึ่งซ้ำกับอีกรายการหนึ่งได้หากบรรทัดคำสั่งตรงกัน เช่น การเปลี่ยนแปลงตัวเลือกบรรทัดคำสั่งในคอมไพเลอร์ Java ไม่ควรทําให้ระบบเรียกใช้การคอมไพล์ C++ ซ้ำ
จนถึงตอนนี้ เรายังไม่พบวิธีแก้ปัญหานี้อย่างเป็นระบบ ซึ่งคล้ายกับปัญหาการลดการกำหนดค่า ดูการพูดคุยเรื่องตัวเลือกต่างๆ เพิ่มเติมได้ที่นี่ ส่วนที่เป็นปัญหาหลักๆ คือกฎของ Starlark (ซึ่งผู้เขียนมักไม่ค่อยคุ้นเคยกับ Bazel) และแง่มุมต่างๆ ซึ่งช่วยเพิ่มมิติของสิ่งที่สามารถสร้างไฟล์เอาต์พุต "เดียวกัน" ได้
แนวทางปัจจุบันคือส่วนของเส้นทางสำหรับการกําหนดค่าคือ <CPU>-<compilation mode>
ที่มีการเพิ่มส่วนต่อท้ายต่างๆ เพื่อให้การเปลี่ยนการกำหนดค่าที่ติดตั้งใช้งานใน Java จะไม่ทําให้การดำเนินการขัดแย้งกัน นอกจากนี้ ระบบจะเพิ่มการตรวจสอบผลรวมชุดการเปลี่ยนการกำหนดค่า Starlark เพื่อให้ผู้ใช้ไม่ก่อให้เกิดความขัดแย้งในการดำเนินการ แต่ก็ยังห่างไกลจากความสมบูรณ์แบบ การดำเนินการนี้ใช้ใน OutputDirectories.buildMnemonic()
และอาศัยข้อมูลโค้ดการกำหนดค่าแต่ละรายการในการเพิ่มส่วนของตัวเองลงในชื่อไดเรกทอรีเอาต์พุต
การทดสอบ
Bazel รองรับการทดสอบมากมาย โดยรองรับข้อมูลต่อไปนี้
- การเรียกใช้การทดสอบจากระยะไกล (หากมีแบ็กเอนด์การดําเนินการจากระยะไกล)
- การทดสอบหลายครั้งพร้อมกัน (สำหรับการลดจำนวนการทดสอบหรือรวบรวมข้อมูลเกี่ยวกับเวลา)
- การแยกการทดสอบ (การแยกเฟรมทดสอบในการทดสอบเดียวกันไปยังหลายกระบวนการเพื่อเพิ่มความเร็ว)
- ทำการทดสอบที่ไม่น่าเชื่อถืออีกครั้ง
- จัดกลุ่มการทดสอบเป็นชุดทดสอบ
การทดสอบคือเป้าหมายที่กําหนดค่าตามปกติซึ่งมี TestProvider ซึ่งจะอธิบายวิธีเรียกใช้การทดสอบ
- อาร์ติแฟกต์ที่การบิลด์ส่งผลให้มีการเรียกใช้การทดสอบ นี่คือไฟล์ "สถานะแคช" ที่มีข้อความ
TestResultData
แบบอนุกรม - จำนวนครั้งที่ควรทำการทดสอบ
- จำนวนชาร์ดที่ควรแยกการทดสอบเป็น
- พารามิเตอร์บางอย่างเกี่ยวกับวิธีทำการทดสอบ (เช่น ระยะหมดเวลาของการทดสอบ)
การกำหนดการทดสอบที่จะเรียกใช้
การกำหนดการทดสอบที่จะทํางานเป็นกระบวนการที่ซับซ้อน
ประการแรก ระหว่างการแยกวิเคราะห์รูปแบบเป้าหมาย ชุดทดสอบจะขยายซ้ำแบบซ้ำๆ ใช้การขยายใน TestsForTargetPatternFunction
แล้ว มีรอยย่นที่ค่อนข้างน่าประหลาดใจคือ หากชุดทดสอบประกาศว่าไม่มีการทดสอบ จะหมายถึงการทดสอบทั้งหมดที่อยู่ในกล่องพัสดุ ซึ่งติดตั้งใช้งานใน Package.beforeBuild()
โดยเพิ่มแอตทริบิวต์โดยนัยชื่อ $implicit_tests
ลงในกฎชุดทดสอบ
จากนั้นจะมีการกรองขนาด แท็ก ระยะหมดเวลา และภาษาตามตัวเลือกบรรทัดคำสั่ง การดำเนินการนี้ใช้ใน TestFilter
และเรียกใช้จาก TargetPatternPhaseFunction.determineTests()
ระหว่างการแยกวิเคราะห์เป้าหมาย และใส่ผลลัพธ์ไว้ใน TargetPatternPhaseValue.getTestsToRunLabels()
สาเหตุที่ไม่สามารถกําหนดค่าแอตทริบิวต์กฎที่กรองได้นั้นเนื่องด้วยแอตทริบิวต์นี้เกิดขึ้นก่อนระยะการวิเคราะห์ จึงไม่สามารถกําหนดค่าได้
จากนั้นระบบจะประมวลผลเพิ่มเติมใน BuildView.createResult()
: ระบบจะกรองเป้าหมายที่การวิเคราะห์ไม่สําเร็จออก และแยกการทดสอบออกเป็นการทดสอบแบบไม่รวมและแบบรวม จากนั้นระบบจะใส่ข้อมูลลงใน AnalysisResult
ซึ่งเป็นวิธีที่ ExecutionTool
รู้ว่าจะเรียกใช้การทดสอบใด
tests()
เป็นตัวดำเนินการการค้นหา (ติดตั้งใช้งานใน TestsFunction
) เพื่อระบุการทดสอบที่จะเรียกใช้เมื่อระบุเป้าหมายที่เฉพาะเจาะจงในบรรทัดคำสั่ง ซึ่งจะช่วยให้กระบวนการที่ซับซ้อนนี้มีความโปร่งใสมากขึ้น น่าเสียดายที่การนำไปใช้งานใหม่อาจต่างจากเดิมในหลายด้านมาก
การทดสอบที่ทำงานอยู่
วิธีเรียกใช้การทดสอบคือขออาร์ติแฟกต์สถานะแคช ซึ่งจะทําให้ TestRunnerAction
ทำงาน ซึ่งสุดท้ายแล้วก็จะเรียก TestActionContext
ที่เลือกโดยตัวเลือกบรรทัดคำสั่ง --test_strategy
ซึ่งจะทําการทดสอบในลักษณะที่ขอ
การทดสอบจะทํางานตามโปรโตคอลที่ซับซ้อนซึ่งใช้ตัวแปรสภาพแวดล้อมเพื่อบอกการทดสอบว่าคาดหวังอะไรจากพวกเขา ดูคำอธิบายโดยละเอียดเกี่ยวกับสิ่งที่ Bazel คาดหวังจากการทดสอบและสิ่งที่การทดสอบคาดหวังจาก Bazel ได้ที่นี่ ในกรณีที่ง่ายที่สุด รหัสออก 0 หมายถึงความสําเร็จ ส่วนรหัสอื่นๆ หมายถึงความล้มเหลว
นอกจากไฟล์สถานะแคชแล้ว กระบวนการทดสอบแต่ละรายการจะสร้างไฟล์อื่นๆ อีกหลายไฟล์ ไฟล์เหล่านี้จะอยู่ใน "ไดเรกทอรีบันทึกการทดสอบ" ซึ่งเป็นไดเรกทอรีย่อยที่ชื่อ testlogs
ของไดเรกทอรีเอาต์พุตของการกําหนดค่าเป้าหมาย
test.xml
ไฟล์ XML สไตล์ JUnit ที่แสดงรายละเอียดกรอบการทดสอบแต่ละรายการในชาร์ดทดสอบtest.log
เอาต์พุตคอนโซลของการทดสอบ โดยไม่มีการแยก stdout และ stderrtest.outputs
"ไดเรกทอรีเอาต์พุตที่ไม่ได้ประกาศ" ซึ่งใช้โดยทดสอบที่ต้องการแสดงผลไฟล์นอกเหนือจากที่พิมพ์ไปยังเทอร์มินัล
การดำเนินการทดสอบมี 2 อย่างที่จะเกิดขึ้นไม่ได้ในระหว่างการสร้างเป้าหมายปกติ ได้แก่ การดำเนินการทดสอบแบบพิเศษและสตรีมมิงเอาต์พุต
การทดสอบบางอย่างต้องดำเนินการในโหมดพิเศษ เช่น ไม่ทําควบคู่กับการทดสอบอื่นๆ ซึ่งทำได้โดยการเพิ่ม tags=["exclusive"]
ลงในกฎทดสอบหรือเรียกใช้การทดสอบด้วย --test_strategy=exclusive
การทดสอบที่ไม่ซ้ำกันแต่ละรายการจะทํางานโดยการเรียกใช้ Skyframe แยกต่างหากที่ขอการเรียกใช้การทดสอบหลังจากบิลด์ "หลัก" การดำเนินการนี้ใช้ใน
SkyframeExecutor.runExclusiveTest()
ซึ่งแตกต่างจากการดำเนินการปกติที่ระบบจะแสดงผลลัพธ์ของเทอร์มินัลเมื่อการดำเนินการเสร็จสิ้น ผู้ใช้สามารถขอให้สตรีมเอาต์พุตของการทดสอบเพื่อให้ทราบความคืบหน้าของการทดสอบที่ทำงานเป็นเวลานาน ซึ่งระบุโดยตัวเลือกบรรทัดคำสั่ง --test_output=streamed
และบอกเป็นนัยถึงการดำเนินการทดสอบพิเศษเพื่อไม่ให้เอาต์พุตของการทดสอบต่างๆ กระจัดกระจาย
การดำเนินการนี้ติดตั้งใช้งานในคลาส StreamedTestOutput
ที่มีชื่อเหมาะเจาะและทำงานโดยการเรียกดูการเปลี่ยนแปลงในไฟล์ test.log
ของการทดสอบที่เป็นปัญหาและส่งออกไบต์ใหม่ไปยังเทอร์มินัลที่กฎ Bazel ทำงานอยู่
ผลลัพธ์ของการทดสอบที่ดำเนินการจะแสดงในบัสเหตุการณ์โดยสังเกตเหตุการณ์ต่างๆ (เช่น TestAttempt
, TestResult
หรือ TestingCompleteEvent
) ระบบจะส่งออกข้อมูลไปยัง Build Event Protocol และส่งไปยังคอนโซลโดย AggregatingTestListener
คอลเล็กชันการครอบคลุม
การทดสอบจะรายงานการครอบคลุมในรูปแบบ LCOV ในไฟล์
bazel-testlogs/$PACKAGE/$TARGET/coverage.dat
หากต้องการรวบรวมการครอบคลุม ระบบจะรวมการเรียกใช้การทดสอบแต่ละรายการไว้ในสคริปต์ที่ชื่อ
collect_coverage.sh
สคริปต์นี้จะตั้งค่าสภาพแวดล้อมการทดสอบเพื่อเปิดใช้การเก็บรวบรวมการครอบคลุม และกำหนดตำแหน่งที่รันไทม์การครอบคลุมจะเขียนไฟล์การครอบคลุม จากนั้นจึงทำการทดสอบ การทดสอบอาจเรียกใช้กระบวนการย่อยหลายรายการและประกอบด้วยส่วนต่างๆ ที่เขียนด้วยภาษาโปรแกรมหลายภาษา (ที่มีรันไทม์การเก็บรวบรวมการครอบคลุมแยกกัน) สคริปต์รัปเปอร์มีหน้าที่แปลงไฟล์ที่ได้เป็นรูปแบบ LCOV หากจําเป็น และผสานไฟล์เหล่านั้นเข้าด้วยกันเป็นไฟล์เดียว
การวาง collect_coverage.sh
ไว้ตรงกลางจะดำเนินการโดยกลยุทธ์การทดสอบ และกำหนดให้ collect_coverage.sh
อยู่ในอินพุตของการทดสอบ ซึ่งทำได้โดยใช้แอตทริบิวต์โดยนัย :coverage_support
ซึ่งจะได้รับการแก้ไขเป็นค่าของ Flag การกําหนดค่า --coverage_support
(ดู TestConfiguration.TestOptions.coverageSupport
)
ภาษาบางภาษาใช้เครื่องมือวัดผลแบบออฟไลน์ ซึ่งหมายความว่าจะมีการเพิ่มเครื่องมือวัดผลความครอบคลุม ณ เวลาคอมไพล์ (เช่น C++) และภาษาอื่นๆ ใช้เครื่องมือวัดผลแบบออนไลน์ ซึ่งหมายความว่าจะมีการเพิ่มเครื่องมือวัดผลความครอบคลุม ณ เวลาเรียกใช้
แนวคิดหลักอีกประการหนึ่งคือความครอบคลุมของเส้นฐาน นี่คือการครอบคลุมของไลบรารี ไฟล์ไบนารี หรือทดสอบว่าไม่มีโค้ดใดทำงานอยู่ ปัญหาที่เครื่องมือนี้แก้ไขได้คือ หากต้องการคำนวณการครอบคลุมของการทดสอบสำหรับไบนารี การผสานรวมการครอบคลุมของการทดสอบทั้งหมดนั้นไม่เพียงพอ เนื่องจากอาจมีโค้ดในไบนารีที่ไม่ได้ลิงก์กับการทดสอบใดๆ ดังนั้น เราจึงทำเพื่อปล่อยไฟล์การครอบคลุมสำหรับทุกไบนารีที่มีเฉพาะไฟล์ที่เรารวบรวมความครอบคลุมโดยไม่มีบรรทัดที่ครอบคลุม ไฟล์ความครอบคลุมพื้นฐานสําหรับเป้าหมายอยู่ที่ bazel-testlogs/$PACKAGE/$TARGET/baseline_coverage.dat
นอกจากนี้ยังสร้างขึ้นสำหรับไบนารีและไลบรารีนอกเหนือจากการทดสอบหากคุณส่ง Flag --nobuild_tests_only
ไปยัง Bazel
ขณะนี้ความครอบคลุมของข้อมูลพื้นฐานใช้งานไม่ได้
เราติดตามไฟล์ 2 กลุ่มสําหรับการเก็บรวบรวมการครอบคลุมสําหรับแต่ละกฎ ได้แก่ ชุดไฟล์ที่มีเครื่องมือวัดและชุดไฟล์ข้อมูลเมตาของเครื่องมือวัด
ชุดไฟล์ที่มีเครื่องมือวัดผลเป็นเพียงชุดไฟล์ที่มีเครื่องมือวัดผล สําหรับรันไทม์การครอบคลุมออนไลน์ สามารถใช้ข้อมูลนี้ที่รันไทม์เพื่อเลือกไฟล์ที่จะตรวจสอบได้ และยังใช้เพื่อติดตั้งใช้งานความครอบคลุมพื้นฐานด้วย
ชุดไฟล์ข้อมูลเมตาของเครื่องมือวัดประสิทธิภาพคือชุดไฟล์เพิ่มเติมที่การทดสอบต้องใช้เพื่อสร้างไฟล์ LCOV ที่ Bazel ต้องการ ในทางปฏิบัติ ไฟล์เหล่านี้ประกอบด้วยไฟล์เฉพาะรันไทม์ เช่น gcc จะสร้างไฟล์ .gcno ในระหว่างการคอมไพล์ ระบบจะเพิ่มรายการเหล่านี้ลงในชุดอินพุตของการดำเนินการทดสอบหากเปิดใช้โหมดความครอบคลุม
ระบบจะจัดเก็บข้อมูลว่ามีการรวบรวมการครอบคลุมหรือไม่ไว้ใน
BuildConfiguration
วิธีนี้เป็นประโยชน์เพราะเป็นวิธีง่ายๆ ในการเปลี่ยนแปลงการดำเนินการทดสอบและกราฟการทำงานที่ขึ้นอยู่กับบิตนี้ และยังหมายความว่าหากมีการกลับบิตนี้ จะต้องมีการวิเคราะห์เป้าหมายทั้งหมดใหม่ (บางภาษา เช่น C++ ต้องใช้ตัวเลือกคอมไพเลอร์ที่แตกต่างกันไปในการปล่อยโค้ดที่สามารถรวบรวมการครอบคลุม ซึ่งช่วยลดปัญหานี้ได้พอสมควร เนื่องจากต้องมีการวิเคราะห์อีกครั้ง)
ไฟล์สนับสนุนการครอบคลุมจะขึ้นอยู่กับป้ายกำกับในการพึ่งพาโดยนัยเพื่อให้นโยบายการเรียกใช้ลบล้างไฟล์เหล่านั้นได้ ซึ่งช่วยให้ไฟล์เหล่านี้แตกต่างกันไปในแต่ละเวอร์ชันของ Bazel โดยหลักการแล้ว เราควรนำความแตกต่างเหล่านี้ออกและกำหนดมาตรฐานให้เหลือเพียงรูปแบบเดียว
นอกจากนี้ เรายังสร้าง "รายงานการครอบคลุม" ซึ่งผสานการครอบคลุมที่รวบรวมสําหรับการทดสอบทุกรายการในการเรียกใช้ Bazel การดำเนินการนี้จัดการโดย CoverageReportActionFactory
และเรียกใช้จาก BuildView.createResult()
โดยจะเข้าถึงเครื่องมือที่จําเป็นได้โดยดูที่:coverage_report_generator
แอตทริบิวต์ของการทดสอบแรกที่ใช้
เครื่องมือการค้นหา
Bazel ใช้ภาษาง่ายๆ ในการถามเรื่องต่างๆ เกี่ยวกับกราฟต่างๆ เรามีคำค้นหาประเภทต่อไปนี้
bazel query
ใช้เพื่อตรวจสอบกราฟเป้าหมายbazel cquery
ใช้เพื่อตรวจสอบกราฟเป้าหมายที่กําหนดค่าไว้bazel aquery
จะใช้เพื่อตรวจสอบกราฟการดำเนินการ
แต่ละรายการเหล่านี้ติดตั้งใช้งานโดยการแยกคลาสย่อยของ AbstractBlazeQueryEnvironment
คุณสามารถเพิ่มฟังก์ชันการค้นหาเพิ่มเติมได้โดยการสร้างคลาสย่อยของ QueryFunction
ระบบจะส่ง query2.engine.Callback
ไปยัง QueryFunction
เพื่อเรียกใช้ผลลัพธ์ที่ต้องการแสดงแทนการเก็บรวบรวมผลลัพธ์ไปยังโครงสร้างข้อมูลบางอย่าง เพื่อให้สตรีมผลการค้นหาได้
ผลลัพธ์ของการค้นหาสามารถแสดงผลได้หลายวิธี เช่น ป้ายกํากับ คลาสป้ายกํากับและกฎ XML, protobuf และอื่นๆ ซึ่งติดตั้งใช้งานเป็นคลาสย่อยของ
OutputFormatter
ข้อกำหนดเล็กๆ น้อยๆ ของรูปแบบเอาต์พุตการค้นหาบางรูปแบบ (proto) คือ Bazel จำเป็นต้องแสดงข้อมูลทั้งหมดที่การโหลดแพ็กเกจให้เพื่อให้ผู้ใช้สามารถเปรียบเทียบเอาต์พุตและพิจารณาว่าเป้าหมายหนึ่งๆ มีการเปลี่ยนแปลงหรือไม่ ด้วยเหตุนี้ ค่าแอตทริบิวต์จึงต้องจัดเก็บเป็นอนุกรมได้ จึงมีแอตทริบิวต์ประเภทต่างๆ เพียงไม่กี่ประเภทที่ไม่มีแอตทริบิวต์ที่มีค่า Starlark ซับซ้อน วิธีแก้ปัญหาทั่วไปคือการใช้ป้ายกํากับและแนบข้อมูลที่ซับซ้อนไปกับกฎที่มีป้ายกํากับนั้น วิธีแก้ปัญหานี้ไม่ค่อยน่าพอใจนัก และเรายินดีอย่างยิ่งที่จะยกเลิกข้อกำหนดนี้
ระบบโมดูล
คุณสามารถขยาย Bazel ได้โดยเพิ่มโมดูลลงไป แต่ละโมดูลต้องเป็นคลาสย่อยของ BlazeModule
(ชื่อนี้มาจากประวัติของ Bazel เมื่อก่อนเรียกว่า Blaze) และรับข้อมูลเกี่ยวกับเหตุการณ์ต่างๆ ระหว่างการเรียกใช้คำสั่ง
โดยส่วนใหญ่จะใช้เพื่อใช้ฟังก์ชันต่างๆ ที่ "ไม่ใช่หลัก" ซึ่งมีเพียง Bazel บางเวอร์ชัน (เช่น เวอร์ชันที่เราใช้ที่ Google) ที่ต้องการ
- อินเทอร์เฟซกับระบบการดําเนินการระยะไกล
- คำสั่งใหม่
ชุดจุดขยายที่ BlazeModule
เสนอค่อนข้างไม่เป็นระเบียบ อย่าใช้แอปเป็นตัวอย่างของหลักการการออกแบบที่ดี
บัสเหตุการณ์
วิธีที่หลักที่ BlazeModules สื่อสารกับส่วนที่เหลือของ Bazel คือผ่านบัสเหตุการณ์ (EventBus
) ระบบจะสร้างอินสแตนซ์ใหม่สําหรับบิลด์แต่ละรายการ ส่วนต่างๆ ของ Bazel สามารถโพสต์เหตุการณ์ไปยังบัสดังกล่าว และโมดูลสามารถลงทะเบียนผู้ฟังสําหรับเหตุการณ์ที่สนใจ ตัวอย่างเช่น รายการต่อไปนี้จะแสดงเป็นเหตุการณ์
- กำหนดรายการเป้าหมายการสร้างที่จะสร้างแล้ว
(
TargetParsingCompleteEvent
) - กําหนดการกําหนดค่าระดับบนสุดแล้ว
(
BuildConfigurationEvent
) - สร้างเป้าหมายสำเร็จหรือไม่ (
TargetCompleteEvent
) - ทำการทดสอบแล้ว (
TestAttempt
,TestSummary
)
เหตุการณ์บางอย่างเหล่านี้แสดงอยู่นอก Bazel ในโปรโตคอลเหตุการณ์การสร้าง (เป็น BuildEvent
) วิธีนี้ไม่เพียงแค่ทำให้ BlazeModule
เท่านั้น แต่ยังรวมถึงสิ่งที่อยู่นอกกระบวนการ Bazel ในการสังเกตบิลด์ด้วย โดยสามารถเข้าถึงในรูปแบบไฟล์ที่มีข้อความโปรโตคอล หรือ Bazel จะเชื่อมต่อกับเซิร์ฟเวอร์ (เรียกว่าบริการเหตุการณ์การสร้าง) เพื่อสตรีมเหตุการณ์ก็ได้
ซึ่งติดตั้งใช้งานในแพ็กเกจ Java build.lib.buildeventservice
และ
build.lib.buildeventstream
ที่เก็บข้อมูลภายนอก
แม้ว่าเดิมที Bazel ออกแบบมาเพื่อใช้ใน Monorepo (โครงสร้างแหล่งที่มาเดียวที่มีทุกอย่างที่จำเป็นต่อการสร้าง) แต่ Bazel ก็ไม่ได้ทำงานในสภาพแวดล้อมแบบนั้นเสมอไป "ที่เก็บข้อมูลภายนอก" เป็นการแยกความคิดที่ใช้เพื่อเชื่อมโลกทั้ง 2 โลกเข้าด้วยกัน โดยที่เก็บข้อมูลภายนอกแสดงถึงโค้ดที่จําเป็นสําหรับบิลด์แต่ไม่ได้อยู่ในสคีมาซอร์สหลัก
ไฟล์ WORKSPACE
ชุดที่เก็บภายนอกจะกำหนดโดยการแยกวิเคราะห์ไฟล์ WORKSPACE เช่น การประกาศที่มีลักษณะดังนี้
local_repository(name="foo", path="/foo/bar")
ผลลัพธ์ในที่เก็บชื่อ @foo
พร้อมใช้งาน สิ่งที่ทำให้การดำเนินการนี้ซับซ้อนคือผู้ใช้สามารถกำหนดกฎใหม่ของที่เก็บข้อมูลในไฟล์ Starlark ซึ่งจะใช้โหลดโค้ด Starlark ใหม่ได้ ซึ่งจะใช้กำหนดกฎใหม่ของที่เก็บข้อมูลได้ และอื่นๆ
ในการรองรับกรณีนี้ การแยกวิเคราะห์ไฟล์ WORKSPACE (ใน WorkspaceFileFunction
) จะแบ่งออกเป็นกลุ่มๆ โดยคั่นด้วยคำสั่ง load()
ดัชนีของข้อมูลโค้ดจะระบุด้วย WorkspaceFileKey.getIndex()
และการคํานวณ WorkspaceFileFunction
จนกว่าดัชนี X หมายถึงการประเมินจนกว่าจะถึงคำสั่ง load()
ลำดับที่ X
กําลังดึงข้อมูลที่เก็บ
คุณต้องดึงข้อมูลโค้ดของที่เก็บก่อนจึงจะพร้อมใช้งานสำหรับ Bazel ซึ่งจะทำให้ Bazel สร้างไดเรกทอรีภายใต้
$OUTPUT_BASE/external/<repository name>
การดึงข้อมูลที่เก็บจะเกิดขึ้นตามขั้นตอนต่อไปนี้
PackageLookupFunction
ตระหนักว่าต้องมีที่เก็บข้อมูลและสร้างRepositoryName
เป็นSkyKey
ซึ่งเรียกใช้RepositoryLoaderFunction
RepositoryLoaderFunction
ส่งต่อคำขอไปยังRepositoryDelegatorFunction
ด้วยเหตุผลที่ไม่ชัดเจน (โค้ดระบุว่าเพื่อหลีกเลี่ยงการดาวน์โหลดซ้ำในกรณีที่ Skyframe รีสตาร์ท แต่เหตุผลนี้ไม่ชัดเจนมากนัก)RepositoryDelegatorFunction
จะค้นหากฎที่เก็บซึ่งได้รับคําขอให้ดึงข้อมูลโดยวนผ่านข้อมูลส่วนต่างๆ ของไฟล์ WORKSPACE จนกว่าจะพบที่เก็บที่ขอ- พบ
RepositoryFunction
ที่เหมาะสมซึ่งใช้การดึงข้อมูลที่เก็บ โดยอาจเป็นการใช้งานที่เก็บของ Starlark หรือแผนที่แบบฮาร์ดโค้ดสำหรับที่เก็บที่มีการใช้งานใน Java
การแคชมีหลายระดับเนื่องจากการดึงข้อมูลพื้นที่เก็บข้อมูลอาจใช้ทรัพยากรมาก
- มีแคชสำหรับไฟล์ที่ดาวน์โหลดไว้ซึ่งใช้การตรวจสอบข้อผิดพลาด (
RepositoryCache
) เป็นคีย์ ซึ่งการตรวจสอบข้อผิดพลาดต้องอยู่ในไฟล์ WORKSPACE แต่วิธีนี้ช่วยรักษาความสมบูรณ์ของข้อมูลได้ อินสแตนซ์เซิร์ฟเวอร์ Bazel ทุกอินสแตนซ์ในเวิร์กสเตชันเดียวกันจะแชร์ข้อมูลนี้ ไม่ว่าจะทำงานในเวิร์กสเปซหรือฐานเอาต์พุตใดก็ตาม - ระบบจะเขียน "ไฟล์เครื่องหมาย" สำหรับที่เก็บข้อมูลแต่ละแห่งในส่วน
$OUTPUT_BASE/external
ซึ่งมีการตรวจสอบผลรวมของกฎที่ใช้ดึงข้อมูล หากเซิร์ฟเวอร์ Bazel รีสตาร์ท แต่ checksum ไม่เปลี่ยนแปลง ระบบจะไม่ดึงข้อมูลอีกครั้ง การดำเนินการนี้ใช้ในRepositoryDelegatorFunction.DigestWriter
- ตัวเลือกบรรทัดคำสั่ง
--distdir
จะกำหนดแคชอื่นที่ใช้ค้นหาอาร์ติแฟกต์ที่จะดาวน์โหลด วิธีนี้เป็นประโยชน์ในการตั้งค่าระดับองค์กร ซึ่ง Bazel ไม่ควรดึงข้อมูลแบบสุ่มจากอินเทอร์เน็ต ซึ่งดำเนินการโดยDownloadManager
เมื่อดาวน์โหลดที่เก็บแล้ว ระบบจะถือว่าอาร์ติแฟกต์ที่อยู่ในที่เก็บนั้นเป็นอาร์ติแฟกต์ต้นทาง ซึ่งทำให้เกิดปัญหาเนื่องจากโดยปกติแล้ว Bazel จะตรวจสอบความทันสมัยของอาร์ติแฟกต์ต้นทางโดยการเรียกใช้ stat() กับอาร์ติแฟกต์เหล่านั้น และอาร์ติแฟกต์เหล่านี้ก็จะเป็นโมฆะด้วยเมื่อคําจํากัดความของที่เก็บอยู่ในนั้นเปลี่ยนแปลง ดังนั้นFileStateValue
สําหรับอาร์ติแฟกต์ในที่เก็บภายนอกต้องขึ้นอยู่กับที่เก็บภายนอก ExternalFilesHelper
จะจัดการเรื่องนี้
การแมปที่เก็บ
กรณีที่รีโพซิทอรีหลายแห่งต้องการใช้รีโพซิทอรีเดียวกัน แต่ใช้เวอร์ชันต่างกัน (นี่คืออินสแตนซ์ของ "ปัญหาการพึ่งพาแบบเพชร") ตัวอย่างเช่น หากไบนารี 2 รายการในที่เก็บข้อมูลแยกกันในบิลด์ต้องการใช้ Guava ก็อาจมีการอ้างอิง Guava ด้วยป้ายกำกับที่ขึ้นต้นด้วย @guava//
ทั้ง 2 รายการ และคาดว่าจะเป็นเวอร์ชันที่แตกต่างกัน
ดังนั้น Bazel จึงอนุญาตให้รายการหนึ่งแมปป้ายกำกับที่เก็บภายนอกอีกครั้งเพื่อให้สตริง @guava//
อ้างถึงที่เก็บ Guava หนึ่ง (เช่น @guava1//
) ในที่เก็บของไบนารีหนึ่งและที่เก็บ Guava อีกรายการหนึ่ง (เช่น @guava2//
) กับที่เก็บของอีกแห่งได้
หรือจะใช้เพื่อต่อเพชรก็ได้ หากที่เก็บขึ้นอยู่กับ @guava1//
และอีกรายการขึ้นอยู่กับ @guava2//
การแมปที่เก็บจะช่วยให้ 1 แมปที่เก็บทั้ง 2 รายการได้อีกครั้งเพื่อใช้ที่เก็บ Canonical @guava//
มีการระบุการแมปไว้ในไฟล์ WORKSPACE เป็นแอตทริบิวต์ repo_mapping
ของการกำหนดที่เก็บแต่ละรายการ จากนั้นจะปรากฏใน Skyframe ในฐานะสมาชิกของ WorkspaceFileValue
ซึ่งเชื่อมต่อกับสิ่งต่อไปนี้
Package.Builder.repositoryMapping
ที่ใช้สำหรับเปลี่ยนรูปแบบแอตทริบิวต์ที่มีป้ายกำกับ ของกฎในแพ็กเกจตามRuleClass.populateRuleAttributeValues()
Package.repositoryMapping
ซึ่งใช้ในเฟสการวิเคราะห์ (สำหรับการแก้ปัญหาต่างๆ เช่น$(location)
ที่ไม่ได้แยกวิเคราะห์ในเฟสการโหลด)BzlLoadFunction
สําหรับการแก้ไขป้ายกํากับในคำสั่ง load()
บิต JNI
เซิร์ฟเวอร์ของ Bazel เขียนด้วย Java เป็นหลัก ข้อยกเว้นคือส่วนที่ Java ทำเองไม่ได้หรือทำเองไม่ได้เมื่อเราติดตั้งใช้งาน ซึ่งส่วนใหญ่จะจำกัดอยู่ที่การโต้ตอบกับระบบไฟล์ การควบคุมกระบวนการ และการดำเนินการระดับล่างอื่นๆ
โค้ด C++ จะอยู่ภายใต้ src/main/native และคลาส Java ที่มีเมธอดแบบเนทีฟดังนี้
NativePosixFiles
และNativePosixFileSystem
ProcessUtils
WindowsFileOperations
และWindowsFileProcesses
com.google.devtools.build.lib.platform
เอาต์พุตคอนโซล
การแสดงผลเอาต์พุตคอนโซลดูเหมือนจะเป็นเรื่องง่าย แต่การรวมกันของกระบวนการที่ทำงานอยู่หลายรายการ (บางครั้งทำงานจากระยะไกล) การแคชแบบละเอียด ความต้องการที่จะมีเอาต์พุตเทอร์มินัลที่ดูดีและมีสีสัน และเซิร์ฟเวอร์ที่ทำงานอยู่นานทำให้การดำเนินการนี้ไม่ใช่เรื่องง่าย
ทันทีที่มีการเรียก RPC จากไคลเอ็นต์ ระบบจะสร้างRpcOutputStream
อินสแตนซ์ 2 รายการ (สำหรับ stdout และ stderr) ซึ่งส่งต่อข้อมูลที่พิมพ์ไปยังไคลเอ็นต์ จากนั้นระบบจะรวมข้อมูลเหล่านี้ไว้ใน OutErr
(คู่ (stdout, stderr)) ทุกสิ่งที่ต้องพิมพ์บนคอนโซลจะผ่านสตรีมเหล่านี้ จากนั้นระบบจะส่งสตรีมเหล่านี้ให้
BlazeCommandDispatcher.execExclusively()
ระบบจะพิมพ์เอาต์พุตด้วยอักขระหลีก ANSI โดยค่าเริ่มต้น เมื่อไม่ต้องการ (--color=no
) ระบบจะตัดออกด้วย AnsiStrippingOutputStream
นอกจากนี้ ระบบจะเปลี่ยนเส้นทาง System.out
และ System.err
ไปยังสตรีมเอาต์พุตเหล่านี้ด้วย
การดำเนินการนี้เพื่อให้สามารถพิมพ์ข้อมูลการแก้ไขข้อบกพร่องโดยใช้ System.err.println()
และยังคงแสดงผลลัพธ์ในเทอร์มินัลของไคลเอ็นต์ (ซึ่งแตกต่างจากเซิร์ฟเวอร์) ในกรณีที่กระบวนการสร้างเอาต์พุตไบนารี (เช่น bazel query --output=proto
) จะไม่มีการบิดเบือน Stout เกิดขึ้น
ข้อความสั้นๆ (ข้อผิดพลาด คำเตือน และสิ่งอื่นๆ ที่คล้ายกัน) จะแสดงผ่านอินเทอร์เฟซ EventHandler
โปรดทราบว่าข้อมูลเหล่านี้แตกต่างจากข้อมูลที่จะโพสต์ใน EventBus
(ข้อมูลนี้ทำให้สับสน) Event
แต่ละรายการมี EventKind
(ข้อผิดพลาด คำเตือน ข้อมูล และอื่นๆ อีก 2-3 รายการ) และอาจมี Location
(ตำแหน่งในซอร์สโค้ดที่ทําให้เหตุการณ์เกิดขึ้น)
การติดตั้งใช้งาน EventHandler
บางรายการจะจัดเก็บเหตุการณ์ที่ได้รับ ซึ่งจะใช้เพื่อเล่นข้อมูลซ้ำไปยัง UI ที่เกิดจากการดำเนินการที่แคชไว้หลายประเภท เช่น คำเตือนที่เกิดจากเป้าหมายที่กําหนดค่าไว้ซึ่งแคชไว้
EventHandler
บางรายการยังอนุญาตให้โพสต์เหตุการณ์ที่ท้ายที่สุดจะปรากฏในบัสเหตุการณ์ด้วย (Event
ปกติจะไม่ปรากฏในบัสเหตุการณ์) เวอร์ชันเหล่านี้คือการใช้งาน ExtendedEventHandler
และการใช้งานหลักคือการเล่นเหตุการณ์ EventBus
ที่แคชไว้ซ้ำ เหตุการณ์ EventBus
ทั้งหมดเหล่านี้ใช้ Postable
แต่ไม่ได้หมายความว่าทุกอย่างที่โพสต์ไปยัง EventBus
ต้องใช้อินเทอร์เฟซนี้ เฉพาะเหตุการณ์ที่ ExtendedEventHandler
แคชไว้เท่านั้น (ซึ่งเป็นสิ่งที่ควรทำและส่วนใหญ่ก็ใช้ แต่ก็ไม่ได้บังคับ)
ผลลัพธ์ของเทอร์มินัลจะส่วนใหญ่แสดงผ่าน UiEventHandler
ซึ่งมีหน้าที่รับผิดชอบการจัดรูปแบบผลลัพธ์และรายงานความคืบหน้าที่ดูดีทั้งหมดที่ Bazel ดำเนินการ โดยจะมีอินพุต 2 รายการ ดังนี้
- บัสเหตุการณ์
- สตรีมเหตุการณ์ที่ส่งผ่านเข้ามาผ่าน Reporter
การเชื่อมต่อโดยตรงเพียงอย่างเดียวที่กลไกการดําเนินการตามคําสั่ง (เช่น Bazel ที่เหลือ) มีกับสตรีม RPC ไปยังไคลเอ็นต์คือผ่าน Reporter.getOutErr()
ซึ่งช่วยให้เข้าถึงสตรีมเหล่านี้ได้โดยตรง โดยจะใช้ได้ก็ต่อเมื่อคำสั่งต้องถ่ายโอนข้อมูลไบนารีจำนวนมาก (เช่น bazel query
)
การทำโปรไฟล์ Bazel
Bazel ทำงานเร็ว Bazel ยังทำงานช้าด้วย เนื่องจากบิลด์มีแนวโน้มที่จะเติบโตจนเกือบถึงขีดจำกัดที่รับได้ ด้วยเหตุนี้ Bazel จึงมีเครื่องมือสร้างโปรไฟล์ซึ่งใช้ในการสร้างโปรไฟล์และ Bazel ได้ด้วย ติดตั้งใช้งานในคลาสที่มีชื่อว่า Profiler
ฟีเจอร์นี้จะเปิดอยู่โดยค่าเริ่มต้น แม้ว่าจะบันทึกเฉพาะข้อมูลแบบย่อเพื่อให้มีค่าใช้จ่ายเพิ่มเติมที่ยอมรับได้ แต่บรรทัดคำสั่ง--record_full_profiler_data
จะทำให้บันทึกทุกอย่างที่ทำได้
โดยจะปล่อยโปรไฟล์ในรูปแบบเครื่องมือสร้างโปรไฟล์ของ Chrome ซึ่งเหมาะกับการดูใน Chrome รูปแบบข้อมูลของเครื่องมือนี้คือกองงาน ซึ่งผู้ใช้สามารถเริ่มและสิ้นสุดงานได้ และงานต่างๆ ควรซ้อนกันอยู่อย่างเป็นระเบียบ แต่ละเธรด Java จะมีกองงานของตัวเอง TODO: วิธีนี้ทำงานกับรูปแบบการกระทำ และรูปแบบการส่งอย่างต่อเนื่องอย่างไร
ระบบจะเริ่มและหยุดเครื่องมือวิเคราะห์ใน BlazeRuntime.initProfiler()
และ BlazeRuntime.afterCommand()
ตามลำดับ และจะพยายามทำงานเป็นเวลานานที่สุดเพื่อให้เราวิเคราะห์ทุกอย่างได้ หากต้องการเพิ่มข้อมูลลงในโปรไฟล์ ให้โทรหา Profiler.instance().profile()
ผลการค้นหา Closeable
จะแสดงเป็นการปิดทำการ
หมายถึงการสิ้นสุดงาน วิธีใช้ที่ดีที่สุดคือใช้กับคำสั่ง try-with-resources
นอกจากนี้เรายังทำโปรไฟล์หน่วยความจำเบื้องต้นใน MemoryProfiler
ด้วย นอกจากนี้ เครื่องมือนี้ยังเปิดอยู่เสมอ และส่วนใหญ่จะบันทึกขนาดฮีปสูงสุดและลักษณะการทำงานของ GC
ทดสอบ Bazel
บาเซลมีการทดสอบหลักๆ 2 ประเภท ได้แก่ การทดสอบที่สังเกต Bazel เป็น "กล่องดำ" และการทดสอบที่ดำเนินการเฉพาะช่วงการวิเคราะห์ เราเรียกการทดสอบแบบแรกว่า "การทดสอบการผสานรวม" และเรียกการทดสอบแบบหลังว่า "การทดสอบหน่วย" แม้ว่าการทดสอบเหล่านี้จะคล้ายกับการทดสอบการผสานรวมที่ผสานรวมน้อยลง นอกจากนี้ เรายังมีการทดสอบหน่วยจริงบางส่วนในกรณีที่จําเป็น
การทดสอบการผสานรวมมี 2 ประเภท ได้แก่
- โซลูชันที่นำไปใช้โดยใช้เฟรมเวิร์กการทดสอบแบบ Bash ที่ละเอียดประณีตภายใต้
src/test/shell
- รายการที่ติดตั้งใช้งานใน Java ซึ่งติดตั้งใช้งานเป็นคลาสย่อยของ
BuildIntegrationTestCase
BuildIntegrationTestCase
เป็นเฟรมเวิร์กการทดสอบการผสานรวมที่แนะนำเนื่องจากมีความพร้อมสำหรับสถานการณ์การทดสอบส่วนใหญ่ เนื่องจากเป็นเฟรมเวิร์ก Java จึงสามารถแก้ไขข้อบกพร่องและผสานรวมกับเครื่องมือการพัฒนาทั่วไปได้หลายอย่างอย่างราบรื่น มีตัวอย่างคลาส BuildIntegrationTestCase
มากมายในที่เก็บ Bazel
การทดสอบการวิเคราะห์จะติดตั้งใช้งานเป็นคลาสย่อยของ BuildViewTestCase
มีระบบไฟล์สำหรับใช้ชั่วคราวที่คุณสามารถใช้เขียนไฟล์ BUILD
จากนั้นเมธอดตัวช่วยต่างๆ จะขอเป้าหมายที่กำหนดค่าไว้ เปลี่ยนการกำหนดค่า และยืนยันสิ่งต่างๆ เกี่ยวกับผลลัพธ์ของการวิเคราะห์ได้