aquery कमांड की मदद से, अपने बिल्ड ग्राफ़ में कार्रवाइयों के लिए क्वेरी की जा सकती है.
यह विश्लेषण के बाद कॉन्फ़िगर किए गए टारगेट ग्राफ़ पर काम करता है और
गतिविधियों, आर्टफ़ैक्ट, और उनके संबंधों के बारे में जानकारी.
aquery तब फ़ायदेमंद होता है, जब आपको कार्रवाइयों/आर्टफ़ैक्ट की प्रॉपर्टी में दिलचस्पी होती है
कॉन्फ़िगर किए गए टारगेट ग्राफ़ से जनरेट किया गया है. उदाहरण के लिए, असल कमांड,
और उनके इनपुट/आउटपुट/यादगार चीज़ों के बारे में बात करेंगे.
यह टूल कई कमांड-लाइन विकल्प स्वीकार करता है. ध्यान देने वाली बात यह है कि aquery निर्देश, सामान्य Basel बिल्ड के ऊपर चलता है और इनहेरिट करता है बिल्ड के दौरान उपलब्ध विकल्पों का सेट होता है.
यह फ़ंक्शन के उन ही सेट के साथ काम करता है जो ट्रेडिशनल
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
क्या आउटपुट में 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 एक आकलन है और बेज़ल का इंंक्रीमेंटलिटी मॉडल. Basel सर्वर के हर इंस्टेंस पर, Skyframe, डिपेंडेंसी ग्राफ़ को स्टोर करता है यह डेटा, विश्लेषण के फ़ेज़ के पिछले चरण से बनाया गया है.
कुछ मामलों में, Skyframe पर ऐक्शन ग्राफ़ के बारे में क्वेरी करना मददगार होता है. इस्तेमाल का एक उदाहरण यह होगा:
- रन
bazel build //target_a - रन
bazel build //target_b foo.outफ़ाइल जनरेट की गई.
Basel के उपयोगकर्ता के तौर पर, मुझे यह पता करना है कि foo.out को बिल्डिंग से जनरेट किया गया है या नहीं
//target_a या //target_b.
एक उपयोगकर्ता bazel aquery 'outputs("foo.out", //target_a)' चला और
bazel aquery 'outputs("foo.out", //target_b)' ज़िम्मेदारी से कार्रवाई का पता लगाने के लिए
foo.out बनाने के लिए और इसके बाद में टारगेट. हालांकि, अलग-अलग
पहले बनाए गए टारगेट की संख्या दो से ज़्यादा हो सकती है. इससे कई 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 (वैकल्पिक रूप से) उस पर फ़िल्टर किया जा सके और
यह विश्लेषण के चरण को फिर से चलाए बिना, कॉन्टेंट का आउटपुट देता है.
ध्यान देने वाली खास बातें
आउटपुट फ़ॉर्मैट
--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: कार्रवाइयों के एट्रिब्यूट
तुलना की जा सकती है.
आसपेक्ट-ऑन-आसपेक्ट
Aspect के लिए ऐसा किया जा सकता है जिन्हें एक-दूसरे के ऊपर लागू किया जाना चाहिए. इस कार्रवाई का क्वेरी आउटपुट फिर इन आसपेक्ट में आसपेक्ट पाथ शामिल हो जाएगा, जो कि कार्रवाई को जनरेट करने वाले टारगेट में लागू किए गए पहलू.
Aspect-on-Aspect का एक उदाहरण:
t0 ^ | <- a1 t1 ^ | <- a2 t2
मान लें कि ti, नियम ri का टारगेट है, जो किसी Aspect ai को लागू करता है तय करती हैं.
मान लें कि टारगेट 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 कार्रवाई को, Aspect a2 को लागू करके जनरेट किया गया
a1(t0), जहां a1(t0) लागू किए गए आसपेक्ट a1 का नतीजा है
टारगेट t0 के लिए.
हर AspectDescriptor का फ़ॉर्मैट ऐसा होता है:
AspectClass([param=value,...])
AspectClass, Aspect क्लास (नेटिव आसपेक्ट के लिए) का नाम हो सकता है या
bzl_file%aspect_name (स्टारलार्क आसपेक्ट के लिए). AspectDescriptor यह हैं
क्रम के हिसाब से क्रम में लगाया जाता है.
डिपेंडेंसी ग्राफ़.
JSON प्रोफ़ाइल से लिंक करना
जब क्वेरी किसी बिल्ड में चल रही कार्रवाइयों के बारे में जानकारी देती है (उन्हें क्यों चलाया जा रहा है, उनके इनपुट/आउटपुट), JSON प्रोफ़ाइल उनके चलने का समय और अवधि बताती है. एक कॉमन डिनॉमिनेटर की मदद से, जानकारी के इन दो सेट को एक साथ मिलाया जा सकता है: ऐक्शन का प्राइमरी आउटपुट.
कार्रवाइयां शामिल करने के लिए JSON प्रोफ़ाइल में आउटपुट देते हैं, तो इनकी मदद से प्रोफ़ाइल जनरेट करें
--experimental_include_primary_output --noexperimental_slim_json_profile.
स्लिम प्रोफ़ाइलें, प्राइमरी आउटपुट के साथ काम नहीं करतीं. किसी कार्रवाई का प्राइमरी आउटपुट
एक क्वेरी के ज़रिए डिफ़ॉल्ट रूप से शामिल होता है.
फ़िलहाल हम इन दो डेटा सोर्स को जोड़ने के लिए कोई कैननिकल टूल नहीं देते हैं, लेकिन आपको यह करना चाहिए ऊपर दी गई जानकारी की मदद से अपनी स्क्रिप्ट बना सकते हैं.
पहले से मालूम समस्याएं
शेयर की गई कार्रवाइयों को मैनेज करना
कभी-कभी कार्रवाइयां ऐसी होती हैं शेयर किए गए कॉन्फ़िगर किया गया है.
एक्ज़ीक्यूशन के चरण में, शेयर की गई ये कार्रवाइयां
इसे सिर्फ़ एक माना जाता है और सिर्फ़ एक बार चलाया जाता है.
हालांकि, a क्वेरी, विश्लेषण से पहले और बाद के ऐक्शन ग्राफ़ पर काम करती है. इसलिए, उसे इन
जैसे कि वे अलग-अलग कार्रवाइयां जिनके आउटपुट आर्टफ़ैक्ट में बिलकुल एक जैसे execPath हों. इस वजह से,
मिलते-जुलते आर्टफ़ैक्ट डुप्लीकेट दिखते हैं.
क्वेरी से जुड़ी समस्याओं/प्लान की गई सुविधाओं की सूची यहां मिल सकती है GitHub.
अक्सर पूछे जाने वाले सवाल
इनपुट फ़ाइल का कॉन्टेंट बदलने पर भी ActionKey में कोई बदलाव नहीं होता.
क्वेरी के हिसाब से, ActionKey का मतलब String से है
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.
इसमें इनपुट फ़ाइलों के कॉन्टेंट में किए जाने वाले बदलाव शामिल नहीं हैं और किसी भी तरह से भ्रम की स्थिति पैदा नहीं की जा सकती RemoteCacheClient#ActionKey.
अपडेट
किसी भी समस्या/सुविधा का अनुरोध करने के लिए, कृपया यहां समस्या दर्ज करें.