La base de código de Bazel

Informar un problemaopen_in_new Ver fuenteopen_in_new Noche}

Este documento es una descripción de la base de código y de la estructura de Bazel. Está dirigido a personas dispuestas a contribuir a Bazel, no a los usuarios finales.

Introducción

La base de código de Bazel es grande (código de producción de ~350 KLOC y código de prueba de ~260 KLOC) y nadie está familiarizado con todo el panorama: todos conocen muy bien su valle en particular, pero pocos saben lo que hay sobre las colinas en cada dirección.

Para que las personas que están en la mitad de su recorrido no se encuentren en un bosque oscuro con la pérdida directa del recorrido, en este documento se intenta ofrecer una descripción general de la base de código para que sea más fácil comenzar a trabajar en ella.

La versión pública del código fuente de Bazel se encuentra en GitHub, en github.com/bazelbuild/bazel. Esta no es la "fuente de confianza"; se deriva de un árbol de fuentes internas de Google que contiene funciones adicionales que no son útiles fuera de Google. El objetivo a largo plazo es hacer de GitHub la fuente de información.

Las contribuciones se aceptan a través del mecanismo de solicitud de extracción regular de GitHub, un Googler importa de forma manual al árbol de fuentes interno y, luego, se vuelve a exportar a GitHub.

Arquitectura cliente/servidor

La mayor parte de Bazel reside en un proceso del servidor que se mantiene en la RAM entre las compilaciones. Esto permite que Bazel mantenga el estado entre compilaciones.

Es por eso que la línea de comandos de Bazel tiene dos tipos de opciones: inicio y comando. En una línea de comandos como esta:

    bazel --host_jvm_args=-Xmx8G build -c opt //foo:bar

Algunas opciones (--host_jvm_args=) están antes del nombre del comando que se ejecutará y otras están después (-c opt). La primera categoría se denomina “opción de inicio” y afecta al proceso del servidor en su totalidad, mientras que la segunda, la “opción de comando”, solo afecta a un solo comando.

Cada instancia de servidor tiene un solo árbol de fuentes asociado (“lugar de trabajo”) y cada lugar de trabajo suele tener una sola instancia de servidor activa. Para evitarlo, especifica una base de salida personalizada (consulta la sección "Diseño del directorio" para obtener más información).

Bazel se distribuye como un único ejecutable ELF que también es un archivo ZIP válido. Cuando escribes bazel, el ejecutable de ELF anterior implementado en C++ (el "cliente") obtiene el control. Configura un proceso de servidor adecuado mediante los siguientes pasos:

1. Comprueba si ya se extrajo. De lo contrario, lo hace. Aquí es de donde proviene la implementación del servidor.
2. Comprueba si hay una instancia de servidor activa que funcione: se está ejecutando, tiene las opciones de inicio correctas y usa el directorio del lugar de trabajo correcto. Para encontrar el servidor en ejecución, observa el directorio $OUTPUT_BASE/server, en el que hay un archivo de bloqueo con el puerto en el que escucha el servidor.
3. Si es necesario, finaliza el proceso del servidor anterior.
4. Si es necesario, inicia un nuevo proceso de servidor.

Una vez que esté listo un proceso de servidor adecuado, el comando que se debe ejecutar se comunica a través de una interfaz de gRPC y, luego, el resultado de Bazel se canaliza a la terminal. Solo se puede ejecutar un comando a la vez. Esto se implementa mediante un mecanismo de bloqueo elaborado con partes en C++ y partes en Java. Existe cierta infraestructura para ejecutar varios comandos en paralelo, ya que la incapacidad de ejecutar bazel version en paralelo con otro comando es un poco vergonzosa. El principal bloqueador es el ciclo de vida de las BlazeModule y algunos estados en BlazeRuntime.

Al final de un comando, el servidor de Bazel transmite el código de salida que el cliente debe devolver. Una alteración interesante es la implementación de bazel run: el trabajo de este comando es ejecutar algo que Bazel acaba de compilar, pero no puede hacerlo desde el proceso del servidor porque no tiene una terminal. Por lo tanto, le indica al cliente qué objeto binario debe ujexec() y con qué argumentos.

Cuando uno presiona Ctrl + C, el cliente lo traduce a una llamada a Cancel en la conexión de gRPC, que intenta finalizar el comando lo antes posible. Después de la tercera combinación de teclas Ctrl + C, el cliente envía una SIGKILL al servidor en su lugar.

El código fuente del cliente está en src/main/cpp y el protocolo que se usa para comunicarse con el servidor está en src/main/protobuf/command_server.proto .

El punto de entrada principal del servidor es BlazeRuntime.main() y GrpcServerImpl.run() controla las llamadas de gRPC del cliente.

Diseño de directorio

Bazel crea un conjunto de directorios un tanto complicado durante una compilación. Hay una descripción completa disponible en Diseño del directorio de salida.

El “espacio de trabajo” es el árbol de fuentes en el que se ejecuta Bazel. Por lo general, corresponde a algo que verificaste en el control de código fuente.

Bazel coloca todos sus datos en la “raíz del usuario de salida”. Por lo general, es $HOME/.cache/bazel/_bazel_${USER}, pero se puede anular con la opción de inicio --output_user_root.

La "base de instalación" es donde se extrae Bazel. Esto se hace automáticamente y cada versión de Bazel obtiene un subdirectorio en función de su suma de verificación en la base de instalación. Se encuentra en $OUTPUT_USER_ROOT/install de forma predeterminada y se puede cambiar con la opción de línea de comandos --install_base.

La “base de salida” es el lugar en el que la instancia de Bazel adjunta a un lugar de trabajo específico escribe. Cada base de salida tiene, como máximo, una instancia del servidor de Bazel en ejecución a la vez. Por lo general, es a la(s) $OUTPUT_USER_ROOT/<checksum of the path to the workspace>. Se puede cambiar con la opción de inicio --output_base, que es, entre otras cosas, útil para evitar la limitación de que solo una instancia de Bazel se puede ejecutar en cualquier lugar de trabajo en cualquier momento.

El directorio de salida contiene, entre otras cosas, lo siguiente:

• Los repositorios externos recuperados en $OUTPUT_BASE/external.
• La raíz de ejecución, un directorio que contiene symlinks a todo el código fuente de la compilación actual. Se encuentra en $OUTPUT_BASE/execroot. Durante la compilación, el directorio de trabajo es $EXECROOT/<name of main repository>. Planeamos cambiar esto a $EXECROOT, aunque es un plan a largo plazo porque es un cambio muy incompatible.
• Archivos compilados durante la compilación.

El proceso de ejecutar un comando

Una vez que el servidor de Bazel obtiene el control y se le informa sobre un comando que necesita ejecutar, ocurre la siguiente secuencia de eventos:

1. Se informa a BlazeCommandDispatcher sobre la nueva solicitud. Decide si el comando necesita un lugar de trabajo en el que ejecutarse (casi todos los comandos, excepto los que no tienen nada que ver con el código fuente, como la versión o la ayuda) y si se está ejecutando otro comando.

2. Se encontró el comando correcto. Cada comando debe implementar la interfaz BlazeCommand y debe tener la anotación @Command (esto es un antipatrón, sería bueno que todos los metadatos que necesita un comando se describieran mediante métodos en BlazeCommand)

3. Se analizan las opciones de la línea de comandos. Cada comando tiene diferentes opciones de línea de comandos, que se describen en la anotación @Command.

4. Se crea un bus de eventos. El bus de eventos es una transmisión de eventos que ocurren durante la compilación. Algunos se exportan fuera de Bazel según el protocolo de eventos de compilación para indicarle al mundo cómo sale la compilación.

5. El comando obtiene el control. Los comandos más interesantes son los que ejecutan una compilación (compilación, prueba, ejecución, cobertura, etc.): BuildTool implementa esta funcionalidad.

6. Se analiza el conjunto de patrones de destino en la línea de comandos y se resuelven los comodines, como //pkg:all y //pkg/.... Esto se implementa en AnalysisPhaseRunner.evaluateTargetPatterns() y se reifica en Skyframe como TargetPatternPhaseValue.

7. La fase de carga y análisis se ejecuta para producir el grafo de acciones (un grafo acíclico dirigido de comandos que deben ejecutarse en la compilación).

8. Se ejecuta la fase de ejecución. Esto significa que se ejecuta cada acción necesaria para compilar los objetivos de nivel superior que se solicitan.

Opciones de línea de comandos

Las opciones de línea de comandos para una invocación de Bazel se describen en un objeto OptionsParsingResult, que, a su vez, contiene un mapa desde las “clases de opciones” hasta los valores de las opciones. Una "clase de opción" es una subclase de OptionsBase y agrupa las opciones de línea de comandos que se relacionan entre sí. Por ejemplo:

1. Opciones relacionadas con un lenguaje de programación (CppOptions o JavaOptions). Estas deben ser una subclase de FragmentOptions y, finalmente, se unen a un objeto BuildOptions.
2. Opciones relacionadas con la forma en que Bazel ejecuta acciones (ExecutionOptions)

Estas opciones están diseñadas para consumirse en la fase de análisis (ya sea a través de RuleContext.getFragment() en Java o ctx.fragments en Starlark). Algunas de ellas (por ejemplo, si se debe incluir el análisis de C++ o no) se leen en la fase de ejecución, pero eso siempre requiere una canalización explícita, ya que BuildConfiguration no está disponible en ese momento. Para obtener más información, consulta la sección "Configuraciones".

ADVERTENCIA: Nos gusta simular que las instancias de OptionsBase son inmutables y usarlas de esa manera (como una parte de SkyKeys). Este no es el caso, y modificarlas es una muy buena manera de dañar Bazel de formas sutiles que son difíciles de depurar. Lamentablemente, hacerlos realmente inmutables es un gran esfuerzo. (Está bien modificar un objeto FragmentOptions inmediatamente después de la construcción antes de que alguien más pueda mantener una referencia a él y antes de que se llame a equals() o hashCode()).

Bazel aprende sobre las clases de opciones de las siguientes maneras:

1. Algunos están conectados por cable a Bazel (CommonCommandOptions).
2. Desde la anotación @Command en cada comando de Bazel
3. Desde ConfiguredRuleClassProvider (estas son opciones de línea de comandos relacionadas con lenguajes de programación individuales)
4. Las reglas de Starlark también pueden definir sus propias opciones (consulta aquí).

Cada opción (excepto las opciones definidas por Starlark) es una variable de miembro de una subclase FragmentOptions que tiene la anotación @Option, que especifica el nombre y el tipo de la opción de línea de comandos junto con algo de texto de ayuda.

El tipo de Java del valor de una opción de línea de comandos suele ser algo simple (una string, un número entero, un valor booleano, una etiqueta, etcétera). Sin embargo, también admitimos opciones de tipos más complicados. En este caso, el trabajo de conversión de la cadena de línea de comandos al tipo de datos recae en una implementación de com.google.devtools.common.options.Converter.

El árbol fuente, como lo ve Bazel

