Trabajadores persistentes

7.3 · 7.2 · 7.1 · 7.0 · 6.5

En esta página, se explica cómo usar trabajadores persistentes, los beneficios, los requisitos y cómo los trabajadores afectan a 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 admitir una secuencia de compilaciones, y el wrapper debe traducir entre la API de la herramienta y el formato de solicitud o respuesta que se describe a continuación. Se puede llamar al mismo trabajador con y sin la marca --persistent_worker en la misma compilación, y es responsable de iniciar y comunicarse con la herramienta de forma adecuada, así como de cerrar a 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 mediante el envío de 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 de NodeJS pueden usar la biblioteca auxiliar @bazel/worker para implementar el protocolo de trabajador.

Usa trabajadores persistentes

Bazel 0.27 y versiones posteriores usan trabajadores persistentes de forma predeterminada cuando se ejecutan compilaciones, aunque la ejecución remota 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 configurar de forma explícita tu compilación para que use trabajadores persistentes si estableces la estrategia worker para la mnemotecnia de la herramienta correspondiente. Como práctica recomendada, este ejemplo incluye especificar local como 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. En Java, las compilaciones pueden ser de 2 a 4 veces más rápidas, a veces más, para la compilación incremental. La compilación de Bazel es aproximadamente 2.5 veces más rápida con los trabajadores. Para obtener más detalles, consulta la sección "Elige la cantidad de trabajadores".

Si también tienes un entorno de compilación remoto que coincide con tu entorno de compilación local, puedes usar la estrategia dinámica experimental, que ejecuta una ejecución remota y una de trabajador. Para habilitar la estrategia dinámica, pasa la marca --experimental_spawn_scheduler. Esta estrategia habilita a los trabajadores automáticamente, por lo que no es necesario especificar la estrategia worker, pero puedes usar local o sandboxed como resguardos.

Elige la cantidad de trabajadores

La cantidad predeterminada de instancias de trabajador por mnemónica es 4, pero se puede ajustar con la marca worker_max_instances. 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 debes compilar una pequeña cantidad de objetivos, un solo trabajador puede ofrecer la mejor compensación entre la velocidad de compilación y el uso de recursos (por ejemplo, consulta el error #8586). La marca worker_max_instances establece la cantidad máxima de instancias de trabajador por conjunto mnemotécnico y de marcas (consulta a continuación), por lo que en un sistema mixto podrías terminar usando mucha memoria si mantienes el valor predeterminado. En el caso de las compilaciones incrementales, el beneficio de varias instancias de trabajadores es aún menor.

En este gráfico, se muestran los tiempos de compilación desde cero de Bazel (//src:bazel objetivo) en una estación de trabajo de Linux con Intel Xeon de 6 núcleos y 3.5 GHz con hiperproceso en 64 GB de RAM. Para cada configuración de trabajador, se ejecutan cinco compilaciones limpias y se toma el promedio de las últimas cuatro.

Gráfico de mejoras en el rendimiento de compilaciones limpias

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 ofrece aún más beneficios. Las compilaciones limpias son relativamente raras, pero es común cambiar un solo archivo entre compilaciones, en particular en el desarrollo impulsado por 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):

Gráfico de las mejoras de rendimiento de las compilaciones incrementales

Figura 2: Gráfico de mejoras en el rendimiento de las compilaciones incrementales.

La aceleración depende del cambio que se realice. En la situación anterior, se mide una aceleración de un factor 6 cuando se cambia una constante de uso general.

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 configurar una marca de trabajador por uso de esta marca, y solo para un nombre nemotécnico. Los trabajadores no solo se crean por separado para cada nombre mnemotécnico, sino también para las variaciones de sus marcas de inicio. Cada combinación de mnemónicos y marcas de inicio se combina en un WorkerKey y, para cada WorkerKey, se pueden crear hasta worker_max_instances trabajadores. Consulta la siguiente sección para ver cómo la configuración de acciones también puede especificar marcas de configuración.

Puedes usar la marca --high_priority_workers para especificar una mnemotecnia que se debe ejecutar en lugar de las mnemotecnias de prioridad normal. Esto puede ayudar a priorizar las acciones que siempre están en la ruta crítica. 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.

Pasar la marca --worker_sandboxing hace que cada solicitud de trabajador use un directorio de zona de pruebas independiente para todas sus entradas. La configuración de la zona de pruebas requiere un tiempo adicional, especialmente en macOS, pero ofrece una mejor garantía de exactitud.

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 campo verbosity en WorkRequest, lo que permite que las implementaciones de trabajadores también sean más detalladas.

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 el nombre nemotécnico. Dado que puede haber más de un WorkerKey por nombre mnemotécnico, es posible que veas más de archivos de registro worker_max_instances para un nombre mnemotécnico determinado.

En el caso de las compilaciones de Android, consulta los detalles en la página Rendimiento de compilaciones de Android.

Implementa 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 de 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 está configurado como JSON). Luego, el trabajador realiza la acción y envía un WorkResponse con formato JSON a Bazel en su stdout. Luego, Bazel analiza esta respuesta y la convierte de forma manual en un proto WorkResponse. Para comunicarse con el trabajador asociado mediante protobuf con codificación binaria en lugar de JSON, requires-worker-protocol se configuraría como 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 establecerá de forma predeterminada que la comunicación del trabajador use 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 multiplex permite usar varios subprocesos si la herramienta subyacente tiene varios subprocesos y el wrapper está configurado para entender 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 nodejs worker 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 asegurarte de que cada ejecución de la herramienta solo vea los archivos de entrada que debería tener. Es posible que la herramienta siga filtrando información entre solicitudes de forma interna, por ejemplo, a través de una caché. El uso de 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 junto con cada archivo de entrada. Por lo tanto, el compilador o el wrapper pueden verificar si la entrada sigue siendo válida sin tener que leer el archivo.

Incluso cuando se usan los resúmenes de entrada para proteger contra el almacenamiento en caché no deseado, los trabajadores en zona de pruebas ofrecen una zona de pruebas menos estricta que una zona de pruebas pura, ya que la herramienta puede conservar otro estado interno que se vio afectado por solicitudes anteriores.

Los trabajadores multiplex solo pueden incluirse en una zona de pruebas si la implementación del trabajador los admite, y esta zona de pruebas debe habilitarse por separado con la marca --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 los siguientes recursos: