การค้นหากราฟการดำเนินการ (Aquery)

คำสั่ง 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))'

  $ bazel aquery 'mnemonic("Cpp.*", (inputs(".*cpp", inputs("foo.*", //src/target_a))))'

        $ 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 ปกติ จึงรับชุดตัวเลือกที่พร้อมใช้งานระหว่างบิลด์

ตัวเลือกคำค้นหา

--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

ดัมพ์ Action Graph จาก Skyframe โดยไม่ต้องทำการวิเคราะห์เพิ่มเติม

เครื่องมือและฟีเจอร์อื่นๆ

การค้นหาเกี่ยวกับสถานะของ Skyframe

Skyframe คือรูปแบบการประเมินและการเพิ่มประสิทธิภาพของ Bazel Skyframe ในแต่ละอินสแตนซ์ของเซิร์ฟเวอร์ Bazel จะจัดเก็บกราฟทรัพยากร Dependency ที่สร้างขึ้นจากการเรียกใช้ก่อนหน้าของระยะการวิเคราะห์

ในบางกรณี การค้นหากราฟการดำเนินการใน Skyframe จะมีประโยชน์ ตัวอย่าง Use Case มีดังนี้

1. เรียกใช้ bazel build //target_a
2. เรียกใช้ bazel build //target_b
3. สร้างไฟล์ 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")'

การเปรียบเทียบเอาต์พุตคำค้นหา

คุณสามารถเปรียบเทียบเอาต์พุตของการเรียกใช้คำค้นหาที่แตกต่างกัน 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: รูปแบบของไฟล์อินพุต รองรับเอาต์พุต aquery ของ proto และ textproto

--attrs=(cmdline|inputs), default=cmdline: แอตทริบิวต์ของการดำเนินการที่จะเปรียบเทียบ

การแสดงภาพซ้อนภาพ

คุณอาจนำ Aspects มาใช้ควบคู่กันได้ จากนั้น เอาต์พุตคำค้นหาของการดำเนินการที่สร้างโดย Aspect เหล่านี้จะรวม Aspect path ซึ่งเป็นลำดับของ Aspect ที่ใช้กับเป้าหมายที่สร้างการดำเนินการ

ตัวอย่างของการแสดงผลแบบภาพซ้อนภาพ

  t0
  ^
  | <- a1
  t1
  ^
  | <- a2
  t2

ให้ _i เป็นเป้าหมายของกฎ _i ซึ่งจะนำ Aspect a_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 สร้างขึ้นโดยแง่มุม a2 ที่นําไปใช้กับ a1(t0) โดยที่ a1(t0) คือผลลัพธ์ของแง่มุม a1 ที่นําไปใช้กับเป้าหมาย t0

AspectDescriptor แต่ละรายการมีรูปแบบดังนี้

  AspectClass([param=value,...])

AspectClass อาจเป็นชื่อของคลาส Aspect (สำหรับ Aspects แบบดั้งเดิม) หรือ bzl_file%aspect_name (สำหรับ Starlark Aspects) AspectDescriptor จะเรียงตามลําดับเชิงทอพอโลยีของกราฟทรัพยากร Dependency

การลิงก์กับโปรไฟล์ JSON

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

หากต้องการรวมเอาต์พุตของการดำเนินการไว้ในโปรไฟล์ JSON ให้สร้างโปรไฟล์ด้วย --experimental_include_primary_output --noexperimental_slim_json_profile โปรไฟล์แบบบางใช้ร่วมกับเอาต์พุตหลักไม่ได้ ผลลัพธ์หลักของการดำเนินการจะรวมอยู่ใน aquery โดยค่าเริ่มต้น

ขณะนี้เราไม่มีเครื่องมือ Canonical ที่จะรวมแหล่งข้อมูล 2 แหล่งนี้ แต่คุณควรสร้างสคริปต์ของคุณเองด้วยข้อมูลข้างต้นได้

ปัญหาที่ทราบ

การจัดการการดำเนินการที่แชร์

บางครั้งระบบจะแชร์การกระทําระหว่างเป้าหมายที่กําหนดค่าไว้

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

คุณดูรายการปัญหาเกี่ยวกับคำค้นหา/ฟีเจอร์ที่วางแผนไว้ได้ใน GitHub

คำถามที่พบบ่อย

ActionKey ยังคงเหมือนเดิม แม้ว่าเนื้อหาของไฟล์อินพุตจะเปลี่ยนไปก็ตาม

ในบริบทของ aquery 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

อัปเดต

สำหรับปัญหา/คำขอฟีเจอร์ โปรดส่งปัญหาที่นี่