Conjuntos de ferramentas

<ph-0-0>

Nesta página, descrevemos o framework do conjunto de ferramentas, que é uma maneira dos autores de regras desacoplarem a lógica de regras da seleção de ferramentas baseada na plataforma. Recomendamos ler as páginas regras e plataformas antes de continuar. Esta página aborda por que os conjuntos de ferramentas são necessários, como defini-los e usá-los e como o Bazel seleciona um conjunto apropriado com base nas restrições da plataforma.

Motivação

Primeiro, vamos analisar os problemas que os conjuntos de ferramentas foram projetados para resolver. Suponha que você esteja escrevendo regras para oferecer suporte à linguagem de programação "bar". A regra bar_binary compila arquivos *.bar usando o compilador barc, uma ferramenta criada como outro destino no espaço de trabalho. Como os usuários que criam destinos bar_binary não precisam especificar uma dependência no compilador, você a torna uma dependência implícita adicionando-a à definição da regra como um atributo particular.

bar_binary = rule(
    implementation = _bar_binary_impl,
    attrs = {
        "srcs": attr.label_list(allow_files = True),
        ...
        "_compiler": attr.label(
            default = "//bar_tools:barc_linux",  # the compiler running on linux
            providers = [BarcInfo],
        ),
    },
)

//bar_tools:barc_linux agora é uma dependência de cada destino bar_binary, então ele será criado antes de qualquer destino bar_binary. Ele pode ser acessado pela função de implementação da regra, assim como qualquer outro atributo:

BarcInfo = provider(
    doc = "Information about how to invoke the barc compiler.",
    # In the real world, compiler_path and system_lib might hold File objects,
    # but for simplicity they are strings for this example. arch_flags is a list
    # of strings.
    fields = ["compiler_path", "system_lib", "arch_flags"],
)

def _bar_binary_impl(ctx):
    ...
    info = ctx.attr._compiler[BarcInfo]
    command = "%s -l %s %s" % (
        info.compiler_path,
        info.system_lib,
        " ".join(info.arch_flags),
    )
    ...

O problema aqui é que o rótulo do compilador está fixado no código em bar_binary, mas destinos diferentes podem precisar de compiladores diferentes, dependendo da plataforma para que estão sendo criados e em qual plataforma estão sendo criados, chamados de plataforma de destino e plataforma de execução, respectivamente. Além disso, o autor da regra nem necessariamente conhece todas as ferramentas e plataformas disponíveis. Portanto, não é possível codificá-las na definição da regra.

Uma solução não ideal seria transferir a carga para os usuários, tornando o atributo _compiler não particular. Em seguida, os destinos individuais podem ser fixados no código para criação para uma plataforma ou outra.

bar_binary(
    name = "myprog_on_linux",
    srcs = ["mysrc.bar"],
    compiler = "//bar_tools:barc_linux",
)

bar_binary(
    name = "myprog_on_windows",
    srcs = ["mysrc.bar"],
    compiler = "//bar_tools:barc_windows",
)

É possível melhorar essa solução usando select para escolher compiler com base na plataforma:

config_setting(
    name = "on_linux",
    constraint_values = [
        "@platforms//os:linux",
    ],
)

config_setting(
    name = "on_windows",
    constraint_values = [
        "@platforms//os:windows",
    ],
)

bar_binary(
    name = "myprog",
    srcs = ["mysrc.bar"],
    compiler = select({
        ":on_linux": "//bar_tools:barc_linux",
        ":on_windows": "//bar_tools:barc_windows",
    }),
)

Mas isso é tedioso e um pouco difícil de fazer para cada usuário do bar_binary. Se esse estilo não for usado de maneira consistente em todo o espaço de trabalho, ele vai criar builds que funcionam bem em uma única plataforma, mas falham quando estendidos a cenários multiplataforma. Ela também não resolve o problema de adicionar suporte a novas plataformas e compiladores sem modificar regras ou destinos existentes.

