Cấu hình chuỗi công cụ C++

Tổng quan

Để gọi trình biên dịch bằng các tuỳ chọn phù hợp, Bazel cần biết một số kiến thức về bên trong trình biên dịch, chẳng hạn như thêm các thư mục và cờ quan trọng. Nói cách khác, Bazel cần một mô hình trình biên dịch được đơn giản hoá để hiểu hoạt động của trình biên dịch này.

Bazel cần biết những thông tin sau:

• Liệu trình biên dịch có hỗ trợ thinLTO, mô-đun, liên kết động hay PIC (mã độc lập với vị trí) hay không.
• Đường dẫn đến các công cụ bắt buộc, chẳng hạn như gcc, ld, ar, objcopy, v.v.
• Hệ thống tích hợp bao gồm các thư mục. Bazel cần những thông tin này để xác thực rằng tất cả tiêu đề có trong tệp nguồn đã được khai báo đúng cách trong tệp BUILD.
• sysroot mặc định.
• Cờ nào cần sử dụng để biên dịch, liên kết, lưu trữ.
• Cờ nào cần sử dụng cho các chế độ biên dịch được hỗ trợ (opt, dbg, nhanh).
• Tạo các biến mà trình biên dịch yêu cầu cụ thể.

Nếu trình biên dịch hỗ trợ nhiều cấu trúc, thì Bazel cần định cấu hình các cấu trúc đó riêng biệt.

CcToolchainConfigInfo là một trình cung cấp cung cấp mức độ chi tiết cần thiết để định cấu hình hành vi của các quy tắc C++ của Bazel. Theo mặc định, Bazel sẽ tự động định cấu hình CcToolchainConfigInfo cho bản dựng, nhưng bạn có thể định cấu hình theo cách thủ công. Để làm được điều đó, bạn cần có một quy tắc Starlark cung cấp CcToolchainConfigInfo và bạn cần trỏ thuộc tính toolchain_config của cc_toolchain đến quy tắc của mình. Bạn có thể tạo CcToolchainConfigInfo bằng cách gọi cc_common.create_cc_toolchain_config_info(). Bạn có thể tìm thấy các hàm khởi tạo Starlark cho tất cả cấu trúc mà bạn cần trong quy trình này trong @rules_cc//cc:cc_toolchain_config_lib.bzl.

Khi một mục tiêu C++ chuyển sang giai đoạn phân tích, Bazel sẽ chọn mục tiêu cc_toolchain thích hợp dựa trên tệp BUILD và lấy trình cung cấp CcToolchainConfigInfo từ mục tiêu được chỉ định trong thuộc tính cc_toolchain.toolchain_config. Mục tiêu cc_toolchain truyền thông tin này đến mục tiêu C++ thông qua CcToolchainProvider.

Ví dụ: hành động biên dịch hoặc liên kết (được tạo thực thể bằng một quy tắc như cc_binary hoặc cc_library) cần các thông tin sau:

• Trình biên dịch hoặc trình liên kết cần sử dụng
• Cờ dòng lệnh cho trình biên dịch/trình liên kết
• Cờ cấu hình được truyền qua các tuỳ chọn --copt/--linkopt
• Biến môi trường
• Các cấu phần phần mềm cần thiết trong hộp cát nơi thực thi hành động

Tất cả thông tin ở trên ngoại trừ các cấu phần phần mềm bắt buộc trong hộp cát được chỉ định trong mục tiêu Starlark mà cc_toolchain trỏ đến.

Các cấu phần phần mềm sẽ được gửi đến hộp cát được khai báo trong mục tiêu cc_toolchain. Ví dụ: với thuộc tính cc_toolchain.linker_files, bạn có thể chỉ định tệp nhị phân trình liên kết và thư viện chuỗi công cụ để gửi vào hộp cát.

Lựa chọn chuỗi công cụ

Logic lựa chọn chuỗi công cụ hoạt động như sau:

1. Người dùng chỉ định một mục tiêu cc_toolchain_suite trong tệp BUILD và trỏ Bazel đến mục tiêu đó bằng cách sử dụng tuỳ chọn --crosstool_top.

