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 建構作業上執行,因此沿用建構期間可用的選項組合。
查詢選項
--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()
動作加入檔案內容,以及 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
:要比較的動作屬性。
長寬比
切面可以相互套用。這些 Aspects 產生的動作查詢輸出會包含「Aspect path」,也就是產生動作的目標所套用的切面序列。
Aspect-on-Aspect 範例:
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)
的 Aspect a2
產生,其中 a1(t0)
是對目標 t0
套用 Aspect a1
的結果。
每個 AspectDescriptor
都有以下格式:
AspectClass([param=value,...])
AspectClass
可以是 Aspect 類別的名稱 (適用於原生切面) 或 bzl_file%aspect_name
(適用於 Starlark 切面)。AspectDescriptor
是按照依附元件圖表的頂端順序排序。
連結 JSON 設定檔
查詢可以提供有關建構中執行動作的資訊 (包括執行的原因、輸入/輸出內容),但 JSON 設定檔會提供執行作業的時間和持續時間。您可以透過動作的主要輸出,來結合這 2 組資訊。
如要在 JSON 設定檔中加入動作的輸出內容,請使用 --experimental_include_primary_output --noexperimental_slim_json_profile
產生設定檔。精簡設定檔與主要輸出內容不相容。查詢預設會納入動作的主要輸出內容
我們目前沒有結合這 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 混淆。
更新
如有任何問題/功能要求,請透過這個頁面回報問題。