Nền tảng

Báo cáo sự cố Xem nguồn

Bazel có thể tạo và kiểm thử mã trên nhiều loại phần cứng, hệ điều hành và cấu hình hệ thống, sử dụng nhiều phiên bản công cụ xây dựng, chẳng hạn như trình liên kết và trình biên dịch. Để giúp xử lý sự phức tạp này, Bazel đã có khái niệm về các quy tắc ràng buộcnền tảng. Quy tắc ràng buộc là một phương diện mà trong đó môi trường xây dựng hoặc sản xuất có thể khác nhau, chẳng hạn như cấu trúc CPU, sự có mặt hoặc không có GPU, hoặc phiên bản của trình biên dịch do hệ thống cài đặt. Nền tảng là một tập hợp các lựa chọn được đặt tên cho các quy tắc ràng buộc này, đại diện cho các tài nguyên cụ thể có sẵn trong một số môi trường.

Việc lập mô hình môi trường dưới dạng nền tảng giúp Bazel tự động chọn chuỗi công cụ phù hợp cho các thao tác tạo bản dựng. Bạn cũng có thể sử dụng các nền tảng kết hợp với quy tắc config_setting để ghi các thuộc tính có thể định cấu hình.

Bazel nhận thấy có 3 vai trò mà một nền tảng có thể phục vụ:

  • Host (Máy chủ lưu trữ) – nền tảng mà Bazel tự chạy.
  • Thực thi – một nền tảng nơi các công cụ xây dựng thực thi các hành động tạo bản dựng để tạo ra kết quả trung gian và đầu ra cuối cùng.
  • Mục tiêu – một nền tảng nơi lưu trữ và thực thi đầu ra cuối cùng.

Bazel hỗ trợ các trường hợp xây dựng sau đây liên quan đến nền tảng:

  • Bản dựng một nền tảng (mặc định) – nền tảng lưu trữ, thực thi và mục tiêu giống nhau. Ví dụ: tạo một tệp thực thi Linux trên Ubuntu chạy trên CPU Intel x64.

  • Các bản dựng có chức năng biên dịch chéo – nền tảng lưu trữ và thực thi giống nhau, nhưng nền tảng mục tiêu thì khác. Ví dụ: tạo một ứng dụng iOS trên macOS chạy trên MacBook Pro.

  • Các bản dựng đa nền tảng – nền tảng lưu trữ, thực thi và mục tiêu đều khác nhau.

Xác định các điều kiện ràng buộc và nền tảng

Không gian cho các lựa chọn nền tảng được xác định bằng cách sử dụng các quy tắc constraint_settingconstraint_value trong BUILD tệp. constraint_setting tạo một thứ nguyên mới, trong khi constraint_value tạo một giá trị mới cho một thứ nguyên nhất định; cùng nhau, chúng sẽ xác định hiệu quả một enum và các giá trị có thể có của nó. Ví dụ: đoạn mã sau đây của tệp BUILD sẽ giới thiệu một quy tắc ràng buộc cho phiên bản glibc của hệ thống với hai giá trị có thể có.

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

Bạn có thể xác định các quy tắc ràng buộc và giá trị của chúng trên nhiều gói trong không gian làm việc. Các chế độ này được nhãn tham chiếu và tuân theo các chế độ kiểm soát chế độ hiển thị thông thường. Nếu chế độ hiển thị cho phép, bạn có thể mở rộng chế độ cài đặt ràng buộc hiện có bằng cách xác định giá trị của riêng bạn cho chế độ cài đặt đó.

Quy tắc platform giới thiệu một nền tảng mới với một số lựa chọn nhất định về giá trị ràng buộc. Nội dung sau đây sẽ tạo một nền tảng có tên linux_x86 và mô tả mọi môi trường chạy hệ điều hành Linux trên kiến trúc x86_64 có phiên bản glibc 2.25. (Xem phần dưới đây để biết thêm về các điều kiện ràng buộc tích hợp của Bazel.)

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

Những quy tắc ràng buộc và nền tảng nhìn chung hữu ích

Để đảm bảo hệ sinh thái được nhất quán, đội ngũ Bazel duy trì một kho lưu trữ có các định nghĩa ràng buộc cho những kiến trúc CPU và hệ điều hành phổ biến nhất. Tất cả các dịch vụ này đều nằm trên https://github.com/bazelbuild/platforms.

Bazel cung cấp định nghĩa nền tảng đặc biệt sau đây: @platforms//host (có bí danh là @bazel_tools//tools:host_platform). Đây là giá trị nền tảng lưu trữ được phát hiện tự động – đại diện cho nền tảng được phát hiện tự động cho hệ thống mà Bazel đang chạy.

Chỉ định nền tảng cho bản dựng

