最佳化效能

回報問題 查看來源 Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

撰寫規則時,最常見的效能陷阱是遍歷或複製從依附元件累積的資料。如果匯總整個建構作業,這些作業很容易就會耗費 O(N^2) 的時間或空間。為避免這種情況,請務必瞭解如何有效使用 depset。

這項作業可能很難正確完成,因此 Bazel 也提供記憶體剖析器,協助您找出可能出錯的地方。警告: 低效率規則的成本可能要到廣泛使用後才會顯現。

使用 depsets

從規則依附元件匯總資訊時,請一律使用 depset。只能使用純清單或字典發布目前規則的本機資訊。

depsset 會以巢狀圖的形式呈現資訊,方便您分享。

請參考下圖:

C -> B -> A
D ---^

每個節點都會發布單一字串。使用 depsets 時,資料會如下所示:

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' 出現了四次!圖表越大,這個問題就越嚴重。

以下是規則實作範例,其中正確使用 depsets 發布遞移資訊。請注意,如果您想使用清單發布規則本機資訊,是可以的,因為這不是 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() 強制將 depset 轉換為扁平清單,但這麼做通常會導致 O(N^2) 成本。如果可以,請避免將 depsets 扁平化,除非是為了偵錯。

一般常見的誤解是,如果只在頂層目標 (例如 <xx>_binary 規則) 中執行此操作,您就可以隨意扁平化 depsets,因為這樣一來,費用就不會累積在建構圖的每個層級中。但如果建構一組具有重疊依附元件的目標,這仍然是 O(N^2)。建構測試 //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()。這會將任何 depsets 的擴充作業延後至執行階段。

除了速度更快之外,這也會減少規則的記憶體耗用量,有時甚至可減少 90% 以上。

以下提供幾個訣竅:

  • 請直接將 depsets 和清單做為引數傳遞,而不是自行將其扁平化。ctx.actions.args() 會為你擴充這些主題。 如果需要對 deps 集合內容進行任何轉換,請查看 ctx.actions.args#add,確認是否有符合需求的項目。

  • 您是否將 File#path 做為引數傳遞?不需要。任何檔案都會自動轉換為路徑,並延遲至擴充時間。

  • 請避免將字串串連在一起來建構字串。 最佳字串引數是常數,因為規則的所有執行個體都會共用其記憶體。

  • 如果引數過長,無法在指令列中輸入,可以使用 ctx.actions.args#use_param_file,有條件或無條件地將 ctx.actions.args() 物件寫入參數檔案。執行動作時,系統會在幕後完成這項作業。如要明確控管參數檔案,可以使用 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

轉換動作輸入內容應為 depsets

使用 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 停止回應,您可能無法執行 bazel info,因此 output_base 目錄通常是工作區目錄中 bazel-<workspace> 符號連結的父項。

效能分析

JSON 追蹤設定檔非常實用,可快速瞭解 Bazel 在叫用期間耗費的時間。

--experimental_command_profile 標記可用於擷取各種 Java Flight Recorder 設定檔 (CPU 時間、實際時間、記憶體配置和鎖定爭用)。

--starlark_cpu_profile 標記可用於寫入所有 Starlark 執行緒的 CPU 使用率 pprof 設定檔。

記憶體用量分析

Bazel 內建記憶體分析器,可協助您檢查規則的記憶體用量。如有問題,您可以傾印堆積,找出造成問題的確切程式碼行。

啟用記憶體追蹤功能

您必須將這兩個啟動標記傳遞至每個 Bazel 叫用:

  STARTUP_FLAGS=\
  --host_jvm_args=-javaagent:<path to java-allocation-instrumenter-3.3.4.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)