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 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))'
outputs
和 mnemonic
函式有類似的語法。
您也可以合併函式來達成 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 建構作業上執行,因此會繼承建構期間可用的一組選項。
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
是否在輸出中加入長寬比產生的動作。
--include_param_files, default=false
包含指令中使用的參數檔案內容 (可能很大)。
--include_file_write_contents, default=false
納入 actions.write()
動作的檔案內容,以及 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_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
上述指令會傳回查詢輸出 before
和 after
之間的差異:哪些動作出現於其中一個,而不同,每項查詢輸出內容中的指令列/輸入內容都不同。執行上述指令的結果為:
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
:輸入檔案的格式。支援 proto
和 textproto
查詢輸出。
--attrs=(cmdline|inputs), default=cmdline
:要比較的動作屬性。
長寬比
您可以為彼此套用切面。這些切面所產生動作的查詢輸出會含有切面路徑,這是對產生動作的目標套用的一序列。
長寬比範例:
t0 ^ | <- a1 t1 ^ | <- a2 t2
讓「i」成為規則 ri 的目標,可為依附元件套用切面 i。
假設在套用至目標 t0 時,a2 會產生動作 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 類別的名稱 (適用於原生切面) 或 bzl_file%aspect_name
(適用於 Starlark Aspects)。AspectDescriptor
會依依附元件圖表的按邏輯順序排序。
連結 JSON 設定檔
雖然查詢可以提供在建構作業中執行的動作 (執行原因、輸入內容/輸出內容) 的相關資訊,但 JSON 設定檔可以向我們提供執行時間和執行時間。您可以透過共同分母來結合這兩組資訊,也就是動作的主要輸出。
如要在 JSON 設定檔中加入動作的輸出內容,請使用 --experimental_include_primary_output --noslim_profile
產生設定檔。Slim 設定檔與納入主要輸出內容不相容。根據預設,查詢會納入動作的主要輸出。
我們目前並未提供合併這 2 個資料來源的標準工具,但您應該可以使用上述資訊自行建構指令碼。
已知問題
處理共用動作
有時動作會在設定的目標之間共用。
在執行階段,這些共用動作只會視為一個,且僅執行一次。不過,查詢是在執行前、分析後動作圖上運作,因此會將這些作業視為輸出 Artifact 具有相同 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 混淆。
更新
如有任何問題/功能要求,請在這裡回報問題。