Bazel se dedica a compilar software, lo que se produce cuando se lee y se interpreta el código fuente. La totalidad del código fuente en el que opera Bazel se denomina “lugar de trabajo” y se estructura en repositorios, paquetes y reglas.

Repositorios

Un "repositorio" es un árbol de fuentes en el que trabaja un desarrollador; por lo general, representa un solo proyecto. El principal de Bazel, Blaze, operaba en un monorepo, es decir, un único árbol de fuentes que contenía todo el código fuente usado para ejecutar la compilación. Por el contrario, Bazel admite proyectos cuyo código fuente abarca varios repositorios. El repositorio desde el que se invoca Bazel se denomina “repositorio principal” y los demás se denominan “repositorios externos”.

Un repositorio se marca con un archivo llamado WORKSPACE (o WORKSPACE.bazel) en su directorio raíz. Este archivo contiene información que es “global” para toda la compilación, por ejemplo, el conjunto de repositorios externos disponibles. Funciona como un archivo de Starlark normal, lo que significa que se pueden usar load() en otros archivos de Starlark. Por lo general, se usa para extraer los repositorios necesarios para un repositorio al que se hace referencia de forma explícita (lo llamamos “patrón deps.bzl”).

El código de los repositorios externos está vinculado a un symlink o se descarga en $OUTPUT_BASE/external.

Cuando se ejecuta la compilación, se debe unir todo el árbol de fuentes. Esto lo hace SymlinkForest, que vincula cada paquete del repositorio principal a $EXECROOT y cada repositorio externo a $EXECROOT/external o $EXECROOT/.. (con el primero, por supuesto, es imposible tener un paquete llamado external en el repositorio principal; por eso estamos migrando desde él).

Paquetes

Cada repositorio está compuesto por paquetes, una colección de archivos relacionados y una especificación de las dependencias. Estas se especifican con un archivo llamado BUILD o BUILD.bazel. Si ambos existen, Bazel prefiere BUILD.bazel. El motivo por el que se aceptan los archivos BUILD es que Blaze, el principal de Bazel, usó este nombre de archivo. Sin embargo, resultó ser un segmento de ruta de uso frecuente, especialmente en Windows, donde los nombres de archivo no distinguen mayúsculas de minúsculas.

Los paquetes son independientes entre sí: los cambios en el archivo BUILD de un paquete no pueden hacer que cambien los demás. La adición o eliminación de archivos BUILD puede cambiar otros paquetes, ya que los globs recursivos se detienen en los límites de los paquetes y, por lo tanto, la presencia de un archivo BUILD detiene la recursividad.

La evaluación de un archivo BUILD se llama “carga de paquetes”. Se implementa en la clase PackageFactory, llama al intérprete de Starlark y requiere conocer el conjunto de clases de reglas disponibles. El resultado de la carga del paquete es un objeto Package. En su mayoría, es un mapa de una cadena (el nombre de un objetivo) al destino en sí.

Una gran parte de la complejidad durante la carga de paquetes es el globbing: Bazel no requiere que todos los archivos de origen se enumeren de forma explícita y, en su lugar, puede ejecutar globs (como glob(["**/*.java"])). A diferencia de la shell, admite globs recursivos que descienden a subdirectorios (pero no a subpaquetes). Esto requiere acceso al sistema de archivos y, como puede ser lento, implementamos todo tipo de trucos para que se ejecute en paralelo y de la manera más eficiente posible.

El gesto de globo terráqueo se implementa en las siguientes clases:

• LegacyGlobber, un globo terráqueo rápido y feliz que no reconoce el Skyframe
• SkyframeHybridGlobber, una versión que usa Skyframe y se revierte al globber heredado para evitar los "reinicios de Skyframe" (como se describe a continuación)

La clase Package en sí contiene algunos miembros que se usan exclusivamente para analizar el archivo WORKSPACE y que no tienen sentido para paquetes reales. Esta es una falla de diseño porque los objetos que describen paquetes regulares no deberían contener campos que describan otra cosa. Examinémoslos.

• Las asignaciones del repositorio
• Las cadenas de herramientas registradas
• Las plataformas de ejecución registradas

Lo ideal es que haya más separación entre el análisis del archivo WORKSPACE y el de los paquetes regulares, de modo que Package no necesite satisfacer las necesidades de ambos. Lamentablemente, esto es difícil de hacer porque los dos están conectados bastante.

Etiquetas, destinos y reglas

Los paquetes se componen de destinos, que tienen los siguientes tipos:

1. Files: Los elementos que son la entrada o el resultado de la compilación En la jerga de Bazel, los llamamos artefactos (que se analizan en otro lugar). No todos los archivos creados durante la compilación son destinos. Es común que una salida de Bazel no tenga una etiqueta asociada.
2. Reglas: En ellas, se describen los pasos para derivar los resultados a partir de las entradas. Por lo general, se asocian con un lenguaje de programación (como cc_library, java_library o py_library), pero hay algunos que no se pueden usar en el lenguaje (como genrule o filegroup).
3. Grupos de paquetes: que se analizan en la sección Visibilidad.

El nombre de un objetivo se denomina etiqueta. La sintaxis de las etiquetas es @repo//pac/kage:name, en la que repo es el nombre del repositorio en el que se encuentra la etiqueta, pac/kage es el directorio en el que se encuentra su archivo BUILD y name es la ruta de acceso del archivo (si la etiqueta hace referencia a un archivo fuente) en relación con el directorio del paquete. Cuando se hace referencia a un destino en la línea de comandos, se pueden omitir algunas partes de la etiqueta:

1. Si se omite el repositorio, se considera que la etiqueta está en el repositorio principal.
2. Si se omite la parte del paquete (como name o :name), se considera que la etiqueta está en el paquete del directorio de trabajo actual (no se permiten las rutas de acceso relativas que contienen referencias de nivel superior (..)).

Un tipo de regla (como "biblioteca C++") se denomina "clase de regla". Las clases de reglas se pueden implementar en Starlark (la función rule()) o en Java (llamadas "reglas nativas", tipo RuleClass). A largo plazo, cada regla específica del lenguaje se implementará en Starlark, pero algunas familias de reglas heredadas (como Java o C++) aún se encuentran en Java por el momento.

Las clases de reglas de Starlark deben importarse al comienzo de los archivos BUILD con la sentencia load(), mientras que las clases de reglas de Java son conocidas "de forma nativa" por Bazel, ya que están registradas con ConfiguredRuleClassProvider.

Las clases de reglas contienen la siguiente información:

1. Sus atributos (como srcs y deps): sus tipos, valores predeterminados, restricciones, etcétera
2. Las transiciones de la configuración y los aspectos vinculados a cada atributo, si los hay
3. La implementación de la regla
4. Los proveedores de información transitiva que la regla crea "por lo general"

Nota sobre la terminología: En la base de código, a menudo, usamos "Rule" para referirse al destino creado por una clase de regla. Sin embargo, en Starlark y en la documentación para el usuario, "Rule" se debe usar exclusivamente para hacer referencia a la clase de regla en sí; el objetivo es solo un "target". Además, ten en cuenta que, a pesar de que RuleClass tiene "clase" en su nombre, no hay ninguna relación de herencia de Java entre una clase de regla y destinos de ese tipo.

Skyframe

El framework de evaluación subyacente a Bazel se llama Skyframe. Su modelo es que todo lo que se debe compilar durante una compilación se organiza en un grafo acíclico dirigido con bordes que apuntan desde cualquier dato hacia sus dependencias, es decir, otros datos que deben conocerse para su construcción.

Los nodos del gráfico se llaman SkyValue y sus nombres se llaman SkyKey. Ambos son profundamente inmutables; solo se debe poder acceder a los objetos inmutables desde ellos. Esta invariante casi siempre se mantiene y, en caso de que no sea así (como con las clases de opciones individuales BuildOptions, que es un miembro de BuildConfigurationValue y su SkyKey), intentamos no cambiarlas ni cambiarlas solo de maneras que no son observables desde el exterior. De esto se desprende que todo lo que se procesa dentro de Skyframe (como los objetivos configurados) también debe ser inmutable.

La forma más conveniente de observar el gráfico de Skyframe es ejecutar bazel dump --skyframe=deps, que vuelca el gráfico, una SkyValue por línea. Lo mejor es hacerlo para compilaciones pequeñas, ya que pueden ser bastante grandes.

Skyframe se encuentra en el paquete com.google.devtools.build.skyframe. El paquete con un nombre similar com.google.devtools.build.lib.skyframe contiene la implementación de Bazel sobre Skyframe. Aquí encontrarás más información sobre Skyframe.

Para evaluar un SkyKey determinado y convertirlo en un SkyValue, Skyframe invocará el SkyFunction correspondiente al tipo de clave. Durante la evaluación de la función, es posible que esta solicite otras dependencias de Skyframe llamando a las diversas sobrecargas de SkyFunction.Environment.getValue(). Esto tiene el efecto secundario de registrar esas dependencias en el gráfico interno de Skyframe, de modo que Skyframe sepa que debe volver a evaluar la función cuando alguna de sus dependencias cambie. En otras palabras, el almacenamiento en caché y el procesamiento incremental de Skyframe funcionan con un nivel de detalle de SkyFunction y SkyValue.

Cada vez que un objeto SkyFunction solicite una dependencia que no está disponible, getValue() mostrará un valor nulo. Luego, la función debe devolver el control a Skyframe mostrando un valor nulo. En algún momento, Skyframe evaluará la dependencia no disponible y, luego, reiniciará la función desde el principio; solo esta vez, la llamada a getValue() se realizará correctamente con un resultado no nulo.

Una consecuencia de esto es que cualquier cálculo realizado dentro de SkyFunction antes del reinicio debe repetirse. Sin embargo, esto no incluye el trabajo realizado para evaluar la dependencia SkyValues, que se almacena en caché. Por lo tanto, normalmente solucionamos este problema de la siguiente manera:

1. Declarar dependencias en lotes (mediante getValuesAndExceptions()) para limitar la cantidad de reinicios
2. Dividir un SkyValue en partes separadas que procesan diferentes SkyFunction, de modo que puedan procesarse y almacenarse en caché de forma independiente Esto debe hacerse de manera estratégica, ya que tiene el potencial de aumentar el uso de memoria.
3. Almacenar el estado entre reinicios, ya sea mediante SkyFunction.Environment.getState() o mantener una caché estática ad hoc “detrás de Skyframe”.

Básicamente, necesitamos estos tipos de soluciones alternativas, ya que solemos tener cientos de miles de nodos de Skyframe en tránsito y Java no admite subprocesos ligeros.

Starlark

Starlark es el lenguaje específico del dominio que se usa para configurar y extender Bazel. Se concibió como un subconjunto restringido de Python que tiene muchos menos tipos, más restricciones en el flujo de control y, lo que es más importante, garantías de inmutabilidad sólidas para habilitar lecturas simultáneas. No es de Turing completa, lo que evita que algunos usuarios (pero no todos) intenten realizar tareas de programación generales en el lenguaje.

