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

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

• 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 से.

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

  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

मान लें कि t_i को नियम r_i का टारगेट बनाया गया है, जो किसी खास पहलू _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 --noexperimental_slim_json_profile का इस्तेमाल करके प्रोफ़ाइल जनरेट करें. छोटी प्रोफ़ाइलों को मुख्य आउटपुट के साथ शामिल नहीं किया जा सकता. किसी कार्रवाई का मुख्य आउटपुट Aquery में डिफ़ॉल्ट रूप से शामिल होता है.

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

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

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

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

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

अपडेट देखें

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