การกำหนดค่าเชนเครื่องมือ C++

ภาพรวม

เมื่อต้องการเรียกใช้คอมไพเลอร์ด้วยตัวเลือกที่เหมาะสม Bazel ต้องมีความรู้เกี่ยวกับภายในของคอมไพเลอร์ เช่น ไดเรกทอรีและแฟล็กที่สำคัญ กล่าวคือ Bazel ต้องใช้รูปแบบคอมไพเลอร์ที่เข้าใจง่ายเพื่อทำความเข้าใจการทํางาน

Bazel จำเป็นต้องทราบข้อมูลต่อไปนี้

• คอมไพเลอร์รองรับ thinLTO, โมดูล, การลิงก์แบบไดนามิก หรือ PIC (โค้ดที่ไม่ขึ้นกับตำแหน่ง) หรือไม่
• เส้นทางไปยังเครื่องมือที่จำเป็น เช่น gcc, ld, ar, objcopy และอื่นๆ
• ระบบในตัวจะมีไดเรกทอรี Bazel ต้องใช้ข้อมูลเหล่านี้เพื่อตรวจสอบว่ามีการประกาศส่วนหัวทั้งหมดที่รวมอยู่ในไฟล์ต้นทางอย่างถูกต้องในไฟล์ BUILD
• sysroot เริ่มต้น
• Flag ที่จะใช้ในการคอมไพล์ การลิงก์ การเก็บถาวร
• แฟล็กใดที่จะใช้สำหรับโหมดการคอมไพล์ที่รองรับ (opt, dbg, Fastbuild)
• ทำให้เป็นตัวแปรที่จำเป็นสำหรับคอมไพเลอร์โดยเฉพาะ

หากคอมไพเลอร์รองรับสถาปัตยกรรมหลายรายการ Bazel จะต้องกำหนดค่าแต่ละสถาปัตยกรรมแยกกัน

CcToolchainConfigInfo เป็นผู้ให้บริการที่ระบุระดับรายละเอียดที่จำเป็นสำหรับการกำหนดค่าลักษณะการทำงานของกฎ C++ ของ Bazel โดยค่าเริ่มต้นแล้ว Bazel จะกําหนดค่า CcToolchainConfigInfo สําหรับบิลด์โดยอัตโนมัติ แต่คุณมีตัวเลือกในการกําหนดค่าด้วยตนเอง ซึ่งต้องมีกฎ Starlark ที่ระบุ CcToolchainConfigInfo และต้องชี้แอตทริบิวต์ toolchain_config ของ cc_toolchain ไปยังกฎ คุณสร้าง CcToolchainConfigInfo ได้โดยเรียกใช้ cc_common.create_cc_toolchain_config_info() คุณดูตัวสร้าง Starlark สำหรับโครงสร้างทั้งหมดที่ต้องใช้ในระหว่างกระบวนการได้ใน @rules_cc//cc:cc_toolchain_config_lib.bzl

เมื่อเป้าหมาย C++ เข้าสู่ช่วงการวิเคราะห์ Bazel จะเลือกเป้าหมาย cc_toolchain ที่เหมาะสมโดยอิงตามไฟล์ BUILD และรับผู้ให้บริการ CcToolchainConfigInfo จากเป้าหมายที่ระบุไว้ในแอตทริบิวต์ cc_toolchain.toolchain_config เป้าหมาย cc_toolchain จะส่งข้อมูลนี้ไปยังเป้าหมาย C++ ผ่าน CcToolchainProvider

ตัวอย่างเช่น การดำเนินการคอมไพล์หรือลิงก์ซึ่งสร้างอินสแตนซ์โดยกฎ เช่น cc_binary หรือ cc_library ต้องใช้ข้อมูลต่อไปนี้

• คอมไพเลอร์หรือโปรแกรมลิงก์ที่จะใช้
• แฟล็กบรรทัดคำสั่งสำหรับคอมไพเลอร์/Linker
• Flag การกําหนดค่าที่ส่งผ่านตัวเลือก --copt/--linkopt
• ตัวแปรสภาพแวดล้อม
• อาร์ติแฟกต์ที่จําเป็นในแซนด์บ็อกซ์ที่ดําเนินการ

ข้อมูลทั้งหมดข้างต้นยกเว้นอาร์ติแฟกต์ที่จําเป็นสําหรับแซนด์บ็อกซ์จะระบุไว้ในเป้าหมาย Starlark ที่ cc_toolchain ชี้ไป

ระบบจะประกาศอาร์ติแฟกต์ที่จะจัดส่งไปยังแซนด์บ็อกซ์ในเป้าหมาย cc_toolchain ตัวอย่างเช่น คุณใช้แอตทริบิวต์ cc_toolchain.linker_files เพื่อระบุไลบรารีไบนารี Linker และ Toolchain เพื่อจัดส่งไปยังแซนด์บ็อกซ์ได้

การเลือกชุดเครื่องมือ

ตรรกะการเลือก Toolchain มีหน้าที่ดังต่อไปนี้

1. ผู้ใช้ระบุเป้าหมาย cc_toolchain_suite ในไฟล์ BUILD และชี้ Bazel ไปยังเป้าหมายโดยใช้ตัวเลือก --crosstool_top

