Este conjunto de reglas existe para permitirte modelar plataformas de hardware específicas para las que compilas y especificar las herramientas específicas que podrías necesitar para compilar código para esas plataformas. El usuario debe estar familiarizado con los conceptos que se explican aquí.
Reglas
constraint_setting
Ver la fuente de la reglaconstraint_setting(name, default_constraint_value, deprecation, distribs, features, licenses, tags, testonly, visibility)
Esta regla se usa para presentar un nuevo tipo de restricción para el que una plataforma puede especificar un valor.
Por ejemplo, puedes definir un constraint_setting
llamado "glibc_version" para representar la capacidad de que las plataformas tengan diferentes versiones de la biblioteca glibc instaladas.
Para obtener más información, consulta la página Plataformas.
Cada constraint_setting
tiene un conjunto extensible de constraint_value
asociados. Por lo general, estos se definen en el mismo paquete, pero a veces un paquete diferente ingresará valores nuevos para una configuración existente. Por ejemplo, la configuración predefinida @platforms//cpu:cpu
se puede extender con un valor personalizado para definir una plataforma que se oriente a una arquitectura de CPU desconocida.
Argumentos
Atributos | |
---|---|
name |
Nombre: Obligatorio Un nombre único para este objetivo. |
default_constraint_value
|
Nombre; no configurable; el valor predeterminado es constraint_value al que apunta debe definirse en el mismo paquete que este constraint_setting .
Si un parámetro de configuración de restricción tiene un valor predeterminado, cada vez que una plataforma no incluye ningún valor de restricción para ese parámetro, es lo mismo que si la plataforma hubiera especificado el valor predeterminado. De lo contrario, si no hay un valor predeterminado, se considera que esa plataforma no especificó la configuración de restricción. En ese caso, la plataforma no coincidiría con ninguna lista de restricciones (como para un |
constraint_value
Fuente de la regla de vistaconstraint_value(name, constraint_setting, deprecation, distribs, features, licenses, tags, testonly, visibility)Esta regla introduce un valor nuevo para un tipo de restricción determinado. Para obtener más detalles, consulta la página Plataformas.
Ejemplo
Lo siguiente crea un nuevo valor posible para el constraint_value
predefinido, que representa la arquitectura de la CPU.
constraint_value( name = "mips", constraint_setting = "@platforms//cpu:cpu", )Las plataformas pueden declarar que tienen la arquitectura
mips
como alternativa a x86_64
, arm
, etcétera.
Argumentos
Atributos | |
---|---|
name |
Name; obligatorio Un nombre único para este destino. |
constraint_setting
|
Etiqueta; no configurable; obligatorio Elconstraint_setting para el que este constraint_value es una opción posible.
|
plataforma
Ver la fuente de la reglaplatform(name, constraint_values, deprecation, distribs, exec_properties, features, licenses, parents, remote_execution_properties, tags, testonly, visibility)
Esta regla define una plataforma nueva: una colección nombrada de opciones de restricción (como la arquitectura de la CPU o la versión del compilador) que describe un entorno en el que se puede ejecutar parte de la compilación. Para obtener más información, consulta la página Plataformas.
Ejemplo
Esto define una plataforma que describe cualquier entorno que ejecute Linux en ARM.
platform( name = "linux_arm", constraint_values = [ "@platforms//os:linux", "@platforms//cpu:arm", ], )
Herencia de la plataforma
Las plataformas pueden usar el atributo parents
para especificar otra plataforma de la que heredarán los valores de restricción. Aunque el atributo parents
toma una lista, actualmente no se admite más de un valor, y especificar varios elementos superiores es un error.
Cuando se verifica el valor de un parámetro de configuración de restricción en una plataforma, primero se verifican los valores establecidos directamente (a través del atributo constraint_values
) y, luego, los valores de restricción en el elemento superior. Esto continúa recursivamente en la cadena de plataformas superiores. De esta manera, cualquier valor que se establezca directamente en una plataforma anulará los valores establecidos en la superior.
Las plataformas heredan el atributo exec_properties
de la plataforma superior.
Se combinarán las entradas del diccionario en exec_properties
de las plataformas superiores y secundarias.
Si aparece la misma clave en el exec_properties
del elemento superior y el secundario, se usará el valor del elemento secundario. Si la plataforma secundaria especifica una cadena vacía como valor, no se establecerá la propiedad correspondiente.
Las plataformas también pueden heredar el atributo remote_execution_properties
(obsoleto) de la plataforma superior. Nota: El código nuevo debe usar exec_properties
en su lugar. La lógica que se describe a continuación se mantiene para ser compatible con el comportamiento heredado, pero se quitará en el futuro.
La lógica para configurar remote_execution_platform
es la siguiente cuando hay una plataforma superior:
-
Si no se establece
remote_execution_property
en la plataforma secundaria, se usará elremote_execution_properties
superior. -
Si
remote_execution_property
se establece en la plataforma secundaria y contiene la cadena literal {PARENT_REMOTE_EXECUTION_PROPERTIES}, esa macro se reemplazará por el contenido del atributoremote_execution_property
del elemento superior. -
Si
remote_execution_property
se establece en la plataforma secundaria y no contiene la macro, se usará elremote_execution_property
secundario sin cambios.
Dado que remote_execution_properties
dejó de estar disponible y se eliminará gradualmente, no se permite combinar remote_execution_properties
y exec_properties
en la misma cadena de herencia.
Se prefiere usar exec_properties
en lugar de remote_execution_properties
obsoleto.
Ejemplo: valores de restricción
platform( name = "parent", constraint_values = [ "@platforms//os:linux", "@platforms//cpu:arm", ], ) platform( name = "child_a", parents = [":parent"], constraint_values = [ "@platforms//cpu:x86_64", ], ) platform( name = "child_b", parents = [":parent"], )
En este ejemplo, las plataformas secundarias tienen las siguientes propiedades:
-
child_a
tiene los valores de restricción@platforms//os:linux
(heredados del elemento superior) y@platforms//cpu:x86_64
(establecidos directamente en la plataforma). -
child_b
hereda todos los valores de restricción del elemento superior y no establece ninguno propio.
Ejemplo: Propiedades de ejecución
platform( name = "parent", exec_properties = { "k1": "v1", "k2": "v2", }, ) platform( name = "child_a", parents = [":parent"], ) platform( name = "child_b", parents = [":parent"], exec_properties = { "k1": "child" } ) platform( name = "child_c", parents = [":parent"], exec_properties = { "k1": "" } ) platform( name = "child_d", parents = [":parent"], exec_properties = { "k3": "v3" } )
En este ejemplo, las plataformas secundarias tienen las siguientes propiedades:
-
child_a
hereda "exec_properties" del elemento superior y no establece el suyo propio. -
child_b
hereda elexec_properties
del elemento superior y anula el valor dek1
. Suexec_properties
será:{ "k1": "child", "k2": "v2" }
. -
child_c
hereda elexec_properties
del elemento superior y anulak1
. Suexec_properties
será:{ "k2": "v2" }
. -
child_d
hereda elexec_properties
del elemento superior y agrega una propiedad nueva. Suexec_properties
será:{ "k1": "v1", "k2": "v2", "k3": "v3" }
.
Argumentos
Atributos | |
---|---|
name |
Nombre: Obligatorio Un nombre único para este objetivo. |
constraint_values
|
Lista de etiquetas; no configurable; el valor predeterminado es Cada |
exec_properties
|
Diccionario: Cadena -> Cadena; no configurable; el valor predeterminado es exec_properties de la plataforma superior.
Si la plataforma superior y la secundaria definen las mismas claves, se conservan los valores de la plataforma secundaria. Se quitan del diccionario todas las claves asociadas con un valor que sea una cadena vacía.
Este atributo reemplaza por completo el atributo remote_execution_properties obsoleto.
|
parents
|
Es una lista de etiquetas no configurables. El valor predeterminado es platform del que esta plataforma debe heredar. Aunque el atributo toma una lista, no debe haber más de una plataforma presente. Cualquier valor de constraint_settings que no se establezca directamente en esta plataforma se encontrará en la plataforma superior.
Consulta la sección sobre herencia de plataformas para obtener más detalles.
|
remote_execution_properties
|
String; no configurable; el valor predeterminado es |
cadena de herramientas
Ver el origen de la reglatoolchain(name, deprecation, distribs, exec_compatible_with, features, licenses, tags, target_compatible_with, target_settings, testonly, toolchain, toolchain_type, visibility)
Esta regla declara el tipo y las restricciones de una cadena de herramientas específica para que se pueda seleccionar durante la resolución de la cadena de herramientas. Consulta la página Cadenas de herramientas para obtener más detalles.
Argumentos
Atributos | |
---|---|
name |
Name; obligatorio Un nombre único para este objetivo. |
exec_compatible_with
|
Es una lista de etiquetas no configurables. El valor predeterminado es constraint_value que una plataforma de ejecución debe satisfacer para que se seleccione esta cadena de herramientas para una compilación de destino en esa plataforma.
|
target_compatible_with
|
Es una lista de etiquetas no configurables. El valor predeterminado es constraint_value que la plataforma de destino debe cumplir a fin de que se seleccione esta cadena de herramientas para una compilación de destino de esa plataforma.
|
target_settings
|
Es una lista de etiquetas. El valor predeterminado es config_setting que la configuración de destino debe satisfacer para que se seleccione esta cadena de herramientas durante la resolución de la cadena de herramientas.
|
toolchain
|
Nombre: Obligatorio El destino que representa la herramienta o el conjunto de herramientas reales que se ponen a disposición cuando se selecciona esta cadena de herramientas. |
toolchain_type
|
Etiqueta; no configurable; obligatorio Es la etiqueta de un destinotoolchain_type que representa la función que cumple esta cadena de herramientas.
|
toolchain_type
Ver el origen de la reglatoolchain_type(name, compatible_with, deprecation, features, restricted_to, tags, target_compatible_with, testonly, visibility)
Esta regla define un nuevo tipo de cadena de herramientas: un objetivo simple que representa una clase de herramientas que cumple la misma función para diferentes plataformas.
Consulta la página Cadena de herramientas para obtener más detalles.
Ejemplo
Esto define un tipo de cadena de herramientas para una regla personalizada.
toolchain_type( name = "bar_toolchain_type", )
Esto se puede usar en un archivo bzl.
bar_binary = rule( implementation = _bar_binary_impl, attrs = { "srcs": attr.label_list(allow_files = True), ... # No `_compiler` attribute anymore. }, toolchains = ["//bar_tools:toolchain_type"] )
Argumentos
Atributos | |
---|---|
name |
Name; obligatorio Un nombre único para este destino. |