Como usar o Bazel no Windows

<ph-0-0>

Nesta página, você verá as práticas recomendadas para usar o Bazel no Windows. Para instruções de instalação, consulte Instalar o Bazel no Windows.

Problemas conhecidos

Os problemas do Bazel relacionados ao Windows são marcados com o rótulo "team-Windows" no GitHub. Confira os problemas em aberto aqui.

Práticas recomendadas

Evitar problemas de caminho longo

Algumas ferramentas têm a limitação máxima do tamanho do caminho no Windows, incluindo o compilador MSVC. Para evitar esse problema, especifique um diretório de saída curto para o Bazel pela flag --output_user_root.

Por exemplo, adicione a seguinte linha ao arquivo do Bazelrc:

startup --output_user_root=C:/tmp

Ativar suporte a nome de arquivo 8.3

O Bazel tenta criar uma versão de nome curto para caminhos de arquivo longos. No entanto, para isso, o suporte ao nome de arquivo 8.3 precisa estar ativado no volume em que o arquivo com o caminho longo reside. Execute o comando a seguir para ativar a criação de nomes do 8.3 em todos os volumes:

fsutil 8dot3name set 0

Alguns recursos exigem que o Bazel crie links simbólicos de arquivos no Windows ativando o Modo de desenvolvedor (no Windows 10 versão 1703 ou mais recente) ou executando o Bazel como administrador. Isso ativa os seguintes recursos:

Para facilitar, adicione as seguintes linhas ao arquivo Baselrc:

startup --windows_enable_symlinks
build --enable_runfiles

Observação: a criação de links simbólicos no Windows é uma operação dispendiosa. A flag --enable_runfiles pode criar uma grande quantidade de links simbólicos de arquivo. Ative esse recurso somente quando precisar dele.

Execução do Bazel: shell MSYS2 x prompt de comando x PowerShell

Recomendação:execute o Bazel no prompt de comando (cmd.exe) ou no PowerShell.

