तारीख सेव करें: BazelCon 2023, 24 से 25 अक्टूबर तक Google म्यूनिख में होगा! ज़्यादा जानें

परफ़ॉर्मेंस को ऑप्टिमाइज़ करना

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

नियम लिखते समय, परफ़ॉर्मेंस से जुड़ी सबसे आम गलतियों में डिपेंडेंसी से इकट्ठा किया गया डेटा, स्कैन या कॉपी होता है. पूरी इमारत में इकट्ठा करने पर, ये कार्रवाइयां आसानी से O(N^2) समय या जगह ले सकती हैं. इससे बचने के लिए, यह समझना ज़रूरी है कि डिपेक्ट का इस्तेमाल कैसे किया जाए.

इसे सही तरीके से तय करना मुश्किल हो सकता है, इसलिए बेज़ल एक ऐसी मेमोरी प्रोफ़ाइलर भी उपलब्ध कराते हैं जो आपको उन जगहों को ढूंढने में मदद करती है जहां आपने कोई गलती की हो. सावधान रहें: बेअसर नियम लिखने की लागत तब तक साफ़ तौर पर नहीं बताई जा सकती, जब तक कि उसका इस्तेमाल बड़े पैमाने पर नहीं किया जाता.

डेस्कटॉप का इस्तेमाल करें

किसी भी नियम पर निर्भरता से जानकारी को रोल अप करते समय, आपको Depset का इस्तेमाल करना चाहिए. मौजूदा नियम से स्थानीय जानकारी को पब्लिश करने के लिए, सिर्फ़ सामान्य सूचियों या लिखवातों का इस्तेमाल करें.

डिसेट, जानकारी को नेस्ट किए गए ग्राफ़ के रूप में दिखाता है, जिससे डेटा शेयर करने की सुविधा चालू होती है.

नीचे दिए गए ग्राफ़ पर विचार करें:

C -> B -> A
D ---^

हर नोड एक स्ट्रिंग को प्रकाशित करता है. गिरावट के साथ डेटा कुछ ऐसा दिखता है:

a = depset(direct=['a'])
b = depset(direct=['b'], transitive=[a])
c = depset(direct=['c'], transitive=[b])
d = depset(direct=['d'], transitive=[b])

ध्यान दें कि हर आइटम का उल्लेख सिर्फ़ एक बार किया जाता है. सूचियों के साथ आपको यह जानकारी मिलेगी:

a = ['a']
b = ['b', 'a']
c = ['c', 'b', 'a']
d = ['d', 'b', 'a']

ध्यान दें कि इस मामले में 'a' का उल्लेख चार बार किया गया है! बड़े ग्राफ़ के साथ होने पर यह समस्या और भी खराब हो जाएगी.

यहां एक ऐसे नियम को लागू करने का उदाहरण दिया गया है जो ट्रांज़िटिव जानकारी को प्रकाशित करने के लिए, सही तरीके से डिपेक्ट का इस्तेमाल करता है. ध्यान दें कि अगर आप नहीं चाहते, तो सूचियों का इस्तेमाल करके नियम-स्थानीय जानकारी प्रकाशित करना ठीक है क्योंकि यह O(N^2) नहीं है.

MyProvider = provider()

def _impl(ctx):
  my_things = ctx.attr.things
  all_things = depset(
      direct=my_things,
      transitive=[dep[MyProvider].all_things for dep in ctx.attr.deps]
  )
  ...
  return [MyProvider(
    my_things=my_things,  # OK, a flat list of rule-local things only
    all_things=all_things,  # OK, a depset containing dependencies
  )]

ज़्यादा जानकारी के लिए, डेप्सेट की खास जानकारी वाला पेज देखें.

depset.to_list() को कॉल करने से बचें

आप to_list() का इस्तेमाल करके डिसेट को फ़्लैट सूची में डाल सकते हैं, लेकिन ऐसा करने से आम तौर पर O(N^2) लागत आती है. अगर हो सके, तो डीबग करने के मकसद को छोड़कर, छोड़ देने के किसी भी फ़्लैट से बचें.

एक सामान्य गलतफ़हमी यह है कि अगर आप ऐसा सिर्फ़ <xx>_binary-लेवल के टारगेट जैसे किसी टॉप-लेवल के टारगेट पर करते हैं, तो डिप्रेशन को कम कर सकते हैं. ऐसा इसलिए, क्योंकि बिल्ड ग्राफ़ के हर लेवल पर लागत जमा नहीं होती. लेकिन यह अब भी O(N^2) है जब आप ओवरलैप करने वाली डिपेंडेंसी के साथ टारगेट का सेट बनाते हैं. ऐसा, //foo/tests/... टेस्ट बनाते समय या आईडीई प्रोजेक्ट को इंपोर्ट करते समय होता है.

कॉल की संख्या depset तक कम करें

