パフォーマンスの最適化

問題を報告open_in_new ソースを表示open_in_new

ルールを作成する際に、依存関係から蓄積されたデータの走査またはコピーは、パフォーマンス低下の最も一般的な原因となります。ビルド全体にこれらのオペレーションを集約すると、O(N^2) の時間またはスペースを要する結果になります。これを回避するには、依存関係を効果的に使用する方法を理解することが重要です。

これを正しく行うのは難しいため、Bazel には、間違いを犯した可能性のある場所を見つけるのに役立つメモリ プロファイラも用意されています。注意: 非効率的なルールを作成することのコストは、それが広く使用されるまで明らかにならない場合があります。

依存関係を使用する

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

depset は情報をネストグラフとして表現し、共有を可能にします。

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

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

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

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.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])

コマンドラインに setIamPolicy.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

推移的アクションの入力は depset にする

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

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 には、ルールのメモリ使用量の確認に役立つメモリ プロファイラが組み込まれています。問題が発生した場合は、ヒープをダンプして、問題の原因となっているコードの正確な行を見つけることができます。

メモリ トラッキングを有効にする

すべての Bazel 呼び出しに次の 2 つの起動フラグを渡す必要があります。

  STARTUP_FLAGS=\
  --host_jvm_args=-javaagent:<path to java-allocation-instrumenter-3.3.0.jar> \
  --host_jvm_args=-DRULE_MEMORY_TRACKER=1

これにより、サーバーがメモリ トラッキング モードで起動します。Bazel の呼び出しで 1 回でもこれらを忘れると、サーバーが再起動するため、最初からやり直す必要があります。

Memory Tracker を使用する

例として、ターゲットの 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 を取得します。

最もホットなコールサイトのテキストダンプを 1 行で取得します。

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