2. เป้าหมาย cc_toolchain_suite อ้างอิงเครื่องมือทางเทคนิคหลายรายการ ค่าของ Flag --cpu และ --compiler จะเป็นตัวกำหนดว่าจะเลือก Toolchain ใดบ้าง ซึ่งอาจอิงจากค่า Flag --cpu เท่านั้น หรืออิงตามค่า --cpu | --compiler ร่วม ขั้นตอนการคัดเลือกมีดังนี้

   • หากระบุตัวเลือก --compiler แล้ว Bazel จะเลือกรายการที่เกี่ยวข้องจากแอตทริบิวต์ cc_toolchain_suite.toolchains ด้วย --cpu | --compiler ถ้า Bazel ไม่พบ รายการที่สอดคล้องกัน ก็จะแสดงข้อผิดพลาด

   • หากไม่ได้ระบุตัวเลือก --compiler ไว้ Bazel จะเลือกรายการที่เกี่ยวข้องจากแอตทริบิวต์ cc_toolchain_suite.toolchains ด้วย --cpu เพียงอย่างเดียว

   • หากไม่ได้ระบุ Flag ใดๆ Bazel จะตรวจสอบระบบโฮสต์และเลือกค่า --cpu ตามสิ่งที่พบ ดูโค้ดกลไกการตรวจสอบ

เมื่อเลือกเครื่องมือเชนแล้ว ออบเจ็กต์ feature และ action_config ที่เกี่ยวข้องในกฎ Starlark จะควบคุมการกำหนดค่าของบิลด์ (นั่นคือ รายการที่อธิบายไว้ภายหลัง) ข้อความเหล่านี้ช่วยให้ใช้งานฟีเจอร์ C++ ที่สมบูรณ์ใน Bazel ได้โดยไม่ต้องแก้ไขไบนารีของ Bazel กฎ C++ รองรับการดำเนินการที่ไม่ซ้ำกันหลายรายการที่บันทึกไว้อย่างละเอียดในซอร์สโค้ด Bazel

ฟีเจอร์

ฟีเจอร์คือเอนทิตีที่ต้องมีการแฟล็กบรรทัดคำสั่ง การดำเนินการ ข้อจำกัดในสภาพแวดล้อมการดำเนินการ หรือการปรับเปลี่ยนทรัพยากร Dependency ฟีเจอร์อาจเป็นเพียงการอนุญาตให้ไฟล์ BUILD เลือกการกำหนดค่าแฟล็ก เช่น treat_warnings_as_errors หรือโต้ตอบกับกฎ C++ และรวมการดำเนินการคอมไพล์ใหม่ๆ และอินพุตในการคอมไพล์ เช่น header_modules หรือ thin_lto ก็ได้

ตามหลักการแล้ว CcToolchainConfigInfo มีรายการฟีเจอร์ โดยแต่ละฟีเจอร์ประกอบด้วยกลุ่ม Flag 1 กลุ่มขึ้นไป โดยแต่ละกลุ่มกำหนดรายการ Flag ที่ใช้กับการดำเนินการของ Bazel ที่เฉพาะเจาะจง

ฟีเจอร์จะระบุตามชื่อ ซึ่งช่วยให้แยกการกำหนดค่ากฎ Starlark ออกจากรุ่น Bazel ได้อย่างเต็มที่ กล่าวคือ 릴리스 Bazel จะไม่ส่งผลต่อลักษณะการทํางานของการกำหนดค่า CcToolchainConfigInfo ตราบใดที่การกำหนดค่าเหล่านั้นไม่จําเป็นต้องใช้ฟีเจอร์ใหม่

ฟีเจอร์จะเปิดใช้ด้วยวิธีใดวิธีหนึ่งต่อไปนี้

• ช่อง enabled ของฟีเจอร์ตั้งค่าเป็น true
• Bazel หรือเจ้าของกฎเปิดใช้อย่างชัดแจ้ง
• ผู้ใช้เปิดใช้ผ่านแอตทริบิวต์ตัวเลือก --feature Bazel หรือกฎ features

ฟีเจอร์อาจมีความเกี่ยวข้องกัน ขึ้นอยู่กับ Flag บรรทัดคำสั่ง BUILDการตั้งค่าไฟล์ และตัวแปรอื่นๆ

ความสัมพันธ์ของฟีเจอร์

โดยทั่วไปแล้ว Dependency จะจัดการกับ Bazel โดยตรง ซึ่งจะบังคับใช้ข้อกําหนดและจัดการความขัดแย้งที่เกิดจากลักษณะของฟีเจอร์ที่กําหนดไว้ในบิลด์ ข้อมูลจำเพาะของ Toolchain ทำให้มีข้อจํากัดที่ละเอียดยิ่งขึ้นสำหรับใช้ในกฎ Starlark ที่ควบคุมการรองรับและการขยายฟีเจอร์โดยตรง ได้แก่

