C++ 工具鍊設定

總覽

Bazel 為了使用正確的選項叫用編譯器，您必須對 例如包含目錄和重要標記 換句話說，Bazel 需要簡化過的編譯器模型，才能瞭解 正常運作。

Bazel 需要知道以下資訊：

• 是否支援精簡 LTO、模組、動態連結或 PIC (位置無關程式碼)。
• 必要工具的路徑，例如 gcc、ld、ar、objcopy 等等。
• 內建系統包含目錄。Bazel 需要這些資訊，才能驗證來源檔案中包含的所有標頭是否已在 BUILD 檔案中正確宣告。
• 預設的 sysroot。
• 要用於編譯、連結、封存的標記。
• 針對支援的編譯模式 (opt、dbg、fastbuild) 使用哪些標記。
• 建立編譯器特別需要的變數。

如果編譯器支援多種架構，Bazel 必須設定 所以需要分開管理

CcToolchainConfigInfo 是供應工具，可提供必要的細微程度，用於設定 Bazel 的 C++ 規則行為。根據預設 Bazel 會自動為您的建構作業設定 CcToolchainConfigInfo，不過您 可讓管理員手動設定這時你需要設定星星規則 可提供 CcToolchainConfigInfo，而您需要 應用程式的 toolchain_config 屬性 cc_toolchain。 您可以呼叫 cc_common.create_cc_toolchain_config_info() 建立 CcToolchainConfigInfo。您可以在 @rules_cc//cc:cc_toolchain_config_lib.bzl。

當 C++ 目標進入分析階段時，Bazel 會選擇適當的 根據 BUILD 檔案設定 cc_toolchain 目標，然後取得 「CcToolchainConfigInfo」供應商 cc_toolchain.toolchain_config 屬性。cc_toolchain 目標 透過 CcToolchainProvider 將這項資訊傳遞至 C++ 目標。

舉例來說，由 cc_binary 或 cc_library 等規則例項化的編譯或連結動作，需要以下資訊：

• 要使用的編譯器或連結器
• 編譯器/連結器的指令列標記
• 透過 --copt/--linkopt 選項傳遞的設定旗標
• 環境變數
• 在執行動作的沙箱中所需的構件

除了沙箱中所需的構件外，上述所有資訊都會在 cc_toolchain 指向的 Starlark 目標中指定。

cc_toolchain 目標會宣告要運送至沙箱的構件。舉例來說，有了 cc_toolchain.linker_files 屬性，您可以 指定要傳送至沙箱的連結器二進位檔和工具鍊程式庫。

工具鍊選項

工具鏈選擇邏輯的運作方式如下：

1. 使用者在 BUILD 檔案和點中指定 cc_toolchain_suite 目標 使用 Terraform 將 Bazel 傳送至目標 --crosstool_top 選項。

2. cc_toolchain_suite 目標參照多個工具鍊。 --cpu 和 --compiler 旗標的值會決定當中 僅根據 --cpu 旗標值選取工具鍊，或 依據彙整值 --cpu | --compiler 計算得出。遴選程序如下：

   • 如果指定 --compiler 選項，Bazel 會選取 來自 cc_toolchain_suite.toolchains 的對應項目 屬性值為 --cpu | --compiler。如果 Bazel 找不到對應的項目，就會擲回錯誤。

   • 如果未指定 --compiler 選項，Bazel 會使用 --cpu 從 cc_toolchain_suite.toolchains 屬性中選取對應的項目。

   • 如果未指定標記，Bazel 會檢查主機系統，並根據所找到的結果選取 --cpu 值。詳情請參閱 檢查機製程式碼

選取工具鏈後，Starlark 規則中的對應 feature 和 action_config 物件會控管建構設定 (即稍後說明的項目)。這些訊息可讓您在 Bazel 中實作完整的 C++ 功能，而無須修改 Bazel 二進位檔。C++ 規則支援多種專屬動作，詳細介紹如下 在 Bazel 原始碼中。

功能

功能是一種需要指令列標記、動作 對執行環境的限製或依附元件變更。功能可以很簡單，例如允許 BUILD 檔案選取標記的設定 (例如 treat_warnings_as_errors)，或與 C++ 規則互動，並在編譯時納入新的編譯動作和輸入內容，例如 header_modules 或 thin_lto。

理想情況下，CcToolchainConfigInfo 會包含一或多個功能清單，每個功能都包含一或多個標記群組，每個群組都會定義一或多個適用於特定 Bazel 動作的標記。

地圖項目需要依名稱指定，這可讓 Starlark 完全分離 規則設定換句話說，Bazel 版本不會 只要這些設定會影響 CcToolchainConfigInfo 設定的行為 您就不必使用新功能

