Visão geral da extensão

Nightly · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

Nesta página, descrevemos como estender a linguagem BUILD usando macros e regras.

As extensões do Bazel são arquivos que terminam em .bzl. Use uma instrução de carregamento para importar um símbolo de uma extensão.

Antes de aprender os conceitos mais avançados, primeiro:

Macros e regras

Uma macro é uma função que instancia regras. As macros vêm em dois tipos: simbólicas (novidade no Bazel 8) e legadas macros. Os dois tipos de macros são definidos de maneira diferente, mas se comportam quase da mesma forma do ponto de vista de um usuário. Uma macro é útil quando um arquivo BUILD fica muito repetitivo ou complexo, porque permite reutilizar algum código. A função é avaliada assim que o arquivo BUILD é lido. Após a avaliação do arquivo BUILD, o Bazel tem poucas informações sobre macros. Se a macro gerar uma genrule, o Bazel vai se comportar quase como se você tivesse declarado essa genrule no arquivo BUILD. A única exceção é que os destinos declarados em uma macro simbólica têm semântica de visibilidade especial: uma macro simbólica pode ocultar os destinos internos do restante do pacote.

Uma regra é mais poderosa do que uma macro. Ela pode acessar os internos do Bazel e ter controle total sobre o que está acontecendo. Por exemplo, ela pode transmitir informações para outras regras.

Se você quiser reutilizar uma lógica simples, comece com uma macro. Recomendamos uma macro simbólica, a menos que você precise oferecer suporte a versões mais antigas do Bazel. Se uma macro se tornar complexa, geralmente é uma boa ideia transformá-la em uma regra. O suporte a uma nova linguagem geralmente é feito com uma regra. As regras são para usuários avançados, e a maioria dos usuários nunca precisa escrever uma. Eles só carregam e chamam regras existentes.

Modelo de avaliação

Um build consiste em três fases.

  • Fase de carregamento. Primeiro, carregue e avalie todas as extensões e todos os arquivos BUILD necessários para o build. A execução dos arquivos BUILD apenas instancia regras (sempre que uma regra é chamada, ela é adicionada a um gráfico). É aqui que as macros são avaliadas.

  • Fase de análise. O código das regras é executado (a função implementation) e as ações são instanciadas. Uma ação descreve como gerar um conjunto de saídas de um conjunto de entradas, como "executar gcc em hello.c e receber hello.o". É necessário listar explicitamente quais arquivos serão gerados antes de executar os comandos reais. Em outras palavras, a fase de análise usa o gráfico gerado pela fase de carregamento e gera um gráfico de ações.

  • Fase de execução. As ações são executadas quando pelo menos uma das saídas é necessária. Se um arquivo estiver ausente ou se um comando não gerar uma saída, o build falhará. Os testes também são executados durante essa fase.

O Bazel usa o paralelismo para ler, analisar e avaliar os arquivos .bzl e BUILD. Um arquivo é lido no máximo uma vez por build, e o resultado da avaliação é armazenado em cache e reutilizado. Um arquivo é avaliado somente depois que todas as dependências dele (instruções load()) são resolvidas. Por design, o carregamento de um arquivo .bzl não tem efeito colateral visível. Ele apenas define valores e funções.

O Bazel tenta ser inteligente: ele usa a análise de dependências para saber quais arquivos precisam ser carregados, quais regras precisam ser analisadas e quais ações precisam ser executadas. Por exemplo, se uma regra gerar ações que não são necessárias para o build atual, elas não serão executadas.

Como criar extensões

Os dois links abaixo serão muito úteis ao escrever suas próprias extensões. Mantenha-os ao alcance:

Avançar

Além de macros e regras, talvez você queira escrever aspectos e regras de repositório.