Consulta configurable (cquery)

Informar un problema Ver fuente

cquery es una variante de query que controla correctamente select() y los efectos de las opciones de compilación en el gráfico de compilación.

Para ello, ejecuta los resultados de la fase de análisis de Bazel, que integra estos efectos. query, por el contrario, se ejecuta sobre los resultados de la fase de carga de Bazel antes de que se evalúen las opciones.

Por ejemplo:

$ cat > tree/BUILD <<EOF
sh_library(
    name = "ash",
    deps = select({
        ":excelsior": [":manna-ash"],
        ":americana": [":white-ash"],
        "//conditions:default": [":common-ash"],
    }),
)
sh_library(name = "manna-ash")
sh_library(name = "white-ash")
sh_library(name = "common-ash")
config_setting(
    name = "excelsior",
    values = {"define": "species=excelsior"},
)
config_setting(
    name = "americana",
    values = {"define": "species=americana"},
)
EOF
# Traditional query: query doesn't know which select() branch you will choose,
# so it conservatively lists all of possible choices, including all used config_settings.
$ bazel query "deps(//tree:ash)" --noimplicit_deps
//tree:americana
//tree:ash
//tree:common-ash
//tree:excelsior
//tree:manna-ash
//tree:white-ash

# cquery: cquery lets you set build options at the command line and chooses
# the exact dependencies that implies (and also the config_setting targets).
$ bazel cquery "deps(//tree:ash)" --define species=excelsior --noimplicit_deps
//tree:ash (9f87702)
//tree:manna-ash (9f87702)
//tree:americana (9f87702)
//tree:excelsior (9f87702)

Cada resultado incluye un identificador único (9f87702) de la configuración con la que se compila el destino.

Dado que cquery se ejecuta en el gráfico de destino configurado, no tiene estadísticas de artefactos, como las acciones de compilación, ni acceso a las reglas de test_suite, ya que no son objetivos configurados. Para obtener información sobre lo primero, consulta aquery.

Sintaxis básica

Una llamada a cquery simple se ve de la siguiente manera:

bazel cquery "function(//target)"

La expresión de consulta "function(//target)" consta de lo siguiente:

  • function(...) es la función que se ejecutará en el destino. cquery admite la mayoría de las funciones de query, además de algunas nuevas.
  • //target es la expresión que se ingresa a la función. En este ejemplo, la expresión es un objetivo simple. Pero el lenguaje de consulta también permite anidar funciones. Ve la Guía de consultas para ver ejemplos.

cquery requiere un destino para ejecutar las fases de carga y análisis. A menos que se especifique lo contrario, cquery analiza los destinos enumerados en la expresión de consulta. Consulta --universe_scope para consultar dependencias de objetivos de compilación de nivel superior.

Parámetros de configuración

La línea:

//tree:ash (9f87702)

significa que //tree:ash se compiló en una configuración con el ID 9f87702. Para la mayoría de los objetivos, este es un hash opaco de los valores de las opciones de compilación que definen la configuración.

Para ver el contenido completo de la configuración, ejecuta el siguiente comando:

$ bazel config 9f87702

9f87702 es un prefijo del ID completo. Esto se debe a que los IDs completos son hash SHA-256, que son largos y difíciles de seguir. cquery comprende cualquier prefijo válido de un ID completo, similar a los hashes cortos de Git. Para ver los IDs completos, ejecuta $ bazel config.

Evaluación del patrón de destino

//foo tiene un significado diferente para cquery que para query. Esto se debe a que cquery evalúa los destinos configurados y el gráfico de compilación puede tener varias versiones configuradas de //foo.

En el caso de cquery, un patrón de destino en la expresión de consulta se evalúa como cada destino configurado con una etiqueta que coincida con ese patrón. El resultado es determinista, pero cquery no ofrece ninguna garantía de ordenamiento más allá del contrato de pedido de consulta principal.

Esto produce resultados más sutiles para las expresiones de consulta que con query. Por ejemplo, lo siguiente puede producir varios resultados:

# Analyzes //foo in the target configuration, but also analyzes
# //genrule_with_foo_as_tool which depends on an exec-configured
# //foo. So there are two configured target instances of //foo in
# the build graph.
$ bazel cquery //foo --universe_scope=//foo,//genrule_with_foo_as_tool
//foo (9f87702)
//foo (exec)

Si deseas declarar con precisión qué instancia consultar, usa la función config.

Consulta la documentación de patrones de destino de query para obtener más información sobre los patrones de destino.

Funciones

Del conjunto de funciones compatibles con query, cquery es compatible con todas las funciones, excepto visible, siblings, buildfiles y tests.

cquery también presenta las siguientes funciones nuevas:

config

expr ::= config(expr, word)

El operador config intenta encontrar el destino configurado para la etiqueta denotada por el primer argumento y la configuración especificadas por el segundo argumento.

Los valores válidos para el segundo argumento son null o un hash de configuración personalizado. Los hash se pueden recuperar desde $ bazel config o desde el resultado de cquery anterior.

Ejemplos:

$ bazel cquery "config(//bar, 3732cc8)" --universe_scope=//foo
$ bazel cquery "deps(//foo)"
//bar (exec)
//baz (exec)

$ bazel cquery "config(//baz, 3732cc8)"

Si no se pueden encontrar todos los resultados del primer argumento en la configuración especificada, solo se muestran los que se pueden encontrar. Si no se pueden encontrar resultados en la configuración especificada, la consulta falla.

Opciones

Opciones de compilación

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

Usa opciones de cquery

--universe_scope (lista separada por comas)

A menudo, las dependencias de los destinos configurados pasan por transiciones, lo que hace que su configuración difiera de su dependiente. Esta marca te permite consultar un destino como si se hubiera compilado como una dependencia o una dependencia transitiva de otro destino. Por ejemplo:

# x/BUILD
genrule(
     name = "my_gen",
     srcs = ["x.in"],
     outs = ["x.cc"],
     cmd = "$(locations :tool) $< >$@",
     tools = [":tool"],
)
cc_binary(
    name = "tool",
    srcs = ["tool.cpp"],
)

Las genrules configuran sus herramientas en la configuración de ejecución para que las siguientes consultas produzcan los siguientes resultados:

Consulta Objetivo compilado Salida
cquery de bazel “//x:tool” //x:tool //x:tool(targetconfig)
cquery bazel "//x:tool" --universe_scope="x:my_gen" //x:my_gen //x:tool(execconfig)

Si se establece esta marca, se compila su contenido. Si no está configurada, se compilan todos los destinos mencionados en la expresión de consulta en su lugar. El cierre transitivo de los objetivos compilados se usa como el universo de la consulta. De cualquier manera, los destinos que se compilarán deben poder compilarse en el nivel superior (es decir, compatibles con las opciones de nivel superior). cquery muestra los resultados en el cierre transitivo de estos objetivos de nivel superior.