2. Mục tiêu cc_toolchain_suite tham chiếu đến nhiều chuỗi công cụ. Giá trị của cờ --cpu và --compiler xác định chuỗi công cụ nào trong số đó được chọn, chỉ dựa trên giá trị cờ --cpu hoặc dựa trên giá trị --cpu | --compiler chung. Quá trình lựa chọn diễn ra như sau:

   • Nếu bạn chỉ định tuỳ chọn --compiler, Bazel sẽ chọn mục nhập tương ứng từ thuộc tính cc_toolchain_suite.toolchains bằng --cpu | --compiler. Nếu không tìm thấy mục nhập tương ứng, Bazel sẽ gửi một lỗi.

   • Nếu không chỉ định tuỳ chọn --compiler, Bazel sẽ chọn mục nhập tương ứng từ thuộc tính cc_toolchain_suite.toolchains chỉ có --cpu.

   • Nếu không có cờ nào được chỉ định, Bazel sẽ kiểm tra hệ thống lưu trữ và chọn một giá trị --cpu dựa trên kết quả phát hiện được. Xem mã cơ chế kiểm tra.

Sau khi bạn chọn một chuỗi công cụ, các đối tượng feature và action_config tương ứng trong quy tắc Starlark sẽ chi phối cấu hình của bản dựng (tức là các mục được mô tả sau). Những thông báo này cho phép triển khai các tính năng C++ hoàn chỉnh trong Bazel mà không cần sửa đổi tệp nhị phân Bazel. Các quy tắc C++ hỗ trợ nhiều hành động riêng biệt được ghi lại chi tiết trong mã nguồn Bazel.

Tính năng

Tính năng là một thực thể yêu cầu cờ dòng lệnh, hành động, điều kiện ràng buộc đối với môi trường thực thi hoặc thay đổi phần phụ thuộc. Một tính năng có thể đơn giản như cho phép tệp BUILD chọn cấu hình của cờ, chẳng hạn như treat_warnings_as_errors, hoặc tương tác với các quy tắc C++ và bao gồm các thao tác biên dịch mới và dữ liệu đầu vào cho quá trình biên dịch, chẳng hạn như header_modules hoặc thin_lto.

Lý tưởng nhất là CcToolchainConfigInfo chứa danh sách các tính năng, trong đó mỗi tính năng bao gồm một hoặc nhiều nhóm cờ, mỗi nhóm xác định một danh sách cờ áp dụng cho các hành động cụ thể của Bazel.

Một tính năng được chỉ định theo tên, cho phép tách hoàn toàn cấu hình quy tắc Starlark khỏi các bản phát hành Bazel. Nói cách khác, bản phát hành Bazel không ảnh hưởng đến hành vi của cấu hình CcToolchainConfigInfo, miễn là các cấu hình đó không yêu cầu sử dụng các tính năng mới.

Bạn có thể bật một tính năng theo một trong những cách sau:

• Trường enabled của tính năng được đặt thành true.
• Bazel hoặc chủ sở hữu quy tắc bật tính năng này một cách rõ ràng.
• Người dùng bật tính năng này thông qua tuỳ chọn Bazel --feature hoặc thuộc tính quy tắc features.

Các tính năng có thể có mối quan hệ phụ thuộc lẫn nhau, phụ thuộc vào cờ dòng lệnh, chế độ cài đặt tệp BUILD và các biến khác.

Mối quan hệ giữa tính năng

Các phần phụ thuộc thường được quản lý trực tiếp bằng Bazel. Công cụ này chỉ thực thi các yêu cầu và quản lý các xung đột nội tại với bản chất của các tính năng được xác định trong bản dựng. Thông số kỹ thuật của chuỗi công cụ cho phép các quy tắc ràng buộc chi tiết hơn để sử dụng trực tiếp trong quy tắc Starlark quản lý việc hỗ trợ và mở rộng tính năng. Đó là:

requires = [
   feature_set (features = [
       'feature-name-1',
       'feature-name-2'
   ]),
]

implies = ['feature']

provides = ['feature']

with_features = [
  with_feature_set(
    features = ['feature-1'],
    not_features = ['feature-2'],
  ),
]

Thao tác

Hành động giúp bạn linh hoạt sửa đổi các trường hợp mà một hành động thực thi mà không cần giả định cách hành động đó sẽ chạy. action_config chỉ định tệp nhị phân công cụ mà một thao tác gọi, trong khi feature chỉ định cấu hình (cờ) xác định cách công cụ đó hoạt động khi thao tác được gọi.

