Xây dựng bằng nền tảng

Báo cáo vấn đề Xem nguồn Nightly · 8.0 . 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel có khả năng hỗ trợ phức tạp để lập mô hình nền tảng và chuỗi công cụ. Để tích hợp tính năng này với các dự án thực tế, bạn cần phải có sự phối hợp cẩn thận giữa chủ sở hữu mã, người duy trì quy tắc và các nhà phát triển Bazel cốt lõi.

Trang này tóm tắt mục đích của các nền tảng và cho biết cách xây dựng bằng các nền tảng đó.

tl;dr: Các API chuỗi công cụ và nền tảng của Bazel có sẵn nhưng sẽ không hoạt động ở mọi nơi cho đến khi tất cả các quy tắc ngôn ngữ, select() và các tệp tham chiếu cũ khác được cập nhật. Công việc này đang được tiến hành. Cuối cùng, tất cả các bản dựng sẽ dựa trên nền tảng. Hãy đọc phần bên dưới để xem bản dựng của bạn phù hợp với loại nào.

Để biết tài liệu chính thức hơn, hãy xem:

Thông tin khái quát

Nền tảng và chuỗi công cụ được giới thiệu để chuẩn hoá cách các dự án phần mềm nhắm đến nhiều loại máy và xây dựng bằng các công cụ ngôn ngữ phù hợp.

Đây là một tính năng tương đối mới trong Bazel. Ý tưởng này được lấy cảm hứng từ việc quan sát thấy các trình duy trì ngôn ngữ đã thực hiện việc này theo cách ad hoc, không tương thích. Ví dụ: các quy tắc C++ sử dụng --cpu và --crosstool_top để đặt CPU mục tiêu và chuỗi công cụ C++ của bản dựng. Cả hai mô hình này đều không mô hình hoá chính xác "nền tảng". Các nỗ lực trước đây để làm như vậy đã dẫn đến các bản dựng khó xử và không chính xác. Các cờ này cũng không kiểm soát quá trình biên dịch Java, quá trình này đã phát triển giao diện độc lập riêng với --java_toolchain.

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ợ nguyên tắc hơn cho các khái niệm này, bao gồm cả các API rõ ràng khuyến khích khả năng tương tác giữa ngôn ngữ và dự án. Đây là mục đích của các API mới này.

Di chuyển

API nền tảng và chuỗi công cụ chỉ hoạt động khi các dự án thực sự sử dụng chúng. Điều này không hề đơn giản vì logic quy tắc, chuỗi công cụ, phần phụ thuộc và select() của dự án phải hỗ trợ các lớp này. Điều này đòi hỏi một trình tự di chuyển cẩn thận để đảm bảo tất cả dự án và phần phụ thuộc của dự án hoạt động đúng cách.

Ví dụ: Quy tắc C++ của Bazel hỗ trợ các nền tảng. Nhưng Quy tắc của Apple thì không. Dự án C++ của bạn có thể không quan tâm đến Apple. Tuy nhiên, một số nền tảng khác có thể. Vì vậy, bạn chưa thể bật nền tảng trên toàn cầu cho tất cả các bản dựng C++.

Phần còn lại của trang này mô tả trình tự di chuyển này cũng như cách thức và thời điểm dự án của bạn có thể phù hợp.

Mục tiêu

Quá trình di chuyển nền tảng của Bazel hoàn tất khi tất cả dự án tạo bản dựng 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 mà dự án của bạn sử dụng có thể suy luận chuỗi công cụ chính xác từ //:myplatform.
  2. Các quy tắc mà phần phụ thuộc của dự án sử dụng có thể suy ra chuỗi công cụ chính xác từ //:myplatform.
  3. Hoặc các dự án phụ thuộc vào dự án của bạn hỗ trợ //:myplatform hoặc dự án của bạn hỗ trợ các API cũ (như --crosstool_top).
  4. //:myplatform tham chiếu đến [các nội dung khai báo chung][Common Platform Declaration]{: .external} của CPU, OS và các khái niệm chung khác hỗ trợ khả năng tương thích tự động giữa các dự án.
  5. Tất cả select() của dự án liên quan đều hiểu được các thuộc tính máy mà //:myplatform ngụ ý.
  6. //:myplatform được xác định ở một vị trí rõ ràng, có thể sử dụng lại: 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, nếu không thì ở một nơi mà tất cả dự án có thể sử dụng nền tảng này đều có thể tìm thấy.

