规则
- cc_binary
- cc_import
- cc_library
- cc_proto_library
- cc_shared_library
- cc_static_library
- fdo_prefetch_hints
- fdo_profile
- memprof_profile
- propeller_optimize
- cc_test
- cc_toolchain
- cc_toolchain_suite
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, link_extra_lib, 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 |
名称;必需 此目标的唯一名称。 |
deps
|
标签列表;默认值为 这些可以是 |
srcs
|
标签列表;默认值为 系统会编译所有 系统不会编译 所有 如果某个规则的名称在
允许的
...以及生成这些文件的任何规则。 不同的扩展名表示不同的编程语言,具体取决于 gcc 惯例。 |
additional_linker_inputs
|
标签列表;默认值为 例如,您可以在此处提供已编译的 Windows .res 文件,以便将其嵌入到二进制目标中。 |
copts
|
字符串列表;默认值为
在编译二进制目标之前,此属性中的每个字符串都会按给定顺序添加到
如果软件包声明了功能
|
defines
|
字符串列表;默认值为 -D ,并添加到此目标的编译命令行以及依赖于它的每个规则中。请务必谨慎,因为这可能会产生深远影响。如果不确定,请改为向 local_defines 添加定义值。
|
includes
|
字符串列表;默认值为
需遵循“Make 变量”替换规则。
每个字符串都以 必须将头文件添加到 srcs 或 hdrs,否则在编译沙盒化(默认)时,依赖项规则将无法使用这些头文件。 |
link_extra_lib
|
标签;默认值为
默认情况下,C++ 二进制文件会与 |
linkopts
|
字符串列表;默认值为 LINKOPTS 。
此列表中不以 |
linkshared
|
布尔值;不可配置;默认值为 linkshared=True 。默认情况下,此选项处于关闭状态。
此标志的存在表示
如果您同时指定 |
linkstatic
|
布尔值;默认值为 cc_binary 和 cc_test :在静态模式下关联二进制文件。对于 cc_library.linkstatic :请参阅下文。
默认情况下,此选项对
如果启用此选项且这是二进制文件或测试,则此选项会告知构建工具尽可能为用户库链接 实际上,有三种不同的方式可以关联可执行文件:
如果将
如果为 |
local_defines
|
字符串列表;默认值为 -D ,并添加到此目标的编译命令行,但不会添加到其依赖项。
|
malloc
|
标签;默认值为
默认情况下,C++ 二进制文件会与 |
nocopts
|
字符串;默认值为 COPTS 中移除与此正则表达式匹配的任何现有 COPTS (包括在规则的 copts 属性中明确指定的值)。
您很少需要使用此属性。
|
stamp
|
整数;默认为
除非其依赖项发生变化,否则不会重新构建带有标记的二进制文件。 |
win_def_file
|
标签;默认值为 仅当 Windows 是目标平台时,才应使用此属性。 它可用于在关联共享库时 导出符号。 |
cc_import
查看规则源代码cc_import(name, deps, 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, )
cc_import( name = "mylib", hdrs = ["mylib.h"], shared_library = "libmylib.so", )
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
相关联 (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", ) # 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, )
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, )
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 的一般说明,请参阅大多数 build 规则定义的典型属性。
|
hdrs
|
标签列表;默认值为 |
alwayslink
|
布尔值;默认值为 如果 alwayslink 不适用于 Windows 上的 VS 2017,这是由于存在已知问题,请将 VS 2017 升级到最新版本。 |
interface_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, 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)
标头包含性检查
构建过程中使用的所有头文件都必须在 cc_*
规则的 hdrs
或 srcs
中声明。系统会强制执行此规则。
对于 cc_library
规则,hdrs
中的头文件构成了库的公共接口,可以直接从库本身的 hdrs
和 srcs
中的文件以及在 deps
中列出库的 cc_*
规则的 hdrs
和 srcs
中的文件中包含。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 使用此功能。
参数
属性 | |
---|---|
name |
名称;必需 此目标的唯一名称。 |
deps
|
标签列表;默认值为 这些可以是 |
srcs
|
标签列表;默认值为 系统会编译所有 系统不会编译 所有 如果某个规则的名称在
允许的
...以及生成这些文件的任何规则。 不同的扩展名表示不同的编程语言,具体取决于 gcc 惯例。 |
hdrs
|
标签列表;默认值为 这是声明用于描述库接口的头文件的首选位置。这些标头将可供此规则或依赖规则中的来源包含。
不应由此库的客户端包含的标头应改为列在 |
additional_compiler_inputs
|
标签列表;默认值为 |
additional_linker_inputs
|
标签列表;默认值为 例如,您可以在此处提供已编译的 Windows .res 文件,以便将其嵌入到二进制目标中。 |
alwayslink
|
布尔值;默认值为 srcs 中列出的文件的所有对象文件,即使其中一些文件不包含二进制文件引用的符号也是如此。如果二进制文件中的代码未明确调用您的代码(例如,您的代码注册接收某些服务提供的回调),此方法会很有用。
如果 alwayslink 不适用于 Windows 上的 VS 2017,这是由于存在已知问题,请将 VS 2017 升级到最新版本。 |
copts
|
字符串列表;默认值为
在编译二进制目标之前,此属性中的每个字符串都会按给定顺序添加到
如果软件包声明了功能
|
defines
|
字符串列表;默认值为 -D ,并添加到此目标的编译命令行以及依赖于它的每个规则中。请务必谨慎,因为这可能会产生深远影响。如果不确定,请改为向 local_defines 添加定义值。
|
implementation_deps
|
标签列表;默认值为 deps 不同,这些库(及其所有传递依赖项)的头文件和包含路径仅用于编译此库,而非依赖于此库的库。使用 implementation_deps 指定的库仍会在依赖于此库的二进制目标中关联。
目前,此功能仅限于 cc_libraries,并由标志 |
include_prefix
|
字符串;默认值为 设置后,此规则的 系统会先移除 |
includes
|
字符串列表;默认值为
需遵循“Make 变量”替换规则。
每个字符串都以 必须将头文件添加到 srcs 或 hdrs,否则在编译沙盒化(默认)时,依赖项规则将无法使用这些头文件。 |
linkopts
|
字符串列表;默认值为 LINKOPTS 。
此列表中不以 |
linkstamp
|
标签;默认值为 base 软件包中使用。
|
linkstatic
|
布尔值;默认值为 cc_binary 和 cc_test :在静态模式下关联二进制文件。对于 cc_library.linkstatic :请参阅下文。
默认情况下,此选项对
如果启用此选项且这是二进制文件或测试,则此选项会告知构建工具尽可能为用户库链接 实际上,有三种不同的方式可以关联可执行文件:
如果将
如果为 |
local_defines
|
字符串列表;默认值为 -D ,并添加到此目标的编译命令行,但不会添加到其依赖项。
|
nocopts
|
字符串;默认值为 COPTS 中移除与此正则表达式匹配的任何现有 COPTS (包括在规则的 copts 属性中明确指定的值)。
您很少需要使用此属性。
|
strip_include_prefix
|
字符串;默认值为 设置后,此规则的 如果是相对路径,则视为相对于软件包的路径。如果是绝对路径,则会被视为相对于代码库的路径。
|
textual_hdrs
|
标签列表;默认值为 此位置用于声明无法单独编译的头文件;也就是说,这些头文件始终需要由其他源文件以文本形式包含,才能构建有效的代码。 |
win_def_file
|
标签;默认值为 仅当 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 |
名称;必需 此目标的唯一名称。 |
deps
|
标签列表;默认值为 proto_library 规则列表。
|
cc_shared_library
查看规则源代码cc_shared_library(name, deps, additional_linker_inputs, dynamic_deps, exports_filter, shared_lib_name, tags, user_link_flags, 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
静态链接起来,后者是传递依赖项。它不会关联 bar
,因为 dynamic_dep
bar_shared
已动态提供该实例。
foo_shared
使用链接器脚本 *.lds 文件来控制应导出的符号。cc_shared_library
规则逻辑不会控制导出的符号,它只会使用假定要导出的符号,以便在分析阶段如果两个共享库导出相同的目标时,报告错误。
系统会假定 cc_shared_library
的每个直接依赖项都已导出。因此,在分析期间,Bazel 会假定 foo_shared
正在导出 foo
。不假定 foo_shared
会导出 baz
。系统还会假定 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 依赖项。
|
exports_filter
|
字符串列表;默认值为
任何目标
请注意,此属性实际上不会向这些目标添加依赖项边,而是应由 允许使用以下语法:
|
shared_lib_name
|
字符串;默认值为 |
user_link_flags
|
字符串列表;默认值为 cc_shared_library( name = "foo_shared", additional_linker_inputs = select({ "//src/conditions:linux": [ ":foo.lds", ":additional_script.txt", ], "//conditions:default": []}), user_link_flags = select({ "//src/conditions:linux": [ "-Wl,-rpath,kittens", "-Wl,--version-script=$(location :foo.lds)", "-Wl,--script=$(location :additional_script.txt)", ], "//conditions:default": []}), ... ) |
win_def_file
|
标签;默认值为 仅当 Windows 是目标平台时,才应使用此属性。 它可用于在关联共享库时 导出符号。 |
cc_static_library
查看规则源代码cc_static_library(name, deps, tags)
生成的静态库包含 deps
中列出的目标的对象文件以及它们的传递依赖项,其中优先考虑 PIC
对象。
输出组
linkdeps
一个文本文件,其中包含 deps
中列出的目标的传递依赖项的标签。这些传递依赖项未向静态库贡献任何对象文件,但确实提供了至少一个静态、动态或接口库。生成的静态库可能需要这些库在链接时可用。
linkopts
一个文本文件,其中包含 deps
中列出的目标的所有传递依赖项的用户提供的 linkopts
。
符号重复
默认情况下,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
|
标签列表;默认值为 不提供任何对象文件的依赖项不会包含在静态库中,但其标签会收集在 |
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 |
名称;必需 此目标的唯一名称。 |
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 |
名称;必需 此目标的唯一名称。 |
absolute_path_profile
|
字符串;默认值为 |
profile
|
标签;默认值为 |
proto_profile
|
标签;默认值为 |
memprof_profile
查看规则源代码memprof_profile(name, absolute_path_profile, compatible_with, deprecation, distribs, features, licenses, profile, restricted_to, tags, target_compatible_with, testonly, visibility)
表示位于工作区或指定绝对路径中的 MEMPROF 配置文件。示例:
memprof_profile( name = "memprof", profile = "//path/to/memprof:profile.afdo", ) memprof_profile( name = "memprof_abs", absolute_path_profile = "/absolute/path/profile.afdo", )
参数
属性 | |
---|---|
name |
名称;必需 此目标的唯一名称。 |
absolute_path_profile
|
字符串;默认值为 |
profile
|
标签;默认值为 |
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 |
名称;必需 此目标的唯一名称。 |
ld_profile
|
标签;默认值为 |
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, link_extra_lib, 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 |
名称;必需 此目标的唯一名称。 |
deps
|
标签列表;默认值为 这些可以是 |
srcs
|
标签列表;默认值为 系统会编译所有 系统不会编译 所有 如果某个规则的名称在
允许的
...以及生成这些文件的任何规则。 不同的扩展名表示不同的编程语言,具体取决于 gcc 惯例。 |
additional_linker_inputs
|
标签列表;默认值为 例如,您可以在此处提供已编译的 Windows .res 文件,以便将其嵌入到二进制目标中。 |
copts
|
字符串列表;默认值为
在编译二进制目标之前,此属性中的每个字符串都会按给定顺序添加到
如果软件包声明了功能
|
defines
|
字符串列表;默认值为 -D ,并添加到此目标的编译命令行以及依赖于它的每个规则中。请务必谨慎,因为这可能会产生深远影响。如果不确定,请改为向 local_defines 添加定义值。
|
includes
|
字符串列表;默认值为
需遵循“Make 变量”替换规则。
每个字符串都以 必须将头文件添加到 srcs 或 hdrs,否则在编译沙盒化(默认)时,依赖项规则将无法使用这些头文件。 |
link_extra_lib
|
标签;默认值为
默认情况下,C++ 二进制文件会与 |
linkopts
|
字符串列表;默认值为 LINKOPTS 。
此列表中不以 |
linkstatic
|
布尔值;默认值为 cc_binary 和 cc_test :在静态模式下关联二进制文件。对于 cc_library.linkstatic :请参阅下文。
默认情况下,此选项对
如果启用此选项且这是二进制文件或测试,则此选项会告知构建工具尽可能为用户库链接 实际上,有三种不同的方式可以关联可执行文件:
如果将
如果为 |
local_defines
|
字符串列表;默认值为 -D ,并添加到此目标的编译命令行,但不会添加到其依赖项。
|
malloc
|
标签;默认值为
默认情况下,C++ 二进制文件会与 |
nocopts
|
字符串;默认值为 COPTS 中移除与此正则表达式匹配的任何现有 COPTS (包括在规则的 copts 属性中明确指定的值)。
您很少需要使用此属性。
|
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_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_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
|
标签;默认值为 归档操作所需的所有 cc_toolchain 工件集合。 |
as_files
|
标签;默认值为 汇编操作所需的所有 cc_toolchain 工件的集合。 |
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 工件集合。 |
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)
表示一组 C++ 工具链。
此规则负责:
- 收集所有相关的 C++ 工具链。
-
根据传递给 Bazel 的
--cpu
和--compiler
选项选择一个工具链。
如需查看详细的 C++ 工具链配置和工具链选择文档,请参阅此 页面 。
参数
属性 | |
---|---|
name |
名称;必需 此目标的唯一名称。 |
toolchains
|
将“<cpu>”或“<cpu>|<compiler>”字符串映射到 cc_toolchain 标签的映射。如果仅将 --cpu 传递给 Bazel,则使用“<cpu>”;如果将 --cpu 和 --compiler 都传递给 Bazel,则使用“<cpu>|<compiler>”。示例:
cc_toolchain_suite( name = "toolchain", toolchains = { "piii|gcc": ":my_cc_toolchain_for_piii_using_gcc", "piii": ":my_cc_toolchain_for_piii_using_default_compiler", }, ) |