Halaman ini membahas cara menggunakan pekerja persisten, manfaat, persyaratan, dan bagaimana pekerja memengaruhi sandboxing.
Pekerja persisten adalah proses yang berjalan lama yang dimulai oleh server Bazel, yang
berfungsi sebagai wrapper di sekitar alat yang sebenarnya (biasanya compiler), atau
alat itu sendiri. Untuk memperoleh manfaat dari pekerja yang gigih, alat ini harus
menjalankan urutan kompilasi, dan wrapper perlu menerjemahkan
antara API alat dan format permintaan/respons yang dijelaskan di bawah. Pekerja
yang sama dapat dipanggil dengan dan tanpa tanda --persistent_worker dalam
build yang sama, dan bertanggung jawab untuk memulai dan berkomunikasi dengan
alat dengan tepat, serta menonaktifkan pekerja saat keluar. Setiap instance pekerja ditetapkan
(tetapi tidak di-chroot ke) direktori kerja terpisah di
<outputBase>/bazel-workers.
Menggunakan pekerja persisten adalah strategi eksekusi yang mengurangi overhead pengaktifan, memungkinkan lebih banyak kompilasi JIT, dan memungkinkan penyimpanan dalam cache, misalnya hierarki sintaksis abstrak dalam eksekusi tindakan. Strategi ini akan mencapai peningkatan ini dengan mengirimkan beberapa permintaan ke {i>checkout<i}.
Pekerja persisten diimplementasikan untuk berbagai bahasa, termasuk Java, Scala, Kotlin, dan lainnya.
Program yang menggunakan runtime NodeJS dapat menggunakan library helper @bazel/worker untuk mengimplementasikan protokol pekerja.
Menggunakan pekerja persisten
Bazel 0.27 dan yang lebih tinggi
menggunakan pekerja persisten secara default saat menjalankan build, meskipun eksekusi
jarak jauh lebih diutamakan. Untuk tindakan yang tidak mendukung pekerja persisten,
Bazel kembali memulai instance alat untuk setiap tindakan. Anda dapat menetapkan build secara eksplisit
untuk menggunakan pekerja persisten dengan menetapkan strategi
worker untuk mnemonic alat
yang berlaku. Sebagai praktik terbaik, contoh ini mencakup penetapan local sebagai
kembali ke strategi worker:
bazel build //my:target --strategy=Javac=worker,local
Menggunakan strategi pekerja, bukan strategi lokal, dapat meningkatkan kecepatan kompilasi secara signifikan, bergantung pada penerapan. Untuk Java, build dapat berupa 2–4 kali lebih cepat, terkadang lebih untuk kompilasi inkremental. Mengompilasi Bazel adalah sekitar 2,5 kali lebih cepat dengan pekerja. Untuk mengetahui detail selengkapnya, lihat "Memilih jumlah pekerja" bagian.
Jika Anda juga memiliki lingkungan build jarak jauh yang cocok dengan lingkungan build lokal, Anda dapat menggunakan strategi dinamis eksperimental, yang menjalankan eksekusi jarak jauh dan eksekusi pekerja secara bersamaan. Untuk mengaktifkan fitur
strategi, meneruskan
--experimental_spawn_scheduler
penanda. Strategi ini otomatis mengaktifkan pekerja, sehingga Anda tidak perlu menentukan strategi worker, tetapi Anda tetap dapat menggunakan local atau sandboxed sebagai penggantian.
Memilih jumlah pekerja
Jumlah default worker instance per mnemonik adalah 4, tetapi dapat disesuaikan
dengan
worker_max_instances
penanda. Ada imbal balik antara pemanfaatan CPU yang tersedia dengan baik dan
kompilasi JIT dan hit cache yang Anda dapatkan. Dengan lebih banyak pekerja, lebih banyak
target akan membayar biaya startup untuk menjalankan kode non-JIT dan mengakses cache
dingin. Jika Anda memiliki sedikit target untuk dibuat, satu pekerja dapat memberikan
kompromi terbaik antara kecepatan kompilasi dan penggunaan resource (misalnya,
lihat masalah #8586.
Tanda worker_max_instances menetapkan jumlah maksimum instance pekerja per
mnemonik dan penanda (lihat di bawah), jadi dalam sistem campuran, Anda akhirnya dapat menggunakan
cukup banyak memori jika Anda
tetap menggunakan nilai {i>default<i}. Untuk build inkremental,
manfaat dari beberapa instance pekerja bahkan lebih kecil lagi.
Grafik ini menunjukkan waktu kompilasi dari awal untuk Bazel (target
//src:bazel) di workstation Linux Intel Xeon 3,5 GHz hyper-thread 6 core
dengan RAM 64 GB. Untuk setiap konfigurasi pekerja, lima build bersih dijalankan dan
rata-rata dari empat build terakhir diambil.
Gambar 1. Grafik peningkatan performa clean build.
Untuk konfigurasi ini, dua pekerja memberikan kompilasi tercepat, meskipun hanya dengan peningkatan 14% dibandingkan dengan satu pekerja. Satu pekerja adalah opsi yang baik jika Anda ingin menggunakan lebih sedikit memori.
Kompilasi inkremental biasanya memberikan manfaat yang lebih besar. Build yang bersih adalah relatif jarang, tetapi mengubah satu file antar kompilasi adalah hal biasa, di khususnya dalam pengembangan berbasis pengujian. Contoh di atas juga memiliki beberapa aplikasi non-Java tindakan pengemasan padanya yang dapat membayangi waktu kompilasi inkremental.
Mengompilasi ulang sumber Java saja
(//src/main/java/com/google/devtools/build/lib/bazel:BazelServer_deploy.jar)
setelah mengubah konstanta string internal di
AbstractContainerizingSandboxedSpawn.java
memberikan percepatan 3x lipat (rata-rata 20 build inkremental dengan satu build pemanasan
dihapus):
Gambar 2. Grafik peningkatan performa build inkremental.
Percepatan tergantung pada perubahan yang dilakukan. Percepatan faktor 6 diukur dalam situasi di atas saat konstanta yang biasa digunakan diubah.
Mengubah pekerja persisten
Anda dapat meneruskan
--worker_extra_flag
untuk menentukan flag start-up kepada pekerja, yang terkunci dengan mnemonik. Contohnya,
meneruskan --worker_extra_flag=javac=--debug akan mengaktifkan proses debug untuk Javac saja.
Hanya satu flag pekerja yang dapat ditetapkan per penggunaan flag ini, dan hanya untuk satu mnemoni.
Pekerja tidak hanya dibuat secara terpisah untuk setiap mnemonik, tetapi juga untuk
variasi di penanda awal. Setiap kombinasi mnemonik dan start-up
flag digabungkan menjadi WorkerKey, dan untuk setiap WorkerKey hingga
worker_max_instances pekerja dapat dibuat. Lihat bagian berikutnya untuk mengetahui
konfigurasi tindakan juga dapat menentukan
tanda penyiapan.
Anda dapat menggunakan flag
--high_priority_workers
untuk menentukan mnemoni yang harus dijalankan sebagai preferensi daripada mnemoni
prioritas normal. Hal ini dapat membantu memprioritaskan tindakan
yang selalu dalam tahap penting
. Jika ada dua atau lebih pekerja prioritas tinggi yang
menjalankan permintaan, semua
pekerja lain dicegah
untuk berjalan. Flag ini dapat digunakan beberapa kali.
Meneruskan flag
--worker_sandboxing
membuat setiap permintaan pekerja menggunakan direktori sandbox terpisah untuk semua
inputnya. Menyiapkan sandbox memerlukan waktu tambahan,
terutama di macOS, tetapi memberikan jaminan ketepatan yang lebih baik.
Flag
--worker_quit_after_build
terutama berguna untuk proses debug dan pembuatan profil. Flag ini memaksa semua pekerja
untuk berhenti setelah build selesai. Anda juga bisa meneruskan
--worker_verbose ke
mendapatkan lebih banyak {i>output<i} dari apa
yang dilakukan pekerja itu. Penanda ini tercermin dalam
Kolom verbosity di WorkRequest, yang memungkinkan implementasi pekerja juga
yang lebih panjang.
Pekerja menyimpan log mereka di direktori <outputBase>/bazel-workers, sebagai
contoh
/tmp/_bazel_larsrc/191013354bebe14fdddae77f2679c3ef/bazel-workers/worker-1-Javac.log.
Nama file menyertakan ID pekerja dan mnemoni. Karena dapat ada lebih dari satu WorkerKey per mnemoni, Anda mungkin melihat lebih dari worker_max_instances file log untuk mnemoni tertentu.
Untuk build Android, lihat detailnya di Halaman Android Build Performance.
Mengimplementasikan pekerja persisten
Lihat halaman membuat pekerja persisten untuk informasi selengkapnya informasi tentang cara membuat pekerja.
Contoh ini menunjukkan konfigurasi Starlark untuk pekerja yang menggunakan JSON:
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" }
)
Dengan definisi ini, penggunaan pertama
tindakan ini akan dimulai dengan mengeksekusi
command line /bin/some_compiler -max_mem=4G --persistent_worker. Permintaan
untuk mengompilasi Foo.java akan terlihat seperti:
CATATAN: Meskipun spesifikasi buffering protokol menggunakan "snake case" (request_id),
protokol JSON menggunakan "camel case" (requestId). Dalam dokumen ini, kita akan menggunakan
{i>camel case<i} dalam contoh JSON, tetapi {i>snake case<i} ketika berbicara tentang
terlepas dari protokol.
{
"arguments": [ "-g", "-source", "1.5", "Foo.java" ]
"inputs": [
{ "path": "symlinkfarm/input1", "digest": "d49a..." },
{ "path": "symlinkfarm/input2", "digest": "093d..." },
],
}
Pekerja menerimanya di stdin dalam format JSON yang dipisahkan baris baru (karena
requires-worker-protocol disetel ke JSON). Pekerja kemudian melakukan tindakan,
dan mengirimkan WorkResponse berformat JSON ke Bazel pada stdout-nya. Bazel kemudian
menguraikan respons ini dan mengonversinya secara manual menjadi proto WorkResponse. Kepada
berkomunikasi dengan pekerja terkait menggunakan protobuf yang dienkode biner, bukan
JSON, requires-worker-protocol akan ditetapkan ke proto, seperti ini:
execution_requirements = {
"supports-workers" : "1" ,
"requires-worker-protocol" : "proto"
}
Jika Anda tidak menyertakan requires-worker-protocol dalam persyaratan eksekusi,
Bazel akan menetapkan komunikasi pekerja secara default agar menggunakan protobuf.
Bazel memperoleh WorkerKey dari mnemoni dan flag bersama, sehingga jika konfigurasi ini
memungkinkan perubahan parameter max_mem, pekerja terpisah akan
dibuat untuk setiap nilai yang digunakan. Hal ini dapat menyebabkan
penggunaan memori yang berlebihan jika
terlalu banyak variasi yang digunakan.
Setiap pekerja saat ini hanya dapat memproses satu permintaan dalam satu waktu. Versi eksperimental Fitur multiplex worker memungkinkan penggunaan beberapa , jika alat yang mendasarinya adalah multi-thread dan wrapper disiapkan untuk memahami hal ini.
Di repo GitHub ini, Anda dapat melihat contoh wrapper pekerja yang ditulis dalam Java dan Python. Jika Anda berfungsi dalam JavaScript atau TypeScript, @bazel/paket pekerja dan contoh worker nodejs mungkin dapat membantu.
Bagaimana pengaruh pekerja terhadap sandbox?
Menggunakan strategi worker secara default tidak menjalankan tindakan dalam
sandbox, mirip dengan strategi local. Anda dapat menetapkan
tanda --worker_sandboxing untuk menjalankan semua pekerja di dalam sandbox, sehingga memastikan setiap
eksekusi alat hanya melihat file input yang seharusnya dimiliki. Alat
mungkin masih membocorkan informasi antarpermintaan secara internal, misalnya melalui
{i>cache<i}. Menggunakan strategi dynamic
memerlukan pekerja untuk di-sandbox.
Untuk memungkinkan penggunaan cache compiler yang benar dengan pekerja, ringkasan diteruskan dengan setiap file input. Dengan demikian, compiler atau wrapper dapat memeriksa apakah input tetap valid tanpa harus membaca file.
Meskipun menggunakan ringkasan input untuk mencegah penyimpanan dalam cache yang tidak diinginkan, pekerja dengan sandbox menawarkan sandboxing yang kurang ketat daripada sandbox murni, karena alat ini dapat menyimpan status internal lainnya yang telah terpengaruh oleh permintaan sebelumnya.
Pekerja multipleks hanya dapat di-sandbox
jika implementasi pekerja mendukungnya,
dan sandboxing ini harus diaktifkan secara terpisah dengan
--experimental_worker_multiplex_sandboxing. Lihat detail selengkapnya di
dokumen desain).
Bacaan lebih lanjut
Untuk informasi selengkapnya tentang pekerja persisten, lihat: