このページでは、永続ワーカーの使用方法、メリット、要件、 サンドボックス化にワーカーが及ぼす影響を確認できます
永続ワーカーは、Bazel サーバーが開始する長時間実行プロセスです。実際のツール（通常はコンパイラ）のラッパーとして機能するか、ツール自体です。永続ワーカーのメリットを享受するには、ツールが連続したコンパイルをサポートしている必要があります。また、ラッパーは、ツールの API と後述のリクエスト / レスポンス形式を変換する必要があります。同じワーカーが、同じビルドで --persistent_worker フラグの有無にかかわらず呼び出される場合があります。このワーカーは、ツールを適切に起動して通信し、終了時にワーカーをシャットダウンする責任があります。各ワーカー インスタンスには
別の作業ディレクトリに（ただし chroot はされません）
<outputBase>/bazel-workers。
永続ワーカーを使用することは、起動のオーバーヘッドを減らし、より多くの JIT コンパイルを可能にし、アクション実行の抽象構文木などのキャッシュを有効にする実行戦略です。この戦略では、長時間実行プロセスに複数のリクエストを送信することで、これらの改善を実現します。
永続ワーカーは、Java、Scala、Kotlin など、複数の言語で実装されています。
NodeJS ランタイムを使用するプログラムでは、 @bazel/worker ヘルパー ライブラリを ワーカー プロトコルを実装する必要があります。
永続ワーカーを使用する
Bazel 0.27 以降では、ビルドの実行時にデフォルトで永続ワーカーが使用されますが、リモート実行が優先されます。永続ワーカーをサポートしていないアクションの場合、Bazel はアクションごとにツール インスタンスを開始します。明示的に
worker を設定して、ビルドが永続ワーカーを使用するように設定します。
該当するツールの戦略
できます。ベスト プラクティスとして、この例では worker 戦略へのフォールバックとして local を指定しています。
bazel build //my:target --strategy=Javac=worker,local
ローカル戦略ではなくワーカー戦略を使用すると、実装に応じてコンパイル速度が大幅に向上する場合があります。Java の場合、ビルドは 2 ～ 4 になります。 より高速になり、場合によっては増分コンパイルの際に増加します。Bazel のコンパイルは、 ワーカーの実行速度が約 2.5 倍向上しました詳しくは、 ワーカー数の選択できます。
ローカル ビルド環境と一致するリモート ビルド環境もある場合は、リモート実行とワーカー実行を競合させる試験運用版の動的戦略を使用できます。動的画像アセットを
渡すには、
--experimental_spawn_scheduler
設定されます。この戦略ではワーカーが自動的に有効になるため、worker 戦略を指定する必要はありませんが、local または sandboxed をフォールバックとして使用できます。
ワーカー数の選択
ニーモニックあたりのワーカー インスタンスのデフォルト数は 4 ですが、調整できます
新しい
worker_max_instances
設定されます。使用可能な CPU を有効活用することと、JIT コンパイルとキャッシュヒットの量との間にはトレードオフがあります。ワーカーが増えると、
JIT されていないコードの実行やコールド ヒットが発生するため、
キャッシュです。ビルドするターゲットが少ない場合、1 つのワーカーでコンパイル速度とリソース使用量の最適なトレードオフが得られる場合があります（問題 #8586 などをご覧ください）。worker_max_instances フラグは、メモニカとフラグセットあたりのワーカー インスタンスの最大数を設定します（後述）。混在システムでは、デフォルト値のままにすると、かなりのメモリを使用する可能性があります。増分ビルドの場合、複数のワーカー インスタンスのメリットはさらに小さくなります。
このグラフは、64 GB の RAM を搭載した 6 コア ハイパースレッドの Intel Xeon 3.5 GHz Linux ワークステーションでの Bazel（ターゲット //src:bazel）のゼロからのコンパイル時間を示しています。ワーカー構成ごとに 5 つのクリーンビルドが実行され、
最後の 4 つの平均が
使われます
図 1. クリーンビルドのパフォーマンス向上のグラフ。
この構成では、2 つのワーカーが最速のコンパイルを行いますが、それでも 14% にすぎません。 向上します必要な場合は 1 つのワーカーが メモリの使用量が減ります
通常、増分コンパイルはさらに効果的です。クリーンビルドは比較的まれですが、コンパイル間で単一のファイルを変更することは、特にテスト駆動開発で一般的です。上の例では、Java 以外の言語も 追加のコンパイル時間に影響が及ぶおそれがあるからです。
Java ソースのみを再コンパイルする
(//src/main/java/com/google/devtools/build/lib/bazel:BazelServer_deploy.jar)
terraform plan または terraform apply で
AbstractContainerizingSandboxedSpawn.java
3 倍の高速化（1 回のウォームアップ ビルドで平均 20 個の増分ビルド）
破棄される）:
図 2. 増分ビルドのパフォーマンス向上のグラフ。
速度の速さは、変更内容によって変わります。6 分の 1 の高速化は 上記の状況で、よく使用される定数が変更された場合に測定されます。
永続ワーカーの変更
渡すには、
--worker_extra_flag
ワーカーに起動フラグを指定するフラグ。キーがニモニックです。たとえば
--worker_extra_flag=javac=--debug を渡すと、Javac に対してのみデバッグが有効になります。
worker フラグは、このフラグの使用ごとに 1 つだけ設定できます。また、1 つのニーモニックに対してのみ設定できます。
ワーカーは、各メモニカだけでなく、起動フラグの違いごとに個別に作成されます。ニモニックとスタートアップの各組み合わせは
フラグは WorkerKey に結合され、WorkerKey ごとに最大
worker_max_instances ワーカーが作成される可能性があります。アクションの構成で設定フラグを指定する方法については、次のセクションをご覧ください。
--high_priority_workers フラグを使用して、通常の優先度のメモニカよりも優先して実行するメモニカを指定できます。これにより、常にクリティカル パスにあるアクションに優先順位を付けることができます。優先度の高いワーカーが 2 つ以上リクエストを実行している場合、他のすべてのワーカーは実行されません。このフラグは複数回使用できます。
--worker_sandboxing フラグを渡すと、各ワーカー リクエストはすべての入力に個別のサンドボックス ディレクトリを使用します。サンドボックスの設定には、特に macOS で時間がかかりますが、正確性が保証されます。
「
--worker_quit_after_build
フラグは主にデバッグとプロファイリングに役立ちます。このフラグは、すべてのワーカーを
終了します。また、
--worker_verbose～
ワーカーの動作に関するより多くの出力を取得できますこのフラグは WorkRequest の verbosity フィールドに反映され、ワーカーの実装も詳細にできます。
ワーカーは、次の目的で、ログを <outputBase>/bazel-workers ディレクトリに保存します。
例
/tmp/_bazel_larsrc/191013354bebe14fdddae77f2679c3ef/bazel-workers/worker-1-Javac.log。
ファイル名には、ワーカー ID とニーモニックが含まれています。メモニカごとに複数の WorkerKey が存在する可能性があるため、特定のメモニカに worker_max_instances ログファイルが複数表示されることがあります。
Android ビルドについては、Android ビルドのパフォーマンス ページで詳細をご覧ください。
永続ワーカーの実装
ワーカーの作成方法の詳細については、永続ワーカーを作成するをご覧ください。
次の例は、JSON を使用するワーカーの Starlark 構成を示しています。
args_file = ctx.actions.declare_file(ctx.label.name + "_args_file")
ctx.actions.write(
output = args_file,
content = "\n".join(["-g", "-source", "1.5"] + ctx.files.srcs),
)
ctx.actions.run(
mnemonic = "SomeCompiler",
executable = "bin/some_compiler_wrapper",
inputs = inputs,
outputs = outputs,
arguments = [ "-max_mem=4G", "@%s" % args_file.path],
execution_requirements = {
"supports-workers" : "1", "requires-worker-protocol" : "json" }
)
この定義では、このアクションの最初の用途は、
コマンドライン /bin/some_compiler -max_mem=4G --persistent_worker を使用します。Foo.java をコンパイルするリクエストは次のようになります。
注: プロトコル バッファ仕様では「スネークケース」（request_id）が使用されますが、JSON プロトコルでは「キャメルケース」（requestId）が使用されます。このドキュメントでは、JSON の例ではキャメルケースを使用しますが、プロトコルに関係なくフィールドについて説明する場合はスネークケースを使用します。
{
"arguments": [ "-g", "-source", "1.5", "Foo.java" ]
"inputs": [
{ "path": "symlinkfarm/input1", "digest": "d49a..." },
{ "path": "symlinkfarm/input2", "digest": "093d..." },
],
}
ワーカーは、stdin で改行区切りの JSON 形式でこれを受け取ります（requires-worker-protocol が JSON に設定されているため）。ワーカーはアクションを実行し、JSON 形式の WorkResponse を stdout で Bazel に送信します。次に Bazel
このレスポンスを解析し、手動で WorkResponse proto に変換します。JSON ではなくバイナリでエンコードされた protobuf を使用して関連するワーカーと通信するには、次のように requires-worker-protocol を proto に設定します。
execution_requirements = {
"supports-workers" : "1" ,
"requires-worker-protocol" : "proto"
}
実行要件に requires-worker-protocol を含めない場合は、次のようになります。
Bazel では、デフォルトで protobuf を使用するようにワーカー通信を行います。
Bazel は、ニーモニックと共有フラグから WorkerKey を取得しているため、
別のワーカーで max_mem パラメータを変更することで、
使用される値ごとに生成されます。そのため、次の場合にメモリが過剰に消費されることがあります。
あまりに多くのバリエーションを
使用することはありません
現在、各ワーカーが一度に処理できるリクエストは 1 つのみです。試験運用版 Multiplex Worker 機能によって、複数の 基盤となるツールがマルチスレッドであり、ラッパーが 理解してください。
イン こちらの GitHub リポジトリ Java と Python で記述されたワーカー ラッパーの例を確認できます。もし 動作している場合、 @bazel/worker パッケージ および Nodejs ワーカーの例 役立つかもしれません。
ワーカーはサンドボックスにどのように影響しますか？
デフォルトでは worker 戦略を使用すると、アクションは実行されません。
サンドボックス。local 戦略と同様です。1 対 1 の
サンドボックス内のすべてのワーカーを実行する --worker_sandboxing フラグ。各ワーカーが
ツールの実行には想定されている入力ファイルしか表示されません。それでも、キャッシュなどを通じて、リクエスト間で情報が内部的に漏洩する可能性があります。dynamic 戦略を使用するには、ワーカーをサンドボックス化する必要があります。
ワーカーでコンパイラ キャッシュを正しく使用できるように、ダイジェストが 必要があります。したがって、コンパイラまたはラッパーは、入力が ファイルを読み取る必要はありません。
不要なキャッシュを防ぐために入力ダイジェストを使用する場合でも、 サンドボックスは純粋なサンドボックスよりも厳格ではありません。ツールがサンドボックス化されてしまうため、 以前のリクエストの影響を受けた他の内部状態を保持する。
Multiplex ワーカーは、ワーカー実装でサポートされている場合にのみサンドボックス化できます。
また、このサンドボックス化は、ファイアウォール ルールの
--experimental_worker_multiplex_sandboxing フラグ。詳しくは、以下をご覧ください。
設計ドキュメントを参照）。
関連情報
永続ワーカーの詳細については、以下をご覧ください。