功能會透過下列任一方式啟用：

• 功能的 enabled 欄位已設為 true。
• Bazel 或規則擁有者明確啟用該規則。
• 使用者可透過 --feature Bazel 選項或 features 規則屬性啟用此功能。

功能可能會相互依賴，並依賴指令列旗標、BUILD 檔案設定和其他變數。

特徵關係

依附元件通常是直接透過 Bazel 管理，後者會直接強制執行 處理及管理功能性質的衝突本體 工具鍊規格可以提供更精細的 控管功能在 Starlark 規則中直接使用的限制 。包括：

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'],
  ),
]

動作

動作可讓您彈性地修改動作執行的情況，而無須假設動作的執行方式。一個 action_config 會指定動作叫用的工具二進位檔，而 feature 會指定決定該工具方式的設定 (旗標)。 所發生的行為。

功能參照動作，指出哪些 Bazel 動作 因為動作可以修改 Bazel 動作圖表。 CcToolchainConfigInfo 供應商包含含有旗標和工具的動作 例如 c++-compile系統會針對每個動作指派旗標 將這些內容與地圖項目建立關聯

每個動作名稱都代表 Bazel 執行的單一類型動作，例如編譯或連結。不過，動作與 Bazel 動作類型之間存在多對一關係，其中 Bazel 動作類型是指實作動作的 Java 類別 (例如 CppCompileAction)。具體來說，下表中的「組譯器動作」和「編譯器動作」是 CppCompileAction，而連結動作則是 CppLinkAction。

組合動作

編譯器動作

連結動作

AR 動作

AR 動作會透過 ar 將物件檔案組合成封存資料庫 (.a 檔案)，並將部分語意編碼至名稱中。

LTO 動作

使用 action_config

action_config 是 Starlark 結構體，可透過指定在動作期間要叫用的工具 (二進位檔) 和由功能定義的標記集合，描述 Bazel 動作。這些旗標會將限制套用至動作的

action_config() 建構函式有以下參數：

action_config 可根據前述的特徵關係，要求及暗示其他特徵和 action_config。這項行為與功能的行為類似。

最後兩個屬性與功能的對應屬性重複，但我們仍將其納入，因為部分 Bazel 動作需要特定標記或環境變數，而我們的目標是避免不必要的 action_config+feature 組合。通常，建議在多個 action_config 之間共用單一功能。

使用同一個 action_name 可定義多個 action_config 在同一工具鍊中調整設定這可避免工具路徑發生模稜兩可的情況 並強制執行 action_config 背後的意圖，也就是動作的屬性 會在工具鍊的單一位置提供清楚的說明。

使用工具建構函式

action_config 可以透過 tools 參數指定一組工具。 tool() 建構函式會採用下列參數：

對於指定的 action_config，系統只會套用一個 tool 套用至 Bazel 動作的工具路徑和執行需求已選取工具 逐一檢查 action_config 的 tools 屬性，直到工具為止 找到符合功能設定的 with_feature 集 (請參閱本頁前面的「特徵關係」一節) 的說明)。請將工具清單結束使用預設值 對應至空白功能設定。

使用案例：

您可使用各項功能和動作來實作 Bazel 動作 很多元的跨平台語義例如，偵錯符號產生功能 macOS 必須在編譯動作中產生符號，然後叫用 這個特殊工具可用來建立壓縮的 Dsym 封存檔 然後解壓縮該封存來產生應用程式套件，並 .plist 則可透過 Xcode 消耗的檔案。

使用 Bazel 時，您可以按照下列方式實作這個程序， unbundle-debuginfo 是 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"],
   ),
]

這項功能可以完全以不同方式實作在 Linux 上，但前者使用 fission 或 Windows 則是會產生 .pdb 檔案。舉例來說， 如果是以 fission 為基礎的偵錯符號產生實作，看起來可能像 如下：

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

標記群組

CcToolchainConfigInfo 可讓您將標記綁定為用於特定用途的群組。您可以在預先定義的變數中指定標記 ，編譯器會在將標記新增到 建構指令例如：

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

在這種情況下，標記的內容會替換為動作的輸出檔案路徑。

標記群組會按照建構指令的順序展開至建構指令 在清單中，從上到下、由左到右

適用於新增至建構作業時，需要在不同值重複值的旗標 指令，標記群組可以疊代 list 類型的變數。舉例來說， list 類型的變數 include_path：

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

include_paths 清單中的每個路徑元素會展開為 -I<path>。所有語言 標記群組宣告主體中的標記 (或 flag_group) 會展開為 單位。例如：

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

會將 include_paths 清單中的每個路徑元素展開為 -I <path>。

變數可以重複多次。例如：

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

展開為：

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

變數可對應至可透過點號符號存取的結構體。例如：

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

結構體可嵌套，也可能包含序列。避免名稱衝突 且明確來說， 您必須透過欄位指定完整路徑例如：

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

條件式展開

旗標群組可根據 expand_if_available、expand_if_not_available、expand_if_true、expand_if_false 或 expand_if_equal 屬性，根據特定變數或其欄位的存在情形支援條件式展開。例如：

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

CcToolchainConfigInfo 參考資料

本節提供建構變數、功能和其他資訊的參考資料，這些資訊可協助您成功設定 C++ 規則。

CcToolchainConfigInfo 建構變數

以下是 CcToolchainConfigInfo 建構變數的參考資料。

知名功能

以下是功能和啟用條件的參考資料。

舊版功能修補邏輯

為確保回溯相容性，Bazel 會對工具鏈的功能套用下列變更：

• 將 legacy_compile_flags 功能移至工具鍊頂端
• 將 default_compile_flags 功能移至工具鏈頂端
• 將 dependency_file (如果沒有的話) 功能新增至工具鏈頂端
• 將 pic 功能 (如果有的話) 新增至工具鏈頂端
• 在工具鍊頂端新增 per_object_debug_info (如果尚未顯示) 功能
• 在工具鍊頂端新增 preprocessor_defines (如果尚未顯示) 功能
• 將 includes 功能 (如果有的話) 新增至工具鏈頂端
• 將 include_paths 功能 (如果有的話) 新增至工具鏈頂端
• 在工具鍊頂端新增 fdo_instrument (如果尚未顯示) 功能
• 在工具鍊頂端新增 fdo_optimize (如果尚未顯示) 功能
• 將 cs_fdo_instrument 功能 (如果有的話) 新增至工具鏈頂端
• 將 cs_fdo_optimize 功能 (如果有的話) 新增至工具鏈頂端
• 將 fdo_prefetch_hints 功能 (如果有的話) 新增至工具鏈頂端
• 在工具鍊頂端新增 autofdo (如果尚未顯示) 功能
• 將 build_interface_libraries (如果沒有，則顯示 ) 功能新增至工具鏈頂端
• 在工具鍊頂端新增 dynamic_library_linker_tool (如果尚未顯示) 功能
• 在工具鍊頂端新增 shared_flag (如果尚未顯示) 功能
• 在工具鍊頂端新增 linkstamps (如果尚未顯示) 功能
• 在工具鍊頂端新增 output_execpath_flags (如果尚未顯示) 功能
• 在工具鍊頂端新增 runtime_library_search_directories (如果尚未顯示) 功能
• 將 library_search_directories (如果沒有的話) 功能新增至工具鏈頂端
• 將 archiver_flags (如果沒有，則顯示 ) 功能新增至工具鏈頂端
• 將 libraries_to_link 功能 (如果有的話) 新增至工具鏈頂端
• 將 force_pic_flags 功能 (如果有的話) 新增至工具鏈頂端
• 將 user_link_flags 功能 (如果有的話) 新增至工具鏈頂端
• 將 legacy_link_flags 功能 (如果有的話) 新增至工具鏈頂端
• 在工具鍊頂端新增 static_libgcc (如果尚未顯示) 功能
• 將 fission_support 功能 (如果有的話) 新增至工具鏈頂端
• 將 strip_debug_symbols (如果沒有，則顯示 ) 功能新增至工具鏈頂端
• 在工具鍊頂端新增 coverage (如果尚未顯示) 功能
• 在工具鍊頂端新增 llvm_coverage_map_format (如果尚未顯示) 功能
• 將 gcc_coverage_map_format 功能 (如果有的話) 新增至工具鏈頂端
• 將 fully_static_link (如果沒有，則顯示 ) 功能新增至工具鏈底部
• 將 user_compile_flags (如果沒有，則顯示 ) 功能新增至工具鏈底部
• 將 sysroot (如果沒有，則顯示 ) 功能新增至工具鏈底部
• 在工具鍊底部新增 unfiltered_compile_flags (如未顯示) 功能
• 將 linker_param_file (如果沒有，則顯示 ) 功能新增至工具鏈底部
• 將 compiler_input_flags (如果沒有，則顯示 ) 功能新增至工具鏈底部
• 在工具鍊底部新增 compiler_output_flags (如未顯示) 功能

這份功能很長。我們預計在Starlark 中的 Crosstool 完成後，移除這些項目。不妨向好奇的讀者參考 CppActionConfigs、 對生產工具鍊而言，可以考慮新增 no_legacy_features， 工具鍊的特性