Platform

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.
Laporkan masalah Lihat sumber

Bazel dapat mem-build dan menguji kode di berbagai hardware, sistem operasi, dan konfigurasi sistem, menggunakan berbagai versi alat build seperti linker dan compiler. Untuk membantu mengelola kerumitan ini, Bazel memiliki konsep batasan dan platform. Batasan adalah dimensi yang mungkin membuat lingkungan build atau produksi berbeda, seperti arsitektur CPU, keberadaan atau tidak adanya GPU, atau versi compiler yang diinstal sistem. Platform adalah kumpulan pilihan bernama untuk batasan ini, yang mewakili resource tertentu yang tersedia di beberapa lingkungan.

Pemodelan lingkungan sebagai platform membantu Bazel memilih toolchain yang sesuai untuk tindakan build. Platform juga dapat digunakan bersama dengan aturan config_setting untuk menulis atribut yang dapat dikonfigurasi.

Bazel mengenali tiga peran yang dapat disalurkan platform:

  • Host - platform tempat Bazel sendiri berjalan.
  • Eksekusi - platform tempat alat build menjalankan tindakan build untuk menghasilkan output perantara dan final.
  • Target - platform tempat output akhir berada dan dieksekusi.

Bazel mendukung skenario build berikut terkait platform:

  • Build platform tunggal (default) - host, eksekusi, dan platform target sama. Misalnya, mem-build file Linux yang dapat dieksekusi di Ubuntu yang berjalan pada CPU Intel x64.

  • Build lintas kompilasi - platform host dan eksekusi sama, tetapi platform target berbeda. Misalnya, mem-build aplikasi iOS di macOS yang berjalan di MacBook Pro.

  • Build multi-platform - platform host, eksekusi, dan target berbeda.

Menentukan batasan dan platform

Ruang yang dapat dipilih untuk platform ditentukan menggunakan aturan constraint_setting dan constraint_value dalam file BUILD. constraint_setting membuat dimensi baru, sedangkan constraint_value membuat nilai baru untuk dimensi tertentu; bersama-sama keduanya menentukan enum dan nilai yang memungkinkan secara efektif. Misalnya, cuplikan file BUILD berikut memperkenalkan batasan untuk versi glibc sistem dengan dua kemungkinan nilai.

constraint_setting(name = "glibc_version")

constraint_value(
    name = "glibc_2_25",
    constraint_setting = ":glibc_version",
)

constraint_value(
    name = "glibc_2_26",
    constraint_setting = ":glibc_version",
)

Batasan dan nilainya dapat ditentukan di berbagai paket dalam ruang kerja. Keduanya direferensikan oleh label dan tunduk pada kontrol visibilitas biasa. Jika visibilitas memungkinkan, Anda dapat memperluas setelan batasan yang ada dengan menentukan nilai Anda sendiri untuk parameter tersebut.

Aturan platform memperkenalkan platform baru dengan pilihan nilai batasan tertentu. Berikut membuat platform bernama linux_x86, dan mengatakan bahwa itu menjelaskan lingkungan apa pun yang menjalankan sistem operasi Linux pada arsitektur x86_64 dengan versi glibc 2.25. (Lihat selengkapnya di bawah tentang batasan bawaan Bazel.)

platform(
    name = "linux_x86",
    constraint_values = [
        "@platforms//os:linux",
        "@platforms//cpu:x86_64",
        ":glibc_2_25",
    ],
)

Batasan dan platform yang umumnya berguna

Agar ekosistemnya tetap konsisten, tim Bazel mengelola repositori dengan definisi batasan untuk arsitektur CPU dan sistem operasi yang paling populer. Semuanya ada di https://github.com/bazelbuild/platforms.

Bazel dikirimkan dengan definisi platform khusus berikut: @local_config_platform//:host. Ini adalah nilai platform host yang terdeteksi otomatis - mewakili platform yang terdeteksi otomatis untuk sistem yang dijalankan Bazel.

Menentukan platform untuk build

Anda dapat menentukan platform host dan target untuk build menggunakan tanda command line berikut:

  • --host_platform - setelan default ke @bazel_tools//platforms:host_platform
  • --platforms - setelan default ke @bazel_tools//platforms:target_platform

Melewati target yang tidak kompatibel

Saat membuat untuk platform target tertentu, sering kali diinginkan untuk melewatkan target yang tidak akan pernah berfungsi pada platform tersebut. Misalnya, driver perangkat Windows Anda kemungkinan akan menghasilkan banyak error compiler saat mem-build mesin Linux dengan //.... Gunakan atribut target_compatible_with untuk memberi tahu Bazel batasan platform target yang dimiliki kode Anda.