Các API cũ sẽ bị xoá ngay khi đạt được mục tiêu này. Sau đó, đây sẽ là cách tiêu chuẩn để các dự án chọn nền tảng và chuỗi công cụ.

Tôi có nên sử dụng nền tảng không?

Nếu chỉ muốn tạo hoặc biên dịch chéo một dự án, bạn nên làm theo tài liệu chính thức của dự án.

Nếu là người duy trì dự án, ngôn ngữ hoặc chuỗi công cụ, cuối cùng bạn sẽ muốn hỗ trợ các API mới. Việc bạn chờ cho đến khi quá trình di chuyển toàn cầu hoàn tất hay chọn sử dụng sớm tuỳ thuộc vào nhu cầu cụ thể về giá trị / chi phí:

Giá trị

  • Bạn có thể select() hoặc chọn chuỗi công cụ trên các thuộc tính chính xác mà bạn quan tâm thay vì cờ được mã hoá cứng như --cpu. Ví dụ: nhiều CPU có thể hỗ trợ cùng một tập lệnh.
  • Các bản dựng chính xác hơn. Nếu bạn select() với --cpu trong ví dụ trên, sau đó thêm một CPU mới hỗ trợ cùng một tập lệnh, thì select() sẽ không nhận ra CPU mới. Tuy nhiên, select() trên các nền tảng vẫn chính xác.
  • Trải nghiệm người dùng đơn giản hơn. Tất cả dự án đều hiểu: --platforms=//:myplatform. Không cần nhiều cờ dành riêng cho ngôn ngữ trên dòng lệnh.
  • Thiết kế ngôn ngữ đơn giản hơn. Tất cả ngôn ngữ đều dùng chung một API để xác định chuỗi công cụ, sử dụng chuỗi công cụ và chọn chuỗi công cụ phù hợp cho một nền tảng.
  • Bạn có thể bỏ qua các mục tiêu trong giai đoạn tạo bản dựng và kiểm thử nếu các mục tiêu đó không tương thích với nền tảng mục tiêu.

Chi phí

  • Các dự án phụ thuộc chưa hỗ trợ nền tảng có thể không tự động hoạt động với nền tảng của bạn.
  • Để các tính năng này hoạt động, bạn có thể phải bảo trì tạm thời thêm.
  • Việc cùng tồn tại của API mới và API cũ đòi hỏi hướng dẫn người dùng cẩn thận hơn để tránh nhầm lẫn.
  • Định nghĩa chuẩn cho các thuộc tính phổ biến như OS và CPU vẫn đang phát triển và có thể cần thêm các nội dung đóng góp ban đầu.
  • Các định nghĩa chuẩn cho chuỗi công cụ dành riêng cho ngôn ngữ vẫn đang phát triển và có thể yêu cầu thêm các đóng góp ban đầu.

Xem xét API

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

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 lại trong 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ữ (chẳng hạn 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 tạo bằng các công cụ này.

Chuỗi công cụ khai báo constraint_value của các máy mà chúng có thể nhắm đến (target_compatible_with = ["@platforms//os:linux"]) và các máy mà công cụ của chúng 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 bản dựng và tạo tệp nhị phân cho //:myplatform. Đây được gọi là độ phân giải 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.

Hãy xem tại đây để tìm hiểu kỹ hơn.

Trạng thái

Mức độ hỗ trợ nền tảng hiện tại còn tuỳ theo ngôn ngữ. Tất cả các quy tắc chính của Bazel đều đang chuyển sang các nền tảng. Tuy nhiên, quá trình này sẽ mất chút thời gian. Có ba lý do chính dẫn đến việc này:

  1. Bạn phải cập nhật logic quy tắc để lấy thông tin công cụ từ API chuỗi công cụ mới (ctx.toolchains) và ngừng đọc các chế độ cài đặt cũ như --cpu và --crosstool_top. Việc này tương đối đơn giản.

  2. Người duy trì chuỗi công cụ phải xác định chuỗi công cụ và cho phép người dùng truy cập vào chuỗi công cụ đó (trong kho lưu trữ GitHub và mục nhập WORKSPACE). Về mặt kỹ thuật, việc này khá đơn giản nhưng phải được sắp xếp một cách thông minh để duy trì trải nghiệm dễ dàng cho người dùng.

    Bạn cũng cần có định nghĩa nền tảng (trừ phi bạn tạo bản dựng cho cùng một máy mà Bazel chạy trên đó). Nhìn chung, các dự án phải xác định nền tảng của riêng mình.

  3. Bạn phải di chuyển các dự án hiện có. select() và hoạt động chuyển đổi cũng phải được di chuyển. Đây là thách thức lớn nhất. Điều 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 tất cả ngôn ngữ không thể đọc --platforms).