ข้อจำกัด	คำอธิบาย
requires = [ feature_set (features = [ 'feature-name-1', 'feature-name-2' ]), ]	ระดับฟีเจอร์ ระบบจะรองรับฟีเจอร์นี้ก็ต่อเมื่อเปิดใช้ฟีเจอร์ที่จำเป็นที่ระบุไว้เท่านั้น เช่น เมื่อระบบรองรับฟีเจอร์ในโหมดการสร้างบางโหมดเท่านั้น (opt, dbg หรือfastbuild) หาก "requires" มี "feature_set" หลายรายการ ระบบจะรองรับฟีเจอร์ดังกล่าวหาก "feature_set" รายการใดรายการหนึ่งตรงตามข้อกำหนด (เมื่อเปิดใช้ฟีเจอร์ที่ระบุไว้ทั้งหมด)
implies = ['feature']	ระดับฟีเจอร์ ฟีเจอร์นี้หมายถึงฟีเจอร์ที่ระบุ การเปิดใช้ฟีเจอร์หนึ่งๆ จะเป็นการเปิดใช้ฟีเจอร์ทั้งหมดที่ฟีเจอร์นั้นนัยถึงโดยปริยายด้วย (กล่าวคือ ฟีเจอร์จะทํางานแบบซ้ำซ้อน) นอกจากนี้ คุณยังแยกฟังก์ชันกลุ่มย่อยทั่วไปออกจากชุดฟีเจอร์ได้ด้วย เช่น ส่วนประกอบทั่วไปของเจลล้างทำความสะอาด ปิดใช้ฟีเจอร์ที่นัยไม่ได้
provides = ['feature']	ระดับฟีเจอร์ บ่งบอกว่าฟีเจอร์นี้เป็นหนึ่งในฟีเจอร์ทางเลือกหลายรายการที่ใช้งานร่วมกันไม่ได้ เช่น เจลล้างทำความสะอาดทั้งหมดอาจระบุ provides = ["sanitizer"] ซึ่งจะช่วยปรับปรุงการจัดการข้อผิดพลาดด้วยการแสดงทางเลือกต่างๆ หากผู้ใช้ขอฟีเจอร์ที่เหมือนกัน 2 อย่างขึ้นไปพร้อมกัน
with_features = [ with_feature_set( features = ['feature-1'], not_features = ['feature-2'], ), ]	ระดับชุดการแจ้งว่าไม่เหมาะสม ฟีเจอร์หนึ่งๆ สามารถระบุชุด Flag หลายชุดได้ เมื่อระบุ with_features ชุดแฟล็กจะขยายเป็นคำสั่งบิลด์เท่านั้นหากมี with_feature_set อย่างน้อย 1 รายการที่มีการเปิดใช้ฟีเจอร์ทั้งหมดในชุด features ที่ระบุ และปิดใช้ฟีเจอร์ทั้งหมดที่ระบุในชุด not_features หากไม่ได้ระบุ with_features ระบบจะใช้ชุด Flag กับการดำเนินการทั้งหมดที่ระบุโดยไม่มีเงื่อนไข

การทำงาน

การดำเนินการมีความยืดหยุ่นในการปรับเปลี่ยนสถานการณ์ต่างๆ ที่การดำเนินการจะทำโดยไม่ต้องคาดเดาว่าการดำเนินการจะทำงานอย่างไร action_config จะระบุไบนารีของเครื่องมือที่การดําเนินการเรียกใช้ ขณะที่ feature จะระบุการกําหนดค่า (Flag) ที่กําหนดลักษณะการทํางานของเครื่องมือนั้นเมื่อมีการเรียกใช้การดําเนินการ

ฟีเจอร์จะอ้างอิงการดำเนินการเพื่อส่งสัญญาณแจ้งว่าการดำเนินการของ Bazel ใดจะมีผล เนื่องจากการดำเนินการจะแก้ไขกราฟการดำเนินการของ Bazel ได้ ผู้ให้บริการ CcToolchainConfigInfo มีการดำเนินการที่มี Flag และเครื่องมือที่เกี่ยวข้อง เช่น c++-compile ระบบจะกำหนดธงให้กับการดำเนินการ แต่ละรายการโดยการเชื่อมโยงกับฟีเจอร์

ชื่อการดำเนินการแต่ละชื่อแสดงการดำเนินการประเภทเดียวที่ดำเนินการโดย Bazel เช่น การคอมไพล์หรือการลิงก์ อย่างไรก็ตาม การดำเนินการและประเภทการดำเนินการของ Bazel นั้นมีความเกี่ยวข้องแบบหลายต่อ 1 โดยประเภทการดำเนินการของ Bazel จะอ้างอิงถึงคลาส Java ที่ใช้การดำเนินการ (เช่น CppCompileAction) โดยเฉพาะอย่างยิ่ง "การดำเนินการของ assembler" และ "การดำเนินการของคอมไพเลอร์" ในตารางด้านล่างคือ CppCompileAction ส่วนการดำเนินการลิงก์คือ CppLinkAction

การดำเนินการของโปรแกรมประกอบ

การดำเนินการ	คำอธิบาย
preprocess-assemble	ประกอบกับการประมวลผลข้อมูลล่วงหน้า โดยปกติแล้วจะใช้กับไฟล์ .S
assemble	ประกอบโดยไม่ประมวลผลก่อน โดยปกติแล้วจะใช้กับไฟล์ .s

การดําเนินการของผู้คอมไพล์

การดำเนินการ	คำอธิบาย
cc-flags-make-variable	นำไปใช้กับ CC_FLAGS ใน genrules
c-compile	คอมไพล์เป็น C
c++-compile	คอมไพล์เป็น C++
c++-header-parsing	เรียกใช้โปรแกรมแยกวิเคราะห์ของคอมไพเลอร์ในไฟล์ส่วนหัวเพื่อให้แน่ใจว่าส่วนหัวนั้นสมบูรณ์ในตัว ไม่เช่นนั้นจะเกิดข้อผิดพลาดในการคอมไพล์ ใช้กับ Toolchain ที่รองรับโมดูลเท่านั้น

การดำเนินของการลิงก์