Starlark se implementa en el paquete net.starlark.java. También tiene una implementación independiente de Go aquí. Actualmente, la implementación de Java que se usa en Bazel es un intérprete.

Starlark se usa en varios contextos, incluidos los siguientes:

1. El idioma BUILD. Aquí es donde se definen las reglas nuevas. El código de Starlark que se ejecuta en este contexto solo tiene acceso al contenido del archivo BUILD y a los archivos .bzl cargados por este.
2. Definiciones de reglas. Así es como se definen las reglas nuevas (como la compatibilidad con un idioma nuevo). El código de Starlark que se ejecuta en este contexto tiene acceso a la configuración y a los datos que proporcionan sus dependencias directas (más información sobre este tema más adelante).
3. El archivo WORKSPACE. Aquí es donde se definen los repositorios externos (código que no está en el árbol de fuentes principal).
4. Definiciones de las reglas del repositorio. Aquí es donde se definen los nuevos tipos de repositorios externos. El código de Starlark que se ejecuta en este contexto puede ejecutar código arbitrario en la máquina en la que se ejecuta Bazel y llegar fuera del espacio de trabajo.

Los dialectos disponibles para los archivos BUILD y .bzl son ligeramente diferentes porque expresan cosas distintas. Puedes encontrar una lista de las diferencias aquí.

Obtén más información sobre Starlark aquí.

La fase de carga y análisis

En la fase de carga y análisis, Bazel determina las acciones necesarias para compilar una regla en particular. Su unidad básica es un “destino configurado”, que es, con bastante certeza, un par (objetivo, configuración).

Se llama "fase de carga/análisis" porque se puede dividir en dos partes distintas, que solían ser serializadas, pero ahora pueden superponerse con el tiempo:

1. Cargar paquetes, es decir, convertir archivos BUILD en los objetos Package que los representan
2. Analizar los destinos configurados, es decir, ejecutar la implementación de las reglas para producir el gráfico de acciones

Cada destino configurado en el cierre transitivo de los destinos configurados solicitados en la línea de comandos debe analizarse de abajo hacia arriba; es decir, primero los nodos de hoja y, luego, hasta los de la línea de comandos. Las entradas para el análisis de un solo destino configurado son las siguientes:

1. La configuración. ("cómo" compilar esa regla; por ejemplo, la plataforma de destino, pero también elementos como las opciones de línea de comandos que el usuario desea que se pasen al compilador de C++)
2. Las dependencias directas. Sus proveedores de información transitiva están disponibles para la regla que se analiza. Se llaman así porque proporcionan una "lista completa" de la información en el cierre transitivo del destino configurado, como todos los archivos .jar en la ruta de clase o todos los archivos .o que deben vincularse en un objeto binario C++).
3. El objetivo en sí. Este es el resultado de la carga del paquete en el que se encuentra el destino. En el caso de las reglas, esto incluye sus atributos, que son, por lo general, lo importante.
4. La implementación del destino configurado Para las reglas, puede estar en Starlark o en Java. Todos los destinos configurados sin reglas se implementan en Java.

El resultado de analizar un destino configurado es el siguiente:

1. Los proveedores de información transitiva que configuraron los destinos que dependen de ella pueden acceder a los servicios
2. Los artefactos que puede crear y las acciones que los producen

La API que se ofrece a las reglas de Java es RuleContext, que es el equivalente del argumento ctx de las reglas de Starlark. Su API es más potente, pero, al mismo tiempo, es más fácil ejecutar Bad ThingsTM, por ejemplo, escribir código cuya complejidad de tiempo o espacio sea cuadrática (o peor), para hacer que el servidor de Bazel falle con una excepción de Java o infringir invariantes (por ejemplo, modificar una instancia de Options de forma involuntaria o hacer que un destino configurado sea mutable).

El algoritmo que determina las dependencias directas de un destino configurado se encuentra en DependencyResolver.dependentNodeMap().

Parámetros de configuración

Las configuraciones son el “cómo” de compilar un destino: para qué plataforma, con qué opciones de línea de comandos, etcétera.

Se puede compilar el mismo destino para varias configuraciones en la misma compilación. Esto es útil, por ejemplo, cuando se usa el mismo código para una herramienta que se ejecuta durante la compilación y para el código de destino y realizamos compilaciones cruzadas, o cuando compilamos una app de Android multifuncional (una que contiene código nativo para varias arquitecturas de CPU).

De forma conceptual, la configuración es una instancia BuildOptions. Sin embargo, en la práctica, BuildOptions se une a BuildConfiguration que proporciona varias funciones adicionales. Se propaga desde la parte superior del gráfico de dependencia hasta la parte inferior. Si cambia, la compilación debe volver a analizarse.

Esto genera anomalías, como tener que volver a analizar toda la compilación si, por ejemplo, cambia la cantidad de ejecuciones de prueba solicitadas, aunque eso solo afecte los objetivos de prueba (planeamos “cortar” la configuración para que este no sea el caso, pero aún no esté listo).

Cuando una implementación de reglas necesita parte de la configuración, debe declararla en su definición mediante RuleClass.Builder.requiresConfigurationFragments(). Esto se hace para evitar errores (como las reglas de Python que usan el fragmento de Java) y facilitar el recorte de la configuración, de modo que, por ejemplo, si las opciones de Python cambian, no es necesario volver a analizar los destinos de C++.

La configuración de una regla no necesariamente es la misma que la de su regla “superior”. El proceso de cambiar la configuración en un perímetro de dependencia se denomina “transición de configuración”. Puede suceder en dos lugares:

1. En un perímetro de dependencia Estas transiciones se especifican en Attribute.Builder.cfg() y son funciones de un Rule (donde se produce la transición) y un BuildOptions (la configuración original) a uno o más BuildOptions (la configuración de salida).
2. En cualquier perímetro entrante a un destino configurado. Se especifican en RuleClass.Builder.cfg().

Las clases relevantes son TransitionFactory y ConfigurationTransition.

Se usan transiciones de configuración, por ejemplo:

1. Para declarar que se usa una dependencia en particular durante la compilación y, por lo tanto, debe compilarse en la arquitectura de ejecución
2. Declarar que una dependencia particular debe compilarse para varias arquitecturas (como código nativo en APK multiarquitectura de Android)

Si una transición de configuración da como resultado varias configuraciones, se denomina transición dividida.

Las transiciones de configuración también se pueden implementar en Starlark (consulta la documentación aquí)

Proveedores de información transitiva

Los proveedores de información transitiva son una forma (y la _única_vía) para que los destinos configurados indiquen información sobre otros destinos configurados que dependen de ellos. La razón por la que se agrega el término "transitivo" es que, por lo general, es una clase de datos integrados del cierre transitivo de un destino configurado.

Por lo general, existe una correspondencia 1:1 entre los proveedores de información transitiva de Java y los de Starlark (la excepción es DefaultInfo, que es una combinación de FileProvider, FilesToRunProvider y RunfilesProvider porque esa API se considera más similar a Starlark que una transliteración directa de Java). Su clave es una de las siguientes cosas:

1. Un objeto de clase de Java. Esta opción solo está disponible para los proveedores a los que no se puede acceder desde Starlark. Estos proveedores son una subclase de TransitiveInfoProvider.
2. Una string. Esto es heredado y se desaconseja, ya que es susceptible a conflictos de nombres. Estos proveedores de información transitiva son subclases directas de build.lib.packages.Info .
3. Símbolo de un proveedor. Esto se puede crear desde Starlark con la función provider() y es la forma recomendada de crear proveedores nuevos. El símbolo está representado por una instancia Provider.Key en Java.

Los proveedores nuevos implementados en Java deben implementarse usando BuiltinProvider. NativeProvider dejó de estar disponible (aún no tuvimos tiempo de quitarlo) y no se puede acceder a las subclases de TransitiveInfoProvider desde Starlark.

Destinos configurados

Los destinos configurados se implementan como RuleConfiguredTargetFactory. Hay una subclase para cada clase de regla implementada en Java. Los destinos configurados de Starlark se crean a través de StarlarkRuleConfiguredTargetUtil.buildRule() .

Las fábricas de destino configuradas deben usar RuleConfiguredTargetBuilder para construir el valor que se muestra. Consta de lo siguiente:

1. Su filesToBuild, el concepto confuso de "el conjunto de archivos que representa esta regla". Estos son los archivos que se compilan cuando el destino configurado está en la línea de comandos o en los srcs de una genrule.
2. Sus archivos de ejecución, regulares y datos.
3. Sus grupos de salida. Estos son varios "otros conjuntos de archivos" que la regla puede compilar. Se puede acceder a ellos con el atributo output_group de la regla de grupo de archivos en BUILD y usando el proveedor OutputGroupInfo en Java.

Archivos de ejecución

Algunos objetos binarios necesitan archivos de datos para ejecutarse. Un ejemplo destacado son las pruebas que necesitan archivos de entrada. En Bazel, esto se representa con el concepto de “runfiles”. Un “árbol de runfiles” es un árbol de directorios de los archivos de datos para un objeto binario en particular. Se crea en el sistema de archivos como un árbol de symlink con enlaces simbólicos individuales que apuntan a los archivos en los árboles de salida.

Un conjunto de archivos de ejecución se representa como una instancia de Runfiles. Es conceptualmente un mapa de la ruta de acceso de un archivo en el árbol de archivos de ejecución a la instancia Artifact que lo representa. Es un poco más complicado que usar una sola Map por dos motivos:

• La mayoría de las veces, la ruta de acceso de los archivos de ejecución de un archivo es la misma que su execpath. Los usamos para ahorrar algo de RAM.
• Existen varios tipos heredados de entradas en árboles de archivos de ejecución, que también deben representarse.

Los archivos de ejecución se recopilan con RunfilesProvider: una instancia de esta clase representa los archivos de ejecución de un destino configurado (como una biblioteca) y sus necesidades de cierre transitivo, y se recopilan como un conjunto anidado (de hecho, se implementan mediante conjuntos anidados en la cubierta): cada destino une los archivos de ejecución de sus dependencias, agrega algunos de los suyos y, luego, envía la configuración resultante hacia arriba en el gráfico de dependencia. Una instancia RunfilesProvider contiene dos instancias Runfiles, una para cuando se depende de la regla mediante el atributo “datos” y una para cada otro tipo de dependencia entrante. Esto se debe a que, a veces, un destino presenta archivos de ejecución diferentes a los que se diferencian cuando se depende de un atributo de datos. Este es el comportamiento heredado no deseado que aún no hemos eliminado.

Los archivos de ejecución de los objetos binarios se representan como una instancia de RunfilesSupport. Esto es diferente de Runfiles porque RunfilesSupport tiene la capacidad de compilarse (a diferencia de Runfiles, que es solo una asignación). Para ello, se requieren los siguientes componentes adicionales:

• Manifiesto de los archivos de ejecución de entrada Esta es una descripción serializada del árbol de archivos de ejecución. Se usa como proxy para el contenido del árbol de archivos de ejecución, y Bazel supone que el árbol de archivos de ejecución cambia solo si cambia el contenido del manifiesto.
• El manifiesto de runfiles de salida. Las bibliotecas de entorno de ejecución que controlan árboles de archivos de ejecución usan esta función, especialmente en Windows, que a veces no admite vínculos simbólicos.
• El intermediario de runfiles. Para que exista un árbol de archivos de ejecución, es necesario compilar el árbol de symlink y el artefacto al que apuntan. Para disminuir la cantidad de aristas de dependencia, se puede usar el intermediario de archivos de ejecución para representarlos todos.
• Argumentos de línea de comandos para ejecutar el objeto binario cuyos archivos de ejecución representa el objeto RunfilesSupport.

Aspectos

Los aspectos son una forma de "propagar el procesamiento por el gráfico de dependencia". Se describen para los usuarios de Bazel aquí. Un buen ejemplo motivador son los búferes de protocolo: una regla proto_library no debería conocer ningún lenguaje en particular, pero compilar la implementación de un mensaje de búfer de protocolo (la "unidad básica" de búferes de protocolo) en cualquier lenguaje de programación debe acoplarse a la regla proto_library, de modo que, si dos objetivos en el mismo lenguaje dependen del mismo búfer de protocolo, se compile solo una vez.

Al igual que los objetivos configurados, se representan en Skyframe como un SkyValue y la forma en que se construyen es muy similar a la forma en que se compilan los destinos configurados: tienen una clase de fábrica llamada ConfiguredAspectFactory que tiene acceso a un RuleContext, pero, a diferencia de las fábricas de destino configuradas, también conoce el destino configurado al que está vinculado y sus proveedores.

El conjunto de aspectos propagados por el gráfico de dependencia se especifica para cada atributo con la función Attribute.Builder.aspects(). Hay algunas clases con nombres confusos que participan en el proceso:

1. AspectClass es la implementación del aspecto. Puede estar en Java (en cuyo caso es una subclase) o en Starlark (en cuyo caso es una instancia de StarlarkAspectClass). Es análogo a RuleConfiguredTargetFactory.
2. AspectDefinition es la definición del aspecto. Incluye los proveedores que requiere y los proveedores que proporciona, y contiene una referencia a su implementación, como la instancia de AspectClass adecuada. Es análogo a RuleClass.
3. AspectParameters es una forma de parametrizar un aspecto que se propaga hacia abajo en el gráfico de dependencia. Actualmente es una cadena a la asignación de cadenas. Un buen ejemplo de por qué es útil son los búferes de protocolo: si un lenguaje tiene varias APIs, la información sobre para qué API deben compilarse los búferes de protocolo se debe propagar hacia abajo en el gráfico de dependencia.
4. Aspect representa todos los datos necesarios para calcular un aspecto que se propaga hacia el gráfico de dependencia. Consiste en la clase de aspecto, su definición y sus parámetros.
5. RuleAspect es la función que determina qué aspectos debe propagar una regla en particular. Es una función Rule -> Aspect.

Una complicación un tanto inesperada es que los aspectos se pueden adjuntar a otros aspectos. Por ejemplo, un aspecto que recopila la ruta de clase para un IDE de Java probablemente quiera conocer todos los archivos .jar en la ruta de clase, pero algunos de ellos son búferes de protocolo. En ese caso, se recomienda conectar el aspecto del IDE al par (regla proto_library + aspecto de proto de Java).

La complejidad de los aspectos sobre los aspectos se captura en la clase AspectCollection.

Plataformas y cadenas de herramientas

Bazel admite compilaciones multiplataforma, es decir, compilaciones en las que puede haber varias arquitecturas en las que se ejecutan acciones de compilación y varias arquitecturas para las que se compila código. En la terminología de Bazel, estas arquitecturas se denominan plataformas (consulta la documentación completa aquí)

Una plataforma se describe mediante una asignación de pares clave-valor desde la configuración de restricciones (como el concepto de "arquitectura de CPU") hasta los valores de restricción (como una CPU específica, como x86_64). Tenemos un "diccionario" de la configuración y los valores de restricciones más usados en el repositorio @platforms.

El concepto de cadena de herramientas proviene del hecho de que, según las plataformas en las que se ejecute la compilación y las plataformas a las que se oriente, es posible que necesites usar diferentes compiladores. Por ejemplo, una cadena de herramientas específica de C++ puede ejecutarse en un SO específico y poder orientarse a otros SO. Bazel debe determinar el compilador de C++ que se usa en función de la ejecución establecida y la plataforma de destino (consulta la documentación sobre las cadenas de herramientas aquí).

Para ello, las cadenas de herramientas se anotan con el conjunto de restricciones de ejecución y plataforma de destino que admiten. Para ello, la definición de una cadena de herramientas se divide en dos partes:

1. Una regla toolchain() que describe el conjunto de restricciones de ejecución y destino que admite una cadena de herramientas y le indica qué tipo (como C++ o Java) es de la cadena de herramientas (esta última se representa con la regla toolchain_type()).
2. Una regla específica del lenguaje que describe la cadena de herramientas real (como cc_toolchain())

Esto se hace de esta manera porque necesitamos conocer las restricciones de cada cadena de herramientas para determinar la resolución de la cadena de herramientas, y las reglas *_toolchain() específicas del lenguaje contienen mucha más información que eso, por lo que tardan más en cargarse.

Las plataformas de ejecución se especifican de una de las siguientes maneras:

1. En el archivo WORKSPACE con la función register_execution_platforms()
2. En la línea de comandos con la opción de línea de comandos --extra_execution_platforms

El conjunto de plataformas de ejecución disponibles se calcula en RegisteredExecutionPlatformsFunction .

La plataforma de destino para un destino configurado se determina mediante PlatformOptions.computeTargetPlatform() . Es una lista de plataformas porque en algún momento queremos admitir varias plataformas de destino, pero aún no se implementó.

ToolchainResolutionFunction determina el conjunto de cadenas de herramientas que se usarán para un destino configurado. Es una función de:

• El conjunto de cadenas de herramientas registradas (en el archivo WORKSPACE y en la configuración)
• La ejecución deseada y las plataformas de destino (en la configuración)
• El conjunto de tipos de cadenas de herramientas que requiere el destino configurado (en UnloadedToolchainContextKey)
• El conjunto de restricciones de la plataforma de ejecución del destino configurado (el atributo exec_compatible_with) y la configuración (--experimental_add_exec_constraints_to_targets), en UnloadedToolchainContextKey

Su resultado es un UnloadedToolchainContext, que es, en esencia, un mapa del tipo de cadena de herramientas (representado como una instancia de ToolchainTypeInfo) a la etiqueta de la cadena de herramientas seleccionada. Se llama "unloading" porque no contiene las cadenas de herramientas en sí, solo sus etiquetas.

Luego, las cadenas de herramientas se cargan con ResolvedToolchainContext.load() y se usan en la implementación del destino configurado que las solicitó.

También tenemos un sistema heredado que se basa en que haya una sola configuración de “host” y configuraciones de destino representadas por varias marcas de configuración, como --cpu . Estamos realizando la transición al sistema anterior de manera gradual. Para manejar casos en los que las personas confían en los valores de configuración heredados, implementamos asignaciones de plataforma para traducir entre las marcas heredadas y las restricciones de la plataforma de estilo nuevo. Su código está en PlatformMappingFunction y usa un "pequeño lenguaje" que no es de Starlark.

Restricciones

A veces, uno quiere designar un destino como compatible solo con algunas plataformas. Desafortunadamente, Bazel cuenta con varios mecanismos para lograr este objetivo:

• Restricciones específicas de reglas
• environment_group()/environment()
• Restricciones de la plataforma

Por lo general, las restricciones específicas de las reglas se usan en Google para reglas de Java. Pronto están disponibles y no están disponibles en Bazel, pero es posible que el código fuente contenga referencias. El atributo que administra esto se denomina constraints= .

Environment_group() y Environment()

Estas reglas son un mecanismo heredado y no se usan ampliamente.

Todas las reglas de compilación pueden declarar para qué "entornos" se pueden compilar, cuando un "entorno" es una instancia de la regla environment().

Existen varias formas de especificar entornos compatibles para una regla:

1. A través del atributo restricted_to= Esta es la forma más directa de especificación, declara el conjunto exacto de entornos que la regla admite para este grupo.
2. A través del atributo compatible_with= De esta manera, se declaran los entornos que admite una regla, además de los entornos "estándar" que son compatibles de forma predeterminada.
3. A través de los atributos a nivel de paquete default_restricted_to= y default_compatible_with=
4. A través de especificaciones predeterminadas en reglas environment_group() Cada entorno pertenece a un grupo de pares relacionados por tema (como "arquitecturas de CPU", "versiones de JDK" o "sistemas operativos móviles"). La definición de un grupo de entornos incluye cuáles de estos entornos deben admitirse de forma “predeterminada” si no se especifica lo contrario en los atributos restricted_to= o environment(). Una regla sin tales atributos hereda todos los valores predeterminados.
5. Mediante un valor predeterminado de clase de regla Esto anula los valores predeterminados globales para todas las instancias de la clase de regla determinada. Esto se puede usar, por ejemplo, para hacer que todas las reglas *_test se puedan probar sin que cada instancia tenga que declarar explícitamente esta capacidad.

environment() se implementa como una regla normal, mientras que environment_group() es una subclase de Target, pero no de Rule (EnvironmentGroup), y una función que está disponible de forma predeterminada en Starlark (StarlarkLibrary.environmentGroup()), que eventualmente crea un objetivo epónimo. Esto es para evitar una dependencia cíclica que podría surgir porque cada entorno necesita declarar el grupo de entornos al que pertenece, y cada grupo de entornos debe declarar sus entornos predeterminados.

Se puede restringir una compilación a un entorno determinado con la opción de línea de comandos --target_environment.

La implementación de la verificación de restricciones se encuentra en RuleContextConstraintSemantics y TopLevelConstraintSemantics.

Restricciones de la plataforma

La manera "oficial" actual de describir con qué plataformas es compatible un destino es usar las mismas restricciones que se usan para describir las cadenas de herramientas y las plataformas. Está en proceso de revisión en la solicitud de extracción #10945.

Visibilidad

Si trabajas en una base de código grande con muchos desarrolladores (como en Google), procura evitar que el resto dependa de tu código de manera arbitraria. De lo contrario, según la ley de Hyrum, las personas comenzarán a depender de comportamientos que consideras detalles de implementación.

Bazel admite esto con el mecanismo llamado visibilidad: puedes declarar que solo se puede depender de un destino en particular con el uso del atributo de visibilidad. Este atributo es un poco especial porque, aunque contiene una lista de etiquetas, estas pueden codificar un patrón sobre los nombres de paquetes en lugar de un puntero a cualquier destino en particular. (Sí, es un defecto de diseño).

Esto se implementa en los siguientes lugares:

• La interfaz RuleVisibility representa una declaración de visibilidad. Puede ser una constante (completamente pública o completamente privada) o una lista de etiquetas.
• Las etiquetas pueden hacer referencia a grupos de paquetes (lista predefinida de paquetes), a paquetes directamente (//pkg:__pkg__) o a subárboles de paquetes (//pkg:__subpackages__). Esto es diferente de la sintaxis de la línea de comandos, que usa //pkg:* o //pkg/....
• Los grupos de paquetes se implementan como su propio destino (PackageGroup) y su propio objetivo configurado (PackageGroupConfiguredTarget). Es probable que podamos reemplazarlos por reglas simples si quisiéramos. Su lógica se implementa con la ayuda de PackageSpecification, que corresponde a un solo patrón, como //pkg/...; PackageGroupContents, que corresponde al atributo packages de un solo package_group, y PackageSpecificationProvider, que se agrega en un package_group y su includes transitivo.
• La conversión de listas de etiquetas de visibilidad a dependencias se realiza en DependencyResolver.visitTargetVisibility y en otros lugares.
• La verificación real se realiza en CommonPrerequisiteValidator.validateDirectPrerequisiteVisibility().

Conjuntos anidados

A menudo, un destino configurado agrega un conjunto de archivos de sus dependencias, agrega el suyo y une el conjunto agregado en un proveedor de información transitiva para que los destinos configurados que dependen de él puedan hacer lo mismo. Ejemplos:

• Los archivos de encabezado C++ usados para una compilación
• Los archivos de objeto que representan el cierre transitivo de un cc_library
• El conjunto de archivos .jar que deben estar en la ruta de clase para que se compile o ejecute una regla de Java
• El conjunto de archivos de Python en el cierre transitivo de una regla de Python

Si hiciéramos esto de forma simple, por ejemplo, con List o Set, obtendríamos un uso cuadrático de memoria: si hay una cadena de N reglas y cada regla agrega un archivo, tendríamos 1 + 2...+ N miembros de la colección.

Para evitar este problema, se nos ocurrió el concepto de NestedSet. Es una estructura de datos compuesta por otras instancias de NestedSet y algunos miembros propios, lo que forma un grafo acíclico dirigido de conjuntos. Son inmutables y sus miembros se pueden iterar. Definimos un orden de iteración múltiple (NestedSet.Order): pedido anticipado, pedido posterior, topológico (un nodo siempre aparece después de sus principales) y "no me importa, pero debería ser el mismo cada vez".

La misma estructura de datos se llama depset en Starlark.

Artefactos y acciones

La compilación real consiste en un conjunto de comandos que deben ejecutarse para producir el resultado que el usuario desea. Los comandos se representan como instancias de la clase Action, y los archivos, como instancias de la clase Artifact. Se organizan en un grafo acíclico dirigido y bipartito denominado "grafo de acción".

Los artefactos vienen en dos tipos: artefactos de origen (que están disponibles antes de que Bazel comience a ejecutarse) y artefactos derivados (que se deben compilar). Los artefactos derivados pueden ser de varios tipos:

1. **Artefactos normales. **Se verifica la actualización mediante el cálculo de su suma de verificación, con mtime como atajo. No se suma la verificación del archivo si su hora no ha cambiado.
2. Artefactos de symlink sin resolver. Para comprobar su actualización, se llama a readlink(). A diferencia de los artefactos normales, pueden ser symlinks colgantes. Por lo general, se usa en casos en los que se agrupan algunos archivos en algún tipo de archivo.
3. Artefactos de árboles. No son archivos individuales, sino árboles de directorios. Para comprobar si están actualizados, se verifica el conjunto de archivos que contiene y su contenido. Se representan como TreeArtifact.
4. Artefactos de metadatos constantes. Los cambios en estos artefactos no activan una recompilación. Se usa exclusivamente para la información de sellos de compilación: no queremos volver a compilarla solo porque cambió la hora actual.

No hay un motivo fundamental por el que los artefactos de origen no puedan ser artefactos de árbol o de symlink sin resolver, es solo que aún no los implementamos (sin embargo, deberíamos hacerlo; hacer referencia a un directorio de origen en un archivo BUILD es uno de los pocos problemas de inexactitud conocidos con Bazel. Tenemos una implementación de ese tipo de trabajos, que está habilitada por la propiedad BAZEL_TRACK_SOURCE_DIRECTORIES=1 de JVM).

Un tipo notable de Artifact son los intermediarios. Estas se indican mediante instancias de Artifact que son las salidas de MiddlemanAction. Se usan para casos especiales en algunos casos:

• La agregación de intermediarios se utiliza para agrupar artefactos. Esto es para que, si muchas acciones usan el mismo conjunto grande de entradas, no tenemos aristas de dependencia N*M, solo N+M (se reemplazan por conjuntos anidados).
• La programación de intermediarios de dependencia garantiza que una acción se ejecute antes que otra. Se usan principalmente para el análisis con lint, pero también para la compilación de C++ (consulta CcCompilationContext.createMiddleman() para obtener una explicación).
• Se usan intermediarios de archivos de ejecución para garantizar la presencia de un árbol de archivos de ejecución, de modo que no sea necesario depender por separado del manifiesto de salida y de cada artefacto al que hace referencia el árbol de archivos de ejecución.

Las acciones se entienden mejor como un comando que debe ejecutarse, el entorno que necesita y el conjunto de resultados que produce. Los siguientes son los componentes principales de la descripción de una acción:

• La línea de comandos que se debe ejecutar
• Los artefactos de entrada que necesita
• Las variables de entorno que se deben configurar
• Anotaciones que describen el entorno (como la plataforma) en el que debe ejecutarse

También hay otros casos especiales, como la escritura de un archivo cuyo contenido es conocido por Bazel. Son una subclase de AbstractAction. La mayoría de las acciones son SpawnAction o StarlarkAction (las mismas, pero podría decirse que no deberían ser clases separadas), aunque Java y C++ tienen sus propios tipos de acciones (JavaCompileAction, CppCompileAction y CppLinkAction).

En algún momento, queremos mover todo a SpawnAction. JavaCompileAction es bastante similar, pero C++ es un caso especial debido al análisis del archivo .d y la inclusión del análisis.

El gráfico de acciones está principalmente "incorporado" en el gráfico de Skyframe: de forma conceptual, la ejecución de una acción se representa como una invocación de ActionExecutionFunction. La asignación desde un borde de dependencia de un gráfico de acciones a un borde de dependencia de Skyframe se describe en ActionExecutionFunction.getInputDeps() y Artifact.key(), y tiene algunas optimizaciones para mantener baja la cantidad de bordes de Skyframe:

• Los artefactos derivados no tienen sus propios SkyValue. En cambio, se usa Artifact.getGeneratingActionKey() para encontrar la clave de la acción que lo genera.
• Los conjuntos anidados tienen su propia clave Skyframe.

Acciones compartidas

Algunas acciones son generadas por varios destinos configurados. Las reglas de Starlark son más limitadas, ya que solo pueden colocar sus acciones derivadas en un directorio determinado por su configuración y su paquete (pero aun así, las reglas del mismo paquete pueden entrar en conflicto), pero las reglas implementadas en Java pueden colocar artefactos derivados en cualquier lugar.

Esto se considera un error, pero deshacerse de él es muy difícil, ya que produce ahorros significativos en el tiempo de ejecución cuando, por ejemplo, un archivo fuente debe procesarse de alguna manera y varias reglas hacen referencia a él (pájaro de mano a mano). Esto tiene el costo de contar con un poco de RAM: cada instancia de una acción compartida debe almacenarse en la memoria por separado.

Si dos acciones generan el mismo archivo de salida, deben ser exactamente iguales: tener las mismas entradas y las mismas salidas, y ejecutar la misma línea de comandos. Esta relación de equivalencia se implementa en Actions.canBeShared() y se verifica entre las fases de análisis y ejecución mediante la observación de cada acción. Esto se implementa en SkyframeActionExecutor.findAndStoreArtifactConflicts() y es uno de los pocos lugares en Bazel que requiere una vista “global” de la compilación.

La fase de ejecución

En este momento, Bazel comienza a ejecutar acciones de compilación, como comandos que producen resultados.

Lo primero que hace Bazel después de la fase de análisis es determinar qué artefactos deben compilarse. La lógica para esto está codificada en TopLevelArtifactHelper. A grandes rasgos, es el filesToBuild de los objetivos configurados en la línea de comandos y el contenido de un grupo de salida especial con el propósito explícito de expresar "si este destino está en la línea de comandos, compila estos artefactos".

El siguiente paso es crear la raíz de ejecución. Debido a que Bazel tiene la opción de leer paquetes de origen desde diferentes ubicaciones en el sistema de archivos (--package_path), debe proporcionar acciones ejecutadas de forma local con un árbol de fuentes completo. La clase SymlinkForest se encarga de esto. Para ello, toma nota de cada destino usado en la fase de análisis y crea un árbol de directorios único que vincula symlinks a cada paquete con un destino usado desde su ubicación real. Una alternativa sería pasar las rutas de acceso correctas a los comandos (teniendo en cuenta --package_path). Esto es indeseable por los siguientes motivos:

• Cambia las líneas de comandos de acción cuando se mueve un paquete de una entrada de ruta de paquete a otra (suele ser un caso común).
• El resultado es líneas de comandos diferentes si una acción se ejecuta de forma remota que si se ejecuta localmente
• Requiere una transformación de línea de comandos específica para la herramienta en uso (considera la diferencia entre las rutas de clase de Java y las rutas de inclusión de C++).
• Cambiar la línea de comandos de una acción invalida su entrada de caché de acciones
• --package_path se da de baja de forma gradual y constante

Luego, Bazel comienza a recorrer el grafo de acciones (el grafo dirigido bipartito compuesto por acciones y sus artefactos de entrada y salida) y de ejecutar acciones. La ejecución de cada acción se representa con una instancia de la clase SkyValue ActionExecutionValue.

Dado que ejecutar una acción es costoso, tenemos algunas capas de almacenamiento en caché que se pueden acceder detrás de Skyframe:

• ActionExecutionFunction.stateMap contiene datos para que los reinicios de Skyframe de ActionExecutionFunction sean económicos.
• La caché de acciones locales contiene datos sobre el estado del sistema de archivos
• Los sistemas de ejecución remota suelen contener su propia caché

La caché de acciones locales

Esta caché es otra capa que se encuentra detrás de Skyframe; incluso si una acción se vuelve a ejecutar en Skyframe, puede ser un hit en la caché de acciones locales. Representa el estado del sistema de archivos local y se serializa en el disco, lo que significa que cuando se inicia un nuevo servidor Bazel, se pueden obtener hits de caché de acciones locales, aunque el gráfico de Skyframe esté vacío.

Se verifica esta caché para detectar hits con el método ActionCacheChecker.getTokenIfNeedToExecute() .

A diferencia de su nombre, es un mapa desde la ruta de acceso de un artefacto derivado hasta la acción que lo emitió. La acción se describe de la siguiente manera:

1. El conjunto de sus archivos de entrada y salida, y su suma de verificación
2. Su "clave de acción", que suele ser la línea de comandos que se ejecutó, pero, en general, representa todo lo que no captura la suma de verificación de los archivos de entrada (como en FileWriteAction, es la suma de verificación de los datos escritos).

También existe una "caché de acciones de arriba abajo" muy experimental que aún está en desarrollo y que usa hashes transitivos para evitar ir a la caché tantas veces.

Descubrimiento y reducción de entradas

Algunas acciones son más complicadas que solo tener un conjunto de entradas. Los cambios en el conjunto de entradas de una acción se presentan de dos formas:

• Una acción puede descubrir entradas nuevas antes de su ejecución o decidir que algunas de sus entradas no son realmente necesarias. El ejemplo canónico es C++, en el que es mejor hacer una suposición fundamentada sobre los archivos de encabezado que usa un archivo de C++ a partir de su cierre transitivo para no tener en cuenta el envío de todos los archivos a ejecutores remotos. Por lo tanto, tenemos la opción de no registrar todos los archivos de encabezado como una "entrada", sino analizar el archivo de origen en busca de encabezados incluidos de forma transitiva y solo marcar esos archivos de encabezado incluidos de manera transitiva y solo marcar esos archivos de encabezado en un procesador #include de forma transitiva y solo marcar esos archivos de encabezado en .
• Una acción puede darse cuenta de que algunos archivos no se usaron durante su ejecución. En C++, esto se denomina "archivos .d": el compilador indica qué archivos de encabezado se usaron después del hecho y, para evitar la vergüenza de tener una incrementalidad peor que la de Make, Bazel usa este hecho. Esto ofrece una mejor estimación que el escáner de inclusión, ya que se basa en el compilador.

Estas se implementan con métodos en Action:

1. Se llama a Action.discoverInputs(). Debería mostrar un conjunto anidado de artefactos que se determina que son obligatorios. Estos deben ser artefactos de origen para que no haya bordes de dependencia en el gráfico de acciones que no tengan un equivalente en el gráfico de destino configurado.
2. La acción se ejecuta llamando a Action.execute().
3. Al final de Action.execute(), la acción puede llamar a Action.updateInputs() para indicarle a Bazel que no se necesitaban todas sus entradas. Esto puede generar compilaciones incrementales incorrectas si se informa que una entrada usada no está en uso.

Cuando una caché de acciones muestra un hit en una instancia de acción nueva (como la que se creó después de reiniciar el servidor), Bazel llama a updateInputs() para que el conjunto de entradas refleje el resultado del descubrimiento y la reducción de entradas que se hicieron antes.

Las acciones de Starlark pueden usar la función para declarar algunas entradas como no utilizadas mediante el argumento unused_inputs_list= de ctx.actions.run().

Distintas formas de ejecutar acciones: estrategias o ActionContexts

Algunas acciones se pueden ejecutar de diferentes maneras. Por ejemplo, una línea de comandos se puede ejecutar de forma local, local, pero en varios tipos de zonas de pruebas o de forma remota. El concepto que lo representa se llama ActionContext (o Strategy, ya que solo aprobamos a la mitad con un cambio de nombre).

El ciclo de vida de un contexto de acción es el siguiente:

1. Cuando se inicia la fase de ejecución, se les pregunta a las instancias de BlazeModule qué contextos de acción tienen. Esto sucede en el constructor de ExecutionTool. Los tipos de contextos de acción se identifican mediante una instancia Class de Java que hace referencia a una subinterfaz de ActionContext y cuya interfaz debe implementar el contexto de acción.
2. El contexto de acción adecuado se selecciona entre los disponibles y se reenvía a ActionExecutionContext y BlazeExecutor .
3. Las acciones solicitan contextos con ActionExecutionContext.getContext() y BlazeExecutor.getStrategy() (realmente debería haber una sola manera de hacerlo...)

En las estrategias, es posible llamar a otras estrategias para que hagan su trabajo. Esto se usa, por ejemplo, en la estrategia dinámica que inicia acciones de forma local y remota y, luego, usa lo que finalice primero.

Una estrategia notable es la que implementa procesos de trabajadores persistentes (WorkerSpawnStrategy). La idea es que algunas herramientas tengan un tiempo de inicio prolongado y, por lo tanto, se deben reutilizar entre las acciones, en lugar de iniciar una nueva para cada acción (esto representa un posible problema de corrección, ya que Bazel se basa en la promesa del proceso de trabajador de que no lleva un estado observable entre solicitudes individuales).

Si la herramienta cambia, el proceso de trabajador debe reiniciarse. Para determinar si un trabajador se puede volver a usar, se debe calcular una suma de verificación para la herramienta que se usa con WorkerFilesHash. Se basa en saber qué entradas de la acción representan parte de la herramienta y cuáles son entradas. El creador de la acción lo determina: Spawn.getToolFiles() y los archivos de ejecución de Spawn se cuentan como partes de la herramienta.

Más información sobre estrategias (o contextos de acción):

• Aquí encontrarás información sobre varias estrategias para ejecutar acciones.
• Aquí encontrarás información sobre la estrategia dinámica, en la que ejecutamos una acción de forma local y remota para ver qué finaliza primero.
• La información sobre las complejidades de la ejecución de acciones de forma local está disponible aquí.

El administrador de recursos local

Bazel puede ejecutar muchas acciones en paralelo. La cantidad de acciones locales que se deben ejecutar en paralelo difiere de una acción a otra: cuantos más recursos requiera una acción, menos instancias deberían ejecutarse al mismo tiempo para evitar sobrecargar la máquina local.

Esto se implementa en la clase ResourceManager: cada acción debe anotarse con una estimación de los recursos locales que requiere en forma de una instancia ResourceSet (CPU y RAM). Luego, cuando los contextos de acción realizan una acción que requiere recursos locales, llaman a ResourceManager.acquireResources() y se bloquean hasta que los recursos necesarios estén disponibles.

Aquí encontrarás una descripción más detallada de la administración de recursos locales.

La estructura del directorio de salida

Cada acción requiere un lugar separado en el directorio de salida donde se colocan sus resultados. Por lo general, la ubicación de los artefactos derivados es la siguiente:

$EXECROOT/bazel-out/<configuration>/bin/<package>/<artifact name>

¿Cómo se determina el nombre del directorio asociado con una configuración en particular? Hay dos propiedades deseables en conflicto:

1. Si pueden ocurrir dos configuraciones en la misma compilación, deben tener directorios diferentes para que ambas puedan tener su propia versión de la misma acción. De lo contrario, si las dos configuraciones no están de acuerdo, como la línea de comandos de una acción que produce el mismo archivo de salida, Bazel no sabrá qué acción elegir (un “conflicto de acción”).
2. Si dos configuraciones representan "más o menos" lo mismo, deberían tener el mismo nombre para que las acciones ejecutadas en una puedan reutilizarse en la otra si las líneas de comandos coinciden. Por ejemplo, los cambios en las opciones de línea de comandos para el compilador de Java no deberían provocar que se vuelvan a ejecutar las acciones de compilación de C++.

Hasta ahora, no encontramos una forma de resolver este problema de principios, que tiene similitudes con el problema de recorte de configuración. Un análisis más extenso sobre las opciones está disponible aquí. Las principales áreas problemáticas son las reglas de Starlark (cuyos autores no suelen estar familiarizados con Bazel) y los aspectos, que agregan otra dimensión al espacio de elementos que pueden producir el "mismo" archivo de salida.

El enfoque actual es que el segmento de ruta de acceso para la configuración sea <CPU>-<compilation mode> con varios sufijos agregados, de modo que las transiciones de configuración implementadas en Java no generen conflictos de acciones. Además, se agrega una suma de comprobación del conjunto de transiciones de configuración de Starlark para que los usuarios no puedan causar conflictos de acciones. No es para nada perfecto. Esto se implementa en OutputDirectories.buildMnemonic() y depende de que cada fragmento de configuración agregue su propia parte al nombre del directorio de salida.

Pruebas

Bazel tiene una amplia compatibilidad para ejecutar pruebas. Es compatible con:

• Ejecución de pruebas de forma remota (si hay un backend de ejecución remota disponible)
• Ejecución de pruebas varias veces en paralelo (para reducir o recopilar datos de tiempo)
• Pruebas de fragmentación (dividiendo casos de prueba en la misma prueba en varios procesos para mejorar la velocidad)
• Volver a ejecutar pruebas inestables
• Agrupa pruebas en paquetes de pruebas

Las pruebas son destinos configurados normales que tienen un TestProvider, que describe cómo se debe ejecutar la prueba:

• Los artefactos cuya compilación dio como resultado la prueba que se estaba ejecutando. Este es un archivo de “estado de la caché” que contiene un mensaje TestResultData serializado
• La cantidad de veces que se debe ejecutar la prueba
• La cantidad de fragmentos en los que se debe dividir la prueba
• Algunos parámetros sobre cómo se debe ejecutar la prueba (como el tiempo de espera de la prueba)

Determina qué pruebas ejecutar

Determinar qué pruebas se ejecutan es un proceso elaborado.

Primero, durante el análisis de patrones de destino, los conjuntos de pruebas se expanden de manera recursiva. La expansión se implementa en TestsForTargetPatternFunction. Una arruga un poco sorprendente es que si un conjunto de pruebas no declara ninguna prueba, se refiere a todas las pruebas de su paquete. Para implementar esto en Package.beforeBuild(), se agrega un atributo implícito llamado $implicit_tests para probar las reglas del paquete.

Luego, las pruebas se filtran según el tamaño, las etiquetas, el tiempo de espera y el idioma de acuerdo con las opciones de la línea de comandos. Esto se implementa en TestFilter y se llama desde TargetPatternPhaseFunction.determineTests() durante el análisis de destino, y el resultado se coloca en TargetPatternPhaseValue.getTestsToRunLabels(). El motivo por el que los atributos de la regla que se pueden filtrar no son configurables es que esto sucede antes de la fase de análisis y, por lo tanto, la configuración no está disponible.

Esto se procesa aún más en BuildView.createResult(): se filtran los destinos cuyos análisis fallaron y las pruebas se dividen en pruebas exclusivas y no exclusivas. Luego, se coloca en AnalysisResult, que es la forma en que ExecutionTool sabe qué pruebas debe ejecutar.

Para brindar transparencia a este proceso elaborado, el operador de consulta tests() (implementado en TestsFunction) está disponible para determinar qué pruebas se ejecutan cuando se especifica un destino específico en la línea de comandos. Lamentablemente, es una reimplementación, por lo que es probable que se desvíe de lo anterior de varias maneras sutiles.

Cómo ejecutar pruebas

Para ejecutar las pruebas, se solicitan artefactos de estado de caché. Esto genera la ejecución de un TestRunnerAction, que finalmente llama al TestActionContext elegido por la opción de línea de comandos --test_strategy que ejecuta la prueba de la manera solicitada.

Las pruebas se ejecutan de acuerdo con un protocolo elaborado que usa variables de entorno para indicar a las pruebas qué se espera de ellas. Aquí encontrarás una descripción detallada de lo que Bazel espera las pruebas y qué pueden esperar de Bazel. En el caso más simple, un código de salida 0 significa éxito, todo lo demás significa falla.

Además del archivo de estado de caché, cada proceso de prueba emite otros archivos. Se colocan en el “directorio del registro de pruebas”, que es el subdirectorio llamado testlogs del directorio de salida de la configuración de destino:

• test.xml, un archivo en formato XML de estilo JUnit que detalla los casos de prueba individuales en el fragmento de prueba
• test.log: Es el resultado de la consola de la prueba. stdout y stderr no están separados.
• test.outputs, el "directorio de salidas no declarados"; esto se usa en pruebas que quieren generar archivos además de lo que imprimen en la terminal.

Hay dos cosas que pueden suceder durante la ejecución de prueba y que no pueden durante la compilación de objetivos regulares: la ejecución de prueba exclusiva y la transmisión de resultados.

Algunas pruebas deben ejecutarse en modo exclusivo, por ejemplo, no en paralelo con otras pruebas. Esto se puede obtener agregando tags=["exclusive"] a la regla de prueba o ejecutando la prueba con --test_strategy=exclusive . Cada prueba exclusiva se ejecuta a través de una invocación de Skyframe separada que solicita la ejecución de la prueba después de la compilación "principal". Esto se implementa en SkyframeExecutor.runExclusiveTest().

A diferencia de las acciones normales, cuyo resultado de la terminal se vuelca cuando la acción finaliza, el usuario puede solicitar que se transmita el resultado de las pruebas para que se le informe sobre el progreso de una prueba de larga duración. Esto se especifica mediante la opción de línea de comandos --test_output=streamed y también implica una ejecución de prueba exclusiva para que los resultados de diferentes pruebas no se intercalan.

Esto se implementa en la clase StreamedTestOutput, cuyo nombre es apropiado, y funciona sondeando los cambios en el archivo test.log de la prueba en cuestión y volcando los bytes nuevos en la terminal en la que gobierna Bazel.

Los resultados de las pruebas ejecutadas están disponibles en el bus de eventos mediante la observación de varios eventos (como TestAttempt, TestResult o TestingCompleteEvent). Se vuelcan al protocolo de eventos de compilación y AggregatingTestListener los emite a la consola.

Recopilación de cobertura

La cobertura se informa mediante las pruebas en formato LCOV en los archivos.bazel-testlogs/$PACKAGE/$TARGET/coverage.dat .

Para recopilar cobertura, cada ejecución de prueba se une a una secuencia de comandos llamada collect_coverage.sh .

Esta secuencia de comandos configura el entorno de la prueba para habilitar la recopilación de cobertura y determinar dónde se escriben los archivos de cobertura en los entornos de ejecución de cobertura. Luego, ejecuta la prueba. Una prueba puede ejecutar varios subprocesos y constar de partes escritas en varios lenguajes de programación diferentes (con entornos de ejecución de recopilación de cobertura independientes). Si es necesario, la secuencia de comandos del wrapper es responsable de convertir los archivos resultantes en formato LCOV y los combina en un solo archivo.

La interposición de collect_coverage.sh se realiza con las estrategias de prueba y requiere que collect_coverage.sh esté en las entradas de la prueba. Esto se logra mediante el atributo implícito :coverage_support, que se resuelve en el valor de la marca de configuración --coverage_support (consulta TestConfiguration.TestOptions.coverageSupport).

Algunos lenguajes realizan instrumentación sin conexión, lo que significa que la instrumentación de cobertura se agrega en el tiempo de compilación (como C++), mientras que otros realizan instrumentación en línea, lo que significa que la instrumentación de cobertura se agrega en el tiempo de ejecución.

Otro concepto fundamental es la cobertura de referencia. Esta es la cobertura de una biblioteca, un objeto binario o una prueba si no se ejecutó ningún código. El problema que resuelve es que, si quieres calcular la cobertura de la prueba de un objeto binario, no basta con combinar la cobertura de todas las pruebas, ya que puede haber código en el objeto binario que no está vinculado a ninguna prueba. Por lo tanto, lo que hacemos es emitir un archivo de cobertura para cada objeto binario que contiene solo los archivos para los que recopilamos cobertura, sin líneas cubiertas. El archivo de cobertura de referencia para un destino se encuentra en bazel-testlogs/$PACKAGE/$TARGET/baseline_coverage.dat . También se genera para objetos binarios y bibliotecas, además de para pruebas si pasas la marca --nobuild_tests_only a Bazel.

Actualmente, la cobertura del modelo de referencia no funciona.

Hacemos un seguimiento de dos grupos de archivos para la recopilación de cobertura para cada regla: el conjunto de archivos de instrumentación y el conjunto de archivos de metadatos de instrumentación.

El conjunto de archivos instrumentados es solo eso, un conjunto de archivos para instrumentar. En el caso de los entornos de ejecución de cobertura en línea, se puede usar en el tiempo de ejecución para decidir qué archivos instrumentar. También se usa para implementar la cobertura de referencia.

El conjunto de archivos de metadatos de instrumentación es el conjunto de archivos adicionales que una prueba necesita para generar los archivos LCOV que Bazel requiere. En la práctica, esto consiste en archivos específicos del entorno de ejecución; por ejemplo, gcc emite archivos .gcno durante la compilación. Estas se agregan al conjunto de entradas de acciones de prueba si el modo de cobertura está habilitado.

Si se recopila o no la cobertura se almacena en BuildConfiguration. Esto es útil porque es una manera fácil de cambiar la acción de prueba y el gráfico de acción según este bit, pero también significa que, si este bit está invertido, todos los objetivos deben volver a analizarse (algunos lenguajes, como C++, requieren diferentes opciones de compilador para emitir código que pueda recopilar cobertura, lo que mitiga este problema de alguna manera, ya que entonces se necesita un nuevo análisis de todas formas).

Se depende de los archivos de compatibilidad de cobertura a través de etiquetas en una dependencia implícita para que la política de invocación pueda anularlos, lo que les permite diferir entre las diferentes versiones de Bazel. Idealmente, se quitarían estas diferencias y estandarizábamos una de ellas.

También generamos un “informe de cobertura” que combina la cobertura recopilada para cada prueba en una invocación de Bazel. CoverageReportActionFactory se encarga de esto y se llama desde BuildView.createResult() . Obtiene acceso a las herramientas que necesita observando el atributo :coverage_report_generator de la primera prueba que se ejecuta.

El motor de consultas

Bazel usa un pequeño lenguaje para hacerle varias preguntas sobre distintos gráficos. Se proporcionan los siguientes tipos de consultas:

• bazel query se usa para investigar el gráfico de destino.
• bazel cquery se usa para investigar el gráfico de destino configurado.
• bazel aquery se usa para investigar el gráfico de acciones.

Cada uno de estos se implementa mediante la subclasificación AbstractBlazeQueryEnvironment. Se pueden realizar funciones de consulta adicionales mediante la subclasificación QueryFunction. Para permitir la transmisión de resultados de consultas, en lugar de recopilarlos en alguna estructura de datos, se pasa una query2.engine.Callback a QueryFunction, que la llama para obtener los resultados que desea mostrar.

El resultado de una consulta se puede emitir de varias maneras: etiquetas, etiquetas y clases de reglas, XML, protobuf, etcétera. Se implementan como subclases de OutputFormatter.

Un requisito sutil de algunos formatos de resultado de consultas (proto, definitivamente) es que Bazel debe emitir _toda _la información que proporciona la carga de paquetes para que se pueda diferenciar el resultado y determinar si un objetivo en particular ha cambiado. En consecuencia, los valores de los atributos deben ser serializables, por lo que hay muy pocos tipos de atributos sin atributos que tengan valores de Starlark complejos. La solución alternativa habitual es usar una etiqueta y adjuntar la información compleja a la regla con esa etiqueta. No es una solución alternativa muy satisfactoria, y sería muy bueno quitar este requisito.

El sistema de módulos

Bazel se puede extender agregando módulos. Cada módulo debe crear una subclase de BlazeModule (el nombre es una reliquia de la historia de Bazel cuando se llamaba Blaze) y obtiene información sobre varios eventos durante la ejecución de un comando.

Por lo general, se usan para implementar varias partes de la funcionalidad "no principal" que solo algunas versiones de Bazel (como la que usamos en Google) necesitan:

• Interfaces para los sistemas de ejecución remota
• Comandos nuevos

El conjunto de puntos de extensión que ofrece BlazeModule es un poco aleatorio. No lo uses como ejemplo de buenos principios de diseño.

El bus de eventos

La forma principal en que BlazeModules se comunica con el resto de Bazel es a través de un bus de eventos (EventBus): se crea una instancia nueva para cada compilación, varias partes de Bazel pueden publicar eventos en ella y los módulos pueden registrar objetos de escucha para los eventos que les interesan. Por ejemplo, los siguientes elementos se representan como eventos:

• Se determinó la lista de objetivos de compilación que se compilarán (TargetParsingCompleteEvent).
• Se determinaron las configuraciones de nivel superior (BuildConfigurationEvent)
• Se compiló un destino, ya sea correctamente o no (TargetCompleteEvent)
• Se ejecutó una prueba (TestAttempt, TestSummary)

Algunos de estos eventos se representan fuera de Bazel en el protocolo de eventos de compilación (son BuildEvent). Esto permite que los objetos BlazeModule y fuera del proceso de Bazel observen la compilación. Se puede acceder a ellos como un archivo que contiene mensajes de protocolo o como Bazel puede conectarse a un servidor (llamado el servicio de eventos de compilación) para transmitir eventos.

Esto se implementa en los paquetes de Java build.lib.buildeventservice y build.lib.buildeventstream.

Repositorios externos

Mientras que Bazel se diseñó originalmente para usarse en un monorepo (un único árbol de fuentes que contiene todo lo que se necesita compilar), Bazel vive en un mundo donde esto no es necesariamente cierto. Los "repositorios externos" son una abstracción que se usa para unir estos dos mundos: representan el código que es necesario para la compilación, pero que no está en el árbol de fuentes principal.

El archivo WORKSPACE

El conjunto de repositorios externos se determina mediante el análisis del archivo WORKSPACE. Por ejemplo, una declaración como la siguiente:

    local_repository(name="foo", path="/foo/bar")

Está disponible el repositorio llamado @foo. Esto se complica es que se pueden definir nuevas reglas de repositorio en archivos de Starlark, que luego se pueden usar para cargar código de Starlark nuevo, que se puede usar para definir reglas de repositorio nuevas y así sucesivamente.

Para manejar este caso, el análisis del archivo WORKSPACE (en WorkspaceFileFunction) se divide en fragmentos delineados por declaraciones load(). El índice del fragmento se indica con WorkspaceFileKey.getIndex(), y calcular WorkspaceFileFunction hasta que el índice X significa evaluarlo hasta la X.a declaración load().

Recupera repositorios

Antes de que el código del repositorio esté disponible para Bazel, se debe fetched. Esto hace que Bazel cree un directorio en $OUTPUT_BASE/external/<repository name>.

La recuperación del repositorio se realiza en los siguientes pasos:

1. PackageLookupFunction se da cuenta de que necesita un repositorio y crea un RepositoryName como SkyKey, que invoca a RepositoryLoaderFunction.
2. RepositoryLoaderFunction reenvía la solicitud a RepositoryDelegatorFunction por razones poco claras (el código indica que debe evitar volver a descargar elementos en caso de reinicios de Skyframe, pero no es un razonamiento muy sólido).
3. RepositoryDelegatorFunction descubre la regla del repositorio que se le solicita recuperar mediante la iteración sobre los fragmentos del archivo WORKSPACE hasta que se encuentra el repositorio solicitado.
4. Se encontró el RepositoryFunction adecuado que implementa la recuperación del repositorio; es la implementación de Starlark del repositorio o un mapa hard-coded para los repositorios que se implementan en Java.

Hay varias capas de almacenamiento en caché, ya que recuperar un repositorio puede ser muy costoso:

1. Hay una caché para los archivos descargados, que tiene como clave su suma de verificación (RepositoryCache). Esto requiere que la suma de verificación esté disponible en el archivo WORKSPACE, pero de todos modos es bueno para la hermeticidad. Esto se comparte entre cada instancia del servidor de Bazel en la misma estación de trabajo, sin importar en qué lugar de trabajo o base de salida se ejecuten.
2. Se escribe un "archivo de marcador" para cada repositorio en $OUTPUT_BASE/external que contenga una suma de verificación de la regla que se usó para recuperarla. Si el servidor de Bazel se reinicia, pero la suma de verificación no cambia, no se vuelve a recuperar. Esto se implementa en RepositoryDelegatorFunction.DigestWriter .
3. La opción de línea de comandos --distdir designa otra caché que se usa para buscar artefactos que se descargarán. Esto es útil en la configuración empresarial en la que Bazel no debería recuperar elementos aleatorios de Internet. Esto lo implementa DownloadManager .

Una vez que se descarga un repositorio, sus artefactos se tratan como artefactos de origen. Esto plantea un problema porque Bazel suele verificar la actualización de los artefactos de origen llamando a stat() en ellos, y estos artefactos también se invalidan cuando cambia la definición del repositorio en el que se encuentran. Por lo tanto, los objetos FileStateValue de un artefacto en un repositorio externo deben depender de su repositorio externo. ExternalFilesHelper se encarga de esta tarea.

Directorios administrados

A veces, los repositorios externos necesitan modificar archivos en la raíz del lugar de trabajo (como un administrador de paquetes que aloja los paquetes descargados en un subdirectorio del árbol de fuentes). Esto va en contra de la suposición de que Bazel hace que los archivos de origen solo sean modificados por el usuario y no por sí solos, y permite que los paquetes hagan referencia a cada directorio en la raíz del espacio de trabajo. Para hacer que este tipo de repositorio externo funcione, Bazel hace dos cosas:

1. Permite que el usuario especifique subdirectorios del lugar de trabajo a los que no puede acceder Bazel. Se enumeran en un archivo llamado .bazelignore y la funcionalidad se implementa en BlacklistedPackagePrefixesFunction.
2. Codificamos la asignación del subdirectorio del lugar de trabajo al repositorio externo que controla en ManagedDirectoriesKnowledge, y manejamos los FileStateValue que hacen referencia a ellos de la misma manera que los repositorios externos normales.

Asignaciones de repositorios

Puede suceder que varios repositorios deseen depender del mismo repositorio, pero en versiones diferentes (este es un ejemplo del "problema de dependencia de diamante"). Por ejemplo, si dos objetos binarios en repositorios separados en la compilación quieren depender de Guava, es probable que ambos hagan referencia a Guava con etiquetas que comienzan con @guava// y se espera que eso signifique diferentes versiones de ella.

Por lo tanto, Bazel permite que uno vuelva a asignar las etiquetas de repositorio externo para que la cadena @guava// pueda hacer referencia a un repositorio de Guava (como @guava1//) en el repositorio de un objeto binario y a otro repositorio de Guava (como @guava2//) en el repositorio del otro.

De manera alternativa, también se puede usar para join diamantes. Si un repositorio depende de @guava1// y otro depende de @guava2//, la asignación de repositorios permite que uno vuelva a asignar ambos repositorios para usar un repositorio @guava// canónico.

La asignación se especifica en el archivo WORKSPACE como el atributo repo_mapping de las definiciones de repositorios individuales. Luego, aparece en Skyframe como miembro de WorkspaceFileValue, donde se conecta a lo siguiente:

• Package.Builder.repositoryMapping, que se usa para transformar los atributos con valor de etiqueta de las reglas en el paquete mediante RuleClass.populateRuleAttributeValues()
• Package.repositoryMapping, que se usa en la fase de análisis (para resolver problemas como $(location), que no se analizan en la fase de carga)
• BzlLoadFunction para resolver etiquetas en sentencias load()

Bits de JNI

El servidor de Bazel está_ mayormente _escrito en Java. La excepción son las partes que Java no puede hacer por sí misma o que no podría hacer por sí sola cuando la implementamos. Esto se limita principalmente a la interacción con el sistema de archivos, el control de procesos y varios otros elementos de bajo nivel.

El código C++ se encuentra en src/main/native y las clases de Java con métodos nativos son las siguientes:

• NativePosixFiles y NativePosixFileSystem
• ProcessUtils
• WindowsFileOperations y WindowsFileProcesses
• com.google.devtools.build.lib.platform

Resultado de la consola

Emitir resultados de la consola parece sencillo, pero la confluencia de ejecutar varios procesos (a veces de forma remota), el almacenamiento en caché detallado, el deseo de obtener un resultado de terminal agradable y colorido, y tener un servidor de larga duración lo hacen no trivial.

Inmediatamente después de que el cliente ingresa la llamada RPC, se crean dos instancias de RpcOutputStream (para stdout y stderr) que reenvían los datos impresos al cliente. Luego, se unen en un OutErr (un par (stdout, stderr). Todo lo que se deba imprimir en la consola pasa por estas transmisiones. Luego, estas transmisiones se entregan a BlazeCommandDispatcher.execExclusively().

El resultado se imprime de forma predeterminada con secuencias de escape ANSI. Cuando no son deseados (--color=no), se los quita con un AnsiStrippingOutputStream. Además, System.out y System.err se redireccionan a estos flujos de salida. Esto es para que la información de depuración se pueda imprimir con System.err.println() y aun así termine en el resultado de la terminal del cliente (que es diferente del del servidor). Se debe tener cuidado de que, si un proceso produce una salida binaria (como bazel query --output=proto), no se realiza ninguna combinación de stdout.

Los mensajes cortos (errores, advertencias y similares) se expresan a través de la interfaz EventHandler. En particular, son diferentes de lo que se publica en EventBus (esto es confuso). Cada Event tiene un EventKind (error, advertencia, información y algunos más) y puede tener un Location (el lugar en el código fuente que provocó el evento).

Algunas implementaciones de EventHandler almacenan los eventos que recibieron. Esto se usa para volver a reproducir información en la IU causada por varios tipos de procesamiento en caché, por ejemplo, las advertencias emitidas por un destino configurado en caché.

Algunos EventHandler también permiten publicar eventos que, con el tiempo, se encuentran en el autobús de eventos (los Event normales no _no _aparecen allí). Estas son implementaciones de ExtendedEventHandler y su uso principal es volver a reproducir eventos EventBus almacenados en caché. Todos estos eventos EventBus implementan Postable, pero no todo lo que se publica en EventBus necesariamente implementa esta interfaz; solo aquellos que se almacenan en caché mediante un ExtendedEventHandler (sería útil y, en la mayoría de los casos, esto no se aplica; sin embargo, no se aplica de manera forzosa).

Los resultados de la terminal se emiten en su mayoría a través de UiEventHandler, que es responsable de todos los informes de progreso y formatos de salida sofisticados que realiza Bazel. Tiene dos entradas:

• El bus de eventos
• La transmisión del evento se canalizó a través de Reporter.

La única conexión directa que la máquina de ejecución de comandos (por ejemplo, el resto de Bazel) tiene con la transmisión de RPC al cliente es a través de Reporter.getOutErr(), que permite el acceso directo a estas transmisiones. Solo se usa cuando un comando necesita volcar grandes cantidades de datos binarios posibles (como bazel query).

Cómo generar perfiles de Bazel

Bazel es rápido. Bazel también es lento, ya que las compilaciones tienden a crecer hasta el límite de lo que es tolerable. Por este motivo, Bazel incluye un generador de perfiles que puede usarse para generar perfiles de compilaciones y Bazel en sí. Se implementa en una clase que se llama correctamente Profiler. Está activado de forma predeterminada, aunque solo registra datos abreviados para que su sobrecarga se pueda tolerar. La línea de comandos --record_full_profiler_data hace que registre todo lo que pueda.

Emite un perfil en el formato del generador de perfiles de Chrome; se ve mejor en Chrome. Su modelo de datos es el de pilas de tareas: uno puede iniciar tareas y finalizarlas, y se supone que estas deben estar anidadas de forma prolija entre ellas. Cada subproceso de Java recibe su propia pila de tareas. TODO: ¿Cómo funciona esto con las acciones y el estilo de paso de continuación?

El generador de perfiles se inicia y se detiene en BlazeRuntime.initProfiler() y BlazeRuntime.afterCommand() respectivamente, e intenta estar activo el mayor tiempo posible para que podamos generar perfiles de todo. Para agregar algo al perfil, llama a Profiler.instance().profile(). Muestra una Closeable, cuyo cierre representa el final de la tarea. Se recomienda su uso con sentencias de prueba con recursos.

También realizamos perfiles de memoria rudimentarios en MemoryProfiler. También está siempre activa y, sobre todo, registra los tamaños máximos de montón y el comportamiento de GC.

Prueba Bazel

Bazel tiene dos tipos principales de pruebas: unas que observan a Bazel como una “caja negra” y otras que solo ejecutan la fase de análisis. Llamamos a las primeras "pruebas de integración" y a las segundas "pruebas de unidades", aunque son más como pruebas de integración que están menos integradas. También tenemos algunas pruebas de unidades reales, en las que son necesarias.

Entre las pruebas de integración, tenemos dos tipos:

1. Unas implementadas con un framework de prueba de Bash muy elaborado en src/test/shell
2. Las que están implementadas en Java. Se implementan como subclases de BuildIntegrationTestCase.

BuildIntegrationTestCase es el framework de prueba de integración preferido, ya que está bien equipado para la mayoría de las situaciones de prueba. Como es un framework de Java, proporciona capacidad de depuración y una integración perfecta con muchas herramientas de desarrollo comunes. Hay muchos ejemplos de clases BuildIntegrationTestCase en el repositorio de Bazel.

Las pruebas de análisis se implementan como subclases de BuildViewTestCase. Existe un sistema de archivos de cero que puedes usar para escribir archivos BUILD. Luego, varios métodos auxiliares pueden solicitar destinos configurados, cambiar la configuración y confirmar varios aspectos sobre el resultado del análisis.