Consulta do gráfico de ações (aquery)

Reportar um problema Ver a fonte Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

O comando aquery permite consultar ações no gráfico de build. Ele opera no gráfico de destino configurado pós-análise e expõe informações sobre ações, artefatos e os relacionamentos entre eles.

aquery é útil quando você tem interesse nas propriedades das ações/artefatos gerados no gráfico de destino configurado. Por exemplo, os comandos reais executados e as entradas/saídas/mnemônicos deles.

A ferramenta aceita várias opções de linha de comando. O comando aquery é executado em cima de um build regular do Bazel e herda o conjunto de opções disponíveis durante um build.

Ele oferece suporte ao mesmo conjunto de funções disponíveis para query tradicional, mas não para siblings, buildfiles e tests.

Exemplo de saída aquery (sem detalhes específicos):

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

Sintaxe básica

Confira um exemplo simples da sintaxe de aquery:

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

A expressão de consulta (entre aspas) consiste no seguinte:

  • aquery_function(...): funções específicas de aquery. Mais detalhes abaixo.
  • function(...): as funções padrão como query tradicionais.
  • //target é o rótulo do destino de interesse.
# 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))'

Como usar funções aquery

Há três funções aquery:

  • inputs: filtra ações por entradas.
  • outputs: filtrar ações por saídas
  • mnemonic: filtrar ações por mnemônico

expr ::= inputs(word, expr)

O operador inputs retorna as ações geradas na criação de expr, cujos nomes de arquivos de entrada correspondem à regex fornecida por word.

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

As funções outputs e mnemonic compartilham uma sintaxe semelhante.

Também é possível combinar funções para realizar a operação AND. Exemplo:

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

O comando acima encontraria todas as ações envolvidas na criação de //src/target_a, cujos mnemônicos correspondem a "Cpp.*" e as entradas correspondem aos padrões ".*cpp" e "foo.*".

Exemplo do erro de sintaxe produzido:

        $ 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))

Opções

Opções de build

O aquery é executado em cima de um build normal do Bazel e, portanto, herda o conjunto de opções disponíveis durante um build.

Opções de Aquery

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

O formato de saída padrão (text) é legível por humanos. Use proto, textproto ou jsonproto para um formato legível por máquina. A mensagem proto é analysis.ActionGraphContainer.

--include_commandline, default=true

Inclui o conteúdo das linhas de comando de ação na saída (potencialmente grande).

--include_artifacts, default=true

Inclui nomes das entradas e saídas de ação na saída (potencialmente grande).

--include_aspects, default=true

Determina se é para incluir ações geradas pela Aspect na saída.

--include_param_files, default=false

Inclua o conteúdo dos arquivos de parâmetros usados no comando (potencialmente grandes).

--include_file_write_contents, default=false

Inclua o conteúdo do arquivo para a ação actions.write() e o conteúdo do arquivo de manifesto para a ação SourceSymlinkManifest. O conteúdo do arquivo é retornado no campo file_contents com --output=xxxproto. Com --output=text, a saída tem a linha FileWriteContents: [<base64-encoded file contents>]

--skyframe_state, default=false

Sem realizar análises extras, despeje o Action Graph do Skyframe.

Outras ferramentas e recursos

Consultar o estado do Skyframe

O Skyframe é o modelo de avaliação e incrementalidade do Bazel. Em cada instância do servidor Bazel, o Skyframe armazena o gráfico de dependência criado nas execuções anteriores da fase de análise.

Em alguns casos, é útil consultar o Action Graph no Skyframe. Um exemplo de caso de uso:

  1. Executar bazel build //target_a
  2. Executar bazel build //target_b
  3. O arquivo foo.out foi gerado.

Como usuário do Bazel, quero determinar se foo.out foi gerado da criação de //target_a ou //target_b.

É possível executar bazel aquery 'outputs("foo.out", //target_a)' e bazel aquery 'outputs("foo.out", //target_b)' para descobrir a ação responsável por criar foo.out e, por sua vez, o destino. No entanto, o número de diferentes metas criadas anteriormente pode ser maior que 2, o que torna a execução de vários comandos aquery um incômodo.

Como alternativa, use a flag --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")'

