เมื่อเขียนกฎ ข้อผิดพลาดด้านประสิทธิภาพที่พบบ่อยที่สุดคือการเรียกดูหรือคัดลอกข้อมูลที่รวบรวมจากข้อกําหนด เมื่อรวบรวมข้อมูลทั้งหมดในบิลด์ การดำเนินการเหล่านี้อาจใช้เวลาหรือพื้นที่เก็บข้อมูล O(N^2) ได้อย่างง่ายดาย เพื่อหลีกเลี่ยงปัญหานี้ จึงจำเป็นต้องเข้าใจวิธีใช้การตั้งค่าอย่างมีประสิทธิภาพ
การแก้ไขข้อผิดพลาดอาจทำได้ยาก ด้วยเหตุนี้ Bazel จึงมีเครื่องมือสร้างโปรไฟล์ความทรงจำที่ช่วยให้คุณค้นหาจุดที่อาจเกิดความผิดพลาด โปรดทราบว่าค่าใช้จ่ายในการเขียนกฎที่ไม่มีประสิทธิภาพอาจไม่ชัดเจนจนกว่ากฎดังกล่าวจะใช้งานกันอย่างแพร่หลาย
ใช้ชุดข้อมูล
คุณควรใช้ depsets ทุกครั้งที่รวมข้อมูลจากข้อกําหนดของกฎ ใช้เฉพาะลิสต์หรือพจนานุกรมธรรมดาเพื่อเผยแพร่ข้อมูลในกฎปัจจุบัน
ชุดข้อมูล Dependency Set จะแสดงข้อมูลเป็นกราฟที่ฝังอยู่ซึ่งช่วยให้แชร์ได้
ลองดูกราฟต่อไปนี้
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' 4 ครั้ง แต่ด้วยกราฟที่ใหญ่กว่านี้
ปัญหานี้จะแย่ลงเท่านั้น
ต่อไปนี้คือตัวอย่างการใช้งานกฎที่ใช้การปรับค่าอย่างถูกต้องเพื่อเผยแพร่ข้อมูลทรานซิชัน โปรดทราบว่าคุณเผยแพร่ข้อมูลระดับกฎโดยใช้ลิสต์ได้หากต้องการ เนื่องจากการดำเนินการนี้ไม่ใช่ 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) เมื่อคุณสร้างชุดเป้าหมายที่มีความสัมพันธ์ซึ่งกันและกัน กรณีนี้จะเกิดขึ้นเมื่อสร้างการทดสอบ //foo/tests/... หรือเมื่อนำเข้าโปรเจ็กต์ IDE
ลดจํานวนการโทรเป็น depset
การเรียกใช้ depset ภายในลูปมักเป็นข้อผิดพลาด ซึ่งอาจทําให้เกิด Depset ที่มีการฝังซ้อนกันมาก ซึ่งทํางานได้ไม่ดี เช่น
x = depset()
for i in inputs:
# Do not do that.
x = depset(transitive = [x, i.deps])
รหัสนี้แทนที่ได้ง่าย ก่อนอื่น ให้รวบรวมชุดข้อมูล transitive แล้วผสานทั้งหมดพร้อมกัน
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() ซึ่งจะเลื่อนการขยายการตั้งค่าใดก็ตามไปยังระยะการดำเนินการ
นอกจากความเร็วสูงสุดแล้ว กฎของคุณจะช่วยลดการใช้หน่วยความจำได้ ซึ่งบางครั้งอาจลดลง 90% หรือมากกว่านั้น
เคล็ดลับบางส่วนมีดังนี้
ส่งชุดข้อมูลและลิสต์เป็นอาร์กิวเมนต์โดยตรงแทนการผสานด้วยตัวเอง ระบบจะเพิ่มพื้นที่เก็บข้อมูลให้
ctx.actions.args()GB หากต้องการเปลี่ยนรูปแบบเนื้อหา depset ให้ดูที่ ctx.actions.args#add เพื่อดูว่ามีอะไรที่ตรงกับความต้องการหรือไม่คุณส่ง
File#pathเป็นอาร์กิวเมนต์อยู่หรือไม่ ไม่จำเป็น ระบบจะเปลี่ยนไฟล์เป็นเส้นทางโดยอัตโนมัติ โดยจะเลื่อนไปไว้ที่เวลาขยายหลีกเลี่ยงการสร้างสตริงโดยการต่อสตริงเข้าด้วยกัน อาร์กิวเมนต์สตริงที่ดีที่สุดเป็นค่าคงที่เนื่องจากมีการแชร์หน่วยความจำระหว่างอินสแตนซ์ทั้งหมดของกฎ
หากอาร์กิวเมนต์ยาวเกินกว่าที่บรรทัดคำสั่งจะรองรับ ระบบจะเขียนออบเจ็กต์
ctx.actions.args()ไปยังไฟล์พารามิเตอร์แบบมีเงื่อนไขหรือไม่มีเงื่อนไขได้โดยใช้ctx.actions.args#use_param_fileซึ่งจะมีการดำเนินการอยู่เบื้องหลังเมื่อดำเนินการ หากต้องการควบคุมไฟล์ params อย่างชัดแจ้ง คุณสามารถเขียนไฟล์ด้วยตนเองได้โดยใช้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 ยอมรับ depset ใช้คำสั่งนี้ทุกครั้งที่รวบรวมอินพุตจากข้อกําหนดเบื้องต้นแบบทรานซิทีฟ
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 ได้หาก bazel ค้างอยู่ โดยปกติแล้วไดเรกทอรี output_base จะเป็นไดเรกทอรีหลักของ bazel-<workspace>
ลิงก์สัญลักษณ์ในไดเรกทอรีเวิร์กスペース
โปรไฟล์ประสิทธิภาพ
Bazel จะเขียนโปรไฟล์ JSON ไปยัง command.profile.gz ในฐานเอาต์พุตโดยค่าเริ่มต้น คุณสามารถกําหนดค่าตําแหน่งด้วย Flag --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 กำลังทำอะไร เช่น "Launch Bazel", "assessTargetPatterns" และ "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 ด้วย
analyze-profile
วิธีการทำโปรไฟล์นี้มี 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 มาพร้อมกับเครื่องมือสร้างโปรไฟล์หน่วยความจำในตัวที่จะช่วยให้คุณตรวจสอบการใช้หน่วยความจำของกฎได้ หากพบปัญหา คุณสามารถถ่ายโอนข้อมูลกองขยะเพื่อค้นหาบรรทัดโค้ดที่ทำให้เกิดปัญหา
การเปิดใช้การติดตามหน่วยความจํา
คุณต้องส่ง Flag เริ่มต้น 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 เป้าหมาย และดูว่าเป้าหมายนี้ทำอะไรได้บ้าง หากต้องการเรียกใช้การวิเคราะห์เท่านั้นและไม่เรียกใช้ระยะการทำงานของบิลด์ ให้เพิ่ม Flag --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 เพื่อตรวจสอบฮีป จุดเริ่มต้นที่ดีคือการดูกราฟเปลวไฟโดยใช้ 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)