Tính năng tham chiếu các hành động để báo hiệu những hành động Bazel mà chúng ảnh hưởng đến vì các hành động có thể sửa đổi biểu đồ hành động Bazel. Trình cung cấp CcToolchainConfigInfo chứa các thao tác có cờ và công cụ liên kết với chúng, chẳng hạn như c++-compile. Cờ được chỉ định cho từng hành động bằng cách liên kết các hành động đó với một tính năng.

Mỗi tên hành động đại diện cho một loại hành động do Bazel thực hiện, chẳng hạn như biên dịch hoặc liên kết. Tuy nhiên, có mối quan hệ nhiều với một giữa các hành động và loại hành động Bazel, trong đó loại hành động Bazel đề cập đến một lớp Java triển khai một hành động (chẳng hạn như CppCompileAction). Cụ thể, "các hành động của trình tập hợp" và "các hành động của trình biên dịch" trong bảng dưới đây là CppCompileAction, còn các hành động liên kết là CppLinkAction.

Thao tác với trình tập hợp

Thao tác của trình biên dịch

Thao tác với đường liên kết

Hành động AR

Các hành động thực tế tăng cường (AR) sẽ tập hợp các tệp đối tượng thành các thư viện lưu trữ (tệp .a) thông qua ar và mã hoá một số ngữ nghĩa vào tên.

Thao tác của LTO

Sử dụng action_config

action_config là một cấu trúc Starlark mô tả một thao tác Bazel bằng cách chỉ định công cụ (tệp nhị phân) để gọi trong thao tác và các tập hợp cờ do các tính năng xác định. Các cờ này áp dụng các quy tắc ràng buộc cho quá trình thực thi của hành động.

Hàm khởi tạo action_config() có các tham số sau:

action_config có thể yêu cầu và ngụ ý các tính năng và action_config khác theo mối quan hệ giữa các tính năng được mô tả trước đó. Hành vi này tương tự như hành vi của một tính năng.

Hai thuộc tính cuối cùng là dư thừa so với các thuộc tính tương ứng trên các tính năng và được đưa vào vì một số thao tác Bazel yêu cầu một số cờ hoặc biến môi trường nhất định và mục tiêu là để tránh các cặp action_config+feature không cần thiết. Thông thường, bạn nên chia sẻ một tính năng trên nhiều action_config.

Bạn không thể xác định nhiều action_config có cùng action_name trong cùng một chuỗi công cụ. Điều này giúp tránh sự mơ hồ trong đường dẫn công cụ và thực thi ý định đằng sau action_config – rằng các thuộc tính của một hành động được mô tả rõ ràng ở một nơi duy nhất trong chuỗi công cụ.

Sử dụng hàm khởi tạo công cụ

action_config có thể chỉ định một bộ công cụ thông qua tham số tools. Hàm khởi tạo tool() nhận các tham số sau:

Đối với một action_config nhất định, chỉ một tool áp dụng đường dẫn công cụ và yêu cầu thực thi cho thao tác Bazel. Một công cụ được chọn bằng cách lặp lại thuộc tính tools trên action_config cho đến khi tìm thấy một công cụ có tập hợp with_feature khớp với cấu hình tính năng (xem phần Mối quan hệ giữa các tính năng ở trên trang này để biết thêm thông tin). Bạn nên kết thúc danh sách công cụ bằng một công cụ mặc định tương ứng với cấu hình tính năng trống.

Ví dụ về cách sử dụng

Bạn có thể sử dụng cùng lúc các tính năng và thao tác để triển khai các thao tác Bazel với ngữ nghĩa đa dạng trên nhiều nền tảng. Ví dụ: việc tạo biểu tượng gỡ lỗi trên macOS yêu cầu tạo biểu tượng trong thao tác biên dịch, sau đó gọi một công cụ chuyên biệt trong thao tác liên kết để tạo tệp lưu trữ dsym nén, sau đó giải nén tệp lưu trữ đó để tạo gói ứng dụng và tệp .plist mà Xcode có thể sử dụng.

