Grupos de ejecución

Informar un problema Ver código fuente Nightly 8.1 · 8.0 · 7.5 · 7.4 · 7.3 · 7.2

Los grupos de ejecución permiten varias plataformas de ejecución dentro de un solo objetivo. Cada grupo de ejecución tiene sus propias dependencias de cadena de herramientas y realiza su propia resolución de cadena de herramientas.

Contexto

Los grupos de ejecución permiten que el autor de la regla defina conjuntos de acciones, cada uno con una plataforma de ejecución potencialmente diferente. Varias plataformas de ejecución pueden permitir que las acciones se ejecuten de manera diferente, por ejemplo, compilar una app para iOS en un trabajador remoto (Linux) y, luego, vincularla o firmarla en un trabajador local de Mac.

Poder definir grupos de acciones también ayuda a aliviar el uso de mnemotecnias de acciones como un proxy para especificar acciones. No se garantiza que los mnemónicos sean únicos y solo pueden hacer referencia a una sola acción. Esto es especialmente útil para asignar recursos adicionales a acciones intensivas de procesamiento y memoria específicas, como la vinculación en compilaciones de C++, sin asignar demasiados recursos a tareas menos exigentes.

Cómo definir grupos de ejecución

Durante la definición de reglas, los autores pueden declarar un conjunto de grupos de ejecución. En cada grupo de ejecución, el autor de la regla puede especificar todo lo necesario para seleccionar una plataforma de ejecución para ese grupo, es decir, cualquier restricción a través de exec_compatible_with y los tipos de cadena de herramientas a través de toolchain.

# foo.bzl
my_rule = rule(
    _impl,
    exec_groups = {
        link: exec_group(
            exec_compatible_with = [ "@platforms//os:linux" ]
            toolchains = ["//foo:toolchain_type"],
        ),
        test: exec_group(
            toolchains = ["//foo_tools:toolchain_type"],
        ),
    },
    attrs = {
        "_compiler": attr.label(cfg = config.exec("link"))
    },
)

En el fragmento de código anterior, puedes ver que las dependencias de herramientas también pueden especificar la transición para un grupo de ejecución con el parámetro de atributo cfg y el módulo config. El módulo expone una función exec que toma un solo parámetro de cadena, que es el nombre del grupo de ejecución para el que se debe compilar la dependencia.

Al igual que en las reglas nativas, el grupo de ejecución test está presente de forma predeterminada en las reglas de prueba de Starlark.

Cómo acceder a los grupos de ejecución

En la implementación de reglas, puedes declarar que las acciones se deben ejecutar en la plataforma de ejecución de un grupo de ejecución. Para ello, usa el parámetro exec_group de los métodos de generación de acciones, específicamente ctx.actions.run y ctx.actions.run_shell.

# foo.bzl
def _impl(ctx):
  ctx.actions.run(
     inputs = [ctx.attr._some_tool, ctx.srcs[0]]
     exec_group = "compile",
     # ...
  )

Los autores de reglas también podrán acceder a las cadenas de herramientas resueltas de los grupos de ejecución, de manera similar a como puedes acceder a la cadena de herramientas resuelta de un destino:

# foo.bzl
def _impl(ctx):
  foo_info = ctx.exec_groups["link"].toolchains["//foo:toolchain_type"].fooinfo
  ctx.actions.run(
     inputs = [foo_info, ctx.srcs[0]]
     exec_group = "link",
     # ...
  )

Grupos de ejecución predeterminados

Los siguientes grupos de ejecución están predefinidos:

  • test: Acciones del ejecutor de pruebas, disponibles en todas las reglas de prueba.
  • cpp_link: Acciones de vinculación de C++.

Usa grupos de ejecución para establecer propiedades de ejecución

Los grupos de ejecución se integran con el atributo exec_properties que existe en cada regla y permite que el escritor de destino especifique un diccionario de cadenas de propiedades que luego se pasa al mecanismo de ejecución. Por ejemplo, si deseas establecer alguna propiedad, por ejemplo, la memoria, para el objetivo y asignar a ciertas acciones una asignación de memoria más alta, escribirías una entrada exec_properties con una clave aumentada del grupo de ejecución, como la siguiente:

# BUILD
my_rule(
    name = 'my_target',
    exec_properties = {
        'mem': '12g',
        'link.mem': '16g'
    }
    
)

Todas las acciones con exec_group = "link" verían el diccionario de propiedades de ejecución como {"mem": "16g"}. Como puedes ver, la configuración a nivel del grupo de ejecución anula la configuración a nivel del objetivo.

Usa grupos de ejecución para establecer restricciones de plataforma

Los grupos de ejecución también se integran con los atributos exec_compatible_with y exec_group_compatible_with que existen en cada regla y permiten que el escritor de destino especifique restricciones adicionales que deben satisfacer las plataformas de ejecución seleccionadas para las acciones del destino.

Por ejemplo, si la regla my_test define el grupo de ejecución link además del grupo de ejecución predeterminado y test, el siguiente uso de estos atributos ejecutaría acciones en el grupo de ejecución predeterminado en una plataforma con una gran cantidad de CPUs, la acción de prueba en Linux y la acción de vinculación en la plataforma de ejecución predeterminada:

# BUILD
constraint_setting(name = "cpu")
constraint_value(name = "high_cpu", constraint_setting = ":cpu")

platform(
  name = "high_cpu_platform",
  constraint_values = [":high_cpu"],
  exec_properties = {
    "cpu": "256",
  },
)

my_test(
    name = "my_test",
    exec_compatible_with = ["//constraints:high_cpu"],
    exec_group_compatible_with = {
        "test": ["@platforms//os:linux"],
    },
    ...
)

Grupos de ejecución y propiedades de ejecución de la plataforma

Es posible definir exec_properties para grupos de ejecución arbitrarios en objetivos de plataforma (a diferencia de exec_properties establecido directamente en un objetivo, donde se rechazan las propiedades para grupos de ejecución desconocidos). Luego, los objetivos heredan el exec_properties de la plataforma de ejecución que afecta al grupo de ejecución predeterminado y a cualquier otro grupo de ejecución relevante.

Por ejemplo, supongamos que ejecutar pruebas en la plataforma de ejecución requiere que un recurso esté disponible, pero no es necesario para la compilación y la vinculación. Esto se puede modelar de la siguiente manera:

# BUILD
platform(
    name = "exec_platform",
    exec_properties = {
        "test.resource": "...",
    },
)

cc_test(
    name = "my_test",
    srcs = ["my_test.cc"],
)

Los exec_properties definidos directamente en los objetivos tienen prioridad sobre los que se heredan de la plataforma de ejecución.