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 文件可以直接包含 在 srcs 或下列任何规则的 hdrsdeps 参数。

所有 #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

...以及生成这些文件的任何规则。 不同的扩展表示 。

additional_linker_inputs

List of labels; optional

将这些文件传递给 C++ 链接器命令。

例如,您可以在此处提供经过编译的 Windows .res 文件, 二进制目标。

copts

List of strings; optional

将这些选项添加到 C++ 编译命令中。 需遵循 "Make variable" 替换和 Bourne shell 令牌化

此属性中的每个字符串都会按照指定顺序添加到 COPTS 中, 编译二进制目标的过程这些标志仅在编译此目标时有效,而不会在编译此目标时生效 因此请注意别处包含的头文件。所有路径都应 相对于工作区,而不是当前软件包。

如果该软件包声明了 featureno_copts_tokenization,Bourne shell 标记化仅适用于字符串 其中包含一个“品牌”变量。

defines

List of strings; optional

要添加到编译行的定义列表。 受“品牌”的约束变量替换和 Bourne shell 令牌化。 每个字符串都必须由单个 Bourne shell 令牌组成, 前缀为 -D,并添加到编译命令行中, 以及依赖于该规则的每条规则请务必小心, 产生深远的影响。如有疑问,请将定义值添加到 local_defines
includes

List of strings; optional

要添加到编译行的 include 目录列表。

需遵循替换 "Make variable" 的规定。 每个字符串都带有 -isystem 前缀,并添加到 COPTS 中。 与 COPTS 不同,系统会为此规则添加这些标记 以及依赖于它的所有规则(注意:并非其所依赖的规则!)是 必须格外小心,因为这可能会造成深远的影响。如有疑问,请添加 “-I”标志更改为 COPTS

必须将标头添加到 srcs 或 hdrs 中,否则它们将无法供从属使用 使用沙盒(默认)编译时应遵循的规则。

linkopts

List of strings; optional

将这些标志添加到 C++ 链接器命令中。 受“品牌”的约束变量替换, <ph type="x-smartling-placeholder"></ph> Bourne shell 标记化 标签扩展。 此属性中的每个字符串都会先添加到 LINKOPTS 中, 链接二进制目标。

此列表中将出现每个不以 $- 开头的元素 假定为 deps 中目标的标签。通过 该目标生成的文件的列表会附加到链接器 选项。如果标签无效,或者 未在 deps 中声明。

linkshared

Boolean; optional; nonconfigurable; default is False

创建共享库。 要启用此属性,请在您的规则中添加 linkshared=True。默认情况下 此选项处于停用状态

此标志的存在表示使用 -shared 标志进行链接 gcc,这样生成的共享库适合加载到 Java 程序不过,出于构建目的,它绝不会链接到 因为假设使用 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)。 某些系统库可能仍然是动态链接的, 因为没有静态库因此生成的可执行文件仍会 处于关联状态,因此大部分都是静态的。

关联可执行文件其实有三种不同的方法:

  • 使用完全静态链接功能的 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 shell 令牌化。 每个字符串都必须由单个 Bourne shell 令牌组成, 前缀为 -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

是否将 build 信息编码到二进制文件中。可能的值: <ph type="x-smartling-placeholder">
    </ph>
  • stamp = 1:始终将 build 信息标记到二进制文件中,即使在 --nostamp build。 应避免使用,因为这可能会终止 二进制文件以及依赖于它的任何下游操作。
  • stamp = 0:始终用常量值替换 build 信息。本次 提供良好的构建结果缓存。
  • stamp = -1:build 信息的嵌入由 --[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.链接到静态或共享库
在 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++ 的任何二进制文件 预编译的库会链接至静态库中归档的所有对象文件, 即使其中一些不包含二进制文件引用的符号,也是如此。 如果 二进制文件。例如,如果您的代码注册以接收一些回调 提供的服务

如果 alwayslink 无法用于 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, additional_compiler_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)

标头包含性检查

build 中使用的所有头文件必须在 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

包含检查规则仅适用于直接 包含。在上面的示例中,foo.cc 可以 包括bar.h,其中可能包括baz.h, 允许 turn 包含 baz-impl.h。从技术上讲 编译 .cc 文件可能会以传递方式包含任何头文件 文件放在 hdrssrcs 传递 deps 闭包中的任何 cc_library。在 在这种情况下,编译器可能会读取 baz.hbaz-impl.h 编译 foo.cc 时,但 foo.cc 不得 包含“#include "baz.h"”。为此 允许,必须将 baz 添加到 depsfoo 个。

遗憾的是,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 文件可以直接包含 在 srcs 或下列任何规则的 hdrsdeps 参数。

所有 #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

...以及生成这些文件的任何规则。 不同的扩展表示 。

hdrs

List of labels; optional

发布的 将此库直接包含在依赖规则中。

