Trang này được dịch bởi Cloud Translation API.

Truy vấn biểu đồ hành động (truy vấn)

Lệnh aquery cho phép bạn truy vấn các hành động trong biểu đồ bản dựng. Tính năng này hoạt động trên Biểu đồ mục tiêu đã định cấu hình sau khi phân tích và hiển thị thông tin về Hành động, Cấu phần phần mềm và mối quan hệ của chúng.

aquery rất hữu ích khi bạn quan tâm đến các thuộc tính của Hành động/Cấu phần phần mềm được tạo từ Biểu đồ mục tiêu đã định cấu hình. Ví dụ: các lệnh thực tế chạy và dữ liệu đầu vào/đầu ra/ký tự ghi nhớ của các lệnh đó.

Công cụ này chấp nhận một số tuỳ chọn dòng lệnh. Đáng chú ý là lệnh aquery chạy trên một bản dựng Bazel thông thường và kế thừa tập hợp tuỳ chọn có sẵn trong bản dựng.

Phiên bản này hỗ trợ cùng một tập hợp hàm có sẵn cho query truyền thống nhưng siblings, buildfiles và tests.

Ví dụ về kết quả đầu ra aquery (không có thông tin chi tiết cụ thể):

$ bazel aquery 'deps(//some:label)'
action 'Writing file some_file_name'
  Mnemonic: ...
  Target: ...
  Configuration: ...
  ActionKey: ...
  Inputs: [...]
  Outputs: [...]

Cú pháp cơ bản

Dưới đây là một ví dụ đơn giản về cú pháp cho aquery:

bazel aquery "aquery_function(function(//target))"

Biểu thức truy vấn (trong dấu ngoặc kép) bao gồm:

aquery_function(...): các hàm dành riêng cho aquery. Tìm hiểu thêm bên dưới.
function(...): các hàm chuẩn như query truyền thống.
//target là nhãn cho mục tiêu quan tâm.

# 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))'

Sử dụng hàm truy vấn

Có 3 hàm aquery:

inputs: lọc hành động theo dữ liệu đầu vào.
outputs: lọc các hành động theo kết quả đầu ra
mnemonic: lọc hành động theo kỷ niệm

expr ::= inputs(word, expr)

Toán tử inputs trả về các thao tác được tạo từ việc tạo expr có tên tệp đầu vào khớp với biểu thức chính quy do word cung cấp.

$ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'

Các hàm outputs và mnemonic có cú pháp tương tự.

Bạn cũng có thể kết hợp các hàm để có được phép toán AND. Ví dụ:

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

Lệnh trên sẽ tìm tất cả hành động liên quan đến việc tạo //src/target_a có phần ghi nhớ khớp với "Cpp.*" và dữ liệu đầu vào khớp với mẫu ".*cpp" và "foo.*".

Ví dụ về lỗi cú pháp được tạo:

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

Tùy chọn

Tuỳ chọn xây dựng

aquery chạy trên một bản dựng Bazel thông thường và do đó kế thừa tập hợp tuỳ chọn có sẵn trong bản dựng.

Tùy chọn truy vấn

`--output=(text|summary|proto|jsonproto|textproto), default=text`

Định dạng đầu ra mặc định (text) là định dạng mà con người có thể đọc được, hãy dùng proto, textproto hoặc jsonproto cho định dạng mà máy có thể đọc được. Thông điệp proto là analysis.ActionGraphContainer.

`--include_commandline, default=true`

Bao gồm nội dung của các dòng lệnh hành động trong dữ liệu đầu ra (có thể lớn).

`--include_artifacts, default=true`

Bao gồm tên của các đầu vào và đầu ra của hành động trong dữ liệu đầu ra (có thể lớn).

`--include_aspects, default=true`

Liệu có đưa hành động do Khung hình tạo vào kết quả hay không.

`--include_param_files, default=false`

Bao gồm nội dung của các tệp tham số được dùng trong lệnh (có thể lớn).

`--include_file_write_contents, default=false`