Incluso si es posible compilar todos los objetivos en una expresión de consulta en el nivel superior, puede ser beneficioso no hacerlo. Por ejemplo, configurar --universe_scope de manera explícita podría evitar compilar destinos varias veces en configuraciones que no te interesan. También te podría ayudar a especificar qué versión de configuración de un destino estás buscando (ya que por el momento no es posible especificar esto por completo de otra manera). Debes establecer esta marca si la expresión de consulta es más compleja que deps(//foo).

--implicit_deps (booleano, predeterminado=Verdadero)

Si estableces esta marca como falsa, se filtrarán todos los resultados que no se establezcan de forma explícita en el archivo BUILD y, en su lugar, Bazel configure en otro lugar. Esto incluye el filtrado de cadenas de herramientas resueltas.

--tool_deps (booleano, predeterminado=Verdadero)

Establecer esta marca en falso filtra todos los destinos configurados para los que la ruta desde el destino consultado hasta ellos atraviesa una transición entre la configuración de destino y las configuraciones que no son objetivo. Si el destino consultado está en la configuración de destino, establecer --notool_deps solo mostrará los destinos que también están en esa configuración. Si el destino consultado tiene una configuración ajena al objetivo, configurar --notool_deps solo mostrará los objetivos en configuraciones que no sean de destino. Esta configuración, por lo general, no afecta el filtrado de cadenas de herramientas resueltas.

--include_aspects (booleano, predeterminado=Verdadero)

Incluir las dependencias agregadas por aspects

Si esta marca está inhabilitada, cquery somepath(X, Y) y cquery deps(X) | grep 'Y' omiten Y si X solo depende de ella a través de un aspecto.

Formatos de salida

De forma predeterminada, cquery genera una lista ordenada por dependencias de pares de etiquetas y configuración. También hay otras opciones para exponer los resultados.

Transiciones

--transitions=lite
--transitions=full

Las transiciones de configuración se usan para compilar objetivos por debajo de los objetivos de nivel superior en configuraciones diferentes a las de los objetivos de nivel superior.

Por ejemplo, un destino podría imponer una transición a la configuración de ejecución en todas las dependencias de su atributo tools. Se conocen como transiciones de atributos. Las reglas también pueden imponer transiciones en su propia configuración, lo que se conoce como transiciones de clase de regla. Este formato de salida da como resultado información sobre estas transiciones, como su tipo y el efecto que tienen en las opciones de compilación.

Este formato de salida se activa con la marca --transitions que se establece en NONE de forma predeterminada. Se puede establecer en el modo FULL o LITE. El modo FULL genera información sobre las transiciones de clase de regla y las transiciones de atributos, incluida una diferencia detallada de las opciones antes y después de la transición. El modo LITE genera la misma información sin las diferencias de opciones.

Resultado del mensaje de protocolo

--output=proto

Esta opción hace que los destinos resultantes se impriman en un formulario de búfer de protocolo binario. La definición del búfer de protocolo se puede encontrar en src/main/protobuf/analysis_v2.proto.

CqueryResult es el mensaje de nivel superior que contiene los resultados de la consulta. Tiene una lista de mensajes ConfiguredTarget y una lista de mensajes Configuration. Cada ConfiguredTarget tiene un configuration_id cuyo valor es igual al del campo id del mensaje Configuration correspondiente.

--[no]proto:include_configurations

De forma predeterminada, los resultados de cquery muestran información de configuración como parte de cada destino configurado. Si deseas omitir esta información y obtener un resultado de proto con el mismo formato que el resultado de proto de la consulta, establece esta marca como falsa.

Consulta la documentación de resultados de proto de la consulta para obtener más opciones relacionadas con los resultados de proto.

Resultado del gráfico

--output=graph

Esta opción genera un resultado como un archivo .dot compatible con Graphviz. Consulta la documentación de resultados del gráfico de query para obtener más detalles. cquery también admite --graph:node_limit y --graph:factored.

Salida de archivos

--output=files

Esta opción imprime una lista de los archivos de salida producidos por cada destino que coincide con la consulta, similar a la lista impresa al final de una invocación bazel build. El resultado contiene solo los archivos anunciados en los grupos de salida solicitados, como lo determina la marca --output_groups. Sí incluye archivos fuente.

Todas las rutas de acceso que emite este formato de salida están relacionadas con execroot, que se puede obtener a través de bazel info execution_root. Si existe el symlink de conveniencia bazel-out, también se resuelven las rutas de acceso a los archivos del repositorio principal en relación con el directorio del lugar de trabajo.

Define el formato de salida con Starlark

--output=starlark

Este formato de salida llama a una función Starlark para cada destino configurado en el resultado de la consulta y, luego, imprime el valor que muestra la llamada. La marca --starlark:file especifica la ubicación de un archivo Starlark que define una función llamada format con un solo parámetro, target. Se llama a esta función para cada Destino en el resultado de la consulta. Como alternativa, para mayor comodidad, puedes especificar solo el cuerpo de una función declarada como def format(target): return expr con la marca --starlark:expr.

Dialecto "cquery" de Starlark

El entorno de cquery Starlark difiere de un archivo COMPILAR o .bzl. Incluye todas las constantes y funciones principales integradas de Starlark, además de algunas específicas de cquery que se describen a continuación, pero no glob, native ni rule (por ejemplo,) y no admite sentencias de carga.

build_options(target)

build_options(target) muestra un mapa cuyas claves son identificadores de opciones de compilación (consulta Configuraciones) y cuyos valores son sus valores de Starlark. Las opciones de compilación cuyos valores no son legales de Starlark se omiten de este mapa.

Si el destino es un archivo de entrada, build_options(target) muestra Ninguno, ya que los objetivos del archivo de entrada tienen una configuración nula.

proveedores(objetivo)

providers(target) muestra un mapa cuyas claves son nombres de proveedores (por ejemplo, "DefaultInfo") y cuyos valores son sus valores de Starlark. Los proveedores cuyos valores no son valores legales de Starlark se omiten de este mapa.

Ejemplos

Muestra una lista separada por espacios de los nombres base de todos los archivos que produce //foo:

  bazel cquery //foo --output=starlark \
    --starlark:expr="' '.join([f.basename for f in target.files.to_list()])"

Imprime una lista separada por espacios de las rutas de todos los archivos que producen los objetivos rule en //bar y sus subpaquetes:

  bazel cquery 'kind(rule, //bar/...)' --output=starlark \
    --starlark:expr="' '.join([f.path for f in target.files.to_list()])"

Imprime una lista de los mnemónicos de todas las acciones registradas por //foo.

  bazel cquery //foo --output=starlark \
    --starlark:expr="[a.mnemonic for a in target.actions]"

Imprime una lista de resultados de compilación registrados por un //baz cc_library.

  bazel cquery //baz --output=starlark \
    --starlark:expr="[f.path for f in target.output_groups.compilation_outputs.to_list()]"

Muestra el valor de la opción de línea de comandos --javacopt cuando compilas //foo.

  bazel cquery //foo --output=starlark \
    --starlark:expr="build_options(target)['//command_line_option:javacopt']"

Imprime la etiqueta de cada objetivo con exactamente un resultado. En este ejemplo, se usan las funciones de Starlark definidas en un archivo.

  $ cat example.cquery

  def has_one_output(target):
    return len(target.files.to_list()) == 1

  def format(target):
    if has_one_output(target):
      return target.label
    else:
      return ""

  $ bazel cquery //baz --output=starlark --starlark:file=example.cquery

Imprime la etiqueta de cada destino, que es estrictamente Python 3. En este ejemplo, se usan las funciones de Starlark definidas en un archivo.

  $ cat example.cquery

  def format(target):
    p = providers(target)
    py_info = p.get("PyInfo")
    if py_info and py_info.has_py3_only_sources:
      return target.label
    else:
      return ""

  $ bazel cquery //baz --output=starlark --starlark:file=example.cquery

Extrae un valor de un proveedor definido por el usuario.

  $ cat some_package/my_rule.bzl

  MyRuleInfo = provider(fields={"color": "the name of a color"})

  def _my_rule_impl(ctx):
      ...
      return [MyRuleInfo(color="red")]

  my_rule = rule(
      implementation = _my_rule_impl,
      attrs = {...},
  )

  $ cat example.cquery

  def format(target):
    p = providers(target)
    my_rule_info = p.get("//some_package:my_rule.bzl%MyRuleInfo'")
    if my_rule_info:
      return my_rule_info.color
    return ""

  $ bazel cquery //baz --output=starlark --starlark:file=example.cquery

cquery y query

cquery y query se complementan y se destacan en diferentes nichos. Ten en cuenta la siguiente información para decidir cuál es la más adecuada para ti:

  • cquery sigue ramas select() específicas para modelar el gráfico exacto que compilas. query no sabe qué rama elige la compilación, por lo que se sobreestima cuando incluye todas las ramas.
  • La precisión de cquery requiere compilar más del gráfico que query. En particular, cquery evalúa los destinos configurados, mientras que query solo evalúa los objetivos. Esto lleva más tiempo y utiliza más memoria.
  • La interpretación de cquery del lenguaje de consulta presenta una ambigüedad que query evita. Por ejemplo, si "//foo" existe en dos configuraciones, ¿cuál debe usar cquery "deps(//foo)"? La función config puede ayudar con esto.
  • Como herramienta más nueva, cquery no es compatible con ciertos casos de uso. Consulta Problemas conocidos para obtener más detalles.

Errores conocidos

Todos los destinos que "compila" cquery deben tener la misma configuración.

Antes de evaluar las consultas, cquery activa una compilación hasta justo antes del punto en el que se ejecutarían las acciones de compilación. Los destinos que "compila" están seleccionados de forma predeterminada entre todas las etiquetas que aparecen en la expresión de la consulta (esto se puede anular con --universe_scope). Estos deben tener la misma configuración.

Si bien estas suelen compartir la configuración de “objetivo” de nivel superior, las reglas pueden cambiar su propia configuración con las transiciones perimetrales entrantes. Aquí es donde cquery no cumple con los requisitos.

Solución alternativa: Si es posible, configura --universe_scope en un alcance más estricto. Por ejemplo:

# This command attempts to build the transitive closures of both //foo and
# //bar. //bar uses an incoming edge transition to change its --cpu flag.
$ bazel cquery 'somepath(//foo, //bar)'
ERROR: Error doing post analysis query: Top-level targets //foo and //bar
have different configurations (top-level targets with different
configurations is not supported)

# This command only builds the transitive closure of //foo, under which
# //bar should exist in the correct configuration.
$ bazel cquery 'somepath(//foo, //bar)' --universe_scope=//foo

No se admite --output=xml.

Resultado no determinista.

cquery no limpia automáticamente el gráfico de compilación de los comandos anteriores y, por lo tanto, tiende a recopilar resultados de consultas anteriores. Por ejemplo, genrule ejerce una transición de ejecución en su atributo tools, es decir, configura sus herramientas en la configuración de ejecución.

A continuación, puedes ver los efectos persistentes de esa transición.

$ cat > foo/BUILD <<<EOF
genrule(
    name = "my_gen",
    srcs = ["x.in"],
    outs = ["x.cc"],
    cmd = "$(locations :tool) $< >$@",
    tools = [":tool"],
)
cc_library(
    name = "tool",
)
EOF

    $ bazel cquery "//foo:tool"
tool(target_config)

    $ bazel cquery "deps(//foo:my_gen)"
my_gen (target_config)
tool (exec_config)
...

    $ bazel cquery "//foo:tool"
tool(exec_config)

Solución alternativa: Cambia cualquier opción de inicio para forzar un nuevo análisis de los destinos configurados. Por ejemplo, agrega --test_arg=<whatever> al comando de compilación.

Solución de problemas

Patrones de objetivos recurrentes (/...)

Si encuentras lo siguiente:

$ bazel cquery --universe_scope=//foo:app "somepath(//foo:app, //foo/...)"
ERROR: Error doing post analysis query: Evaluation failed: Unable to load package '[foo]'
because package is not in scope. Check that all target patterns in query expression are within the
--universe_scope of this query.

Esto sugiere, de manera incorrecta, que el paquete //foo no está dentro del alcance aunque --universe_scope=//foo:app lo incluya. Esto se debe a limitaciones de diseño en cquery. Como solución alternativa, incluye de forma explícita //foo/... en el alcance del universo:

$ bazel cquery --universe_scope=//foo:app,//foo/... "somepath(//foo:app, //foo/...)"

Si eso no funciona (por ejemplo, porque algún destino en //foo/... no puede compilar con las marcas de compilación elegidas), desenvuelve manualmente el patrón en los paquetes constituyentes con una consulta de procesamiento previo:

# Replace "//foo/..." with a subshell query call (not cquery!) outputting each package, piped into
# a sed call converting "<pkg>" to "//<pkg>:*", piped into a "+"-delimited line merge.
# Output looks like "//foo:*+//foo/bar:*+//foo/baz".
#
$  bazel cquery --universe_scope=//foo:app "somepath(//foo:app, $(bazel query //foo/...
--output=package | sed -e 's/^/\/\//' -e 's/$/:*/' | paste -sd "+" -))"