A estrutura do conjunto de ferramentas resolve esse problema adicionando um nível extra de indireção. Essencialmente, você declara que a regra tem uma dependência abstrata em algum membro de uma família de destinos (um tipo de conjunto de ferramentas), e o Bazel resolve isso automaticamente para um destino específico (um conjunto de ferramentas) com base nas restrições de plataforma aplicáveis. Nem o autor da regra nem o de destino precisam conhecer o conjunto completo de plataformas e conjuntos de ferramentas disponíveis.

Como escrever regras que usam conjuntos de ferramentas

No framework de conjunto de ferramentas, em vez de as regras dependerem diretamente de ferramentas, elas dependem de tipos de conjunto de ferramentas. Um tipo de conjunto de ferramentas é um destino simples que representa uma classe de ferramentas que atendem à mesma função em plataformas diferentes. Por exemplo, você pode declarar um tipo que representa o compilador de barras:

# By convention, toolchain_type targets are named "toolchain_type" and
# distinguished by their package path. So the full path for this would be
# //bar_tools:toolchain_type.
toolchain_type(name = "toolchain_type")

A definição de regra na seção anterior foi modificada para que, em vez de usar o compilador como um atributo, ele declare que consome um conjunto de ferramentas //bar_tools:toolchain_type.

bar_binary = rule(
    implementation = _bar_binary_impl,
    attrs = {
        "srcs": attr.label_list(allow_files = True),
        ...
        # No `_compiler` attribute anymore.
    },
    toolchains = ["//bar_tools:toolchain_type"],
)

A função de implementação agora acessa essa dependência em ctx.toolchains em vez de ctx.attr, usando o tipo de conjunto de ferramentas como a chave.

def _bar_binary_impl(ctx):
    ...
    info = ctx.toolchains["//bar_tools:toolchain_type"].barcinfo
    # The rest is unchanged.
    command = "%s -l %s %s" % (
        info.compiler_path,
        info.system_lib,
        " ".join(info.arch_flags),
    )
    ...

ctx.toolchains["//bar_tools:toolchain_type"] retorna o provedor ToolchainInfo de qualquer destino em que o Bazel resolveu a dependência do conjunto de ferramentas. Os campos do objeto ToolchainInfo são definidos pela regra da ferramenta subjacente. Na próxima seção, essa regra será definida de modo que haja um campo barcinfo que envolva um objeto BarcInfo.

O procedimento do Bazel para resolver conjuntos de ferramentas para destinos é descrito abaixo. Somente o destino do conjunto de ferramentas resolvido se torna uma dependência do destino bar_binary, não todo o espaço dos conjuntos de ferramentas candidatos.

Conjuntos de ferramentas obrigatórios e opcionais

Por padrão, quando uma regra expressa uma dependência do tipo de conjunto de ferramentas usando um rótulo básico (como mostrado acima), esse tipo é considerado obrigatório. Se o Bazel não encontrar um conjunto de ferramentas correspondente (consulte Resolução de conjunto de ferramentas abaixo) para um tipo de conjunto de ferramentas obrigatório, isso ocorrerá um erro, e a análise será interrompida.

Em vez disso, é possível declarar uma dependência de tipo de conjunto de ferramentas opcional desta maneira:

bar_binary = rule(
    ...
    toolchains = [
        config_common.toolchain_type("//bar_tools:toolchain_type", mandatory = False),
    ],
)

Quando um tipo de conjunto de ferramentas opcional não pode ser resolvido, a análise continua e o resultado de ctx.toolchains["//bar_tools:toolchain_type"] é None.

A função config_common.toolchain_type é obrigatória por padrão.

É possível usar os seguintes formulários:

  • Tipos de conjunto de ferramentas obrigatórios:
    • toolchains = ["//bar_tools:toolchain_type"]
    • toolchains = [config_common.toolchain_type("//bar_tools:toolchain_type")]
    • toolchains = [config_common.toolchain_type("//bar_tools:toolchain_type", mandatory = True)]
  • Tipos de conjunto de ferramentas opcionais:
    • toolchains = [config_common.toolchain_type("//bar_tools:toolchain_type", mandatory = False)]
