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

Nightly · 9.1 · 9.0 · 8.7 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

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 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 कार्रवाई के लिए, मेनिफ़ेस्ट फ़ाइल का कॉन्टेंट शामिल करें. फ़ाइल का कॉन्टेंट, --output=xxxproto के साथ file_contents फ़ील्ड में दिखता है. --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.

foo.out को बनाने के लिए ज़िम्मेदार कार्रवाई और टारगेट का पता लगाने के लिए, bazel aquery 'outputs("foo.out", //target_a)' और bazel aquery 'outputs("foo.out", //target_b)' को चलाया जा सकता है. हालांकि, पहले बनाए गए अलग-अलग टारगेट की संख्या दो से ज़्यादा हो सकती है. ऐसे में, 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 के आउटपुट की तुलना करना

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

ऊपर दिया गया कमांड, aquery के 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: तुलना की जाने वाली 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 आसपेक्ट a2 से जनरेट हुई है. यह आसपेक्ट a1(t0) पर लागू किया गया है. यहां a1(t0), टारगेट t0 पर लागू किए गए a1 आसपेक्ट का नतीजा है.

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

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

AspectClass , आसपेक्ट क्लास का नाम (नेटिव आसपेक्ट के लिए) या bzl_file%aspect_name (Starlark आसपेक्ट के लिए) हो सकता है. 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 के साथ भ्रमित नहीं करना चाहिए.

अपडेट

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