Usar Bazel en Windows

Informar un problema Ver fuente Noche {/2/}}

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

Errores conocidos

Los problemas de Bazel relacionados con Windows se marcan con la etiqueta “team-Windows” en GitHub. Puedes ver los problemas abiertos aquí.

Prácticas recomendadas

Evita problemas con rutas largas

Algunas herramientas tienen la Limitación máxima de longitud de ruta de acceso 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 la compatibilidad con nombres de archivos 8.3

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

fsutil 8dot3name set 0

Algunas funciones requieren que Bazel pueda crear symlinks de archivos en Windows, ya sea habilitando el modo de desarrollador (en Windows 10 1703 o versiones posteriores) o ejecutando Bazel como administrador. Esto habilita las siguientes funciones:

Para facilitar el proceso, agrega las siguientes líneas a tu 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 archivos. Habilita esta función solo cuando la necesites.

Ejecuta Bazel: shell de MSYS2 en comparación con el símbolo del sistema y PowerShell

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

A partir del 15/01/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 en la mayoría de los casos de uso, algunos elementos no funcionan, como interrumpir la compilación con Ctrl + C desde MSYS2). Además, si eliges ejecutar el comando en MSYS2, debes inhabilitar la conversión automática de rutas de acceso de MSYS2. De lo contrario, MSYS convertirá los argumentos de línea de comandos que se parecen a rutas de acceso de Unix (como //foo:bar) en rutas de Windows. Consulta esta respuesta de StackOverflow para obtener más detalles.

Cómo usar Bazel sin Bash (MSYS2)

Cómo usar 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 se trate de lo siguiente:

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

Sin embargo, genrule suele usarse para tareas simples, como copiar un archivo o escribir un archivo de texto. En lugar de usar genrule (y según Bash), puedes encontrar una regla adecuada en el repositorio de bazel-skylib. Cuando se compilan en Windows, estas reglas no requieren Bash.

Cómo usar la prueba de Bazel sin Bash

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

A partir de Bazel 1.0, puedes probar cualquier regla sin Bash, excepto en los siguientes casos:

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

Usa la ejecución de Bazel sin Bash

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

A partir de Bazel 1.0, puedes ejecutar cualquier regla sin Bash, excepto en los siguientes casos:

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

Usa reglas binarias y sh*, y ctx.actions.run_shell() sin Bash

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

En el futuro, es posible que haya una opción para usar el Subsistema de Windows para Linux (WSL) con el objetivo de compilar estas reglas, pero, por el momento, no es una prioridad para el subequipo de Bazel en Windows.

Configura variables de entorno

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

Compila en Windows

Cómo compilar C++ con MSVC

Para compilar destinos C++ con MSVC, necesitas:

  • 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 tu sistema. Para indicarle a Bazel que use una instalación de VC específica, puedes configurar las siguientes variables de entorno:

    Para Visual Studio 2017 y 2019, establece una de estas opciones: BAZEL_VC. Además, puedes configurar BAZEL_VC_FULL_VERSION.

    • Usa BAZEL_VC en 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, 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++ mediante BAZEL_VC_FULL_VERSION si hay más de una versión instalada. De lo contrario, Bazel elegirá la más reciente.

      set BAZEL_VC_FULL_VERSION=14.16.27023

    Para Visual Studio 2015 o versiones anteriores, configura BAZEL_VC. (BAZEL_VC_FULL_VERSION no es compatible).

    • Usa BAZEL_VC en 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 instalado. También puedes especificar la versión del SDK de Windows configurando BAZEL_WINSDK_FULL_VERSION. Puedes usar un número completo del SDK de Windows 10, como 10.0.10240.0, o especificar 8.1 para usar el SDK de Windows 8.1 (solo hay una versión disponible del SDK de Windows 8.1). Asegúrate de tener instalado el SDK de Windows especificado.

    Requisito: Esto es compatible con VC 2017 y 2019. La versión independiente de las herramientas de compilación de VC 2015 no es compatible con 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 compilar un destino C++ ahora mismo.

Intenta compilar un destino a partir de 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. Si deseas especificar una arquitectura de destino diferente, establece la opción de compilación --cpu para 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, para compilar objetivos para la arquitectura ARM, ejecuta lo siguiente:

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

Para compilar y usar bibliotecas vinculadas de forma 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 de archivo de parámetros del compilador con --features=compiler_param_file.

Cómo compilar C++ con Clang

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

Requisito: Para compilar con Clang, debes instalar tanto LLVM como las herramientas de compilación de Visual C++, ya que, si bien usas clang-cl.exe como compilador, debes vincular las bibliotecas de Visual C++.

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

  • BAZEL_LLVM el directorio de instalación de LLVM

    set BAZEL_LLVM=C:\Program Files\LLVM

Existen varias situaciones para habilitar la cadena de herramientas de Clang a fin de compilar C++.

  • En Bazel 0.28 y versiones anteriores: Clang no es compatible.

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

  • Con --incompatible_enable_cc_toolchain_resolution, debes agregar una plataforma de segmentación 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 de Clang de las siguientes 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 tu 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 una versión futura 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 pueda configurar el entorno para la JVM y ejecutar el objeto binario

Intenta compilar un destino a partir de 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 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 autoextraíble
  • ejecutable que puede iniciar el intérprete de Python con el archivo ZIP autoextraíble como argumento

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

Intenta compilar un destino a partir de 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 información detallada sobre cómo Bazel compila destinos de Python en Windows, consulta este documento de diseño.