Catat Tanggalnya: BazelCon 2023 akan diadakan pada 24-25 Oktober di Google Munich! Pelajari lebih lanjut

Toolchain

Laporkan masalah Lihat sumber

Halaman ini menjelaskan framework toolchain, yang merupakan cara bagi penulis aturan untuk memisahkan logika aturannya dari pemilihan alat berbasis platform. Sebaiknya baca halaman aturan dan platform sebelum melanjutkan. Halaman ini membahas alasan toolchain diperlukan, cara menentukan dan menggunakannya, dan cara Bazel memilih toolchain yang sesuai berdasarkan batasan platform.

Motivasi

Pertama-tama, mari kita lihat toolchain yang dirancang untuk dipecahkan masalahnya. Misalkan Anda menulis aturan untuk mendukung bahasa pemrograman "bar". Aturan bar_binary Anda akan mengompilasi file *.bar menggunakan compiler barc, sebuah alat yang di-build sebagai target lain di ruang kerja Anda. Karena pengguna yang menulis target bar_binary seharusnya tidak perlu menentukan dependensi pada compiler, Anda harus menjadikannya dependensi implisit dengan menambahkannya ke definisi aturan sebagai atribut pribadi.

bar_binary = rule(
    implementation = _bar_binary_impl,
    attrs = {
        "srcs": attr.label_list(allow_files = True),
        ...
        "_compiler": attr.label(
            default = "//bar_tools:barc_linux",  # the compiler running on linux
            providers = [BarcInfo],
        ),
    },
)

//bar_tools:barc_linux sekarang menjadi dependensi dari setiap target bar_binary, sehingga akan dibuat sebelum target bar_binary. Aturan ini dapat diakses oleh fungsi implementasi aturan seperti atribut lainnya:

BarcInfo = provider(
    doc = "Information about how to invoke the barc compiler.",
    # In the real world, compiler_path and system_lib might hold File objects,
    # but for simplicity they are strings for this example. arch_flags is a list
    # of strings.
    fields = ["compiler_path", "system_lib", "arch_flags"],
)

def _bar_binary_impl(ctx):
    ...
    info = ctx.attr._compiler[BarcInfo]
    command = "%s -l %s %s" % (
        info.compiler_path,
        info.system_lib,
        " ".join(info.arch_flags),
    )
    ...

Masalah yang ada di sini adalah bahwa label compiler di-hardcode menjadi bar_binary, tetapi target yang berbeda mungkin memerlukan compiler yang berbeda bergantung pada platform yang mereka buat dan platform tempat mereka dibuat -- masing-masing disebut platform target dan platform eksekusi. Selain itu, penulis aturan tidak selalu mengetahui semua alat dan platform yang tersedia, sehingga tidak mungkin meng-hardcode-nya dalam definisi aturan.

Solusi yang kurang ideal adalah mengalihkan beban kepada pengguna, dengan membuat atribut _compiler menjadi non-pribadi. Lalu, setiap target dapat di-hardcode untuk dibuat untuk satu platform atau platform lainnya.

bar_binary(
    name = "myprog_on_linux",
    srcs = ["mysrc.bar"],
    compiler = "//bar_tools:barc_linux",
)

bar_binary(
    name = "myprog_on_windows",
    srcs = ["mysrc.bar"],
    compiler = "//bar_tools:barc_windows",
)

Anda dapat meningkatkan solusi ini dengan menggunakan select untuk memilih compiler berdasarkan platform:

config_setting(
    name = "on_linux",
    constraint_values = [
        "@platforms//os:linux",
    ],
)

config_setting(
    name = "on_windows",
    constraint_values = [
        "@platforms//os:windows",
    ],
)

bar_binary(
    name = "myprog",
    srcs = ["mysrc.bar"],
    compiler = select({
        ":on_linux": "//bar_tools:barc_linux",
        ":on_windows": "//bar_tools:barc_windows",
    }),
)

Namun, ini membosankan dan sedikit banyak ditanyakan kepada setiap pengguna bar_binary. Jika gaya ini tidak digunakan secara konsisten di seluruh ruang kerja, gaya tersebut akan menghasilkan build yang berfungsi dengan baik di satu platform, tetapi gagal saat diperluas ke skenario multi-platform. Perubahan ini juga tidak mengatasi masalah penambahan dukungan untuk platform dan compiler baru tanpa mengubah aturan atau target yang ada.

