เมื่อเขียนกฎ ข้อผิดพลาดด้านประสิทธิภาพที่พบบ่อยที่สุดคือการส่งข้อมูลหรือคัดลอกข้อมูลที่รวบรวมมาจากทรัพยากร Dependency เมื่อรวบรวมจากทั่วทั้งบิลด์ การดำเนินการเหล่านี้อาจใช้เวลาหรือพื้นที่ O(N^2) ได้โดยง่าย เพื่อหลีกเลี่ยงปัญหานี้ คุณจึงต้องเข้าใจ วิธีใช้ Depset อย่างมีประสิทธิภาพ
การที่ถูกต้องอาจเป็นเรื่องยาก ดังนั้น Bazel จึงมีเครื่องมือสร้างโปรไฟล์หน่วยความจำที่ช่วยให้คุณค้นหาจุดที่อาจทำพลาดได้ แต่ควรระวังเรื่องค่าใช้จ่ายสำหรับการเขียนกฎที่ไม่มีประสิทธิภาพอย่างชัดเจนจนกว่าจะนำไปใช้อย่างแพร่หลาย
ใช้ Depset
เมื่อใดก็ตามที่คุณรวมข้อมูลจากทรัพยากร Dependency ของกฎ คุณควรใช้ depset ใช้เฉพาะรายการหรือคำสั่งทั่วไปเพื่อเผยแพร่ข้อมูล ในเครื่องลงในกฎปัจจุบันเท่านั้น
Depset แสดงถึงข้อมูลในรูปแบบกราฟที่ซ้อนกันซึ่งจะทำให้สามารถแชร์ได้
ลองใช้กราฟต่อไปนี้
C -> B -> A
D ---^
แต่ละโหนดจะเผยแพร่สตริงเดียว เมื่อใช้ Depset ข้อมูลจะมีลักษณะดังนี้
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' ถึง 4 ครั้ง ถ้ากราฟใหญ่ขึ้น ปัญหานี้จะแย่ลง
นี่คือตัวอย่างของการใช้งานกฎที่ใช้ depset อย่างถูกต้องในการเผยแพร่ข้อมูลทางอ้อม โปรดทราบว่าคุณสามารถเผยแพร่ข้อมูลกฎท้องถิ่น โดยใช้รายการได้หากต้องการ เนื่องจากไม่ใช่ 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()
คุณบังคับให้ Depset เป็นรายการแบบแบนได้โดยใช้ to_list() แต่การทำเช่นนั้นมักจะส่งผลให้เกิดต้นทุน O(N^2) หากเป็นไปได้ ให้หลีกเลี่ยงการทำให้ตัวเดตลดลง ยกเว้นเพื่อจุดประสงค์ในการแก้ไขข้อบกพร่อง
สิ่งที่คนมักเข้าใจผิดก็คือ คุณลดความคลาดเคลื่อนได้อย่างอิสระหากดำเนินการที่เป้าหมายระดับบนสุดเท่านั้น เช่น กฎ <xx>_binary หลังจากนั้นต้นทุนจะไม่สะสมเพิ่มขึ้นในแต่ละระดับของกราฟบิลด์ แต่นี่จะยัง O(N^2) อยู่เมื่อคุณสร้างชุดเป้าหมายที่มีทรัพยากร Dependency ทับซ้อนกัน ซึ่งจะเกิดขึ้นเมื่อสร้างการทดสอบ //foo/tests/... หรือเมื่อนำเข้าโปรเจ็กต์ IDE
ลดจำนวนการโทรไปยัง depset
การเรียกใช้ depset แบบวนซ้ำมักเป็นข้อผิดพลาด เนื่องจากอาจทำให้มีระยะการซ้อนที่ลึกมาก ซึ่งทำงานได้ไม่ดี เช่น
x = depset()
for i in inputs:
# Do not do that.
x = depset(transitive = [x, i.deps])
รหัสนี้สามารถแทนที่ได้โดยง่าย อย่างแรก ให้รวบรวม Depsets ที่สับเปลี่ยนและผสานเข้าด้วยกันทั้งหมดในครั้งเดียว
transitive = []
for i in inputs:
transitive.append(i.deps)
x = depset(transitive = transitive)
ซึ่งบางครั้งอาจลดลงโดยใช้ความเข้าใจในรายการ เช่น
x = depset(transitive = [i.deps for i in inputs])
ใช้ ctx.actions.args() สำหรับบรรทัดคำสั่ง
เมื่อสร้างบรรทัดคำสั่ง คุณควรใช้ ctx.actions.args() การดำเนินการนี้เลื่อนการขยาย Depset ไปยังระยะการดำเนินการ
นอกเหนือจากการทำงานที่เร็วขึ้นอย่างเคร่งครัดแล้ว วิธีนี้จะช่วยลดการใช้หน่วยความจำของกฎ โดยในบางครั้งอาจมากกว่า 90%
เคล็ดลับบางส่วนมีดังนี้
ส่งต่อ Depsets และลิสต์เป็นอาร์กิวเมนต์โดยตรง แทนที่จะแยกเป็นรายการเดี่ยวๆ เราจะขยายระยะเวลาการเป็นสมาชิก
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 จะยอมรับการดีเซต ใช้ตัวเลือกนี้ทุกครั้งที่มีการรวบรวมอินพุต
จากทรัพยากร Dependency แบบชั่วคราว
inputs = depset(...)
ctx.actions.run(
inputs = inputs, # Do *not* turn inputs into a list
...
)
แบบแขวน
หาก Bazel แขวนอยู่ คุณสามารถกด Ctrl-\ หรือส่งสัญญาณ SIGQUIT (kill -3 $(bazel info server_pid)) แบบ Bazel เพื่อรับดัมพ์เทรดในไฟล์ $(bazel info output_base)/server/jvm.out
เนื่องจากคุณอาจเรียกใช้ bazel info ไม่ได้หากมีการแขวนไว้ ไดเรกทอรี output_base จึงมักเป็นระดับบนสุดของลิงก์สัญลักษณ์ bazel-<workspace> ในไดเรกทอรีพื้นที่ทำงาน
การทำโปรไฟล์ประสิทธิภาพ
Bazel เขียนโปรไฟล์ JSON ไปยัง command.profile.gz ในฐานเอาต์พุตโดยค่าเริ่มต้น คุณสามารถกำหนดค่าตำแหน่งด้วยแฟล็ก --profile ตัวอย่างเช่น --profile=/tmp/profile.gz สถานที่ตั้งที่ลงท้ายด้วย .gz จะถูกบีบอัดด้วย GZIP
หากต้องการดูผลลัพธ์ ให้เปิด chrome://tracing ในแท็บเบราว์เซอร์ Chrome คลิก "โหลด" แล้วเลือกไฟล์โปรไฟล์ (ที่อาจบีบอัด) หากต้องการดูผลลัพธ์ที่ละเอียดยิ่งขึ้น ให้คลิกช่องที่มุมล่างซ้าย
คุณใช้การควบคุมด้วยแป้นพิมพ์เหล่านี้เพื่อไปยังส่วนต่างๆ ได้
- กด
1สำหรับโหมด "เลือก" ในโหมดนี้ คุณจะเลือกช่องเฉพาะเพื่อตรวจสอบรายละเอียดกิจกรรมได้ (ดูมุมซ้ายล่าง) เลือกหลายเหตุการณ์เพื่อดูสรุปและสถิติแบบรวม - กด
2สำหรับโหมด "เลื่อน" จากนั้นลากเมาส์เพื่อย้ายมุมมอง นอกจากนี้ คุณยังสามารถใช้a/dเพื่อเลื่อนไปทางซ้าย/ขวา - กด
3สำหรับโหมด "ซูม" จากนั้นลากเมาส์เพื่อซูม นอกจากนี้ คุณยังใช้w/sเพื่อซูมเข้า/ออกได้อีกด้วย - กด
4สำหรับโหมด "การจับเวลา" ซึ่งคุณจะวัดระยะทางระหว่าง 2 เหตุการณ์ได้ - กด
?เพื่อดูข้อมูลเกี่ยวกับการควบคุมทั้งหมด
ข้อมูลโปรไฟล์
โปรไฟล์ตัวอย่าง:
รูปที่ 1 โปรไฟล์ตัวอย่าง
โดยมีแถวพิเศษดังนี้
action counters: แสดงจำนวนการดำเนินการที่เกิดขึ้นพร้อมกันในเที่ยวบิน ให้คลิกเพื่อดูค่าที่แท้จริง ควรถึงค่าของ--jobsในบิลด์ที่สะอาดcpu counters: แสดงปริมาณ CPU ที่ Bazel ใช้งานในแต่ละวินาที (ค่า 1 เท่ากับ 1 แกนหมายถึงไม่ว่าง 100%)Critical Path: แสดง 1 บล็อกสำหรับการดำเนินการแต่ละรายการในเส้นทางวิกฤติgrpc-command-1: ชุดข้อความหลักของ Bazel การดูภาพรวมกว้างๆ ว่า Bazel กำลังทำอะไรอยู่ เช่น "เปิดตัว Bazel", "impressionTargetPatterns" และ "runAnalysisPhase"Service Thread: แสดงการหยุดเก็บขยะ (GC) ชั่วคราวและผู้เยาว์
แถวอื่นๆ แสดงแทนชุดข้อความ Bazel และแสดงเหตุการณ์ทั้งหมดในชุดข้อความนั้น
ปัญหาด้านประสิทธิภาพที่พบบ่อย
เมื่อวิเคราะห์โปรไฟล์ประสิทธิภาพ ให้มองหาข้อมูลต่อไปนี้
- ช้ากว่าระยะการวิเคราะห์ที่คาดไว้ (
runAnalysisPhase) โดยเฉพาะในบิลด์ที่เพิ่มขึ้น นี่อาจเป็นสัญญาณของการใช้กฎที่ไม่มีประสิทธิภาพ เช่น กฎที่ค่อยๆ ลดค่าที่กำหนด การโหลดแพ็กเกจอาจช้าลงเนื่องจากมีเป้าหมายมากเกินไป มาโครที่ซับซ้อน หรือบอลลูนที่เกิดซ้ำ - การดำเนินการที่ช้าแต่ละรายการ โดยเฉพาะการดำเนินการที่อยู่ในเส้นทางสำคัญ คุณอาจสามารถแบ่งการดำเนินการขนาดใหญ่ออกเป็นการดำเนินการย่อยหลายๆ การดำเนินการ หรือลดชุดของทรัพยากร Dependency (ชั่วคราว) เพื่อให้ทำงานได้เร็วขึ้น และตรวจหาค่าที่ไม่ใช่
PROCESS_TIMEสูงผิดปกติ (เช่นREMOTE_SETUPหรือFETCH) - จุดคอขวด ซึ่งเป็นชุดข้อความจำนวนเล็กน้อยที่ยุ่งเหยิงอยู่ในขณะที่คนอื่นๆ ทั้งหมดไม่มีการใช้งาน / กำลังรอผลลัพธ์ (ดูประมาณ 15-30 วินาทีในภาพหน้าจอด้านบน) ในการเพิ่มประสิทธิภาพ ก็เป็นไปได้ว่าจะต้องมีการใช้กฎ หรือตัว Bazel เองเพื่อให้ทำงานพร้อมกันได้มากขึ้น กรณีนี้อาจเกิดขึ้นได้เช่นกัน เมื่อมีจำนวน GC มากผิดปกติ
รูปแบบไฟล์โปรไฟล์
ออบเจ็กต์ระดับบนสุดมีข้อมูลเมตา (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) เป็นหนึ่งในค่า enum ของ ProfilerTask
โปรดทราบว่าระบบจะรวมบางเหตุการณ์เข้าด้วยกันหากเหตุการณ์นั้นสั้นมากและใกล้เคียงกัน โปรดส่ง --noslim_json_profile หากต้องการป้องกันไม่ให้มีการผสานรวมเหตุการณ์
โปรดดูข้อกำหนดรูปแบบเหตุการณ์ของ Chrome Trace ด้วย
โปรไฟล์การวิเคราะห์
วิธีการทำโปรไฟล์นี้ประกอบด้วย 2 ขั้นตอน ขั้นแรกคุณต้องทำการสร้าง/ทดสอบด้วยแฟล็ก --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 มาพร้อมกับเครื่องมือสร้างโปรไฟล์หน่วยความจำในตัวที่ช่วยให้คุณตรวจสอบการใช้หน่วยความจำของกฎได้ หากมีปัญหา คุณสามารถดัมพ์ฮีปเพื่อหาบรรทัดโค้ดที่ทำให้เกิดปัญหา
การเปิดใช้การติดตามหน่วยความจำ
คุณต้องส่งแฟล็กเริ่มต้น 2 รายการต่อไปนี้ไปยังการเรียกใช้ 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)
ดูว่าหน่วยความจำจะอยู่ที่ใดด้วยการสร้างไฟล์ pprof โดยใช้ bazel dump --skylark_memory
$ bazel $(STARTUP_FLAGS) dump --skylark_memory=$HOME/prof.gz
> Dumping Starlark heap to: /usr/local/google/home/$USER/prof.gz
ใช้เครื่องมือ pprof เพื่อตรวจสอบฮีป จุดเริ่มต้นที่ดีคือ
การรับกราฟ Fle โดยใช้ pprof -flame $HOME/prof.gz
รับ pprof จาก https://github.com/google/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)