ผู้ปฏิบัติงานแบบถาวรช่วยให้บิลด์เร็วขึ้น หากคุณมีการดำเนินการซ้ำๆ ในบิลด์ซึ่งมีต้นทุนในการเริ่มต้นใช้งานสูงหรือจะได้รับประโยชน์จากการแคชข้ามการดำเนินการ คุณอาจต้องให้ผู้ปฏิบัติงานถาวรของคุณเองเป็นผู้ดำเนินการเหล่านี้
เซิร์ฟเวอร์ Bazel สื่อสารกับผู้ปฏิบัติงานโดยใช้ stdin
/stdout
โดยรองรับการใช้บัฟเฟอร์โปรโตคอลหรือสตริง JSON
การใช้งานผู้ปฏิบัติงานมี 2 ส่วนดังนี้
การทำให้พนักงาน
ผู้ปฏิบัติงานถาวรจะต้องปฏิบัติตามข้อกำหนดบางประการดังต่อไปนี้
- โดยจะอ่าน WorkRequests จาก
stdin
- โดยจะเขียน WorkResponses (และเฉพาะ
WorkResponse
) ลงในstdout
- ยอมรับแฟล็ก
--persistent_worker
โดย Wrapper ต้องจดจำแฟล็กบรรทัดคำสั่ง--persistent_worker
และตั้งค่าให้คงอยู่ถาวรก็ต่อเมื่อมีการส่งแฟล็กดังกล่าวเท่านั้น มิเช่นนั้น ก็ต้องทำการคอมไพล์แบบ 1 ช็อตและออก
หากโปรแกรมของคุณเป็นไปตามข้อกำหนดเหล่านี้ ก็สามารถใช้เป็นผู้ปฏิบัติงานถาวรได้
คำของาน
WorkRequest
มีรายการอาร์กิวเมนต์สำหรับผู้ปฏิบัติงาน รายการคู่ไดเจสต์ของเส้นทางที่แสดงอินพุตที่ผู้ปฏิบัติงานเข้าถึงได้ (ไม่ได้บังคับใช้ แต่คุณใช้ข้อมูลนี้สำหรับการแคชได้) และรหัสคำขอซึ่งเป็น 0 สำหรับผู้ปฏิบัติงาน Singleplex
หมายเหตุ: แม้ว่าข้อกำหนดของบัฟเฟอร์โปรโตคอลจะใช้ "รูปแบบ Snake Case" (request_id
) แต่โปรโตคอล JSON จะใช้ "รูปแบบ Camel Case" (requestId
) เอกสารนี้ใช้รูปแบบ Camel Case ในตัวอย่าง JSON แต่ใช้รูปแบบ Snake Case เมื่อพูดถึงฟิลด์โดยไม่คำนึงถึงโปรโตคอล
{
"arguments" : ["--some_argument"],
"inputs" : [
{ "path": "/path/to/my/file/1", "digest": "fdk3e2ml23d"},
{ "path": "/path/to/my/file/2", "digest": "1fwqd4qdd" }
],
"requestId" : 12
}
คุณสามารถใช้ช่อง verbosity
(ไม่บังคับ) เพื่อขอเอาต์พุตการแก้ไขข้อบกพร่องเพิ่มเติมจากเวิร์กเกอร์ โดยขึ้นอยู่กับผู้ปฏิบัติงานว่าจะนำเสนออะไรและอย่างไร ค่าที่สูงขึ้นหมายถึงเอาต์พุตที่มีความละเอียดมากขึ้น การส่ง Flag --worker_verbose
ไปยัง Bazel จะตั้งค่าช่อง verbosity
เป็น 10 แต่คุณใช้ค่าที่เล็กกว่าหรือมากกว่าได้ด้วยตัวเองสำหรับเอาต์พุตจำนวนต่างๆ
มีเพียงผู้ปฏิบัติงานที่รองรับแซนด์บ็อกซ์ Multiplex ที่ใช้ช่อง sandbox_dir
ที่ไม่บังคับเท่านั้น
การตอบกลับเกี่ยวกับงาน
WorkResponse
ประกอบด้วยรหัสคำขอ โค้ดสำหรับออก 0 หรือที่ไม่ใช่ 0 และสตริงเอาต์พุตที่อธิบายข้อผิดพลาดทั้งหมดที่พบในการประมวลผลหรือการดำเนินการตามคำขอ ฟิลด์ output
มีคำอธิบายสั้นๆ โดยอาจเขียนบันทึกทั้งหมดลงใน stderr
ของผู้ปฏิบัติงาน เนื่องจากผู้ปฏิบัติงานเขียนได้แค่ WorkResponses
ไปยัง stdout
จึงเป็นเรื่องปกติที่ผู้ปฏิบัติงานจะเปลี่ยนเส้นทาง stdout
ของเครื่องมือที่ใช้ไปยัง stderr
{
"exitCode" : 1,
"output" : "Action failed with the following message:\nCould not find input
file \"/path/to/my/file/1\"",
"requestId" : 12
}
ไม่จำเป็นต้องกรอกข้อมูลครบทุกช่องตามมาตรฐานของ protobuf อย่างไรก็ตาม Bazel กำหนดให้ WorkRequest
และ WorkResponse
ที่เกี่ยวข้องต้องมีรหัสคำขอเดียวกัน ดังนั้นจึงต้องระบุรหัสคำขอหากไม่ใช่ 0 WorkResponse
นี้ถูกต้อง
{
"requestId" : 12,
}
request_id
จาก 0 หมายถึงคำขอ "singleplex" ที่ใช้เมื่อไม่สามารถดำเนินการตามคำขอนี้พร้อมกับคำขออื่นๆ ได้ เซิร์ฟเวอร์จะรับประกันว่าผู้ปฏิบัติงานหนึ่งๆ จะได้รับคำขอที่มีเพียง request_id
0 หรือ request_id
ที่มากกว่า 0 เท่านั้น ระบบจะส่งคำขอ Singleplex เป็นอนุกรม ตัวอย่างเช่น หากเซิร์ฟเวอร์ไม่ได้ส่งคำขออีกรายการหนึ่งจนกว่าจะได้รับการตอบกลับ (ยกเว้นคำขอยกเลิก โปรดดูด้านล่าง)
หมายเหตุ
- บัฟเฟอร์โปรโตคอลแต่ละรายการจะมีความยาวนำหน้าในรูปแบบ
varint
(ดูMessageLite.writeDelimitedTo()
- คำขอและการตอบสนอง JSON ไม่ได้นำหน้าด้วยตัวระบุขนาด
- คำขอ JSON รักษาโครงสร้างเดียวกันกับ Protobuf แต่ใช้ JSON มาตรฐานและใช้รูปแบบ Caml Case สำหรับชื่อช่องทั้งหมด
- ผู้ปฏิบัติงาน JSON ต้องยอมรับช่องที่ไม่รู้จักในข้อความเหล่านี้ และใช้ค่าเริ่มต้นของ protocolbuf สำหรับค่าที่หายไป เพื่อรักษาคุณสมบัติความเข้ากันได้แบบย้อนหลังและไปข้างหน้าเหมือนกับ Protobuf
- Bazel จัดเก็บคำขอเป็น Protocolbufs และแปลงเป็น JSON โดยใช้รูปแบบ JSON ของ produf
การยกเลิก
ผู้ปฏิบัติงานสามารถเลือกที่จะอนุญาตให้ยกเลิกคำของานก่อนทำเสร็จได้
ซึ่งมีประโยชน์อย่างยิ่งเมื่อเกี่ยวข้องกับการดำเนินการแบบไดนามิกที่การดําเนินการในเครื่องอาจถูกขัดจังหวะโดยการดำเนินการระยะไกลที่เร็วกว่าเป็นประจำ หากต้องการอนุญาตการยกเลิก ให้เพิ่ม supports-worker-cancellation: 1
ลงในช่อง execution-requirements
(ดูด้านล่าง) แล้วตั้งค่า Flag --experimental_worker_cancellation
คำขอยกเลิกคือ WorkRequest
ที่มีการตั้งค่าฟิลด์ cancel
(และการตอบกลับการยกเลิกก็เช่นเดียวกันคือ WorkResponse
ที่มีการตั้งค่าฟิลด์ was_cancelled
) ช่องเดียวที่ต้องอยู่ในคำขอยกเลิกหรือยกเลิกคำตอบคือ request_id
ซึ่งระบุคำขอที่จะยกเลิก ช่อง request_id
จะเท่ากับ 0 สําหรับผู้ทํางานแบบ Singleplex หรือ request_id
ที่ไม่ใช่ 0 ของ WorkRequest
ที่ส่งไปก่อนหน้านี้สําหรับผู้ทํางานแบบ Multiplex เซิร์ฟเวอร์อาจส่งคำขอยกเลิกสำหรับคำขอที่เจ้าหน้าที่ตอบกลับแล้ว ในกรณีนี้ต้องไม่สนใจคำขอยกเลิก
ต้องตอบข้อความ WorkRequest
ที่ไม่ยกเลิกแต่ละข้อความเพียงครั้งเดียว ไม่ว่าจะมีการยกเลิกข้อความหรือไม่ก็ตาม เมื่อเซิร์ฟเวอร์ส่งคำขอยกเลิก ผู้ปฏิบัติงานอาจตอบกลับด้วย WorkResponse
ด้วยชุด request_id
และตั้งค่าช่อง was_cancelled
เป็น "จริง" ระบบยอมรับการส่ง WorkResponse
ปกติด้วย แต่จะไม่สนใจฟิลด์ output
และ exit_code
เมื่อส่งคำตอบสำหรับ WorkRequest
แล้ว ผู้ปฏิบัติงานต้องไม่แตะต้องไฟล์ในไดเรกทอรีการทำงาน เซิร์ฟเวอร์จะล้างไฟล์ต่างๆ
รวมถึงไฟล์ชั่วคราวได้โดยไม่เสียค่าใช้จ่าย
การสร้างกฎที่ใช้แรงงาน
และจะต้องสร้างกฎที่สร้างการทำงานที่ผู้ปฏิบัติงานต้องทำด้วย การสร้างกฎ Starlark ที่ใช้เวิร์กเกอร์นั้นเหมือนกับการสร้างกฎอื่นๆ
นอกจากนี้ กฎจะต้องมีการอ้างอิงถึงตัวผู้ปฏิบัติงานเอง และมีข้อกำหนดบางประการสำหรับการทำงานที่เกิดขึ้น
กำลังส่งต่อให้กับผู้ปฏิบัติงาน
กฎที่ใช้ผู้ปฏิบัติงานต้องมีช่องที่อ้างถึงผู้ปฏิบัติงานเอง ดังนั้นคุณจะต้องสร้างอินสแตนซ์ของกฎ \*\_binary
เพื่อกำหนดผู้ปฏิบัติงาน หากผู้ปฏิบัติงานของคุณมีชื่อว่า MyWorker.Java
กฎที่เกี่ยวข้องอาจเป็นกฎที่เกี่ยวข้อง
java_binary(
name = "worker",
srcs = ["MyWorker.Java"],
)
ซึ่งจะสร้างป้ายกำกับ "worker" ที่หมายถึงไบนารีของผู้ปฏิบัติงาน จากนั้นคุณจะต้องระบุกฎที่ใช้ผู้ปฏิบัติงาน กฎนี้ควรกำหนดแอตทริบิวต์ ที่อ้างอิงถึงไบนารีของผู้ปฏิบัติงาน
หากไบนารีของเวิร์กเกอร์ที่คุณสร้างอยู่ในแพ็กเกจชื่อ "work" ซึ่งอยู่ในระดับบนสุดของบิลด์ คำจำกัดความของแอตทริบิวต์อาจเป็นดังนี้
"worker": attr.label(
default = Label("//work:worker"),
executable = True,
cfg = "exec",
)
cfg = "exec"
บ่งบอกว่าควรสร้างเวิร์กเกอร์ให้ทำงานบนแพลตฟอร์มการดำเนินการของคุณแทนแพลตฟอร์มเป้าหมาย (กล่าวคือ ใช้เวิร์กเกอร์เป็นเครื่องมือระหว่างการบิลด์)
ข้อกำหนดการดําเนินการของงาน
กฎที่ใช้ผู้ปฏิบัติงานจะสร้างการทำงานเพื่อให้ผู้ปฏิบัติงานดำเนินการ การดำเนินการเหล่านี้มีข้อกำหนด 2 ข้อ
ฟิลด์ "arguments" การดำเนินการนี้จะใช้รายการสตริง โดยเหลือแค่อาร์กิวเมนต์สุดท้ายที่เป็นอาร์กิวเมนต์ที่ส่งผ่านไปยังผู้ปฏิบัติงานเมื่อเริ่มต้นใช้งาน องค์ประกอบสุดท้ายในรายการ "arguments" คืออาร์กิวเมนต์
flag-file
(ตามด้วย @) ผู้ปฏิบัติงานจะอ่านอาร์กิวเมนต์จากไฟล์ Flag ที่ระบุตาม WorkRequest แต่ละรายการ กฎของคุณจะเขียนอาร์กิวเมนต์ที่ไม่ใช่การเริ่มต้นสำหรับเวิร์กเกอร์ลงในไฟล์ Flag นี้ได้ฟิลด์ "execution-requirements" ซึ่งใช้พจนานุกรมที่มี
"supports-workers" : "1"
,"supports-multiplex-workers" : "1"
หรือทั้ง 2 อย่างจำเป็นต้องมีฟิลด์ "arguments" และ "execution-requirements" สำหรับการดำเนินการทั้งหมดที่ส่งไปยังผู้ปฏิบัติงาน นอกจากนี้ การดําเนินการที่ควรดำเนินการโดยผู้ทํางาน JSON จะต้องมี
"requires-worker-protocol" : "json"
ในช่องข้อกําหนดการดําเนินการ"requires-worker-protocol" : "proto"
ยังเป็นข้อกำหนดการดำเนินการที่ถูกต้องด้วย แม้ว่าจะไม่จำเป็นสำหรับผู้ปฏิบัติงานประเภท Proto เนื่องจากเป็นค่าเริ่มต้นอยู่แล้วนอกจากนี้ คุณยังตั้งค่า
worker-key-mnemonic
ในข้อกำหนดการดำเนินการได้ด้วย ซึ่งอาจเป็นประโยชน์หากคุณใช้ไฟล์ปฏิบัติการซ้ำสำหรับการดำเนินการหลายประเภท และต้องการแยกแยะการทำงานของผู้ปฏิบัติงานรายนี้ไฟล์ชั่วคราวที่สร้างขึ้นระหว่างการดำเนินการควรบันทึกไว้ในไดเรกทอรีของผู้ปฏิบัติงาน ซึ่งจะเป็นการเปิดใช้แซนด์บ็อกซ์
สมมติว่ามีการกำหนดนิยามกฎที่มีแอตทริบิวต์ "worker" ที่อธิบายไว้ข้างต้น นอกเหนือจากแอตทริบิวต์ "srcs" ที่แทนอินพุต แอตทริบิวต์ "output" ที่แสดงเอาต์พุต และแอตทริบิวต์ "args" ที่แสดงอาร์กิวเมนต์เริ่มต้นของโปรแกรมทำงาน การเรียกไปยัง ctx.actions.run
อาจมีลักษณะดังนี้
ctx.actions.run(
inputs=ctx.files.srcs,
outputs=[ctx.outputs.output],
executable=ctx.executable.worker,
mnemonic="someMnemonic",
execution_requirements={
"supports-workers" : "1",
"requires-worker-protocol" : "json"},
arguments=ctx.attr.args + ["@flagfile"]
)
สำหรับตัวอย่างอีกตัวอย่างหนึ่ง โปรดดูการใช้ผู้ปฏิบัติงานถาวร
ตัวอย่าง
ฐานโค้ด Bazel ใช้ผู้ปฏิบัติงานคอมไพเลอร์ Java นอกเหนือจากตัวอย่างผู้ปฏิบัติงาน JSON ที่ใช้ในการทดสอบการผสานรวม
คุณสามารถใช้โครงข้อแข็งของตัวประกอบนี้เพื่อทำให้เครื่องมือที่ใช้ Java ใช้กับผู้ปฏิบัติงานได้ โดยการส่งผ่านใน Callback ที่ถูกต้อง
ดูตัวอย่างกฎที่ใช้ผู้ปฏิบัติงานได้ที่การทดสอบการผสานรวมผู้ปฏิบัติงานของ Bazel
ผู้มีส่วนร่วมภายนอกได้ติดตั้งใช้งาน WOrkers ในภาษาต่างๆ มากมาย โปรดดูการใช้งาน WOrkers แบบคงที่ของ Bazel ในหลายภาษา คุณสามารถดูตัวอย่างอื่นๆ อีกมากมายใน GitHub