Với Bazel, bạn có thể triển khai quy trình này như sau, trong đó unbundle-debuginfo là một hành động Bazel:

load("@rules_cc//cc:defs.bzl", "ACTION_NAMES")

action_configs = [
    action_config (
        action_name = ACTION_NAMES.cpp_link_executable,
        tools = [
            tool(
                with_features = [
                    with_feature(features=["generate-debug-symbols"]),
                ],
                path = "toolchain/mac/ld-with-dsym-packaging",
            ),
            tool (path = "toolchain/mac/ld"),
        ],
    ),
]

features = [
    feature(
        name = "generate-debug-symbols",
        flag_sets = [
            flag_set (
                actions = [
                    ACTION_NAMES.c_compile,
                    ACTION_NAMES.cpp_compile
                ],
                flag_groups = [
                    flag_group(
                        flags = ["-g"],
                    ),
                ],
            )
        ],
        implies = ["unbundle-debuginfo"],
   ),
]

Bạn có thể triển khai tính năng này theo cách hoàn toàn khác nhau cho Linux (sử dụng fission) hoặc cho Windows (tạo tệp .pdb). Ví dụ: quá trình triển khai để tạo biểu tượng gỡ lỗi dựa trên fission có thể có dạng như sau:

load("@rules_cc//cc:defs.bzl", "ACTION_NAMES")

action_configs = [
    action_config (
        name = ACTION_NAMES.cpp_compile,
        tools = [
            tool(
                path = "toolchain/bin/gcc",
            ),
        ],
    ),
]

features = [
    feature (
        name = "generate-debug-symbols",
        requires = [with_feature_set(features = ["dbg"])],
        flag_sets = [
            flag_set(
                actions = [ACTION_NAMES.cpp_compile],
                flag_groups = [
                    flag_group(
                        flags = ["-gsplit-dwarf"],
                    ),
                ],
            ),
            flag_set(
                actions = [ACTION_NAMES.cpp_link_executable],
                flag_groups = [
                    flag_group(
                        flags = ["-Wl", "--gdb-index"],
                    ),
                ],
            ),
      ],
    ),
]

Nhóm cờ

CcToolchainConfigInfo cho phép bạn gói các cờ thành các nhóm phục vụ một mục đích cụ thể. Bạn có thể chỉ định một cờ trong đó bằng cách sử dụng các biến được xác định trước trong giá trị cờ mà trình biên dịch sẽ mở rộng khi thêm cờ vào lệnh bản dựng. Ví dụ:

flag_group (
    flags = ["%{output_execpath}"],
)

Trong trường hợp này, nội dung của cờ sẽ được thay thế bằng đường dẫn tệp đầu ra của thao tác.

Các nhóm cờ được mở rộng thành lệnh bản dựng theo thứ tự xuất hiện trong danh sách, từ trên xuống dưới, từ trái sang phải.

Đối với các cờ cần lặp lại với các giá trị khác nhau khi được thêm vào lệnh tạo, nhóm cờ có thể lặp lại các biến thuộc loại list. Ví dụ: biến include_path thuộc loại list:

flag_group (
    iterate_over = "include_paths",
    flags = ["-I%{include_paths}"],
)

sẽ mở rộng thành -I<path> cho từng phần tử đường dẫn trong danh sách include_paths. Tất cả cờ (hoặc flag_group) trong phần nội dung khai báo nhóm cờ đều được mở rộng dưới dạng một đơn vị. Ví dụ:

flag_group (
    iterate_over = "include_paths",
    flags = ["-I", "%{include_paths}"],
)

mở rộng thành -I <path> cho mỗi phần tử đường dẫn trong danh sách include_paths.

Một biến có thể lặp lại nhiều lần. Ví dụ:

flag_group (
    iterate_over = "include_paths",
    flags = ["-iprefix=%{include_paths}", "-isystem=%{include_paths}"],
)

mở rộng thành:

-iprefix=<inc0> -isystem=<inc0> -iprefix=<inc1> -isystem=<inc1>

Biến có thể tương ứng với các cấu trúc có thể truy cập bằng ký hiệu dấu chấm. Ví dụ:

flag_group (
    flags = ["-l%{libraries_to_link.name}"],
)

