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

समस्या की शिकायत करें स्रोत देखें

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 फ़ंक्शन तीन तरह के होते हैं:

  • 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 कार्रवाई के लिए मेनिफ़ेस्ट फ़ाइल का कॉन्टेंट शामिल करें. फ़ाइल का कॉन्टेंट, --output=xxxproto के साथ file_contents फ़ील्ड में दिखाया जाता है. --output=text के साथ, आउटपुट में FileWriteContents: [<base64-encoded file contents>] लाइन होती है

--skyframe_state, default=false

अतिरिक्त विश्लेषण किए बिना, Skyframe से ऐक्शन ग्राफ़ को डंप करें.

दूसरे टूल और सुविधाएं

स्काईफ़्रेम की स्थिति के बारे में क्वेरी करना

Skyframe, Bazel का आकलन और इंक्रीमेंटल मॉडल है. Bazel सर्वर के हर इंस्टेंस पर, Skyframe डिपेंडेंसी ग्राफ़ स्टोर करता है. यह ग्राफ़, विश्लेषण के चरण के पिछले रन से बनाया गया होता है.

कुछ मामलों में, Skyframe पर ऐक्शन ग्राफ़ के बारे में क्वेरी करना मददगार होता है. इस्तेमाल का एक उदाहरण यह होगा:

  1. रन bazel build //target_a
  2. रन bazel build //target_b
  3. फ़ाइल foo.out जनरेट की गई.

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

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

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

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

  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: उन कार्रवाइयों के एट्रिब्यूट जिनकी तुलना की जानी है.

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

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

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

  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=...)]
  ...

इसका मतलब है कि a1(t0) पर लागू किए गए आसपेक्ट a2 से कार्रवाई X जनरेट हुई. यहां a1(t0), टारगेट t0 पर लागू किए गए आसपेक्ट a1 से मिला है.

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

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

AspectClass, आसपेक्ट क्लास का नाम (नेटिव आसपेक्ट के लिए) या bzl_file%aspect_name (स्टारलार्क आसपेक्ट के लिए) हो सकता है. AspectDescriptor को डिपेंडेंसी ग्राफ़ के टॉप के हिसाब से क्रम में लगाया गया है.

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

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

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

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

आम तौर पर होने वाली समस्याएं

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

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

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

अपडेट देखें

किसी भी समस्या/सुविधा का अनुरोध करने के लिए, कृपया यहां समस्या दर्ज करें.