首页 > 编程语言> 文章详细

bazel C++

2020-03-05 13:02:57 阅读：372 来源： 互联网

标签：name lib cc C++ bazel test include hello

转载：https://www.jianshu.com/p/4e778df3c13b

bazel的所有代码都在当前工程，每个工程都是一个 WORKSPACE 。
每个WORKSPACE下有多个BUILD文件。
BUILD内是多个targets，这些targets都是以starlark语言声明。

Starlark语言

和python很像。
线程安全
数据类型有 None, bool, dict, function, int, list, string, depset, struct
可变数据结构有 lists 和 dicts

命令行

规则

bazel [<startup options>] <command> [<args>]

或

bazel [<startup options>] <command> [<args>] -- [<target patterns>]

命令行参数文档

工作原理

加载与target有关的BUILD文件
分析inputs和dependencies，生成 action graph
执行graph，产出outputs

action graph： bazel依赖这个图来追踪文件变化，以及是否需要重新编译，并且还可以为用户提供代码之间的依赖关系图。

依赖声明

同一个文件BUILD之内

cc_library(
    name = "hello-greet",
    srcs = ["hello-greet.cc"],
    hdrs = ["hello-greet.h"],
)

cc_binary(
    name = "hello-world",
    srcs = ["hello-world.cc"],
    deps = [
        ":hello-greet",
    ],
)

不同BUILD文件之间

cc_library(
    name = "hello-greet",
    srcs = ["hello-greet.cc"],
    hdrs = ["hello-greet.h"],
)

cc_binary(
    name = "hello-world",
    srcs = ["hello-world.cc"],
    deps = [
        ":hello-greet",
        "//lib:hello-time",
    ],
)

:hello-time 定义在 lib 目录
不同的目录BUILD在bazel中被称为不同的package

可见性
同一个package内的targets默认互相可见
不同package之间targets的可见性需要手动定义

cc_library(
    name = "hello-time",
    srcs = ["hello-time.cc"],
    hdrs = ["hello-time.h"],
    visibility = ["//main:__pkg__"],
)

可以在每个package的BUILD文件顶部声明其中的targets对其他包的默认可见性

package(
    default_visibility = [
        "//tensorflow_serving:internal",
    ],
    features = ["-layering_check"],
)

对所有包可见声明如下

cc_proto_library(
    name = "cc_echo_c++_proto",
    deps = [
        ":echo_c++_proto",
    ],
    visibility = [
        "//visibility:public",
    ],
)

target

有2种

rule target，比如 cc_library
file target

C++ 最佳实践

BUILD文件

每个BUILD文件包含一个 cc_library 规则目标
尽可能细粒度C++库，以提高并行速度，并减少增量编译
如果srcs中只有一个文件，那么 cc_library的名字和这个文件名相同，比如：

   cc_library(
       name = "mylib",
       srcs = ["mylib.cc"],
       hdrs = ["mylib.h"],
       deps = [":lower-level-lib"]
   )

每个library都有个单独的test target，并且以_test结尾命名这个target和测试文件名，比如

   cc_test(
       name = "mylib_test",
       srcs = ["mylib_test.cc"],
       deps = [":mylib"]
   )

include路径

所有include路径都相对于WORKSPACE目录
非系统目录用 #include "foo/bar/baz.h", 系统目录用 #include <foo/bar/baz.h>
不要使用 . 和 ..
对第三方库可以使用 include_prefix 和 strip_include_prefix

有时候依赖第三方库的时候，这些库里的文件已有的include path如果放到当前目录，会不符合从workspace root引用文件的规则，就需要添加目录，比如下面的目录

└── my-project
    ├── legacy
    │   └── some_lib
    │       ├── BUILD
    │       ├── include
    │       │   └── some_lib.h
    │       └── some_lib.cc
    └── WORKSPACE

以上，bazel要求some_lib.h必须以legacy/some_lib/include/some_lib.h这个形式包含，但some_lib.cc现在是"include/some_lib.h"这样包含的，要使这个include path有效，需要按如下方式指定路径(待验证)：

cc_library(
    name = "some_lib",
    srcs = ["some_lib.cc"],
    hdrs = ["include/some_lib.h"],
    copts = ["-Ilegacy/some_lib/include"],
)

包含多个文件

使用glob

cc_library(
    name = "build-all-the-files",
    srcs = glob(["*.cc"]),
    hdrs = glob(["*.h"]),
)

依赖处理

bazel中的依赖不传递解析

如果包含了其他头文件，就要把这个头文件的target包含进来。这个头文件内部的include则不用管。比如

sandwich依赖bread，bread依赖flour，但sandwich不依赖flour。

cc_library(
    name = "sandwich",
    srcs = ["sandwich.cc"],
    hdrs = ["sandwich.h"],
    deps = [":bread"],
)