Penggunaan atribut ini yang paling sederhana membatasi target ke satu platform. Target tidak akan dibuat untuk platform apa pun yang tidak memenuhi semua batasan. Contoh berikut membatasi win_driver_lib.cc ke Windows 64-bit.

cc_library(
    name = "win_driver_lib",
    srcs = ["win_driver_lib.cc"],
    target_compatible_with = [
        "@platforms//cpu:x86_64",
        "@platforms//os:windows",
    ],
)

:win_driver_lib hanya kompatibel untuk build dengan Windows 64-bit dan tidak kompatibel dengan Windows 64-bit lainnya. Ketidakcocokan ini bersifat transitif. Setiap target yang secara transitif bergantung pada target yang tidak kompatibel dianggap tidak kompatibel.

Kapan target dilewati?

Target akan dilewati jika dianggap tidak kompatibel dan disertakan dalam build sebagai bagian dari perluasan pola target. Misalnya, dua pemanggilan berikut akan melewati target yang tidak kompatibel yang ditemukan dalam perluasan pola target.

$ bazel build --platforms=//:myplatform //...
$ bazel build --platforms=//:myplatform //:all

Pengujian yang tidak kompatibel dalam test_suite juga dilewati jika test_suite ditentukan pada command line dengan --expand_test_suites. Dengan kata lain, target test_suite pada command line berperilaku seperti :all dan .... Menggunakan --noexpand_test_suites akan mencegah perluasan dan menyebabkan target test_suite dengan pengujian yang tidak kompatibel juga tidak kompatibel.

Menentukan target yang tidak kompatibel secara eksplisit pada command line akan menghasilkan pesan error dan build gagal.

$ bazel build --platforms=//:myplatform //:target_incompatible_with_myplatform
...
ERROR: Target //:target_incompatible_with_myplatform is incompatible and cannot be built, but was explicitly requested.
...
FAILED: Build did NOT complete successfully

Batasan lebih ekspresif

Untuk fleksibilitas yang lebih tinggi dalam mengekspresikan batasan, gunakan @platforms//:incompatible constraint_value yang tidak ada kepuasan platform.

Gunakan select() bersama dengan @platforms//:incompatible untuk mengekspresikan batasan yang lebih rumit. Misalnya, gunakan untuk menerapkan logika OR dasar. Kode berikut menandai library yang kompatibel dengan macOS dan Linux, tetapi tidak dengan platform lain.

cc_library(
    name = "unixish_lib",
    srcs = ["unixish_lib.cc"],
    target_compatible_with = select({
        "@platforms//os:osx": [],
        "@platforms//os:linux": [],
        "//conditions:default": ["@platforms//:incompatible"],
    }),
)

Hal di atas dapat ditafsirkan sebagai berikut:

  1. Saat menargetkan macOS, targetnya tidak memiliki batasan.
  2. Saat menargetkan Linux, target tidak memiliki batasan.
  3. Jika tidak, target akan memiliki batasan @platforms//:incompatible. Karena @platforms//:incompatible bukan bagian dari platform apa pun, targetnya dianggap tidak kompatibel.

Agar batasan Anda lebih mudah dibaca, gunakan selects.with_or() skylib.

Anda dapat mengekspresikan kompatibilitas terbalik dengan cara yang sama. Contoh berikut menjelaskan library yang kompatibel dengan semua hal kecuali untuk ARM.

cc_library(
    name = "non_arm_lib",
    srcs = ["non_arm_lib.cc"],
    target_compatible_with = select({
        "@platforms//cpu:arm": ["@platforms//:incompatible"],
        "//conditions:default": [],
    ],
)

Mendeteksi target yang tidak kompatibel menggunakan bazel cquery

Anda dapat menggunakan IncompatiblePlatformProvider dalam format output Starlark bazel cquery untuk membedakan target yang tidak kompatibel dengan target yang kompatibel.

Ini dapat digunakan untuk memfilter target yang tidak kompatibel. Contoh di bawah hanya akan mencetak label untuk target yang kompatibel. Target yang tidak kompatibel tidak akan dicetak.

$ cat example.cquery

def format(target):
  if "IncompatiblePlatformProvider" not in providers(target):
    return target.label
  return ""


$ bazel cquery //... --output=starlark --starlark:file=example.cquery

Masalah Umum

Target yang tidak kompatibel mengabaikan pembatasan visibilitas.