การดำเนินการ	คำอธิบาย
c++-link-dynamic-library	ลิงก์ไลบรารีที่ใช้ร่วมกันซึ่งมีทรัพยากร Dependency ทั้งหมด
c++-link-nodeps-dynamic-library	ลิงก์ไลบรารีที่ใช้ร่วมกันซึ่งมีเฉพาะแหล่งที่มา cc_library เท่านั้น
c++-link-executable	ลิงก์ไลบรารีสุดท้ายที่พร้อมใช้งาน

การดำเนินการ AR

การดำเนินการ AR จะรวมไฟล์ออบเจ็กต์ลงในไลบรารีที่เก็บถาวร (.a ไฟล์) ผ่าน ar และเข้ารหัสความหมายบางอย่างลงในชื่อ

การดำเนินการ	คำอธิบาย
c++-link-static-library	สร้างไลบรารีแบบคงที่ (ที่เก็บถาวร)

การดำเนินการ LTO

การดำเนินการ	คำอธิบาย
lto-backend	การดำเนินการ ThinLTO ที่คอมไพล์บิตโค้ดให้เป็นออบเจ็กต์แบบเนทีฟ
lto-index	การดำเนินการ ThinLTO ที่สร้างดัชนีทั่วโลก

การใช้ action_config

action_config คือสตรูคเจอร์ Starlark ที่อธิบายการดำเนินการของ Bazel โดยระบุเครื่องมือ (ไบนารี) ที่จะเรียกใช้ในระหว่างการดำเนินการและชุด Flag ที่กําหนดโดยฟีเจอร์ Flag เหล่านี้ใช้ข้อจำกัดกับการดำเนินการของการดำเนินการ

ตัวสร้าง action_config() มีพารามิเตอร์ต่อไปนี้

แอตทริบิวต์	คำอธิบาย
action_name	การกระทำของ Bazel ที่สอดคล้องกับการดำเนินการนี้ Bazel ใช้แอตทริบิวต์นี้เพื่อสำรวจเครื่องมือต่อการดำเนินการและข้อกำหนดการดำเนินการ
tools	ไฟล์ปฏิบัติการที่จะเรียกใช้ เครื่องมือที่ใช้กับการดำเนินการจะเป็นเครื่องมือแรกในรายการที่มีชุดฟีเจอร์ที่ตรงกับการกําหนดค่าฟีเจอร์ ต้องระบุค่าเริ่มต้น
flag_sets	รายการแฟล็กที่ใช้กับกลุ่มการดำเนินการ เหมือนกับสำหรับฟีเจอร์
env_sets	รายการข้อจำกัดของสภาพแวดล้อมที่ใช้กับกลุ่มการดำเนินการ เหมือนกับสำหรับฟีเจอร์

action_config สามารถกำหนดให้ใช้ฟีเจอร์และ action_config อื่นๆ ตามที่กำหนดไว้โดยความสัมพันธ์ของฟีเจอร์ที่อธิบายไว้ก่อนหน้านี้ ลักษณะการทํางานนี้คล้ายกับฟีเจอร์

แอตทริบิวต์ 2 รายการสุดท้ายซ้ำซ้อนกับแอตทริบิวต์ที่สอดคล้องกันในฟีเจอร์ และรวมอยู่ด้วยเนื่องจากการดำเนินการบางอย่างของ Bazel ต้องใช้ Flag หรือตัวแปรสภาพแวดล้อมบางอย่าง และเป้าหมายคือหลีกเลี่ยงคู่ action_config+feature ที่ไม่จำเป็น โดยทั่วไปแล้ว เราขอแนะนำให้แชร์ฟีเจอร์เดียวใน action_config หลายแห่ง

คุณกำหนด action_config มากกว่า 1 รายการที่มี action_name เดียวกันภายใน Toolchain เดียวกันไม่ได้ การดำเนินการนี้จะป้องกันความกำกวมในเส้นทางเครื่องมือและบังคับใช้เจตนาที่อยู่เบื้องหลัง action_config เนื่องจากมีการอธิบายพร็อพเพอร์ตี้ของการดำเนินการอย่างชัดเจนในที่เดียวใน Toolchain

การใช้เครื่องมือสร้าง

action_config สามารถระบุชุดเครื่องมือผ่านพารามิเตอร์ tools ตัวสร้าง tool() จะรับพารามิเตอร์ต่อไปนี้

ฟิลด์	คำอธิบาย
path	เส้นทางไปยังเครื่องมือที่เป็นปัญหา (สัมพันธ์กับตำแหน่งปัจจุบัน)
with_features	รายการชุดฟีเจอร์ที่คุณต้องทำตามอย่างน้อย 1 รายการจึงจะใช้เครื่องมือนี้ได้

สําหรับ action_config หนึ่งๆ จะมีเพียง tool รายการเดียวที่ใช้เส้นทางเครื่องมือและข้อกําหนดการดําเนินการกับการดำเนินการ Bazel มีการเลือกเครื่องมือโดยทำซ้ำผ่านแอตทริบิวต์ tools ใน action_config จนกว่าจะพบเครื่องมือที่มีชุด with_feature ตรงกับการกำหนดค่าฟีเจอร์ (ดูข้อมูลเพิ่มเติมได้ที่ความสัมพันธ์ของฟีเจอร์ก่อนหน้านี้ในหน้านี้) คุณควรสิ้นสุดรายการเครื่องมือด้วยเครื่องมือเริ่มต้นที่สอดคล้องกับการกำหนดค่าฟีเจอร์ที่ว่างเปล่า