Framework toolchain mengatasi masalah ini dengan menambahkan tingkat arah tambahan. Pada dasarnya, Anda mendeklarasikan bahwa aturan Anda memiliki dependensi abstrak pada beberapa anggota grup target (jenis toolchain), dan Bazel akan secara otomatis menyelesaikan ini untuk target tertentu (Toolchain) berdasarkan batasan platform yang berlaku. Baik penulis aturan maupun penulis target tidak perlu mengetahui rangkaian lengkap platform dan toolchain yang tersedia.

Menulis aturan yang menggunakan toolchain

Berdasarkan framework toolchain, alih-alih memiliki aturan yang bergantung secara langsung pada alat, aturan tersebut bergantung pada jenis toolchain. Jenis toolchain adalah target sederhana yang mewakili class alat yang menjalankan peran yang sama untuk platform yang berbeda. Misalnya, Anda dapat mendeklarasikan jenis yang merepresentasikan compiler panel:

# By convention, toolchain_type targets are named "toolchain_type" and
# distinguished by their package path. So the full path for this would be
# //bar_tools:toolchain_type.
toolchain_type(name = "toolchain_type")

Definisi aturan di bagian sebelumnya diubah, sehingga tidak menggunakan compiler sebagai atribut, tetapi mendeklarasikan bahwa toolchain tersebut menggunakan toolchain //bar_tools:toolchain_type.

bar_binary = rule(
    implementation = _bar_binary_impl,
    attrs = {
        "srcs": attr.label_list(allow_files = True),
        ...
        # No `_compiler` attribute anymore.
    },
    toolchains = ["//bar_tools:toolchain_type"],
)

Fungsi implementasi kini mengakses dependensi ini pada ctx.toolchains, bukan ctx.attr, menggunakan jenis toolchain sebagai kunci.

def _bar_binary_impl(ctx):
    ...
    info = ctx.toolchains["//bar_tools:toolchain_type"].barcinfo
    # The rest is unchanged.
    command = "%s -l %s %s" % (
        info.compiler_path,
        info.system_lib,
        " ".join(info.arch_flags),
    )
    ...

ctx.toolchains["//bar_tools:toolchain_type"] menampilkan penyedia ToolchainInfo dari target apa pun yang diselesaikan dependensi Bazel. Kolom objek ToolchainInfo ditetapkan oleh aturan alat dasar; di bagian berikutnya, aturan ini ditentukan sedemikian rupa sehingga ada kolom barcinfo yang menggabungkan objek BarcInfo.

Prosedur Bazel untuk menyelesaikan toolchain ke target dijelaskan di bawah. Hanya target toolchain yang telah diselesaikan yang benar-benar menjadi dependensi target bar_binary, bukan seluruh ruang toolchain kandidat.

Toolchain Wajib dan Opsional

Secara default, saat aturan mengekspresikan dependensi jenis toolchain menggunakan label kosong (seperti yang ditunjukkan di atas), jenis toolchain dianggap wajib. Jika Bazel tidak dapat menemukan toolchain yang cocok (lihat Resolusi toolchain di bawah) untuk jenis toolchain wajib, ini adalah error dan penghentian analisis.

Namun, Anda dapat mendeklarasikan dependensi jenis toolchain opsional, seperti berikut:

bar_binary = rule(
    ...
    toolchains = [
        config_common.toolchain_type("//bar_tools:toolchain_type", mandatory = False),
    ],
)

Jika jenis toolchain opsional tidak dapat di-resolve, analisis akan dilanjutkan, dan hasil dari ctx.toolchains["//bar_tools:toolchain_type"] adalah None.

Fungsi config_common.toolchain_type disetel secara default ke wajib.

Formulir berikut dapat digunakan:

  • Jenis toolchain wajib:
    • toolchains = ["//bar_tools:toolchain_type"]
    • toolchains = [config_common.toolchain_type("//bar_tools:toolchain_type")]
    • toolchains = [config_common.toolchain_type("//bar_tools:toolchain_type", mandatory = True)]
  • Jenis toolchain opsional:
    • toolchains = [config_common.toolchain_type("//bar_tools:toolchain_type", mandatory = False)]
bar_binary = rule(
    ...
    toolchains = [
        "//foo_tools:toolchain_type",
        config_common.toolchain_type("//bar_tools:toolchain_type", mandatory = False),
    ],
)

Anda juga dapat menggabungkan dan mencocokkan formulir dalam aturan yang sama. Namun, jika jenis toolchain yang sama tercantum beberapa kali, versi paling ketat akan diterapkan, yang wajib lebih ketat daripada opsional.