Bao gồm nội dung tệp cho thao tác actions.write() và nội dung của tệp kê khai cho thao tác SourceSymlinkManifest. Nội dung tệp được trả về trong trường file_contents với --output=xxxproto. Với --output=text, dữ liệu đầu ra có dòng FileWriteContents: [<base64-encoded file contents>]

`--skyframe_state, default=false`

Nếu không thực hiện phân tích bổ sung, hãy kết xuất Biểu đồ hành động từ Skyframe.

Các công cụ và tính năng khác

Truy vấn dựa trên trạng thái của Skyframe

Skyframe là mô hình đánh giá và gia tăng của Bazel. Trên mỗi thực thể của máy chủ Bazel, Skyframe lưu trữ biểu đồ phần phụ thuộc được tạo từ các lần chạy trước trong giai đoạn Phân tích.

Trong một số trường hợp, bạn nên truy vấn Biểu đồ hành động trên Skyframe. Ví dụ về một trường hợp sử dụng:

Chạy bazel build //target_a
Chạy bazel build //target_b
Tệp foo.out đã được tạo.

Là người dùng Bazel, tôi muốn xác định xem foo.out được tạo từ việc tạo //target_a hay //target_b.

Người dùng có thể chạy bazel aquery 'outputs("foo.out", //target_a)' và bazel aquery 'outputs("foo.out", //target_b)' để tìm ra hành động tạo ra foo.out và mục tiêu theo đó. Tuy nhiên, số lượng mục tiêu khác nhau được tạo trước đó có thể lớn hơn 2, điều này khiến việc chạy nhiều lệnh aquery trở nên khó khăn.

Thay vào đó, bạn có thể sử dụng cờ --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")'

Với chế độ --skyframe_state, aquery sẽ lấy nội dung của Biểu đồ hành động mà Skyframe lưu giữ trên thực thể của Bazel, (không bắt buộc) thực hiện lọc trên đó và xuất nội dung mà không cần chạy lại giai đoạn phân tích.

Các điểm cần cân nhắc đặc biệt

Định dạng đầu ra

--skyframe_state hiện chỉ có sẵn cho --output=proto và --output=textproto

Không bao gồm các nhãn mục tiêu trong biểu thức truy vấn

Hiện tại, --skyframe_state truy vấn toàn bộ biểu đồ hành động tồn tại trên Skyframe, bất kể mục tiêu nào. Việc chỉ định nhãn mục tiêu trong truy vấn cùng với --skyframe_state bị coi là lỗi cú pháp:

  # 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")'

So sánh kết quả của một truy vấn

Bạn có thể so sánh kết quả của hai lệnh gọi một truy vấn khác nhau bằng công cụ aquery_differ. Ví dụ: khi bạn thực hiện một số thay đổi đối với định nghĩa quy tắc và muốn xác minh rằng các dòng lệnh đang chạy không thay đổi. aquery_differ chính là công cụ để làm việc đó.

Công cụ này có trong kho lưu trữ bazelbuild/bazel. Để dùng thư viện này, hãy sao chép kho lưu trữ vào máy cục bộ. Ví dụ về cách sử dụng:

  $ bazel run //tools/aquery_differ -- \
  --before=/path/to/before.proto \
  --after=/path/to/after.proto \
  --input_type=proto \
  --attrs=cmdline \
  --attrs=inputs

Lệnh trên trả về sự khác biệt giữa các kết quả truy vấn before và after: hành động nào đã có trong một nhưng không có trong hành động kia, hành động nào có dòng lệnh/đầu vào khác nhau trong mỗi đầu ra truy vấn, ...). Kết quả của việc chạy lệnh trên sẽ là:

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

Tuỳ chọn lệnh

--before, --after: Các tệp đầu ra của truy vấn sẽ được so sánh

--input_type=(proto|text_proto), default=proto: định dạng của các tệp đầu vào. Hỗ trợ được cung cấp cho đầu ra truy vấn proto và textproto.