Các cấu trúc có thể được lồng và cũng có thể chứa các trình tự. Để tránh trường hợp xung đột tên và thể hiện rõ ràng, bạn phải chỉ định đường dẫn đầy đủ thông qua các trường. Ví dụ:

flag_group (
    iterate_over = "libraries_to_link",
    flag_groups = [
        flag_group (
            iterate_over = "libraries_to_link.shared_libraries",
            flags = ["-l%{libraries_to_link.shared_libraries.name}"],
        ),
    ],
)

Mở rộng có điều kiện

Nhóm cờ hỗ trợ mở rộng có điều kiện dựa trên sự hiện diện của một biến cụ thể hoặc trường của biến đó bằng cách sử dụng các thuộc tính expand_if_available, expand_if_not_available, expand_if_true, expand_if_false hoặc expand_if_equal. Ví dụ:

flag_group (
    iterate_over = "libraries_to_link",
    flag_groups = [
        flag_group (
            iterate_over = "libraries_to_link.shared_libraries",
            flag_groups = [
                flag_group (
                    expand_if_available = "libraries_to_link.shared_libraries.is_whole_archive",
                    flags = ["--whole_archive"],
                ),
                flag_group (
                    flags = ["-l%{libraries_to_link.shared_libraries.name}"],
                ),
                flag_group (
                    expand_if_available = "libraries_to_link.shared_libraries.is_whole_archive",
                    flags = ["--no_whole_archive"],
                ),
            ],
        ),
    ],
)

Tài liệu tham khảo CcToolchainConfigInfo

Phần này cung cấp thông tin tham khảo về các biến bản dựng, tính năng và thông tin khác cần thiết để định cấu hình thành công các quy tắc C++.

Biến bản dựng CcToolchainConfigInfo

Sau đây là thông tin tham khảo về các biến bản dựng CcToolchainConfigInfo.

Các tính năng nổi tiếng

Sau đây là nội dung tham khảo về các tính năng và điều kiện kích hoạt các tính năng đó.

Logic vá tính năng cũ

Bazel áp dụng các thay đổi sau đây cho các tính năng của chuỗi công cụ để có khả năng tương thích ngược:

• Di chuyển tính năng legacy_compile_flags lên đầu chuỗi công cụ
• Di chuyển tính năng default_compile_flags lên đầu chuỗi công cụ
• Thêm tính năng dependency_file (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng pic (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng per_object_debug_info (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng preprocessor_defines (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng includes (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng include_paths (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng fdo_instrument (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng fdo_optimize (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng cs_fdo_instrument (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng cs_fdo_optimize (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng fdo_prefetch_hints (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng autofdo (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng build_interface_libraries (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng dynamic_library_linker_tool (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng shared_flag (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng linkstamps (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng output_execpath_flags (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng runtime_library_search_directories (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng library_search_directories (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng archiver_flags (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng libraries_to_link (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng force_pic_flags (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng user_link_flags (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng legacy_link_flags (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng static_libgcc (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng fission_support (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng strip_debug_symbols (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng coverage (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng llvm_coverage_map_format (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng gcc_coverage_map_format (nếu không có) vào đầu chuỗi công cụ
• Thêm tính năng fully_static_link (nếu không có) vào cuối chuỗi công cụ
• Thêm tính năng user_compile_flags (nếu không có) vào cuối chuỗi công cụ
• Thêm tính năng sysroot (nếu không có) vào cuối chuỗi công cụ
• Thêm tính năng unfiltered_compile_flags (nếu không có) vào cuối chuỗi công cụ
• Thêm tính năng linker_param_file (nếu không có) vào cuối chuỗi công cụ
• Thêm tính năng compiler_input_flags (nếu không có) vào cuối chuỗi công cụ
• Thêm tính năng compiler_output_flags (nếu không có) vào cuối chuỗi công cụ

Đây là một danh sách dài gồm nhiều tính năng. Kế hoạch là loại bỏ chúng sau khi Crosstool trong Starlark hoàn tất. Đối với những độc giả tò mò, hãy xem cách triển khai trong CppActionConfigs và đối với các chuỗi công cụ phát hành công khai, hãy cân nhắc thêm no_legacy_features để chuỗi công cụ trở nên độc lập hơn.