操作图表查询(查询)

您可以使用 aquery 命令在构建图中查询操作。它在分析后的“Configured Target Graph”上运行,并提供有关操作、工件及其关系的信息。

如果您对通过“Configured Target Graph”生成的操作/工件的属性感兴趣,aquery 会非常有用。例如,实际运行的命令及其输入/输出/助记符。

该工具接受多个命令行选项。值得注意的是,aquery 命令在常规 Bazel 构建之上运行,并继承了构建期间可用的一组选项。

它支持的函数集也适用于传统 query,但 siblingsbuildfilestests 除外。

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 函数有三个:

  • inputs:按输入过滤操作。
  • outputs:按输出过滤操作
  • mnemonic:按助记符过滤操作

expr ::= inputs(word, expr)

inputs 运算符会返回构建 expr 时生成的操作,其输入文件名与 word 提供的正则表达式匹配。

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

outputsmnemonic 函数具有相同的语法。

您还可以组合函数来实现 AND 运算。例如:

  $ 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 build 上运行,因此会继承构建期间可用的一组选项

Aquery 选项

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

默认输出格式 (text) 是人类可读的,对于机器可读的格式,请使用 prototextprotojsonproto。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() 操作的文件内容和 SourceSymlinkManifest 操作清单文件的内容。系统会通过 --output=xxxproto 通过 file_contents 字段返回文件内容。使用 --output=text 时,输出包含 FileWriteContents: [<base64-encoded file contents>]

--skyframe_state, default=false

在不执行额外的分析的情况下,从 Skyframe 中转储操作图表。

其他工具和功能

查询 Skyframe 的状态

Skyframe 是 Bazel 的评估和增量模型。在 Bazel 服务器的每个实例上,Skyframe 会存储根据先前的分析阶段运行构造的依赖关系图。

在某些情况下,在 Skyframe 上查询操作图表会很有用。 示例用例如下:

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

比较查询输出

您可以使用 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

上述命令会返回 beforeafter 查询输出之间的差异:哪些操作出现在其中一个查询输出中,哪些操作在每个查询输出中使用不同的命令行/输入...。运行上述命令的结果如下:

  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:要比较的查询输出文件

--input_type=(proto|text_proto), default=proto:输入文件的格式。支持 prototextproto 查询输出。

--attrs=(cmdline|inputs), default=cmdline:要比较的操作的属性。

宽高比

切面可以相互叠加。然后,这些方面生成的操作的查询输出将包含切面路径,这是应用于生成相应操作的目标的一系列方面。

纵横比示例:

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

i 成为规则 ri 的目标,这样可将 Aspect ai 应用于其依赖项。

假设 a2 应用于目标 t0 时生成了操作 X。对于操作 X,bazel aquery --include_aspects 'deps(//t2)' 的文本输出将如下所示:

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

这意味着操作 X 是由应用于 a1(t0) 的方面 a2 生成的,其中 a1(t0) 是应用于目标 t0 的方面 a1 的结果。

每个 AspectDescriptor 都采用以下格式:

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

AspectClass 可以是 Aspect 类的名称(针对原生 Aspects),也可以是 bzl_file%aspect_name(针对 Starlark Aspects)。AspectDescriptor依存关系图的拓扑顺序进行排序。

与 JSON 配置文件相关联

查询会提供有关在构建中运行的操作的信息(运行的原因、其输入/输出),而 JSON 配置文件会告知我们这些操作的执行时间和时长。可以通过一个共性(操作的主要输出)将这两组信息结合起来。

如需将操作的输出包含在 JSON 配置文件中,请使用 --experimental_include_primary_output --noexperimental_slim_json_profile 生成配置文件。精简配置文件与包含主要输出不兼容。默认情况下,查询会包含操作的主要输出。

我们目前不提供将这两个数据源组合在一起的规范工具,但您应该能够使用上述信息构建自己的脚本。

已知问题

处理共享操作

有时,操作会在配置的目标之间共享

在执行阶段,这些共享操作只被视为一次操作,且仅执行一次。不过,查询在执行前、分析后操作图上运行,因此会将这些操作视为具有完全相同的输出工件的 execPath 的单独操作。因此,等效的工件会显示重复。

可在 GitHub 上找到查询问题/计划功能的列表。

常见问题解答

即使输入文件的内容发生更改,ActionKey 也会保持不变。

在查询上下文中,ActionKey 是指从 ActionAnalysisMetadata#getKey 获取的 String

  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 混淆。

更新

如有任何问题/功能请求,请在此处提交问题。