किसी लूप में depset को कॉल करना अक्सर गलती से हो जाता है. इसकी वजह से, डिप नेस्टिंग हो सकती है, जिसकी वजह से खराब परफ़ॉर्म होता है. उदाहरण के लिए:

x = depset()
for i in inputs:
    # Do not do that.
    x = depset(transitive = [x, i.deps])

इस कोड को आसानी से बदला जा सकता है. सबसे पहले, उन सभी चीज़ों को एक साथ इकट्ठा करें जिनमें लोगों की आवाजाही होती है. 

transitive = []

for i in inputs:
    transitive.append(i.deps)

x = depset(transitive = transitive)

इसे सूची समझ के इस्तेमाल से कभी-कभी कम किया जा सकता है:

x = depset(transitive = [i.deps for i in inputs])

कमांड लाइन के लिए, ctx.action.args() का इस्तेमाल करें

कमांड लाइन बनाते समय, आपको ctx.action.args() का इस्तेमाल करना चाहिए. इससे, लागू होने वाले किसी भी डिफ़ेट का दायरा बढ़ जाता है.

यह पूरी तरह से तेज़ होने के अलावा, आपके नियमों की मेमोरी की खपत को भी कम कर देगा -- कभी-कभी 90% या इससे ज़्यादा.

इसके लिए, यहां कुछ सुझाव दिए गए हैं:

  • सूचियों और फ़्लैट को आसान बनाने के बजाय, सीधे आर्ग्युमेंट के तौर पर पास करें. ये आपके लिए ctx.actions.args() तक बड़ा हो जाएंगे. अगर आपको Depset के कॉन्टेंट में कोई बदलाव करना है, तो ctx.action.args#add पर जाएं और देखें कि बिल में क्या शामिल है.

  • क्या आपने File#path को आर्ग्युमेंट के तौर पर पास किया है? कोई ज़रूरत नहीं. कोई भी फ़ाइल अपने-आप ही उसके पाथ में बदल जाती है और उसे बड़ा होने का समय तय नहीं किया जा सकता.

  • स्ट्रिंग को एक साथ जोड़कर बनाने से बचें. सबसे अच्छा स्ट्रिंग तर्क एक स्थायी होता है, क्योंकि इसकी मेमोरी आपके नियम के सभी इंस्टेंस के बीच शेयर की जाएगी.

  • अगर कमांड लाइन के लिए आर्ग काफ़ी लंबे हैं, तो ctx.actions.args() ऑब्जेक्ट को ctx.actions.args#use_param_file का इस्तेमाल करके, पैरामीटर फ़ाइल में कंडीशनल या कंडीशनल तरीके से लिखा जा सकता है. जब यह कार्रवाई पूरी हो जाएगी, तो यह पर्दे के पीछे हो जाएगा. अगर आपको पैरामीटर फ़ाइल को साफ़ तौर पर कंट्रोल करने की ज़रूरत है, तो उसेctx.actions.write का इस्तेमाल करके, मैन्युअल तरीके से लिखा जा सकता है.

उदाहरण:

def _impl(ctx):
  ...
  args = ctx.actions.args()
  file = ctx.declare_file(...)
  files = depset(...)

  # Bad, constructs a full string "--foo=<file path>" for each rule instance
  args.add("--foo=" + file.path)

  # Good, shares "--foo" among all rule instances, and defers file.path to later
  # It will however pass ["--foo", <file path>] to the action command line,
  # instead of ["--foo=<file_path>"]
  args.add("--foo", file)

  # Use format if you prefer ["--foo=<file path>"] to ["--foo", <file path>]
  args.add(format="--foo=%s", value=file)

  # Bad, makes a giant string of a whole depset
  args.add(" ".join(["-I%s" % file.short_path for file in files])

  # Good, only stores a reference to the depset
  args.add_all(files, format_each="-I%s", map_each=_to_short_path)

# Function passed to map_each above
def _to_short_path(f):
  return f.short_path

संक्रामक कार्रवाई इनपुट को गहराई से तय किया जाना चाहिए

ctx.action.run का इस्तेमाल करके कार्रवाई करते समय यह न भूलें कि inputs फ़ील्ड में डिक्रिप्ट स्वीकार किया जाता है. जब भी इनपुट, डिपेंडेंसी से इकट्ठा किए जाते हैं, तब इसका इस्तेमाल करें.

inputs = depset(...)
ctx.actions.run(
  inputs = inputs,  # Do *not* turn inputs into a list
  ...
)

हैंगिंग

अगर बेज़ल लटका हुआ लगता है, तो आप Ctrl-\ दबा सकते हैं या Bazel को SIGQUIT सिग्नल (kill -3 $(bazel info server_pid)) भेज सकते हैं, ताकि फ़ाइल में थ्रेड को $(bazel info output_base)/server/jvm.out भेजा जा सके.

अगर बेजल का इस्तेमाल किया जाता है, तो हो सकता है कि आप bazel info न चला पाएं. इसलिए, output_base डायरेक्ट्री आम तौर पर, आपके फ़ाइल फ़ोल्डर की डायरेक्ट्री में bazel-<workspace> सिमलिंक की पैरंट होती है.

परफ़ॉर्मेंस प्रोफ़ाइलिंग

JSON ट्रेस प्रोफ़ाइल से यह समझने में मदद मिल सकती है कि न्योता भेजने के दौरान, बेज़ल ने किन चीज़ों पर समय बिताया.

मेमोरी भरने की सुविधा

Bazel में पहले से ऐसा मेमोरी प्रोफ़ाइलर मौजूद होता है जिसकी मदद से आप नियम की मेमोरी इस्तेमाल कर सकते हैं. अगर कोई समस्या है, तो आप कोड की सही लाइन ढूंढने के लिए हीप को डंप कर सकते हैं.

मेमोरी को ट्रैक करने की सुविधा चालू की जा रही है

Bazel के हर न्योते को शुरू करने के लिए, आपको इन दोनों फ़्लैग को पास करना होगा:

  STARTUP_FLAGS=\
  --host_jvm_args=-javaagent:$(BAZEL)/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
  --host_jvm_args=-DRULE_MEMORY_TRACKER=1

इससे, मेमोरी ट्रैकिंग मोड में सर्वर शुरू होता है. अगर आप बेज़ल शुरू करने के इस तरीके को भी भूल जाते हैं, तो सर्वर रीस्टार्ट होगा और आपको फिर से शुरू करना होगा.

मेमोरी ट्रैकर का इस्तेमाल करना

उदाहरण के लिए, foo टारगेट देखें और जानें कि यह क्या करता है. सिर्फ़ विश्लेषण चलाने और बिल्ड एक्ज़ीक्यूशन चरण चलाने के लिए, --nobuild फ़्लैग जोड़ें.

$ bazel $(STARTUP_FLAGS) build --nobuild //foo:foo

इसके बाद, देखें कि पूरे Bazel इंस्टेंस में कितनी मेमोरी इस्तेमाल होती है:

$ bazel $(STARTUP_FLAGS) info used-heap-size-after-gc
> 2594MB

इसे bazel dump --rules का इस्तेमाल करके, नियम की क्लास के हिसाब से बांटें:

$ bazel $(STARTUP_FLAGS) dump --rules
>

RULE                                 COUNT     ACTIONS          BYTES         EACH
genrule                             33,762      33,801    291,538,824        8,635
config_setting                      25,374           0     24,897,336          981
filegroup                           25,369      25,369     97,496,272        3,843
cc_library                           5,372      73,235    182,214,456       33,919
proto_library                        4,140     110,409    186,776,864       45,115
android_library                      2,621      36,921    218,504,848       83,366
java_library                         2,371      12,459     38,841,000       16,381
_gen_source                            719       2,157      9,195,312       12,789
_check_proto_library_deps              719         668      1,835,288        2,552
... (more output)

bazel dump --skylark_memory का इस्तेमाल करके देखें कि pprof फ़ाइल इस्तेमाल करके मेमोरी कहां जा रही है:

$ bazel $(STARTUP_FLAGS) dump --skylark_memory=$HOME/prof.gz
> Dumping Starlark heap to: /usr/local/google/home/$USER/prof.gz

हीप की जांच करने के लिए, pprof टूल का इस्तेमाल करें. शुरू करने का सबसे अच्छा तरीका है pprof -flame $HOME/prof.gz का इस्तेमाल करके किसी फ़्लेम ग्राफ़ को हासिल करना.

https://github.com/google/pprof से pprof पाएं.

सबसे लोकप्रिय कॉल साइटों के टेक्स्ट डंप का एनोटेशन पाएं. इस टेक्स्ट में, लाइनों की जानकारी दी जाती है:

$ pprof -text -lines $HOME/prof.gz
>
      flat  flat%   sum%        cum   cum%
  146.11MB 19.64% 19.64%   146.11MB 19.64%  android_library <native>:-1
  113.02MB 15.19% 34.83%   113.02MB 15.19%  genrule <native>:-1
   74.11MB  9.96% 44.80%    74.11MB  9.96%  glob <native>:-1
   55.98MB  7.53% 52.32%    55.98MB  7.53%  filegroup <native>:-1
   53.44MB  7.18% 59.51%    53.44MB  7.18%  sh_test <native>:-1
   26.55MB  3.57% 63.07%    26.55MB  3.57%  _generate_foo_files /foo/tc/tc.bzl:491
   26.01MB  3.50% 66.57%    26.01MB  3.50%  _build_foo_impl /foo/build_test.bzl:78
   22.01MB  2.96% 69.53%    22.01MB  2.96%  _build_foo_impl /foo/build_test.bzl:73
   ... (more output)