bar_binary = rule(
    ...
    toolchains = [
        "//foo_tools:toolchain_type",
        config_common.toolchain_type("//bar_tools:toolchain_type", mandatory = False),
    ],
)

Também é possível misturar e combinar formulários na mesma regra. No entanto, se o mesmo tipo de conjunto de ferramentas for listado várias vezes, ele usará a versão mais estrita, em que o obrigatório é mais restrito do que opcional.

Como escrever aspectos que usam conjuntos de ferramentas

Os aspectos têm acesso à mesma API de conjunto de ferramentas como regras: é possível definir os tipos necessários, acessar os conjuntos de ferramentas por meio do contexto e usá-los para gerar novas ações usando o conjunto de ferramentas.

bar_aspect = aspect(
    implementation = _bar_aspect_impl,
    attrs = {},
    toolchains = ['//bar_tools:toolchain_type'],
)

def _bar_aspect_impl(target, ctx):
  toolchain = ctx.toolchains['//bar_tools:toolchain_type']
  # Use the toolchain provider like in a rule.
  return []

Como definir conjuntos de ferramentas

Para definir alguns conjuntos de ferramentas para um determinado tipo, três coisas são necessárias:

  1. Uma regra específica da linguagem que representa o tipo de ferramenta ou conjunto de ferramentas. Por convenção, o nome dessa regra é sufixado com "_conjunto de ferramentas".

    1. Observação:a regra \_toolchain não pode criar ações de build. Em vez disso, ele coleta artefatos de outras regras e os encaminha para a regra que usa o conjunto de ferramentas. Essa regra é responsável por criar todas as ações de build.

  2. Vários destinos desse tipo de regra, representando versões do conjunto de ferramentas ou ferramentas para diferentes plataformas.

  3. Para cada destino, um destino associado da regra genérica toolchain, para fornecer metadados usados pelo framework do conjunto de ferramentas. Este destino toolchain também se refere ao toolchain_type associado a esse conjunto de ferramentas. Isso significa que determinada regra _toolchain pode ser associada a qualquer toolchain_type e que somente uma instância toolchain que usa essa regra _toolchain que a regra seja associada a uma toolchain_type.

Para nosso exemplo em execução, aqui está a definição de uma regra bar_toolchain. Nosso exemplo tem apenas um compilador, mas outras ferramentas, como um vinculador, também podem ser agrupadas abaixo dele.

def _bar_toolchain_impl(ctx):
    toolchain_info = platform_common.ToolchainInfo(
        barcinfo = BarcInfo(
            compiler_path = ctx.attr.compiler_path,
            system_lib = ctx.attr.system_lib,
            arch_flags = ctx.attr.arch_flags,
        ),
    )
    return [toolchain_info]

bar_toolchain = rule(
    implementation = _bar_toolchain_impl,
    attrs = {
        "compiler_path": attr.string(),
        "system_lib": attr.string(),
        "arch_flags": attr.string_list(),
    },
)

A regra precisa retornar um provedor ToolchainInfo, que se torna o objeto que a regra de consumo recupera usando ctx.toolchains e o rótulo do tipo de conjunto de ferramentas. ToolchainInfo, assim como struct, pode conter pares arbitrários de valores de campo. A especificação de exatamente quais campos são adicionados ao ToolchainInfo precisa ser claramente documentada no tipo de conjunto de ferramentas. Neste exemplo, os valores retornam unidos em um objeto BarcInfo para reutilizar o esquema definido acima. Esse estilo pode ser útil para validação e reutilização de código.

Agora você pode definir destinos para compiladores barc específicos.

