Bazel 教程:配置 C++ 工具链

<ph type="x-smartling-placeholder"></ph> 报告问题 查看来源 敬上 每晚 · 7.3。 · 7.2。 · 7.1。 · 7.0。 · 6.5

本教程使用一个示例场景来说明如何配置 C++ 工具链。它基于 示例 C++ 项目 使用 clang 构建时不会出错。

学习内容

在本教程中,您将学习如何:

  • 设置构建环境
  • 配置 C++ 工具链
  • 创建一条 Starlark 规则, 配置 cc_toolchain,以便 Bazel 构建应用 与clang
  • 通过运行以下命令确认预期结果: bazel build --config=clang_config //main:hello-world(在 Linux 计算机上)
  • 构建 C++ 应用

准备工作

设置构建环境

本教程假定您使用的是 Linux,并且已成功构建 C++ 应用,并安装了相应的工具和库。 本教程使用 clang version 9.0.1,您可以将其安装在系统上。

请按以下步骤设置构建环境:

  1. 如果您还没有这样做 下载并安装 Bazel 0.23 或更高版本。

  2. 下载 示例 C++ 项目 并将其放在本地机器上的空目录中。

  3. 将以下 cc_binary 目标添加到 main/BUILD 文件中:

    cc_binary(
        name = "hello-world",
        srcs = ["hello-world.cc"],
    )
    
  4. 使用以下代码在工作区目录的根目录下创建一个 .bazelrc 文件: 以下内容以启用 --config 标志的使用:

    # Use our custom-configured c++ toolchain.
    
    build:clang_config --crosstool_top=//toolchain:clang_suite
    
    # Use --cpu as a differentiator.
    
    build:clang_config --cpu=k8
    
    # Use the default Bazel C++ toolchain to build the tools used during the
    # build.
    
    build:clang_config --host_crosstool_top=@bazel_tools//tools/cpp:toolchain
    

对于条目 build:{config_name} --flag=value,使用命令行标志 --config={config_name} 与该特定标志相关联。请参阅 所用标志的文档: crosstool_topcpuhost_crosstool_top

构建目标时 与 bazel build --config=clang_config //main:hello-world 结合使用时,Bazel 会使用您的 自定义工具链 cc_toolchain_suite //toolchain:clang_suite。该套件可能会列出 工具链,适用于不同 CPU 因此,它使用 --cpu=k8 标志进行了区分。

由于 Bazel 在构建期间使用许多用 C++ 编写的内部工具,例如 process-wrapper,则为 以便使用这些工具链(而非主机平台)构建这些工具, 本教程中创建的存储分区

配置 C++ 工具链