ตัวอย่างการใช้

คุณใช้ฟีเจอร์และการทำงานร่วมกันเพื่อนำการกระทำของ Bazel ไปใช้ ด้วยความหมายข้ามแพลตฟอร์มที่หลากหลายได้ ตัวอย่างเช่น การสร้างสัญลักษณ์การแก้ไขข้อบกพร่องใน macOS ต้องสร้างสัญลักษณ์ในการดำเนินการคอมไพล์ จากนั้นเรียกใช้เครื่องมือเฉพาะทางระหว่างการดำเนินการลิงก์เพื่อสร้างที่เก็บถาวรของ DS ที่บีบอัด จากนั้นคลายการบีบอัดที่เก็บถาวรนั้นเพื่อสร้าง Bundle แอปพลิเคชันและไฟล์ .plist ที่ Xcode สามารถใช้งานได้

เมื่อใช้ Bazel คุณจะนำกระบวนการนี้ไปใช้แทนได้ โดยให้ unbundle-debuginfo เป็นการดำเนินการของ Bazel

load("@rules_cc//cc:defs.bzl", "ACTION_NAMES")

action_configs = [
    action_config (
        action_name = ACTION_NAMES.cpp_link_executable,
        tools = [
            tool(
                with_features = [
                    with_feature(features=["generate-debug-symbols"]),
                ],
                path = "toolchain/mac/ld-with-dsym-packaging",
            ),
            tool (path = "toolchain/mac/ld"),
        ],
    ),
]

features = [
    feature(
        name = "generate-debug-symbols",
        flag_sets = [
            flag_set (
                actions = [
                    ACTION_NAMES.c_compile,
                    ACTION_NAMES.cpp_compile
                ],
                flag_groups = [
                    flag_group(
                        flags = ["-g"],
                    ),
                ],
            )
        ],
        implies = ["unbundle-debuginfo"],
   ),
]

ฟีเจอร์เดียวกันนี้อาจใช้งานต่างออกไปโดยสิ้นเชิงสำหรับ Linux ที่ใช้ fission หรือสำหรับ Windows ซึ่งสร้างไฟล์ .pdb ตัวอย่างเช่น การใช้งานในการสร้างสัญลักษณ์การแก้ไขข้อบกพร่องตาม fission อาจมีลักษณะดังนี้

load("@rules_cc//cc:defs.bzl", "ACTION_NAMES")

action_configs = [
    action_config (
        name = ACTION_NAMES.cpp_compile,
        tools = [
            tool(
                path = "toolchain/bin/gcc",
            ),
        ],
    ),
]

features = [
    feature (
        name = "generate-debug-symbols",
        requires = [with_feature_set(features = ["dbg"])],
        flag_sets = [
            flag_set(
                actions = [ACTION_NAMES.cpp_compile],
                flag_groups = [
                    flag_group(
                        flags = ["-gsplit-dwarf"],
                    ),
                ],
            ),
            flag_set(
                actions = [ACTION_NAMES.cpp_link_executable],
                flag_groups = [
                    flag_group(
                        flags = ["-Wl", "--gdb-index"],
                    ),
                ],
            ),
      ],
    ),
]

กลุ่มการแจ้งว่าไม่เหมาะสม

CcToolchainConfigInfo ช่วยให้คุณรวม Flag ไว้เป็นกลุ่มสำหรับวัตถุประสงค์ที่เฉพาะเจาะจงได้ คุณระบุแฟล็กภายในได้โดยใช้ตัวแปรที่กำหนดไว้ล่วงหน้าภายในค่าแฟล็ก ซึ่งคอมไพเลอร์จะขยายเมื่อเพิ่มแฟล็กในคำสั่งบิลด์ เช่น

flag_group (
    flags = ["%{output_execpath}"],
)

ในกรณีนี้ เนื้อหาของแฟล็กจะแทนที่ด้วยเส้นทางไฟล์เอาต์พุตของการดำเนินการ

ระบบจะขยายกลุ่ม Flag ไปยังคำสั่งบิลด์ตามลำดับที่ปรากฏในรายการจากบนลงล่างจากซ้ายไปขวา

สำหรับแฟล็กที่ต้องทำซ้ำด้วยค่าอื่นเมื่อเพิ่มลงในคำสั่งบิลด์ กลุ่มแฟล็กจะทำซ้ำตัวแปรประเภท list ได้ เช่น ตัวแปร include_path ประเภท list

flag_group (
    iterate_over = "include_paths",
    flags = ["-I%{include_paths}"],
)

ขยายเป็น -I<path> สำหรับองค์ประกอบเส้นทางแต่ละรายการในรายการ include_paths ธงทั้งหมด (หรือ flag_group) ในส่วนเนื้อหาของการประกาศกลุ่ม Flag จะขยายเป็นหน่วยหนึ่ง เช่น

flag_group (
    iterate_over = "include_paths",
    flags = ["-I", "%{include_paths}"],
)

ขยายเป็น -I <path> สำหรับองค์ประกอบเส้นทางแต่ละรายการในรายการ include_paths

ตัวแปรใช้ซ้ำได้หลายครั้ง เช่น

flag_group (
    iterate_over = "include_paths",
    flags = ["-iprefix=%{include_paths}", "-isystem=%{include_paths}"],
)

ขยายเป็น

-iprefix=<inc0> -isystem=<inc0> -iprefix=<inc1> -isystem=<inc1>

