Bazel มีการรองรับที่ซับซ้อนสำหรับการจำลองแพลตฟอร์มและชุดเครื่องมือสำหรับบิลด์หลายสถาปัตยกรรมและบิลด์ที่คอมไพล์ข้าม
หน้านี้สรุปสถานะของการสนับสนุนนี้
และดู:
สถานะ
C++
กฎ C++ ใช้แพลตฟอร์มเพื่อเลือกชุดเครื่องมือเมื่อตั้งค่า --incompatible_enable_cc_toolchain_resolution
ซึ่งหมายความว่าคุณจะกำหนดค่าโปรเจ็กต์ C++ ได้ด้วยสิ่งต่อไปนี้
bazel build //:my_cpp_project --platforms=//:myplatform
แทนที่จะเป็นแบบเดิม
bazel build //:my_cpp_project` --cpu=... --crosstool_top=... --compiler=...
การดำเนินการนี้จะเปิดใช้โดยค่าเริ่มต้นใน Bazel 7.0 (#7260)
หากต้องการทดสอบโปรเจ็กต์ C++ กับแพลตฟอร์ม โปรดดูหัวข้อการย้ายข้อมูลโปรเจ็กต์และการกำหนดค่าชุดเครื่องมือ C++
Java
กฎ Java ใช้แพลตฟอร์มเพื่อเลือกชุดเครื่องมือ
ซึ่งจะใช้แทน Flag เดิมอย่าง --java_toolchain
, --host_java_toolchain
,
--javabase
และ --host_javabase
ดูรายละเอียดได้ที่ Java และ Bazel
Android
กฎ Android จะใช้แพลตฟอร์มเพื่อเลือก Toolchain
ตั้งค่า --incompatible_enable_android_toolchain_resolution
แล้ว
ซึ่งหมายความว่าคุณสามารถกำหนดค่าโปรเจ็กต์ Android ด้วยสิ่งต่อไปนี้
bazel build //:my_android_project --android_platforms=//:my_android_platform
แทน Flag เดิมอย่าง --android_crosstool_top
, --android_cpu
และ --fat_apk_cpu
การดำเนินการนี้จะเปิดใช้โดยค่าเริ่มต้นใน Bazel 7.0 (#16285)
หากต้องการทดสอบโปรเจ็กต์ Android กับแพลตฟอร์ม โปรดดู การย้ายข้อมูลโปรเจ็กต์
Apple
กฎของ Apple ไม่รองรับแพลตฟอร์มและยังไม่มีการกำหนดเวลา เพื่อรับการสนับสนุน
คุณจะยังใช้ API ของแพลตฟอร์มกับบิลด์ของ Apple ได้ (เช่น เมื่อสร้าง โดยใช้ทั้งกฎของ Apple และ C++ ที่แท้จริง) กับแพลตฟอร์ม การแมป
ภาษาอื่นๆ
- กฎ Go รองรับแพลตฟอร์มอย่างเต็มรูปแบบ
- กฎความน่าเชื่อถือรองรับแพลตฟอร์มอย่างเต็มรูปแบบ
หากคุณเป็นเจ้าของชุดกฎภาษา โปรดดูการย้ายข้อมูลชุดกฎเพื่อเพิ่มการสนับสนุน
ข้อมูลเบื้องต้น
แพลตฟอร์มและชุดเครื่องมือได้รับการนําเสนอเพื่อกำหนดมาตรฐานวิธีกำหนดเป้าหมายสถาปัตยกรรมต่างๆ และคอมไพล์ข้ามของโปรเจ็กต์ซอฟต์แวร์
นี่คือ
แรงบันดาลใจ
จากการสังเกตที่ผู้ดูแลภาษาทำสิ่งนี้ในโฆษณาอยู่แล้ว
เฉพาะกิจ, แบบที่ใช้ร่วมกันไม่ได้ ตัวอย่างเช่น กฎ C++ ใช้ --cpu
และ
--crosstool_top
เพื่อประกาศ CPU และ Toolchain เป้าหมาย ตัวอย่างทั้ง 2 รายการนี้ไม่ได้จำลอง "แพลตฟอร์ม" อย่างถูกต้อง สิ่งนี้ทำให้เกิดงานสร้างที่ไม่น่าอึดอัดและไม่ถูกต้อง
Java, Android และภาษาอื่นๆ ได้พัฒนาแฟล็กของตัวเองเพื่อวัตถุประสงค์ที่คล้ายกัน ซึ่งไม่มีภาษาใดที่ทำงานร่วมกันได้ การสร้างบิลด์ข้ามภาษา ยุ่งยากและซับซ้อน
Bazel ออกแบบมาสำหรับโปรเจ็กต์ขนาดใหญ่ที่ใช้หลายภาษาและหลายแพลตฟอร์ม ช่วงเวลานี้ ต้องการการสนับสนุนโดยมีหลักการมากกว่าสำหรับแนวคิดเหล่านี้ รวมถึง API มาตรฐาน
ความต้องการในการย้ายข้อมูล
การอัปเกรดเป็น API ใหม่ต้องใช้ความพยายาม 2 ประการ ได้แก่ การเผยแพร่ API และการอัปเกรด ใช้ตรรกะของกฎ
รายการแรกเสร็จแล้ว แต่ครั้งที่ 2 ยังทำอยู่ ซึ่งประกอบด้วย
มีการกำหนดแพลตฟอร์มและ Toolchain เฉพาะภาษา การอ่านตรรกะทางภาษา
Toolchain ผ่าน API ใหม่แทน Flag เก่าอย่าง --crosstool_top
และ
config_setting
เลือกใช้ API ใหม่แทน Flag เก่า
งานนี้ตรงไปตรงมาแต่ต้องใช้ความพยายามที่แตกต่างกันสำหรับแต่ละภาษา รวมถึงคำเตือนที่ยุติธรรมสำหรับเจ้าของโปรเจ็กต์เพื่อทดสอบกับการเปลี่ยนแปลงที่กําลังจะเกิดขึ้น
ด้วยเหตุนี้ การย้ายข้อมูลจึงเกิดขึ้นอย่างต่อเนื่อง
เป้าหมาย
การย้ายข้อมูลนี้จะเสร็จสมบูรณ์เมื่อโปรเจ็กต์ทั้งหมดที่สร้างด้วยแบบฟอร์มต่อไปนี้
bazel build //:myproject --platforms=//:myplatform
ซึ่งหมายความว่า
- กฎของโปรเจ็กต์เลือกเครื่องมือเชนที่ถูกต้องสำหรับ
//:myplatform
- ทรัพยากร Dependency ของโปรเจ็กต์เลือก Toolchain ที่เหมาะสมสำหรับ
//:myplatform
//:myplatform
อ้างอิงการประกาศทั่วไปของCPU
,OS
และพร็อพเพอร์ตี้ทั่วไปอื่นๆ ที่ไม่ขึ้นอยู่กับภาษาselect()
ที่เกี่ยวข้องทั้งหมดตรงกับ//:myplatform
อย่างถูกต้อง//:myplatform
ได้รับการกําหนดในที่ที่เข้าถึงได้ชัดเจน เช่น ในรีโปของโปรเจ็กต์หากแพลตฟอร์มนั้นใช้เฉพาะกับโปรเจ็กต์ของคุณ หรือที่ที่โปรเจ็กต์ที่บริโภคทั้งหมดสามารถค้นหาได้
แฟล็กเก่า เช่น --cpu
, --crosstool_top
และ --fat_apk_cpu
จะ
จะเลิกใช้งานและนำออกทันทีที่ทำได้
ท้ายที่สุดแล้ว การกำหนดค่าสถาปัตยกรรมจึงเป็นวิธีเดียว
กำลังย้ายข้อมูลโปรเจ็กต์
หากคุณสร้างด้วยภาษาที่รองรับแพลตฟอร์ม บิลด์ของคุณควรทํางานกับการเรียกใช้ เช่น
bazel build //:myproject --platforms=//:myplatform
ดูรายละเอียดอย่างละเอียดได้ที่สถานะและเอกสารประกอบของภาษา
หากภาษาต้องมีการตั้งค่าสถานะเพื่อเปิดใช้การรองรับแพลตฟอร์ม คุณยังต้องตั้งค่า แฟล็กนั้น ดูรายละเอียดได้ที่สถานะ
คุณต้องตรวจสอบรายการต่อไปนี้เพื่อให้โปรเจ็กต์สร้าง
//:myplatform
ต้องมีอยู่ โดยทั่วไปแล้วเป็นความรับผิดชอบของเจ้าของโปรเจ็กต์ กำหนดแพลตฟอร์มเพราะโครงการที่ต่างกันกำหนดเป้าหมายเครื่องที่ต่างกัน โปรดดูแพลตฟอร์มเริ่มต้นต้องมี Toolchain ที่ต้องการใช้ หากใช้เครื่องมือทางภาษาที่มีอยู่ เจ้าของภาษาควรระบุวิธีการลงทะเบียนเครื่องมือเหล่านั้น ถ้า การเขียน Toolchain ของคุณเอง คุณจะต้องลงทะเบียนใน
WORKSPACE
หรือด้วย--extra_toolchains
select()
และการเปลี่ยนการกำหนดค่าต้อง แก้ไขได้อย่างถูกต้อง โปรดดูselect() และการเปลี่ยนหากบิลด์ของคุณรวมภาษาที่รองรับและไม่รองรับแพลตฟอร์มต่างๆ คุณอาจ ซึ่งจำเป็นต้องใช้การแมปแพลตฟอร์มเพื่อช่วยให้ภาษาเดิมใช้งานกับ API ใหม่ได้ ดูรายละเอียดได้ที่การแมปแพลตฟอร์ม
หากยังพบปัญหาอยู่ โปรดติดต่อเพื่อขอความช่วยเหลือ
แพลตฟอร์มเริ่มต้น
เจ้าของโปรเจ็กต์ควรกำหนดแพลตฟอร์มอย่างชัดเจนเพื่ออธิบายสถาปัตยกรรมที่ต้องการสร้าง ซึ่งจะทริกเกอร์ด้วย --platforms
เมื่อไม่ได้ตั้งค่า --platforms
ค่าเริ่มต้นของ Bazel จะเป็น platform
ที่แสดงถึงเครื่องสำหรับสร้างในเครื่อง รายการนี้จะสร้างขึ้นโดยอัตโนมัติที่ @local_config_platform//:host
คุณจึงไม่ต้องกำหนดอย่างชัดแจ้ง โดยจะแมป OS
และ CPU
ของเครื่องที่ใช้งานอยู่กับ constraint_value
ที่ประกาศไว้ใน @platforms
select()
โปรเจ็กต์select()
บนแพลตฟอร์มconstraint_value
เป้าหมายได้ แต่จะดำเนินการให้เสร็จสมบูรณ์ไม่ได้ เราตั้งใจให้ select()
รองรับแท็กประเภทต่างๆ
อุปกรณ์ให้ได้มากที่สุด ไลบรารีที่มีแหล่งที่มาเฉพาะ ARM
ควรรองรับทั้งหมด
เครื่องที่ขับเคลื่อนโดย ARM
ยกเว้นในกรณีที่มีเหตุผลให้เจาะจงมากขึ้น
หากต้องการเลือก constraint_value
อย่างน้อย 1 รายการ ให้ใช้
config_setting(
name = "is_arm",
constraint_values = [
"@platforms//cpu:arm",
],
)
ซึ่งเทียบเท่ากับการเลือกใน --cpu
แบบดั้งเดิม
config_setting(
name = "is_arm",
values = {
"cpu": "arm",
},
)
ดูรายละเอียดเพิ่มเติมได้ที่นี่
select
ใน --cpu
, --crosstool_top
ฯลฯ ไม่เข้าใจ --platforms
เมื่อย้ายข้อมูลโปรเจ็กต์ไปยังแพลตฟอร์ม คุณต้องแปลงโปรเจ็กต์เป็น
constraint_values
หรือใช้การแมปแพลตฟอร์มเพื่อรองรับ
ทั้ง 2 สไตล์ในระหว่างการย้ายข้อมูล
ทรานซิชัน
การเปลี่ยน Starlark จะเปลี่ยนสถานะบางส่วนของกราฟการบิลด์ หากโปรเจ็กต์ใช้ทรานซิชันที่ตั้งค่า --cpu
, --crossstool_top
หรือ Flag เดิมอื่นๆ กฎที่อ่าน --platforms
จะไม่แสดงการเปลี่ยนแปลงเหล่านี้
เมื่อย้ายข้อมูลโปรเจ็กต์ไปยังแพลตฟอร์ม คุณต้องแปลงการเปลี่ยนแปลงอย่างใดอย่างหนึ่งต่อไปนี้
return { "//command_line_option:cpu": "arm" }
ไปยัง return {
"//command_line_option:platforms": "//:my_arm_platform" }
หรือใช้ platform
เพื่อให้รองรับทั้ง 2 สไตล์ระหว่างการย้ายข้อมูล
กำลังย้ายข้อมูลชุดกฎ
หากคุณเป็นเจ้าของชุดกฎและต้องการสนับสนุนแพลตฟอร์ม คุณต้องดำเนินการดังนี้
มีการแปลง Toolchain ของกฎด้วย Toolchain API โปรดดู toolchain API (
ctx.toolchains
)ไม่บังคับ: กําหนด Flag
--incompatible_enable_platforms_for_my_language
เพื่อให้ตรรกะกฎแก้ไขเครื่องมือทางเทคนิคผ่าน API ใหม่หรือ Flag เก่าสลับกัน เช่น--crosstool_top
ในระหว่างการทดสอบการย้ายข้อมูลกําหนดพร็อพเพอร์ตี้ที่เกี่ยวข้องซึ่งประกอบกันเป็นคอมโพเนนต์ของแพลตฟอร์ม ดูพร็อพเพอร์ตี้แพลตฟอร์มทั่วไป
กำหนดเครื่องมือมาตรฐานและทำให้ผู้ใช้เข้าถึงเครื่องมือเหล่านั้นได้ผ่านวิธีการลงทะเบียนของกฎ (รายละเอียด)
ตรวจสอบว่า
select()
และ แพลตฟอร์มสนับสนุนการเปลี่ยนการกำหนดค่า นี่คือ ที่ท้าทายที่สุด เป็นเรื่องที่ท้าทายอย่างยิ่งสำหรับโปรเจ็กต์หลายภาษา (ซึ่งอาจล้มเหลวหากทุกภาษาอ่าน--platforms
ไม่ได้)
หากต้องการใช้กฎที่ไม่รองรับแพลตฟอร์มต่างๆ ร่วมกัน คุณอาจต้อง การแมปแพลตฟอร์มเพื่อเชื่อมช่องว่าง
พร็อพเพอร์ตี้ของแพลตฟอร์มทั่วไป
พร็อพเพอร์ตี้ทั่วไปของแพลตฟอร์มข้ามภาษา เช่น OS
และ CPU
ควรมีลักษณะดังนี้
ที่ประกาศใน @platforms
ซึ่งจะช่วยส่งเสริมการแชร์ การกำหนดมาตรฐาน และความเข้ากันได้ข้ามภาษา
คุณควรประกาศพร็อพเพอร์ตี้ที่ไม่ซ้ำกันสำหรับกฎของคุณในที่เก็บของกฎ ช่วงเวลานี้ ช่วยให้คุณรักษาความเป็นเจ้าของแนวคิดที่ชัดเจนเกี่ยวกับกฎ เป็นผู้รับผิดชอบ
หากกฎของคุณใช้ระบบปฏิบัติการหรือ CPU ตามวัตถุประสงค์ที่กำหนดเอง ควรประกาศรายการเหล่านี้ไว้ใน
ที่เก็บของกฎเทียบกับ
@platforms
การแมปแพลตฟอร์ม
การแมปแพลตฟอร์มคือ API ชั่วคราวที่ช่วยให้ตรรกะแบบรับรู้แพลตฟอร์มผสมผสานกับตรรกะเดิมในบิลด์เดียวกันได้ เครื่องมือนี้เป็นเครื่องมือที่ทำงานแบบตรงไปตรงมาซึ่งมีไว้เพื่อลดความไม่เข้ากันได้กับกรอบเวลาการย้ายข้อมูลที่แตกต่างกันเท่านั้น
การแมปแพลตฟอร์มคือการแมป platform()
กับชุด Flag รุ่นเดิมที่สอดคล้องกัน หรือในทางกลับกัน เช่น
platforms:
# Maps "--platforms=//platforms:ios" to "--cpu=ios_x86_64 --apple_platform_type=ios".
//platforms:ios
--cpu=ios_x86_64
--apple_platform_type=ios
flags:
# Maps "--cpu=ios_x86_64 --apple_platform_type=ios" to "--platforms=//platforms:ios".
--cpu=ios_x86_64
--apple_platform_type=ios
//platforms:ios
# Maps "--cpu=darwin_x86_64 --apple_platform_type=macos" to "//platform:macos".
--cpu=darwin_x86_64
--apple_platform_type=macos
//platforms:macos
Bazel ใช้ข้อมูลนี้เพื่อรับประกันว่าการตั้งค่าทั้งหมด ทั้งแบบตามแพลตฟอร์มและแบบเดิม จะใช้อย่างสอดคล้องกันตลอดทั้งการสร้าง รวมถึงในการเปลี่ยนผ่าน
โดยค่าเริ่มต้น Bazel จะอ่านการแมปจากไฟล์ platform_mappings
ในไฟล์
Workspace Root นอกจากนี้ คุณยังสามารถตั้งค่า
--platform_mappings=//:my_custom_mapping
ดูรายละเอียดได้ที่การออกแบบการแมปแพลตฟอร์ม
การตรวจสอบ API
platform
คือคอลเล็กชันของ
constraint_value
เป้าหมาย:
platform(
name = "myplatform",
constraint_values = [
"@platforms//os:linux",
"@platforms//cpu:arm",
],
)
constraint_value
เป็นเครื่อง
ระบบจะจัดกลุ่มค่า "ประเภท" เดียวกันไว้ภายใต้ constraint_setting
เดียวกัน ดังนี้
constraint_setting(name = "os")
constraint_value(
name = "linux",
constraint_setting = ":os",
)
constraint_value(
name = "mac",
constraint_setting = ":os",
)
toolchain
คือกฎ Starlark คือ
แอตทริบิวต์ประกาศเครื่องมือของภาษา (เช่น compiler =
"//mytoolchain:custom_gcc"
) บัตรของ providers
ข้อมูลนี้มาใช้กับกฎที่จะต้องสร้างด้วยเครื่องมือเหล่านี้
toolchain จะประกาศconstraint_value
ของเครื่องที่กำหนดเป้าหมายได้ (target_compatible_with = ["@platforms//os:linux"]
) และเครื่องที่เครื่องมือของ toolchain ทำงานได้ (exec_compatible_with = ["@platforms//os:mac"]
)
เมื่อสร้าง $ bazel build //:myproject --platforms=//:myplatform
ทาง Bazel จะเลือกชุดเครื่องมือที่ทำงานบนเครื่องที่ใช้สร้างได้และสร้างไบนารีสำหรับ //:myplatform
โดยอัตโนมัติ การดำเนินการนี้เรียกว่าการแก้ไขเครื่องมือทางเทคนิค
คุณสามารถลงทะเบียนชุดเครื่องมือที่ใช้ได้ใน WORKSPACE
ด้วย register_toolchains
หรือที่บรรทัดคำสั่งด้วย --extra_toolchains
ดูข้อมูลเพิ่มเติมที่นี่
คำถาม
หากต้องการการสนับสนุนทั่วไปและคำถามเกี่ยวกับลำดับเวลาการย้ายข้อมูล โปรดติดต่อ bazel-discuss หรือเจ้าของกฎที่เหมาะสม
สำหรับการพูดคุยถึงการออกแบบและพัฒนา API ของแพลตฟอร์ม/เครื่องมือเชน โปรดติดต่อ bazel-dev