नियम लिखते समय, डिपेंडेंसी से इकट्ठा किए गए डेटा को ट्रैवर्स या कॉपी करना, परफ़ॉर्मेंस से जुड़ी सबसे सामान्य गड़बड़ी होती है. पूरे बिल्ड को एक साथ दिखाने पर, ये कार्रवाइयां आसानी से O(N^2) समय या जगह ले सकती हैं. इससे बचने के लिए, यह समझना ज़रूरी है कि डिसेट का असरदार ढंग से इस्तेमाल कैसे किया जाए.
इस बात को सही करना मुश्किल हो सकता है, इसलिए Bazel एक मेमोरी प्रोफ़ाइलर भी देता है, जो आपको ऐसी जगह ढूंढने में मदद करता है जहां शायद आपसे गलती हो. ध्यान रखें: लागू न होने वाले नियम को लिखने की कीमत तब तक साफ़ नहीं दिखती, जब तक उसका बड़े पैमाने पर इस्तेमाल न किया जाए.
डिसेट का इस्तेमाल करें
जब भी आप नियम डिपेंडेंसी से जानकारी रोल अप कर रहे हों, तो आपको depsets का इस्तेमाल करना चाहिए. मौजूदा नियम के हिसाब से जानकारी पब्लिश करने के लिए, सिर्फ़ सामान्य सूचियों या लिखवाने की सुविधा का इस्तेमाल करें.
डिपसेट, जानकारी को नेस्ट किए गए ग्राफ़ के रूप में दिखाता है, जो शेयर करने की सुविधा चालू करता है.
नीचे दिया गया ग्राफ़ देखें:
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.तुलना() का इस्तेमाल करें
कमांड लाइन बनाते समय, आपको 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 info output_base)/server/jvm.out
में थ्रेड डंप पाने के लिए, Ctrl-\ दबाएं या Bazel को SIGQUIT
सिग्नल (kill -3 $(bazel info server_pid)
) भेजें.
अगर बैजल हैंग हो गया है, तो हो सकता है कि आप bazel info
न चला पाएं. इसलिए,
output_base
डायरेक्ट्री आम तौर पर आपकी फ़ाइल फ़ोल्डर डायरेक्ट्री में bazel-<workspace>
सिमलिंक की पैरंट होती है.
परफ़ॉर्मेंस की प्रोफ़ाइल बनाना
Bazel, आउटपुट बेस में डिफ़ॉल्ट रूप से command.profile.gz
पर JSON प्रोफ़ाइल लिखता है. जगह की जानकारी को --profile
फ़्लैग का इस्तेमाल करके कॉन्फ़िगर किया जा सकता है, जैसे कि --profile=/tmp/profile.gz
. .gz
पर खत्म होने वाली जगहों को
GZIP के साथ कंप्रेस किया जाता है.
नतीजे देखने के लिए, Chrome ब्राउज़र टैब में chrome://tracing
खोलें. इसके बाद, "लोड करें" पर क्लिक करें और (संभावित रूप से कंप्रेस की गई) प्रोफ़ाइल फ़ाइल चुनें. नतीजों की ज़्यादा जानकारी के लिए, नीचे बाएं कोने में मौजूद बॉक्स पर क्लिक करें.
नेविगेट करने के लिए, इन कीबोर्ड कंट्रोल का इस्तेमाल किया जा सकता है:
- "चुनें" मोड के लिए
1
दबाएं. इस मोड में, इवेंट की जानकारी देखने के लिए कुछ खास बॉक्स चुनें (नीचे बायां कोना देखें). खास जानकारी और एग्रीगेट किए गए आंकड़े पाने के लिए, एक से ज़्यादा इवेंट चुनें. - "पैन" मोड के लिए
2
दबाएं. इसके बाद, व्यू को चलाने के लिए माउस को खींचें और छोड़ें. बाएं/दाएं ले जाने के लिए,a
/d
का भी इस्तेमाल किया जा सकता है. - "ज़ूम" मोड के लिए
3
दबाएं. फिर ज़ूम करने के लिए माउस खींचें. ज़ूम इन/आउट करने के लिए,w
/s
का भी इस्तेमाल किया जा सकता है. - "समय" मोड के लिए
4
दबाएं, जहां दो इवेंट के बीच की दूरी मापी जा सकती है. - सभी कंट्रोल के बारे में जानने के लिए,
?
दबाएं.
प्रोफ़ाइल की जानकारी
प्रोफ़ाइल का उदाहरण:
पहला डायग्राम. प्रोफ़ाइल का उदाहरण.
यहां कुछ खास लाइनें दी गई हैं:
action counters
: दिखाता है कि फ़्लाइट में एक साथ कितनी कार्रवाइयां की जा रही हैं. वास्तविक मान देखने के लिए उस पर क्लिक करें. क्लीन बिल्ड में--jobs
की वैल्यू तक जाना चाहिए.cpu counters
: बिल्ड के हर सेकंड के लिए, यह दिखाता है कि बैटरी लाइफ़ के लिए कितने सीपीयू (CPU) का इस्तेमाल किया गया (1 का मतलब एक कोर का 100% व्यस्त होना है).Critical Path
: अहम पाथ पर हर कार्रवाई के लिए एक ब्लॉक दिखाता है.grpc-command-1
: Bazel का मुख्य थ्रेड. इससे यह अच्छी तरह समझा जा सकता है कि Bzel क्या कर रहा है. उदाहरण के लिए, "Launch Bazel", "evaluateTargetTargets", और "runAnalysisUse".Service Thread
: कचरा हटाने की छोटी और बड़ी संख्या (जीसी) को रोका गया है.
दूसरी लाइनें, बैजल थ्रेड को दिखाती हैं और उस थ्रेड पर सभी इवेंट दिखाती हैं.
परफ़ॉर्मेंस से जुड़ी सामान्य समस्याएं
परफ़ॉर्मेंस प्रोफ़ाइलों का विश्लेषण करते समय इन चीज़ों पर ध्यान दें:
- विश्लेषण के चरण में उम्मीद से ज़्यादा धीमी (
runAnalysisPhase
), खास तौर पर उन मामलों में जो इंक्रीमेंटल बिल्ड होते हैं. यह किसी नियम को लागू करने में हुई गड़बड़ी का संकेत हो सकता है. उदाहरण के लिए, ऐसा नियम जो डिसेट को फ़्लैट करता है. बहुत ज़्यादा टारगेट, जटिल मैक्रो या बार-बार इस्तेमाल होने वाले ग्लॉब की वजह से पैकेज लोड होने की स्पीड धीमी हो सकती है. - धीमी रफ़्तार से की जाने वाली व्यक्तिगत कार्रवाइयां, खास तौर पर वे कार्रवाइयां जो अहम पाथ पर हैं. बड़ी कार्रवाइयों को कई छोटी कार्रवाइयों में बांटा जा सकता है. इसके अलावा, उनकी स्पीड बढ़ाने के लिए उनकी डिपेंडेंसी को कम किया जा सकता है. साथ ही, यह भी देखें कि
PROCESS_TIME
की सामान्य से ज़्यादा वैल्यू न हो, जैसे किREMOTE_SETUP
याFETCH
. - बॉटलनेक, जो कि थ्रेड की छोटी संख्या है, वहां बाकी सभी थ्रेड व्यस्त हैं / नतीजे का इंतज़ार कर रहे हैं (ऊपर दिए गए स्क्रीनशॉट में 15 से 30 सेकंड के आस-पास देखें). इसे ऑप्टिमाइज़ करने के लिए आपको नियम लागू करने की प्रोसेस को छूना होगा या Bazel को छूने की ज़रूरत होगी, ताकि एक साथ काम किया जा सके. ऐसा तब भी हो सकता है, जब जीसी बहुत ज़्यादा हो.
प्रोफ़ाइल का फ़ाइल फ़ॉर्मैट
टॉप लेवल ऑब्जेक्ट में मेटाडेटा (otherData
) और असल ट्रेसिंग डेटा (traceEvents
) शामिल होता है. मेटाडेटा में ज़्यादा जानकारी होती है, जैसे कि शुरू करने का आईडी और Bazel को शुरू करने की तारीख.
उदाहरण:
{
"otherData": {
"build_id": "101bff9a-7243-4c1a-8503-9dc6ae4c3b05",
"date": "Tue Jun 16 08:30:21 CEST 2020",
"profile_finish_ts": "1677666095162000",
"output_base": "/usr/local/google/_bazel_johndoe/573d4be77eaa72b91a3dfaa497bf8cd0"
},
"traceEvents": [
{"name":"thread_name","ph":"M","pid":1,"tid":0,"args":{"name":"Critical Path"}},
{"cat":"build phase marker","name":"Launch Bazel","ph":"X","ts":-1824000,"dur":1824000,"pid":1,"tid":60},
...
{"cat":"general information","name":"NoSpawnCacheModule.beforeCommand","ph":"X","ts":116461,"dur":419,"pid":1,"tid":60},
...
{"cat":"package creation","name":"src","ph":"X","ts":279844,"dur":15479,"pid":1,"tid":838},
...
{"name":"thread_name","ph":"M","pid":1,"tid":11,"args":{"name":"Service Thread"}},
{"cat":"gc notification","name":"minor GC","ph":"X","ts":334626,"dur":13000,"pid":1,"tid":11},
...
{"cat":"action processing","name":"Compiling third_party/grpc/src/core/lib/transport/status_conversion.cc","ph":"X","ts":12630845,"dur":136644,"pid":1,"tid":1546}
]
}
ट्रेस इवेंट में टाइमस्टैंप (ts
) और कुल समय (dur
) माइक्रोसेकंड में दिए जाते हैं. कैटगरी (cat
), ProfilerTask
की enum वैल्यू में से एक है.
ध्यान दें कि अगर कुछ इवेंट बहुत छोटे हैं और एक-दूसरे के करीब हैं, तो उन्हें एक साथ मर्ज कर दिया जाता है. अगर आपको इवेंट मर्ज होने से रोकना है, तो --noslim_json_profile
को पास करें.
Chrome ट्रेस इवेंट फ़ॉर्मैट की खास बातें भी देखें.
प्रोफ़ाइल का विश्लेषण करें
प्रोफ़ाइलिंग के इस तरीके में दो चरण हैं. पहले आपको --profile
फ़्लैग की मदद से बिल्ड/टेस्ट एक्ज़ीक्यूट करना होगा, उदाहरण के लिए
$ bazel build --profile=/tmp/prof //path/to:target
जनरेट की गई फ़ाइल (इस मामले में /tmp/prof
), एक बाइनरी फ़ाइल है. इसे analyze-profile
कमांड की मदद से प्रोसेस किया जा सकता है और उसका विश्लेषण किया जा सकता है:
$ bazel analyze-profile /tmp/prof
डिफ़ॉल्ट रूप से, यह खास प्रोफ़ाइल डेटाफ़ाइल के लिए खास जानकारी के विश्लेषण की जानकारी प्रिंट करता है. इसमें निर्माण के हर चरण के लिए अलग-अलग तरह के टास्क के कुल आंकड़े और अहम पाथ का विश्लेषण शामिल होता है.
डिफ़ॉल्ट आउटपुट के पहले सेक्शन में, बिल्ड के अलग-अलग चरणों में लगने वाले समय की खास जानकारी होती है:
INFO: Profile created on Tue Jun 16 08:59:40 CEST 2020, build ID: 0589419c-738b-4676-a374-18f7bbc7ac23, output base: /home/johndoe/.cache/bazel/_bazel_johndoe/d8eb7a85967b22409442664d380222c0
=== PHASE SUMMARY INFORMATION ===
Total launch phase time 1.070 s 12.95%
Total init phase time 0.299 s 3.62%
Total loading phase time 0.878 s 10.64%
Total analysis phase time 1.319 s 15.98%
Total preparation phase time 0.047 s 0.57%
Total execution phase time 4.629 s 56.05%
Total finish phase time 0.014 s 0.18%
------------------------------------------------
Total run time 8.260 s 100.00%
Critical path (4.245 s):
Time Percentage Description
8.85 ms 0.21% _Ccompiler_Udeps for @local_config_cc// compiler_deps
3.839 s 90.44% action 'Compiling external/com_google_protobuf/src/google/protobuf/compiler/php/php_generator.cc [for host]'
270 ms 6.36% action 'Linking external/com_google_protobuf/protoc [for host]'
0.25 ms 0.01% runfiles for @com_google_protobuf// protoc
126 ms 2.97% action 'ProtoCompile external/com_google_protobuf/python/google/protobuf/compiler/plugin_pb2.py'
0.96 ms 0.02% runfiles for //tools/aquery_differ aquery_differ
मेमोरी के इस्तेमाल की प्रोफ़ाइल बनाई जा रही है
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
ये सर्वर को मेमोरी ट्रैकिंग मोड में शुरू करते हैं. अगर आप इन्हें एक भी 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)