このページでは、永続ワーカーの使用方法、メリット、要件、 サンドボックス化にワーカーが及ぼす影響を確認できます
永続ワーカーは、Bazel サーバーが開始する長時間実行プロセスです。実際のツール（通常はコンパイラ）のラッパーとして機能するか、ツール自体です。永続ワーカーのメリットを享受するには、ツールが連続したコンパイルをサポートしている必要があります。また、ラッパーは、ツールの API と後述のリクエスト / レスポンス形式を変換する必要があります。同じワーカーが、同じビルドで --persistent_worker フラグの有無にかかわらず呼び出される場合があります。このワーカーは、ツールを適切に起動して通信し、終了時にワーカーをシャットダウンする責任があります。各ワーカー インスタンスには、<outputBase>/bazel-workers の下の個別の作業ディレクトリが割り当てられます（ただし、chroot はされません）。
永続ワーカーを使用することは、起動のオーバーヘッドを減らし、より多くの JIT コンパイルを可能にし、アクション実行の抽象構文木などのキャッシュを有効にする実行戦略です。この戦略 これらの改善を実現するには、複数のリクエストを長時間実行 プロセスです
NodeJS ランタイムを使用するプログラムでは、 @bazel/worker ヘルパー ライブラリを ワーカー プロトコルを実装する必要があります。
永続ワーカーの使用
Bazel 0.27 以降
ビルド実行時にデフォルトで永続ワーカーを使用するが、リモート
実行が優先されます。永続ワーカーをサポートしていないアクションの場合、Bazel はアクションごとにツール インスタンスを開始します。永続ワーカーを使用するようにビルドを明示的に設定するには、該当するツールの頭字語に worker 戦略を設定します。ベスト プラクティスとして、この例では、local を
worker 戦略にフォールバックします。
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 フラグは、インスタンスあたりのワーカー インスタンスの最大数を設定します。
ニモニックとフラグセットの両方を使用するため（下記参照）、これらが混在するシステムでは、
多くのメモリを消費します増分ビルドの場合、複数のワーカー インスタンスのメリットはさらに小さくなります。
このグラフは、Bazel（ターゲット）のゼロからのコンパイル時間を示しています。
//src:bazel など）を 6 コアのハイパー スレッド Intel Xeon 3.5 GHz Linux ワークステーションで実行
64GB の RAM を搭載していますワーカー構成ごとに 5 件のクリーンビルドが実行され、最後の 4 件の平均が使用されます。
図 1. クリーンビルドのパフォーマンス向上のグラフ。
この構成では、2 つのワーカーが最も高速なコンパイルを実現しますが、1 つのワーカーと比較してわずか 14% の改善にしかなりません。必要な場合は 1 つのワーカーが メモリの使用量が減ります
一般的に、増分コンパイルの方が大きなメリットがあります。クリーンビルドは比較的まれですが、コンパイル間で単一のファイルを変更することは、特にテスト駆動開発で一般的です。上の例では、Java 以外の言語も 追加のコンパイル時間に影響が及ぶおそれがあるからです。
AbstractContainerizingSandboxedSpawn.java で内部文字列定数を変更した後に Java ソースのみ（//src/main/java/com/google/devtools/build/lib/bazel:BazelServer_deploy.jar）を再コンパイルすると、3 倍の速度向上（平均 20 回の増分ビルド、1 回のウォームアップ ビルドを破棄）が得られます。
図 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
フラグを指定すると、各ワーカー リクエストで、そのすべてのリクエストに対して
できます。サンドボックスのセットアップには時間がかかります。
精度が保証されます。
「
--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 または
1 つのニモニックに対して
ログファイルを 1 つ作成します
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 つのみです。試験運用版のマルチプレックス ワーカー機能を使用すると、基盤となるツールがマルチスレッドであり、ラッパーがこれを認識するように設定されている場合に、複数のスレッドを使用できます。
イン こちらの GitHub リポジトリ Java と Python で記述されたワーカー ラッパーの例を確認できます。もし 動作している場合、 @bazel/worker パッケージ および Nodejs ワーカーの例 役立つかもしれません。
ワーカーはサンドボックスにどのように影響しますか？
デフォルトでは worker 戦略を使用すると、アクションは実行されません。
サンドボックス。local 戦略と同様です。1 対 1 の
サンドボックス内のすべてのワーカーを実行する --worker_sandboxing フラグ。各ワーカーが
ツールの実行には想定されている入力ファイルしか表示されません。それでも、キャッシュなどを通じて、リクエスト間で情報が内部的に漏洩する可能性があります。dynamic 戦略を使用するには、ワーカーをサンドボックス化する必要があります。
ワーカーでコンパイラ キャッシュを正しく使用できるように、ダイジェストが 必要があります。したがって、コンパイラまたはラッパーは、入力が ファイルを読み取る必要はありません。
入力ダイジェストを使用して不要なキャッシュを防ぐ場合でも、サンドボックス化されたワーカーは、ツールが以前のリクエストの影響を受けた他の内部状態を保持する可能性があるため、純粋なサンドボックスよりも厳格なサンドボックス化を提供しません。
Multiplex ワーカーは、ワーカー実装でサポートされている場合にのみサンドボックス化できます。
また、このサンドボックス化は、ファイアウォール ルールの
--experimental_worker_multiplex_sandboxing フラグ。詳しくは、設計ドキュメントをご覧ください）。
関連情報
永続ワーカーの詳細については、以下をご覧ください。