Bạn có thể chỉ định nền tảng lưu trữ và nền tảng đích cho một bản dựng bằng cách sử dụng các cờ dòng lệnh sau:

  • --host_platform – mặc định là @bazel_tools//tools:host_platform
    • Mục tiêu này được đặt bí danh là @platforms//host, được hỗ trợ bởi một quy tắc kho lưu trữ giúp phát hiện hệ điều hành và CPU của máy chủ, đồng thời ghi mục tiêu nền tảng.
    • Ngoài ra còn có @platforms//host:constraints.bzl để hiển thị một mảng có tên là HOST_CONSTRAINTS, có thể dùng trong các tệp BUILD và Starlark khác.
  • --platforms – mặc định là nền tảng lưu trữ
    • Điều này có nghĩa là khi không có cờ nào khác được đặt, @platforms//host là nền tảng mục tiêu.
    • Nếu bạn đặt --host_platform mà không phải --platforms, thì giá trị của --host_platform sẽ vừa là nền tảng lưu trữ vừa là nền tảng mục tiêu.

Bỏ qua các mục tiêu không tương thích

Khi xây dựng cho một nền tảng mục tiêu cụ thể, bạn nên bỏ qua các mục tiêu không bao giờ hoạt động trên nền tảng đó. Ví dụ: trình điều khiển thiết bị Windows có thể sẽ tạo nhiều lỗi trình biên dịch khi tạo trên máy Linux có //.... Sử dụng thuộc tính target_compatible_with để cho Bazel biết mã của bạn có những hạn chế đối với nền tảng mục tiêu nào.

Cách sử dụng đơn giản nhất của thuộc tính này là giới hạn mục tiêu trong một nền tảng duy nhất. Mục tiêu sẽ không được xây dựng cho bất kỳ nền tảng nào không đáp ứng được tất cả các điều kiện ràng buộc. Ví dụ sau đây giới hạn win_driver_lib.cc ở 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 chỉ tương thích với việc xây dựng ứng dụng trên Windows 64 bit và không tương thích với mọi phiên bản khác. Tính không tương thích mang tính bắc cầu. Mọi mục tiêu phụ thuộc bắc cầu vào một mục tiêu không tương thích đều được coi là không tương thích.

Khi nào các mục tiêu bị bỏ qua?

Các mục tiêu bị bỏ qua khi bị coi là không tương thích và được đưa vào bản dựng trong quá trình mở rộng mẫu mục tiêu. Ví dụ: 2 lệnh gọi sau đây bỏ qua mọi mục tiêu không tương thích được tìm thấy trong mở rộng mẫu mục tiêu.

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

Các kiểm thử không tương thích trong test_suite cũng bị bỏ qua nếu test_suite được chỉ định trên dòng lệnh bằng --expand_test_suites. Nói cách khác, các mục tiêu test_suite trên dòng lệnh hoạt động giống như :all.... Việc sử dụng --noexpand_test_suites sẽ ngăn chặn việc mở rộng và khiến các mục tiêu test_suite có các kiểm thử không tương thích cũng không tương thích.

Việc chỉ định rõ ràng một mục tiêu không tương thích trên dòng lệnh sẽ dẫn đến thông báo lỗi và bản dựng không thành công.

$ 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

Các mục tiêu rõ ràng không tương thích sẽ tự động bị bỏ qua nếu bạn bật --skip_incompatible_explicit_targets.

Các quy tắc ràng buộc rõ ràng hơn

Để linh hoạt hơn trong việc thể hiện các quy tắc ràng buộc, hãy sử dụng @platforms//:incompatible constraint_value mà không có nền tảng nào đáp ứng.

Sử dụng select() kết hợp với @platforms//:incompatible để thể hiện các quy tắc hạn chế phức tạp hơn. Ví dụ: hãy sử dụng hàm này để triển khai logic OR cơ bản. Giá trị sau đây đánh dấu một thư viện tương thích với macOS và Linux, nhưng không tương thích với nền tảng nào khác.

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

Những điều trên có thể được hiểu như sau:

  1. Khi nhắm đến macOS, mục tiêu không có quy tắc ràng buộc nào.
  2. Khi nhắm mục tiêu Linux, mục tiêu sẽ không có quy tắc ràng buộc nào.
  3. Nếu không, mục tiêu có quy tắc ràng buộc @platforms//:incompatible. Vì @platforms//:incompatible không thuộc bất kỳ nền tảng nào, nên mục tiêu được xem là không tương thích.

Để các quy tắc ràng buộc của bạn dễ đọc hơn, hãy sử dụng selects.with_or() của skylib.

Bạn có thể thể hiện khả năng tương thích ngược theo cách tương tự. Ví dụ sau đây mô tả một thư viện tương thích với mọi sản phẩm, ngoại trừ ARM.

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

Phát hiện mục tiêu không tương thích bằng bazel cquery

Bạn có thể sử dụng IncompatiblePlatformProvider trong định dạng đầu ra Starlark của bazel cquery để phân biệt mục tiêu không tương thích với các mục tiêu tương thích.

Bạn có thể dùng thông tin này để lọc ra các mục tiêu không tương thích. Ví dụ bên dưới sẽ chỉ in nhãn cho các mục tiêu tương thích. Các mục tiêu không tương thích sẽ không được in.

$ cat example.cquery

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


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

Vấn đề đã biết

Mục tiêu không tương thích bỏ qua các hạn chế về chế độ hiển thị.