Menulis aspek yang menggunakan toolchain

Aspek memiliki akses ke API toolchain yang sama sebagai aturan: Anda dapat menentukan jenis toolchain yang diperlukan, mengakses toolchain melalui konteks, dan menggunakannya untuk menghasilkan tindakan baru menggunakan toolchain.

bar_aspect = aspect(
    implementation = _bar_aspect_impl,
    attrs = {},
    toolchains = ['//bar_tools:toolchain_type'],
)

def _bar_aspect_impl(target, ctx):
  toolchain = ctx.toolchains['//bar_tools:toolchain_type']
  # Use the toolchain provider like in a rule.
  return []

Menentukan toolchain

Untuk menentukan beberapa toolchain untuk jenis toolchain tertentu, Anda memerlukan tiga hal:

  1. Aturan khusus bahasa yang mewakili jenis alat atau rangkaian alat. Berdasarkan aturan, nama aturan ini diberi akhiran "_Toolchain".

    1. Catatan: Aturan \_toolchain tidak dapat membuat tindakan build apa pun. Sebaliknya, API ini mengumpulkan artefak dari aturan lain dan meneruskannya ke aturan yang menggunakan toolchain. Aturan tersebut bertanggung jawab untuk membuat semua tindakan build.
  2. Beberapa target jenis aturan ini, merepresentasikan versi alat atau rangkaian alat untuk berbagai platform.

  3. Untuk setiap target tersebut, target terkait dari aturan toolchain generik, untuk menyediakan metadata yang digunakan oleh framework toolchain. Target toolchain ini juga merujuk pada toolchain_type yang terkait dengan toolchain ini. Artinya, aturan _toolchain tertentu dapat dikaitkan dengan toolchain_type apa pun, dan hanya dalam instance toolchain yang menggunakan aturan _toolchain ini bahwa aturan tersebut dikaitkan dengan toolchain_type.

Untuk contoh yang sedang berjalan, berikut adalah definisi untuk aturan bar_toolchain. Contoh kami hanya memiliki compiler, tetapi alat lain seperti linker juga dapat dikelompokkan di bawahnya.

def _bar_toolchain_impl(ctx):
    toolchain_info = platform_common.ToolchainInfo(
        barcinfo = BarcInfo(
            compiler_path = ctx.attr.compiler_path,
            system_lib = ctx.attr.system_lib,
            arch_flags = ctx.attr.arch_flags,
        ),
    )
    return [toolchain_info]

bar_toolchain = rule(
    implementation = _bar_toolchain_impl,
    attrs = {
        "compiler_path": attr.string(),
        "system_lib": attr.string(),
        "arch_flags": attr.string_list(),
    },
)

Aturan ini harus menampilkan penyedia ToolchainInfo, yang menjadi objek yang diambil oleh aturan yang dikonsumsi menggunakan ctx.toolchains dan label jenis toolchain. ToolchainInfo, seperti struct, dapat menyimpan pasangan nilai kolom arbitrer. Spesifikasi kolom yang ditambahkan ke ToolchainInfo secara tepat harus didokumentasikan dengan jelas pada jenis toolchain. Dalam contoh ini, nilai yang digabungkan dalam objek BarcInfo untuk menggunakan kembali skema yang ditentukan di atas; gaya ini mungkin berguna untuk validasi dan penggunaan ulang kode.

Sekarang Anda dapat menentukan target untuk compiler barc tertentu.

bar_toolchain(
    name = "barc_linux",
    arch_flags = [
        "--arch=Linux",
        "--debug_everything",
    ],
    compiler_path = "/path/to/barc/on/linux",
    system_lib = "/usr/lib/libbarc.so",
)

bar_toolchain(
    name = "barc_windows",
    arch_flags = [
        "--arch=Windows",
        # Different flags, no debug support on windows.
    ],
    compiler_path = "C:\\path\\on\\windows\\barc.exe",
    system_lib = "C:\\path\\on\\windows\\barclib.dll",
)

Terakhir, Anda akan membuat definisi toolchain untuk dua target bar_toolchain. Definisi ini menautkan target khusus bahasa ke jenis toolchain dan memberikan informasi batasan yang memberi tahu Bazel saat toolchain sesuai untuk platform tertentu.