ตัวแปรสามารถสอดคล้องกับโครงสร้างที่เข้าถึงได้โดยใช้เครื่องหมายจุด เช่น

flag_group (
    flags = ["-l%{libraries_to_link.name}"],
)

โครงสร้างสามารถซ้อนกันได้และอาจมีลำดับ คุณต้องระบุเส้นทางแบบเต็มในช่องเพื่อไม่ให้ชื่อทับซ้อนกันและเพื่อความชัดเจน เช่น

flag_group (
    iterate_over = "libraries_to_link",
    flag_groups = [
        flag_group (
            iterate_over = "libraries_to_link.shared_libraries",
            flags = ["-l%{libraries_to_link.shared_libraries.name}"],
        ),
    ],
)

การขยายแบบมีเงื่อนไข

กลุ่มที่มีการแจ้งจะรองรับการขยายแบบมีเงื่อนไขตามการมีอยู่ของตัวแปรหรือช่องของตัวแปรนั้นๆ โดยใช้แอตทริบิวต์ expand_if_available, expand_if_not_available, expand_if_true, expand_if_false หรือ expand_if_equal เช่น

flag_group (
    iterate_over = "libraries_to_link",
    flag_groups = [
        flag_group (
            iterate_over = "libraries_to_link.shared_libraries",
            flag_groups = [
                flag_group (
                    expand_if_available = "libraries_to_link.shared_libraries.is_whole_archive",
                    flags = ["--whole_archive"],
                ),
                flag_group (
                    flags = ["-l%{libraries_to_link.shared_libraries.name}"],
                ),
                flag_group (
                    expand_if_available = "libraries_to_link.shared_libraries.is_whole_archive",
                    flags = ["--no_whole_archive"],
                ),
            ],
        ),
    ],
)

หมายเหตุ: ระบบจะเพิ่มตัวเลือก --whole_archive และ --no_whole_archive ลงในคำสั่งบิลด์เมื่อไลบรารีที่ทำซ้ำในปัจจุบันมีช่อง is_whole_archive เท่านั้น

ข้อมูลอ้างอิง CcToolchainConfigInfo

ส่วนนี้จะแสดงข้อมูลอ้างอิงของตัวแปรบิลด์ ฟีเจอร์ และข้อมูลอื่นๆ ที่จำเป็นในการกำหนดค่ากฎ C++ ให้สำเร็จ

ตัวแปรบิลด์ CcToolchainConfigInfo

ต่อไปนี้เป็นข้อมูลอ้างอิงเกี่ยวกับCcToolchainConfigInfoตัวแปรการสร้าง

หมายเหตุ: คอลัมน์การดําเนินการจะระบุประเภทการดําเนินการที่เกี่ยวข้อง (หากมี)

