สำหรับเอกสารรุ่นที่เสถียร โปรดใช้รายการแบบเลื่อนลง "เอกสารที่มีเวอร์ชัน" มุมมองเริ่มต้นจะแสดงเวอร์ชันล่าสุดที่ HEAD

หน้านี้ได้รับการแปลโดย Cloud Translation API

การเพิ่มประสิทธิภาพ

เมื่อเขียนกฎ ข้อผิดพลาดด้านประสิทธิภาพที่พบบ่อยที่สุดคือการส่งข้อมูลหรือคัดลอกข้อมูลที่รวบรวมมาจากทรัพยากร 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> ในไดเรกทอรีพื้นที่ทำงาน

การทำโปรไฟล์ประสิทธิภาพ

โปรไฟล์การติดตาม JSON มีประโยชน์มากในการช่วยให้เข้าใจสิ่งที่ Bazel ใช้เวลาระหว่างการเรียกใช้ได้อย่างรวดเร็ว

ธง --experimental_command_profile อาจใช้เพื่อจับภาพโปรไฟล์โปรแกรมอัดเสียง Java Flighter ประเภทต่างๆ (เวลา CPU, เวลาจริง, การจัดสรรหน่วยความจำ และการช่วงชิงล็อก)

แฟล็ก --starlark_cpu_profile อาจใช้เพื่อเขียนโปรไฟล์ Pprof ของการใช้งาน CPU โดยเทรด Starlark ทั้งหมด

การทำโปรไฟล์หน่วยความจำ

Bazel มาพร้อมกับเครื่องมือสร้างโปรไฟล์หน่วยความจำในตัวที่ช่วยให้คุณตรวจสอบการใช้หน่วยความจำของกฎได้ หากมีปัญหา คุณสามารถดัมพ์ฮีปเพื่อหาบรรทัดโค้ดที่ทำให้เกิดปัญหา

การเปิดใช้การติดตามหน่วยความจำ

คุณต้องส่งแฟล็กเริ่มต้น 2 รายการต่อไปนี้ไปยังการเรียกใช้ 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)

ดูว่าหน่วยความจำจะอยู่ที่ใดด้วยการสร้างไฟล์ 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)