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

किसी समस्या की शिकायत करें सोर्स देखें Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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(...): स्टैंडर्ड functions को 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 बिल्ड के ऊपर चलता है. इसलिए, यह बिल्ड के दौरान उपलब्ध विकल्पों का सेट इनहेरिट करता है.

क्वेरी के विकल्प

--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, Bazel सर्वर के हर इंस्टेंस पर, विश्लेषण के चरण के पिछले रन से बनाए गए डिपेंडेंसी ग्राफ़ को सेव करता है.

कुछ मामलों में, 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

ऊपर दिया गया कमांड, 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 लागू करता है.

मान लें कि 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, नेटिव ऐस्पेक्ट के लिए ऐस्पेक्ट क्लास का नाम या Starlark ऐस्पेक्ट के लिए bzl_file%aspect_name हो सकता है. AspectDescriptor को डिपेंडेंसी ग्राफ़ के टॉपोलॉजिकल क्रम में लगाया जाता है.

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

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

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

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

पहले से मालूम समस्याएं

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

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

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

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

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

इनपुट फ़ाइल का कॉन्टेंट बदलने पर भी, ActionKey एक जैसा ही रहता है.

aquery के संदर्भ में, ActionKey का मतलब ActionAnalysisMetadata#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 के साथ नहीं जोड़ा जाना चाहिए.

अपडेट

अगर आपको कोई समस्या है या आपको कोई सुविधा चाहिए, तो कृपया यहां समस्या दर्ज करें.