要配置 C++ 工具链,重复构建应用并消除 逐一检查每个错误。

  1. 使用以下命令运行构建:

    bazel build --config=clang_config //main:hello-world
    

    因为您在--crosstool_top=//toolchain:clang_suite .bazelrc 文件,则 Bazel 会抛出以下错误:

    No such package `toolchain`: BUILD file not found on package path.
    

    在工作区目录中,为软件包创建 toolchain 目录 并在 toolchain 目录下有一个空的 BUILD 文件。

  2. 再次运行构建。由于 toolchain 软件包尚未定义 clang_suite 目标,则 Bazel 会抛出以下错误:

    No such target '//toolchain:clang_suite': target 'clang_suite' not declared
    in package 'toolchain' defined by .../toolchain/BUILD
    

    toolchain/BUILD 文件中,定义一个空文件组,如下所示:

    package(default_visibility = ["//visibility:public"])
    
    filegroup(name = "clang_suite")
    
  3. 再次运行构建。Bazel 会抛出以下错误:

    '//toolchain:clang_suite' does not have mandatory providers: 'ToolchainInfo'
    

    Bazel 发现 --crosstool_top 标志指向的规则 没有提供必要的 ToolchainInfo 提供商。因此,您需要将 --crosstool_top 指向提供 ToolchainInfo - 即 cc_toolchain_suite 规则。在 toolchain/BUILD 文件,请将空文件组替换为以下代码:

    cc_toolchain_suite(
        name = "clang_suite",
        toolchains = {
            "k8": ":k8_toolchain",
        },
    )
    

    toolchains 属性会自动映射 --cpu(以及 --compiler)值更改为 cc_toolchain。您尚未 定义了任何 cc_toolchain 目标,Bazel 会指出这一点 。

  4. 再次运行构建。Bazel 会抛出以下错误:

    Rule '//toolchain:k8_toolchain' does not exist
    

    现在,您需要为cc_toolchain cc_toolchain_suite.toolchains 属性。将以下内容添加到 toolchain/BUILD 文件:

    filegroup(name = "empty")
    
    cc_toolchain(
        name = "k8_toolchain",
        toolchain_identifier = "k8-toolchain",
        toolchain_config = ":k8_toolchain_config",
        all_files = ":empty",
        compiler_files = ":empty",
        dwp_files = ":empty",
        linker_files = ":empty",
        objcopy_files = ":empty",
        strip_files = ":empty",
        supports_param_files = 0,
    )
    
  5. 再次运行构建。Bazel 会抛出以下错误:

    Rule '//toolchain:k8_toolchain_config' does not exist
    

    接下来,添加“:k8_toolchain_config”定位到 toolchain/BUILD 文件:

    filegroup(name = "k8_toolchain_config")
    
  6. 再次运行构建。Bazel 会抛出以下错误:

    '//toolchain:k8_toolchain_config' does not have mandatory providers:
    'CcToolchainConfigInfo'
    

    CcToolchainConfigInfo 是您用于配置 C++ 工具链。如需修正此错误,请创建 Starlark 规则 为 Bazel 提供CcToolchainConfigInfo功能,方法是 toolchain/cc_toolchain_config.bzl 文件,其中包含以下内容:

    def _impl(ctx):
        return cc_common.create_cc_toolchain_config_info(
            ctx = ctx,
            toolchain_identifier = "k8-toolchain",
            host_system_name = "local",
            target_system_name = "local",
            target_cpu = "k8",
            target_libc = "unknown",
            compiler = "clang",
            abi_version = "unknown",
            abi_libc_version = "unknown",
        )
    
    cc_toolchain_config = rule(
        implementation = _impl,
        attrs = {},
        provides = [CcToolchainConfigInfo],
    )
    

    cc_common.create_cc_toolchain_config_info() 会创建所需的提供程序 CcToolchainConfigInfo。如需使用 cc_toolchain_config 规则,请添加加载项 语句添加到 toolchain/BUILD 语句(位于 package 语句正下方):

    load(":cc_toolchain_config.bzl", "cc_toolchain_config")
    

    并替换“k8_toolchain_config”带有一个声明的 cc_toolchain_config 规则:

    cc_toolchain_config(name = "k8_toolchain_config")
    
  7. 再次运行构建。Bazel 会抛出以下错误:

    .../BUILD:1:1: C++ compilation of rule '//:hello-world' failed (Exit 1)
    src/main/tools/linux-sandbox-pid1.cc:421:
    "execvp(toolchain/DUMMY_GCC_TOOL, 0x11f20e0)": No such file or directory
    Target //:hello-world failed to build`
    

    此时,Bazel 有足够的信息来尝试构建代码,但 它仍然不知道使用什么工具来完成所需的构建 操作。您将修改 Starlark 规则实现,告诉 Bazel,什么 工具。为此,您需要使用 @bazel_tools//tools/cpp:cc_toolchain_config_lib.bzl:

    # toolchain/cc_toolchain_config.bzl:
    # NEW
    load("@bazel_tools//tools/cpp:cc_toolchain_config_lib.bzl", "tool_path")
    
    def _impl(ctx):
        tool_paths = [ # NEW
            tool_path(
                name = "gcc",
                path = "/usr/bin/clang",
            ),
            tool_path(
                name = "ld",
                path = "/usr/bin/ld",
            ),
            tool_path(
                name = "ar",
                path = "/usr/bin/ar",
            ),
            tool_path(
                name = "cpp",
                path = "/bin/false",
            ),
            tool_path(
                name = "gcov",
                path = "/bin/false",
            ),
            tool_path(
                name = "nm",
                path = "/bin/false",
            ),
            tool_path(
                name = "objdump",
                path = "/bin/false",
            ),
            tool_path(
                name = "strip",
                path = "/bin/false",
            ),
        ]
        return cc_common.create_cc_toolchain_config_info(
            ctx = ctx,
            toolchain_identifier = "local",
            host_system_name = "local",
            target_system_name = "local",
            target_cpu = "k8",
            target_libc = "unknown",
            compiler = "clang",
            abi_version = "unknown",
            abi_libc_version = "unknown",
            tool_paths = tool_paths, # NEW
        )
    

    请确保 /usr/bin/clang/usr/bin/ld 是正确的路径 。

  8. 再次运行构建。Bazel 会抛出以下错误:

     ..../BUILD:3:1: undeclared inclusion(s) in rule '//main:hello-world':
     this rule is missing dependency declarations for the following files included by 'main/hello-world.cc':
     '/usr/include/c++/9/ctime'
     '/usr/include/x86_64-linux-gnu/c++/9/bits/c++config.h'
     '/usr/include/x86_64-linux-gnu/c++/9/bits/os_defines.h'
     ....
    

    Bazel 需要知道在哪里搜索包含的标头。还有 有多种方法可以解决此问题,如使用 includes 属性 cc_binary,但这里使用 cxx_builtin_include_directories cc_common.create_cc_toolchain_config_info 的参数。请注意 您使用的是其他版本的 clang,则包含路径将为 与众不同。这些路径也可能因分布而异。

    修改 toolchain/cc_toolchain_config.bzl 中的返回值,以查找 如下所示:

     return cc_common.create_cc_toolchain_config_info(
          ctx = ctx,
          cxx_builtin_include_directories = [ # NEW
            "/usr/lib/llvm-9/lib/clang/9.0.1/include",
            "/usr/include",
          ],
          toolchain_identifier = "local",
          host_system_name = "local",
          target_system_name = "local",
          target_cpu = "k8",
          target_libc = "unknown",
          compiler = "clang",
          abi_version = "unknown",
          abi_libc_version = "unknown",
          tool_paths = tool_paths,
     )
    
  9. 再次运行构建命令,您将看到如下错误:

    /usr/bin/ld: bazel-out/k8-fastbuild/bin/main/_objs/hello-world/hello-world.o: in function `print_localtime()':
    hello-world.cc:(.text+0x68): undefined reference to `std::cout'
    

    其原因在于,链接器缺少 C++ 标准 但却找不到相应的符号。有多种方法可以解决此问题 例如使用 cc_binarylinkopts 属性。在这里,谜题解开了 以确保使用工具链的任何目标都不必指定 。

    将以下代码复制到 cc_toolchain_config.bzl

      # NEW
      load("@bazel_tools//tools/build_defs/cc:action_names.bzl", "ACTION_NAMES")
      # NEW
      load(
          "@bazel_tools//tools/cpp:cc_toolchain_config_lib.bzl",
          "feature",
          "flag_group",
          "flag_set",
          "tool_path",
      )
    
      all_link_actions = [ # NEW
          ACTION_NAMES.cpp_link_executable,
          ACTION_NAMES.cpp_link_dynamic_library,
          ACTION_NAMES.cpp_link_nodeps_dynamic_library,
      ]
    
      def _impl(ctx):
          tool_paths = [
              tool_path(
                  name = "gcc",
                  path = "/usr/bin/clang",
              ),
              tool_path(
                  name = "ld",
                  path = "/usr/bin/ld",
              ),
              tool_path(
                  name = "ar",
                  path = "/bin/false",
              ),
              tool_path(
                  name = "cpp",
                  path = "/bin/false",
              ),
              tool_path(
                  name = "gcov",
                  path = "/bin/false",
              ),
              tool_path(
                  name = "nm",
                  path = "/bin/false",
              ),
              tool_path(
                  name = "objdump",
                  path = "/bin/false",
              ),
              tool_path(
                  name = "strip",
                  path = "/bin/false",
              ),
          ]
    
          features = [ # NEW
              feature(
                  name = "default_linker_flags",
                  enabled = True,
                  flag_sets = [
                      flag_set(
                          actions = all_link_actions,
                          flag_groups = ([
                              flag_group(
                                  flags = [
                                      "-lstdc++",
                                  ],
                              ),
                          ]),
                      ),
                  ],
              ),
          ]
    
          return cc_common.create_cc_toolchain_config_info(
              ctx = ctx,
              features = features, # NEW
              cxx_builtin_include_directories = [
                  "/usr/lib/llvm-9/lib/clang/9.0.1/include",
                  "/usr/include",
              ],
              toolchain_identifier = "local",
              host_system_name = "local",
              target_system_name = "local",
              target_cpu = "k8",
              target_libc = "unknown",
              compiler = "clang",
              abi_version = "unknown",
              abi_libc_version = "unknown",
              tool_paths = tool_paths,
          )
    
      cc_toolchain_config = rule(
          implementation = _impl,
          attrs = {},
          provides = [CcToolchainConfigInfo],
      )
    
  10. 如果您运行 bazel build --config=clang_config //main:hello-world,它应该 终于构建了

检查您的作业

在本教程中,您学习了如何配置基本的 C++ 工具链, 工具链比这个简单的示例更强大。

要点总结如下: - 您需要在命令行中指定 --crosstool_top 标志, 指向某个cc_toolchain_suite - 您可以使用 .bazelrc 为特定配置创建快捷方式 文件 - cc_toolchain_suite 可能会针对不同的 CPU 列出 cc_toolchains,以及 编译系统您可以使用 --cpu 等命令行标志来区分。 - 您必须告知工具链工具所在的位置。在本教程中 有一个简化版本,您可以通过系统访问相关工具。如果 如果您想了解一种更加独立的方法,可以参阅 工作区此处.您的工具可能来自 您需要将其文件设为可公开访问, 设置为 cc_toolchain,其中包含属性的目标依赖项,例如 compiler_filestool_paths 也需要进行更改。 - 您可以创建功能来自定义应向哪些标志传递 无论是关联操作还是任何其他类型的操作

深入阅读

有关详情,请参阅 C++ 工具链配置