इस पेज का अनुवाद Cloud Translation API से किया गया है.

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

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

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

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

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

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

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

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.actions.orgs() का इस्तेमाल करें

कमांड लाइन बनाते समय, आपको ctx.actions.args() का इस्तेमाल करना चाहिए. इससे, कमांड लाइन को एक्ज़ीक्यूशन फ़ेज़ में ले जाया जा सकता है.

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

यहां कुछ तरकीबें दी गई हैं:

डिपेसेट और सूचियों को खुद फ़्लैट करने के बजाय सीधे तर्कों के तौर पर पास करें. इन्हें ctx.actions.args() तक बड़ा कर दिया जाएगा. अगर आपको डिप्सेट कॉन्टेंट में कोई बदलाव करना है, तो ctx.actions.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.actions.run का इस्तेमाल करके कोई कार्रवाई बनाते समय, यह न भूलें कि inputs फ़ील्ड डिप्सेट स्वीकार करता है. जब भी डिपेंडेंसी से इनपुट इकट्ठा किए जाते हैं, तब इसका इस्तेमाल करें.

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

हैंगिंग

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

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

परफ़ॉर्मेंस की प्रोफ़ाइल बनाना

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

मेमोरी की प्रोफ़ाइल बनाई जा रही है

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

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

आपको हर बैजल के लिए इन दो स्टार्टअप फ़्लैग को पास करना होगा:

  STARTUP_FLAGS=\
  --host_jvm_args=-javaagent:<path to java-allocation-instrumenter-3.3.0.jar> \
  --host_jvm_args=-DRULE_MEMORY_TRACKER=1

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

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

उदाहरण के तौर पर, टारगेट 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)