这是声明 描述该库的接口这些标头 以供来源添加到此规则或依赖规则中。 此库的客户端不应包含的标头应 在 srcs 属性中列出,即使它们位于 包含的公共文档资源。请参阅“标头包含” ”查看更详细的说明。

additional_compiler_inputs

List of labels; optional

您可能想要传递给编译器命令行的任何其他文件,例如 sanitizer 忽略列表等。随后,您便可以在 copts 中使用 $(location) 函数。

Boolean; optional; default is False

如果为 1,则表示(直接或间接)依赖于此 C++ 的任何二进制文件 会链接至 srcs,即使其中一些不包含二进制文件引用的符号也是如此。 如果 二进制文件。例如,如果您的代码注册以接收一些回调 提供的服务

如果 alwayslink 无法用于 Windows 上的 VS 2017,原因在于 已知问题, 请将 VS 2017 升级到最新版本。

copts

List of strings; optional

将这些选项添加到 C++ 编译命令中。 需遵循 "Make variable" 替换和 Bourne shell 令牌化

此属性中的每个字符串都会按照指定顺序添加到 COPTS 中, 编译二进制目标的过程这些标志仅在编译此目标时有效,而不会在编译此目标时生效 因此请注意别处包含的头文件。所有路径都应 相对于工作区,而不是当前软件包。

如果该软件包声明了 featureno_copts_tokenization,Bourne shell 标记化仅适用于字符串 其中包含一个“品牌”变量。

defines

List of strings; optional

要添加到编译行的定义列表。 受“品牌”的约束变量替换和 Bourne shell 令牌化。 每个字符串都必须由单个 Bourne shell 令牌组成, 前缀为 -D,并添加到编译命令行中, 以及依赖于该规则的每条规则请务必小心, 产生深远的影响。如有疑问,请将定义值添加到 local_defines
implementation_deps

List of labels; optional

库目标所依赖的其他库的列表。取消 deps,这些库(及其所有库)的头文件和 include 路径 传递依赖项)仅用于编译此库,而不会用于 一切都依赖于它使用 implementation_deps 指定的库仍然链接到 依赖于此库的二进制文件目标

目前,此用法仅限于 cc_library,并由标志保护 --experimental_cc_implementation_deps

include_prefix

String; optional

要添加到此规则标头的路径中的前缀。

设置后,此规则的 hdrs 属性中的标头可供访问 at 是该属性的值,位于其代码库相对路径前面。

先移除 strip_include_prefix 属性中的前缀, 前缀。

includes

List of strings; optional

要添加到编译行的 include 目录列表。

需遵循替换 "Make variable" 的规定。 每个字符串都带有 -isystem 前缀,并添加到 COPTS 中。 与 COPTS 不同,系统会为此规则添加这些标记 以及依赖于它的所有规则(注意:并非其所依赖的规则!)是 必须格外小心,因为这可能会造成深远的影响。如有疑问,请添加 “-I”标志更改为 COPTS

必须将标头添加到 srcs 或 hdrs 中,否则它们将无法供从属使用 使用沙盒(默认)编译时应遵循的规则。

linkopts

List of strings; optional

将这些标志添加到 C++ 链接器命令中。 受“品牌”的约束变量替换, <ph type="x-smartling-placeholder"></ph> Bourne shell 标记化 标签扩展。 此属性中的每个字符串都会先添加到 LINKOPTS 中, 链接二进制目标。

此列表中将出现每个不以 $- 开头的元素 假定为 deps 中目标的标签。通过 该目标生成的文件的列表会附加到链接器 选项。如果标签无效,或者 未在 deps 中声明。

linkstamp

Label; optional

同时编译指定的 C++ 源文件并将其关联到最终版本 二进制文件要引入时间戳,必须用这种伎俩 转换为二进制文件;如果我们将源文件编译为 对象文件,那么时间戳就会是错误的。 链接戳记编译不得包含任何 编译器标记,因此不应依赖于任何特定的 头文件、编译器选项或其他编译变量。 只有在 base 软件包。
linkstatic

Boolean; optional; default is False

对于cc_binarycc_test:以静态方式关联二进制文件 模式。对于 cc_library.linkstatic:请参阅下文。

默认情况下,系统会为 cc_binary 启用此选项,为其余设备关闭此选项。

如果已启用,并且是二进制文件或测试文件,此选项将指示构建工具加入 尽可能为用户库使用 .a(而非 .so)。 某些系统库可能仍然是动态链接的, 因为没有静态库因此生成的可执行文件仍会 处于关联状态,因此大部分都是静态的。

关联可执行文件其实有三种不同的方法:

  • 使用完全静态链接功能的 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 shell 令牌化。 每个字符串都必须由单个 Bourne shell 令牌组成, 前缀为 -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_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_绝对_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 配置文件的文件,或者包含 AutoFDO 配置文件的 .afdo。
