最佳化效能

回報問題 查看原始碼

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

要正確執行操作可能並不容易,因此 Bazel 也會提供記憶體分析器,以助您找出自己可能犯錯的地方。請留意:在廣泛使用之前,編寫效率低落的規則可能付出代價。

使用 depset

從規則依附元件取得資訊時,您應使用 depsets。請只使用純清單或索引,將本機資訊發布至目前規則。

虛設常式以巢狀結構圖表示資訊,允許共用。

請參考以下圖表:

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()

您可以使用 to_list() 將 depset 強制轉換為精簡清單,但這通常會產生 O(N^2) 成本。如果可以,請盡量避免為了偵錯目的而分割空白集。

常見的誤解是,如果只在頂層目標 (例如 <xx>_binary 規則) 上進行自由分割,即可自由壓平,因為費用不會在建構圖的每個層級上累計。但是當您建構具有重疊依附元件的一組目標時,這「仍然」是 O(N^2)。當您建構測試 //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() 為你展開。 如果需要對記憶體不足內容進行轉換,請查看 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 欄位會接受解碼器。每當系統間接從依附元件收集輸入內容時,請使用此選項。

inputs = depset(...)
ctx.actions.run(
  inputs = inputs,  # Do *not* turn inputs into a list
  ...
)

懸掛式

如果 Bazel 似乎停止運作,您可以按下 Ctrl-\ 鍵或傳送 SIGQUIT 信號 (kill -3 $(bazel info server_pid)),在 $(bazel info output_base)/server/jvm.out 檔案中取得執行緒傾印。

由於 bazel 掛斷時您可能無法執行 bazel info,因此 output_base 目錄通常是工作區目錄中 bazel-<workspace> 符號連結的父項。

效能分析

JSON 追蹤記錄設定檔可協助您快速瞭解 Bazel 在叫用期間花費什麼時間。

--experimental_command_profile 旗標可用於擷取各種類型 (CPU 時間、實際時間、記憶體配置和鎖定爭用) 的 Java 航班錄音工具設定檔。

--starlark_cpu_profile 旗標可用來編寫所有 Starlark 執行緒的 CPU 使用率剖析設定檔。

記憶體分析

Bazel 內建記憶體分析器,可協助您檢查規則的記憶體用量。如果發生問題,您可以轉儲記憶體快照,找出造成問題的確切程式碼行。

啟用記憶體追蹤

您必須將下列兩個啟動標記傳送給「每個」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)

使用 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)