ตัวแปร	การดำเนินการ	คำอธิบาย
source_file	คอมไพล์	ไฟล์ต้นฉบับที่จะคอมไพล์
input_file	แถบ	อาร์ติแฟกต์ที่จะตัด
output_file	คอมไพล์	ผลลัพธ์การคอมไพล์
output_assembly_file	คอมไพล์	ไฟล์ประกอบที่ส่งออก มีผลเฉพาะเมื่อการดำเนินการ compile ส่งออกข้อความแอสเซมบลี ซึ่งมักจะเป็นเมื่อใช้ Flag --save_temps เนื้อหาจะเหมือนกับของ output_file
output_preprocess_file	คอมไพล์	เอาต์พุตที่ประมวลผลล่วงหน้า มีผลเฉพาะกับการดำเนินการคอมไพล์ที่ประมวลผลไฟล์ต้นทางก่อนเท่านั้น ซึ่งมักจะใช้เมื่อใช้แฟล็ก --save_temps เนื้อหาจะเหมือนกับเนื้อหาสำหรับ output_file
includes	คอมไพล์	ลำดับไฟล์ที่คอมไพเลอร์ต้องรวมไว้ในซอร์สที่คอมไพล์โดยไม่มีเงื่อนไข
include_paths	คอมไพล์	ไดเรกทอรีลําดับที่คอมไพเลอร์ค้นหาส่วนหัวที่รวมอยู่โดยใช้ #include<foo.h> และ #include "foo.h"
quote_include_paths	คอมไพล์	ลำดับ -iquote ประกอบด้วยไดเรกทอรีที่คอมไพเลอร์ค้นหาส่วนหัวที่รวมโดยใช้ #include "foo.h"
system_include_paths	คอมไพล์	ลำดับ -isystem ประกอบด้วยไดเรกทอรีที่คอมไพเลอร์ค้นหาส่วนหัวที่รวมโดยใช้ #include <foo.h>
dependency_file	คอมไพล์	ไฟล์ .d Dependency ที่คอมไพเลอร์สร้างขึ้น
preprocessor_defines	คอมไพล์	ลําดับของ defines เช่น --DDEBUG
pic	คอมไพล์	คอมไพล์เอาต์พุตเป็นโค้ดที่ไม่อิงตามตำแหน่ง
gcov_gcno_file	คอมไพล์	ไฟล์ความครอบคลุม gcov
per_object_debug_info_file	คอมไพล์	ไฟล์ข้อมูลการแก้ไขข้อบกพร่อง (.dwp) ของแต่ละออบเจ็กต์
stripotps	แถบ	ลำดับของ stripopts
legacy_compile_flags	คอมไพล์	ลำดับการแจ้งจากช่อง CROSSTOOL เดิม เช่น compiler_flag, optional_compiler_flag, cxx_flag และ optional_cxx_flag
user_compile_flags	คอมไพล์	ลําดับ Flag จากแอตทริบิวต์กฎ copt หรือ Flag --copt, --cxxopt และ --conlyopt
unfiltered_compile_flags	คอมไพล์	ลําดับสถานะจากช่องunfiltered_cxx_flagเดิมCROSSTOOLหรือฟีเจอร์unfiltered_compile_flags ข้อมูลเหล่านี้ไม่ได้กรองตามแอตทริบิวต์กฎ nocopts
sysroot		sysroot
runtime_library_search_directories	ลิงก์	รายการในเส้นทางการค้นหารันไทม์ของ Linker (โดยปกติจะตั้งค่าด้วยแฟล็ก -rpath)
library_search_directories	ลิงก์	รายการในเส้นทางการค้นหา Linker (โดยปกติจะตั้งค่าด้วยแฟล็ก -L)
libraries_to_link	ลิงก์	แฟล็กที่ให้ไฟล์เพื่อลิงก์เป็นอินพุตในการเรียกใช้ Linker
def_file_path	ลิงก์	ตำแหน่งของไฟล์ def ที่ใช้ใน Windows กับ MSVC
linker_param_file	ลิงก์	ตำแหน่งของไฟล์พารามิเตอร์ linker ที่ Bazel สร้างขึ้นเพื่อเอาชนะขีดจำกัดความยาวของบรรทัดคำสั่ง
output_execpath	ลิงก์	Execpath ของเอาต์พุตของโปรแกรมลิงก์
generate_interface_library	ลิงก์	"yes" หรือ "no" ขึ้นอยู่กับว่าควรสร้างไลบรารีอินเทอร์เฟซหรือไม่
interface_library_builder_path	ลิงก์	เส้นทางไปยังเครื่องมือสร้างไลบรารีอินเทอร์เฟซ
interface_library_input_path	ลิงก์	อินพุตสําหรับเครื่องมือสร้างifsoคลังอินเทอร์เฟซ
interface_library_output_path	ลิงก์	เส้นทางที่จะสร้างคลังอินเทอร์เฟซโดยใช้ifsoเครื่องมือสร้าง
legacy_link_flags	ลิงก์	Flag ของ linker ที่มาจากช่อง CROSSTOOL รุ่นเดิม
user_link_flags	ลิงก์	Flag ของ Linker ที่มาจากแอตทริบิวต์ --linkopt หรือ linkopts
linkstamp_paths	ลิงก์	ตัวแปรบิลด์ที่มีเส้นทางลิงก์สแตมป์
force_pic	ลิงก์	การมีอยู่ของตัวแปรนี้บ่งบอกว่าควรสร้างโค้ด PIC/PIE (มีการส่งผ่านตัวเลือก Bazel "--force_pic")
strip_debug_symbols	ลิงก์	การมีอยู่ของตัวแปรนี้บ่งบอกว่าควรตัดสัญลักษณ์การแก้ไขข้อบกพร่องออก
is_cc_test	ลิงก์	จะเป็นจริงเมื่อการดำเนินการปัจจุบันเป็นcc_testการดำเนินการลิงก์ มิเช่นนั้นจะเป็นเท็จ
is_using_fission	คอมไพล์, ลิงก์	การมีตัวแปรนี้บ่งบอกว่า Fission (ข้อมูลการแก้ไขข้อบกพร่องต่อออบเจ็กต์) ทำงานอยู่ ข้อมูลการแก้ไขข้อบกพร่องจะอยู่ในไฟล์ .dwo แทนที่จะเป็น .o ไฟล์ และคอมไพเลอร์และ Linker จำเป็นต้องทราบเรื่องนี้
fdo_instrument_path	คอมไพล์ ลิงก์	เส้นทางไปยังไดเรกทอรีที่จัดเก็บโปรไฟล์เครื่องมือวัด FDO
fdo_profile_path	คอมไพล์	เส้นทางไปยังโปรไฟล์ FDO
fdo_prefetch_hints_path	คอมไพล์	เส้นทางไปยังโปรไฟล์ที่ดึงข้อมูลแคชล่วงหน้า
csfdo_instrument_path	คอมไพล์, ลิงก์	เส้นทางไปยังไดเรกทอรีที่จัดเก็บโปรไฟล์เครื่องมือวัด FDO ที่คำนึงถึงบริบท

สถานที่ที่รู้จักกันดี

ต่อไปนี้เป็นข้อมูลอ้างอิงเกี่ยวกับฟีเจอร์และเงื่อนไขการเปิดใช้งาน

