Aturan Platform dan Toolchain

{3/2.0.20.2. Laporkan masalah Lihat sumber

Ada seperangkat aturan untuk memungkinkan Anda membuat model platform hardware tertentu yang Anda bangun dan menentukan alat spesifik yang mungkin diperlukan untuk mengompilasi kode bagi platform tersebut. Pengguna harus sudah memahami konsep yang dijelaskan di sini.

Aturan

constraint_setting

Lihat sumber aturan 
constraint_setting(name, default_constraint_value, deprecation, distribs, features, licenses, tags, testonly, visibility)

Aturan ini digunakan untuk memperkenalkan jenis batasan baru yang nilainya dapat ditentukan oleh platform. Misalnya, Anda dapat menentukan constraint_setting bernama "glibc_version" untuk merepresentasikan kemampuan bagi platform untuk menginstal versi library glibc yang berbeda. Untuk mengetahui detail selengkapnya, lihat halaman Platform.

Setiap constraint_setting memiliki kumpulan constraint_value terkait yang dapat diperluas. Biasanya ini ditentukan dalam paket yang sama, tetapi terkadang paket yang berbeda akan memasukkan nilai baru untuk setelan yang ada. Misalnya, @platforms//cpu:cpu setelan yang telah ditetapkan dapat diperluas dengan nilai kustom untuk menentukan platform yang menargetkan arsitektur CPU yang tidak jelas.

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.
default_constraint_value

Nama; tidak dapat dikonfigurasi; defaultnya adalah None

Label nilai default untuk setelan ini, yang akan digunakan jika tidak ada nilai yang diberikan. Jika atribut ini ada, constraint_value yang ditunjuk oleh atribut tersebut harus ditentukan dalam paket yang sama dengan constraint_setting ini.

Jika setelan batasan memiliki nilai default, maka setiap kali platform tidak menyertakan nilai batasan apa pun untuk setelan tersebut, platform akan sama seperti jika platform telah menentukan nilai default. Jika tidak, apabila tidak ada nilai default, setelan batasan dianggap belum ditetapkan oleh platform tersebut. Dalam hal ini, platform tidak akan cocok dengan daftar batasan apa pun (misalnya untuk config_setting) yang memerlukan nilai tertentu untuk setelan tersebut.

constraint_value

Lihat sumber aturan 
constraint_value(name, constraint_setting, deprecation, distribs, features, licenses, tags, testonly, visibility)
Aturan ini memperkenalkan nilai baru untuk jenis batasan tertentu. Untuk mengetahui detail selengkapnya, lihat halaman Platform.

Contoh

Kode berikut membuat kemungkinan nilai baru untuk constraint_value yang telah ditetapkan sebelumnya yang mewakili arsitektur cpu. 

constraint_value(
    name = "mips",
    constraint_setting = "@platforms//cpu:cpu",
)
Selanjutnya, platform dapat mendeklarasikan bahwa platform tersebut memiliki arsitektur mips sebagai alternatif untuk x86_64, arm, dan seterusnya.

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.
constraint_setting

Label; tidak dapat dikonfigurasi; wajib

constraint_setting yang dapat menampilkan constraint_value ini.

platform

Lihat sumber aturan 
platform(name, constraint_values, deprecation, distribs, exec_properties, features, licenses, parents, remote_execution_properties, tags, testonly, visibility)

Aturan ini menentukan platform baru, yaitu kumpulan pilihan batasan bernama (seperti arsitektur CPU atau versi compiler) yang menjelaskan lingkungan tempat bagian build dapat dijalankan. Untuk mengetahui detail selengkapnya, lihat halaman Platform.

Contoh

Ini mendefinisikan platform yang menjelaskan lingkungan apa pun yang menjalankan Linux di ARM. 

platform(
    name = "linux_arm",
    constraint_values = [
        "@platforms//os:linux",
        "@platforms//cpu:arm",
    ],
)

Pewarisan Platform

Platform dapat menggunakan atribut parents untuk menentukan platform lain yang akan mewarisi nilai batasannya. Meskipun atribut parents mengambil daftar, saat ini tidak lebih dari satu nilai yang didukung, dan menetapkan beberapa induk merupakan error.

Saat memeriksa nilai setelan batasan di platform, pertama-tama nilai yang ditetapkan secara langsung (melalui atribut constraint_values) akan diperiksa, lalu nilai batasan pada induk. Hal ini terus berlanjut ke rantai platform induk secara rekursif. Dengan cara ini, setiap nilai yang ditetapkan langsung pada platform akan menggantikan nilai yang ditetapkan pada induknya.

Platform mewarisi atribut exec_properties dari platform induk. Entri kamus dalam exec_properties platform induk dan turunan akan digabungkan. Jika kunci yang sama muncul di exec_properties induk dan turunan, nilai turunan akan digunakan. Jika platform turunan menetapkan string kosong sebagai nilai, properti terkait akan dibatalkan penetapannya.

Platform juga dapat mewarisi atribut remote_execution_properties (tidak digunakan lagi) dari platform induk. Catatan: kode baru harus menggunakan exec_properties. Logika yang dijelaskan di bawah ini dipertahankan agar kompatibel dengan perilaku lama, tetapi akan dihapus pada masa mendatang. Logika untuk menetapkan remote_execution_platform adalah sebagai berikut saat ada platform induk:

  1. Jika remote_execution_property tidak disetel di platform turunan, remote_execution_properties induk akan digunakan.
  2. Jika remote_execution_property disetel pada platform turunan, dan berisi string literal {PARENT_REMOTE_EXECUTION_PROPERTIES}, makro tersebut akan diganti dengan konten atribut remote_execution_property induk.
  3. Jika remote_execution_property ditetapkan di platform turunan, dan tidak berisi makro, remote_execution_property turunan tidak akan digunakan.

Karena remote_execution_properties tidak digunakan lagi dan akan dihentikan, pencampuran remote_execution_properties dan exec_properties dalam rantai pewarisan yang sama tidak diizinkan. Lebih suka menggunakan exec_properties daripada remote_execution_properties yang tidak digunakan lagi.

Contoh: Nilai Batasan

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"],
)