bar_toolchain(
    name = "barc_linux",
    arch_flags = [
        "--arch=Linux",
        "--debug_everything",
    ],
    compiler_path = "/path/to/barc/on/linux",
    system_lib = "/usr/lib/libbarc.so",
)

bar_toolchain(
    name = "barc_windows",
    arch_flags = [
        "--arch=Windows",
        # Different flags, no debug support on windows.
    ],
    compiler_path = "C:\\path\\on\\windows\\barc.exe",
    system_lib = "C:\\path\\on\\windows\\barclib.dll",
)

Por fim, você vai criar definições de toolchain para os dois destinos bar_toolchain. Essas definições vinculam os destinos específicos da linguagem ao tipo de conjunto de ferramentas e fornecem as informações de restrição que informam ao Bazel quando o conjunto é adequado para uma determinada plataforma.

toolchain(
    name = "barc_linux_toolchain",
    exec_compatible_with = [
        "@platforms//os:linux",
        "@platforms//cpu:x86_64",
    ],
    target_compatible_with = [
        "@platforms//os:linux",
        "@platforms//cpu:x86_64",
    ],
    toolchain = ":barc_linux",
    toolchain_type = ":toolchain_type",
)

toolchain(
    name = "barc_windows_toolchain",
    exec_compatible_with = [
        "@platforms//os:windows",
        "@platforms//cpu:x86_64",
    ],
    target_compatible_with = [
        "@platforms//os:windows",
        "@platforms//cpu:x86_64",
    ],
    toolchain = ":barc_windows",
    toolchain_type = ":toolchain_type",
)

O uso da sintaxe de caminho relativo acima sugere que essas definições estão todas no mesmo pacote, mas não há motivo para que o tipo de conjunto de ferramentas, os destinos do conjunto de ferramentas específicos da linguagem e os destinos de definição toolchain não possam estar todos em pacotes separados.

Consulte o go_toolchain para um exemplo real.

Conjuntos de ferramentas e configurações

Uma pergunta importante para os autores de regras é: quando um destino bar_toolchain é analisado, qual configuração ele vê e quais transições precisam ser usadas para dependências? O exemplo acima usa atributos de string, mas o que aconteceria com um conjunto de ferramentas mais complicado que depende de outros destinos no repositório do Bazel?

Vamos conferir uma versão mais complexa de bar_toolchain:

def _bar_toolchain_impl(ctx):
    # The implementation is mostly the same as above, so skipping.
    pass

bar_toolchain = rule(
    implementation = _bar_toolchain_impl,
    attrs = {
        "compiler": attr.label(
            executable = True,
            mandatory = True,
            cfg = "exec",
        ),
        "system_lib": attr.label(
            mandatory = True,
            cfg = "target",
        ),
        "arch_flags": attr.string_list(),
    },
)

O uso de attr.label é igual a de uma regra padrão, mas o significado do parâmetro cfg é um pouco diferente.

A dependência de um destino (chamado de "pai") para um conjunto de ferramentas por meio da resolução dele usa uma transição de configuração especial chamada "transição do conjunto de ferramentas". A transição do conjunto de ferramentas mantém a configuração da mesma, mas força a plataforma de execução a ser a mesma para o conjunto de ferramentas e para o pai. Caso contrário, a resolução do conjunto de ferramentas pode escolher qualquer plataforma de execução e não seria necessariamente igual à do pai. Isso permite que todas as dependências exec do conjunto de ferramentas também sejam executáveis para as ações de build do pai. Todas as dependências do conjunto de ferramentas que usam cfg = "target" (ou que não especificam cfg, já que "destino" é o padrão) são criadas para a mesma plataforma que o pai. Isso permite que as regras do conjunto de ferramentas contribuam com bibliotecas (o atributo system_lib acima) e ferramentas (o atributo compiler) para as regras de build que precisam delas. As bibliotecas do sistema são vinculadas ao artefato final e, portanto, precisam ser criadas para a mesma plataforma, enquanto o compilador é uma ferramenta invocada durante o build e precisa poder ser executado na plataforma de execução.

