C / C++ 規則

規則

cc_binary

cc_binary(name, deps, srcs, data, additional_linker_inputs, args, compatible_with, copts, defines, deprecation, distribs, env, exec_compatible_with, exec_properties, features, includes, licenses, linkopts, linkshared, linkstatic, local_defines, malloc, nocopts, output_licenses, restricted_to, stamp, tags, target_compatible_with, testonly, toolchains, visibility, win_def_file)

隱含輸出目標

  • name.stripped (只會在明確要求時建構):移除 最新版本的二進位檔案strip -g 已在二進位檔上執行,以移除偵錯 符號。您可以透過指令列 --stripopt=-foo。只有在明確要求時,系統才會建構這個輸出內容。
  • name.dwp (僅在明確要求時建構):如果 Fission 已啟用:偵錯 適用於遠端部署二進位檔偵錯的資訊套件。其他: 空白檔案。

引數

屬性
name

Name; required

此目標的專屬名稱。

deps

List of labels; optional

要連結至二進位檔目標的其他程式庫清單。

可以是 cc_libraryobjc_library 目標。

srcs

List of labels; optional

要處理以建立目標的 C 和 C++ 檔案清單。 這些是 C/C++ 來源檔案和標頭檔案,可以是非產生的 (一般來源檔案) 程式碼) 或由系統產生

所有 .cc.c.cpp 檔案都會 加以編譯如果檔案名稱位於 其他規則的 outs 會自動採用另一項規則

.h 檔案不會經過編譯,但可在 依據來源納入這項規則中的來源。.cc.h 檔案中可以直接加入 這些srcshdrs 列出的任何規則 deps 引數。

總共 #included 個檔案必須在以下示例中提及: 這項規則的 srcs 屬性,或 參照 cc_library()hdrs 屬性。 如果標頭與程式庫相關 列在該程式庫的 hdrs 屬性中,其餘 與這項規則的來源相關聯的標頭 srcs。請參閱「標頭納入檢查」 以取得更詳盡的說明

如果規則名稱位於 srcs, 這項規則會自動依循該規則 如果命名規則的 outs 為 C 或 C++ 這些來源檔案都會編譯成這項規則 如果是程式庫檔案,請選擇相應的連結

允許的 srcs 檔案類型:

  • C 和 C++ 來源檔案:.c.cc.cpp.cxx.c++.C
  • C 和 C++ 標頭檔案:.h.hh.hpp.hxx.inc.inl.H
  • 使用 C 預先處理器組合:.S
  • 封存檔:.a.pic.a
  • 「一律連結」程式庫:.lo.pic.lo
  • 共用資料庫 (版本化或反版本):.so.so.version
  • 物件檔案:.o.pic.o

...以及產生這些檔案的任何規則。 不同的擴充功能代表 改成 gcc 慣例

additional_linker_inputs

List of labels; optional

將這些檔案傳送至 C++ 連接器指令。

舉例來說,可以在這裡提供已編譯的 Windows .res 檔案,以便嵌入 做為二進位目標

copts

List of strings; optional

將這些選項新增至 C++ 編譯指令。 取決於「化變數」替代和 Bourne 殼層權杖化

此屬性中的每個字串都會按照指定順序新增至 COPTS, 來編譯二進位目標標記只會在編譯這個目標時生效,不會 因此,請謹慎處理包含在其他地方的標頭檔案。所有路徑 是相對於工作區,而不是目前的套件。

如果套件已宣告功能 no_copts_tokenization,Bourne 殼層權杖化功能僅適用於字串 其中包含一個「廠牌」變數。

defines

List of strings; optional

要新增至編譯行的定義清單。 取決於 「廠牌」替代和 Bourne 殼層權杖化。 每個字串都必須包含單一 Bourne 殼層符記 加在 -D 的前面,並新增至這個目標的編譯指令列。 並套用仰賴規則的每項規則請務必小心,因為這可能有 影響深遠的影響如有疑問,請將定義值加進 local_defines
includes

List of strings; optional

要新增至編譯行的包含 URI 清單。

套用至「Make 變數」替代。 每個字串前面都會加上 -isystem,並新增至 COPTS。 與最佳化不同,系統會在這項規則中新增這些標記 並提供相關的所有規則(注意:而不是仰賴的規則!)成為 因為這樣可能帶來相當深遠的影響有疑慮就加上 「-我」標記為 COPTS

標頭必須新增至 srcs 或 Hdr,否則就無法使用 預設規則。

linkopts

List of strings; optional

將這些標記新增至 C++ 連接器指令。 取決於 「廠牌」替代變數, Bourne 殼層權杖化展開標籤。 此屬性中的每個字串都加到 LINKOPTS 之前, 來連結二進位資料

這份清單中每個開頭不是 $- 的元素 假設為 deps 中目標的標籤。 該目標產生的檔案清單會附加至連結器 只要設定成「自動重新啟動」 和「在主機維護期間」選項即可如果標籤無效或 未在 deps 中宣告。

linkshared

Boolean; optional; nonconfigurable; default is False

建立共用資料庫。 如要啟用這項屬性,請在規則中加入 linkshared=True。預設 這個選項就會停用

出現這個旗標,表示連結是透過 -shared 標記完成 新增至 gcc,產生的共用資料庫適合載入 Java 程式範例不過,基於建構目的,這個 API 永遠不會連結至 相依二進位檔,因為原定方法為透過 cc_binary 規則只有其他程式手動載入,因此 不應視為替代 cc_library 規則。為提高擴充性,建議您完全避免採用此方法, 讓 java_library 依附於 cc_library 規則 。

如果同時指定 linkopts=['-static']linkshared=True, 即可獲得一個完全獨立的單元如果您同時指定 linkstatic=Truelinkshared=True,您大多能獲得單價 獨立單元

linkstatic

Boolean; optional; default is True

適用於 cc_binarycc_test:連結靜態的二進位檔 模式。cc_library.linkstatic:請參閱下方說明。

這個選項預設為 cc_binary,其餘則為關閉。

如果啟用此選項,且是二進位檔或測試項目,這個選項會指示建構工具 .a,盡可能避免使用 .so 的使用者程式庫。 部分系統程式庫可能仍然會以動態方式連結, 我們沒有靜態資料庫因此,產生的執行檔仍會 不過,因此只能「幾乎」都是靜態資料。

連結執行檔的方法有三種:

  • 使用 Full_static_link 功能 STATIC,所有內容皆以靜態方式連結; 例如:「gcc -static foo.o libbar.a libbaz.a -lm」。
    啟用這個模式的方式,就是在fully_static_link features 屬性。
  • STATIC:以靜態方式連結所有使用者程式庫 (如果是 可用的版本),但系統程式庫 (不包括 C/C++ 執行階段程式庫) 會透過動態連結的方式連結 (例如「gcc foo.o libfoo.a libbaz.a -lm」。
    透過指定 linkstatic=True 即可啟用這個模式。
  • 動態版本:所有程式庫皆以動態方式連結 (如果動態版本是 可用),例如:「gcc foo.o libfoo.so libbaz.so -lm」。
    透過指定 linkstatic=False 即可啟用這個模式。

linkstatic 屬性如果用於 cc_library() 規則。 如果是 C++ 程式庫,linkstatic=True 表示只有 系統允許使用靜態連結,因此不會產生 .so。linkstatic=False 包含 但無法防止建立靜態資料庫這個屬性是用來控制 動態程式庫建立程序

如果值為 linkstatic=False,建構工具會建立符號連結,指向 依賴 *.runfiles 區域的共用程式庫

local_defines

List of strings; optional

要新增至編譯行的定義清單。 取決於 「廠牌」替代和 Bourne 殼層權杖化。 每個字串都必須包含單一 Bourne 殼層符記 加在 -D 的前面,並新增至這個目標的編譯指令列。 而非依附關係
malloc

Label; optional; default is @bazel_tools//tools/cpp:malloc

覆寫 Malloc 的預設依附元件。

根據預設,C++ 二進位檔會與 //tools/cpp:malloc 連結, 是空的程式庫,所以二進位檔最終會使用 libc malloc。 這個標籤必須參照 cc_library。如果是針對非 C++ 如果發生下列情形,系統會忽略這個屬性的值: 已指定 linkshared=True

nocopts

String; optional

移除 C++ 編譯指令中的相符選項。 取決於 「廠牌」變數替代。 這個屬性的值會解讀為規則運算式。 符合這個規則運算式的任何現有 COPTS (包括規則的 copts 屬性中明確指定的值) 會從 COPTS:用於編譯這項規則。 這個屬性應該很少需要用。
stamp

Integer; optional; default is -1

是否將建構資訊編碼為二進位檔。可能的值包括:
  • stamp = 1:一律在二進位檔中加上建構資訊加上戳記,即使在 --nostamp 版本。本 建議避免設定,因為這可能會終止 以及任何相依的下游動作
  • stamp = 0:一律以常數值取代建構資訊。這個 也提供良好的建構結果快取功能
  • stamp = -1:建構資訊的嵌入功能是由 --[no]stamp 旗標。

除非其依附元件變更,否則系統「不會」重新建構加上時間戳記的二進位檔。

win_def_file

Label; optional

要傳遞至連接器的 Windows DEF 檔案。

只有在 Windows 是目標平台時,才能使用這項屬性。 可用於 匯出符號

cc_import

cc_import(name, data, hdrs, alwayslink, compatible_with, deprecation, distribs, features, interface_library, licenses, restricted_to, shared_library, static_library, system_provided, tags, target_compatible_with, testonly, visibility)

cc_import 規則可讓使用者匯入預先編譯的 C/C++ 程式庫。

以下為一般用途:
1.連結靜態資料庫

cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  static_library = "libmylib.a",
  # If alwayslink is turned on,
  # libmylib.a will be forcely linked into any binary that depends on it.
  # alwayslink = 1,
)
敬上 2.連結共用資料庫 (Unix)
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  shared_library = "libmylib.so",
)
敬上 3.將共用資料庫與介面程式庫連結 (Windows)
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  # mylib.lib is a import library for mylib.dll which will be passed to linker
  interface_library = "mylib.lib",
  # mylib.dll will be available for runtime
  shared_library = "mylib.dll",
)
敬上 4.將共用資料庫連結至「system_provided=True」(Windows)
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  # mylib.lib is an import library for mylib.dll which will be passed to linker
  interface_library = "mylib.lib",
  # mylib.dll is provided by system environment, for example it can be found in PATH.
  # This indicates that Bazel is not responsible for making mylib.dll available.
  system_provided = 1,
)
敬上 5. AI 必須採行 隱私保護設計原則連結至靜態或共用資料庫
在 Unix 上:
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  static_library = "libmylib.a",
  shared_library = "libmylib.so",
)

# first will link to libmylib.a
cc_binary(
  name = "first",
  srcs = ["first.cc"],
  deps = [":mylib"],
  linkstatic = 1, # default value
)

# second will link to libmylib.so
cc_binary(
  name = "second",
  srcs = ["second.cc"],
  deps = [":mylib"],
  linkstatic = 0,
)
敬上 Windows:
cc_import(
  name = "mylib",
  hdrs = ["mylib.h"],
  static_library = "libmylib.lib", # A normal static library
  interface_library = "mylib.lib", # An import library for mylib.dll
  shared_library = "mylib.dll",
)

# first will link to libmylib.lib
cc_binary(
  name = "first",
  srcs = ["first.cc"],
  deps = [":mylib"],
  linkstatic = 1, # default value
)

# second will link to mylib.dll through mylib.lib
cc_binary(
  name = "second",
  srcs = ["second.cc"],
  deps = [":mylib"],
  linkstatic = 0,
)

引數

屬性
name

Name; required

此目標的專屬名稱。

hdrs

List of labels; optional

發布標頭檔案清單 並將這個預先編譯的程式庫直接納入相依規則的來源

Boolean; optional; default is False

如為 1,則任何直接或間接仰賴這個 C++ 的二進位檔 靜態程式庫中封存的所有物件檔案,都會連結到預先編譯的程式庫 即使某些符號不包含二進位參照的符號。 如果程式碼中的程式碼未明確呼叫,這個方法就很實用 二進位檔案 (舉例來說,如果您的程式碼註冊以取得某些回呼) 這項工具可讓您存取 該基礎架構的各項服務

如果始終連結無法在 Windows 上與 VS 2017 搭配運作,這是因為 已知問題 請將 VS 2017 升級至最新版本。

interface_library

Label; optional

用於連結共用資料庫的單一介面程式庫。

允許的檔案類型: .ifso, .tbd, .lib, .so.dylib

shared_library

Label; optional

單一預先編譯的共用資料庫。Bazel 會確保 二進位檔案

允許的檔案類型: .so, .dll.dylib

static_library

Label; optional

單一預先編譯的靜態資料庫。

允許的檔案類型: .a, .pic.a.lib

system_provided

Boolean; optional; default is False

如果值為 1,代表執行階段需要的共用資料庫是由系統提供。於 這個例子中必須指定 interface_library shared_library 必須留空。

cc_library

cc_library(name, deps, srcs, data, hdrs, alwayslink, compatible_with, copts, defines, deprecation, distribs, exec_compatible_with, exec_properties, features, implementation_deps, include_prefix, includes, licenses, linkopts, linkstamp, linkstatic, local_defines, nocopts, restricted_to, strip_include_prefix, tags, target_compatible_with, testonly, textual_hdrs, toolchains, visibility, win_def_file)

標頭納入檢查

凡是用於建構作業的標頭檔案,都必須在 hdrs 中宣告,或是 第 srcs 項規則 (共 cc_* 項)。這是強制執行的,

針對 cc_library 規則,hdrs 中的標頭是由以下欄位構成的公開介面: 您可以直接從 hdrs 和 程式庫本身的 srcs,以及 hdrscc_* 規則的 srcs 列出了 deps 中的程式庫。 srcs 中的標頭只能直接從 hdrs 中的檔案加入 和程式庫本身的 srcs判斷是否要 建議您詢問 hdrssrcs,是否希望這個資料庫的使用者 可直接加入。這與介於 程式設計語言中的 publicprivate 瀏覽權限。

cc_binarycc_test 規則沒有匯出介面,因此它們 也沒有 hdrs 屬性。屬於二進位檔或測試集的所有標頭 直接列於 srcs 中。

請看以下範例來說明這些規則。

cc_binary(
    name = "foo",
    srcs = [
        "foo.cc",
        "foo.h",
    ],
    deps = [":bar"],
)

cc_library(
    name = "bar",
    srcs = [
        "bar.cc",
        "bar-impl.h",
    ],
    hdrs = ["bar.h"],
    deps = [":baz"],
)

cc_library(
    name = "baz",
    srcs = [
        "baz.cc",
        "baz-impl.h",
    ],
    hdrs = ["baz.h"],
)

下表列出了本範例中允許的直接納入項目。例如: 允許「foo.cc」直接加入 foo.hbar.h,但 並非 baz.h

包含檔案允許納入的項目
foo.hbar.h
foo.ccfoo.h bar.h
bar.hbar-impl.h baz.h
Bar-impl.hbar.h baz.h
bar.ccbar.h bar-impl.h baz.h
baz.hbaz-impl.h
baz-impl.hbaz.h
baz.ccbaz.h baz-impl.h

納入檢查規則僅適用於 direct 包容。在上述範例中,foo.cc 可允許 包含 bar.h,其中可能包括 baz.h 允許轉彎,允許包括baz-impl.h。技術上 .cc 檔案的編譯方式可能間接包含任何標頭 該檔案位於 hdrssrcs 中 遞移 deps 封閉的任何cc_library。於 在此情況下,編譯器可能會讀取 baz.hbaz-impl.h 編譯 foo.cc 時,但 foo.cc 不得 包含 #include "baz.h"。為了達成這個目標 已允許,必須將 baz 新增至 deps (共 foo 個)。

遺憾的是,Bazel 目前無法區分直接和遞移性 無法偵測檔案是否包含非法包含 只允許間接納入的標頭。例如: 如果直接用在上述 foo.cc 的範例中,Bazel 不會抱怨 包含 baz.h。這會違法,因為foo 不會直接依附於 baz。目前未產生任何錯誤 啟用後,我們日後可能會加入這類錯誤檢查。

引數

屬性
name

Name; required

此目標的專屬名稱。

deps

List of labels; optional

要連結至二進位檔目標的其他程式庫清單。

可以是 cc_libraryobjc_library 目標。

srcs

List of labels; optional

要處理以建立目標的 C 和 C++ 檔案清單。 這些是 C/C++ 來源檔案和標頭檔案,可以是非產生的 (一般來源檔案) 程式碼) 或由系統產生

所有 .cc.c.cpp 檔案都會 加以編譯如果檔案名稱位於 其他規則的 outs 會自動採用另一項規則

.h 檔案不會經過編譯,但可在 依據來源納入這項規則中的來源。.cc.h 檔案中可以直接加入 這些srcshdrs 列出的任何規則 deps 引數。

總共 #included 個檔案必須在以下示例中提及: 這項規則的 srcs 屬性,或 參照 cc_library()hdrs 屬性。 如果標頭與程式庫相關 列在該程式庫的 hdrs 屬性中,其餘 與這項規則的來源相關聯的標頭 srcs。請參閱「標頭納入檢查」 以取得更詳盡的說明

如果規則名稱位於 srcs, 這項規則會自動依循該規則 如果命名規則的 outs 為 C 或 C++ 這些來源檔案都會編譯成這項規則 如果是程式庫檔案,請選擇相應的連結

允許的 srcs 檔案類型:

  • C 和 C++ 來源檔案:.c.cc.cpp.cxx.c++.C
  • C 和 C++ 標頭檔案:.h.hh.hpp.hxx.inc.inl.H
  • 使用 C 預先處理器組合:.S
  • 封存檔:.a.pic.a
  • 「一律連結」程式庫:.lo.pic.lo
  • 共用資料庫 (版本化或反版本):.so.so.version
  • 物件檔案:.o.pic.o

...以及產生這些檔案的任何規則。 不同的擴充功能代表 改成 gcc 慣例

hdrs

List of labels; optional

發布標頭檔案清單 並將這個程式庫直接納入相依規則的來源

此為強烈建議使用此處宣告的標頭檔案位置 描述程式庫的介面這些標頭就會 依據來源納入這項規則或依附規則。 不應由這個程式庫用戶端包含的標頭 列在 srcs 屬性中,即使它們 手動加入其中一個目錄請參閱「標頭納入」 檢查」即可瞭解詳情。

Boolean; optional; default is False

如為 1,則任何直接或間接仰賴這個 C++ 的二進位檔 資料夾中列出的檔案 srcs (即使有些不包含二進位檔參照的符號)。 如果程式碼中的程式碼未明確呼叫,這個方法就很實用 二進位檔案 (舉例來說,如果您的程式碼註冊以取得某些回呼) 這項工具可讓您存取 該基礎架構的各項服務

如果始終連結無法在 Windows 上與 VS 2017 搭配運作,這是因為 已知問題 請將 VS 2017 升級至最新版本。

copts

List of strings; optional

將這些選項新增至 C++ 編譯指令。 取決於「化變數」替代和 Bourne 殼層權杖化

此屬性中的每個字串都會按照指定順序新增至 COPTS, 來編譯二進位目標標記只會在編譯這個目標時生效,不會 因此,請謹慎處理包含在其他地方的標頭檔案。所有路徑 是相對於工作區,而不是目前的套件。

如果套件已宣告功能 no_copts_tokenization,Bourne 殼層權杖化功能僅適用於字串 其中包含一個「廠牌」變數。

defines

List of strings; optional

要新增至編譯行的定義清單。 取決於 「廠牌」替代和 Bourne 殼層權杖化。 每個字串都必須包含單一 Bourne 殼層符記 加在 -D 的前面,並新增至這個目標的編譯指令列。 並套用仰賴規則的每項規則請務必小心,因為這可能有 影響深遠的影響如有疑問,請將定義值加進 local_defines
implementation_deps

List of labels; optional

該程式庫鎖定的其他程式庫清單。取消喜歡 deps,標頭和包含這些程式庫的路徑 (及其全部路徑) 遞移依附元件) 只會用於這個程式庫的編譯作業,不適用於 依靠它使用 implementation_deps 指定的程式庫仍在連結中 取決於這個程式庫的二進位目標

目前僅限使用 cc_libraries,並受到標記的保護 --experimental_cc_implementation_deps

include_prefix

String; optional

要新增至這項規則標頭路徑的前置字串。

設定後,即可存取這項規則 hdrs 屬性中的標頭 at 是這個屬性的值,在其存放區相關路徑前面。

系統會先移除 strip_include_prefix 屬性中的前置字元 前置字元,

includes

List of strings; optional

要新增至編譯行的包含 URI 清單。

套用至「Make 變數」替代。 每個字串前面都會加上 -isystem,並新增至 COPTS。 與最佳化不同,系統會在這項規則中新增這些標記 並提供相關的所有規則(注意:而不是仰賴的規則!)成為 因為這樣可能帶來相當深遠的影響有疑慮就加上 「-我」標記為 COPTS

標頭必須新增至 srcs 或 Hdr,否則就無法使用 預設規則。

linkopts

List of strings; optional

將這些標記新增至 C++ 連接器指令。 取決於 「廠牌」替代變數, Bourne 殼層權杖化展開標籤。 此屬性中的每個字串都加到 LINKOPTS 之前, 來連結二進位資料

這份清單中每個開頭不是 $- 的元素 假設為 deps 中目標的標籤。 該目標產生的檔案清單會附加至連結器 只要設定成「自動重新啟動」 和「在主機維護期間」選項即可如果標籤無效或 未在 deps 中宣告。

linkstamp

Label; optional

同時編譯指定的 C++ 來源檔案,並連結至最終版本 二進位檔案。必須藉由這個技巧來引入時間戳記 將資料轉換為二進位檔只要將來源檔案編譯成 物件檔案中,時間戳記就會不正確。 連結取樣編譯不得包含任何特定一組 編譯器旗標,因此不應仰賴任何特定 標頭、編譯器選項或其他建構變數。 只有在 base 套件。
linkstatic

Boolean; optional; default is False

適用於 cc_binarycc_test:連結靜態的二進位檔 模式。cc_library.linkstatic:請參閱下方說明。

這個選項預設為 cc_binary,其餘則為關閉。

如果啟用此選項,且是二進位檔或測試項目,這個選項會指示建構工具 .a,盡可能避免使用 .so 的使用者程式庫。 部分系統程式庫可能仍然會以動態方式連結, 我們沒有靜態資料庫因此,產生的執行檔仍會 不過,因此只能「幾乎」都是靜態資料。

連結執行檔的方法有三種:

  • 使用 Full_static_link 功能 STATIC,所有內容皆以靜態方式連結; 例如:「gcc -static foo.o libbar.a libbaz.a -lm」。
    啟用這個模式的方式,就是在fully_static_link features 屬性。
  • STATIC:以靜態方式連結所有使用者程式庫 (如果是 可用的版本),但系統程式庫 (不包括 C/C++ 執行階段程式庫) 會透過動態連結的方式連結 (例如「gcc foo.o libfoo.a libbaz.a -lm」。
    透過指定 linkstatic=True 即可啟用這個模式。
  • 動態版本:所有程式庫皆以動態方式連結 (如果動態版本是 可用),例如:「gcc foo.o libfoo.so libbaz.so -lm」。
    透過指定 linkstatic=False 即可啟用這個模式。

linkstatic 屬性如果用於 cc_library() 規則。 如果是 C++ 程式庫,linkstatic=True 表示只有 系統允許使用靜態連結,因此不會產生 .so。linkstatic=False 包含 但無法防止建立靜態資料庫這個屬性是用來控制 動態程式庫建立程序

如果值為 linkstatic=False,建構工具會建立符號連結,指向 依賴 *.runfiles 區域的共用程式庫

local_defines

List of strings; optional

要新增至編譯行的定義清單。 取決於 「廠牌」替代和 Bourne 殼層權杖化。 每個字串都必須包含單一 Bourne 殼層符記 加在 -D 的前面,並新增至這個目標的編譯指令列。 而非依附關係
nocopts

String; optional

移除 C++ 編譯指令中的相符選項。 取決於 「廠牌」變數替代。 這個屬性的值會解讀為規則運算式。 符合這個規則運算式的任何現有 COPTS (包括規則的 copts 屬性中明確指定的值) 會從 COPTS:用於編譯這項規則。 這個屬性應該很少需要用。
strip_include_prefix

String; optional

要從這項規則的標頭路徑去除的前置字元,

設定後,即可存取這項規則 hdrs 屬性中的標頭 遭到截斷的前置字元

如果是相對路徑,則會採用套件相關路徑。如果是絕對值 可理解為存放區相關路徑

緊接在 include_prefix 屬性中的前置字元後,再加上 移除。

textual_hdrs

List of labels; optional

發布標頭檔案清單 這個程式庫會以文字形式納入依附規則的來源。

這是宣告無法自行編譯的標頭檔案的位置; 也就是說,這些物件必須一律 在其他來源檔案以文字形式納入 再也不是件繁重乏味的工作

win_def_file

Label; optional

要傳遞至連接器的 Windows DEF 檔案。

只有在 Windows 是目標平台時,才能使用這項屬性。 可用於 匯出符號

cc_proto_library

cc_proto_library(name, deps, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

cc_proto_library 會從 .proto 檔案產生 C++ 程式碼。

deps 必須指向 proto_library 規則。

範例:

cc_library(
    name = "lib",
    deps = [":foo_cc_proto"],
)

cc_proto_library(
    name = "foo_cc_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

引數

屬性
name

Name; required

此目標的專屬名稱。

deps

List of labels; optional

proto_library 清單 並產生 C++ 程式碼

fdo_prefetch_hints

fdo_prefetch_hints(name, compatible_with, deprecation, distribs, features, licenses, profile, restricted_to, tags, target_compatible_with, testonly, visibility)

代表位於工作區或指定位置的 FDO 預先擷取提示設定檔 範例:

fdo_prefetch_hints(
    name = "hints",
    profile = "//path/to/hints:profile.afdo",
)

fdo_profile(
  name = "hints_abs",
  absolute_path_profile = "/absolute/path/profile.afdo",
)

引數

屬性
name

Name; required

此目標的專屬名稱。

profile

Label; optional

提示設定檔的標籤。提示檔案的副檔名為 .afdo 該標籤也可以指向 fdo_absolute_path_profile 規則。

fdo_profile

fdo_profile(name, absolute_path_profile, compatible_with, deprecation, distribs, features, licenses, profile, proto_profile, restricted_to, tags, target_compatible_with, testonly, visibility)

代表位於工作區或指定絕對路徑的 FDO 設定檔。 範例:

fdo_profile(
    name = "fdo",
    profile = "//path/to/fdo:profile.zip",
)

fdo_profile(
  name = "fdo_abs",
  absolute_path_profile = "/absolute/path/profile.zip",
)

引數

屬性
name

Name; required

此目標的專屬名稱。

absolute_path_profile

String; optional

FDO 設定檔的絕對路徑。FDO 檔案可使用下列其中一個副檔名: .profraw (未建立索引的 LLVM 設定檔)、.profdata (已建立索引的 LLVM 設定檔)、.zip ,其中包含 LLVM profraw 設定檔,.afdo 則適用於 AutoFDO 設定檔。
profile

Label; optional

FDO 設定檔或產生該設定檔的規則的標籤。FDO 檔案中的 以下擴充功能:.profraw (適用於未建立索引的 LLVM 設定檔)、.profdata (已建立索引的 LLVM) 設定檔、.zip,內含 LLVM profraw 設定檔、.afdo for AutoFDO 設定檔、.xfdo XBinary 設定檔。該標籤也可以指向 fdo_absolute_path_profile 規則。
proto_profile

Label; optional

protobuf 設定檔的標籤。

propeller_optimize

propeller_optimize(name, compatible_with, deprecation, distribs, features, ld_profile, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

代表工作區中的 Propeller 最佳化設定檔。 範例:

propeller_optimize(
    name = "layout",
    cc_profile = "//path:cc_profile.txt",
    ld_profile = "//path:ld_profile.txt"
)

propeller_optimize(
    name = "layout_absolute",
    absolute_cc_profile = "/absolute/cc_profile.txt",
    absolute_ld_profile = "/absolute/ld_profile.txt"
)

引數

屬性
name

Name; required

此目標的專屬名稱。

ld_profile

Label; optional

傳送至連結動作的設定檔標籤。這個檔案有 .txt 副檔名。

cc_test

cc_test(name, deps, srcs, data, additional_linker_inputs, args, compatible_with, copts, defines, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, includes, licenses, linkopts, linkstatic, local, local_defines, malloc, nocopts, restricted_to, shard_count, size, stamp, tags, target_compatible_with, testonly, timeout, toolchains, visibility, win_def_file)

引數

屬性
name

Name; required

此目標的專屬名稱。

deps

List of labels; optional

要連結至二進位檔目標的其他程式庫清單。

可以是 cc_libraryobjc_library 目標。

srcs

List of labels; optional

要處理以建立目標的 C 和 C++ 檔案清單。 這些是 C/C++ 來源檔案和標頭檔案,可以是非產生的 (一般來源檔案) 程式碼) 或由系統產生

所有 .cc.c.cpp 檔案都會 加以編譯如果檔案名稱位於 其他規則的 outs 會自動採用另一項規則

.h 檔案不會經過編譯,但可在 依據來源納入這項規則中的來源。.cc.h 檔案中可以直接加入 這些srcshdrs 列出的任何規則 deps 引數。

總共 #included 個檔案必須在以下示例中提及: 這項規則的 srcs 屬性,或 參照 cc_library()hdrs 屬性。 如果標頭與程式庫相關 列在該程式庫的 hdrs 屬性中,其餘 與這項規則的來源相關聯的標頭 srcs。請參閱「標頭納入檢查」 以取得更詳盡的說明

如果規則名稱位於 srcs, 這項規則會自動依循該規則 如果命名規則的 outs 為 C 或 C++ 這些來源檔案都會編譯成這項規則 如果是程式庫檔案,請選擇相應的連結

允許的 srcs 檔案類型:

  • C 和 C++ 來源檔案:.c.cc.cpp.cxx.c++.C
  • C 和 C++ 標頭檔案:.h.hh.hpp.hxx.inc.inl.H
  • 使用 C 預先處理器組合:.S
  • 封存檔:.a.pic.a
  • 「一律連結」程式庫:.lo.pic.lo
  • 共用資料庫 (版本化或反版本):.so.so.version
  • 物件檔案:.o.pic.o

...以及產生這些檔案的任何規則。 不同的擴充功能代表 改成 gcc 慣例

additional_linker_inputs

List of labels; optional

將這些檔案傳送至 C++ 連接器指令。

舉例來說,可以在這裡提供已編譯的 Windows .res 檔案,以便嵌入 做為二進位目標

copts

List of strings; optional

將這些選項新增至 C++ 編譯指令。 取決於「化變數」替代和 Bourne 殼層權杖化

此屬性中的每個字串都會按照指定順序新增至 COPTS, 來編譯二進位目標標記只會在編譯這個目標時生效,不會 因此,請謹慎處理包含在其他地方的標頭檔案。所有路徑 是相對於工作區,而不是目前的套件。

如果套件已宣告功能 no_copts_tokenization,Bourne 殼層權杖化功能僅適用於字串 其中包含一個「廠牌」變數。

defines

List of strings; optional

要新增至編譯行的定義清單。 取決於 「廠牌」替代和 Bourne 殼層權杖化。 每個字串都必須包含單一 Bourne 殼層符記 加在 -D 的前面,並新增至這個目標的編譯指令列。 並套用仰賴規則的每項規則請務必小心,因為這可能有 影響深遠的影響如有疑問,請將定義值加進 local_defines
includes

List of strings; optional

要新增至編譯行的包含 URI 清單。

套用至「Make 變數」替代。 每個字串前面都會加上 -isystem,並新增至 COPTS。 與最佳化不同,系統會在這項規則中新增這些標記 並提供相關的所有規則(注意:而不是仰賴的規則!)成為 因為這樣可能帶來相當深遠的影響有疑慮就加上 「-我」標記為 COPTS

標頭必須新增至 srcs 或 Hdr,否則就無法使用 預設規則。

linkopts

List of strings; optional

將這些標記新增至 C++ 連接器指令。 取決於 「廠牌」替代變數, Bourne 殼層權杖化展開標籤。 此屬性中的每個字串都加到 LINKOPTS 之前, 來連結二進位資料

這份清單中每個開頭不是 $- 的元素 假設為 deps 中目標的標籤。 該目標產生的檔案清單會附加至連結器 只要設定成「自動重新啟動」 和「在主機維護期間」選項即可如果標籤無效或 未在 deps 中宣告。

linkstatic

Boolean; optional; default is False

適用於 cc_binarycc_test:連結靜態的二進位檔 模式。cc_library.linkstatic:請參閱下方說明。

這個選項預設為 cc_binary,其餘則為關閉。

如果啟用此選項,且是二進位檔或測試項目,這個選項會指示建構工具 .a,盡可能避免使用 .so 的使用者程式庫。 部分系統程式庫可能仍然會以動態方式連結, 我們沒有靜態資料庫因此,產生的執行檔仍會 不過,因此只能「幾乎」都是靜態資料。

連結執行檔的方法有三種:

  • 使用 Full_static_link 功能 STATIC,所有內容皆以靜態方式連結; 例如:「gcc -static foo.o libbar.a libbaz.a -lm」。
    啟用這個模式的方式,就是在fully_static_link features 屬性。
  • STATIC:以靜態方式連結所有使用者程式庫 (如果是 可用的版本),但系統程式庫 (不包括 C/C++ 執行階段程式庫) 會透過動態連結的方式連結 (例如「gcc foo.o libfoo.a libbaz.a -lm」。
    透過指定 linkstatic=True 即可啟用這個模式。
  • 動態版本:所有程式庫皆以動態方式連結 (如果動態版本是 可用),例如:「gcc foo.o libfoo.so libbaz.so -lm」。
    透過指定 linkstatic=False 即可啟用這個模式。

linkstatic 屬性如果用於 cc_library() 規則。 如果是 C++ 程式庫,linkstatic=True 表示只有 系統允許使用靜態連結,因此不會產生 .so。linkstatic=False 包含 但無法防止建立靜態資料庫這個屬性是用來控制 動態程式庫建立程序

如果值為 linkstatic=False,建構工具會建立符號連結,指向 依賴 *.runfiles 區域的共用程式庫

local_defines

List of strings; optional

要新增至編譯行的定義清單。 取決於 「廠牌」替代和 Bourne 殼層權杖化。 每個字串都必須包含單一 Bourne 殼層符記 加在 -D 的前面,並新增至這個目標的編譯指令列。 而非依附關係
malloc

Label; optional; default is @bazel_tools//tools/cpp:malloc

覆寫 Malloc 的預設依附元件。

根據預設,C++ 二進位檔會與 //tools/cpp:malloc 連結, 是空的程式庫,所以二進位檔最終會使用 libc malloc。 這個標籤必須參照 cc_library。如果是針對非 C++ 如果發生下列情形,系統會忽略這個屬性的值: 已指定 linkshared=True

nocopts

String; optional

移除 C++ 編譯指令中的相符選項。 取決於 「廠牌」變數替代。 這個屬性的值會解讀為規則運算式。 符合這個規則運算式的任何現有 COPTS (包括規則的 copts 屬性中明確指定的值) 會從 COPTS:用於編譯這項規則。 這個屬性應該很少需要用。
stamp

Integer; optional; default is 0

是否將建構資訊編碼為二進位檔。可能的值包括:
  • stamp = 1:一律在二進位檔中加上建構資訊加上戳記,即使在 --nostamp 版本。本 建議避免設定,因為這可能會終止 以及任何相依的下游動作
  • stamp = 0:一律以常數值取代建構資訊。這個 也提供良好的建構結果快取功能
  • stamp = -1:建構資訊的嵌入功能是由 --[no]stamp 旗標。

除非其依附元件變更,否則系統「不會」重新建構加上時間戳記的二進位檔。

win_def_file

Label; optional

要傳遞至連接器的 Windows DEF 檔案。

只有在 Windows 是目標平台時,才能使用這項屬性。 可用於 匯出符號

cc_toolchain

cc_toolchain(name, all_files, ar_files, as_files, compatible_with, compiler, compiler_files, compiler_files_without_includes, coverage_files, cpu, deprecation, distribs, dwp_files, dynamic_runtime_lib, exec_transition_for_inputs, features, libc_top, licenses, linker_files, module_map, objcopy_files, restricted_to, static_runtime_lib, strip_files, supports_header_parsing, supports_param_files, tags, target_compatible_with, testonly, toolchain_config, toolchain_identifier, visibility)

代表 C++ 工具鍊。

此規則負責:

  • 收集執行 C++ 動作所需的所有構件。做法是 例如 all_filescompiler_files linker_files 或其他結尾為 _files 的屬性)。這些 最常見的檔案群組發現了所有必要檔案。
  • 為 C++ 動作產生正確的指令列。方法是使用 CcToolchainConfigInfo 提供者 (請見下方說明)。

使用 toolchain_config 屬性設定 C++ 工具鍊。 另請參閱 第 頁 查看詳細的 C++ 工具鍊設定和工具鍊選擇說明文件。

使用 tags = ["manual"],以免建立及設定工具鍊 叫用 bazel build //... 時不需要使用

引數

屬性
name

Name; required

此目標的專屬名稱。

all_files

Label; required

顯示所有 cc_toolchain 構件。這些構件會新增為以下項目的輸入內容: Rules_cc 相關動作 (使用更精確的 屬性。Bazel 假設 all_files 是超集 所有其他構件屬性 (例如 linktamp 編譯需要一併編譯) 並連結檔案,因此需要 all_files)。

這是 cc_toolchain.files 包含的內容,全部 Starlark 都使用這個項目 管理 C++ 工具鍊的規則。

ar_files

Label; optional

包含封存動作所需的所有 cc_toolchain 構件。

as_files

Label; optional

組合動作所需的所有 cc_toolchain 構件。

compiler

String; optional; nonconfigurable

已淘汰,請改用 toolchain_identifier 屬性。這是一件名詞 晚於 從 CROSSTOOL 遷移至 Starlark ,將由以下開發人員移除: #7075

設定後,就會用於執行 Crosstool_config.toolchain 選取。需要 的優先順序高於 --cpu Bazel 選項

compiler_files

Label; required

編譯動作所需的所有 cc_toolchain 構件。
compiler_files_without_includes

Label; optional

如果出現編譯動作所需的 cc_toolchain 構件, 支援輸入探索 (目前只支援 Google)。
coverage_files

Label; optional

內含涵蓋範圍動作所需的所有 cc_toolchain 構件。如未指定 all_files。
cpu

String; optional; nonconfigurable

已淘汰,請改用 toolchain_identifier 屬性。這是後期 從 COSSTOOL 遷移至 Starlark ,將由以下開發人員移除: #7075

設定後,就會用於執行 Crosstool_config.toolchain 選取。需要 的優先順序高於 --cpu Bazel 選項

dwp_files

Label; required

內含執行 Dwp 動作所需的所有 cc_toolchain 構件。
dynamic_runtime_lib

Label; optional

C++ 執行階段程式庫的動態程式庫構件 (例如 libstdc++.so)。

這將用於「static_link_cpp_runtimes」功能已啟用,而我們要連結 動態依附元件

exec_transition_for_inputs

Boolean; optional; default is True

設為 True 即可將 exec 平台的所有檔案輸入內容建構至 cc_toolchain。 而不完成轉換 (即預設為目標平台)。
libc_top

Label; optional

這個集合會傳遞做為輸入內容的 libc 構件,用於編譯/連結動作。
linker_files

Label; required

包含連結動作所需的所有 cc_toolchain 構件。
module_map

Label; optional

要用於模組化版本的模組對應構件。
objcopy_files

Label; required

內含執行 objcopy 動作所需的所有 cc_toolchain 構件。
static_runtime_lib

Label; optional

C++ 執行階段程式庫的靜態程式庫構件 (例如 libstdc++.a)。

這將用於「static_link_cpp_runtimes」功能已啟用,而我們要連結 靜態依附元件

strip_files

Label; required

包含移除操作所需的所有 cc_toolchain 構件。
supports_header_parsing

Boolean; optional; default is False

如果 cc_toolchain 支援標頭剖析動作,請設為 True。
supports_param_files

Boolean; optional; default is True

如果 cc_toolchain 支援使用參數檔案連結動作,請設為 True。
toolchain_config

Label; required

提供 cc_toolchain_config_info 的規則標籤。
toolchain_identifier

String; optional; nonconfigurable

用來比對此 cc_toolchain 與 crosstool_config.toolchain.

直到問題 #5380 已修正 建議您使用這個方法將 cc_toolchainCROSSTOOL.toolchain。其將會由 toolchain_config 取代 屬性 (#5380)。

cc_toolchain_suite

cc_toolchain_suite(name, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

代表 C++ 工具鍊的集合。

此規則負責:

  • 收集所有相關 C++ 工具鍊。
  • 根據 --cpu--compiler 選項選擇一個工具鍊 並傳遞至 Bazel

另請參閱 第 頁 查看詳細的 C++ 工具鍊設定和工具鍊選擇說明文件。

引數

屬性
name

Name; required

此目標的專屬名稱。

toolchains

Dictionary mapping strings to labels; required; nonconfigurable

「<cpu>」的地圖或「<cpu>|<compiler>」對應至 cc_toolchain 標籤。「<cpu>」只有在以下情況下才會使用:--cpu 會傳遞至 Bazel,以及「<cpu>|<compiler>」 --cpu--compiler 會傳遞到 Bazel。範例:

          cc_toolchain_suite(
            name = "toolchain",
            toolchains = {
              "piii|gcc": ":my_cc_toolchain_for_piii_using_gcc",
              "piii": ":my_cc_toolchain_for_piii_using_default_compiler",
            },
          )