Nếu đang thiết kế một bộ quy tắc mới, bạn phải hỗ trợ các nền tảng ngay từ đầu. Điều này tự động giúp các quy tắc của bạn tương thích với các quy tắc và dự án khác, với giá trị ngày càng tăng khi API nền tảng trở nên phổ biến hơn.

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

Các thuộc tính nền tảng như OS và CPU phổ biến trên các dự án phải được khai báo ở một nơi tập trung, tiêu chuẩn. Điều này khuyến khích khả năng tương thích giữa các dự án và giữa các ngôn ngữ.

Ví dụ: nếu MyApp có select() trên constraint_value @myapp//cpus:arm và SomeCommonLib có select() trên @commonlib//constraints:arm, thì các chế độ "arm" này sẽ kích hoạt bằng các tiêu chí không tương thích.

Các thuộc tính phổ biến trên toàn cầu được khai báo trong kho lưu trữ @platforms (vì vậy, nhãn chuẩn cho ví dụ trên là @platforms//cpu:arm). Các thuộc tính phổ biến theo ngôn ngữ phải được khai báo trong kho lưu trữ của ngôn ngữ tương ứng.

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

Nhìn chung, chủ sở hữu dự án nên xác định rõ nền tảng để mô tả loại máy mà họ muốn xây dựng. Sau đó, các sự kiện này được kích hoạt bằng --platforms.

Khi bạn không đặt --platforms, Bazel sẽ mặc định là platform đại diện cho máy tạo bản 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 xác định rõ ràng. Phương thức này liên kết OS và CPU của máy cục bộ với constraint_value được khai báo trong @platforms.

C++

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

Đ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ì cách cũ:

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

Nếu dự án của bạn chỉ sử dụng C++ thuần tuý và không phụ thuộc vào các dự án không phải C++, thì bạn có thể sử dụng các nền tảng một cách an toàn miễn là select và các lượt chuyển đổi tương thích. Hãy xem #7260 và Định cấu hình chuỗi công cụ C++ để biết thêm hướng dẫn.

Chế độ này không được bật theo mặc định. Điều này là do các dự án của Apple vẫn định cấu hình các phần phụ thuộc C++ bằng --cpu và --crosstool_top (ví dụ). Vì vậy, điều này phụ thuộc vào việc các quy tắc của Apple có di chuyển sang các nền tảng hay không.

Java

Các quy tắc Java của Bazel sử dụng nền tảng.

Phương thức này sẽ thay thế các cờ cũ --java_toolchain, --host_java_toolchain, --javabase và --host_javabase.

Để tìm hiểu cách sử dụng cờ cấu hình, hãy xem hướng dẫn về Bazel và Java. Để biết thêm thông tin, hãy xem Tài liệu thiết kế.

Nếu bạn vẫn đang sử dụng cờ cũ, hãy làm theo quy trình di chuyển trong Vấn đề #7849.

Android

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

Tính năng này không được bật theo mặc định. Tuy nhiên, quá trình di chuyển đang diễn ra suôn sẻ.

Quả táo

Các quy tắc của Apple trong Bazel chưa hỗ trợ các nền tảng để chọn chuỗi công cụ của Apple.

Các lớp này cũng không hỗ trợ các phần phụ thuộc C++ được bật nền tảng vì các lớp này sử dụng --crosstool_top cũ để thiết lập chuỗi công cụ C++. Cho đến khi quá trình di chuyển này hoàn tất, bạn có thể kết hợp các dự án Apple với C++ hỗ trợ nền tảng bằng tính năng ánh xạ nền tảng (ví dụ).

Ngôn ngữ khác

Nếu bạn đang thiết kế quy tắc cho một ngôn ngữ mới, hãy sử dụng các nền tảng để chọn chuỗi công cụ của ngôn ngữ đó. Hãy xem tài liệu về chuỗi công cụ để biết hướng dẫn chi tiết.

select()

Dự án có thể select() trên các mục tiêu constraint_value nhưng không hoàn tất các nền tảng. Điều này là có chủ ý để select() hỗ trợ nhiều loại 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ả máy chạy ARM, trừ phi có lý do cụ thể hơn.

Để chọn trê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",
    },
)

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 các nền tảng, bạn phải chuyển đổi các dự án đó 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 thông qua cửa sổ di chuyển.