Como registrar e criar com conjuntos de ferramentas

Nesse ponto, todos os elementos básicos estão montados, e você só precisa disponibilizar os conjuntos de ferramentas para o procedimento de resolução do Bazel. Isso é feito registrando o conjunto de ferramentas, seja em um arquivo MODULE.bazel usando register_toolchains() ou transmitindo os rótulos dos conjuntos de ferramentas na linha de comando usando a sinalização --extra_toolchains.

register_toolchains(
    "//bar_tools:barc_linux_toolchain",
    "//bar_tools:barc_windows_toolchain",
    # Target patterns are also permitted, so you could have also written:
    # "//bar_tools:all",
    # or even
    # "//bar_tools/...",
)

Ao usar padrões de destino para registrar conjuntos de ferramentas, a ordem em que eles são registrados é determinada pelas seguintes regras:

  • Os conjuntos de ferramentas definidos em um subpacote de um pacote são registrados antes dos conjuntos de ferramentas definidos no próprio pacote.
  • Dentro de um pacote, os conjuntos de ferramentas são registrados na ordem lexicográfica dos nomes.

Agora, quando você criar um destino que dependa de um tipo de conjunto de ferramentas, um conjunto apropriado será selecionado com base nas plataformas de destino e execução.

# my_pkg/BUILD

platform(
    name = "my_target_platform",
    constraint_values = [
        "@platforms//os:linux",
    ],
)

bar_binary(
    name = "my_bar_binary",
    ...
)

bazel build //my_pkg:my_bar_binary --platforms=//my_pkg:my_target_platform

O Bazel verá que //my_pkg:my_bar_binary está sendo criado com uma plataforma que tem @platforms//os:linux e, portanto, resolverá a referência de //bar_tools:toolchain_type para //bar_tools:barc_linux_toolchain. Isso vai criar //bar_tools:barc_linux, mas não //bar_tools:barc_windows.

Resolução do conjunto de ferramentas

Para cada destino que usa conjuntos de ferramentas, o procedimento de resolução do conjunto de ferramentas do Bazel determina as dependências concretas do conjunto de ferramentas do destino. O procedimento usa como entrada um conjunto de tipos de conjunto de ferramentas obrigatórios, a plataforma de destino, a lista de plataformas de execução disponíveis e a lista de conjuntos de ferramentas disponíveis. As saídas dele são um conjunto de ferramentas selecionado para cada tipo, além de uma plataforma de execução selecionada para o destino atual.

As plataformas e os conjuntos de ferramentas de execução disponíveis são reunidos no gráfico de dependência externa por chamadas register_execution_platforms e register_toolchains em arquivos MODULE.bazel. Outras plataformas de execução e conjuntos de ferramentas também podem ser especificados na linha de comando usando --extra_execution_platforms e --extra_toolchains. A plataforma host é incluída automaticamente como uma plataforma de execução disponível. As plataformas e os conjuntos de ferramentas disponíveis são rastreados como listas ordenadas para determinismo, com preferência para os itens anteriores da lista.

O conjunto de conjuntos de ferramentas disponíveis, em ordem de prioridade, é criado usando --extra_toolchains e register_toolchains:

  1. Os conjuntos de ferramentas registrados usando --extra_toolchains são adicionados primeiro. Dentro deles, o último conjunto de ferramentas tem a prioridade mais alta.
  2. Conjuntos de ferramentas registrados usando register_toolchains no gráfico de dependência externa transitiva, na seguinte ordem: o primeiro conjunto de ferramentas mencionado tem a prioridade mais alta.
    1. Conjuntos de ferramentas registrados pelo módulo raiz, como o MODULE.bazel na raiz do espaço de trabalho.
    2. Conjuntos de ferramentas registrados no arquivo WORKSPACE do usuário, incluindo em qualquer macro invocada a partir desse arquivo.
    3. Conjuntos de ferramentas registrados por módulos não raiz (por exemplo, dependências especificadas pelo módulo raiz e as dependências correspondentes etc.);
    4. Conjuntos de ferramentas registrados no "sufixo WORKSPACE". Ele é usado apenas por determinadas regras nativas empacotadas com a instalação do Bazel.