No modo --skyframe_state, o aquery usa o conteúdo do Action Graph que o Skyframe mantém na instância do Bazel, (opcionalmente) realiza a filtragem e gera o conteúdo, sem executar novamente a fase de análise.

Considerações especiais

Formato da saída

No momento, o --skyframe_state está disponível apenas para --output=proto e --output=textproto

Não inclusão de rótulos de destino na expressão de consulta

No momento, o --skyframe_state consulta todo o gráfico de ações que existe no Skyframe, independente das metas. Especificar o rótulo de destino na consulta com --skyframe_state é considerado um erro de sintaxe:

  # 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")'

Comparar resultados de aquery

É possível comparar as saídas de duas invocações de aquery diferentes usando a ferramenta aquery_differ. Por exemplo, quando você faz algumas mudanças na definição da regra e quer verificar se as linhas de comando em execução não foram alteradas. aquery_differ é a ferramenta para isso.

A ferramenta está disponível no repositório bazelbuild/bazel. Para usar, clone o repositório na sua máquina local. Exemplo de uso:

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

O comando acima retorna a diferença entre as saídas de aquery before e after: quais ações estavam presentes em uma, mas não na outra, quais ações têm diferentes linhas de comando/entradas em cada saída de aquery etc. O resultado da execução do comando acima seria:

  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/
    ...

Opções de comando

--before, --after: os arquivos de saída da aquery a serem comparados

--input_type=(proto|text_proto), default=proto: o formato dos arquivos de entrada. O suporte é fornecido para a saída de aquery proto e textproto.

--attrs=(cmdline|inputs), default=cmdline: os atributos das ações a serem comparadas.

Aspecto sobre aspecto

É possível aplicar Aspectos uns sobre os outros. A saída aquery da ação gerada por esses aspectos incluiria o caminho do aspecto, que é a sequência de aspectos aplicados ao destino que gerou a ação.

Exemplo de aspecto sobre aspecto:

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

Seja ti um destino da regra ri, que aplica um aspecto ai às dependências dele.

Suponha que a2 gere uma ação X quando aplicada ao destino t0. A saída de texto de bazel aquery --include_aspects 'deps(//t2)' para a ação X seria:

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

Isso significa que a ação X foi gerada pelo aspecto a2 aplicado a a1(t0), em que a1(t0) é o resultado do aspecto a1 aplicado ao destino t0.

Cada AspectDescriptor tem o seguinte formato:

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

AspectClass pode ser o nome da classe Aspect (para aspectos nativos) ou bzl_file%aspect_name (para aspectos do Starlark). AspectDescriptor são classificados em ordem topológica do gráfico de dependência.

Como vincular com o perfil JSON

Enquanto o aquery fornece informações sobre as ações em execução em um build (por que elas estão sendo executadas, entradas/saídas), o perfil JSON informa o tempo e a duração da execução. É possível combinar esses dois conjuntos de informações usando um denominador comum: a saída principal de uma ação.

Para incluir as saídas das ações no perfil JSON, gere o perfil com --experimental_include_primary_output --noexperimental_slim_json_profile. Os perfis compactos são incompatíveis com a inclusão de saídas principais. A saída principal de uma ação é incluída por padrão por uma aquery.

No momento, não oferecemos uma ferramenta canônica para combinar essas duas fontes de dados, mas você pode criar seu próprio script com as informações acima.

Problemas conhecidos

Como processar ações compartilhadas

Às vezes, as ações são compartilhadas entre os destinos configurados.

Na fase de execução, essas ações compartilhadas são consideradas como uma só e executadas apenas uma vez. No entanto, aquery opera no gráfico de ações de pré-execução e pós-análise e, portanto, trata esses como ações separadas cujos artefatos de saída têm exatamente o mesmo execPath. Como resultado, os artefatos equivalentes aparecem duplicados.

A lista de problemas do aquery/recursos planejados pode ser encontrada no GitHub.

Perguntas frequentes

A ActionKey permanece a mesma, mesmo que o conteúdo de um arquivo de entrada tenha mudado.

No contexto de uma aquery, ActionKey se refere ao String obtido 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.

Isso exclui as mudanças no conteúdo dos arquivos de entrada e não deve ser confundido com RemoteCacheClient#ActionKey.

Atualizações

Se tiver algum problema ou quiser pedir um recurso, registre um problema aqui.