profile

Label; optional

FDO 配置文件的标签或生成该配置文件的规则。FDO 文件可以包含 以下扩展名:.profraw 表示未编入索引的 LLVM 配置文件,.profdata 表示已编入索引的 LLVM 配置文件、包含 LLVM Profraw 配置文件的 .zip、用于 AutoFDO 配置文件的 .afdo、用于 XBinary 配置文件。该标签还可以指向 fdo_绝对_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 文件可以直接包含 在 srcs 或下列任何规则的 hdrsdeps 参数。

所有 #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

...以及生成这些文件的任何规则。 不同的扩展表示 。

additional_linker_inputs

List of labels; optional

将这些文件传递给 C++ 链接器命令。

例如,您可以在此处提供经过编译的 Windows .res 文件, 二进制目标。

copts

List of strings; optional

将这些选项添加到 C++ 编译命令中。 需遵循 "Make variable" 替换和 Bourne shell 令牌化

此属性中的每个字符串都会按照指定顺序添加到 COPTS 中, 编译二进制目标的过程这些标志仅在编译此目标时有效,而不会在编译此目标时生效 因此请注意别处包含的头文件。所有路径都应 相对于工作区,而不是当前软件包。

如果该软件包声明了 featureno_copts_tokenization,Bourne shell 标记化仅适用于字符串 其中包含一个“品牌”变量。

defines

List of strings; optional

要添加到编译行的定义列表。 受“品牌”的约束变量替换和 Bourne shell 令牌化。 每个字符串都必须由单个 Bourne shell 令牌组成, 前缀为 -D,并添加到编译命令行中, 以及依赖于该规则的每条规则请务必小心, 产生深远的影响。如有疑问,请将定义值添加到 local_defines
includes

List of strings; optional

要添加到编译行的 include 目录列表。

需遵循替换 "Make variable" 的规定。 每个字符串都带有 -isystem 前缀,并添加到 COPTS 中。 与 COPTS 不同,系统会为此规则添加这些标记 以及依赖于它的所有规则(注意:并非其所依赖的规则!)是 必须格外小心,因为这可能会造成深远的影响。如有疑问,请添加 “-I”标志更改为 COPTS

必须将标头添加到 srcs 或 hdrs 中,否则它们将无法供从属使用 使用沙盒(默认)编译时应遵循的规则。

linkopts

List of strings; optional

将这些标志添加到 C++ 链接器命令中。 受“品牌”的约束变量替换, <ph type="x-smartling-placeholder"></ph> Bourne shell 标记化 标签扩展。 此属性中的每个字符串都会先添加到 LINKOPTS 中, 链接二进制目标。

此列表中将出现每个不以 $- 开头的元素 假定为 deps 中目标的标签。通过 该目标生成的文件的列表会附加到链接器 选项。如果标签无效,或者 未在 deps 中声明。

linkstatic

Boolean; optional; default is False

对于cc_binarycc_test:以静态方式关联二进制文件 模式。对于 cc_library.linkstatic:请参阅下文。

默认情况下,系统会为 cc_binary 启用此选项,为其余设备关闭此选项。

如果已启用,并且是二进制文件或测试文件,此选项将指示构建工具加入 尽可能为用户库使用 .a(而非 .so)。 某些系统库可能仍然是动态链接的, 因为没有静态库因此生成的可执行文件仍会 处于关联状态,因此大部分都是静态的。

关联可执行文件其实有三种不同的方法:

  • 使用完全静态链接功能的 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 shell 令牌化。 每个字符串都必须由单个 Bourne shell 令牌组成, 前缀为 -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

是否将 build 信息编码到二进制文件中。可能的值: <ph type="x-smartling-placeholder">
    </ph>
  • stamp = 1:始终将 build 信息标记到二进制文件中,即使在 --nostamp build。 应避免使用,因为这可能会终止 二进制文件以及依赖于它的任何下游操作。
  • stamp = 0:始终用常量值替换 build 信息。本次 提供良好的构建结果缓存。
  • stamp = -1:build 信息的嵌入由 --[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_fileslinker_files 或以 _files 结尾的其他属性)。这些是 最常见的文件组。
  • 为 C++ 操作生成正确的命令行。为此,您可以使用 CcToolchainConfigInfo 提供方(详见下文)。

使用 toolchain_config 属性配置 C++ 工具链。 另请参阅此内容 <ph type="x-smartling-placeholder"></ph> 信息页 ,获取详细的 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 属性。这只是个提示 晚于 <ph type="x-smartling-placeholder"></ph> 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 属性。此后便是小操作 通过 CROSSTOOL 迁移到 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

用于模块化 build 的模块映射工件。
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

另请参阅此内容 <ph type="x-smartling-placeholder"></ph> 信息页 ,获取详细的 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",
            },
          )