BazelCon 2024 登録の受け付けを開始しました。

このページは Cloud Translation API によって翻訳されました。

パフォーマンスの最適化

<ph type="x-smartling-placeholder"></ph> 問題を報告するソースを表示夜間 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

ルールを記述する際のパフォーマンス上の問題として最も一般的なのは、トラバースまたはコピーです。依存関係から蓄積したデータ全体として集計する場合場合、これらのオペレーションには O(N^2) 時間またはスペースが簡単にかかる可能性があります。これを回避するには、依存関係を効果的に使用する方法を理解するうえで非常に重要です。

これを適切にするのは難しい場合があるため、Bazel ではメモリプロファイラも用意されています。は、誤りの可能性がある箇所を見つけるのに役立ちます。注意: 非効率的なルールを記述した場合のコストは、あります。

依存関係を使用する

ルールの依存関係の情報を統合する場合は、 depsets。プレーンなリストまたは辞書のみを使用して情報をパブリッシュする適用できます。

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) になります。できます。デバッグ時以外は、Depset のフラット化は可能な限り避けるあります。

よくある誤解は、自分でやるだけで依存関係を自由にフラット化できる、というものです。 <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])

このコードは簡単に置き換えることができます。まず、推移的 depset を収集し、一度にすべてを統合します。

transitive = []

for i in inputs:
    transitive.append(i.deps)

x = depset(transitive = transitive)

これは、リストの理解を使用することで軽減できる場合があります。

x = depset(transitive = [i.deps for i in inputs])

コマンドラインに gsuite.actions.args() を使用する

コマンドラインを作成するときは、ctx.actions.args() を使用してください。これにより、依存関係が実行フェーズまで展開されます。

これにより、厳密に高速になるほかに、VM のメモリ消費量が場合によっては 90% 以上も削減できます。

コツをご紹介します。

依存関係とリストをフラット化するのではなく、引数として直接渡すできます。ctx.actions.args() 拡張されます。依存関係のコンテンツに対して変換が必要な場合は、 ctx.actions.args#add を使用して、自分に適したものがあるかどうかを確認します。
File#path を引数として渡していますか？必要ない。制限なし File は自動的に path が、展開時間まで延期される。
文字列を連結して構成しないようにします。メモリはリソース間で共有されるため、最適な文字列引数は定数である表示されます。
コマンドラインに対して引数が長すぎる場合は、ctx.actions.args() オブジェクトパラメータファイルには、条件付きまたは無条件に、 ctx.actions.args#use_param_file。これは、行われます。インフラストラクチャの params ファイルを制御します。 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 の dump で確認します。

bazel がハングしていると bazel info を実行できない可能性があるため、 output_base ディレクトリは通常、bazel-<workspace> の親です。シンボリックリンクを作成します。

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

JSON トレースプロファイルは、呼び出し中に Bazel が時間を費やした時間をすばやく把握できます。

メモリのプロファイリング

Bazel には Memory Profiler が組み込まれており、ルールのチェックに役立つメモリ使用率が高くなります。問題がある場合は、ヒープをダンプして問題を引き起こしているコードの行を正確に特定します。

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

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

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

これらのコマンドにより、サーバーがメモリトラッキングモードで起動します。2023 年中に設定を忘れてしまった場合でも 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 ツールを使用してヒープを調査します。手始めに、 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)