Usar Bazel en Windows

Informa un problema Ver código fuente

En esta página, se abordan las prácticas recomendadas para usar Bazel en Windows. Para obtener instrucciones de instalación, consulta Instala Bazel en Windows.

Problemas conocidos

Los problemas de Bazel relacionados con Windows están marcados con la etiqueta “team-Windows” en GitHub. Puedes ver los problemas abiertos aquí.

Prácticas recomendadas

Evita problemas con rutas de acceso extensas

Algunas herramientas tienen la limitación máxima de longitud de ruta en Windows, incluido el compilador MSVC. Para evitar este problema, puedes especificar un directorio de salida corto para Bazel con la marca --output_user_root.

Por ejemplo, agrega la siguiente línea a tu archivo bazelrc:

startup --output_user_root=C:/tmp

Habilitar compatibilidad con nombres de archivo de 8.3

Bazel intenta crear una versión de nombre corto para rutas de archivos largas. Sin embargo, para hacerlo, debe habilitarse la compatibilidad con el nombre de archivo 8.3 en el volumen en el que reside el archivo con la ruta larga. Para habilitar la creación de nombres de 8.3 en todos los volúmenes, ejecuta el siguiente comando:

fsutil 8dot3name set 0

Algunas funciones requieren que Bazel pueda crear symlinks de archivos en Windows, ya sea mediante la habilitación del modo de desarrollador (en Windows 10 versión 1703 o posterior) o mediante la ejecución de Bazel como administrador. Esto habilita las siguientes funciones:

Para facilitar el proceso, agrega las siguientes líneas al archivo bazelrc:

startup --windows_enable_symlinks
build --enable_runfiles

Nota: Crear symlinks en Windows es una operación costosa. La marca --enable_runfiles puede crear una gran cantidad de symlinks de archivo. Habilita esta función solo cuando la necesites.

Ejecuta Bazel: shell de MSYS2, símbolo del sistema o PowerShell

Recomendación: Ejecuta Bazel desde el símbolo del sistema (cmd.exe) o desde PowerShell.

A partir del 15 de enero de 2020, no ejecutes Bazel desde bash, ya sea desde la shell de MSYS2, Git Bash, Cygwin o cualquier otra variante de Bash. Si bien Bazel puede funcionar para la mayoría de los casos prácticos, algunos elementos presentan errores, como interrumpir la compilación con Ctrl+C desde MSYS2. Además, si eliges ejecutar en MSYS2, debes inhabilitar la conversión automática de la ruta de acceso de MSYS2; de lo contrario, MSYS convertirá los argumentos de la línea de comandos que parecen las rutas de acceso de Unix (como //foo:bar) a rutas de acceso de Windows. Consulta esta respuesta de StackOverflow para obtener más detalles.

Usa Bazel sin Bash (MSYS2)

Usa la compilación de Bazel sin Bash

Las versiones de Bazel anteriores a la 1.0 solían requerir que Bash compilara algunas reglas.

A partir de Bazel 1.0, puedes compilar cualquier regla sin Bash, a menos que sea una:

  • genrule, ya que las genrules ejecutan comandos de Bash
  • Regla sh_binary o sh_test, ya que estas necesitan inherentemente Bash
  • Regla de Starlark que usa ctx.actions.run_shell() o ctx.resolve_command()

Sin embargo, genrule a menudo se usa para tareas simples, como copiar un archivo o escribir un archivo de texto. En lugar de usar genrule (y según Bash), es posible que encuentres una regla adecuada en el repositorio de bazel-skylib. Cuando se compilan en Windows, estas reglas no requieren Bash.

Usa la prueba de Bazel sin Bash

Las versiones de Bazel anteriores a la 1.0 solían requerir Bash en bazel test.

A partir de Bazel 1.0, puedes probar cualquier regla sin Bash, excepto cuando se cumplen estas condiciones:

  • usas --run_under
  • la regla de prueba requiere Bash (porque su ejecutable es una secuencia de comandos de shell)

Usa Bazel sin ejecutar Bash

Las versiones de Bazel anteriores a la 1.0 solían requerir Bash en bazel run.

A partir de Bazel 1.0, puedes ejecutar cualquier regla sin Bash, excepto cuando se cumplen estas condiciones:

  • usas --run_under o --script_path
  • la regla de prueba requiere Bash (porque su ejecutable es una secuencia de comandos de shell)

Uso de las reglas shbinary y sh* y ctx.actions.run_shell() sin Bash

Necesitas Bash para compilar y probar reglas sh_*, además de compilar y probar reglas de Starlark que usan ctx.actions.run_shell() y ctx.resolve_command(). Esto se aplica no solo a las reglas de tu proyecto, sino a las reglas de cualquiera de los repositorios externos de los que depende tu proyecto (incluso de forma transitiva).

En el futuro, es posible que exista la opción de usar el Subsistema de Windows para Linux (WSL) a fin de compilar estas reglas. Sin embargo, por el momento, no es una prioridad para el subequipo de Bazel en Windows.

Configure variables de entorno

Las variables de entorno que configuras en el símbolo del sistema de Windows (cmd.exe) solo se establecen en esa sesión del símbolo del sistema. Si inicias un cmd.exe nuevo, debes volver a configurar las variables. Para configurar siempre las variables cuando se inicie cmd.exe, puedes agregarlas a las variables de usuario o a variables del sistema en el cuadro de diálogo Control Panel > System Properties > Advanced > Environment Variables....

Compila en Windows

Compila C++ con MSVC

Para compilar destinos C++ con MSVC, necesitas lo siguiente:

  • El compilador de Visual C++.

  • Las variables de entorno BAZEL_VC y BAZEL_VC_FULL_VERSION (opcional).

    Bazel detecta automáticamente el compilador de Visual C++ en el sistema. Para indicarle a Bazel que use una instalación de VC específica, puedes configurar las siguientes variables de entorno:

    En Visual Studio 2017 y 2019, establece una de las siguientes opciones: BAZEL_VC. Además, puedes configurar BAZEL_VC_FULL_VERSION.

    • BAZEL_VC: El directorio de instalación de las herramientas de compilación de Visual C++

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

    • BAZEL_VC_FULL_VERSION (Opcional) Solo para Visual Studio 2017 y 2019, es el número de versión completo de tus herramientas de compilación de Visual C++. Puedes elegir la versión exacta de las herramientas de compilación de Visual C++ a través de BAZEL_VC_FULL_VERSION si hay más de una versión instalada; de lo contrario, Bazel elegirá la versión más reciente.

      set BAZEL_VC_FULL_VERSION=14.16.27023

    Para Visual Studio 2015 o una versión anterior, establece BAZEL_VC. (BAZEL_VC_FULL_VERSION no es compatible).

    • BAZEL_VC: El directorio de instalación de las herramientas de compilación de Visual C++

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

  • El SDK de Windows

    El SDK de Windows contiene los archivos de encabezado y las bibliotecas que necesitas cuando compilas aplicaciones de Windows, incluido Bazel. De forma predeterminada, se usará la versión más reciente del SDK de Windows. También puedes especificar la versión del SDK de Windows si configuras BAZEL_WINSDK_FULL_VERSION. Puedes usar un número de SDK completo de Windows 10, como 10.0.10240.0, o especificar 8.1 para usar el SDK de Windows 8.1 (solo está disponible una versión del SDK de Windows 8.1). Asegúrate de tener instalado el SDK de Windows especificado.

    Requisito: Esta función es compatible con el VC 2017 y 2019. Las herramientas de compilación independientes de VC 2015 no admiten la selección del SDK de Windows; necesitarás la instalación completa de Visual Studio 2015; de lo contrario, se ignorará BAZEL_WINSDK_FULL_VERSION.

    set BAZEL_WINSDK_FULL_VERSION=10.0.10240.0

Si todo está configurado, puedes crear un destino C++ ahora.

Intenta compilar un destino desde uno de nuestros proyectos de muestra:

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

De forma predeterminada, los objetos binarios compilados se orientan a la arquitectura x64. Para especificar una arquitectura de destino diferente, establece la opción de compilación --cpu de tu arquitectura de destino: * x64 (predeterminado): --cpu=x64_windows o ninguna opción * x86: --cpu=x64_x86_windows * ARM: --cpu=x64_arm_windows * ARM64: --cpu=arm64_windows

Por ejemplo, a fin de compilar destinos para la arquitectura ARM, ejecuta lo siguiente:

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

Para compilar y usar bibliotecas de vinculación dinámica (archivos DLL), consulta este ejemplo.

Límite de longitud de la línea de comandos: para evitar el problema de límite de longitud de la línea de comandos de Windows, habilita la función del archivo de parámetros del compilador mediante --features=compiler_param_file.

Compila C++ con Clang

A partir de la versión 0.29.0, Bazel admite la compilación con un controlador de compiladores compatible con MSVC de LLVM (clang-cl.exe).

Requisito: Para compilar con Clang, debes instalar ambas herramientas: LLVM y Visual C++ Build, ya que, aunque usas clang-cl.exe como compilador, debes vincular las bibliotecas de Visual C++.

Bazel puede detectar de forma automática la instalación de LLVM en tu sistema, o puedes indicarle de forma explícita a Bazel dónde instala LLVM mediante BAZEL_LLVM.

  • BAZEL_LLVM: el directorio de instalación de LLVM

    set BAZEL_LLVM=C:\Program Files\LLVM

Si quieres habilitar la cadena de herramientas de Clang para compilar C++, existen varias situaciones.

  • En Babael 0.28 y versiones anteriores, no se admite Clang.

  • Sin --incompatible_enable_cc_toolchain_resolution: Puedes habilitar la cadena de herramientas Clang mediante una marca de compilación --compiler=clang-cl.

  • Con --incompatible_enable_cc_toolchain_resolution: debes agregar una orientación de plataforma a tu BUILD file (p. ej., el archivo BUILD de nivel superior):

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

    Luego, puedes habilitar la cadena de herramientas Clang de dos maneras:

    • Especifica las siguientes marcas de compilación:
    --extra_toolchains=@local_config_cc//:cc-toolchain-x64_windows-clang-cl --extra_execution_platforms=//:x64_windows-clang-cl
    • Registra la plataforma y la cadena de herramientas en el archivo WORKSPACE:
    register_execution_platforms(
    ":x64_windows-clang-cl"
)

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

    Se planea habilitar la marca --incompatible_enable_cc_toolchain_resolution de forma predeterminada en actualizaciones futuras de Bazel. Por lo tanto, se recomienda habilitar la compatibilidad con Clang con el segundo enfoque.

Compila Java

Para compilar destinos de Java, necesitas lo siguiente:

En Windows, Bazel compila dos archivos de salida para las reglas java_binary:

  • Un archivo .jar
  • Un archivo .exe que puede configurar el entorno para la JVM y ejecutar el objeto binario

Intenta compilar un destino desde uno de nuestros proyectos de muestra:

  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

Compila con Python

Para compilar destinos de Python, necesitas lo siguiente:

En Windows, Bazel compila dos archivos de salida para las reglas py_binary:

  • un archivo ZIP de extracción automática
  • un archivo ejecutable que puede iniciar el intérprete de Python con el archivo ZIP de extracción automática como argumento

Puedes ejecutar el archivo ejecutable (tiene una extensión .exe) o ejecutar Python con el archivo ZIP de extracción automática como argumento.

Intenta compilar un destino desde uno de nuestros proyectos de muestra:

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

Si te interesa obtener detalles sobre cómo Bazel compila los objetivos de Python en Windows, consulta este documento de diseño.