toolchain(
    name = "barc_linux_toolchain",
    exec_compatible_with = [
        "@platforms//os:linux",
        "@platforms//cpu:x86_64",
    ],
    target_compatible_with = [
        "@platforms//os:linux",
        "@platforms//cpu:x86_64",
    ],
    toolchain = ":barc_linux",
    toolchain_type = ":toolchain_type",
)

toolchain(
    name = "barc_windows_toolchain",
    exec_compatible_with = [
        "@platforms//os:windows",
        "@platforms//cpu:x86_64",
    ],
    target_compatible_with = [
        "@platforms//os:windows",
        "@platforms//cpu:x86_64",
    ],
    toolchain = ":barc_windows",
    toolchain_type = ":toolchain_type",
)

Penggunaan sintaksis jalur relatif di atas menunjukkan bahwa definisi ini semuanya ada dalam paket yang sama, tetapi tidak ada alasan bahwa jenis toolchain, target toolchain khusus bahasa, dan target definisi toolchain tidak dapat semuanya ada dalam paket terpisah.

Lihat go_toolchain untuk contoh yang sebenarnya.

Toolchain dan konfigurasi

Pertanyaan penting bagi penulis aturan adalah, saat target bar_toolchain dianalisis, konfigurasi apa yang dilihatnya, dan transisi apa yang harus digunakan untuk dependensi? Contoh di atas menggunakan atribut string, tetapi apa yang akan terjadi untuk toolchain yang lebih rumit, yang bergantung pada target lain di repositori Bazel?

Mari lihat versi bar_toolchain yang lebih kompleks:

def _bar_toolchain_impl(ctx):
    # The implementation is mostly the same as above, so skipping.
    pass

bar_toolchain = rule(
    implementation = _bar_toolchain_impl,
    attrs = {
        "compiler": attr.label(
            executable = True,
            mandatory = True,
            cfg = "exec",
        ),
        "system_lib": attr.label(
            mandatory = True,
            cfg = "target",
        ),
        "arch_flags": attr.string_list(),
    },
)

Penggunaan attr.label sama dengan aturan standar, tetapi arti parameter cfg sedikit berbeda.

Dependensi dari target (disebut "induk") ke toolchain melalui resolusi toolchain menggunakan transisi konfigurasi khusus yang disebut "transisi toolchain". Transisi toolchain membuat konfigurasi tetap sama, kecuali bahwa paksa platform eksekusi agar sama dengan toolchain seperti pada induk (jika tidak, resolusi toolchain untuk toolchain dapat memilih platform eksekusi apa pun, dan tidak harus sama dengan untuk induk). Hal ini memungkinkan dependensi exec toolchain lainnya juga dapat dieksekusi untuk tindakan build induk. Dependensi toolchain mana pun yang menggunakan cfg = "target" (atau yang tidak menentukan cfg, karena "target" adalah defaultnya) dibuat untuk platform target yang sama dengan induk. Hal ini memungkinkan aturan toolchain memkontribusikan library (atribut system_lib di atas) dan alat (atribut compiler) ke aturan build yang memerlukannya. Library sistem ditautkan ke dalam artefak akhir, sehingga harus di-build untuk platform yang sama, sedangkan compiler adalah alat yang dipanggil selama build dan harus dapat berjalan pada platform eksekusi.

Mendaftarkan dan mem-build dengan toolchain

Pada tahap ini, semua elemen penyusun sudah dirakit, dan Anda hanya perlu menyediakan toolchain untuk prosedur resolusi Bazel. Hal ini dilakukan dengan mendaftarkan toolchain, baik dalam file WORKSPACE menggunakan register_toolchains(), atau dengan meneruskan label toolchain pada command line menggunakan flag --extra_toolchains.

register_toolchains(
    "//bar_tools:barc_linux_toolchain",
    "//bar_tools:barc_windows_toolchain",
    # Target patterns are also permitted, so you could have also written:
    # "//bar_tools:all",
)

Sekarang, saat Anda membuat target yang bergantung pada jenis toolchain, toolchain yang sesuai akan dipilih berdasarkan platform eksekusi dan target.

# my_pkg/BUILD

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

bar_binary(
    name = "my_bar_binary",
    ...
)
bazel build //my_pkg:my_bar_binary --platforms=//my_pkg:my_target_platform

Bazel akan melihat bahwa //my_pkg:my_bar_binary sedang dibuat dengan platform yang memiliki @platforms//os:linux dan oleh karena itu, selesaikan referensi //bar_tools:toolchain_type ke //bar_tools:barc_linux_toolchain. Ini akan membuat //bar_tools:barc_linux, tetapi tidak //bar_tools:barc_windows.

