En esta página, se proporciona una descripción general de alto nivel de los problemas y desafíos específicos de escribir reglas de Bazel eficientes.
Requisitos de resumen
- Suposición: El objetivo es la corrección, la capacidad de procesamiento, la facilidad de uso y la latencia
- Suposición: Repositorios a gran escala
- Suposición: Lenguaje de descripción similar a BUILD
- Histórico: La separación estricta entre la carga, el análisis y la ejecución está desactualizada, pero sigue afectando a la API
- Intrínseco: La ejecución y el almacenamiento en caché remotos son difíciles
- Intrínseco: El uso de la información de cambios para compilaciones incrementales correctas y rápidas requiere patrones de codificación inusuales
- Intrínseco: Evitar el consumo cuadrático de tiempo y memoria es difícil
Suposiciones
Estas son algunas suposiciones sobre el sistema de compilación, como la necesidad de corrección, la facilidad de uso, la capacidad de procesamiento y los repositorios a gran escala. En las siguientes secciones, se abordan estos supuestos y se ofrecen lineamientos para garantizar que las reglas se redacten de manera eficaz.
Busca la precisión, la capacidad de procesamiento, la facilidad de uso y la latencia.
Suponemos que el sistema de compilación debe ser, ante todo, correcto con respecto a las compilaciones incrementales. Para un árbol fuente determinado, el resultado de la misma compilación siempre debe ser el mismo, independientemente de cómo se vea el árbol de resultados. En la primera aproximación, esto significa que Bazel necesita conocer cada entrada que se utiliza en un paso de compilación determinado, de modo que pueda volver a ejecutar ese paso si cambia alguna de las entradas. Bazel tiene límites en cuanto a la precisión que puede alcanzar, ya que filtra información como la fecha y la hora de la compilación, y omite ciertos tipos de cambios, como los cambios en los atributos de los archivos. El aislamiento ayuda a garantizar la corrección, ya que evita las lecturas de archivos de entrada no declarados. Además de los límites intrínsecos del sistema, existen algunos problemas conocidos de corrección, la mayoría de los cuales se relacionan con Fileset o las reglas de C++, que son problemas difíciles. Estamos trabajando en soluciones a largo plazo para corregir estos problemas.
El segundo objetivo del sistema de compilación es tener una capacidad de procesamiento alta. Constantemente, superamos los límites de lo que se puede hacer con la asignación de máquinas actual para un servicio de ejecución remota. Si el servicio de ejecución remota se sobrecarga, nadie puede trabajar.
La facilidad de uso es el siguiente factor. Entre varios enfoques correctos con la misma (o similar) huella del servicio de ejecución remota, elegimos el que es más fácil de usar.
La latencia indica el tiempo que transcurre desde que se inicia una compilación hasta que se obtiene el resultado deseado, ya sea un registro de prueba de una prueba aprobada o fallida, o un mensaje de error que indica que un archivo BUILD tiene un error tipográfico.
Ten en cuenta que estos objetivos suelen superponerse. La latencia es tanto una función de la capacidad de procesamiento del servicio de ejecución remota como la corrección es relevante para la facilidad de uso.
Repositorios a gran escala
El sistema de compilación debe operar a la escala de repositorios grandes, donde grande significa que no cabe en un solo disco duro, por lo que es imposible realizar una extracción completa en casi todas las máquinas de los desarrolladores. Una compilación de tamaño mediano deberá leer y analizar decenas de miles de archivos BUILD, y evaluar cientos de miles de globs. Si bien es teóricamente posible leer todos los archivos BUILD en una sola máquina, aún no hemos podido hacerlo en un tiempo y con una memoria razonables. Por lo tanto, es fundamental que los archivos BUILD se puedan cargar y analizar de forma independiente.
Lenguaje de descripción similar a BUILD
En este contexto, suponemos un lenguaje de configuración que es aproximadamente similar a los archivos BUILD en la declaración de reglas binarias y de biblioteca, y sus interdependencias. Los archivos BUILD se pueden leer y analizar de forma independiente, y evitamos incluso mirar los archivos fuente siempre que podemos (excepto para la existencia).
Lugar histórico
Existen diferencias entre las versiones de Bazel que generan desafíos, y algunas de ellas se describen en las siguientes secciones.
La separación estricta entre la carga, el análisis y la ejecución está desactualizada, pero sigue afectando la API.
Técnicamente, es suficiente que una regla conozca los archivos de entrada y salida de una acción justo antes de que se envíe la acción a la ejecución remota. Sin embargo, la base de código original de Bazel tenía una separación estricta de la carga de paquetes, luego analizaba las reglas con una configuración (principalmente, marcas de línea de comandos) y solo entonces ejecutaba las acciones. Esta distinción sigue siendo parte de la API de reglas hoy en día, aunque el núcleo de Bazel ya no la requiere (se proporcionan más detalles a continuación).
Esto significa que la API de Rules requiere una descripción declarativa de la interfaz de reglas (qué atributos tiene y qué tipos de atributos). Existen algunas excepciones en las que la API permite que se ejecute código personalizado durante la fase de carga para calcular nombres implícitos de archivos de salida y valores implícitos de atributos. Por ejemplo, una regla java_library llamada "foo" genera de forma implícita un resultado llamado "libfoo.jar", al que se puede hacer referencia desde otras reglas en el gráfico de compilación.
Además, el análisis de una regla no puede leer ningún archivo fuente ni inspeccionar el resultado de una acción. En cambio, debe generar un grafo bipartito dirigido parcial de los pasos de compilación y los nombres de los archivos de salida que solo se determinan a partir de la regla en sí y sus dependencias.
Intrínseco
Hay algunas propiedades intrínsecas que dificultan la escritura de reglas, y algunas de las más comunes se describen en las siguientes secciones.
La ejecución y el almacenamiento en caché remotos son difíciles
La ejecución y el almacenamiento en caché remotos mejoran los tiempos de compilación en repositorios grandes en aproximadamente dos órdenes de magnitud en comparación con la ejecución de la compilación en una sola máquina. Sin embargo, la escala a la que debe funcionar es asombrosa: el servicio de ejecución remota de Google está diseñado para controlar una gran cantidad de solicitudes por segundo, y el protocolo evita cuidadosamente los viajes de ida y vuelta innecesarios, así como el trabajo innecesario del lado del servicio.
En este momento, el protocolo requiere que el sistema de compilación conozca todas las entradas de una acción determinada con anticipación. Luego, el sistema de compilación calcula una huella digital de acción única y le solicita al programador un acierto de caché. Si se encuentra un acierto de caché, el programador responde con los resúmenes de los archivos de salida. Los archivos en sí se abordan por resumen más adelante. Sin embargo, esto impone restricciones en las reglas de Bazel, que deben declarar todos los archivos de entrada con anticipación.
Usar información de cambios para compilaciones incrementales correctas y rápidas requiere patrones de codificación inusuales
Anteriormente, argumentamos que, para ser correcto, Bazel necesita conocer todos los archivos de entrada que se utilizan en un paso de compilación para detectar si ese paso de compilación sigue actualizado. Lo mismo sucede con la carga de paquetes y el análisis de reglas, y diseñamos Skyframe para controlar esto en general. Skyframe es una biblioteca de gráficos y un framework de evaluación que toma un nodo objetivo (como "compila //foo con estas opciones") y lo desglosa en sus partes constituyentes, que luego se evalúan y combinan para producir este resultado. Como parte de este proceso, Skyframe lee paquetes, analiza reglas y ejecuta acciones.
En cada nodo, Skyframe hace un seguimiento exacto de los nodos que usó un nodo determinado para calcular su propia salida, desde el nodo objetivo hasta los archivos de entrada (que también son nodos de Skyframe). Tener este gráfico representado de forma explícita en la memoria permite que el sistema de compilación identifique exactamente qué nodos se ven afectados por un cambio determinado en un archivo de entrada (incluida la creación o eliminación de un archivo de entrada), y realice la cantidad mínima de trabajo para restablecer el árbol de salida a su estado previsto.
Como parte de este proceso, cada nodo realiza un proceso de detección de dependencias. Cada nodo puede declarar dependencias y, luego, usar el contenido de esas dependencias para declarar aún más dependencias. En principio, esto se asigna bien a un modelo de subproceso por nodo. Sin embargo, las compilaciones medianas contienen cientos de miles de nodos de Skyframe, lo que no es posible fácilmente con la tecnología Java actual (y, por motivos históricos, actualmente estamos obligados a usar Java, por lo que no hay subprocesos ligeros ni continuaciones).
En su lugar, Bazel usa un grupo de subprocesos de tamaño fijo. Sin embargo, eso significa que, si un nodo declara una dependencia que aún no está disponible, es posible que debamos anular esa evaluación y reiniciarla (posiblemente en otro subproceso) cuando la dependencia esté disponible. Esto, a su vez, significa que los nodos no deben hacer esto en exceso; un nodo que declara N dependencias de forma serial puede reiniciarse N veces, lo que cuesta O(N^2) tiempo. En cambio, nuestro objetivo es declarar las dependencias de forma masiva y anticipada, lo que a veces requiere reorganizar el código o incluso dividir un nodo en varios para limitar la cantidad de reinicios.
Ten en cuenta que esta tecnología no está disponible actualmente en la API de reglas. En cambio, la API de reglas aún se define con los conceptos heredados de fases de carga, análisis y ejecución. Sin embargo, una restricción fundamental es que todos los accesos a otros nodos deben pasar por el framework para que este pueda hacer un seguimiento de las dependencias correspondientes. Independientemente del lenguaje en el que se implemente el sistema de compilación o en el que se escriban las reglas (no tienen que ser el mismo), los autores de las reglas no deben usar bibliotecas o patrones estándar que omitan Skyframe. En el caso de Java, esto significa evitar java.io.File, así como cualquier forma de reflexión y cualquier biblioteca que haga cualquiera de estas acciones. Las bibliotecas que admiten la inyección de dependencias de estas interfaces de bajo nivel aún deben configurarse correctamente para Skyframe.
Esto sugiere que, en primer lugar, se debe evitar exponer a los autores de reglas a un tiempo de ejecución de lenguaje completo. El peligro de usar accidentalmente esas APIs es demasiado grande: varios errores de Bazel en el pasado se debieron a reglas que usaban APIs no seguras, a pesar de que las reglas fueron escritas por el equipo de Bazel o por otros expertos en el dominio.
Evitar el consumo cuadrático de tiempo y memoria es difícil
Para empeorar las cosas, además de los requisitos que impone Skyframe, las limitaciones históricas del uso de Java y la obsolescencia de la API de reglas, la introducción accidental de un consumo cuadrático de tiempo o memoria es un problema fundamental en cualquier sistema de compilación basado en reglas de biblioteca y binarias. Existen dos patrones muy comunes que introducen un consumo de memoria cuadrático (y, por lo tanto, un consumo de tiempo cuadrático).
Cadenas de reglas de biblioteca: Considera el caso de una cadena de reglas de biblioteca A depende de B, que depende de C, y así sucesivamente. Luego, queremos calcular alguna propiedad sobre el cierre transitivo de estas reglas, como la ruta de acceso de la clase de tiempo de ejecución de Java o el comando del vinculador de C++ para cada biblioteca. De forma ingenua, podríamos tomar una implementación de lista estándar; sin embargo, esto ya introduce un consumo de memoria cuadrático: la primera biblioteca contiene una entrada en la ruta de acceso a la clase, la segunda dos, la tercera tres, y así sucesivamente, para un total de 1 + 2 + 3 + … + N = O(N^2) entradas.
Reglas binarias que dependen de las mismas reglas de biblioteca: Considera el caso en el que un conjunto de archivos binarios depende de las mismas reglas de biblioteca, por ejemplo, si tienes varias reglas de prueba que prueban el mismo código de biblioteca. Supongamos que, de N reglas, la mitad son reglas binarias y la otra mitad son reglas de la biblioteca. Ahora considera que cada archivo binario hace una copia de alguna propiedad calculada sobre el cierre transitivo de las reglas de la biblioteca, como la ruta de acceso de clase del tiempo de ejecución de Java o la línea de comandos del vinculador de C++. Por ejemplo, podría expandir la representación de la cadena de línea de comandos de la acción de vinculación de C++. N/2 copias de N/2 elementos requieren una memoria de O(N^2).
Clases de colecciones personalizadas para evitar la complejidad cuadrática
Bazel se ve muy afectado por ambos casos, por lo que introdujimos un conjunto de clases de recopilación personalizadas que comprimen de manera eficaz la información en la memoria, ya que evitan la copia en cada paso. Casi todas estas estructuras de datos tienen una semántica establecida, por lo que las llamamos depset (también conocidas como NestedSet en la implementación interna). La mayoría de los cambios para reducir el consumo de memoria de Bazel en los últimos años fueron cambios para usar depsets en lugar de lo que se usaba anteriormente.
Lamentablemente, el uso de depsets no resuelve automáticamente todos los problemas. En particular, incluso iterar sobre un depset en cada regla reintroduce el consumo de tiempo cuadrático. Internamente, NestedSets también tiene algunos métodos auxiliares para facilitar la interoperabilidad con las clases de colecciones normales. Desafortunadamente, pasar accidentalmente un NestedSet a uno de estos métodos genera un comportamiento de copia y reintroduce el consumo de memoria cuadrático.