Dalam contoh ini, platform turunan memiliki properti berikut:

  • child_a memiliki nilai batasan @platforms//os:linux (diwarisi dari induk) dan @platforms//cpu:x86_64 (ditetapkan langsung di platform).
  • child_b mewarisi semua nilai batasan dari induk, dan tidak menetapkan nilai sendiri.

Contoh: Properti eksekusi

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"
    }
)

Dalam contoh ini, platform turunan memiliki properti berikut:

  • child_a mewarisi "exec_properties" induk dan tidak menetapkan miliknya sendiri.
  • child_b mewarisi exec_properties induk dan mengganti nilai k1. exec_properties-nya akan menjadi: { "k1": "child", "k2": "v2" }.
  • child_c mewarisi exec_properties induk dan membatalkan penetapan k1. exec_properties-nya akan menjadi: { "k2": "v2" }.
  • child_d mewarisi exec_properties induk dan menambahkan properti baru. exec_properties-nya akan menjadi: { "k1": "v1", "k2": "v2", "k3": "v3" }.

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.
constraint_values

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

Kombinasi pilihan batasan yang ada pada platform ini. Agar platform dapat diterapkan ke lingkungan tertentu, lingkungan harus memiliki setidaknya nilai yang ada dalam daftar ini.

Setiap constraint_value dalam daftar ini harus ditujukan untuk constraint_setting yang berbeda. Misalnya, Anda tidak dapat menentukan platform yang mengharuskan arsitektur CPU menjadi @platforms//cpu:x86_64 dan @platforms//cpu:arm.

exec_properties

Kamus: String -> String; tidak dapat dikonfigurasi; defaultnya adalah {}

Peta string yang memengaruhi cara tindakan dijalankan dari jarak jauh. Bazel tidak berupaya menafsirkannya. Bazel diperlakukan sebagai data buram yang diteruskan melalui kolom Platform dari protokol eksekusi jarak jauh. Ini mencakup semua data dari atribut exec_properties platform induk. Jika platform turunan dan induk menentukan kunci yang sama, nilai turunan akan dipertahankan. Setiap kunci yang terkait dengan nilai yang merupakan string kosong akan dihapus dari kamus. Atribut ini adalah pengganti penuh untuk remote_execution_properties yang tidak digunakan lagi.
parents

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

Label target platform yang harus diwarisi oleh platform ini. Meskipun atribut ini mengambil daftar, tidak boleh ada lebih dari satu platform. Setiap constraint_settings yang tidak ditetapkan langsung di platform ini akan ditemukan di platform induk. Lihat bagian Pewarisan Platform untuk mengetahui detailnya.
remote_execution_properties

String; tidak dapat dikonfigurasi; defaultnya adalah ""

TIDAK DIGUNAKAN LAGI. Sebagai gantinya, gunakan atribut exec_properties. String yang digunakan untuk mengonfigurasi platform eksekusi jarak jauh. Build yang sebenarnya tidak berupaya menafsirkannya. Build akan diperlakukan sebagai data buram yang dapat digunakan oleh SpawnRunner tertentu. Ini dapat mencakup data dari atribut "remote_execution_properties" platform induk, dengan menggunakan makro "{PARENT_REMOTE_EXECUTION_PROPERTIES}". Lihat bagian Pewarisan Platform untuk mengetahui detailnya.

toolchain

Lihat sumber aturan 
toolchain(name, deprecation, distribs, exec_compatible_with, features, licenses, tags, target_compatible_with, target_settings, testonly, toolchain, toolchain_type, visibility)

Aturan ini mendeklarasikan jenis dan batasan toolchain tertentu sehingga dapat dipilih selama resolusi toolchain. Lihat halaman Toolchain untuk mengetahui detail selengkapnya.

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.
exec_compatible_with

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

Daftar constraint_value yang harus dipenuhi oleh platform eksekusi agar toolchain ini dapat dipilih untuk build target pada platform tersebut.
target_compatible_with

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

Daftar constraint_value yang harus dipenuhi oleh platform target agar toolchain ini dapat dipilih untuk build target untuk platform tersebut.
target_settings

Daftar label; defaultnya adalah []

Daftar config_setting yang harus dipenuhi oleh konfigurasi target agar toolchain ini dapat dipilih selama resolusi toolchain.
toolchain

Nama; wajib diisi

Target yang merepresentasikan rangkaian alat atau rangkaian alat sebenarnya yang tersedia saat toolchain ini dipilih.
toolchain_type

Label; tidak dapat dikonfigurasi; wajib

Label target toolchain_type yang merepresentasikan peran yang dilayani toolchain ini.

toolchain_type

Lihat sumber aturan 
toolchain_type(name, compatible_with, deprecation, features, restricted_to, tags, target_compatible_with, testonly, visibility)

Aturan ini menetapkan jenis toolchain baru -- target sederhana yang mewakili class alat yang memiliki peran yang sama untuk platform yang berbeda.

Lihat halaman Toolchain untuk detail selengkapnya.

Contoh

Kode ini menentukan jenis toolchain untuk aturan kustom. 

toolchain_type(
    name = "bar_toolchain_type",
)

Ini dapat digunakan dalam file 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"]
)

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.