パフォーマンスの最適化

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
問題を報告する ソースを表示

ルールを記述する際のよくある問題は、依存関係から蓄積されたデータを走査またはコピーすることです。ビルド全体で集計すると、このオペレーションでは O(N^2) の時間やスペースを簡単に消費できます。これを防ぐには、デプスを効果的に使用する方法を理解することが重要です。

正確に把握するのは難しい場合があるため、Bazel はメモリ プロファイラも提供しており、誤って間違った場所を見つけやすくなります。警告: 非効率的なルールを作成するコストは、広く使用されるまでは明らかにならない可能性があります。

Depset を使用する

ルールの依存関係から情報をロールアップするたびに、デプセットを使用する必要があります。現在のルールのローカル情報を公開する場合は、書式なしリストまたは辞書のみを使用してください。

委譲セットは、情報をネストされたグラフで表し、共有を可能にする

次のグラフについて考えてみましょう。

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

各ノードは 1 つの文字列をパブリッシュします。デプトを使用した場合、データは次のようになります。

a = depset(direct=['a'])
b = depset(direct=['b'], transitive=[a])
c = depset(direct=['c'], transitive=[b])
d = depset(direct=['d'], transitive=[b])

それぞれの項目について 1 回だけ言及します。リストを使用すると、次のようになります。

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) です。これは、テスト //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 を引数として渡していますか?不要。任意の File は自動的にパスに変換され、展開時間まで延期されます。

  • 文字列を連結して構築することは避けてください。最適な文字列引数は定数で、ルールのすべてのインスタンス間でメモリが共有されます。

  • コマンドラインで引数が長すぎる場合は、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

推移的アクションの入力はデプトにする必要があります

ctx.actions.run を使用してアクションを作成する場合は、inputs フィールドがデプトを受け入れることを忘れないでください。これは、依存関係から推移的に入力を収集する際に使用します。

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 がハングアップすると bazel info を実行できなくなる可能性があるため、output_base ディレクトリは通常、ワークスペース ディレクトリにある bazel-<workspace> シンボリック リンクの親になります。

パフォーマンス プロファイリング

JSON トレース プロファイルは、Bazel が呼び出しに費やした時間をすばやく理解するのに便利です。

メモリ プロファイリング

Bazel には Memory Profiler が組み込まれており、ルールのメモリ使用量を確認できます。問題がある場合は、ヒープをダンプして問題の原因となっている正確なコード行を見つけることができます。

メモリ トラッキングの有効化

次の 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

サーバーがメモリ トラッキング モードで起動します。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)