Kiểu chuyển cảnh

Các chuyển đổi Starlark thay đổi các cờ xuống các phần của biểu đồ bản dựng. Nếu dự án của bạn sử dụng một hiệu ứng chuyển đổi đặt --cpu, --crossstool_top hoặc cá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 các 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 tính năng ánh xạ nền tảng để hỗ trợ cả hai kiểu thông qua cửa sổ di chuyển.

Cách sử dụng các nền tảng hiện nay

Nếu chỉ muốn tạo hoặc biên dịch chéo một dự án, bạn nên làm theo tài liệu chính thức của dự án. Người duy trì dự án và ngôn ngữ sẽ quyết định cách thức và thời điểm tích hợp với các nền tảng, cũng như giá trị mà việc tích hợp đó mang lại.

Nếu là người duy trì dự án, ngôn ngữ hoặc chuỗi công cụ và bản dựng của bạn không sử dụng nền tảng theo mặc định, bạn có 3 lựa chọn (ngoài việc chờ quá trình di chuyển toàn cầu):

  1. Bật cờ "use platforms" (sử dụng nền tảng) cho các ngôn ngữ của dự án (nếu có) và thực hiện mọi hoạt động kiểm thử cần thiết để xem liệu các dự án bạn quan tâm có hoạt động hay không.

  2. Nếu các dự án mà bạn quan tâm vẫn phụ thuộc vào các cờ cũ như --cpu và --crosstool_top, hãy sử dụng các cờ này cùng với --platforms:

    bazel build //:my_mixed_project --platforms==//:myplatform --cpu=... --crosstool_top=...

    Việc này sẽ gây ra một số chi phí bảo trì (bạn phải đảm bảo chế độ cài đặt khớp với nhau theo cách thủ công). Tuy nhiên, cách này sẽ hoạt động nếu không có hiệu ứng chuyển đổi bất thường.

  3. Viết tính năng ánh xạ nền tảng để hỗ trợ cả hai kiểu bằng cách ánh xạ chế độ cài đặt kiểu --cpu đến các nền tảng tương ứng và ngược lại.

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

Mối liên kết nền tảng là một API tạm thời cho phép logic dựa trên nền tảng và logic dựa trên phiên bản cũ cùng tồn tại trong cùng một bản dựng thông qua cửa sổ ngừng sử dụng của logic dựa trên phiên bản cũ.

Ánh xạ nền tảng là bản đồ của platform() đến một nhóm cờ cũ tương ứng hoặc ngược lại. 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 --apple_platform_type=macos" to "//platform:macos".
  --cpu=darwin
  --apple_platform_type=macos
    //platforms:macos

Bazel sử dụng tính năng 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, bao gồm cả thông qua quá trình 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ể đặt --platform_mappings=//:my_custom_mapping.

Hãy xem tại đây để biết toàn bộ thông tin chi tiết.

Câu hỏi

Để được hỗ trợ chung và giải đáp thắc mắc về tiến trình di chuyển, hãy liên hệ với bazel-discuss@googlegroups.com 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@googlegroups.com.

Xem thêm