Resolusi toolchain

Untuk setiap target yang menggunakan toolchain, prosedur resolusi toolchain Bazel menentukan dependensi toolchain konkret target. Prosedur ini mengambil input dari jenis toolchain yang diperlukan, platform target, daftar platform eksekusi yang tersedia, dan daftar toolchain yang tersedia sebagai input. Outputnya adalah toolchain yang dipilih untuk setiap jenis toolchain serta platform eksekusi yang dipilih untuk target saat ini.

Platform eksekusi dan toolchain yang tersedia dikumpulkan dari file WORKSPACE melalui register_execution_platforms dan register_toolchains. Platform eksekusi dan toolchain tambahan juga dapat ditentukan pada command line melalui --extra_execution_platforms dan --extra_toolchains. Platform host secara otomatis disertakan sebagai platform eksekusi yang tersedia. Platform dan toolchain yang tersedia dilacak sebagai daftar yang diurutkan untuk determinisme, dengan preferensi yang diberikan ke item sebelumnya dalam daftar.

Langkah-langkah penyelesaiannya adalah sebagai berikut.

  1. Klausul target_compatible_with atau exec_compatible_with cocok dengan platform jika, untuk setiap constraint_value dalam daftarnya, platform juga memiliki constraint_value tersebut (baik secara eksplisit maupun default).

    Jika platform memiliki constraint_value dari constraint_setting yang tidak direferensikan oleh klausul, hal ini tidak memengaruhi pencocokan.

  2. Jika target yang dibuat menentukan atribut exec_compatible_with (atau definisi aturannya menentukan argumen exec_compatible_with), daftar platform eksekusi yang tersedia akan difilter untuk menghapus argumen yang tidak cocok dengan batasan eksekusi.

  3. Untuk setiap platform eksekusi yang tersedia, kaitkan setiap jenis toolchain dengan toolchain pertama yang tersedia, jika ada, yang kompatibel dengan platform eksekusi ini dan platform target.

  4. Setiap platform eksekusi yang gagal menemukan toolchain wajib yang kompatibel untuk salah satu jenis toolchain-nya akan diabaikan. Platform yang tersisa akan menjadi platform eksekusi target saat ini, dan toolchain terkaitnya (jika ada) menjadi dependensi target.

Platform eksekusi yang dipilih digunakan untuk menjalankan semua tindakan yang dibuat oleh target.

Jika target yang sama dapat di-build di beberapa konfigurasi (misalnya untuk CPU yang berbeda) dalam build yang sama, prosedur resolusi akan diterapkan secara independen ke setiap versi target.

Jika aturan menggunakan grup eksekusi, setiap grup eksekusi akan melakukan resolusi toolchain secara terpisah, dan masing-masing memiliki platform dan toolchain eksekusinya sendiri.

Men-debug toolchain

Jika Anda menambahkan dukungan toolchain ke aturan yang ada, gunakan flag --toolchain_resolution_debug=regex. Selama resolusi toolchain, flag ini memberikan output panjang untuk jenis toolchain atau nama target yang cocok dengan variabel ekspresi reguler. Anda dapat menggunakan .* untuk menampilkan semua informasi. Bazel akan menampilkan nama toolchain yang diperiksa dan dilewatinya selama proses resolusi.

Jika Anda ingin melihat dependensi cquery yang berasal dari resolusi toolchain, gunakan flag --transitions cquery:

# Find all direct dependencies of //cc:my_cc_lib. This includes explicitly
# declared dependencies, implicit dependencies, and toolchain dependencies.
$ bazel cquery 'deps(//cc:my_cc_lib, 1)'
//cc:my_cc_lib (96d6638)
@bazel_tools//tools/cpp:toolchain (96d6638)
@bazel_tools//tools/def_parser:def_parser (HOST)
//cc:my_cc_dep (96d6638)
@local_config_platform//:host (96d6638)
@bazel_tools//tools/cpp:toolchain_type (96d6638)
//:default_host_platform (96d6638)
@local_config_cc//:cc-compiler-k8 (HOST)
//cc:my_cc_lib.cc (null)
@bazel_tools//tools/cpp:grep-includes (HOST)

# Which of these are from toolchain resolution?
$ bazel cquery 'deps(//cc:my_cc_lib, 1)' --transitions=lite | grep "toolchain dependency"
  [toolchain dependency]#@local_config_cc//:cc-compiler-k8#HostTransition -> b6df211