Di chuyển sang nền tảng

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

Bazel có dịch vụ hỗ trợ tinh vi để lập mô hình các nền tảngchuỗi công cụ cho các bản dựng đa kiến trúc và biên dịch chéo.

Trang này tóm tắt trạng thái của việc hỗ trợ này.

Xem thêm:

Trạng thái

C++

Các quy tắc C++ sử dụng nền tảng để chọn chuỗi công cụ khi bạn đặt --incompatible_enable_cc_toolchain_resolution.

Điều này có nghĩa là bạn có thể định cấu hình dự án C++ bằng:

bazel build //:my_cpp_project --platforms=//:myplatform

thay vì phiên bản cũ:

bazel build //:my_cpp_project` --cpu=... --crosstool_top=...  --compiler=...

Tính năng này sẽ được bật theo mặc định trong Bazel 7.0 (#7260).

Để kiểm thử dự án C++ với các nền tảng, hãy xem bài viết Di chuyển dự ánĐịnh cấu hình chuỗi công cụ C++.

Java

Các quy tắc Java sử dụng nền tảng để chọn chuỗi công cụ.

Thao tác này sẽ thay thế các cờ cũ --java_toolchain, --host_java_toolchain, --javabase--host_javabase.

Vui lòng xem Java và Bazel để biết thông tin chi tiết.

Android

Các quy tắc của Android sử dụng các nền tảng để chọn chuỗi công cụ khi bạn đặt --incompatible_enable_android_toolchain_resolution.

Điều này có nghĩa là bạn có thể định cấu hình dự án Android bằng:

bazel build //:my_android_project --android_platforms=//:my_android_platform

thay vì dùng các cờ cũ như --android_crosstool_top, --android_cpu--fat_apk_cpu.

Tính năng này sẽ được bật theo mặc định trong Bazel 7.0 (#16285).

Để kiểm thử dự án Android với các nền tảng, hãy xem phần Di chuyển dự án.

Quả táo

Các quy tắc của Apple không hỗ trợ nền tảng và chưa được lên lịch hỗ trợ.

Bạn vẫn có thể sử dụng API nền tảng với các bản dựng của Apple (ví dụ: khi tạo bằng sự kết hợp các quy tắc của Apple và C++ thuần tuý) bằng tính năng ánh xạ nền tảng.

Ngôn ngữ khác

Nếu bạn sở hữu một bộ quy tắc ngôn ngữ, hãy xem phần Di chuyển bộ quy tắc để biết thêm thông tin hỗ trợ.

Thông tin khái quát

Nền tảngchuỗi công cụ được ra mắt để chuẩn hoá cách các dự án phần mềm nhắm đến nhiều cấu trúc và biên dịch chéo.

Điều này được truyền cảm hứng khi quan sát thấy các nhà duy trì ngôn ngữ đã thực hiện việc này theo những cách đặc biệt và không tương thích. Ví dụ: các quy tắc C++ sử dụng --cpu--crosstool_top để khai báo CPU mục tiêu và chuỗi công cụ. Không có nguồn nào trong số này mô hình chính xác một "nền tảng". Điều này tạo ra các bản dựng khó xử lý và không chính xác.

Java, Android và các ngôn ngữ khác đã phát triển cờ riêng cho các mục đích tương tự, nhưng không có cờ nào trong số đó hoạt động với nhau. Điều này khiến các bản dựng việc sử dụng trên nhiều ngôn ngữ trở nên khó hiểu và phức tạp.

Bazel dành cho các dự án lớn, đa ngôn ngữ và đa nền tảng. Điều này đòi hỏi sự hỗ trợ theo nguyên tắc hơn cho các khái niệm này, bao gồm một API tiêu chuẩn rõ ràng.

Cần di chuyển

Để nâng cấp lên API mới, bạn cần làm hai việc: phát hành API và nâng cấp logic quy tắc để sử dụng API đó.

Hành động đầu tiên đã hoàn tất, nhưng quảng cáo thứ hai vẫn đang diễn ra. Điều này bao gồm việc đảm bảo các chuỗi công cụ và nền tảng dành riêng cho ngôn ngữ được xác định, logic ngôn ngữ sẽ đọc chuỗi công cụ thông qua API mới thay vì các cờ cũ như --crosstool_topconfig_setting chọn trên API mới thay vì cờ cũ.

Công việc này đơn giản nhưng đòi hỏi nỗ lực riêng cho từng ngôn ngữ, cộng với cảnh báo công bằng để chủ sở hữu dự án kiểm thử các thay đổi sắp tới.

Đây là lý do tại sao quá trình di chuyển này diễn ra liên tục.

Mục tiêu

Quá trình di chuyển này hoàn tất khi tất cả dự án được tạo bằng biểu mẫu:

bazel build //:myproject --platforms=//:myplatform

Điều này có nghĩa là:

  1. Các quy tắc của dự án chọn chuỗi công cụ phù hợp cho //:myplatform.
  2. Các phần phụ thuộc của dự án chọn chuỗi công cụ phù hợp cho //:myplatform.
  3. //:myplatform tham chiếu đến các nội dung khai báo phổ biến của CPU, OS và các thuộc tính chung, độc lập về ngôn ngữ khác
  4. Tất cả select() liên quan đều khớp đúng với //:myplatform.
  5. //:myplatform được xác định ở một vị trí rõ ràng và dễ tiếp cận: trong kho lưu trữ của dự án nếu nền tảng là dành riêng cho dự án của bạn, hoặc tại một vị trí chung nào đó mà tất cả các dự án đang dùng đều có thể tìm thấy nền tảng đó

Các cờ cũ như --cpu, --crosstool_top--fat_apk_cpu sẽ không được dùng nữa và bị xoá ngay khi thấy an toàn.

Cuối cùng, đây sẽ là cách duy nhất để định cấu hình kiến trúc.

Di chuyển dự án

Nếu tạo bản dựng bằng các ngôn ngữ hỗ trợ nền tảng, thì bản dựng của bạn đã hoạt động được với một lệnh gọi như:

bazel build //:myproject --platforms=//:myplatform

Xem phần Trạng thái và tài liệu về ngôn ngữ của bạn để biết thông tin chi tiết chính xác.

Nếu một ngôn ngữ yêu cầu cờ để cho phép hỗ trợ nền tảng, thì bạn cũng cần đặt cờ đó. Xem phần Trạng thái để biết chi tiết.

Để tạo bản dựng dự án, bạn cần kiểm tra những điều sau:

  1. //:myplatform phải tồn tại. Thông thường, chủ sở hữu dự án có trách nhiệm xác định nền tảng vì các dự án khác nhau nhắm mục tiêu đến các máy khác nhau. Hãy xem phần Nền tảng mặc định.

  2. Chuỗi công cụ bạn muốn sử dụng phải tồn tại. Nếu sử dụng chuỗi công cụ thương mại, thì chủ sở hữu ngôn ngữ nên cung cấp hướng dẫn về cách đăng ký các chuỗi công cụ đó. Nếu viết các chuỗi công cụ tuỳ chỉnh của riêng mình, bạn cần register các chuỗi công cụ đó trong WORKSPACE hoặc bằng --extra_toolchains.

  3. Các select()chuyển đổi cấu hình phải được giải quyết đúng cách. Hãy xem select()Transitions.

  4. Nếu bản dựng của bạn kết hợp các ngôn ngữ có hỗ trợ và không hỗ trợ nền tảng, thì bạn có thể cần ánh xạ nền tảng để giúp các ngôn ngữ cũ hoạt động với API mới. Xem bài viết Ánh xạ nền tảng để biết thông tin chi tiết.

Nếu bạn vẫn gặp vấn đề, hãy liên hệ với nhóm hỗ trợ.

Nền tảng mặc định

Chủ sở hữu dự án nên xác định các nền tảng tường minh để mô tả kiến trúc mà họ muốn xây dựng. Sau đó, các hành động này sẽ được kích hoạt bằng --platforms.

Khi bạn không thiết lập --platforms, Bazel sẽ mặc định dùng một platform đại diện cho máy xây dựng cục bộ. Mã này được tạo tự động tại @local_config_platform//:host nên bạn không cần phải xác định rõ ràng. Thao tác này liên kết OSCPU của máy cục bộ với các constraint_value được khai báo trong @platforms.

select()

Các dự án có thể select() trên constraint_value mục tiêu nhưng không thể hoàn tất các nền tảng. Đây là ý định của select() để hỗ trợ nhiều máy nhất có thể. Thư viện có các nguồn dành riêng cho ARM phải hỗ trợ tất cả các máy hỗ trợ ARM, trừ phi có lý do cụ thể hơn.

Để chọn một hoặc nhiều constraint_value, hãy sử dụng:

config_setting(
    name = "is_arm",
    constraint_values = [
        "@platforms//cpu:arm",
    ],
)

Điều này tương đương với việc chọn theo cách truyền thống trên --cpu:

config_setting(
    name = "is_arm",
    values = {
        "cpu": "arm",
    },
)

Bạn có thể xem thêm thông tin tại đây.

select trên --cpu, --crosstool_top, v.v. không hiểu --platforms. Khi di chuyển dự án sang nền tảng, bạn phải chuyển đổi các loại đó thành constraint_values hoặc sử dụng tính năng liên kết nền tảng để hỗ trợ cả hai kiểu trong quá trình di chuyển.

Kiểu chuyển cảnh

Hiệu ứng chuyển đổi Starlark sẽ thay đổi cờ ở các phần trên biểu đồ bản dựng. Nếu dự án của bạn sử dụng hiệu ứng chuyển đổi đặt --cpu, --crossstool_top hoặc cờ cũ khác, thì các quy tắc đọc --platforms sẽ không thấy những thay đổi này.

Khi di chuyển dự án sang nền tảng, bạn phải chuyển đổi các thay đổi như return { "//command_line_option:cpu": "arm" } thành return { "//command_line_option:platforms": "//:my_arm_platform" } hoặc sử dụng mối liên kết nền tảng để hỗ trợ cả hai kiểu trong quá trình di chuyển cửa sổ.

Di chuyển bộ quy tắc của bạn

Nếu sở hữu một bộ quy tắc và muốn hỗ trợ các nền tảng, bạn cần phải:

  1. Để logic quy tắc phân giải chuỗi công cụ bằng API chuỗi công cụ. Hãy xem API chuỗi công cụ (ctx.toolchains).

  2. Không bắt buộc: xác định một cờ --incompatible_enable_platforms_for_my_language để logic quy tắc luân phiên phân giải các chuỗi công cụ thông qua API mới hoặc các cờ cũ như --crosstool_top trong quá trình kiểm thử quá trình di chuyển.

  3. Xác định các thuộc tính có liên quan tạo nên thành phần của nền tảng. Xem phần Các thuộc tính phổ biến của nền tảng

  4. Xác định chuỗi công cụ tiêu chuẩn và giúp người dùng truy cập vào các chuỗi công cụ đó thông qua hướng dẫn đăng ký của quy tắc (thông tin chi tiết)

  5. Đảm bảo các nền tảng hỗ trợ select()chuyển đổi cấu hình. Đây là thách thức lớn nhất. Việc này đặc biệt khó khăn đối với các dự án đa ngôn ngữ (có thể không thành công nếu mọi ngôn ngữ đều không đọc được --platforms).

Nếu cần kết hợp với các quy tắc không hỗ trợ nền tảng, bạn có thể cần mối liên kết nền tảng để thu hẹp khoảng cách.

Các thuộc tính phổ biến của nền tảng

Bạn nên khai báo các thuộc tính nền tảng phổ biến, nhiều ngôn ngữ như OSCPU trong @platforms. Điều này khuyến khích việc chia sẻ, tiêu chuẩn hoá và tương thích với nhiều ngôn ngữ.

Bạn phải khai báo các thuộc tính dành riêng cho quy tắc của mình trong kho lưu trữ của quy tắc. Điều này cho phép bạn duy trì quyền sở hữu rõ ràng đối với các khái niệm cụ thể mà quy tắc của bạn chịu trách nhiệm.

Nếu các quy tắc của bạn sử dụng hệ điều hành hoặc CPU có mục đích tuỳ chỉnh, thì bạn phải khai báo những quy tắc này trong kho lưu trữ của quy tắc so với @platforms.

Liên kết nền tảng

Ánh xạ nền tảng là một API tạm thời cho phép kết hợp logic nhận biết nền tảng với logic cũ trong cùng một bản dựng. Đây là một công cụ cùn chỉ nhằm xử lý các trường hợp không tương thích với các khung thời gian di chuyển khác nhau.

Liên kết nền tảng là bản đồ ánh xạ platform() với một bộ cờ cũ tương ứng hoặc cờ ngược. Ví dụ:

platforms:
  # Maps "--platforms=//platforms:ios" to "--cpu=ios_x86_64 --apple_platform_type=ios".
  //platforms:ios
    --cpu=ios_x86_64
    --apple_platform_type=ios

flags:
  # Maps "--cpu=ios_x86_64 --apple_platform_type=ios" to "--platforms=//platforms:ios".
  --cpu=ios_x86_64
  --apple_platform_type=ios
    //platforms:ios

  # Maps "--cpu=darwin_x86_64 --apple_platform_type=macos" to "//platform:macos".
  --cpu=darwin_x86_64
  --apple_platform_type=macos
    //platforms:macos

Bazel sử dụng phương pháp này để đảm bảo tất cả các chế độ cài đặt, cả dựa trên nền tảng và cũ, đều được áp dụng nhất quán trong suốt quá trình xây dựng, kể cả khi chuyển đổi.

Theo mặc định, Bazel đọc các mối liên kết từ tệp platform_mappings trong thư mục gốc của không gian làm việc. Bạn cũng có thể thiết lập --platform_mappings=//:my_custom_mapping.

Xem thiết kế liên kết nền tảng để biết thông tin chi tiết.

Đánh giá API

platform là tập hợp các constraint_value mục tiêu:

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

constraint_value là một thuộc tính máy. Các giá trị thuộc cùng một "loại" được nhóm vào một constraint_setting chung:

constraint_setting(name = "os")
constraint_value(
    name = "linux",
    constraint_setting = ":os",
)
constraint_value(
    name = "mac",
    constraint_setting = ":os",
)

toolchain là một quy tắc Starlark. Các thuộc tính của lớp này khai báo các công cụ của ngôn ngữ (như compiler = "//mytoolchain:custom_gcc"). Nhà cung cấp của lớp này truyền thông tin này đến các quy tắc cần xây dựng bằng các công cụ này.

Chuỗi công cụ khai báo constraint_value máy mà chúng có thể nhắm mục tiêu (target_compatible_with = ["@platforms//os:linux"]) và các máy mà công cụ có thể chạy trên đó (exec_compatible_with = ["@platforms//os:mac"]).

Khi tạo $ bazel build //:myproject --platforms=//:myplatform, Bazel sẽ tự động chọn một chuỗi công cụ có thể chạy trên máy tạo và tạo tệp nhị phân cho //:myplatform. Đây gọi là quá trình giải quyết bằng chuỗi công cụ.

Bạn có thể đăng ký tập hợp các chuỗi công cụ có sẵn trong WORKSPACE bằng register_toolchains hoặc tại dòng lệnh bằng --extra_toolchains.

Để biết thêm thông tin, hãy xem tại đây.

Câu hỏi

Nếu cần được hỗ trợ chung và có câu hỏi về tiến trình di chuyển, hãy liên hệ với bazel-discuss hoặc chủ sở hữu của các quy tắc thích hợp.

Để thảo luận về thiết kế và quá trình phát triển của các API nền tảng/chuỗi công cụ, hãy liên hệ với bazel-dev.

Xem thêm