Visão geral da extensão

Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

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 carga para importar um símbolo de uma extensão.

Antes de aprender os conceitos mais avançados, faça o seguinte:

Macros e regras

Uma macro é uma função que cria regras. Isso é útil quando um arquivo BUILD está ficando muito repetitivo ou complexo, porque permite reutilizar algum código. A função é avaliada assim que o arquivo BUILD é lido. Depois da avaliação do arquivo BUILD, o Bazel tem poucas informações sobre macros: se a macro gerar um genrule, o Bazel vai se comportar como se você tivesse escrito o genrule. Como resultado, bazel query vai listar apenas os genrule gerados.

Uma regra é mais eficiente do que uma macro. Ele 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. Se uma macro ficar complexa, é uma boa ideia transformá-la em uma regra. O suporte a um novo idioma geralmente é feito com uma regra. As regras são para usuários avançados, e a maioria das pessoas nunca vai precisar escrever uma. Elas apenas carregam e chamam regras existentes.

Modelo de avaliação

Uma 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 a build. A execução dos arquivos BUILD apenas instancia regras (cada vez 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 (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 "execute gcc em hello.c e receba 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ção.

  • Fase de execução. As ações são executadas quando pelo menos uma das saídas é necessária. Se um arquivo estiver faltando ou se um comando não gerar uma saída, o build vai falhar. Os testes também são executados nessa 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 só é avaliado depois que todas as dependências (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ência 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 ao alcance:

Indo mais longe

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