Consulta del gráfico de acción (aquery)

El comando aquery te permite consultar acciones en tu gráfico de compilación. Opera en el gráfico de destino configurado posterior al análisis y expone información sobre acciones, artefactos y sus relaciones.

aquery es útil cuando te interesan las propiedades de las acciones o los artefactos generados a partir del gráfico de destino configurado. Por ejemplo, los comandos reales que se ejecutan y sus entradas, salidas y mnemónicos.

La herramienta acepta varias opciones de línea de comandos. En particular, el comando aquery se ejecuta sobre una compilación normal de Bazel y hereda el conjunto de opciones disponibles durante una compilación.

Admite el mismo conjunto de funciones que también está disponible para query tradicional, pero siblings, buildfiles y tests.

Este es un ejemplo de resultado de aquery (sin detalles específicos):

$ bazel aquery 'deps(//some:label)'
action 'Writing file some_file_name'
  Mnemonic: ...
  Target: ...
  Configuration: ...
  ActionKey: ...
  Inputs: [...]
  Outputs: [...]

Sintaxis básica

A continuación, se muestra un ejemplo simple de la sintaxis de aquery:

bazel aquery "aquery_function(function(//target))"

La expresión de búsqueda (entre comillas) consta de lo siguiente:

• aquery_function(...): Son funciones específicas de aquery. Obtén más detalles a continuación.
• function(...): Las funciones estándar como query tradicionales.
• //target es la etiqueta del destino de interés.

# aquery examples:
# Get the action graph generated while building //src/target_a
$ bazel aquery '//src/target_a'

# Get the action graph generated while building all dependencies of //src/target_a
$ bazel aquery 'deps(//src/target_a)'

# Get the action graph generated while building all dependencies of //src/target_a
# whose inputs filenames match the regex ".*cpp".
$ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'

Cómo usar las funciones de aquery

Existen tres funciones aquery:

• inputs: Filtra las acciones por entradas.
• outputs: Filtra las acciones por resultados.
• mnemonic: Filtra las acciones por mnemónico

expr ::= inputs(word, expr)

El operador inputs devuelve las acciones generadas a partir de la compilación de expr, cuyos nombres de archivos de entrada coinciden con la regex proporcionada por word.

$ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'

Las funciones outputs y mnemonic comparten una sintaxis similar.

También puedes combinar funciones para lograr la operación AND. Por ejemplo:

  $ bazel aquery 'mnemonic("Cpp.*", (inputs(".*cpp", inputs("foo.*", //src/target_a))))'

El comando anterior encontraría todas las acciones involucradas en la compilación de //src/target_a, cuyos mnemónicos coinciden con "Cpp.*" y cuyas entradas coinciden con los patrones ".*cpp" y "foo.*".

