規則
- cc_binary
- cc_import
- cc_library
- cc_shared_library
- cc_static_library
- cc_test
- cc_toolchain
- cc_toolchain_suite
- fdo_prefetch_hints
- fdo_profile
- memprof_profile
- propeller_optimize
cc_binary
查看規則來源cc_binary(name, deps, srcs, data, additional_linker_inputs, args, compatible_with, conlyopts, copts, cxxopts, defines, deprecation, distribs, dynamic_deps, env, exec_compatible_with, exec_properties, features, hdrs_check, includes, licenses, link_extra_lib, linkopts, linkshared, linkstatic, local_defines, malloc, module_interfaces, nocopts, output_licenses, reexport_deps, restricted_to, stamp, tags, target_compatible_with, testonly, toolchains, visibility, win_def_file)
產生可執行的二進位檔。
目標的
name
應與應用程式主要進入點的來源檔案名稱相同 (不含副檔名)。舉例來說,如果您在 main.cc
中設定了進入點,則名稱應為 main
。隱含輸出目標
name.stripped
(僅在明確要求時建構):經過精簡的二進位檔版本。strip -g
會在二進位檔上執行,以移除偵錯符號。您可以使用--stripopt=-foo
在指令列上提供其他去除選項。name.dwp
(僅在明確要求時才建構):如果已啟用 Fission:偵錯資訊套件檔案,適合用於偵錯遠端部署的二進位檔。否則:空白檔案。
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
deps
|
標籤清單;預設為 這些可以是 |
srcs
|
標籤清單;預設為 系統會編譯所有 純粹的彙整器檔案 (.s、.asm) 不會經過預先處理,通常會使用彙整器建構。經過預處理的彙整檔案 (.S) 會經過預處理,並通常使用 C/C++ 編譯器建構。 系統不會編譯 所有已
如果
允許的
... 以及產生這些檔案的任何規則 (例如 |
data
|
標籤清單;預設為 data 的一般註解,請參閱「大多數建構規則定義的常見屬性」。如果 如果 C++ 程式碼可以存取這些資料檔案,如下所示:
|
additional_linker_inputs
|
標籤清單;預設為 例如,您可以在此提供已編譯的 Windows .res 檔案,以便嵌入二進位目標。 |
conlyopts
|
字串清單;預設為 |
copts
|
字串清單;預設為
這個屬性中的每個字串都會依照指定順序新增至
如果套件宣告功能
|
cxxopts
|
字串清單;預設為 |
defines
|
字串清單;預設為 -D ,然後新增至這個目標的編譯指令行,以及依附於該目標的每個規則。請務必謹慎操作,因為這可能會造成廣泛的影響。如有疑問,請改為將定義值新增至 local_defines 。 |
dynamic_deps
|
標籤清單;預設為 cc_shared_library 依附元件。
|
hdrs_check
|
字串;預設為 |
includes
|
字串清單;預設為 -isystem path_to_package/include_entry 。這項功能僅適用於不符合 Google 寫法風格的第三方程式庫 #include 陳述式。與 COPTS 不同的是,這些標記會新增至此規則和所有依附此規則的規則。(注意:不是依附的規則!)請務必謹慎操作,因為這可能會造成廣泛的影響。如有疑問,請改為在 COPTS 中加入「-I」標記。
新增的 |
link_extra_lib
|
標籤;預設為
根據預設,C++ 二進位檔會連結至 |
linkopts
|
字串清單;預設為 LINKOPTS 。
這個清單中每個元素的開頭不是 |
linkshared
|
布林值;預設值為 linkshared=True 。這個選項預設為關閉。
這個標記的存在表示連結會將
如果您同時指定 |
linkstatic
|
布林值;預設值為 cc_binary 和 cc_test :在靜態模式中連結二進位檔。如為 cc_library.link_static :請參閱下文。根據預設,這個選項會為
如果已啟用,且這是二進位檔或測試,這個選項會指示建構工具盡可能連結 實際上有三種不同的方式可以連結可執行檔:
如果
如果
在正式環境中,使用 |
local_defines
|
字串清單;預設為 -D ,然後新增至此目標的編譯指令行,但不新增至其依附項目。 |
malloc
|
標籤;預設為
根據預設,C++ 二進位檔會連結至 |
module_interfaces
|
標籤清單;預設為 C++ 標準對模組介面檔案副檔名沒有限制
使用方式受到 |
nocopts
|
字串;預設為 COPTS 中移除任何符合此規則運算式的先前 COPTS (包括規則 copts 屬性中明確指定的值)。這個屬性不應在 third_party 以外的情況下使用或需要。除了「Make」變數替換之外,系統不會以任何方式預先處理這些值。 |
reexport_deps
|
標籤清單;預設為 |
stamp
|
整數;預設值為
除非依附元件變更,否則系統不會重新建構經過標記的二進位檔。 |
win_def_file
|
標籤;預設為 只有在 Windows 是目標平台時,才應使用這個屬性。可在連結共用程式庫時 匯出符號。 |
cc_import
查看規則來源cc_import(name, deps, data, hdrs, alwayslink, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, includes, interface_library, linkopts, objects, pic_objects, pic_static_library, restricted_to, shared_library, static_library, system_provided, tags, target_compatible_with, testonly, toolchains, 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,
)
cc_import(
name = "mylib",
hdrs = ["mylib.h"],
shared_library = "libmylib.so",
)
在 Unix 上:
cc_import(
name = "mylib",
hdrs = ["mylib.h"],
# libmylib.ifso is an interface library for libmylib.so which will be passed to linker
interface_library = "libmylib.ifso",
# libmylib.so will be available for runtime
shared_library = "libmylib.so",
)
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 will be available for runtime
shared_library = "mylib.dll",
)
system_provided=True
連結共用程式庫在 Unix 上:
cc_import(
name = "mylib",
hdrs = ["mylib.h"],
interface_library = "libmylib.ifso", # Or we can also use libmylib.so as its own interface library
# libmylib.so is provided by system environment, for example it can be found in LD_LIBRARY_PATH.
# This indicates that Bazel is not responsible for making libmylib.so available.
system_provided = 1,
)
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,
)
在 Unix 上:
cc_import(
name = "mylib",
hdrs = ["mylib.h"],
static_library = "libmylib.a",
shared_library = "libmylib.so",
)
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",
)
其餘部分在 Unix 和 Windows 上都相同:
# first will link to libmylib.a (or libmylib.lib)
cc_binary(
name = "first",
srcs = ["first.cc"],
deps = [":mylib"],
linkstatic = 1, # default value
)
# second will link to libmylib.so (or libmylib.lib)
cc_binary(
name = "second",
srcs = ["second.cc"],
deps = [":mylib"],
linkstatic = 0,
)
cc_import
支援 include 屬性。例如:
cc_import(
name = "curl_lib",
hdrs = glob(["vendor/curl/include/curl/*.h"]),
includes = ["vendor/curl/include"],
shared_library = "vendor/curl/lib/.libs/libcurl.dylib",
)
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
deps
|
標籤清單;預設為 deps 的一般註解,請參閱「大多數建構規則定義的常見屬性」。
|
hdrs
|
標籤清單;預設為 |
alwayslink
|
布林值;預設值為 如果 alwayslink 無法在 Windows 上與 VS 2017 搭配運作,可能是因為已知問題,請將 VS 2017 升級至最新版本。 |
includes
|
字串清單;預設為 -isystem path_to_package/include_entry 。這項功能僅適用於不符合 Google 寫法風格的第三方程式庫 #include 陳述式。與 COPTS 不同的是,這些標記會新增至此規則和所有依附此規則的規則。(注意:不是依附的規則!)請務必謹慎操作,因為這可能會造成廣泛的影響。如有疑問,請改為在 COPTS 中加入「-I」標記。
預設 |
interface_library
|
標籤;預設為 允許的檔案類型:
|
linkopts
|
字串清單;預設為 LINKOPTS 。
清單中每個元素的開頭不是 |
objects
|
標籤清單;預設為 |
pic_objects
|
標籤清單;預設為 |
pic_static_library
|
標籤;預設為 |
shared_library
|
標籤;預設為 允許的檔案類型: |
static_library
|
標籤;預設為 允許的檔案類型: |
system_provided
|
布林值;預設值為 interface_library ,而 shared_library 應留空。 |
cc_library
查看規則來源cc_library(name, deps, srcs, data, hdrs, additional_compiler_inputs, additional_linker_inputs, alwayslink, compatible_with, conlyopts, copts, cxxopts, defines, deprecation, distribs, exec_compatible_with, exec_properties, features, hdrs_check, implementation_deps, include_prefix, includes, licenses, linkopts, linkstamp, linkstatic, local_defines, module_interfaces, restricted_to, strip_include_prefix, tags, target_compatible_with, testonly, textual_hdrs, toolchains, visibility, win_def_file)
請將 cc_library()
用於 C++ 編譯的程式庫。結果可能是 .so
、.lo
或 .a
,具體取決於需求。
如果您使用依附 cc_library
的靜態連結來建構項目,依附程式庫規則的輸出內容就是 .a
檔案。如果您指定 alwayslink=True
,就會取得 .lo
檔案。
共用程式庫的實際輸出檔案名稱為 libfoo.so
,其中 foo 是規則的名稱。其他類型的程式庫結尾分別為 .lo
和 .a
。如果您需要特定的共用程式庫名稱 (例如,用於定義 Python 模組),請使用 genrule 將程式庫複製至所需名稱。
標頭納入檢查
在建構作業中使用的所有標頭檔案,都必須在 cc_*
規則的 hdrs
或 srcs
中宣告。這項規定是強制執行的。
對於 cc_library
規則,hdrs
中的標頭包含程式庫的公開介面,可直接從 hdrs
和程式庫本身的 srcs
檔案,以及 cc_*
規則的 hdrs
和 srcs
檔案中,列出程式庫的 deps
中直接納入。srcs
中的標頭只能直接從資料庫本身的 hdrs
和 srcs
檔案中加入。決定是否要將標頭放入 hdrs
或 srcs
時,請先考慮是否要讓這個程式庫的使用者能夠直接納入標頭。這與程式語言中 public
和 private
可見性之間的決定大致相同。
cc_binary
和 cc_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.h
和 bar.h
,但不能包含 baz.h
。
包含檔案 | 允許納入的內容 |
---|---|
foo.h | bar.h |
foo.cc | foo.h bar.h |
bar.h | bar-impl.h baz.h |
bar-impl.h | bar.h baz.h |
bar.cc | bar.h bar-impl.h baz.h |
baz.h | baz-impl.h |
baz-impl.h | baz.h |
baz.cc | baz.h baz-impl.h |
納入檢查規則僅適用於直接納入內容。在上述範例中,foo.cc
可包含 bar.h
,而 bar.h
可包含 baz.h
,baz.h
則可包含 baz-impl.h
。從技術層面來說,編譯 .cc
檔案時,可能會透過 deps
閉包中的 cc_library
將 hdrs
或 srcs
中的任何標頭檔案納入。在這種情況下,編譯器在編譯 foo.cc
時可能會讀取 baz.h
和 baz-impl.h
,但 foo.cc
不得包含 #include "baz.h"
。為允許這項操作,baz
必須新增至 foo
的 deps
。
Bazel 會依賴工具鍊支援功能來強制執行包含檢查規則。工具鍊必須支援 layering_check
功能,並明確要求此功能,例如透過 --features=layering_check
指令列旗標或 package
函式的 features
參數。Bazel 提供的工具鍊僅支援在 Unix 和 macOS 上使用 clang 執行這項功能。
範例
我們使用 alwayslink
標記,強制連結器連結此程式碼,即使主要二進位程式碼未參照此程式碼也一樣。
cc_library(
name = "ast_inspector_lib",
srcs = ["ast_inspector_lib.cc"],
hdrs = ["ast_inspector_lib.h"],
visibility = ["//visibility:public"],
deps = ["//third_party/llvm/llvm/tools/clang:frontend"],
# alwayslink as we want to be able to call things in this library at
# debug time, even if they aren't used anywhere in the code.
alwayslink = 1,
)
以下範例來自 third_party/python2_4_3/BUILD
。部分程式碼會使用 dl
程式庫 (用於載入其他動態程式庫),因此這項規則會指定 -ldl
連結選項,以連結 dl
程式庫。
cc_library(
name = "python2_4_3",
linkopts = [
"-ldl",
"-lutil",
],
deps = ["//third_party/expat"],
)
以下範例來自 third_party/kde/BUILD
。我們會在集管器中保留預先建構的 .so
檔案。標頭檔案位於名為 include
的子目錄中。
cc_library(
name = "kde",
srcs = [
"lib/libDCOP.so",
"lib/libkdesu.so",
"lib/libkhtml.so",
"lib/libkparts.so",
...more .so files...,
],
includes = ["include"],
deps = ["//third_party/X11"],
)
以下範例來自 third_party/gles/BUILD
。第三方程式碼通常需要一些 defines
和 linkopts
。
cc_library(
name = "gles",
srcs = [
"GLES/egl.h",
"GLES/gl.h",
"ddx.c",
"egl.c",
],
defines = [
"USE_FLOAT",
"__GL_FLOAT",
"__GL_COMMON",
],
linkopts = ["-ldl"], # uses dlopen(), dl library
deps = [
"es",
"//third_party/X11",
],
)
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
deps
|
標籤清單;預設為 這些可以是 如要查看 這些應為 C++ 程式庫規則的名稱。建構連結此規則程式庫的二進位檔時,您也會連結 儘管名稱為「deps」,但並非所有程式庫的用戶端都屬於此類別。執行階段資料依附元件應放在 如要連結預先編譯的第三方程式庫,請改為將其名稱新增至 如要依附某個項目,但不將其連結至這個程式庫,請改為將其名稱新增至 |
srcs
|
標籤清單;預設為 系統會編譯所有 純粹的彙整器檔案 (.s、.asm) 不會經過預先處理,通常會使用彙整器建構。經過預處理的彙整檔案 (.S) 會經過預處理,並通常使用 C/C++ 編譯器建構。 系統不會編譯 所有已
如果
允許的
... 以及產生這些檔案的任何規則 (例如 |
data
|
標籤清單;預設為 data 的一般註解,請參閱「大多數建構規則定義的常見屬性」。如果 如果 C++ 程式碼可以存取這些資料檔案,如下所示:
|
hdrs
|
標籤清單;預設為 這是宣告描述程式庫介面的標頭檔案的首選位置。這些標頭會開放給這項規則或相關依附規則中的來源使用。即使標頭已由發布的標頭納入,如果該標頭並非此程式庫的用戶端應納入的標頭,也應列在 允許的 |
additional_compiler_inputs
|
標籤清單;預設為 |
additional_linker_inputs
|
標籤清單;預設為 例如,您可以在此提供已編譯的 Windows .res 檔案,以便嵌入二進位目標。 |
alwayslink
|
布林值;預設值為 srcs 中列出的所有物件檔案,即使其中有些檔案不含二進位檔案參照的符號也一樣。如果二進位檔中的程式碼並未明確呼叫您的程式碼 (例如,如果您的程式碼註冊接收某些服務提供的回呼),這項功能就很實用。如果 alwayslink 無法在 Windows 上與 VS 2017 搭配運作,可能是因為已知問題,請將 VS 2017 升級至最新版本。 |
conlyopts
|
字串清單;預設為 |
copts
|
字串清單;預設為
這個屬性中的每個字串都會依照指定順序新增至
如果套件宣告功能
|
cxxopts
|
字串清單;預設為 |
defines
|
字串清單;預設為 -D ,然後新增至這個目標的編譯指令行,以及依附於該目標的每個規則。請務必謹慎操作,因為這可能會造成廣泛的影響。如有疑問,請改為將定義值新增至 local_defines 。 |
hdrs_check
|
字串;預設為 |
implementation_deps
|
標籤清單;預設為 deps 不同,這些程式庫的標頭和包含路徑 (以及所有傳遞依附元件) 只用於編譯這個程式庫,而非依附於此程式庫的程式庫。使用 implementation_deps 指定的程式庫仍會連結至依賴此程式庫的二進位目標。 |
include_prefix
|
字串;預設為 設定後,您可以在該規則的 系統會先移除 這項屬性僅適用於 |
includes
|
字串清單;預設為 -isystem path_to_package/include_entry 。這項功能僅適用於不符合 Google 寫法風格的第三方程式庫 #include 陳述式。與 COPTS 不同的是,這些標記會新增至此規則和所有依附此規則的規則。(注意:不是依附的規則!)請務必謹慎操作,因為這可能會造成廣泛的影響。如有疑問,請改為在 COPTS 中加入「-I」標記。
新增的 |
linkopts
|
字串清單;預設為 cc_binary.linkopts 。linkopts 屬性也會套用至任何目標,這些目標會透過 deps 屬性 (或透過其他類似處理方式的屬性:cc_binary 的 malloc 屬性),直接或間接地依附於這個程式庫。相依性 linkopt 優先於相依 linkopt (也就是說,相依性 linkopt 會在命令列中稍後出現)。在 --linkopt 中指定的 Linkopt 優先於規則 Linkopt。
請注意, 此外,請注意,系統不支援「-Wl,-soname」或「-Xlinker -soname」選項,且不應在這個屬性中指定這些選項。 |
linkstamp
|
標籤;預設為 base 套件。
|
linkstatic
|
布林值;預設值為 cc_binary 和 cc_test :在靜態模式中連結二進位檔。如為 cc_library.link_static :請參閱下文。根據預設,這個選項會為
如果已啟用,且這是二進位檔或測試,這個選項會指示建構工具盡可能連結 實際上有三種不同的方式可以連結可執行檔:
如果
如果
在正式環境中,使用 |
local_defines
|
字串清單;預設為 -D ,然後新增至此目標的編譯指令行,但不新增至其依附項目。 |
module_interfaces
|
標籤清單;預設為 C++ 標準對模組介面檔案副檔名沒有限制
使用方式受到 |
strip_include_prefix
|
字串;預設為 設定後,您就可以在路徑中使用這個前置字串,存取這個規則的 如果是相對路徑,則會視為與套件相關的路徑。如果是絕對路徑,系統會將其視為相對於存放區的路徑。 這個前置字元會在移除後,新增至 這項屬性僅適用於 |
textual_hdrs
|
標籤清單;預設為 這是宣告無法自行編譯的標頭檔案位置,也就是說,其他來源檔案必須以文字形式納入標頭檔案,才能建構有效的程式碼。 |
win_def_file
|
標籤;預設為 只有在 Windows 是目標平台時,才應使用這個屬性。可在連結共用程式庫時 匯出符號。 |
cc_shared_library
查看規則來源cc_shared_library(name, deps, additional_linker_inputs, compatible_with, deprecation, distribs, dynamic_deps, exec_compatible_with, exec_properties, experimental_disable_topo_sort_do_not_use_remove_before_7_0, exports_filter, features, restricted_to, roots, shared_lib_name, static_deps, tags, target_compatible_with, testonly, toolchains, user_link_flags, visibility, win_def_file)
會產生共用程式庫。
範例
cc_shared_library( name = "foo_shared", deps = [ ":foo", ], dynamic_deps = [ ":bar_shared", ], additional_linker_inputs = [ ":foo.lds", ], user_link_flags = [ "-Wl,--version-script=$(location :foo.lds)", ], ) cc_library( name = "foo", srcs = ["foo.cc"], hdrs = ["foo.h"], deps = [ ":bar", ":baz", ], ) cc_shared_library( name = "bar_shared", shared_lib_name = "bar.so", deps = [":bar"], ) cc_library( name = "bar", srcs = ["bar.cc"], hdrs = ["bar.h"], ) cc_library( name = "baz", srcs = ["baz.cc"], hdrs = ["baz.h"], )
在這個範例中,foo_shared
會靜態連結 foo
和 baz
,後者是傳遞式依附元件。系統已由 dynamic_dep
bar_shared
動態提供 bar
,因此不會連結 bar
。
foo_shared
會使用連結器指令碼 *.lds 檔案,控管應匯出的符號。cc_shared_library
規則邏輯不會控制要匯出的符號,只會使用假設要匯出的符號,在分析階段提供錯誤訊息 (如果兩個共用程式庫匯出相同的目標)。
系統會假設 cc_shared_library
的每個直接依附元件都會匯出。因此,Bazel 在分析期間會假設 foo
是由 foo_shared
匯出。系統不會假設 baz
是由 foo_shared
匯出。系統也會假設 exports_filter
比對到的每個目標都會匯出。
範例中的每個 cc_library
最多只能出現在一個 cc_shared_library
中。如果我們想將 baz
連結至 bar_shared
,就必須將 tags = ["LINKABLE_MORE_THAN_ONCE"]
新增至 baz
。
由於 shared_lib_name
屬性,bar_shared
產生的檔案名稱會是 bar.so
,而非 Linux 上的預設名稱 libbar.so
。
錯誤
Two shared libraries in dependencies export the same symbols.
只要您建立的目標含有兩個匯出相同目標的不同 cc_shared_library
依附元件,就會發生這種情況。如要修正這個問題,您必須停止在其中一個 cc_shared_library
依附元件中匯出程式庫。
Two shared libraries in dependencies link the same library statically
只要您建立新 cc_shared_library
時,其中包含兩個不同的 cc_shared_library
依附元件,且這些依附元件會靜態連結相同的目標,就會發生這種情況。與匯出錯誤類似。
修正這個問題的方法之一,是停止將程式庫連結至其中一個 cc_shared_library
依附元件。同時,仍連結該程式庫的應用程式需要匯出該程式庫,以便未連結該程式庫的應用程式可繼續查看該程式庫中的符號。另一種方法是提取匯出目標的第三方程式庫。第三種方法是使用 LINKABLE_MORE_THAN_ONCE
標記問題來源 cc_library
,但這種修正方式應極少使用,您必須確保 cc_library
確實可安全地重複連結。
'//foo:foo' is already linked statically in '//bar:bar' but not exported`
這表示 deps
遞移閉合中的程式庫可供存取,且不必經過其中一個 cc_shared_library
依附元件,但已連結至 dynamic_deps
中的不同 cc_shared_library
,且未匯出。
解決方法是從 cc_shared_library
依附元件匯出,或提取匯出該依附元件的第三方 cc_shared_library
。
Do not place libraries which only contain a precompiled dynamic library in deps.
如果您有預先編譯的動態程式庫,則不需要且無法將其靜態連結至您目前正在建立的 cc_shared_library
目標。因此,它不屬於 cc_shared_library
的 deps
。如果這個預先編譯的動態程式庫是 cc_libraries
其中一個的依附元件,則 cc_library
需要直接依附該程式庫。
Trying to export a library already exported by a different shared library
如果您在目前的規則中聲明要匯出目標,而該目標已由其中一個動態依附元件匯出,系統就會顯示這則錯誤訊息。
如要修正這個問題,請從 deps
中移除目標,並只從動態依附元件中依賴該目標,或是確認 exports_filter
不會擷取這個目標。
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
deps
|
標籤清單;預設為
只要這些直接依附元件的任何間接程式庫依附元件尚未在
在分析期間,規則實作會將
當相同程式庫靜態連結至多個 |
additional_linker_inputs
|
標籤清單;預設為 user_link_flags 屬性執行這項操作。 |
dynamic_deps
|
標籤清單;預設為 cc_shared_library 依附元件。
|
experimental_disable_topo_sort_do_not_use_remove_before_7_0
|
布林值;預設值為 |
exports_filter
|
字串清單;預設為
任何目標
請注意,這個屬性實際上並不會在這些目標中新增依附元件邊緣,而是應由 以下語法是允許的:
|
roots
|
標籤清單;預設為 |
shared_lib_name
|
字串;預設為 |
static_deps
|
字串清單;預設為 |
user_link_flags
|
字串清單;預設為
|
win_def_file
|
標籤;預設為 只有在 Windows 是目標平台時,才應使用這個屬性。可在連結共用程式庫時 匯出符號。 |
cc_static_library
查看規則來源cc_static_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
--experimental_cc_static_library
旗標搭配使用。
根據目標清單及其間接依附元件,產生靜態資料庫。產生的靜態資料庫包含 deps
中列出的目標物件檔案,以及其間接依附元件,並將偏好設定給 PIC
物件。
輸出群組
linkdeps
文字檔案,其中包含 deps
中列出的目標的傳遞依附元件標籤,這些目標並未為靜態資料庫提供任何物件檔案,但至少提供一個靜態、動態或介面資料庫。產生的靜態資料庫可能會要求這些程式庫在連結時可用。
linkopts
文字檔案,其中包含使用者提供的 linkopts
,列出 deps
中列出的目標的所有傳遞依附元件。
重複符號
根據預設,cc_static_library
規則會檢查產生的靜態程式庫是否包含任何重複的符號。如果是這樣,建構作業就會失敗,並顯示列出重複符號和包含這些符號的物件檔案的錯誤訊息。
您可以設定 features = ["-symbol_check"]
,或透過 --features=-symbol_check
全面停用每個目標或每個套件的這項檢查。
symbol_check
的工具鍊支援
搭配 Bazel 提供的自動設定 C++ 工具鍊,可在所有平台上支援 symbol_check
功能。自訂工具鍊可以透過下列兩種方式之一新增支援:
- 實作
ACTION_NAMES.validate_static_library
動作,並透過symbol_check
功能啟用該動作。在動作中設定的工具會透過兩個引數叫用:用於檢查重複符號的靜態資料庫,以及在檢查通過時必須建立的檔案路徑。 - 讓
symbol_check
功能新增封存器旗標,導致建立靜態資料庫的動作在重複符號上失敗。
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
deps
|
標籤清單;預設為 靜態程式庫不會納入未提供任何物件檔案的依附元件,但會在 |
cc_test
查看規則來源cc_test(name, deps, srcs, data, additional_linker_inputs, args, compatible_with, conlyopts, copts, cxxopts, defines, deprecation, distribs, dynamic_deps, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, hdrs_check, includes, licenses, link_extra_lib, linkopts, linkshared, linkstatic, local, local_defines, malloc, module_interfaces, nocopts, reexport_deps, restricted_to, shard_count, size, stamp, tags, target_compatible_with, testonly, timeout, toolchains, visibility, win_def_file)
cc_test()
規則會編譯測試。在本例中,測試是指包裝某些測試程式碼的二進位檔。
根據預設,C++ 測試會以動態連結方式連結。
如要將單元測試連結為靜態,請指定 linkstatic=True
。建議您註解為何測試需要 linkstatic
;這可能不是很明顯。
隱含輸出目標
name.stripped
(僅在明確要求時建構):經過精簡的二進位檔版本。strip -g
會在二進位檔上執行,以移除偵錯符號。您可以使用--stripopt=-foo
在指令列上提供其他去除選項。name.dwp
(僅在明確要求時才建構):如果已啟用 Fission:偵錯資訊套件檔案,適合用於偵錯遠端部署的二進位檔。否則:空白檔案。
請參閱 cc_binary() 引數,但測試的 stamp
引數預設為 0,且 cc_test
具有額外的
所有測試規則 (*_test) 通用的屬性。
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
deps
|
標籤清單;預設為 這些可以是 |
srcs
|
標籤清單;預設為 系統會編譯所有 純粹的彙整器檔案 (.s、.asm) 不會經過預先處理,通常會使用彙整器建構。經過預處理的彙整檔案 (.S) 會經過預處理,並通常使用 C/C++ 編譯器建構。 系統不會編譯 所有已
如果
允許的
... 以及產生這些檔案的任何規則 (例如 |
data
|
標籤清單;預設為 data 的一般註解,請參閱「大多數建構規則定義的常見屬性」。如果 如果 C++ 程式碼可以存取這些資料檔案,如下所示:
|
additional_linker_inputs
|
標籤清單;預設為 例如,您可以在此提供已編譯的 Windows .res 檔案,以便嵌入二進位目標。 |
conlyopts
|
字串清單;預設為 |
copts
|
字串清單;預設為
這個屬性中的每個字串都會依照指定順序新增至
如果套件宣告功能
|
cxxopts
|
字串清單;預設為 |
defines
|
字串清單;預設為 -D ,然後新增至這個目標的編譯指令行,以及依附於該目標的每個規則。請務必謹慎操作,因為這可能會造成廣泛的影響。如有疑問,請改為將定義值新增至 local_defines 。 |
dynamic_deps
|
標籤清單;預設為 cc_shared_library 依附元件。
|
hdrs_check
|
字串;預設為 |
includes
|
字串清單;預設為 -isystem path_to_package/include_entry 。這項功能僅適用於不符合 Google 寫法風格的第三方程式庫 #include 陳述式。與 COPTS 不同的是,這些標記會新增至此規則和所有依附此規則的規則。(注意:不是依附的規則!)請務必謹慎操作,因為這可能會造成廣泛的影響。如有疑問,請改為在 COPTS 中加入「-I」標記。
新增的 |
link_extra_lib
|
標籤;預設為
根據預設,C++ 二進位檔會連結至 |
linkopts
|
字串清單;預設為 LINKOPTS 。
這個清單中每個元素的開頭不是 |
linkshared
|
布林值;預設值為 linkshared=True 。這個選項預設為關閉。
這個標記的存在表示連結會將
如果您同時指定 |
linkstatic
|
布林值;預設值為 cc_binary 和 cc_test :在靜態模式中連結二進位檔。如為 cc_library.link_static :請參閱下文。根據預設,這個選項會為
如果已啟用,且這是二進位檔或測試,這個選項會指示建構工具盡可能連結 實際上有三種不同的方式可以連結可執行檔:
如果
如果
在正式環境中,使用 |
local_defines
|
字串清單;預設為 -D ,然後新增至此目標的編譯指令行,但不新增至其依附項目。 |
malloc
|
標籤;預設為
根據預設,C++ 二進位檔會連結至 |
module_interfaces
|
標籤清單;預設為 C++ 標準對模組介面檔案副檔名沒有限制
使用方式受到 |
nocopts
|
字串;預設為 COPTS 中移除任何符合此規則運算式的先前 COPTS (包括規則 copts 屬性中明確指定的值)。這個屬性不應在 third_party 以外的情況下使用或需要。除了「Make」變數替換之外,系統不會以任何方式預先處理這些值。 |
reexport_deps
|
標籤清單;預設為 |
stamp
|
整數;預設值為
除非依附元件變更,否則系統不會重新建構經過標記的二進位檔。 |
win_def_file
|
標籤;預設為 只有在 Windows 是目標平台時,才應使用這個屬性。可在連結共用程式庫時 匯出符號。 |
cc_toolchain
查看規則來源cc_toolchain(name, all_files, ar_files, as_files, compatible_with, compiler_files, compiler_files_without_includes, coverage_files, deprecation, distribs, dwp_files, dynamic_runtime_lib, exec_compatible_with, exec_properties, exec_transition_for_inputs, features, libc_top, licenses, linker_files, module_map, objcopy_files, output_licenses, restricted_to, static_runtime_lib, strip_files, supports_header_parsing, supports_param_files, tags, target_compatible_with, testonly, toolchain_config, toolchain_identifier, toolchains, visibility)
代表 C++ 工具鍊。
此規則負責:
-
收集執行 C++ 動作所需的所有構件。這項操作會透過
all_files
、compiler_files
、linker_files
或其他以_files
結尾的屬性完成。這些屬性通常是用來將所有必要檔案納入檔案群組。 -
為 C++ 動作產生正確的命令列。這項操作是使用
CcToolchainConfigInfo
供應器完成的 (詳情請見下文)。
使用 toolchain_config
屬性設定 C++ 工具鍊。如要進一步瞭解 C++ 工具鍊設定和工具鍊選取說明文件,請參閱這個
頁面
。
使用 tags = ["manual"]
可避免在叫用 bazel build //...
時,不必要地建構及設定工具鍊
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
all_files
|
標籤;必填 收集所有 cc_toolchain 構件。這些構件會新增為所有 rules_cc 相關動作的輸入內容 (使用屬性中更精確的構件集的動作除外)。Bazel 會假設all_files 是所有其他提供構件屬性的超集 (例如,連結標記編譯作業需要編譯和連結檔案,因此會採用 all_files )。
這是 |
ar_files
|
標籤;預設為 |
as_files
|
標籤;預設為 |
compiler_files
|
標籤;必填 收集編譯動作所需的所有 cc_toolchain 構件。 |
compiler_files_without_includes
|
標籤;預設為 |
coverage_files
|
標籤;預設為 |
dwp_files
|
標籤;必填 收集 dwp 動作所需的所有 cc_toolchain 構件。 |
dynamic_runtime_lib
|
標籤;預設為 當您啟用「static_link_cpp_runtimes」功能,並且要動態連結依附元件時,就會使用這個選項。 |
exec_transition_for_inputs
|
布林值;預設值為 |
libc_top
|
標籤;預設為 |
linker_files
|
標籤;必填 收集連結動作所需的所有 cc_toolchain 構件。 |
module_map
|
標籤;預設為 |
objcopy_files
|
標籤;必填 收集 objcopy 動作所需的所有 cc_toolchain 構件。 |
output_licenses
|
字串清單;預設為 |
static_runtime_lib
|
標籤;預設為 當您啟用「static_link_cpp_runtimes」功能,並且要以靜態方式連結依附元件時,系統就會使用這個值。 |
strip_files
|
標籤;必填 收集所有去除動作所需的 cc_toolchain 構件。 |
supports_header_parsing
|
布林值;預設值為 |
supports_param_files
|
布林值;預設值為 |
toolchain_config
|
標籤;必填 提供cc_toolchain_config_info 的規則標籤。 |
toolchain_identifier
|
字串;預設為
在問題 #5380 修正前,這是建議將 |
cc_toolchain_suite
查看規則來源cc_toolchain_suite(name, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
已淘汰:此規則不會執行任何操作,且將遭到移除。
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
fdo_prefetch_hints
查看規則來源fdo_prefetch_hints(name, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, profile, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
代表工作區中 FDO 預先擷取提示設定檔。範例:
fdo_prefetch_hints(
name = "hints",
profile = "//path/to/hints:profile.afdo",
)
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
profile
|
標籤;必填 提示設定檔的標籤。提示檔案的副檔名為 .afdo。標籤也可以指向 fdo_absolute_path_profile 規則。 |
fdo_profile
查看規則來源fdo_profile(name, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, memprof_profile, profile, proto_profile, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
代表工作區中的 FDO 設定檔。範例:
fdo_profile(
name = "fdo",
profile = "//path/to/fdo:profile.zip",
)
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
memprof_profile
|
標籤;預設為 |
profile
|
標籤;必填 FDO 設定檔或產生該設定檔的規則的標籤。FDO 檔案可以有下列其中一個副檔名:.profraw 用於未編入索引的 LLVM 設定檔、.profdata 用於已編入索引的 LLVM 設定檔、.zip 用於儲存 LLVM profraw 設定檔、.afdo 用於 AutoFDO 設定檔、.xfdo 用於 XBinary 設定檔。標籤也可以指向 fdo_absolute_path_profile 規則。 |
proto_profile
|
標籤;預設為 |
memprof_profile
查看規則來源memprof_profile(name, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, profile, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
代表工作區中的 MEMPROF 設定檔。範例:
memprof_profile(
name = "memprof",
profile = "//path/to/memprof:profile.afdo",
)
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
profile
|
標籤;必填 MEMPROF 設定檔的標籤。設定檔應具有 .profdata 副檔名 (針對已編入索引/符號化的 memprof 設定檔),或是 .zip 副檔名 (針對內含 memprof.profdata 檔案的 ZIP 檔案)。標籤也可以指向 fdo_absolute_path_profile 規則。 |
propeller_optimize
查看規則來源propeller_optimize(name, cc_profile, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, ld_profile, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
代表工作區中的 Propeller 最佳化設定檔。範例:
propeller_optimize(
name = "layout",
cc_profile = "//path:cc_profile.txt",
ld_profile = "//path:ld_profile.txt"
)
引數
屬性 | |
---|---|
name |
名稱;必填 這個目標的專屬名稱。 |
cc_profile
|
標籤;必填 傳遞至各種編譯動作的設定檔標籤。這個檔案的副檔名為 .txt。 |
ld_profile
|
標籤;必填 傳遞至連結動作的設定檔標籤。這個檔案的副檔名為 .txt。 |