--attrs=(cmdline|inputs), default=cmdline: các thuộc tính của các hành động cần so sánh.

Góc nhìn

Bạn có thể áp dụng Các khía cạnh chồng lên nhau. Sau đó, kết quả truy vấn của hành động do các khía cạnh này tạo ra sẽ bao gồm Đường dẫn khung hình, là trình tự của các khía cạnh được áp dụng cho mục tiêu đã tạo ra hành động.

Ví dụ về Khung hình:

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

Giả sử t_i là mục tiêu của quy tắc r_i, quy tắc này sẽ áp dụng Khung hình a_i cho các phần phụ thuộc.

Giả sử a2 tạo ra một hành động X khi áp dụng cho mục tiêu t0. Đầu ra văn bản của bazel aquery --include_aspects 'deps(//t2)' cho hành động X sẽ là:

  action ...
  Mnemonic: ...
  Target: //my_pkg:t0
  Configuration: ...
  AspectDescriptors: [//my_pkg:rule.bzl%**a2**(foo=...)
    -> //my_pkg:rule.bzl%**a1**(bar=...)]
  ...

Điều này có nghĩa là hành động X được tạo bởi Khung hình a2 và được áp dụng cho a1(t0), trong đó a1(t0) là kết quả của Khung hình a1 được áp dụng cho mục tiêu t0.

Mỗi AspectDescriptor có định dạng sau:

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

AspectClass có thể là tên của lớp Aspects (đối với các Khung hình gốc) hoặc bzl_file%aspect_name (đối với các Khung hình Starlark). AspectDescriptor được sắp xếp theo thứ tự tô pô của biểu đồ phần phụ thuộc.

Liên kết với hồ sơ JSON

Mặc dù truy vấn cung cấp thông tin về các hành động đang được chạy trong bản dựng (lý do chúng đang được chạy, dữ liệu đầu vào/đầu ra của các hành động đó), nhưng hồ sơ JSON cho chúng ta biết thời gian và thời lượng thực thi của các hành động đó. Có thể kết hợp 2 tập thông tin này qua một mẫu số chung: đầu ra chính của một hành động.

Để đưa kết quả của các hành động vào hồ sơ JSON, hãy tạo hồ sơ bằng --experimental_include_primary_output --noexperimental_slim_json_profile. Hồ sơ mỏng không tương thích với việc thêm dữ liệu đầu ra chính. Theo mặc định, đầu ra chính của một hành động sẽ được một truy vấn đưa vào.

Chúng tôi hiện chưa cung cấp công cụ chuẩn hoá để kết hợp 2 nguồn dữ liệu này, nhưng bạn có thể xây dựng tập lệnh của riêng mình bằng thông tin trên.

Vấn đề đã biết

Xử lý các thao tác được chia sẻ

Đôi khi, các hành động được dùng chung giữa các mục tiêu đã định cấu hình.

Trong giai đoạn thực thi, các hành động dùng chung đó chỉ được coi là một và chỉ được thực thi một lần. Tuy nhiên, truy vấn hoạt động trên biểu đồ hành động trước khi thực thi và sau phân tích và do đó xử lý các hành động này như các hành động riêng biệt có Cấu phần phần mềm đầu ra có cùng execPath. Do đó, các Cấu phần phần mềm tương đương sẽ bị trùng lặp.

Bạn có thể xem danh sách các vấn đề truy vấn/tính năng theo kế hoạch trên GitHub.

Câu hỏi thường gặp

ActionKey vẫn giữ nguyên mặc dù nội dung của tệp đầu vào thay đổi.

Trong ngữ cảnh của một truy vấn, ActionKey đề cập đến String nhận được từ 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.

Điều này không bao gồm các thay đổi đối với nội dung của tệp đầu vào và bạn không nên nhầm lẫn với RemoteCacheClient#ActionKey.

Các bản cập nhật

Đối với mọi vấn đề/yêu cầu về tính năng, vui lòng báo cáo vấn đề tại đây.