A continuación, se muestra un ejemplo del error de sintaxis que se produce:

        $ bazel aquery 'deps(inputs(".*cpp", //src/target_a))'
        ERROR: aquery filter functions (inputs, outputs, mnemonic) produce actions,
        and therefore can't be the input of other function types: deps
        deps(inputs(".*cpp", //src/target_a))

Opciones

Opciones de compilación

aquery se ejecuta sobre una compilación normal de Bazel y, por lo tanto, hereda el conjunto de opciones disponibles durante una compilación.

Opciones de Aquery

--output=(text|summary|proto|jsonproto|textproto), default=text

El formato de salida predeterminado (text) es legible por humanos. Usa proto, textproto o jsonproto para el formato legible por máquinas. El mensaje .proto es analysis.ActionGraphContainer.

--include_commandline, default=true

Incluye el contenido de las líneas de comandos de la acción en el resultado (puede ser grande).

--include_artifacts, default=true

Incluye los nombres de las entradas y salidas de la acción en el resultado (puede ser grande).

--include_aspects, default=true

Indica si se deben incluir en el resultado las acciones generadas por Aspect.

--include_param_files, default=false

Incluye el contenido de los archivos de parámetros que se usan en el comando (podría ser grande).

--include_file_write_contents, default=false

Incluye el contenido del archivo para la acción actions.write() y el contenido del archivo de manifiesto para la acción SourceSymlinkManifest. El contenido del archivo se devuelve en el campo file_contents con --output=xxxproto. Con --output=text, el resultado tiene una línea FileWriteContents: [<base64-encoded file contents>].

--skyframe_state, default=false

Sin realizar análisis adicionales, vuelca el gráfico de acciones de Skyframe.

Otras herramientas y funciones

Consultas sobre el estado de Skyframe

Skyframe es el modelo de evaluación y de incrementalidad de Bazel. En cada instancia del servidor de Bazel, Skyframe almacena el gráfico de dependencias construido a partir de las ejecuciones anteriores de la fase de análisis.

En algunos casos, es útil consultar el Action Graph en Skyframe. Un ejemplo de caso de uso sería el siguiente:

1. Ejecuta bazel build //target_a
2. Ejecuta bazel build //target_b
3. Se generó el archivo foo.out.

Como usuario de Bazel, quiero determinar si foo.out se generó a partir de la compilación de //target_a o //target_b.

Se podría ejecutar bazel aquery 'outputs("foo.out", //target_a)' y bazel aquery 'outputs("foo.out", //target_b)' para determinar la acción responsable de crear foo.out y, a su vez, el destino. Sin embargo, la cantidad de destinos diferentes compilados anteriormente puede ser mayor que 2, lo que dificulta la ejecución de varios comandos aquery.

Como alternativa, se puede usar la marca --skyframe_state:

  # List all actions on Skyframe's action graph
  $ bazel aquery --output=proto --skyframe_state

  # or

  # List all actions on Skyframe's action graph, whose output matches "foo.out"
  $ bazel aquery --output=proto --skyframe_state 'outputs("foo.out")'

Con el modo --skyframe_state, aquery toma el contenido del Action Graph que Skyframe mantiene en la instancia de Bazel, (opcionalmente) lo filtra y genera el contenido, sin volver a ejecutar la fase de análisis.

Consideraciones especiales

Formato de salida

Actualmente, --skyframe_state solo está disponible para --output=proto y --output=textproto.

No se incluyen etiquetas de destino en la expresión de búsqueda.

Actualmente, --skyframe_state consulta todo el gráfico de acciones que existe en Skyframe, independientemente de los destinos. Se considera un error de sintaxis tener la etiqueta de destino especificada en la búsqueda junto con --skyframe_state:

  # WRONG: Target Included
  $ bazel aquery --output=proto --skyframe_state **//target_a**
  ERROR: Error while parsing '//target_a)': Specifying build target(s) [//target_a] with --skyframe_state is currently not supported.

  # WRONG: Target Included
  $ bazel aquery --output=proto --skyframe_state 'inputs(".*.java", **//target_a**)'
  ERROR: Error while parsing '//target_a)': Specifying build target(s) [//target_a] with --skyframe_state is currently not supported.

  # CORRECT: Without Target
  $ bazel aquery --output=proto --skyframe_state
  $ bazel aquery --output=proto --skyframe_state 'inputs(".*.java")'

Cómo comparar los resultados de aquery

Puedes comparar los resultados de dos invocaciones de aquery diferentes con la herramienta aquery_differ. Por ejemplo, cuando realizas algunos cambios en la definición de tu regla y deseas verificar que las líneas de comandos que se ejecutan no hayan cambiado. aquery_differ es la herramienta para eso.

La herramienta está disponible en el repositorio bazelbuild/bazel. Para usarlo, clona el repositorio en tu máquina local. Ejemplo de uso:

  $ bazel run //tools/aquery_differ -- \
  --before=/path/to/before.proto \
  --after=/path/to/after.proto \
  --input_type=proto \
  --attrs=cmdline \
  --attrs=inputs

El comando anterior muestra la diferencia entre los resultados de before y after aquery (qué acciones estaban presentes en uno pero no en el otro, qué acciones tienen diferentes entradas o líneas de comandos en cada resultado de aquery, etcétera). El resultado de ejecutar el comando anterior sería el siguiente:

  Aquery output 'after' change contains an action that generates the following outputs that aquery output 'before' change doesn't:
  ...
  /list of output files/
  ...

  [cmdline]
  Difference in the action that generates the following output(s):
    /path/to/abc.out
  --- /path/to/before.proto
  +++ /path/to/after.proto
  @@ -1,3 +1,3 @@
    ...
    /cmdline diff, in unified diff format/
    ...

Opciones de comando

--before, --after: Son los archivos de salida de aquery que se compararán.

--input_type=(proto|text_proto), default=proto: Es el formato de los archivos de entrada. Se proporciona compatibilidad con el resultado de proto y textproto de aquery.

--attrs=(cmdline|inputs), default=cmdline: Son los atributos de las acciones que se compararán.

Aspecto sobre aspecto

Es posible que los aspectos se apliquen uno encima del otro. El resultado de aquery de la acción generada por estos aspectos incluiría la ruta de Aspect, que es la secuencia de aspectos aplicados al destino que generó la acción.

Ejemplo de Aspect-on-Aspect:

  t0
  ^
  | <- a1
  t1
  ^
  | <- a2
  t2

Sea t_i un destino de la regla r_i, que aplica un aspecto a_i a sus dependencias.

Supongamos que a2 genera una acción X cuando se aplica al objetivo t0. El resultado de texto de bazel aquery --include_aspects 'deps(//t2)' para la acción X sería el siguiente:

  action ...
  Mnemonic: ...
  Target: //my_pkg:t0
  Configuration: ...
  AspectDescriptors: [//my_pkg:rule.bzl%**a2**(foo=...)
    -> //my_pkg:rule.bzl%**a1**(bar=...)]
  ...

Esto significa que la acción X se generó a partir del aspecto a2 aplicado a a1(t0), donde a1(t0) es el resultado del aspecto a1 aplicado al objetivo t0.

Cada AspectDescriptor tiene el siguiente formato:

  AspectClass([param=value,...])

AspectClass podría ser el nombre de la clase Aspect (para los aspectos nativos) o bzl_file%aspect_name (para los aspectos de Starlark). AspectDescriptor se ordenan según el orden topológico del gráfico de dependencia.

Vinculación con el perfil JSON

Si bien aquery proporciona información sobre las acciones que se ejecutan en una compilación (por qué se ejecutan y sus entradas y salidas), el perfil JSON nos indica el momento y la duración de su ejecución. Es posible combinar estos 2 conjuntos de información a través de un denominador común: el resultado principal de una acción.

Para incluir los resultados de las acciones en el perfil JSON, genera el perfil con --experimental_include_primary_output --noslim_profile. Los perfiles compactos no son compatibles con la inclusión de resultados principales. aquery incluye de forma predeterminada el resultado principal de una acción.

Actualmente, no proporcionamos una herramienta canónica para combinar estas 2 fuentes de datos, pero deberías poder compilar tu propio script con la información anterior.

Problemas conocidos

Cómo controlar acciones compartidas

A veces, las acciones se comparten entre los objetivos configurados.

En la fase de ejecución, esas acciones compartidas simplemente se consideran como una y solo se ejecutan una vez. Sin embargo, aquery opera en el grafo de acciones previo a la ejecución y posterior al análisis, por lo que trata a estos como acciones separadas cuyos artefactos de salida tienen el mismo execPath. Como resultado, los artefactos equivalentes aparecen duplicados.

La lista de problemas y funciones planificadas de aquery se puede encontrar en GitHub.

Preguntas frecuentes

La ActionKey sigue siendo la misma, aunque haya cambiado el contenido de un archivo de entrada.

En el contexto de aquery, ActionKey hace referencia al String obtenido de ActionAnalysisMetadata#getKey:

  Returns a string encoding all of the significant behaviour of this Action that might affect the
  output. The general contract of `getKey` is this: if the work to be performed by the
  execution of this action changes, the key must change.

  ...

  Examples of changes that should affect the key are:

  - Changes to the BUILD file that materially affect the rule which gave rise to this Action.
  - Changes to the command-line options, environment, or other global configuration resources
      which affect the behaviour of this kind of Action (other than changes to the names of the
      input/output files, which are handled externally).
  - An upgrade to the build tools which changes the program logic of this kind of Action
      (typically this is achieved by incorporating a UUID into the key, which is changed each
      time the program logic of this action changes).
  Note the following exception: for actions that discover inputs, the key must change if any
  input names change or else action validation may falsely validate.

Esto excluye los cambios en el contenido de los archivos de entrada y no se debe confundir con RemoteCacheClient#ActionKey.

Actualizaciones

Si tienes algún problema o solicitud de función, informa el problema aquí.