ฟีเจอร์	เอกสารประกอบ
opt | dbg | fastbuild	เปิดใช้โดยค่าเริ่มต้นตามโหมดการคอมไพล์
static_linking_mode | dynamic_linking_mode	เปิดใช้โดยค่าเริ่มต้นตามโหมดการลิงก์
per_object_debug_info	เปิดใช้หากมีการระบุและเปิดใช้ฟีเจอร์ supports_fission รวมถึงมีการระบุโหมดการคอมไพล์ปัจจุบันใน Flag --fission
supports_start_end_lib	หากเปิดใช้ (และตั้งค่าตัวเลือก --start_end_lib) Bazel จะไม่ลิงก์กับไลบรารีแบบคงที่ แต่จะใช้ตัวเลือก linker --start-lib/--end-lib เพื่อลิงก์กับออบเจ็กต์โดยตรง ซึ่งช่วยให้สร้างบิลด์ได้เร็วขึ้นเนื่องจาก Bazel ไม่จำเป็นต้องสร้างไลบรารีแบบคงที่
supports_interface_shared_libraries	หากเปิดใช้ (และตั้งค่าตัวเลือก --interface_shared_objects) Bazel จะลิงก์เป้าหมายที่มีการตั้งค่า linkstatic เป็น "เท็จ" (ค่าเริ่มต้นคือ cc_test) กับไลบรารีที่แชร์อินเทอร์เฟซ ซึ่งจะทำให้เพิ่มการลิงก์ใหม่ได้เร็วขึ้น
supports_dynamic_linker	หากเปิดใช้ กฎ C++ จะทราบว่า Toolchain สร้างไลบรารีที่แชร์ได้
static_link_cpp_runtimes	หากเปิดใช้ Bazel จะลิงก์รันไทม์ของ C++ แบบคงที่ในโหมดการลิงก์แบบคงที่และแบบไดนามิกในโหมดการลิงก์แบบไดนามิก ระบบจะเพิ่มรายการต่างๆ ที่ระบุในแอตทริบิวต์ cc_toolchain.static_runtime_lib หรือ cc_toolchain.dynamic_runtime_lib (ขึ้นอยู่กับโหมดการลิงก์) ลงในการดำเนินการลิงก์
supports_pic	หากเปิดใช้ เครื่องมือทางเทคนิคจะรู้ว่าต้องใช้ออบเจ็กต์ PIC สำหรับไลบรารีแบบไดนามิก ตัวแปร `pic` จะปรากฏขึ้นเมื่อใดก็ตามที่จำเป็นต้องคอมไพล์ PIC หากไม่ได้เปิดใช้โดยค่าเริ่มต้นและมีการส่ง `--force_pic` มาด้วย Bazel จะขอ `supports_pic` และตรวจสอบว่าเปิดใช้ฟีเจอร์แล้ว หากฟีเจอร์นี้หายไปหรือ เปิดใช้ไม่ได้ คุณจะใช้ "--force_pic" ไม่ได้
static_linking_mode | dynamic_linking_mode	เปิดใช้โดยค่าเริ่มต้นตามโหมดการลิงก์
no_legacy_features	ป้องกันไม่ให้ Bazel เพิ่มฟีเจอร์เดิมในการกําหนดค่า C++ หากมี ดูรายการฟีเจอร์ทั้งหมดได้ที่ด้านล่าง

ตรรกะการแพตช์ฟีเจอร์เดิม

Bazel ใช้การเปลี่ยนแปลงต่อไปนี้กับฟีเจอร์ของเครื่องมือทางเทคนิคเพื่อให้มีความเข้ากันได้แบบย้อนหลัง

• ย้ายฟีเจอร์ legacy_compile_flags ไปไว้ที่ด้านบนของเครื่องมือ
• ย้ายฟีเจอร์ default_compile_flags ไปที่ด้านบนสุดของ Toolchain
• เพิ่มฟีเจอร์ dependency_file (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ pic (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ per_object_debug_info (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ preprocessor_defines (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ includes (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ include_paths (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ fdo_instrument (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ fdo_optimize (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ cs_fdo_instrument (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ cs_fdo_optimize (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ fdo_prefetch_hints (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ autofdo (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ build_interface_libraries (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ dynamic_library_linker_tool (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ shared_flag (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ linkstamps (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ output_execpath_flags (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ runtime_library_search_directories (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ library_search_directories (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ archiver_flags (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ libraries_to_link (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ force_pic_flags (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ user_link_flags (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ legacy_link_flags (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ static_libgcc (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ fission_support (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ strip_debug_symbols (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ coverage (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ llvm_coverage_map_format (หากไม่มี) ไว้ที่ด้านบนของเครื่องมือ
• เพิ่มฟีเจอร์ gcc_coverage_map_format (หากไม่มี) ที่ด้านบนของ Toolchain
• เพิ่มฟีเจอร์ fully_static_link (หากไม่มี) ลงที่ด้านล่างของเครื่องมือ
• เพิ่มฟีเจอร์ user_compile_flags (หากไม่มี) ที่ด้านล่างของ Toolchain
• เพิ่มฟีเจอร์ sysroot (หากไม่มี) ที่ด้านล่างของ Toolchain
• เพิ่มฟีเจอร์ unfiltered_compile_flags (หากไม่มี) ลงที่ด้านล่างของเครื่องมือ
• เพิ่มฟีเจอร์ linker_param_file (หากไม่มี) ลงที่ด้านล่างของเครื่องมือ
• เพิ่มฟีเจอร์ compiler_input_flags (หากไม่มี) ที่ด้านล่างของ Toolchain
• เพิ่มฟีเจอร์ compiler_output_flags (หากไม่มี) ที่ด้านล่างของ Toolchain

เราจะพูดถึงฟีเจอร์ต่างๆ จำนวนมาก แผนการคือกำจัดทิ้งเมื่อ ข้ามเครื่องมือใน Starlark เสร็จ สําหรับผู้อ่านที่อยากรู้ ให้ดูการใช้งานใน CppActionConfigs และสำหรับเครื่องมือทางเทคนิคเวอร์ชันที่ใช้งานจริง ให้พิจารณาเพิ่ม no_legacy_features เพื่อให้เครื่องมือทางเทคนิคเป็นแบบสแตนด์อโลนมากขึ้น