bazel使用匯總

最近重構代碼之后，打算在本地用bazel來作項目構建。主要是因為brpc已經支持了bazel，所以在此之前料想會簡單許多。

安裝比較簡單，centos直接用yum就行。按照這個指示：

https://docs.bazel.build/versions/master/install-redhat.html

wget https://copr.fedorainfracloud.org/coprs/vbatts/bazel/repo/epel-7/vbatts-bazel-epel-7.repo -O /etc/yum.repos.d/
yum install bazel

 最基本的使用，參考tutorial就行了。

https://docs.bazel.build/versions/master/tutorial/cpp.html

常用的也就是cc_library和cc_binary。（因為我現在用blade也是這樣……）

當然寫c++，這里有個common case可以看看。

https://docs.bazel.build/versions/master/cpp-use-cases.html

頭文件

頭文件的引入比較復雜些，分幾種情況：

1. 多文件。（使用通配符）

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

2. 使用copts來指定引用目錄。

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

這里就涉及到另一個參數，includes。includes和copts的使用區別主要有兩點:

a. includes不需要加-I，而且直接是相對路徑就行。也就是說，如果相對於主目錄是./sub/subsub/a.h，sub/BUILD里，includes只需要寫['subsub']， 如果是copts則需要寫['-Isub/subsub/']。

b. copts只在當前目標里生效。includes則所有依賴到該目錄都會繼承。所以一般library還是用includes。

這里還要注意，如果用cc_binary，srcs里也要包含引用的頭文件，不然也會報錯。

其他參數就看看文檔：

https://docs.bazel.build/versions/master/be/c-cpp.html

外部引用

可以在WORKSPACE文件里寫。

https://docs.bazel.build/versions/master/be/workspace.html

具體我的使用場景是把第3方庫代碼download下來放在項目里，然后通過WORKSPACE來設置。所以我會用到的是local_repository。比如我在我的項目WORKSPACE里這樣寫：

local_repository(
  name = "com_google_protobuf",
  path = "3rdlib/protobuf-3.6.1/",
)

local_repository(
  name = "com_github_google_leveldb",
  path = "3rdlib/leveldb-1.20",
)

local_repository(
  name = "com_github_gflags_gflags",
  path = "3rdlib/gflags-master",
)

然后把brpc里對應的leveldb.BUILD拷到leveldb的源碼目錄，這樣brpc的BUILD基本就不需要改了。

但是這里碰到另一個坑，就是編譯protobuf要指定HAVE_LIB=1。這里就通過在項目根目錄的.bazelrc里寫：

build --copt -DHAVE_ZLIB=1

這樣bazel build就會默認調用這句命令。這里有個問題，是必須要在項目的根目錄.bazelrc里寫，在第三方目錄里寫是沒用的。

https://github.com/bazelbuild/bazel/issues/6319

https://github.com/brpc/brpc/issues/275

外部非bazel的項目也可以用genrule，使用make來編譯。genrule會自動執行。被依賴的文件，可能通過filegroup暴露出去。

https://docs.bazel.build/versions/master/be/general.html

genrule可以用到一些內置變量。系統變量用$$引用。內置變量見：

https://docs.bazel.build/versions/master/be/make-variables.html

但是獲取不了本項目的絕對路徑。所以我也不知道應該怎么撈取，得到的都是sandbox里的，只能用..來取到項目目錄。

genrule(
    name = "libevent-srcs",
    outs = include_files + lib_files,
    cmd = "\n".join([
        "export INSTALL_DIR=$$(pwd)/$(@D)/libevent",
        "export TMP_DIR=$$(mktemp -d -t libevent.XXXXXX)",
        "mkdir -p $$TMP_DIR",
        "cp -R $$(pwd)/../../../../../external/com_github_libevent_libevent/* $$TMP_DIR",  9         "cd $$TMP_DIR",
        "./autogen.sh",
        "./configure --prefix=$$INSTALL_DIR CFLAGS=-fPIC CXXFLAGS=-fPIC --enable-shared=no --disable-openssl",
        "make install",
        "rm -rf $$TMP_DIR",
    ]),
)

動態庫查找問題

有個庫用到了boost。boost太大沒有包含到項目里，放在另一個目錄里，但是bazel找不到庫目錄，雖然已經export了LIBRARY_PATH和LD_LIBRARY_PATH。但是實際執行時是：

exec env - \
    LD_LIBRARY_PATH=:/home/myaccount/boost_1_68_0/release/lib/ \
    PATH=/usr/local/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/usr/local/apache-hive-2.3.3-bin:/usr/local/apache-hive-2.3.3-bin:/home/xxj/.local/bin \
    PWD=/proc/self/cwd \
    TMPDIR=/tmp \

因為沒有傳遞LIBRARY_PATH，所以boost庫找不到。LIBRARY_PATH和LD_LIBRARY_PATH的區別見：

https://stackoverflow.com/questions/4250624/ld-library-path-vs-library-path

IBRARY_PATH is used by gcc before compilation to search directories containing static libraries that need to be linked to your program.
LD_LIBRARY_PATH is used by your program to search directories containing shared libraries after it has been successfully compiled and linked.

解決方案就在通過--action_env指定。

bazel build //3rdlib/test:bintest --action_env=LIBRARY_PATH=:/home/myaccount/boost_1_68_0/release/lib/

https://bazel.build/designs/2016/06/21/environment.html

Currently, Bazel provides a cleaned set of environment variables to the actions in order to obtain hermetic builds.

If the effective option for a variable has an unspecified value, the value from the invocation environment of Bazel is taken.

所以這里也可以不給LIBRARY_PATH指定值，這樣就會直接使用環境變量。

bazel build //3rdlib/test:bintest --action_env=LIBRARY_PATH

 

proto處理

https://blog.bazel.build/2017/02/27/protocol-buffers.html

定義一個proto_library和對應的cc_proto_library。

proto_library(
        name = "http_proto",
        srcs = [
                "http.proto",
        ],
)

cc_proto_library(
        name = "http_cc_proto",
        deps = [":http_proto"],
)

這里cc_proto_library的deps一定要指向proto_library。

https://docs.bazel.build/versions/master/be/c-cpp.html#cc_proto_library

然后對應的cc_binary可以依賴到它和它產生的文件:

cc_binary(
    name = "http_server",
    srcs = ["http_server.cpp"],
        deps = [
                ":http_cc_proto",
                "//3rdlib/brpc-0.9.5:brpc",
        ],
)

不過要想include生成的.pb.h文件，需要用相對於workspace的相對路徑才行。

待定問題

1. -fopenmp這類參數沒法繼承。比如某個庫編譯需要用到-fopenmp。那么依賴到的binary的copts也要加上這個。現在還沒有其他方案。

copts = [ 
    '-fopenmp',
    '-march=native',
],