เมื่อเขียนกฎ ข้อผิดพลาดด้านประสิทธิภาพที่พบบ่อยที่สุดก็คือการข้ามหรือคัดลอก ข้อมูลที่เก็บรวบรวมจากทรัพยากร Dependency เมื่อรวมข้อมูลจากผลรวม การดำเนินการเหล่านี้สามารถใช้เวลาหรือพื้นที่ว่าง O(N^2) ได้อย่างง่ายดาย เพื่อหลีกเลี่ยงปัญหานี้ เป็นสิ่งสำคัญในการทำความเข้าใจวิธีใช้ Depset อย่างมีประสิทธิภาพ
การยืนยันนี้อาจทำได้ยาก ดังนั้น Bazel จึงมีเครื่องมือสร้างโปรไฟล์หน่วยความจำที่ ช่วยคุณหาจุดที่อาจเกิดความผิดพลาด เตือน: ค่าใช้จ่ายในการเขียนกฎที่ไม่มีประสิทธิภาพอาจไม่ชัดเจนจนกว่าจะ กันอย่างแพร่หลาย
ใช้การตั้งค่า
เมื่อใดก็ตามที่คุณรวมข้อมูลจากทรัพยากร Dependency ของกฎ คุณควรใช้ depsets ใช้เฉพาะรายการแบบธรรมดาหรือคำสั่งเพื่อเผยแพร่ข้อมูล ภายในกฎปัจจุบัน
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' ถึง 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
หลีกเลี่ยงการโทรหา depset.to_list()
คุณสามารถเปลี่ยนการตั้งค่าให้เป็นรายการแบบเดี่ยวได้โดยใช้
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])
โค้ดนี้สามารถแทนที่ได้โดยง่าย ขั้นแรก ให้รวบรวมแท็กย่อยและ รวมทั้งหมดในครั้งเดียว:
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()ให้คุณ หากต้องการเปลี่ยนรูปแบบเนื้อหา Depset โปรดดูที่ ctx.actions.args#add เพื่อดูว่าสิ่งใดตรงกับใบเรียกเก็บเงินหรือไม่คุณส่งผ่าน
File#pathเป็นอาร์กิวเมนต์ใช่ไหม ไม่จำเป็น ช่วง ระบบจะเปลี่ยนไฟล์เป็นไฟล์โดยอัตโนมัติ 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-\ หรือส่ง
Bazel แสดงสัญญาณ SIGQUIT (kill -3 $(bazel info server_pid)) เพื่อรับชุดข้อความ
ดัมพ์ในไฟล์ $(bazel info output_base)/server/jvm.out
เนื่องจากคุณอาจเรียกใช้ bazel info ไม่ได้หาก bazel ถูกแขวนไว้
ไดเรกทอรี output_base มักจะเป็นไดเรกทอรีระดับบนของ bazel-<workspace>
symlink ในไดเรกทอรี 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", "assessTargetPatterns" และ "runAnalysisPhase"Service Thread: แสดงการหยุดให้บริการชั่วคราวสำหรับการเก็บรวบรวมขยะขนาดเล็กและใหญ่ (GC)
แถวอื่นๆ แสดงชุดข้อความ Bazel และแสดงกิจกรรมทั้งหมดในชุดข้อความนั้น
ปัญหาด้านประสิทธิภาพที่พบบ่อย
เมื่อวิเคราะห์โปรไฟล์ประสิทธิภาพ ให้มองหาข้อมูลต่อไปนี้
- ช้ากว่าช่วงการวิเคราะห์ที่คาดไว้ (
runAnalysisPhase) โดยเฉพาะเมื่อ งานสร้างที่เพิ่มขึ้นเรื่อยๆ ซึ่งอาจเป็นสัญญาณของการใช้กฎที่ไม่มีคุณภาพ ตัวอย่าง 1 ที่ปรับค่าให้คงที่ การโหลดแพ็กเกจอาจช้าเนื่องจาก มีเป้าหมายมากเกินไป มาโครที่ซับซ้อน หรือการหมุนวนซ้ำ - การดำเนินการที่ช้าแต่ละรายการ โดยเฉพาะการดำเนินการในเส้นทางสำคัญ อาจจะเป็น
เพื่อแยกการทำงานขนาดใหญ่ออกเป็นการทำงานย่อยๆ หลายรายการ หรือลด
ชุดทรัพยากร 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
วิธีการทำโปรไฟล์นี้ประกอบด้วยสองขั้นตอน ขั้นแรกคุณต้องเรียกใช้
ตัวอย่างเช่น สร้าง/ทดสอบด้วยแฟล็ก --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 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)
ดูว่าหน่วยความจำที่ใช้ไปไหนโดยการสร้างไฟล์ 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)