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

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

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

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

यह टूल कई कमांड-लाइन विकल्प स्वीकार करता है. खास तौर पर, क्वेरी कमांड सामान्य बेज़ल बिल्ड के ऊपर काम करती है और बिल्ड के दौरान उपलब्ध विकल्पों के सेट को इनहेरिट करती है.

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

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

--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

क्या आउटपुट में Aspect से जनरेट की गई कार्रवाइयों को शामिल करना है.

--include_param_files, default=false

कमांड में इस्तेमाल की गई पैरामीटर फ़ाइलों का कॉन्टेंट शामिल करें (यह बड़ी हो सकती है).

चेतावनी: इस फ़्लैग को चालू करने से --include_commandline फ़्लैग अपने-आप चालू हो जाएगा.

--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_state के साथ टारगेट तय करने की सुविधा उपलब्ध नहीं है. यह फ़्लैग सिर्फ़ --output=proto या --output=textproto के साथ उपलब्ध है.

अन्य टूल और सुविधाएं

SkyFrame की स्थिति के हिसाब से क्वेरी करना

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

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

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

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

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

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

फ़िलहाल, --skyframe_state सिर्फ़ --output=proto और --output=textproto के लिए उपलब्ध है

क्वेरी एक्सप्रेशन में टारगेट लेबल को शामिल न करना

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

यह टूल, baazbuild/baकोई डेटा स्टोर करने की जगह में उपलब्ध है. इसका इस्तेमाल करने के लिए, रिपॉज़िटरी (डेटा स्टोर करने की जगह) को अपने कंप्यूटर पर क्लोन करें. इस्तेमाल का एक उदाहरण:

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

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

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

Aspect-on-Aspect का एक उदाहरण:

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

मान लें कि t_i, नियम r_i का टारगेट है, जो किसी Aspect a_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=...)]
  ...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

इनपुट फ़ाइल का कॉन्टेंट बदलने पर भी ActionKey में कोई बदलाव नहीं होता.

क्वेरी के कॉन्टेक्स्ट में, 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.

इसमें इनपुट फ़ाइलों के कॉन्टेंट में किए जाने वाले बदलाव शामिल नहीं हैं. साथ ही, पाए जाने के लिए रिमोटकैश क्लाइंट#ActionKey जैसे किसी दूसरे तरीके का इस्तेमाल करें.

अपडेट

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