ऐक्शन ग्राफ़ क्वेरी (क्वेरी)

समस्या की शिकायत करें सोर्स देखें Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

aquery कमांड की मदद से, अपने बिल्ड ग्राफ़ में कार्रवाइयों के लिए क्वेरी की जा सकती है. यह पोस्ट-विश्लेषण के बाद कॉन्फ़िगर किए गए टारगेट ग्राफ़ पर काम करता है. साथ ही, कार्रवाइयों, आर्टफ़ैक्ट, और उनके बीच के संबंधों के बारे में जानकारी देता है.

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_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 फ़ंक्शन का इस्तेमाल करना

तीन 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 का इस्तेमाल करें. प्रोटो मैसेज 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 पर ऐक्शन ग्राफ़ से क्वेरी करना फ़ायदेमंद होता है. इस्तेमाल के उदाहरण के तौर पर, यह मामला लिया जा सकता है:

  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 बनाने के लिए कौनसे ऐक्शन ज़िम्मेदार हैं. इससे टारगेट का भी पता लगाया जा सकता है. हालांकि, पहले बनाए गए अलग-अलग टारगेट की संख्या दो से ज़्यादा हो सकती है. इस वजह से, एक साथ कई 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 के इंस्टेंस पर सेव करता है. इसके बाद, aquery इस कॉन्टेंट को फ़िल्टर करता है और इसे आउटपुट करता है. हालांकि, ऐसा करना ज़रूरी नहीं है. इस प्रोसेस में, विश्लेषण के चरण को फिर से नहीं चलाया जाता.

ध्यान देने वाली खास बातें

आउटपुट फ़ॉर्मैट

फ़िलहाल, --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 इनवोकेशन के आउटपुट की तुलना की जा सकती है. उदाहरण के लिए: जब आपको नियम की परिभाषा में कुछ बदलाव करने हों और आपको यह पुष्टि करनी हो कि कमांड लाइनें नहीं बदली हैं. 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 के आउटपुट के बीच का अंतर दिखाती है: कौनसी कार्रवाइयां एक में मौजूद थीं, लेकिन दूसरे में नहीं, किन कार्रवाइयों में हर aquery आउटपुट में अलग-अलग कमांड लाइन/इनपुट हैं, ...). ऊपर दी गई कमांड को चलाने पर यह नतीजा मिलेगा:

  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: तुलना की जाने वाली aquery आउटपुट फ़ाइलें

--input_type=(proto|text_proto), default=proto: इनपुट फ़ाइलों का फ़ॉर्मैट. यह सुविधा, proto और textproto aquery के आउटपुट के लिए उपलब्ध है.

--attrs=(cmdline|inputs), default=cmdline: तुलना की जाने वाली कार्रवाइयों के एट्रिब्यूट.

आसपेक्ट-ऑन-आसपेक्ट

पहलू को एक-दूसरे के ऊपर लागू किया जा सकता है. इन पहलुओं से जनरेट हुई कार्रवाई का aquery आउटपुट, पहलू का पाथ शामिल करेगा. यह पाथ, टारगेट पर लागू किए गए पहलुओं का क्रम होता है.

आस्पेक्ट-ऑन-आस्पेक्ट का उदाहरण:

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

मान लें कि ti, नियम ri का टारगेट है. यह नियम, अपनी डिपेंडेंसी पर पहलू 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, टारगेट t0 पर लागू किए गए पहलू a1 के नतीजे a1(t0) पर लागू किए गए पहलू a2 से जनरेट हुआ था.a1(t0)

हर AspectDescriptor का फ़ॉर्मैट यह होता है:

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

AspectClass, नेटिव पहलुओं के लिए Aspect क्लास का नाम या Starlark पहलुओं के लिए bzl_file%aspect_name हो सकता है. AspectDescriptor को डिपेंडेंसी ग्राफ़ के टोपोलॉजिकल क्रम में क्रम से लगाया जाता है.

JSON प्रोफ़ाइल से लिंक करना

aquery, किसी बिल्ड में चल रही कार्रवाइयों के बारे में जानकारी देता है. जैसे, उन्हें क्यों चलाया जा रहा है और उनके इनपुट/आउटपुट क्या हैं. वहीं, JSON प्रोफ़ाइल से हमें उनके एक्ज़ीक्यूशन के समय और अवधि के बारे में पता चलता है. इन दोनों तरह की जानकारी को एक साथ मिलाया जा सकता है. इसके लिए, हमें एक सामान्य डिनॉमिनेटर की ज़रूरत होती है: किसी कार्रवाई का मुख्य आउटपुट.

JSON प्रोफ़ाइल में कार्रवाइयों के आउटपुट शामिल करने के लिए, --experimental_include_primary_output --noslim_profile का इस्तेमाल करके प्रोफ़ाइल जनरेट करें. स्लिम प्रोफ़ाइलें, प्राइमरी आउटपुट शामिल करने के साथ काम नहीं करती हैं. किसी कार्रवाई का प्राइमरी आउटपुट, aquery में डिफ़ॉल्ट रूप से शामिल होता है.

फ़िलहाल, हम इन दो डेटा सोर्स को एक साथ इस्तेमाल करने के लिए कोई कैननिकल टूल उपलब्ध नहीं कराते हैं. हालांकि, ऊपर दी गई जानकारी का इस्तेमाल करके, अपनी स्क्रिप्ट बनाई जा सकती है.

ज्ञात समस्याएं

शेयर की गई कार्रवाइयों को मैनेज करना

कभी-कभी कॉन्फ़िगर किए गए टारगेट के बीच, कार्रवाइयाँ शेयर की जाती हैं.

लागू करने के चरण में, शेयर किए गए उन ऐक्शन को सिर्फ़ एक माना जाता है और उन्हें सिर्फ़ एक बार लागू किया जाता है. हालांकि, aquery, प्री-एक्ज़ीक्यूशन और पोस्ट-ऐनलिसिस ऐक्शन ग्राफ़ पर काम करता है. इसलिए, यह इन्हें अलग-अलग कार्रवाइयों के तौर पर देखता है. इनके आउटपुट आर्टफ़ैक्ट में एक जैसा execPath होता है. इस वजह से, एक जैसे आर्टफ़ैक्ट डुप्लीकेट के तौर पर दिखते हैं.

aquery से जुड़ी समस्याओं/प्लान की गई सुविधाओं की सूची, GitHub पर देखी जा सकती है.

अक्सर पूछे जाने वाले सवाल

इनपुट फ़ाइल का कॉन्टेंट बदल जाने के बावजूद, ActionKey में कोई बदलाव नहीं हुआ.

aquery के संदर्भ में, 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 के साथ भ्रमित नहीं किया जाना चाहिए.

अपडेट

अगर आपको कोई समस्या आ रही है या आपको किसी सुविधा के लिए अनुरोध करना है, तो कृपया यहां समस्या की शिकायत करें.