ルールを作成する際に、依存関係から蓄積されたデータの走査またはコピーは、パフォーマンス低下の最も一般的な原因となります。ビルド全体にこれらのオペレーションを集約すると、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> シンボリック リンクの親です。
パフォーマンス プロファイリング
デフォルトでは、Bazel は出力ベースの command.profile.gz に JSON プロファイルを書き込みます。ロケーションは --profile フラグで構成できます（例: --profile=/tmp/profile.gz）。末尾が .gz のロケーションは、GZIP で圧縮されます。
結果を確認するには、Chrome ブラウザのタブで chrome://tracing を開き、[読み込み] をクリックして、（圧縮されている可能性のある）プロファイル ファイルを選択します。詳細な結果を表示するには、左下のボックスをクリックします。
次のキーボード コントロールを使用して操作できます。
- 「選択」モードにするには
1キーを押します。このモードでは、特定のボックスを選択してイベントの詳細を調べることができます（左下隅を参照）。概要と集計データを確認するには、複数のイベントを選択してください。 - 「パン」モードにするには
2キーを押します。マウスをドラッグしてビューを動かします。a/dを使用して左右に移動することもできます。 - 「ズーム」モードにするには
3キーを押します。マウスをドラッグしてズームします。w/sを使用してズームイン/ズームアウトすることもできます。 - 2 つのイベント間の距離を測定できる「タイミング」モードで
4を押します。 ?キーを押すと、すべてのコントロールが表示されます。
プロフィール情報
プロファイルの例:
図 1. プロファイルの例。
次のような特殊な行があります。
action counters: 処理中の同時実行アクションの数が表示されます。これをクリックすると、実際の値が表示されます。クリーンビルドでは--jobsの値まで増やす必要があります。cpu counters: ビルドの 1 秒ごとに、Bazel によって使用されている CPU の量を表示します（値 1 は 1 つのコアが 100% ビジー状態であることに相当します）。Critical Path: クリティカル パス上のアクションごとに 1 つのブロックを表示します。grpc-command-1: Bazel のメインスレッド。「Launch Bazel」、「evaluateTargetPatterns」、「runAnalysisPhase」など、Bazel による処理の概要を把握するために役立ちます。Service Thread: マイナーおよびメジャー ガベージ コレクション（GC）の一時停止を表示します。
その他の行は Bazel スレッドを表し、そのスレッドのすべてのイベントが表示されます。
パフォーマンスに関する一般的な問題
パフォーマンス プロファイルを分析する際は、次の点を確認します。
- 特に増分ビルドで、想定よりも遅い分析フェーズ（
runAnalysisPhase）。これは、不適切なルール実装の兆候である可能性があります（たとえば、依存関係をフラット化しているケースなど）。パッケージの読み込みは、大量のターゲット、複雑なマクロ、再帰的な glob によって遅くなることがあります。 - 個々の遅いアクション（特にクリティカル パス上のアクション）。大規模なアクションを複数の小さなアクションに分割したり、（推移的な）依存関係のセットを減らして動作を高速化したりする可能性があります。
PROCESS_TIME以外（REMOTE_SETUPやFETCHなど）が異常に多いかどうかも確認してください。 - ボトルネック（少数のスレッド）がビジー状態となり、他のスレッドはすべてアイドル状態で結果を待機しています（上のスクリーンショットの 15 ～ 30 秒程度）。これを最適化するには、ほとんどの場合、ルールの実装または Bazel 自体を変更して並列処理を強化します。これは、GC の量が異常である場合にも発生することがあります。
プロファイルのファイル形式
トップレベル オブジェクトには、メタデータ（otherData）と実際のトレースデータ（traceEvents）が含まれます。メタデータには、呼び出し ID や Bazel 呼び出しの日付などの追加情報が含まれます。
例:
{
"otherData": {
"build_id": "101bff9a-7243-4c1a-8503-9dc6ae4c3b05",
"date": "Tue Jun 16 08:30:21 CEST 2020",
"output_base": "/usr/local/google/_bazel_johndoe/573d4be77eaa72b91a3dfaa497bf8cd0"
},
"traceEvents": [
{"name":"thread_name","ph":"M","pid":1,"tid":0,"args":{"name":"Critical Path"}},
{"cat":"build phase marker","name":"Launch Bazel","ph":"X","ts":-1824000,"dur":1824000,"pid":1,"tid":60},
...
{"cat":"general information","name":"NoSpawnCacheModule.beforeCommand","ph":"X","ts":116461,"dur":419,"pid":1,"tid":60},
...
{"cat":"package creation","name":"src","ph":"X","ts":279844,"dur":15479,"pid":1,"tid":838},
...
{"name":"thread_name","ph":"M","pid":1,"tid":11,"args":{"name":"Service Thread"}},
{"cat":"gc notification","name":"minor GC","ph":"X","ts":334626,"dur":13000,"pid":1,"tid":11},
...
{"cat":"action processing","name":"Compiling third_party/grpc/src/core/lib/transport/status_conversion.cc","ph":"X","ts":12630845,"dur":136644,"pid":1,"tid":1546}
]
}
トレース イベントのタイムスタンプ（ts）と期間（dur）はマイクロ秒単位です。カテゴリ（cat）は ProfilerTask の列挙値の一つです。非常に短く互いに近いイベントについては、マージされることに注意してください。イベントのマージを防ぐには、--noslim_json_profile を渡してください。
Chrome トレース イベント形式の仕様もご覧ください。
分析プロファイル
このプロファイリング方法は 2 つのステップに分かれています。まず、--profile フラグを使用してビルド/テストを実行する必要があります。
$ bazel build --profile=/tmp/prof //path/to:target
生成されるファイル（この場合は /tmp/prof）はバイナリ ファイルであり、analyze-profile コマンドで後処理して分析できます。
$ bazel analyze-profile /tmp/prof
デフォルトでは、指定したプロファイル データファイルの要約分析情報が出力されます。これには、各ビルドフェーズのさまざまなタスクタイプの累積統計や、クリティカル パスの分析が含まれます。
デフォルトの出力の最初のセクションには、さまざまなビルドフェーズにかかった時間の概要が表示されます。
INFO: Profile created on Tue Jun 16 08:59:40 CEST 2020, build ID: 0589419c-738b-4676-a374-18f7bbc7ac23, output base: /home/johndoe/.cache/bazel/_bazel_johndoe/d8eb7a85967b22409442664d380222c0
=== PHASE SUMMARY INFORMATION ===
Total launch phase time 1.070 s 12.95%
Total init phase time 0.299 s 3.62%
Total loading phase time 0.878 s 10.64%
Total analysis phase time 1.319 s 15.98%
Total preparation phase time 0.047 s 0.57%
Total execution phase time 4.629 s 56.05%
Total finish phase time 0.014 s 0.18%
------------------------------------------------
Total run time 8.260 s 100.00%
Critical path (4.245 s):
Time Percentage Description
8.85 ms 0.21% _Ccompiler_Udeps for @local_config_cc// compiler_deps
3.839 s 90.44% action 'Compiling external/com_google_protobuf/src/google/protobuf/compiler/php/php_generator.cc [for host]'
270 ms 6.36% action 'Linking external/com_google_protobuf/protoc [for host]'
0.25 ms 0.01% runfiles for @com_google_protobuf// protoc
126 ms 2.97% action 'ProtoCompile external/com_google_protobuf/python/google/protobuf/compiler/plugin_pb2.py'
0.96 ms 0.02% runfiles for //tools/aquery_differ aquery_differ
メモリのプロファイリング
Bazel には、ルールのメモリ使用量の確認に役立つメモリ プロファイラが組み込まれています。問題が発生した場合は、ヒープをダンプして、問題の原因となっているコードの正確な行を見つけることができます。
メモリ トラッキングを有効にする
すべての Bazel 呼び出しに次の 2 つの起動フラグを渡す必要があります。
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
これにより、サーバーがメモリ トラッキング モードで起動します。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)