Uma regra define uma série de ações que o Bazel executa nas entradas para produzir um conjunto de saídas, que são referenciadas em provedores retornados pela função de implementação da regra. Por exemplo, uma regra binária C++ pode:
- Escolha um conjunto de arquivos de origem
.cpp
(entradas). - Execute
g++
nos arquivos de origem (ação). - Retorne o provedor
DefaultInfo
com a saída executável e outros arquivos que serão disponibilizados no ambiente de execução. - Retorne o provedor
CcInfo
com informações específicas de C++ coletadas do destino e das dependências dele.
Do ponto de vista do Bazel, g++
e as bibliotecas C++ padrão também são entradas
para essa regra. Como criador de regras, considere não apenas as entradas fornecidas pelo usuário para uma regra, mas também todas as ferramentas e bibliotecas necessárias para executar as ações.
Antes de criar ou modificar qualquer regra, conheça as fases de build do Bazel. É importante entender as três fases de um build (carregamento, análise e execução). Também é útil aprender sobre macros para entender a diferença entre regras e macros. Para começar, leia o tutorial sobre regras. Depois, use esta página como referência.
Algumas regras são incorporadas ao Bazel. Essas regras nativas, como
genrule
e filegroup
, oferecem suporte básico.
Ao definir suas próprias regras, você pode adicionar suporte a linguagens e ferramentas
que o Bazel não tem suporte nativo.
O Bazel fornece um modelo de extensibilidade para escrever regras usando a
linguagem Starlark. Essas regras são escritas em arquivos .bzl
, que
podem ser carregados diretamente de arquivos BUILD
.
Ao definir sua própria regra, você decide quais atributos ela aceita e como ela gera as saídas.
A função implementation
da regra define o comportamento exato durante a
fase de análise. Essa função não executa nenhum
comando externo. Em vez disso, ele registra ações que serão usadas
posteriormente durante a fase de execução para criar as saídas da regra, se forem
necessárias.
Criação de regras
Em um arquivo .bzl
, use a função rule para definir uma nova regra e armazene o resultado em uma variável global. A chamada para rule
especifica
atributos e uma
função de implementação:
example_library = rule(
implementation = _example_library_impl,
attrs = {
"deps": attr.label_list(),
...
},
)
Isso define um tipo de regra chamado example_library
.
A chamada para rule
também precisa especificar se a regra cria uma
saída executável (com executable = True
) ou especificamente
um executável de teste (com test = True
). Se o último for o último, a regra é uma regra de teste
e o nome da regra precisa terminar em _test
.
Instanciação de destino
As regras podem ser carregadas e chamadas em arquivos BUILD
:
load('//some/pkg:rules.bzl', 'example_library')
example_library(
name = "example_target",
deps = [":another_target"],
...
)
Cada chamada para uma regra de criação não retorna nenhum valor, mas tem o efeito colateral de definir um destino. Isso é chamado de instanciação da regra. Isso especifica um nome para o novo destino e os valores dos atributos dele.
As regras também podem ser chamadas com base em funções do Starlark e carregadas em arquivos .bzl
.
As funções do Starlark que chamam regras são chamadas de macros do Starlark.
Por fim, as macros Starlark precisam ser chamadas a partir de arquivos BUILD
e só podem ser
chamadas durante a fase de carregamento, quando os arquivos BUILD
são avaliados para instanciar destinos.
Atributos
Um atributo é um argumento de regra. Os atributos podem fornecer valores específicos para a implementação de um destino ou podem se referir a outros destinos, criando um gráfico de dependências.
Os atributos específicos das regras, como srcs
ou deps
, são definidos transmitindo um mapa
de nomes de atributos para esquemas (criados usando o módulo
attr
) para o parâmetro attrs
de rule
.
Atributos comuns, como
name
e visibility
, são adicionados implicitamente a todas as regras. Outros
atributos são adicionados implicitamente às
regras executáveis e de teste especificamente. Atributos que
são implicitamente adicionados a uma regra não podem ser incluídos no dicionário transmitido para
attrs
.
Atributos de dependência
As regras que processam o código-fonte geralmente definem os seguintes atributos para lidar com vários tipos de dependências:
srcs
especifica os arquivos de origem processados pelas ações de um destino. Muitas vezes, o esquema de atributo especifica quais extensões de arquivo são esperadas para o tipo de arquivo de origem que a regra processa. As regras para idiomas com arquivos principais geralmente especificam um atributohdrs
separado para cabeçalhos processados por um destino e os consumidores dele.deps
especifica dependências de código para um destino. O esquema de atributos precisa especificar quais provedores essas dependências precisam fornecer. Por exemplo,cc_library
forneceCcInfo
.- O
data
especifica os arquivos a serem disponibilizados no momento da execução para qualquer executável que dependa de um destino. Isso permite a especificação de arquivos arbitrários.
example_library = rule(
implementation = _example_library_impl,
attrs = {
"srcs": attr.label_list(allow_files = [".example"]),
"hdrs": attr.label_list(allow_files = [".header"]),
"deps": attr.label_list(providers = [ExampleInfo]),
"data": attr.label_list(allow_files = True),
...
},
)
Estes são exemplos de atributos de dependência. Qualquer atributo que especifique
um rótulo de entrada (aqueles definidos com
attr.label_list
,
attr.label
ou
attr.label_keyed_string_dict
)
especifica dependências de um determinado tipo
entre um destino e os destinos cujos rótulos (ou os objetos
Label
correspondentes) são listados nesse atributo quando o destino
é definido. O repositório e, possivelmente, o caminho para esses rótulos é resolvido em relação ao destino definido.
example_library(
name = "my_target",
deps = [":other_target"],
)
example_library(
name = "other_target",
...
)
Neste exemplo, other_target
é uma dependência de my_target
e, portanto,
other_target
é analisado primeiro. Será um erro se houver um ciclo no
gráfico de dependência dos destinos.
Atributos particulares e dependências implícitas
Um atributo de dependência com um valor padrão cria uma dependência implícita. Ela
é implícita porque faz parte do gráfico de destino que o usuário não
especifica em um arquivo BUILD
. As dependências implícitas são úteis para codificar uma relação entre uma regra e uma ferramenta (uma dependência de tempo de compilação, como um compilador), já que, na maioria das vezes, um usuário não está interessado em especificar qual ferramenta a regra usa. Dentro da função de implementação da regra, isso é tratado
da mesma forma que outras dependências.
Se você quiser fornecer uma dependência implícita sem permitir que o usuário
substitua esse valor, torne o atributo privado atribuindo um nome
que comece com um sublinhado (_
). Os atributos particulares precisam ter valores
padrão. Geralmente, só faz sentido usar atributos particulares para dependências
implícitas.
example_library = rule(
implementation = _example_library_impl,
attrs = {
...
"_compiler": attr.label(
default = Label("//tools:example_compiler"),
allow_single_file = True,
executable = True,
cfg = "exec",
),
},
)
Neste exemplo, cada destino do tipo example_library
tem uma dependência
implícita no compilador //tools:example_compiler
. Isso permite
que a função de implementação de example_library
gere ações que invocam o
compilador, mesmo que o usuário não tenha transmitido o rótulo como uma entrada. Como
_compiler
é um atributo particular, ctx.attr._compiler
sempre apontará para //tools:example_compiler
em todos os destinos desse tipo de
regra. Como alternativa, é possível nomear o atributo compiler
sem o
sublinhado e manter o valor padrão. Isso permite que os usuários substituam um
compilador diferente, se necessário, mas não exige reconhecimento do rótulo
do compilador.
As dependências implícitas geralmente são usadas para ferramentas que residem no mesmo repositório que a implementação da regra. Se a ferramenta vier da plataforma de execução ou de um repositório diferente, a regra precisará extrair essa ferramenta de um conjunto de ferramentas.
Atributos de saída
Os atributos de saída, como attr.output
e
attr.output_list
, declaram um arquivo de saída gerado pelo
destino. Eles diferem dos atributos de dependência de duas maneiras:
- Eles definem destinos de arquivo de saída em vez de se referirem a destinos definidos em outro lugar.
- Os destinos do arquivo de saída dependem do destino da regra instanciada, e não do contrário.
Normalmente, os atributos de saída são usados apenas quando uma regra precisa criar saídas com nomes definidos pelo usuário, que não podem ser baseados no nome de destino. Se uma regra tiver
um atributo de saída, ela normalmente será denominada out
ou outs
.
Os atributos de saída são a maneira preferencial de criar saídas pré-declaradas, que podem ser especificamente dependentes ou solicitadas na linha de comando.
Função de implementação
Todas as regras exigem uma função implementation
. Essas funções são executadas
estritamente na fase de análise e transformam o
gráfico de destinos gerado na fase de carregamento em um gráfico de
ações a serem realizadas durante a fase de execução. Dessa forma,
as funções de implementação não podem ler nem gravar arquivos.
As funções de implementação de regras geralmente são particulares (nomeadas com um sublinhado
à esquerda). Convencionalmente, eles recebem o mesmo nome da regra, mas com o sufixo
_impl
.
As funções de implementação usam exatamente um parâmetro: um
contexto de regra, convencionalmente chamado de ctx
. Eles retornam uma lista de provedores.
Destinos
As dependências são representadas no momento da análise como objetos
Target
. Esses objetos contêm os provedores gerados quando a função de implementação do destino foi executada.
ctx.attr
tem campos correspondentes aos nomes de cada
atributo de dependência, contendo objetos Target
que representam cada dependência
direta que usa esse atributo. Para atributos label_list
, esta é uma lista de
Targets
. Para atributos label
, é um único Target
ou None
.
Uma lista de objetos de provedor é retornada pela função de implementação de um destino:
return [ExampleInfo(headers = depset(...))]
Eles podem ser acessados usando a notação de índice ([]
), com o tipo de provedor como
chave. Eles podem ser provedores personalizados definidos no Starlark ou
provedores de regras nativas disponíveis como variáveis
globais do Starlark.
Por exemplo, se uma regra recebe arquivos de cabeçalho usando um atributo hdrs
e os fornece
às ações de compilação do destino e dos consumidores, ela pode
coletar esses arquivos assim:
def _example_library_impl(ctx):
...
transitive_headers = [hdr[ExampleInfo].headers for hdr in ctx.attr.hdrs]
Há um estilo de struct legado, que não é recomendado e é preciso migrar as regras dele.
Arquivos
Os arquivos são representados por objetos File
. Como o Bazel não
realiza a E/S de arquivos durante a fase de análise, esses objetos não podem ser usados para
ler ou gravar diretamente o conteúdo do arquivo. Em vez disso, elas são transmitidas para funções que emitem
ações (consulte ctx.actions
) para criar partes do
gráfico de ações.
Um File
pode ser um arquivo de origem ou um arquivo gerado. Cada arquivo gerado
precisa ser uma saída de exatamente uma ação. Os arquivos de origem não podem ser a saída de
nenhuma ação.
Para cada atributo de dependência, o campo correspondente de
ctx.files
contém uma lista das saídas padrão de todas
as dependências que usam esse atributo:
def _example_library_impl(ctx):
...
headers = depset(ctx.files.hdrs, transitive = transitive_headers)
srcs = ctx.files.srcs
...
ctx.file
contém um único File
ou None
para
atributos de dependência com especificações definidas como allow_single_file = True
.
ctx.executable
se comporta da mesma forma que ctx.file
, mas
contém apenas campos para atributos de dependência com especificações definidas como executable = True
.
Declaração de saídas
Durante a fase de análise, a função de implementação de uma regra pode criar saídas.
Como todos os rótulos precisam ser conhecidos durante a fase de carregamento, essas saídas extras não têm rótulos. Objetos File
para saídas podem ser criados usando
ctx.actions.declare_file
e
ctx.actions.declare_directory
.
Geralmente, os nomes das saídas são baseados no nome do destino,
ctx.label.name
:
def _example_library_impl(ctx):
...
output_file = ctx.actions.declare_file(ctx.label.name + ".output")
...
Para saídas pré-declaradas, como as criadas para
atributos de saída, os objetos File
podem ser recuperados
dos campos correspondentes de ctx.outputs
.
Ações
Uma ação descreve como gerar um conjunto de saídas com base em um conjunto de entradas, por exemplo, "executar gcc em hello.c e receber hello.o". Quando uma ação é criada, o Bazel não executa o comando imediatamente. Ele a registra em um gráfico de dependências, porque uma ação pode depender da saída de outra. Por exemplo, em C, o vinculador precisa ser chamado depois do compilador.
As funções de uso geral que criam ações são definidas em
ctx.actions
:
ctx.actions.run
, para executar um executável.ctx.actions.run_shell
, para executar um comando shell.ctx.actions.write
, para gravar uma string em um arquivo.ctx.actions.expand_template
, para gerar um arquivo com base em um modelo.
ctx.actions.args
pode ser usado para acumular
com eficiência os argumentos de ações. Ele evita o nivelamento de depsets até o
momento de execução:
def _example_library_impl(ctx):
...
transitive_headers = [dep[ExampleInfo].headers for dep in ctx.attr.deps]
headers = depset(ctx.files.hdrs, transitive = transitive_headers)
srcs = ctx.files.srcs
inputs = depset(srcs, transitive = [headers])
output_file = ctx.actions.declare_file(ctx.label.name + ".output")
args = ctx.actions.args()
args.add_joined("-h", headers, join_with = ",")
args.add_joined("-s", srcs, join_with = ",")
args.add("-o", output_file)
ctx.actions.run(
mnemonic = "ExampleCompile",
executable = ctx.executable._compiler,
arguments = [args],
inputs = inputs,
outputs = [output_file],
)
...
As ações fazem uma lista ou remoção de arquivos de entrada e geram uma lista (não vazia) de arquivos de saída. O conjunto de arquivos de entrada e saída precisa ser conhecido durante a fase de análise. Isso pode depender do valor dos atributos, incluindo provedores de dependências, mas não do resultado da execução. Por exemplo, se a ação executar o comando unzip, especifique quais arquivos você espera que sejam inflados antes de executar a descompactação. As ações que criam um número variável de arquivos internamente podem uni-los em um único arquivo (como zip, tar ou outro formato de arquivo).
As ações precisam listar todas as entradas. Listar entradas que não são usadas é permitido, mas ineficiente.
As ações precisam criar todas as saídas. Elas podem gravar outros arquivos, mas o que estiver fora das saídas não ficará disponível para os consumidores. Todas as saídas declaradas precisam ser gravadas por alguma ação.
As ações são comparáveis a funções puras: elas precisam depender apenas das entradas fornecidas e evitar acessar informações do computador, nome de usuário, relógio, rede ou dispositivos de E/S (exceto para leitura de entradas e saídas de gravação). Isso é importante porque a saída será armazenada em cache e reutilizada.
As dependências são resolvidas pelo Bazel, que decide quais ações executar. Caso haja um ciclo no gráfico de dependências, isso constituirá um erro. Criar uma ação não garante que ela será executada, mas isso depende se as saídas são necessárias para o build.
Provedores
Provedores são informações que uma regra expõe a outras regras que dependem deles. Esses dados podem incluir arquivos de saída, bibliotecas, parâmetros a serem transmitidos para a linha de comando de uma ferramenta ou qualquer outra informação que os consumidores de um destino precisem saber.
Como a função de implementação de uma regra só pode ler provedores das
dependências imediatas do destino instanciado, as regras precisam encaminhar todas
as informações das dependências de um destino que precisam ser conhecidas pelos consumidores
de um destino, geralmente acumulando-as em um depset
.
Os provedores de um destino são especificados por uma lista de objetos de provedor retornados pela função de implementação.
As funções de implementação antigas também podem ser escritas em um estilo legado em que
a função de implementação retorna um struct
em vez de uma lista de
objetos de provedor. Esse estilo não é recomendado, e as regras precisam ser migradas dele.
Saídas padrão
As saídas padrão de um destino são aquelas solicitadas por padrão quando
o destino é solicitado para build na linha de comando. Por exemplo, um
//pkg:foo
de destino java_library
tem foo.jar
como saída padrão, então ele
será criado pelo comando bazel build //pkg:foo
.
As saídas padrão são especificadas pelo parâmetro files
de
DefaultInfo
:
def _example_library_impl(ctx):
...
return [
DefaultInfo(files = depset([output_file]), ...),
...
]
Se DefaultInfo
não for retornado pela implementação de uma regra ou o parâmetro files
não for especificado, DefaultInfo.files
será padronizado para todas as saídas pré-declaradas (geralmente, aquelas criadas por atributos de saída).
As regras que executam ações precisam fornecer saídas padrão, mesmo que não se espere que elas sejam usadas diretamente. As ações que não estão no gráfico das saídas solicitadas são removidas. Se uma saída for usada apenas pelos consumidores de um destino, essas ações não serão realizadas quando o destino for criado de forma isolada. Isso dificulta a depuração, porque recriar apenas o destino com falha não reproduzirá a falha.
Arquivos de execução
Os arquivos de execução são um conjunto de arquivos usados por um destino no momento da execução, e não no tempo de build. Durante a fase de execução, o Bazel cria uma árvore de diretórios contendo links simbólicos que apontam para os arquivos de execução. Isso organiza o ambiente para o binário para que ele possa acessar os arquivos de execução durante o tempo de execução.
Os arquivos de execução podem ser adicionados manualmente durante a criação da regra.
Objetos runfiles
podem ser criados pelo método runfiles
no contexto da regra, ctx.runfiles
, e transmitidos para o
parâmetro runfiles
em DefaultInfo
. A saída executável das
regras executáveis é adicionada implicitamente aos arquivos de execução.
Algumas regras especificam atributos, geralmente chamados de
data
, com saídas adicionadas aos
arquivos de execução de um destino. Os arquivos de execução também precisam ser mesclados de data
, bem como
de qualquer atributo que possa fornecer código para execução final, geralmente
srcs
(que pode conter destinos filegroup
com data
associado) e
deps
.
def _example_library_impl(ctx):
...
runfiles = ctx.runfiles(files = ctx.files.data)
transitive_runfiles = []
for runfiles_attr in (
ctx.attr.srcs,
ctx.attr.hdrs,
ctx.attr.deps,
ctx.attr.data,
):
for target in runfiles_attr:
transitive_runfiles.append(target[DefaultInfo].default_runfiles)
runfiles = runfiles.merge_all(transitive_runfiles)
return [
DefaultInfo(..., runfiles = runfiles),
...
]
Provedores personalizados
Os provedores podem ser definidos usando a função provider
para transmitir informações específicas da regra:
ExampleInfo = provider(
"Info needed to compile/link Example code.",
fields = {
"headers": "depset of header Files from transitive dependencies.",
"files_to_link": "depset of Files from compilation.",
},
)
As funções de implementação de regras podem construir e retornar instâncias do provedor:
def _example_library_impl(ctx):
...
return [
...
ExampleInfo(
headers = headers,
files_to_link = depset(
[output_file],
transitive = [
dep[ExampleInfo].files_to_link for dep in ctx.attr.deps
],
),
)
]
Inicialização personalizada de provedores
É possível proteger a instanciação de um provedor com lógica personalizada de validação e pré-processamento. Isso pode ser usado para garantir que todas as instâncias do provedor atendam a determinadas invariantes ou para oferecer aos usuários uma API mais limpa para receber uma instância.
Para fazer isso, transmita um callback init
para a
função provider
. Se esse callback é fornecido, o
tipo de retorno de provider()
muda para uma tupla de dois valores: o símbolo do
provedor, que é o valor de retorno comum quando init
não é usado, e um "construtor
bruto".
Nesse caso, quando o símbolo do provedor for chamado, em vez de retornar diretamente
uma nova instância, ele encaminhará os argumentos para o callback init
. O
valor de retorno do callback precisa ser um dict que mapeia nomes de campos (strings) para valores.
Ele é usado para inicializar os campos da nova instância. O
callback pode ter qualquer assinatura e, se os argumentos não corresponderem à assinatura,
um erro vai ser relatado como se o callback tivesse sido invocado diretamente.
O construtor bruto, por outro lado, ignora o callback init
.
O exemplo a seguir usa init
para pré-processar e validar os argumentos:
# //pkg:exampleinfo.bzl
_core_headers = [...] # private constant representing standard library files
# Keyword-only arguments are preferred.
def _exampleinfo_init(*, files_to_link, headers = None, allow_empty_files_to_link = False):
if not files_to_link and not allow_empty_files_to_link:
fail("files_to_link may not be empty")
all_headers = depset(_core_headers, transitive = headers)
return {"files_to_link": files_to_link, "headers": all_headers}
ExampleInfo, _new_exampleinfo = provider(
fields = ["files_to_link", "headers"],
init = _exampleinfo_init,
)
Uma implementação de regra pode instanciar o provedor da seguinte forma:
ExampleInfo(
files_to_link = my_files_to_link, # may not be empty
headers = my_headers, # will automatically include the core headers
)
O construtor bruto pode ser usado para definir funções públicas alternativas de fábrica
que não passam pela lógica init
. Por exemplo, exampleinfo.bzl
pode definir:
def make_barebones_exampleinfo(headers):
"""Returns an ExampleInfo with no files_to_link and only the specified headers."""
return _new_exampleinfo(files_to_link = depset(), headers = all_headers)
Normalmente, o construtor bruto está vinculado a uma variável com nome que começa com um
sublinhado (_new_exampleinfo
acima) para que o código do usuário não a carregue e
gere instâncias arbitrárias de provedor.
Outro uso para init
é impedir que o usuário chame totalmente o símbolo do provedor e forçá-lo a usar uma função de fábrica:
def _exampleinfo_init_banned(*args, **kwargs):
fail("Do not call ExampleInfo(). Use make_exampleinfo() instead.")
ExampleInfo, _new_exampleinfo = provider(
...
init = _exampleinfo_init_banned)
def make_exampleinfo(...):
...
return _new_exampleinfo(...)
Regras executáveis e regras de teste
As regras executáveis definem destinos que podem ser invocados por um comando bazel run
.
As regras de teste são um tipo especial de regra executável em que os destinos também podem ser
invocados por um comando bazel test
. Regras executáveis e de teste são criadas
definindo o respectivo argumento executable
ou
test
como True
na chamada para rule
:
example_binary = rule(
implementation = _example_binary_impl,
executable = True,
...
)
example_test = rule(
implementation = _example_binary_impl,
test = True,
...
)
As regras de teste precisam ter nomes que terminem em _test
. Os nomes de destinos de teste também costumam
terminar em _test
por convenção, mas isso não é obrigatório. As regras que não são de teste não podem
ter esse sufixo.
Os dois tipos de regra precisam produzir um arquivo de saída executável (que pode ou não
ser pré-declarado) que será invocado pelos comandos run
ou test
. Para informar ao
Bazel quais saídas de uma regra serão usadas como esse executável, transmita-a como o
argumento executable
de um provedor DefaultInfo
retornado. Esse executable
é adicionado às saídas padrão da regra. Portanto, você
não precisa transmiti-lo para executable
e files
. Ele também é adicionado implicitamente
aos runfiles:
def _example_binary_impl(ctx):
executable = ctx.actions.declare_file(ctx.label.name)
...
return [
DefaultInfo(executable = executable, ...),
...
]
A ação que gera esse arquivo deve definir o bit executável no arquivo. Para
uma ação ctx.actions.run
ou
ctx.actions.run_shell
, isso precisa ser feito
pela ferramenta subjacente invocada pela ação. Para uma
ação ctx.actions.write
, transmita is_executable = True
.
Como comportamento legado, as regras executáveis têm uma
saída ctx.outputs.executable
pré-declarada especial. Esse arquivo servirá como
executável padrão se você não especificar um usando DefaultInfo
. Ele não poderá ser
usado de outra forma. Esse mecanismo de saída foi descontinuado porque não oferece suporte à
personalização do nome do arquivo executável no momento da análise.
Confira exemplos de uma regra executável e uma regra de teste.
Regras executáveis e regras de teste têm outros atributos definidos implicitamente, além daqueles adicionados para todas as regras. Os padrões de atributos implicitamente adicionados não podem ser alterados, mas isso pode ser contornado encapsulando uma regra particular em uma macro Starlark, que altera o padrão:
def example_test(size = "small", **kwargs):
_example_test(size = size, **kwargs)
_example_test = rule(
...
)
Local dos arquivos de execução
Quando um destino executável é executado com bazel run
(ou test
), a raiz do
diretório do runfiles é adjacente ao executável. Os caminhos se relacionam da seguinte maneira:
# Given launcher_path and runfile_file:
runfiles_root = launcher_path.path + ".runfiles"
workspace_name = ctx.workspace_name
runfile_path = runfile_file.short_path
execution_root_relative_path = "%s/%s/%s" % (
runfiles_root, workspace_name, runfile_path)
O caminho para um File
no diretório runfiles corresponde a
File.short_path
.
O binário executado diretamente por bazel
é adjacente à raiz do
diretório runfiles
. No entanto, os binários chamados dos arquivos de execução não podem
fazer a mesma suposição. Para atenuar isso, cada binário precisa fornecer uma maneira de
aceitar a raiz dos arquivos de execução como um parâmetro usando um ambiente, um argumento ou
uma sinalização de linha de comando. Isso permite que os binários transmitam a raiz dos arquivos de execução canônicos corretos
para os binários chamados. Se isso não for definido, um binário pode adivinhar que foi o
primeiro binário chamado e procurar um diretório adjacente dos arquivos de execução.
Temas avançados
Como solicitar arquivos de saída
Um único destino pode ter vários arquivos de saída. Quando um comando bazel build
é
executado, algumas das saídas dos destinos fornecidos ao comando são consideradas
solicitadas. O Bazel cria apenas esses arquivos solicitados e os arquivos de que
eles dependem direta ou indiretamente. Em termos do gráfico de ações, o Bazel executa apenas
as ações que são acessíveis como dependências transitivas dos
arquivos solicitados.
Além das saídas padrão, qualquer saída pré-declarada pode ser solicitada explicitamente na linha de comando. As regras podem especificar saídas
pré-declaradas usando atributos de saída. Nesse caso, o usuário escolhe explicitamente rótulos para as saídas ao instanciar a regra. Para acessar objetos
File
para atributos de saída, use o atributo
correspondente de ctx.outputs
. As regras também podem
definir implicitamente as saídas pré-declaradas com base
no nome do destino, mas esse recurso foi descontinuado.
Além das saídas padrão, há grupos de saída, que são coleções
de arquivos de saída que podem ser solicitados juntos. Eles podem ser solicitados com
--output_groups
. Por
exemplo, se um //pkg:mytarget
de destino for de um tipo de regra que tem um grupo de saída
debug_files
, esses arquivos poderão ser criados executando bazel build //pkg:mytarget
--output_groups=debug_files
. Como as saídas não pré-declaradas não têm rótulos,
elas só podem ser solicitadas aparecendo nas saídas padrão ou em um grupo de
saídas.
Os grupos de saída podem ser especificados com o
provedor OutputGroupInfo
. Observe que, ao contrário de muitos
provedores integrados, OutputGroupInfo
pode usar parâmetros com nomes arbitrários
para definir grupos de saída com esse nome:
def _example_library_impl(ctx):
...
debug_file = ctx.actions.declare_file(name + ".pdb")
...
return [
DefaultInfo(files = depset([output_file]), ...),
OutputGroupInfo(
debug_files = depset([debug_file]),
all_files = depset([output_file, debug_file]),
),
...
]
Além disso, ao contrário da maioria dos provedores, OutputGroupInfo
pode ser retornado por um aspecto e pelo destino da regra a que esse aspecto é aplicado, desde que eles não definam os mesmos grupos de saída. Nesse caso, os provedores resultantes
são mesclados.
Observe que, em geral, OutputGroupInfo
não deve ser usado para transmitir tipos específicos
de arquivos de um destino para as ações dos consumidores. Defina
provedores específicos de regras para isso.
Configurações
Imagine que você quer criar um binário C++ para uma arquitetura diferente. O build pode ser complexo e envolver várias etapas. Alguns dos binários intermediários, como compiladores e geradores de código, precisam ser executados na plataforma de execução, que pode ser seu host ou um executor remoto. Alguns binários, como a saída final, precisam ser criados para a arquitetura de destino.
Por esse motivo, o Bazel tem um conceito de "configurações" e transições. Os destinos mais importantes (aqueles solicitados na linha de comando) são integrados à configuração "destino", enquanto as ferramentas que precisam ser executadas na plataforma de execução são integradas a uma configuração "exec". As regras podem gerar ações diferentes com base na configuração, por exemplo, para alterar a arquitetura de CPU que é transmitida para o compilador. Em alguns casos, a mesma biblioteca pode ser necessária para configurações diferentes. Se isso acontecer, ele será analisado e possivelmente criado várias vezes.
Por padrão, o Bazel cria as dependências de um destino na mesma configuração do próprio destino, ou seja, sem transições. Quando uma dependência é uma ferramenta necessária para ajudar a criar o destino, o atributo correspondente precisa especificar uma transição para uma configuração "exec". Isso faz com que a ferramenta e todas as dependências dela sejam criadas para a plataforma de execução.
Para cada atributo de dependência, você pode usar cfg
para decidir se as dependências
precisam ser criadas na mesma configuração ou fazer a transição para uma configuração "exec".
Se um atributo de dependência tiver a flag executable = True
, cfg
precisará ser definido
explicitamente. Isso serve para evitar a criação acidental de uma ferramenta para a configuração
errada.
Confira um exemplo
Em geral, fontes, bibliotecas dependentes e executáveis que serão necessários no tempo de execução podem usar a mesma configuração.
As ferramentas executadas como parte do build (como compiladores ou geradores de código)
precisam ser criadas para uma configuração "exec". Nesse caso, especifique cfg = "exec"
no
atributo.
Caso contrário, os executáveis usados no momento da execução (como parte de um teste, por exemplo) precisam
ser criados para a configuração de destino. Nesse caso, especifique cfg = "target"
no
atributo.
A cfg = "target"
não faz nada de fato: é puramente um valor conveniente para
ajudar os designers de regras a definir as intenções explicitamente. Quando executable = False
,
que significa que cfg
é opcional, defina essa opção apenas quando ela realmente ajudar na legibilidade.
Você também pode usar cfg = my_transition
para usar
transições definidas pelo usuário, que permitem
aos autores de regras muita flexibilidade na mudança de configurações, com a
desvantagem de
tornar o gráfico de build maior e menos compreensível.
Observação: anteriormente, o Bazel não tinha o conceito de plataformas de execução. Em vez disso, todas as ações de build eram consideradas em execução na máquina host. As versões do Bazel anteriores à 6.0 criavam uma configuração de "host" distinta para representar isso. Se você vir referências a "host" no código ou na documentação antiga, é isso que ele se refere. Recomendamos o uso do Bazel 6.0 ou mais recente para evitar essa sobrecarga conceitual extra.
Fragmentos de configuração
As regras podem acessar
fragmentos de configuração, como
cpp
e java
. No entanto, todos os fragmentos necessários precisam ser declarados para
evitar erros de acesso:
def _impl(ctx):
# Using ctx.fragments.cpp leads to an error since it was not declared.
x = ctx.fragments.java
...
my_rule = rule(
implementation = _impl,
fragments = ["java"], # Required fragments of the target configuration
...
)
Links simbólicos dos arquivos de execução
Normalmente, o caminho relativo de um arquivo na árvore de arquivos de execução é o mesmo que o
caminho relativo desse arquivo na árvore de origem ou de saída gerada. Se por algum motivo
precisarem ser diferentes, especifique os argumentos root_symlinks
ou
symlinks
. O root_symlinks
é um dicionário de caminhos de mapeamento para
arquivos, em que os caminhos são relativos à raiz do diretório dos arquivos de execução. O dicionário symlinks
é o mesmo, mas os caminhos são implicitamente prefixados com o nome do espaço de trabalho principal (não com o nome do repositório que contém o destino atual).
...
runfiles = ctx.runfiles(
root_symlinks = {"some/path/here.foo": ctx.file.some_data_file2}
symlinks = {"some/path/here.bar": ctx.file.some_data_file3}
)
# Creates something like:
# sometarget.runfiles/
# some/
# path/
# here.foo -> some_data_file2
# <workspace_name>/
# some/
# path/
# here.bar -> some_data_file3
Se symlinks
ou root_symlinks
for usado, tenha cuidado para não mapear dois arquivos
diferentes para o mesmo caminho na árvore de arquivos de execução. Isso fará com que o build falhe
com um erro descrevendo o conflito. Para corrigir, é necessário modificar os argumentos ctx.runfiles
para remover a colisão. Essa verificação será feita para todos os destinos que usam sua regra, bem como para qualquer tipo que dependa deles. Isso é especialmente arriscado se é provável que sua ferramenta seja usada transitivamente
por outra ferramenta. Os nomes dos links simbólicos precisam ser exclusivos nos arquivos de execução de uma ferramenta e
em todas as dependências dela.
Cobertura de código
Quando o comando coverage
é executado,
o build pode precisar adicionar instrumentação de cobertura para determinados destinos. O
build também coleta a lista de arquivos de origem que estão instrumentados. O subconjunto de
destinos considerados é controlado pela flag
--instrumentation_filter
.
Os destinos de teste são excluídos, a menos que
--instrument_test_targets
seja especificado.
Se a implementação de uma regra adicionar instrumentação de cobertura no momento da criação, ela precisará
considerar isso na função de implementação.
ctx.coverage_instrumented retorna
True
no modo de cobertura se as origens de um destino precisarem ser instrumentadas:
# Are this rule's sources instrumented?
if ctx.coverage_instrumented():
# Do something to turn on coverage for this compile action
A lógica que sempre precisa estar ativada no modo de cobertura (independentemente de as origens de um alvo estarem instrumentadas especificamente ou não) pode ser condicionada em ctx.configuration.coverage_enabled.
Se a regra incluir diretamente fontes das dependências antes da compilação (como arquivos principais), talvez seja necessário ativar a instrumentação no momento da compilação caso as fontes das dependências precisem ser instrumentadas:
# Are this rule's sources or any of the sources for its direct dependencies
# in deps instrumented?
if (ctx.configuration.coverage_enabled and
(ctx.coverage_instrumented() or
any([ctx.coverage_instrumented(dep) for dep in ctx.attr.deps]))):
# Do something to turn on coverage for this compile action
As regras também precisam fornecer informações sobre quais atributos são relevantes para
cobertura com o provedor InstrumentedFilesInfo
, criado usando
coverage_common.instrumented_files_info
.
O parâmetro dependency_attributes
de instrumented_files_info
precisa listar
todos os atributos de dependência de ambiente de execução, incluindo dependências de código, como deps
, e
dependências de dados, como data
. O parâmetro source_attributes
precisará listar os
atributos de arquivos de origem da regra se a instrumentação de cobertura puder ser adicionada:
def _example_library_impl(ctx):
...
return [
...
coverage_common.instrumented_files_info(
ctx,
dependency_attributes = ["deps", "data"],
# Omitted if coverage is not supported for this rule:
source_attributes = ["srcs", "hdrs"],
)
...
]
Se InstrumentedFilesInfo
não for retornado, um padrão será criado com cada
atributo de dependência que não é de ferramenta e que não define
cfg
como "exec"
no esquema do atributo. em
dependency_attributes
. Esse não é um comportamento ideal, já que ele coloca atributos
como srcs
em dependency_attributes
em vez de source_attributes
, mas
evita a necessidade de configuração de cobertura explícita para todas as regras na
cadeia de dependências.
Ações de validação
Às vezes, você precisa validar algo sobre o build, e as informações necessárias para fazer essa validação estão disponíveis apenas em artefatos (arquivos de origem ou arquivos gerados). Como essas informações estão em artefatos, as regras não podem fazer essa validação no momento da análise, porque as regras não podem ler arquivos. Em vez disso, as ações precisam fazer essa validação no ambiente de execução. Quando a validação falha, a ação e o build também falham.
Exemplos de validações que podem ser executadas são análises estáticas, inspeção, verificações de dependência e consistência e verificações de estilo.
As ações de validação também podem melhorar o desempenho do build, movendo em ações separadas partes das ações que não são necessárias para criar artefatos. Por exemplo, se uma única ação que faz compilação e inspeção puder ser separada em uma ação de compilação e uma ação de inspeção, essa ação poderá ser executada como uma ação de validação e em paralelo com outras ações.
Essas "ações de validação" geralmente não produzem nada que é usado em outro lugar do build, já que elas só precisam declarar coisas sobre as entradas. No entanto, isso apresenta um problema: se uma ação de validação não produz nada que é usado em outro lugar no build, como uma regra faz com que a ação seja executada? Antes, a abordagem era fazer com que a ação de validação gerasse um arquivo vazio e adicioná-lo artificialmente às entradas de alguma outra ação importante no build:
Isso funciona porque o Bazel sempre executa a ação de validação quando a ação de compilação é executada, mas isso tem desvantagens significativas:
A ação de validação está no caminho crítico do build. Como ele pensa que a saída vazia é necessária para executar a ação de compilação, ele executará a ação de validação primeiro, mesmo que a ação de compilação ignore a entrada. Isso reduz o paralelismo e deixa os builds mais lentos.
Se outras ações no build puderem ser executadas em vez da ação de compilação, as saídas vazias das ações de validação também precisarão ser adicionadas a elas (a saída do jar de origem de
java_library
, por exemplo). Isso também será um problema se novas ações que podem ser executadas em vez da ação de compilação forem adicionadas posteriormente e a saída de validação vazia for acidentalmente interrompida.
A solução para esses problemas é usar o grupo de saída de validações.
Grupo de saída de validações
O grupo de saída de validações é um grupo de saída projetado para manter as saídas não usadas de ações de validação, para que não precisem ser adicionadas artificialmente às entradas de outras ações.
Esse grupo é especial, porque as saídas são sempre solicitadas, independente do
valor da sinalização --output_groups
e de como o destino é
dependente (por exemplo, na linha de comando, como uma dependência ou por
saídas implícitas do destino). O armazenamento em cache e a incrementabilidade normais ainda se aplicam: se as entradas da ação de validação não tiverem sido alteradas e a ação de validação tiver sido bem-sucedida anteriormente, a ação de validação não será executada.
O uso desse grupo de saída ainda exige que as ações de validação gerem algum arquivo, mesmo um vazio. Isso pode exigir o encapsulamento de algumas ferramentas que normalmente não criam saídas para que um arquivo seja criado.
As ações de validação de um destino não são executadas em três casos:
- Quando o alvo depende do alvo como ferramenta
- Quando o destino depende de uma dependência implícita (por exemplo, um atributo que começa com "_").
- Quando o destino é criado na configuração "exec".
Presume-se que esses destinos tenham os próprios builds e testes separados que revelariam falhas de validação.
Como usar o grupo de saída de validações
O grupo de saída de validações é chamado de _validation
e é usado como qualquer outro
grupo de saída:
def _rule_with_validation_impl(ctx):
ctx.actions.write(ctx.outputs.main, "main output\n")
ctx.actions.write(ctx.outputs.implicit, "implicit output\n")
validation_output = ctx.actions.declare_file(ctx.attr.name + ".validation")
ctx.actions.run(
outputs = [validation_output],
executable = ctx.executable._validation_tool,
arguments = [validation_output.path],
)
return [
DefaultInfo(files = depset([ctx.outputs.main])),
OutputGroupInfo(_validation = depset([validation_output])),
]
rule_with_validation = rule(
implementation = _rule_with_validation_impl,
outputs = {
"main": "%{name}.main",
"implicit": "%{name}.implicit",
},
attrs = {
"_validation_tool": attr.label(
default = Label("//validation_actions:validation_tool"),
executable = True,
cfg = "exec"
),
}
)
O arquivo de saída da validação não é adicionado a DefaultInfo
nem às
entradas de qualquer outra ação. A ação de validação de uma meta desse tipo de regra ainda será executada se o destino depender do rótulo, ou se as saídas implícitas do destino dependerem direta ou indiretamente.
Geralmente, é importante que as saídas das ações de validação entrem apenas no grupo de saída de validação e não sejam adicionadas às entradas de outras ações, porque isso pode derrotar os ganhos de paralelismo. No entanto, observe que o Bazel não tem nenhuma verificação especial para aplicar isso. Portanto, teste se as saídas da ação de validação não são adicionadas às entradas de nenhuma ação nos testes das regras do Starlark. Exemplo:
load("@bazel_skylib//lib:unittest.bzl", "analysistest")
def _validation_outputs_test_impl(ctx):
env = analysistest.begin(ctx)
actions = analysistest.target_actions(env)
target = analysistest.target_under_test(env)
validation_outputs = target.output_groups._validation.to_list()
for action in actions:
for validation_output in validation_outputs:
if validation_output in action.inputs.to_list():
analysistest.fail(env,
"%s is a validation action output, but is an input to action %s" % (
validation_output, action))
return analysistest.end(env)
validation_outputs_test = analysistest.make(_validation_outputs_test_impl)
Sinalização de ações de validação
A execução de ações de validação é controlada pela sinalização de linha de comando --run_validations
, que tem como padrão verdadeiro.
Recursos descontinuados
Saídas pré-declaradas descontinuadas
Há duas maneiras descontinuadas de usar saídas pré-declaradas:
O parâmetro
outputs
derule
especifica um mapeamento entre nomes de atributos de saída e modelos de string para gerar rótulos de saída pré-declarados. Prefira usar saídas não pré-declaradas e adicionar saídas explicitamente aDefaultInfo.files
. Use o rótulo do destino da regra como entrada para regras que consomem a saída em vez de um rótulo de saída pré-declarado.Para regras executáveis,
ctx.outputs.executable
se refere a uma saída executável pré-declarada com o mesmo nome do destino da regra. É melhor declarar a saída explicitamente, por exemplo, comctx.actions.declare_file(ctx.label.name)
, e garantir que o comando que gera o executável defina as permissões dele para permitir a execução. Transmita explicitamente a saída executável para o parâmetroexecutable
deDefaultInfo
.
Recursos dos arquivos de execução a serem evitados
ctx.runfiles
e o tipo runfiles
têm um conjunto complexo de recursos, muitos dos quais são mantidos por motivos legados.
As recomendações a seguir ajudam a reduzir a complexidade:
Evite o uso dos modos
collect_data
ecollect_default
dectx.runfiles
. Esses modos coletam implicitamente arquivos de execução em determinadas bordas de dependência fixadas no código de maneiras confusas. Em vez disso, adicione arquivos usando os parâmetrosfiles
outransitive_files
dectx.runfiles
ou mesclando arquivos de execução das dependências comrunfiles = runfiles.merge(dep[DefaultInfo].default_runfiles)
.Evite usar
data_runfiles
edefault_runfiles
do construtorDefaultInfo
. EspecifiqueDefaultInfo(runfiles = ...)
. A distinção entre arquivos de execução "padrão" e "dados" é mantida por motivos legados. Por exemplo, algumas regras colocam as saídas padrão emdata_runfiles
, mas não emdefault_runfiles
. Em vez de usardata_runfiles
, as regras precisam ambas incluir saídas padrão e mesclar emdefault_runfiles
a partir de atributos que fornecem arquivos de execução (geralmentedata
).Ao recuperar
runfiles
deDefaultInfo
(geralmente apenas para mesclar arquivos executáveis entre a regra atual e as dependências dela), useDefaultInfo.default_runfiles
, nãoDefaultInfo.data_runfiles
.
Como migrar de provedores legados
Antes, os provedores do Bazel eram campos simples no objeto Target
. Eles
foram acessados usando o operador de ponto e foram criados ao colocar o campo
em uma struct
retornada pela função
de implementação da regra em vez de uma lista de objetos de provedor:
return struct(example_info = struct(headers = depset(...)))
Esses provedores podem ser recuperados no campo correspondente do objeto Target
:
transitive_headers = [hdr.example_info.headers for hdr in ctx.attr.hdrs]
Esse estilo foi descontinuado e não deve ser usado em novos códigos. Consulte as informações a seguir que podem ajudar na migração. O novo mecanismo do provedor evita conflitos de nome. Ele também oferece suporte à ocultação de dados, exigindo que qualquer código que acesse uma instância do provedor a recupere usando o símbolo do provedor.
No momento, os provedores legados ainda são compatíveis. Uma regra pode retornar provedores legados e modernos da seguinte maneira:
def _old_rule_impl(ctx):
...
legacy_data = struct(x = "foo", ...)
modern_data = MyInfo(y = "bar", ...)
# When any legacy providers are returned, the top-level returned value is a
# struct.
return struct(
# One key = value entry for each legacy provider.
legacy_info = legacy_data,
...
# Additional modern providers:
providers = [modern_data, ...])
Se dep
for o objeto Target
resultante para uma instância dessa regra, os
provedores e o conteúdo deles poderão ser recuperados como dep.legacy_info.x
e
dep[MyInfo].y
.
Além de providers
, o struct retornado também pode ter vários outros
campos com um significado especial e, portanto, não criar um provedor legado
correspondente:
Os campos
files
,runfiles
,data_runfiles
,default_runfiles
eexecutable
correspondem aos campos com o mesmo nome deDefaultInfo
. Não é permitido especificar nenhum desses campos ao mesmo tempo em que retorna um provedorDefaultInfo
.O campo
output_groups
usa um valor de struct e corresponde a umOutputGroupInfo
.
Nas declarações de regras provides
e nas declarações
providers
de atributos
de dependência, os provedores legados são transmitidos como strings, e os provedores modernos são
transmitidos pelo símbolo Info
. Não se esqueça de mudar de strings para símbolos
ao migrar. Para conjuntos de regras grandes ou complexos em que é difícil atualizar
todas as regras atomicamente, pode ser mais fácil seguir esta sequência de
etapas:
Modifique as regras que produzem o provedor legado para produzir os provedores legados e modernos, usando a sintaxe anterior. No caso de regras que declaram que retornam o provedor legado, atualize essa declaração para incluir os provedores legados e os modernos.
Modifique as regras que consomem o provedor legado para consumir o provedor moderno. Se alguma declaração de atributo exigir o provedor legado, atualize-a também para exigir o provedor moderno. Outra opção é intercalar esse trabalho com a etapa 1, fazendo com que os consumidores aceitem ou exijam um dos dois provedores: teste a presença do provedor legado usando
hasattr(target, 'foo')
ou o novo provedor usandoFooInfo in target
.Remova totalmente o provedor legado de todas as regras.