En esta página, se explica cómo usar trabajadores persistentes, los beneficios, los requisitos y cómo los trabajadores afectan la zona de pruebas.
Un trabajador persistente es un proceso de larga duración que inicia el servidor de Bazel, que funciona como un wrapper alrededor de la herramienta real (por lo general, un compilador) o es la herramienta en sí. Para beneficiarse de los trabajadores persistentes, la herramienta debe
permite realizar una secuencia de compilaciones, y el wrapper debe traducir
entre la API de la herramienta y el formato de solicitud/respuesta que se describe a continuación. Es igual.
se puede llamar al trabajador con y sin la marca --persistent_worker en
misma compilación y es responsable de iniciar y comunicarse adecuadamente con el
y el cierre de los trabajadores al salir. A cada instancia de trabajador se le asigna un directorio de trabajo independiente en <outputBase>/bazel-workers (pero no se le aplica el comando chroot).
El uso de trabajadores persistentes es una estrategia de ejecución que disminuye la sobrecarga de inicio, permite más compilación JIT y habilita el almacenamiento en caché de, por ejemplo, los árboles de sintaxis abstracta en la ejecución de la acción. Esta estrategia logra estas mejoras enviando varias solicitudes a un proceso de larga duración.
Los trabajadores persistentes se implementan en varios lenguajes, como Java, Scala, Kotlin y muchos más.
Los programas que usan un entorno de ejecución NodeJS pueden usar el @bazel/worker para implementar el protocolo del trabajador.
Usa trabajadores persistentes
Bazel 0.27 y versiones posteriores
usa trabajadores persistentes de forma predeterminada cuando ejecuta compilaciones, aunque
ejecución tiene prioridad. En el caso de las acciones que no admiten trabajadores persistentes,
Bazel recurre al inicio de una instancia de herramienta para cada acción. Puedes especificar
Configura tu compilación para usar trabajadores persistentes mediante la configuración de worker
estrategia para la herramienta aplicable
mnemotécnicos. Como práctica recomendada, este ejemplo incluye especificar local como una
resguardo de la estrategia worker:
bazel build //my:target --strategy=Javac=worker,local
El uso de la estrategia de trabajadores en lugar de la estrategia local puede aumentar significativamente la velocidad de compilación, según la implementación. Para Java, las compilaciones pueden ser de 2 a 4 veces más rápido y a veces más para la compilación incremental. La compilación de Bazel es aproximadamente 2.5 veces más rápida con trabajadores. Para obtener más detalles, consulta la "Elige la cantidad de trabajadores" sección.
Si también tienes un entorno de compilación remoto que coincide con tu compilación local
entorno, puedes usar el modelo
estrategia dinámica,
que ejecuta una ejecución remota y una de trabajador. Para habilitar el modo
de palabras clave, pasa el
--experimental_spawn_scheduler
marca. Esta estrategia habilita automáticamente a los trabajadores, por lo que no es necesario
especificar la estrategia worker, pero aún puedes usar local o sandboxed como
y resguardos.
Cómo elegir la cantidad de trabajadores
El número predeterminado de instancias de trabajador por nombre mnemónico es 4, pero se puede ajustar.
con el
worker_max_instances
marca. Existe una compensación entre hacer un buen uso de las CPUs disponibles y la cantidad de compilaciones JIT y de hits de caché que obtienes. Con más trabajadores, más objetivos pagarán los costos de inicio de la ejecución de código no JIT y de acceso a las cachés frías. Si tienes una pequeña cantidad de destinos para compilar, un solo trabajador puede brindar la mejor compensación entre la velocidad de compilación y el uso de recursos (por ejemplo, consulta el problema #8586).
La marca worker_max_instances establece la cantidad máxima de instancias de trabajador por mnemónico y conjunto de marcas (consulta a continuación), por lo que, en un sistema mixto, podrías terminar usando bastante memoria si mantienes el valor predeterminado. En el caso de las compilaciones incrementales, el beneficio de varias instancias de trabajadores es aún menor.
Este gráfico muestra los tiempos de compilación desde cero para Bazel (objetivo
//src:bazel) en una estación de trabajo de Linux con hipersubproceso de Intel Xeon de 3.5 GHz de 6 núcleos
con 64 GB de RAM. Para cada configuración de trabajador, se ejecutan cinco compilaciones limpias y se toma el promedio de las últimas cuatro.
Figura 1: Gráfico de las mejoras de rendimiento de las compilaciones limpias.
Para esta configuración, dos trabajadores proporcionan la compilación más rápida, aunque solo con una mejora del 14% en comparación con un trabajador. Un trabajador es una buena opción si quieres usar menos memoria.
Por lo general, la compilación incremental beneficia aún más. Las compilaciones limpias son relativamente raro, pero cambiar un solo archivo entre compilaciones es común, en en especial en el desarrollo basado en pruebas. El ejemplo anterior también tiene algunas acciones de empaquetado que no son de Java que pueden eclipsar el tiempo de compilación incremental.
La compilación nuevamente de las fuentes de Java solo (//src/main/java/com/google/devtools/build/lib/bazel:BazelServer_deploy.jar) después de cambiar una constante de cadena interna en AbstractContainerizingSandboxedSpawn.java proporciona una aceleración de 3 veces (un promedio de 20 compilaciones incrementales con una compilación de preparación descartada):
Figura 2: Gráfico de mejoras en el rendimiento de las compilaciones incrementales.
La aceleración depende del cambio que se realice. Una aceleración de un factor 6 es medida en la situación anterior, cuando se cambia una constante de uso común.
Modifica trabajadores persistentes
Puedes pasar la marca --worker_extra_flag para especificar marcas de inicio a los trabajadores, con claves mnemónicas. Por ejemplo, pasar --worker_extra_flag=javac=--debug activa la depuración solo para Javac.
Solo se puede establecer una marca de trabajador por uso de esta marca y solo para una mnemónica.
Los trabajadores no solo se crean por separado para cada mnemónica, sino también para las variaciones en sus marcas de inicio. Cada combinación de mnemónico y inicio
se combinan en un WorkerKey, y para cada WorkerKey hasta un
Se pueden crear worker_max_instances trabajadores. Consulta la siguiente sección para ver cómo la configuración de la acción también puede especificar marcas de configuración.
Puedes usar la
--high_priority_workers
marca para especificar un nombre mnemotécnico que se debe ejecutar en lugar de la prioridad normal
mnemotécnicos. Esto puede ayudar a priorizar las acciones que siempre están en
ruta de acceso. Si hay dos o más trabajadores de alta prioridad que ejecutan solicitudes, se impide que se ejecuten todos los demás trabajadores. Esta marca se puede usar varias veces.
Si pasas el
--worker_sandboxing
hace que cada solicitud de trabajador use un directorio de zona de pruebas independiente para todas sus
de datos. Configurar la zona de pruebas lleva más tiempo.
especialmente en macOS, pero ofrece una garantía de precisión mayor.
La marca --worker_quit_after_build es útil principalmente para la depuración y la generación de perfiles. Esta marca obliga a que todos los trabajadores se cierren una vez que se completa una compilación. También puedes pasar --worker_verbose para obtener más resultados sobre lo que hacen los trabajadores. Esta marca se refleja en el
verbosity en WorkRequest, lo que permite que también se puedan
sean más detallados.
Los trabajadores almacenan sus registros en el directorio <outputBase>/bazel-workers, por ejemplo, /tmp/_bazel_larsrc/191013354bebe14fdddae77f2679c3ef/bazel-workers/worker-1-Javac.log.
El nombre del archivo incluye el ID del trabajador y la mnemotecnia. Como puede haber más
de un WorkerKey por nombre mnemotécnico, es posible que veas más de worker_max_instances
archivos de registro para un nombre mnemotécnico determinado.
Para compilaciones de Android, consulta los detalles en la Página de rendimiento de compilación de Android
Cómo implementar trabajadores persistentes
Consulta la página Cómo crear trabajadores persistentes para obtener más información sobre cómo crear un trabajador.
En este ejemplo, se muestra una configuración de Starlark para un trabajador que usa 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" }
)
Con esta definición, el primer uso de esta acción comenzaría con la ejecución
la línea de comandos /bin/some_compiler -max_mem=4G --persistent_worker. Una solicitud
para compilar Foo.java, se vería de la siguiente manera:
NOTA: Si bien la especificación del búfer de protocolo usa “mayúsculas y minúsculas” (request_id), el protocolo JSON usa “mayúsculas y minúsculas” (requestId). En este documento, usaremos mayúsculas y minúsculas en los ejemplos de JSON, pero mayúsculas y minúsculas cuando hablemos del campo, independientemente del protocolo.
{
"arguments": [ "-g", "-source", "1.5", "Foo.java" ]
"inputs": [
{ "path": "symlinkfarm/input1", "digest": "d49a..." },
{ "path": "symlinkfarm/input2", "digest": "093d..." },
],
}
El trabajador recibe esto en stdin, en formato JSON delimitado por saltos de línea (porque
requires-worker-protocol se configura como JSON). A continuación, el trabajador realiza la acción,
y envía un WorkResponse con formato JSON a Bazel en su stdout. Bazel y luego
analiza esta respuesta y la convierte de forma manual en un proto WorkResponse. Para comunicarte con el trabajador asociado con un protobuf con codificación binaria en lugar de JSON, requires-worker-protocol se establecería en proto, de la siguiente manera:
execution_requirements = {
"supports-workers" : "1" ,
"requires-worker-protocol" : "proto"
}
Si no incluyes requires-worker-protocol en los requisitos de ejecución,
Bazel usará de forma predeterminada la comunicación del trabajador para usar protobuf.
Bazel deriva WorkerKey de la mnemónica y las marcas compartidas, por lo que, si esta configuración permitiera cambiar el parámetro max_mem, se generaría un trabajador independiente para cada valor utilizado. Esto puede provocar un consumo excesivo de memoria si se usan demasiadas variaciones.
Por el momento, cada trabajador solo puede procesar una solicitud a la vez. La función experimental de trabajadores multiplexados permite usar varios subprocesos, si la herramienta subyacente es multiproceso y el wrapper está configurado para comprender esto.
En este repositorio de GitHub, puedes ver ejemplos de wrappers de trabajadores escritos en Java y en Python. Si trabajas en JavaScript o TypeScript, el paquete @bazel/worker y el ejemplo de trabajador de nodejs pueden ser útiles.
¿Cómo afectan los trabajadores a la zona de pruebas?
El uso de la estrategia worker de forma predeterminada no ejecuta la acción en una
zona de pruebas, similar a la estrategia local. Puedes configurar
La marca --worker_sandboxing para ejecutar todos los trabajadores dentro de las zonas de pruebas y garantizar que cada uno
ejecución de la herramienta solo ve los archivos de entrada que debería tener. La herramienta
aún podrían filtrar información entre solicitudes internamente, por ejemplo, a través de un
la caché. Usando la estrategia dynamic
requiere que los trabajadores estén en una zona de pruebas.
Para permitir el uso correcto de las cachés del compilador con trabajadores, se pasa un resumen. con cada archivo de entrada. Por lo tanto, el compilador o el wrapper pueden comprobar si la entrada siguen siendo válidos sin tener que leer el archivo.
Incluso cuando se usan los resúmenes de entrada para protegerse contra el almacenamiento en caché los trabajadores ofrecen un entorno aislado menos estricto que uno puro, ya que la herramienta puede mantener otro estado interno que se vio afectado por solicitudes anteriores.
Los trabajadores multiplex solo pueden estar en zona de pruebas si la implementación del trabajador lo admite.
y esta zona de pruebas debe habilitarse por separado con el
--experimental_worker_multiplex_sandboxing. Obtén más detalles en el documento de diseño).
Lecturas adicionales
Para obtener más información sobre los trabajadores persistentes, consulta:
- Entrada de blog original sobre los trabajadores persistentes
- Descripción de la implementación de Haskell
- Entrada de blog de Mike Morearty
- Desarrollo de frontend con Bazel: Angular/TypeScript y trabajadores persistentes con Asana
- Explicación de las estrategias de Bazel
- Debate informativo sobre la estrategia del trabajador en la lista de distribución de bazel-debate