A partir de 15/01/2020, não execute o Bazel usando o bash, seja do shell MSYS2, do Git Bash, do Cygwin ou de qualquer outra variante do Bash. Embora o Bazel possa funcionar na maioria dos casos de uso, algumas coisas não funcionam, como interromper o build com Ctrl+C do MSYS2. Além disso, se você optar por executar no MSYS2, precisará desativar a conversão automática de caminho do MSYS2. Caso contrário, o MSYS converterá argumentos de linha de comando que parecem caminhos Unix (como //foo:bar) em caminhos do Windows. Veja esta resposta do StackOverflow para mais detalhes.

Como usar o Bazel sem Bash (MSYS2)

Como usar o build do Bazel sem Bash

As versões do Bazel anteriores à 1.0 costumavam exigir que o Bash criasse algumas regras.

A partir do Bazel 1.0, é possível criar qualquer regra sem Bash, a menos que ela seja:

  • genrule, porque as regras gerais executam comandos Bash
  • a regra sh_binary ou sh_test, porque elas precisam de Bash inerentemente.
  • Regra do Starlark que usa ctx.actions.run_shell() ou ctx.resolve_command()

No entanto, genrule é frequentemente usado para tarefas simples, como copiar um arquivo ou escrever um arquivo de texto. Em vez de usar genrule (e, dependendo de Bash), você pode encontrar uma regra adequada no repositório bazel-skylib (em inglês). Quando criadas no Windows, essas regras não exigem Bash.

Como usar o teste do Bazel sem Bash

As versões do Bazel anteriores à 1.0 costumavam exigir o Bash para executar bazel test em qualquer coisa.

A partir do Bazel 1.0, é possível testar qualquer regra sem o Bash, exceto quando:

  • você usa --run_under
  • a própria regra de teste exige Bash (porque o executável é um script de shell).

Como usar a execução do Bazel sem Bash

As versões do Bazel anteriores à 1.0 costumavam exigir o Bash para executar bazel run em qualquer coisa.

A partir do Bazel 1.0, é possível executar qualquer regra sem o Bash, exceto quando:

  • você usa --run_under ou --script_path
  • a própria regra de teste exige Bash (porque o executável é um script de shell).

Uso das regras sh_binary e sh_* e ctx.actions.run_shell() sem Bash

Você precisa do Bash para criar e testar regras de sh_* e para criar e testar regras do Starlark que usam ctx.actions.run_shell() e ctx.resolve_command(). Isso se aplica não apenas às regras no seu projeto, mas também às regras em qualquer um dos repositórios externos de que o projeto depende (mesmo de forma transitiva).

No futuro, pode haver uma opção para usar o Subsistema Windows para Linux (WSL) para criar essas regras, mas atualmente não é uma prioridade para a subequipe do Bazel no Windows.

Definir variáveis de ambiente

As variáveis de ambiente definidas no prompt de comando do Windows (cmd.exe) são definidas apenas nessa sessão do prompt de comando. Se você iniciar um novo cmd.exe, vai precisar definir as variáveis novamente. Para sempre definir as variáveis quando cmd.exe for iniciado, adicione-as às variáveis do usuário ou do sistema na caixa de diálogo Control Panel > System Properties > Advanced > Environment Variables....

Criar no Windows

Criar C++ com MSVC

Para criar destinos C++ com MSVC, você precisa de:

  • O compilador do Visual C++.

  • (Opcional) As variáveis de ambiente BAZEL_VC e BAZEL_VC_FULL_VERSION.

    O Bazel detecta automaticamente o compilador Visual C++ no sistema. Para dizer ao Bazel para usar uma instalação de VC específica, defina as seguintes variáveis de ambiente:

    Para o Visual Studio 2017 e 2019, defina uma destas opções: BAZEL_VC. Além disso, você também pode definir BAZEL_VC_FULL_VERSION.

    • BAZEL_VC: o diretório de instalação das ferramentas de build do Visual C++

      set BAZEL_VC=C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\VC

    • BAZEL_VC_FULL_VERSION (opcional) Somente para o Visual Studio 2017 e 2019, o número completo da versão das ferramentas de build do Visual C++. Você pode escolher a versão exata das ferramentas de build do Visual C++ via BAZEL_VC_FULL_VERSION se mais de uma versão estiver instalada. Caso contrário, o Bazel vai escolher a mais recente.

      set BAZEL_VC_FULL_VERSION=14.16.27023

    Para o Visual Studio 2015 ou anterior, defina BAZEL_VC. (BAZEL_VC_FULL_VERSION não é compatível.)

    • BAZEL_VC: o diretório de instalação das ferramentas de build do Visual C++

      set BAZEL_VC=C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC

  • O SDK do Windows

    O SDK do Windows contém os arquivos principais e as bibliotecas que você precisa para criar aplicativos do Windows, incluindo o próprio Bazel. Por padrão, será usado o SDK do Windows mais recente instalado. Também é possível especificar a versão do SDK do Windows definindo BAZEL_WINSDK_FULL_VERSION. É possível usar um número completo do SDK do Windows 10, como 10.0.10240.0, ou especificar 8.1 para usar o SDK do Windows 8.1. Apenas uma versão do SDK do Windows 8.1 está disponível. Verifique se você tem o SDK do Windows especificado instalado.

    Requisito: compatível com o VC 2017 e 2019. As ferramentas de build do VC 2015 independentes não oferecem suporte à seleção do SDK do Windows. Você precisará da instalação completa do Visual Studio 2015. Caso contrário, BAZEL_WINSDK_FULL_VERSION será ignorado.

    set BAZEL_WINSDK_FULL_VERSION=10.0.10240.0

Se tudo estiver configurado, você já pode criar um destino C++.

Tente criar um destino com base em um dos nossos projetos de exemplo:

bazel build //examples/cpp:hello-world
bazel-bin\examples\cpp\hello-world.exe

Por padrão, os binários criados são direcionados à arquitetura x64. Para especificar uma arquitetura de destino diferente, defina a opção de build --cpu para ela: * x64 (padrão): --cpu=x64_windows ou nenhuma opção * x86: --cpu=x64_x86_windows * ARM: --cpu=x64_arm_windows * ARM64: --cpu=arm64_windows

Por exemplo, para criar destinos para a arquitetura ARM, execute:

bazel build //examples/cpp:hello-world --cpu=x64_arm_windows

Para criar e usar Bibliotecas vinculadas dinamicamente (arquivos DLL), consulte este exemplo.

Limite de comprimento da linha de comando: para evitar o problema de limite de comprimento da linha de comando do Windows, ative o recurso de arquivo de parâmetros do compilador usando --features=compiler_param_file.

Criar em C++ com o Clang

A partir da versão 0.29.0, o Bazel oferece suporte à compilação com o driver do compilador LLVM compatível com MSVC (clang-cl.exe).

Requisito: para criar com o Clang, você precisa instalar as ferramentas LLVM e Visual C++ Build, porque, embora você use clang-cl.exe como compilador, ainda precisa vincular às bibliotecas do Visual C++.

O Bazel pode detectar automaticamente a instalação do LLVM no sistema, ou você pode dizer explicitamente ao Bazel onde o LLVM está instalado por BAZEL_LLVM.

  • BAZEL_LLVM: o diretório de instalação do LLVM.

    set BAZEL_LLVM=C:\Program Files\LLVM

Há várias situações para ativar o conjunto de ferramentas do Clang para criar C++.

  • No Bazel 0.28 e versões anteriores: não há suporte para o Clang.

  • Sem --incompatible_enable_cc_toolchain_resolution: você pode ativar o conjunto de ferramentas do Clang por uma flag de build --compiler=clang-cl.

  • Com --incompatible_enable_cc_toolchain_resolution: é necessário adicionar um destino de plataforma ao BUILD file (por exemplo, o arquivo BUILD de nível superior):

    platform(
    name = "x64_windows-clang-cl",
    constraint_values = [
        "@platforms//cpu:x86_64",
        "@platforms//os:windows",
        "@bazel_tools//tools/cpp:clang-cl",
    ],
)

    Em seguida, você pode ativar o conjunto de ferramentas do Clang usando uma das duas maneiras a seguir:

    • Especifique as seguintes flags de build:
    --extra_toolchains=@local_config_cc//:cc-toolchain-x64_windows-clang-cl --extra_execution_platforms=//:x64_windows-clang-cl
    • Registre a plataforma e o conjunto de ferramentas no arquivo MODULE.bazel:
    register_execution_platforms(
    ":x64_windows-clang-cl"
)

register_toolchains(
    "@local_config_cc//:cc-toolchain-x64_windows-clang-cl",
)

    O flag --incompatible_enable_cc_toolchain_resolution será ativado por padrão em uma versão futura do Bazel. Portanto, é recomendável ativar o suporte ao Clang com a segunda abordagem.

Criar Java

Para criar destinos Java, você precisa de:

No Windows, o Bazel cria dois arquivos de saída para as regras java_binary:

  • um arquivo .jar
  • um arquivo .exe que pode configurar o ambiente para a JVM e executar o binário

Tente criar um destino com base em um dos nossos projetos de exemplo:

  bazel build //examples/java-native/src/main/java/com/example/myproject:hello-world
  bazel-bin\examples\java-native\src\main\java\com\example\myproject\hello-world.exe

Criar Python

Para criar destinos em Python, você precisa de:

No Windows, o Bazel cria dois arquivos de saída para as regras py_binary:

  • um arquivo ZIP autoextraível
  • Um arquivo executável que pode iniciar o interpretador de Python com o arquivo ZIP de autoextração como argumento.

É possível executar o arquivo executável (ele tem uma extensão .exe) ou executar o Python com o arquivo ZIP de autoextração como argumento.

Tente criar um destino com base em um dos nossos projetos de exemplo:

  bazel build //examples/py_native:bin
  bazel-bin\examples\py_native\bin.exe
  python bazel-bin\examples\py_native\bin.zip

Se você quiser ver detalhes sobre como o Bazel cria destinos do Python no Windows, confira este documento de design.