aquery कमांड की मदद से, अपने बिल्ड ग्राफ़ में कार्रवाइयां के लिए क्वेरी की जा सकती है.
यह, विश्लेषण के बाद कॉन्फ़िगर किए गए टारगेट ग्राफ़ पर काम करता है और कार्रवाइयां, आर्टफ़ैक्ट और उनके संबंधों के बारे में जानकारी देता है.
aquery तब कॉन्फ़िगर किया जाता है, जब आपको कॉन्फ़िगर किए गए टारगेट ग्राफ़ से जनरेट हुई कार्रवाइयों/आर्टफ़ैक्ट की प्रॉपर्टी में दिलचस्पी हो. उदाहरण के लिए, असल कमांड
और उनके इनपुट/आउटपुट/mnemonics.
यह टूल कई कमांड लाइन विकल्प स्वीकार करता है. खास तौर पर, क्वेरी कमांड एक सामान्य बेज़ल बिल्ड पर चलता है और बिल्ड के दौरान कई विकल्पों को इनहेरिट करता है.
यह फ़ंक्शन के उन ही सेट के साथ काम करता है जो परंपरागत
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))'
क्वेरी फ़ंक्शन का इस्तेमाल करना
तीन 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, सामान्य बेज़ल बिल्ड पर चलता है. इसलिए, यह बिल्ड के दौरान मौजूद विकल्प
के सेट को इनहेरिट करता है.
क्वेरी के विकल्प
--output=(text|summary|proto|jsonproto|textproto), default=text
डिफ़ॉल्ट आउटपुट फ़ॉर्मैट (text) जिसे आसानी से पढ़ा जा सकता हो,
मशीन से पढ़े जा सकने वाले फ़ॉर्मैट के लिए proto, textproto या jsonproto का इस्तेमाल करें.
प्रोटो मैसेज 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 कार्रवाई के लिए
मेनिफ़ेस्ट फ़ाइल का कॉन्टेंट शामिल करें. फ़ाइल का कॉन्टेंट
--output=xxxproto के साथ, file_contents फ़ील्ड में दिखाया जाता है.
--output=text के साथ, आउटपुट में
FileWriteContents: [<base64-encoded file contents>]
लाइन मौजूद है
--skyframe_state, default=false
अलग से विश्लेषण किए बिना, कार्रवाई ग्राफ़ को Skyframe से निकालें.
अन्य टूल और सुविधाएं
Skyframe की स्थिति के बारे में क्वेरी की जा रही है
Skyframe, बैजल का इवैलुएशन और इंक्रीमेंटल मॉडल है. Bazel सर्वर के हर इंस्टेंस में, Skyframe, विश्लेषण के फ़ेज़ के पिछले रन से बनाए गए डिपेंडेंसी ग्राफ़ को स्टोर करता है.
कुछ मामलों में, Skyframe पर कार्रवाई के ग्राफ़ की क्वेरी करने से मदद मिलती है: इस्तेमाल का एक उदाहरण यह होगा:
- रन
bazel build //target_a - रन
bazel build //target_b - फ़ाइल
foo.outजनरेट की गई.
बेज़ल उपयोगकर्ता के तौर पर, मैं तय करना चाहता हूं कि 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 कार्रवाई ग्राफ़ का वह कॉन्टेंट इकट्ठा करता है जो स्काईफ़्रेम ने 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
ti को नियम ii का टारगेट बनने दें, जो किसी डिपेंडेंसी 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, आसपेक्ट रेशियो क्लास (नेटिव आसपेक्ट के लिए) या bzl_file%aspect_name (स्टारलार्क आसपेक्ट के लिए) का नाम हो सकता है. AspectDescriptor को
निर्भरता ग्राफ़ के क्रम से लगाया जाता है.
JSON प्रोफ़ाइल से लिंक करना
क्वेरी से, बिल्ड में चल रही कार्रवाइयों (वे क्यों चल रही हैं, उनके इनपुट/आउटपुट) के बारे में जानकारी मिलती है, लेकिन JSON प्रोफ़ाइल से हमें उन्हें लागू किए जाने का समय और अवधि पता चलती है. एक कॉमन डिनॉमिनेटर के ज़रिए, जानकारी के इन दो सेट को जोड़ा जा सकता है: किसी कार्रवाई का मुख्य आउटपुट.
JSON प्रोफ़ाइल में कार्रवाइयों के आउटपुट शामिल करने के लिए, --experimental_include_primary_output --noexperimental_slim_json_profile की मदद से प्रोफ़ाइल जनरेट करें.
स्लिम प्रोफ़ाइल प्राथमिक आउटपुट के शामिल होने से असंगत हैं. क्वेरी का मुख्य आउटपुट डिफ़ॉल्ट रूप से
शामिल होता है.
फ़िलहाल, हम इन दो डेटा सोर्स को मिलाने के लिए एक कैननिकल टूल नहीं देते. हालांकि, ऊपर दी गई जानकारी के साथ आपको अपनी स्क्रिप्ट खुद बनानी होगी.
ऐसी समस्याएं जिनकी पहले से जानकारी है
शेयर की गई कार्रवाइयों को मैनेज करना
कभी-कभी कॉन्फ़िगर किए गए टारगेट के बीच कार्रवाइयां शेयर की जाती हैं.
एक्ज़ीक्यूशन के चरण में, उन शेयर की गई कार्रवाइयों को आम तौर पर एक कार्रवाई माना जाता है और उन्हें सिर्फ़ एक बार लागू किया जाता है.
हालांकि, क्वेरी लागू करने से पहले की कार्रवाई और विश्लेषण के बाद के कार्रवाई ग्राफ़ पर काम करती है. इसलिए, क्वेरी इन्हें
अलग-अलग कार्रवाइयों की तरह ही इस्तेमाल करती है. इनके नतीजे, आर्टफ़ैक्ट के execPath से मिलते-जुलते होते हैं. इस वजह से, मिलते-जुलते आर्टफ़ैक्ट डुप्लीकेट दिखते हैं.
क्वेरी की समस्याओं/प्लान की गई सुविधाओं की सूची GitHub पर देखी जा सकती है.
अक्सर पूछे जाने वाले सवाल
कार्रवाई कुंजी वही रहती है, भले ही किसी इनपुट फ़ाइल की सामग्री बदल गई हो.
क्वेरी के संदर्भ में ActionKey का मतलब है, ActionAnalysisमेटाडेटा#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 से जुड़ी सेटिंग में बदलाव नहीं किया जा सकता.
अपडेट
किसी भी समस्या/सुविधा के लिए, कृपया यहां शिकायत दर्ज करें.