OBSERVAÇÃO: pseudodestinos, como :all, :* e /..., são ordenados pelo mecanismo de carregamento de pacote do Bazel, que usa uma ordenação lexicográfica.

As etapas de resolução são as seguintes.

  1. Uma cláusula target_compatible_with ou exec_compatible_with corresponde a uma plataforma se, para cada constraint_value na lista, a plataforma também tiver esse constraint_value (explicitamente ou como um padrão).

    Se a plataforma tiver constraint_values de constraint_settings não referenciados pela cláusula, eles não afetarão a correspondência.

  2. Se o destino que está sendo criado especificar o atributo exec_compatible_with (ou a definição da regra especificar o argumento exec_compatible_with), a lista de plataformas de execução disponíveis será filtrada para remover as que não correspondam às restrições de execução.

  3. A lista de conjuntos de ferramentas disponíveis é filtrada para remover qualquer um que especifique target_settings que não corresponda à configuração atual.

  4. Para cada plataforma de execução disponível, você associa cada tipo de conjunto de ferramentas ao primeiro conjunto disponível, se houver, que seja compatível com essa plataforma e com a plataforma de destino.

  5. Qualquer plataforma de execução que não encontre um conjunto de ferramentas obrigatório compatível para um dos tipos é descartada. Das plataformas restantes, a primeira se torna a plataforma de execução do destino atual e os conjuntos de ferramentas associados (se houver) tornam-se dependências do destino.

A plataforma de execução escolhida é usada para executar todas as ações que o destino gera.

Nos casos em que o mesmo destino pode ser criado em várias configurações (como para CPUs diferentes) no mesmo build, o procedimento de resolução é aplicado de forma independente a cada versão do destino.

Se a regra usar grupos de execução, cada um deles fará a resolução do conjunto de ferramentas separadamente, e cada um deles terá a própria plataforma de execução e conjuntos de ferramentas.

Depuração de conjuntos de ferramentas

Se você está adicionando suporte para o conjunto de ferramentas a uma regra atual, use a sinalização --toolchain_resolution_debug=regex. Durante a resolução do conjunto de ferramentas, a sinalização fornece uma saída detalhada para tipos de conjunto de ferramentas ou nomes de destino que correspondem à variável regex. É possível usar .* para gerar todas as informações. O Bazel mostra nomes de conjuntos de ferramentas que verifica e pula durante o processo de resolução.

Caso você queira ver quais dependências de cquery são da resolução do conjunto de ferramentas, use a sinalização --transitions de cquery:

# Find all direct dependencies of //cc:my_cc_lib. This includes explicitly
# declared dependencies, implicit dependencies, and toolchain dependencies.
$ bazel cquery 'deps(//cc:my_cc_lib, 1)'
//cc:my_cc_lib (96d6638)
@bazel_tools//tools/cpp:toolchain (96d6638)
@bazel_tools//tools/def_parser:def_parser (HOST)
//cc:my_cc_dep (96d6638)
@local_config_platform//:host (96d6638)
@bazel_tools//tools/cpp:toolchain_type (96d6638)
//:default_host_platform (96d6638)
@local_config_cc//:cc-compiler-k8 (HOST)
//cc:my_cc_lib.cc (null)
@bazel_tools//tools/cpp:grep-includes (HOST)

# Which of these are from toolchain resolution?
$ bazel cquery 'deps(//cc:my_cc_lib, 1)' --transitions=lite | grep "toolchain dependency"
  [toolchain dependency]#@local_config_cc//:cc-compiler-k8#HostTransition -> b6df211