cmake 进阶 - 源码依赖

支持原创，转载请附上原文链接

keywords

cmake 编译顺序

cmake 源码编译依赖

cmake 链接依赖

target_link_libraries 与 add_dependencies

0 前言

实际项目中，我们的工程一般都会比较大，且可能会依赖第三方源码库。为了对于引入源码的可控性以及多平台的兼容性，一般我们大多做法是将源码直接放到我们工程中进行编译。

0.1 抛出问题

某些第三方源码库比较大，编译时间比较长的时候，我们可能会遇到有些平台工程编译成功，有些工程编译确实失败的，这是为何呢？

1 cmake 编译与链接依赖

1.1 工程结构

首先我们介绍下我们测试的工程结构以及目录中文件内容。

.
├── 3rdparty
│   ├── CMakeLists.txt
│   └── jsoncpp
├── CMakeLists.txt
├── build.sh
└── src
    ├── CMakeLists.txt
    └── main.cc

jsoncpp 里面的内容没有列出来，是从github拉下来的，地址为：jsoncpp，其他文件的内容分别如下：

CMakeLists.txt

cmake_minimum_required(VERSION 3.5)
project(learn2)

set(CMAKE_CXX_STANDARD 11)

add_subdirectory(3rdparty)
add_subdirectory(src)

build.sh

#!/bin/bash

[ ! -d build ] && mkdir build

INSTALL_DIR=${PWD}/output
[ ! -d ${INSTALL_DIR} ] && mkdir ${INSTALL_DIR}

cd build

CMAKE_ARGS="${CMAKE_ARGS} -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR}"

# 并行编译任务数量
cores=8
if which nproc &> /dev/null; then
  cores=$(nproc)
fi
cores=$((cores-1))
[ $cores -gt 32 ] && cores=32
[ $cores -lt 0 ] && cores=2

echo "cores is $cores"

cmake .. ${CMAKE_ARGS} && make -j${cores} install

src/CMakeLists.txt

cmake_minimum_required(VERSION 3.5)
project(cmake_test)

include_directories(
  ${CMAKE_SOURCE_DIR}/3rdparty/jsoncpp/include
)

link_directories(
  ${CMAKE_BINARY_DIR}/lib
)

add_executable(${PROJECT_NAME}
  main.cc
)
target_link_libraries(${PROJECT_NAME}
  jsoncpp
)
install(TARGETS ${PROJECT_NAME} RUNTIME DESTINATION bin)

src/main.cc

#include <iostream>

#include "json/json.h"

int main() {
  Json::Value root;
  root["value"] = 987654321;
  root["ts"] = 123456789.089;

  Json::StreamWriterBuilder builder;
  builder["commentStyle"] = "None";
  builder["indentation"] = "";
  builder["precisionType"] = "decimal";
  builder["precision"] = 1;
  std::string writer_info = Json::writeString(builder, root);

  std::cout << writer_info << std::endl;
  return 0;
}

1.2 编译顺序

cmake的编译顺序，与add_subdirectory的顺序相关（前提：在没有任何编译依赖的情况下，这个后面会介绍到），比如上述的工程，在某些环境还是能编译过的。但是如果 CMakeLists.txt 内容修改为如下，是编译不过的

cmake_minimum_required(VERSION 3.5)
project(learn2)

set(CMAKE_CXX_STANDARD 11)

add_subdirectory(src)
add_subdirectory(3rdparty)

1.3 编译异常

上面工程，在某些环境下，会出现编译失败，失败原因是link的时候找不到jsoncpp库，如下：

main.cc:(.text+0x2ea): undefined reference to `Json::Value::operator=(Json::Value&&)'
collect2: error: ld returned 1 exit status

你是否会疑惑：已经使用target_link_libraries依赖了jsoncpp啊，为啥会出现在 jsoncpp未编译结束的情况下，就开始链接了呢？
其实这个不难找到答案，看看官方文档对于target_link_libraries的解释就明白了

Specify libraries or flags to use when linking a given target and/or its dependents. Usage requirements from linked library targets will be propagated. Usage requirements of a target's dependencies affect compilation of its own sources.

大致意思是目标在链接的时候用到的一些库或者一些符号，这里解决的问题，主要是告诉编译器链接时候去哪里找符号表，但是没有解决编译顺序问题。比如，虽然上面依赖的jsoncpp先编译，但是由于其编译时间长，还没编译完，cmake_test就已经开始链接了，因此报错。

问题解决思路有2个：

单核编译：我们已经指定了编译顺序，如果是单核编译，就不存在链接时候没有ready的问题
明确指定依赖关系

明显方案1，在我们实际开发中，是不符合要求的，这会大大降低我们的编译构建效率。因此，留给我们的只有方案2

1.4 编译依赖

cmake提供了编译依赖相关的函数的，add_dependencies，官方介绍：

Add a dependency between top-level targets.
add_dependencies(<target> [<target-dependency>]...)
Makes a top-level <target> depend on other top-level targets to ensure that they build before <target> does.

从介绍可以看出，这个是为了解决被依赖的target没有编译完，依赖target就开始链接的问题。因此，我们工程的其中以个文件修改为如下：
src/CMakeLists.txt

cmake_minimum_required(VERSION 3.5)
project(cmake_test)

include_directories(
  ${CMAKE_SOURCE_DIR}/3rdparty/jsoncpp/include
)

link_directories(
  ${CMAKE_BINARY_DIR}/lib
)

add_executable(${PROJECT_NAME}
  main.cc
)
target_link_libraries(${PROJECT_NAME}
  jsoncpp
)
add_dependencies(${PROJECT_NAME}
  jsoncpp_lib
)

install(TARGETS ${PROJECT_NAME} RUNTIME DESTINATION bin)

此时，不同平台、不同环境编译都是OK的。这里需要注意：
add_dependencies的参数是targets，也就是add_library的第一个参数

99 其他

CMAKE 工具使用过程中的一些变量介绍

CMAKE_CURRENT_SOURCE_DIR : 当前CMakeLists.txt文件所在目录
CMAKE_SOURCE_DIR： 顶层目录
CMAKE_BINARY_DIR： build目录
PROJECT_NAME： 当前工程名称
CMAKE_INSTALL_PREFIX： 最终安装目录
CMAKE_LIBRARY_ARCHITECTURE：编译目标架构 x86_64-linux-gnu， aarch64-linux-gnu

CMAKE_CXX_FLAGS ： c++的编译参数
CMAKE_C_FLAGS： c编译参数
CMAKE_VERSION： cmake的版本