คำสั่ง aquery
ช่วยให้คุณค้นหาการดำเนินการในกราฟบิลด์ได้
โดยทำงานเกี่ยวกับกราฟเป้าหมายที่กำหนดค่าไว้หลังการวิเคราะห์ และแสดงข้อมูลเกี่ยวกับการดำเนินการ อาร์ติแฟกต์ และความสัมพันธ์
aquery
จะมีประโยชน์เมื่อคุณสนใจพร็อพเพอร์ตี้ของการดำเนินการ/อาร์ติแฟกต์ที่สร้างจากกราฟเป้าหมายที่กำหนดค่าไว้ เช่น จะมีการเรียกใช้คำสั่งจริง
และอินพุต/เอาต์พุต/หน่วยความจำ
เครื่องมือจะยอมรับตัวเลือกบรรทัดคำสั่งหลายรายการ สิ่งที่น่าสังเกตคือคำสั่ง Aquery จะทำงานที่ด้านบนของบิลด์ Bazel ปกติและรับค่าชุดตัวเลือกที่ใช้ได้ระหว่างบิลด์
และรองรับชุดฟังก์ชันเดียวกับที่มีใน query
แบบดั้งเดิมด้วย แต่ siblings
, buildfiles
และ tests
ตัวอย่างเอาต์พุต aquery
(ไม่มีรายละเอียดเฉพาะ)
$ bazel aquery 'deps(//some:label)' action 'Writing file some_file_name' Mnemonic: ... Target: ... Configuration: ... ActionKey: ... Inputs: [...] Outputs: [...]
ไวยากรณ์พื้นฐาน
ตัวอย่างง่ายๆ ของไวยากรณ์สำหรับ aquery
มีดังนี้
bazel aquery "aquery_function(function(//target))"
นิพจน์ข้อความค้นหา (ในเครื่องหมายคำพูด) ประกอบด้วยข้อมูลต่อไปนี้
aquery_function(...)
: ฟังก์ชันเฉพาะสำหรับaquery
โปรดดูรายละเอียดเพิ่มเติมด้านล่างfunction(...)
: ฟังก์ชันมาตรฐาน เป็นquery
แบบดั้งเดิม//target
คือป้ายกำกับของเป้าหมายที่สนใจ
# aquery examples: # Get the action graph generated while building //src/target_a $ bazel aquery '//src/target_a' # Get the action graph generated while building all dependencies of //src/target_a $ bazel aquery 'deps(//src/target_a)' # Get the action graph generated while building all dependencies of //src/target_a # whose inputs filenames match the regex ".*cpp". $ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'
การใช้ฟังก์ชัน Aquery
มีฟังก์ชัน aquery
3 แบบดังนี้
inputs
: กรองการดำเนินการตามอินพุตoutputs
: กรองการดำเนินการตามเอาต์พุตmnemonic
: กรองการดำเนินการตามช่วยจำ
expr ::= inputs(word, expr)
โอเปอเรเตอร์ inputs
จะแสดงผลการดำเนินการที่สร้างจากอาคาร expr
ซึ่งมีชื่อไฟล์ที่ป้อนตรงกับนิพจน์ทั่วไปที่ word
ระบุไว้
$ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'
ฟังก์ชัน outputs
และ mnemonic
ใช้ไวยากรณ์คล้ายกัน
นอกจากนี้ คุณยังรวมฟังก์ชันต่างๆ เข้าด้วยกันเพื่อให้ทำงาน "และ" ได้ เช่น
$ bazel aquery 'mnemonic("Cpp.*", (inputs(".*cpp", inputs("foo.*", //src/target_a))))'
คำสั่งด้านบนจะค้นหาการดำเนินการทั้งหมดที่เกี่ยวข้องกับการสร้าง //src/target_a
ซึ่งการช่วยจำตรงกับ "Cpp.*"
และอินพุตตรงกับรูปแบบ ".*cpp"
และ "foo.*"
ตัวอย่างของข้อผิดพลาดทางไวยากรณ์ที่เกิดขึ้น:
$ bazel aquery 'deps(inputs(".*cpp", //src/target_a))' ERROR: aquery filter functions (inputs, outputs, mnemonic) produce actions, and therefore can't be the input of other function types: deps deps(inputs(".*cpp", //src/target_a))
ตัวเลือก
ตัวเลือกบิลด์
aquery
ทำงานบนบิลด์ Bazel ปกติและด้วยเหตุนี้จึงได้รับชุดตัวเลือกที่ใช้ได้ระหว่างบิลด์
ตัวเลือก Aquery
--output=(text|summary|proto|jsonproto|textproto), default=text
รูปแบบเอาต์พุตเริ่มต้น (text
) คือรูปแบบที่มนุษย์อ่านได้ ให้ใช้ proto
, textproto
หรือ jsonproto
สำหรับรูปแบบที่เครื่องอ่านได้
ข้อความ Proto คือ analysis.ActionGraphContainer
--include_commandline, default=true
รวมเนื้อหาของบรรทัดคำสั่งการดำเนินการในเอาต์พุต (อาจมีขนาดใหญ่)
--include_artifacts, default=true
มีชื่ออินพุตและเอาต์พุตการดำเนินการในเอาต์พุต (อาจมีขนาดใหญ่)
--include_aspects, default=true
รวมการดำเนินการที่ Aspect สร้างขึ้นในเอาต์พุตไหม
--include_param_files, default=false
รวมเนื้อหาของไฟล์พารามิเตอร์ที่ใช้ในคำสั่ง (อาจมีขนาดใหญ่)
--include_file_write_contents, default=false
รวมเนื้อหาไฟล์สำหรับการดำเนินการ actions.write()
และเนื้อหาของไฟล์ Manifest สำหรับการดำเนินการ SourceSymlinkManifest
เนื้อหาไฟล์จะถูกส่งคืนในช่อง file_contents
ด้วย --output=
xxxproto
เมื่อใช้ --output=text
เอาต์พุตจะมี
FileWriteContents: [<base64-encoded file contents>]
บรรทัด
--skyframe_state, default=false
โดยไม่ทำการวิเคราะห์เพิ่มเติม ให้ดัมพ์กราฟการดำเนินการจาก Skyframe
เครื่องมือและฟีเจอร์อื่นๆ
การค้นหาเกี่ยวกับสถานะของ Skyframe
Skyframe คือโมเดลการประเมินและ ส่วนเพิ่มของ Bazel ในแต่ละอินสแตนซ์ของเซิร์ฟเวอร์ Bazel นั้น Skyframe จะจัดเก็บกราฟการอ้างอิงที่สร้างขึ้นจากการเรียกใช้ขั้นตอนการวิเคราะห์ก่อนหน้านี้
ในบางกรณี การค้นหากราฟการดำเนินการใน Skyframe จะเป็นประโยชน์ ตัวอย่างกรณีการใช้งานมีดังนี้
- เรียกใช้
bazel build //target_a
- เรียกใช้
bazel build //target_b
- สร้างไฟล์
foo.out
แล้ว
ในฐานะผู้ใช้ Bazel เราอยากทราบว่า foo.out
สร้างขึ้นจากการสร้าง //target_a
หรือ //target_b
รายการหนึ่งอาจเรียกใช้ bazel aquery 'outputs("foo.out", //target_a)'
และ bazel aquery 'outputs("foo.out", //target_b)'
เพื่อหาการกระทำที่รับผิดชอบในการสร้าง foo.out
และผลที่ได้คือเป้าหมาย อย่างไรก็ตาม จำนวนเป้าหมายต่างๆ ที่สร้างไว้ก่อนหน้านี้อาจมีมากกว่า 2 แบบได้ ซึ่งทำให้การเรียกใช้คำสั่ง aquery
หลายรายการเป็นเรื่องยุ่งยาก
ทั้งนี้ คุณใช้แฟล็ก --skyframe_state
แทนได้ ดังนี้
# List all actions on Skyframe's action graph $ bazel aquery --output=proto --skyframe_state # or # List all actions on Skyframe's action graph, whose output matches "foo.out" $ bazel aquery --output=proto --skyframe_state 'outputs("foo.out")'
เมื่อใช้โหมด --skyframe_state
aquery
จะนำเนื้อหาของกราฟดำเนินการที่ Skyframe จัดเก็บอยู่บนอินสแตนซ์ของ Bazel (ไม่บังคับ) มากรองอินสแตนซ์ดังกล่าวและแสดงผลเนื้อหาโดยไม่ต้องเรียกใช้ขั้นตอนการวิเคราะห์อีกครั้ง
สิ่งที่ควรพิจารณาเป็นพิเศษ
รูปแบบเอาต์พุต
ขณะนี้ --skyframe_state
ใช้ได้กับ --output=proto
และ --output=textproto
เท่านั้น
การไม่รวมป้ายกำกับเป้าหมายในนิพจน์การค้นหา
ปัจจุบัน --skyframe_state
จะค้นหากราฟการดำเนินการทั้งหมดที่มีอยู่ใน Skyframe โดยไม่คำนึงถึงเป้าหมาย การมีป้ายกำกับเป้าหมายที่ระบุในการค้นหาพร้อมกับ --skyframe_state
ถือเป็นข้อผิดพลาดทางไวยากรณ์
# WRONG: Target Included $ bazel aquery --output=proto --skyframe_state **//target_a** ERROR: Error while parsing '//target_a)': Specifying build target(s) [//target_a] with --skyframe_state is currently not supported. # WRONG: Target Included $ bazel aquery --output=proto --skyframe_state 'inputs(".*.java", **//target_a**)' ERROR: Error while parsing '//target_a)': Specifying build target(s) [//target_a] with --skyframe_state is currently not supported. # CORRECT: Without Target $ bazel aquery --output=proto --skyframe_state $ bazel aquery --output=proto --skyframe_state 'inputs(".*.java")'
การเปรียบเทียบเอาต์พุตของ Aquery
คุณสามารถเปรียบเทียบเอาต์พุตของการเรียกใช้คำค้นหาที่แตกต่างกัน 2 รายการโดยใช้เครื่องมือ aquery_differ
เช่น เมื่อคุณเปลี่ยนแปลงคำจำกัดความของกฎและต้องการยืนยันว่าบรรทัดคำสั่งที่ทำงานอยู่นั้นไม่เปลี่ยนแปลง aquery_differ
เป็นเครื่องมือสำหรับทำเรื่องนี้
เครื่องมือนี้พร้อมใช้งานในที่เก็บ bazelbuild/bazel หากต้องการใช้งาน ให้โคลนที่เก็บไปยังเครื่องภายใน ตัวอย่างการใช้งาน:
$ bazel run //tools/aquery_differ -- \ --before=/path/to/before.proto \ --after=/path/to/after.proto \ --input_type=proto \ --attrs=cmdline \ --attrs=inputs
คำสั่งข้างต้นแสดงความแตกต่างระหว่างเอาต์พุต Aquery ของ before
และ after
กล่าวคือ การทำงานใดปรากฏในรูปแบบหนึ่งแต่ไม่แสดง การดำเนินการที่มีบรรทัดคำสั่ง/อินพุตในแต่ละเอาต์พุต aquery ต่างกัน ...) ผลลัพธ์ของการเรียกใช้คำสั่งข้างต้นได้แก่
Aquery output 'after' change contains an action that generates the following outputs that aquery output 'before' change doesn't: ... /list of output files/ ... [cmdline] Difference in the action that generates the following output(s): /path/to/abc.out --- /path/to/before.proto +++ /path/to/after.proto @@ -1,3 +1,3 @@ ... /cmdline diff, in unified diff format/ ...
ตัวเลือกคำสั่ง
--before, --after
: ไฟล์เอาต์พุต aquery ที่จะเปรียบเทียบ
--input_type=(proto|text_proto), default=proto
: รูปแบบของไฟล์อินพุต มีการสนับสนุนสำหรับเอาต์พุตคำค้นหา proto
และ textproto
--attrs=(cmdline|inputs), default=cmdline
: แอตทริบิวต์ของการดำเนินการ
ที่จะเปรียบเทียบ
สัดส่วนภาพ
ระบบสามารถนำองค์ประกอบ มาใช้ซ้อนทับกันได้ เอาต์พุต Aspect ของการดำเนินการที่สร้างโดย Aspect เหล่านี้จะรวมเส้นทางของ Aspect ซึ่งเป็นลำดับของ Aspect ที่ใช้กับเป้าหมายซึ่งสร้างการดำเนินการ
ตัวอย่างของอัตราส่วน
t0 ^ | <- a1 t1 ^ | <- a2 t2
กำหนดให้ฉันเป็นเป้าหมายของกฎ i ซึ่งจะนำ Aspect i ไปใช้กับทรัพยากร Dependency
สมมติว่า a2 สร้างการกระทำ X เมื่อใช้กับเป้าหมาย t0 เอาต์พุตข้อความของ bazel aquery --include_aspects 'deps(//t2)'
สำหรับการดำเนินการ X จะเป็นดังนี้
action ... Mnemonic: ... Target: //my_pkg:t0 Configuration: ... AspectDescriptors: [//my_pkg:rule.bzl%**a2**(foo=...) -> //my_pkg:rule.bzl%**a1**(bar=...)] ...
ซึ่งหมายความว่าการกระทำ X
สร้างขึ้นโดย Aspect a2
ที่ใช้กับ a1(t0)
โดยที่ a1(t0)
คือผลลัพธ์ของการใช้ Aspect a1
กับเป้าหมาย t0
AspectDescriptor
แต่ละรายการจะมีรูปแบบดังต่อไปนี้
AspectClass([param=value,...])
AspectClass
อาจเป็นชื่อของคลาส Aspect (สำหรับมุมมองดั้งเดิม) หรือ bzl_file%aspect_name
(ใน Starlark Aspects) AspectDescriptor
จะจัดเรียงตามลำดับโทโพโลยีของกราฟการอ้างอิง
การลิงก์กับโปรไฟล์ JSON
แม้ว่า Aquery จะให้ข้อมูลเกี่ยวกับการดำเนินการที่เรียกใช้ในบิลด์ (เหตุผลที่เรียกใช้ อินพุต/เอาต์พุต) แต่โปรไฟล์ JSON จะบอกเวลาและระยะเวลาของการดำเนินการให้เราทราบ คุณอาจรวมข้อมูล 2 ชุดนี้ผ่านตัวส่วนร่วมได้ ซึ่งเป็นผลลัพธ์หลักของการดำเนินการ
หากต้องการรวมเอาต์พุตของการดำเนินการในโปรไฟล์ JSON ให้สร้างโปรไฟล์ด้วย --experimental_include_primary_output --noslim_profile
โปรไฟล์แบบสลิมเข้ากันไม่ได้กับการรวมเอาต์พุตหลัก เอาต์พุตหลักของการดำเนินการ
จะรวมอยู่โดยค่าเริ่มต้นตามคำค้นหา
ขณะนี้เราไม่มีเครื่องมือ Canonical ที่จะรวมแหล่งข้อมูล 2 แหล่งนี้เข้าด้วยกัน แต่คุณควรสร้างสคริปต์ของตัวเองด้วยข้อมูลข้างต้นได้
ปัญหาที่ทราบ
การจัดการการดำเนินการที่แชร์
บางครั้งการกระทำจะถูก แชร์ ระหว่างเป้าหมายที่กำหนด
ในระยะดำเนินการ การดำเนินการที่แชร์เหล่านั้นจะถือว่าเป็นรายการเดียวและดำเนินการเพียงครั้งเดียว
อย่างไรก็ตาม Aquery จะทำงานบนกราฟการดำเนินการก่อนดำเนินการและหลังการวิเคราะห์ ดังนั้น Aquery จะทำงานเหมือนการดำเนินการแยกกันซึ่งมีอาร์ติแฟกต์เอาต์พุตมี execPath
เหมือนกัน ด้วยเหตุนี้ อาร์ติแฟกต์ที่เทียบเท่าจึงแสดงซ้ำกัน
ดูรายการปัญหาที่สืบค้น/ฟีเจอร์ที่วางแผนไว้ได้ใน GitHub
คำถามที่พบบ่อย
ActionKey ยังคงเหมือนเดิมแม้ว่าเนื้อหาของไฟล์อินพุตจะมีการเปลี่ยนแปลง
ในบริบทของคำค้นหา ActionKey
หมายถึง String
ที่ได้รับจาก ActionAnalysisMetadata#getKey:
Returns a string encoding all of the significant behaviour of this Action that might affect the output. The general contract of `getKey` is this: if the work to be performed by the execution of this action changes, the key must change. ... Examples of changes that should affect the key are: - Changes to the BUILD file that materially affect the rule which gave rise to this Action. - Changes to the command-line options, environment, or other global configuration resources which affect the behaviour of this kind of Action (other than changes to the names of the input/output files, which are handled externally). - An upgrade to the build tools which changes the program logic of this kind of Action (typically this is achieved by incorporating a UUID into the key, which is changed each time the program logic of this action changes). Note the following exception: for actions that discover inputs, the key must change if any input names change or else action validation may falsely validate.
โดยจะไม่รวมการเปลี่ยนแปลงเนื้อหาของไฟล์อินพุต และไม่สับสนกับ RemoteCacheClient#ActionKey
การอัปเดต
หากมีปัญหา/คำขอฟีเจอร์ โปรดแจ้งปัญหาที่นี่