การสร้างผู้ปฏิบัติงานถาวร

รายงานปัญหา ดูแหล่งที่มา รุ่น Nightly · 7.4 7.3 · 7.2 · 7.1 · 7.0 · 6.5

ผู้ปฏิบัติงานถาวรจะช่วยให้บิลด์ของคุณทำงานได้เร็วขึ้น หากมีการดำเนินการซ้ำๆ ในบิลด์ที่มีต้นทุนเริ่มต้นสูงหรือจะได้ประโยชน์จากการแคชการดำเนินการข้าม คุณอาจต้องใช้งาน Persisted Worker ของคุณเองเพื่อดำเนินการเหล่านี้

เซิร์ฟเวอร์ Bazel จะสื่อสารกับเวิร์กเกอร์โดยใช้ stdin/stdout โดยรองรับการใช้บัฟเฟอร์โปรโตคอลหรือสตริง JSON

การใช้งานผู้ปฏิบัติงานมี 2 ส่วนดังนี้

การสร้างผู้ปฏิบัติงาน

ผู้ปฏิบัติงานถาวรจะต้องปฏิบัติตามข้อกำหนดบางประการดังต่อไปนี้

  • โดยจะอ่าน WorkRequests จาก stdin
  • โดยจะเขียน WorkResponses (และเฉพาะ WorkResponse) ลงใน stdout
  • ยอมรับ Flag --persistent_worker Wrapper ต้องจดจำ--persistent_worker Flag บรรทัดคำสั่งและทำให้ตัวเองคงอยู่เฉพาะในกรณีที่มีการส่ง Flag ดังกล่าว มิเช่นนั้นจะต้องทำการคอมไพล์แบบครั้งเดียวและออก

หากโปรแกรมของคุณเป็นไปตามข้อกำหนดเหล่านี้ ก็สามารถใช้เป็นผู้ปฏิบัติงานถาวรได้

คำขอทำงาน

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 แต่คุณใช้ค่าที่เล็กกว่าหรือมากกว่าได้ด้วยตัวเองสำหรับเอาต์พุตจำนวนต่างๆ

ช่อง 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 ต้องยอมรับช่องที่ไม่รู้จักในข้อความเหล่านี้และใช้ค่าเริ่มต้นของ protobuf สำหรับค่าที่ขาดหายไป เพื่อรักษาพร็อพเพอร์ตี้ความเข้ากันได้ย้อนหลังและไปข้างหน้าแบบเดียวกับ protobuf
  • Bazel จัดเก็บคำขอเป็น Protocolbufs และแปลงเป็น JSON โดยใช้รูปแบบ JSON ของ produf

การยกเลิก

ผู้ปฏิบัติงานเลือกที่จะอนุญาตให้ยกเลิกคำของานก่อนที่จะเสร็จได้ ซึ่งจะมีประโยชน์อย่างยิ่งในการเชื่อมต่อกับการดำเนินการแบบไดนามิก ซึ่งการดำเนินการในเครื่องอาจหยุดชะงักเป็นประจำโดยการดำเนินการจากระยะไกลที่เร็วกว่า หากต้องการอนุญาตการยกเลิก ให้เพิ่ม supports-worker-cancellation: 1 ลงในช่อง execution-requirements (ดูด้านล่าง) และตั้งค่าสถานะ --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" คืออาร์กิวเมนต์ 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

ผู้ร่วมให้ข้อมูลภายนอกได้ติดตั้งใช้งานผู้ปฏิบัติงานโดยใช้ภาษาต่างๆ โปรดดู การใช้ Polyglot ของผู้ปฏิบัติงานถาวรของ Bazel คุณสามารถดูตัวอย่างอื่นๆ อีกมากมายใน GitHub