cc_library(
    name = "bread",
    srcs = ["bread.cc"],
    hdrs = ["bread.h"],
    deps = [":flour"],
)

cc_library(
    name = "flour",
    srcs = ["flour.cc"],
    hdrs = ["flour.h"],
)

单个头文件，如果没有实现，也需要定义target，比如

cc_library(
    name = "source_adapter",
    hdrs = ["source_adapter.h"],
    visibility = [
        "//visibility:public",
    ],
    deps = [
        ":loader",
        ":servable_data",
        ":source",
        ":storage_path",
        ":target",
        "//tensorflow_serving/util:class_registration",
        "@org_tensorflow//tensorflow/core:lib",
    ],
)

包含外部库

假设我们要使用Google Test，可以在WORKSPACE中这样指定：

new_http_archive(
    name = "gtest",
    url = "https://github.com/google/googletest/archive/release-1.7.0.zip",
    sha256 = "b58cb7547a28b2c718d1e38aee18a3659c9e3ff52440297e965f5edffe34b6d0",
    build_file = "gtest.BUILD",
)

【注】如果库已经包含了一个BUILD文件，可以使用 non-new_ 函数。
创建文件gtest.BUILD，这个文件用来编译Google Test，由于google test比较特殊的需求，所以它的编译规则会更复杂，特殊性在于：

googletest-release-1.7.0/src/gtest-all.cc #include了googletest-release-1.7.0/src/下的所有文件，所以需要把这个文件排除掉
它的头文件都是相对于这个目录的googletest-release-1.7.0/include/，比如"gtest/gtest.h"，所以需要把这个目录加到copts的-I选项中
需要链接pthread

所以，最终编译规则如下：

cc_library(
    name = "main",
    srcs = glob(
        ["googletest-release-1.7.0/src/*.cc"],
        exclude = ["googletest-release-1.7.0/src/gtest-all.cc"]
    ),
    hdrs = glob([
        "googletest-release-1.7.0/include/**/*.h",
        "googletest-release-1.7.0/src/*.h"
    ]),
    copts = [
        "-Iexternal/gtest/googletest-release-1.7.0/include"
    ],
    linkopts = ["-pthread"],
    visibility = ["//visibility:public"],
)

这个看起来有点乱，因为里面包含了那个版本目录名，这个名字可以在new_http_archive中使用strip_prefix去掉:

new_http_archive(
    name = "gtest",
    url = "https://github.com/google/googletest/archive/release-1.7.0.zip",
    sha256 = "b58cb7547a28b2c718d1e38aee18a3659c9e3ff52440297e965f5edffe34b6d0",
    build_file = "gtest.BUILD",
    strip_prefix = "googletest-release-1.7.0",
)

去掉后的gtest.BUILD文件如下：

cc_library(
    name = "main",
    srcs = glob(
        ["src/*.cc"],
        exclude = ["src/gtest-all.cc"]
    ),
    hdrs = glob([
        "include/**/*.h",
        "src/*.h"
    ]),
    copts = ["-Iexternal/gtest/include"],
    linkopts = ["-pthread"],
    visibility = ["//visibility:public"],
)

现在，其他的 cc_ rules 可以依赖于 @gtest//:main 。

更详细的cc rule说明参考 cc rules

编写测试用例

创建文件 ./test/hello-test.cc

#include "gtest/gtest.h"
#include "lib/hello-greet.h"

TEST(HelloTest, GetGreet) {
  EXPECT_EQ(get_greet("Bazel"), "Hello Bazel");
}

创建 ./test/BUILD

cc_test(
    name = "hello-test",
    srcs = ["hello-test.cc"],
    copts = ["-Iexternal/gtest/include"],
    deps = [
        "@gtest//:main",
        "//lib:hello-greet",
    ],
)

注意，要使hello-greet对hello-test可见，需要在 ./lib/BUILD文件中添加属性visibility，值为 //test:__pkg__。

运行测试用例：

bazel test test:hello-test

输出：

INFO: Found 1 test target...
Target //test:hello-test up-to-date:
  bazel-bin/test/hello-test
INFO: Elapsed time: 4.497s, Critical Path: 2.53s
//test:hello-test PASSED in 0.3s

Executed 1 out of 1 tests: 1 test passes.

该部分来自于 bazel C++ use case

包含预编译的库

动态库

cc_library(
    name = "mylib",
    srcs = ["mylib.so"],
    hdrs = ["mylib.h"],
)

处理外部依赖

Working with external dependencies

依赖bazel工程

依赖非bazel工程

需要编写BUILD文件

依赖隐藏（Shadowing）

依赖同一个package的不同版本

其他

getting started bazel C++

作者：peteyuan
链接：https://www.jianshu.com/p/4e778df3c13b
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

标签：name,lib,cc,C++,bazel,test,include,hello
来源： https://www.cnblogs.com/qiandeheng/p/12419606.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9