使用Bazel构建C/C++项目

以你之姓@ 2021-09-30 11:16 491阅读 0赞

*  前提
 *  基本概念
 *  速查链接汇总
 *  stage1: 一个package, 一个target
 *  stage2: 一个package，多个target
 *  stage3: 多package，多target
 *  stage4: 使用外部依赖
 *  最佳实践

这是关于Bazel的第二篇blog，前一篇写了安装、配置相关的东西，这一篇则是4个逐步推进的例子，改编自官方demo；以及相应的概念、文档链接等。

## 前提 ##

*  Linux(Ubuntu, etc)或Mac OSX系统，会点儿命令行(包括brew/apt)
 *  装好了zsh和oh-my-zsh（用于`bazel build`等命令的补全）
 *  装好了bazel;
 *  学过C/C++;
 *  用过make/cmake
 *  最好会一点git
 *  bazel版本：目前我用0.21版本，最新版删过东西（https://docs.bazel.build/versions/0.21.0/be/workspace.html）

## 基本概念 ##

*  `WORKSPACE`: 空文件；标识了项目根目录；只有一个
 *  `BUILD`：WORKSPACE下的子目录里，如果放了一个名为`BUILD`的文件，则这个目录是一个`package`；`BUILD`里写一些构建规则 (rules)
 *  `cc_binary`: C/C++ `package`的最常用的构建规则
 *  bazel的C/C++在线文档：https://docs.bazel.build/versions/master/be/c-cpp.html
 *  `target`的概念：cmake中的target包括executable、library两种情况
 *  `rule`的概念：类似于cmake中`target`概念的推广，bazel构建C/C++时的规则有：
    
     *  [cc\_binary][cc_binary]
     *  [cc\_import][cc_import]
     *  [cc\_library][cc_library]
     *  [cc\_proto\_library][cc_proto_library]
     *  [fdo\_prefetch\_hints][fdo_prefetch_hints]
     *  [fdo\_profile][fdo_profile]
     *  [cc\_test][cc_test]
 *  即使是bazel build官方文档，也不明确区分target和rule字眼，可以认为是一个意思
 *  大体上，`.bzl`相当于`.cmake`文件，`BUILD`相当于`CMakeLists.txt`
 *  `WORKSPACE`，`BUILD`中用到了一些预定义的函数或变量，具体看这里：https://docs.bazel.build/versions/master/skylark/lib/skylark-overview.html

## 速查链接汇总 ##

[workspace规则][workspace]  
[starlark预设全局变量][starlark]  
[完整代码][Link 1]

## stage1: 一个package, 一个target ##

这是最简单的bazel构建例子

**目录结构**

├── WORKSPACE
    └── main
        ├── BUILD
        └── hello.c

其中，`main`为包名，因为它包含了`BUILD`文件

`hello.c`:

#include <stdio.h>
    
    int main(void){
        printf("hello from C!\n");
        return 0;
    }

`BUILD`:

cc_binary(
        name = "hello",
        srcs = ["hello.c"],
    )

**执行构建**

bazel build main:all

*  语法是`bazel build 包名:任务名`
 *  输入完`bazel build`后按`tab`键补全提示，比较方便
 *  因为目前只有一个target，也可以输入`bazel build main:hello`

**运行**

bazel run main:all

它其实除了输出bazel相关的信息，执行的是`./bazel-bin/hello`目录下的可执行文件`hello`等

**执行清除**

bazel clean

## stage2: 一个package，多个target ##

典型场景：写一个库，然后调用它。这里写一个神经网络激活函数库，然后写一个测试程序。

**目录结构**

├── WORKSPACE
    └── main
        ├── BUILD
        ├── activations.c
        ├── activations.h
        └── testbed.c
    
    1 directory, 5 files

`BUILD`:

cc_library(
        name = "actv",
        srcs = ["activations.c"],
        hdrs = ["activations.h"],
    )
    
    cc_binary(
        name = "actv-testbed",
        srcs = ["testbed.c"],
        deps = [
            ":actv",
        ],
    )

`activations.h`:

#ifndef __ACTIVATIONS_H__
    #define __ACTIVATIONS_H__
    
    float relu(float x);
    float sigmoid(float x);
    
    #endif

`activations.c`:

#include "activations.h"
    #include <math.h>
    
    float relu(float x){
        if (x>=0) return x;
        return 0;
    }
    
    float sigmoid(float x){
        return 1.0f / (1.0f + exp(-x));
    }

`testbed.c`:

#include <stdio.h>
    #include <time.h>
    #include <stdlib.h>
    #include "activations.h"
    
    // return a random float in (s, t)
    float get_random(float s, float t){
        float v = (float)(rand()) / RAND_MAX;
        v = v * (t-s) + s;
        return v;
    }
    
    int main(){
        const int maxn = 5;
        srand(time(0));
        for(int i=0; i<maxn; i++) {
            float x = get_random(-2.0f, 2.0f);
            float res_relu = relu(x);
            float res_sigmoid = sigmoid(x);
            printf("x=%f\n", x);
            printf("relu(x)=%f\n", res_relu);
            printf("sigmoid(x)=%f\n", res_sigmoid);
            printf("\n");
        }
    
        return 0;
    }

**构建库**

bazel build main:actv

**构建测试**

bazel build main:actv-testbed

**执行**

bazel run main:actv-testbed

## stage3: 多package，多target ##

主要是弄清楚，如何在不同package的target之间设定依赖关系，比如一个库target在其他包中是否可用（visibility），比如头文件的包含路径。

目录结构：

├── lib
    │   ├── BUILD
    │   ├── random.c
    │   ├── random.h
    │   ├── timer.c
    │   └── timer.h
    ├── main
    │   ├── activations.c
    │   ├── activations.h
    │   ├── BUILD
    │   └── testbed.c
    └── WORKSPACE

其中，`lib/BUILD`:

cc_library( name = "timer", srcs = ["timer.c"], hdrs = ["timer.h"], visibility = ["//main:__pkg__"] ) cc_library( name = "random", srcs = ["random.c"], hdrs = ["random.h"], visibility = ["//main:__pkg__"] )

而`main/BUILD`:

cc_library( name = "actv", srcs = ["activations.c"], hdrs = ["activations.h"], ) cc_binary( name = "actv-testbed", srcs = ["testbed.c"], deps = [ ":actv", "//lib:random", "//lib:timer" ], )

各个源码文件其实都很简单，这里就不贴出来的，只需要注意在包含lib包里面的头文件时，`main/testbed.c`是这样写的：

#include "activations.h"
    #include "lib/timer.h"
    #include "lib/random.h"

## stage4: 使用外部依赖 ##

这里说的外部依赖，包括：本地的其他目录，git仓库或http地址下载的。外部依赖可以是基于bazel构建的，也可以不是。

anyway，google家开源的[abseil框架的hello-world例子][abseil_hello-world]可能是最典型的demo了。但是它同时用了gtest、gmock和abseil，感觉太麻烦了，干脆直接**引入abseil外部库来写hello-world**，如下：

**目录结构**

├── BUILD
    ├── hello.cc
    └── WORKSPACE

这里看到并没有子目录，这也是可以的

**`WORKSPACE`**

# 非必须
    workspace(name = "com_google_absl_hello_world")
    
    load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
    
    # Abseil
    http_archive(
        name = "absl",
        strip_prefix = "abseil-cpp-master",
        urls = ["https://github.com/abseil/abseil-cpp/archive/master.zip"],
    )

**`BUILD`**

cc_binary(
        name = "hello",
        srcs = ["hello.cc"],
        deps = [
            "@absl//absl/strings"
        ]
    )

说明：因为在`WORKSPACE`中载入了absl，所以`BUILD`中可以使用`@absl`。

`hello.cc`

#include <iostream>
    #include <string>
    
    #include "absl/strings/str_cat.h"
    #include "absl/strings/string_view.h"
    
    using std::string;
    using std::cout;
    using std::endl;
    
    string Greet(absl::string_view person) {
        return absl::StrCat("Hello ", person);
    }
    
    int main(){
        cout << Greet("world") << endl;
        cout << Greet("ChrisZZ") << endl;
    
        return 0;
    }

**执行构建**

bazel build :hello

它根据`WORKSPACE`中的设定（也就是`http_archive`），从http下载。其他的方法还包括`git_repository`的方式，不过最新版bazel中把这些都踢掉了，必须手动load一下bazel工具中的.bzl文件，才能用它们。。

参考：  
https://stackoverflow.com/questions/45814669/c-project-with-bazel-and-gtest?noredirect=1&lq=1

https://github.com/vincent-picaud/Bazel\_with\_GTest

https://docs.bazel.build/versions/master/external.html

## 最佳实践 ##

https://docs.bazel.build/versions/master/external.html\#best-practices

转载于:https://www.cnblogs.com/zjutzz/p/10305301.html

[cc_binary]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_binary
[cc_import]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_import
[cc_library]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library
[cc_proto_library]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_proto_library
[fdo_prefetch_hints]: https://docs.bazel.build/versions/master/be/c-cpp.html#fdo_prefetch_hints
[fdo_profile]: https://docs.bazel.build/versions/master/be/c-cpp.html#fdo_profile
[cc_test]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_test
[workspace]: https://docs.bazel.build/versions/0.21.0/be/workspace.html
[starlark]: https://docs.bazel.build/versions/master/skylark/lib/globals.html
[Link 1]: https://github.com/zchrissirhcz/bazel_intro
[abseil_hello-world]: https://github.com/abseil/abseil-hello.git