2 cmake简单示例

发表于 分类于 阅读次数：

2 cmake简单示例

2.1 编译单个源文件

创建一个hello.c文件

1
2
3
4
5
6
#include <stdio.h>
int main(void)
{
  printf("Hello,World\n");
  return 0;
}

在hello.c当前目录创建一个CMakeLists.txt（名字需要一致，大小写也一致），它就是 cmake所处理的“代码“

1
2
3
4
5
6
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# #项目名称 任意
project (Demo1)
# 指定生成目标 Demo1
add_executable(Demo1 hello.c)

编辑后文件结构如下

1
2
3
4
5
6
7
.
├── build
├── CMakeLists.txt
└── hello.c

1 directory, 2 files

生成makefile文件：在当前目录执行cmake .(注意后面有一个点)（也可以创建一个build目录，在build目录执行cmake ..），执行后如图：

编译项目：在build目录执行make编译,生成Demo1可执行文件

2.2 编译多个源文件

2.2.1 同一目录多个源文件

源文件都在一个目录内如下，两个源文件helloc.和fun.c

1
2
3
4
5
6
7
8
.
├── build
├── CMakeLists.txt
├── fun.c
└── hello.c

1 directory, 3 files

对应的CMakeLists.txt 如下

1
2
3
4
5
6
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目信息
project (Demo2)
# 指定生成目标
add_executable(Demo hello.c fun.c)

唯一的改动只是在 add_executable 命令中增加了一个 fun.c源文件但是如果源文件很多，把所有源文件的名字都加进去将是一件烦人的工作。更省事的方法是使用 aux_source_directory 命令，该命令会查找指定目录下的所有源文件，然后将结果存进指定变量名。其语法如下：

1
aux_source_directory(<dir> <variable>)

因此可以修改CMakeLists.txt如下

1
2
3
4
5
6
7
#cmake最低版本需求，不加入此行会受到警告信息
cmake_minimum_required(VERSION 2.6)
project(HELLO) #项目名称 任意
#把当前目录(.)下所有源代码文件和头文件加入变量SRC_LIST
aux_source_directory(. SRC_LIST)
#生成可执行程序 hello
add_executable(Demo2 ${SRC_LIST})

这样，CMake 会将当前目录所有源文件的文件名赋值给变量 DIR_SRCS ，再指示变量 DIR_SRCS 中的源文件需要编译成一个名称为 Demo2 的可执行文件。

2.2.2 多个目录，多个源文件

目录结构如下

1
2
3
4
5
6
7
8
9
10
11
12
3
├── build
├── CMakeLists.txt
├── hello.c
└── src
    ├── CMakeLists.txt
    ├── fun1.c
    ├── fun1.h
    ├── fun2.c
    └── fun2.h

2 directories, 7 files

对于这种情况，需要分别在项目根目录 3 和 src 目录里各编写一个 CMakeLists.txt 文件。为了方便，我们可以先将 src 目录里的文件编译成静态库再由 main 函数调用。

根目录的CMakeLists.txt如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目信息
project (Demo3)
# 指定头文件目录
include_directories(${project_SOURCE_DIR}/src)
# 查找当前目录下的所有源文件
# 并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)
# 添加 src 子目录
add_subdirectory(src)
# 指定生成目标
add_executable(Demo ${DIR_SRCS})
# 添加链接库
target_link_libraries(Demo fun)

该文件添加了下面的内容:

  • include_directories 添加头文件路径

  • 使用命令 add_subdirectory 指明本项目包含一个子目录 src，这样 src 目录下的 CMakeLists.txt 文件和源代码也会被处理，也就是会调用src下的CMakeList.txt进行编译 。

  • 使用命令 target_link_libraries 指明可执行文件 Demo 需要连接一个名为 fun 的链接库 。

子目录src下的CMakeLists.txt如下

1
2
3
4
5
# 查找当前目录下的所有源文件
# 并将名称保存到 DIR_LIB_SRCS 变量
aux_source_directory(. DIR_LIB_SRCS)
# 生成链接库
add_library (fun ${DIR_LIB_SRCS})

在该文件中使用命令 add_library 将 src 目录中的源文件编译为静态链接库fun。具体就是libfun.a

编译如下：

2.3 编译库

目录结构和上面目录多源文件一致，目的是将src的fun文件编译为库

1
2
3
4
5
6
7
8
9
10
11
12
3
├── build
├── CMakeLists.txt
├── hello.c
└── src
    ├── CMakeLists.txt
    ├── fun1.c
    ├── fun1.h
    ├── fun2.c
    └── fun2.h

2 directories, 7 files

在src文件夹中创建CMakeLists.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
project(lib_test)
set(CMAKE_BUILD_TYPE Release)

#Bring the headers, such as Student.h into the project
include_directories(.)

#However, the file(GLOB...) allows for wildcard additions:
file(GLOB SOURCES "*.c")

#Generate the shared library from the sources
#生成文件名testlib
add_library(testlib SHARED ${SOURCES})

#Set the location for library installation -- i.e., /usr/lib in this case
# not really necessary in this example. Use "sudo make install" to apply
# install 指定安装目录，执行sudo make install时动态库将被安装在/usr/lib目录
# install(TARGETS testStudent DESTINATION /usr/lib)

上面的变化

  • file指令，这里的作用和aux_source_directory类似
  • add_library而不是add_executable生成库文件，而不是可执行文件，SHARED参数是表明生成动态库，如果是需要生成静态库就是STATIC

编译如下

2.4 使用其他库

现在使用上面生成的库libtestlib.so，文件结构如下

1
2
3
4
5
6
7
8
9
10
5
├── build
├── CMakeLists.txt
├── hello.c
└── lib
    ├── fun1.h
    ├── fun2.h
    └── libtestlib.so

2 directories, 5 files

在根目录下创建CMakeLists.txt如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目信息
project (Demo3)
# 指定头文件目录
include_directories(${project_SOURCE_DIR}/lib)
#添加共享库搜索路径
link_directories(${project_SOURCE_DIR}/lib)
# 查找当前目录下的所有源文件
# 并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)

# 指定生成目标
add_executable(Demo ${DIR_SRCS})
# 添加链接库
target_link_libraries(Demo testlib)

编译如下

2.4.1 库的相互依赖

当生成可执行程序依赖一个静态库，而这个静态库又依赖一个动态库时，你需要在两个 CMakeLists.txt 文件中进行相应的配置。

首先，我们来看生成静态库的 CMakeLists.txt 文件：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
cmake_minimum_required(VERSION 3.12)
project(MyStaticLibrary)

# 添加需要编译的源文件
add_library(MyStaticLibrary STATIC
    src/library.cpp
)

# 指定头文件的搜索路径
target_include_directories(MyStaticLibrary PUBLIC include)

# 如果静态库依赖于动态库，可以使用target_link_libraries命令链接动态库
target_link_libraries(MyStaticLibrary PRIVATE other_library)

# 指定安装规则（可选）
install(TARGETS MyStaticLibrary
    ARCHIVE DESTINATION lib
)

在这个示例中，假设你的源文件位于 src 目录中，头文件位于 include 目录中。静态库将被安装到 lib 目录下。注意，使用 target_link_libraries 命令将动态库链接到静态库时，使用 PRIVATE 关键字表示该依赖关系仅适用于静态库本身，而不会传递给依赖于该静态库的其他目标。

接下来，我们来看生成可执行程序的 CMakeLists.txt 文件：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
cmake_minimum_required(VERSION 3.12)
project(MyExecutable)

# 添加需要编译的源文件
add_executable(MyExecutable
    src/main.cpp
)

# 指定头文件的搜索路径
target_include_directories(MyExecutable PRIVATE include)

# 如果可执行程序依赖于静态库，使用target_link_libraries命令链接静态库
target_link_libraries(MyExecutable PRIVATE MyStaticLibrary)

# 如果静态库依赖于动态库，还需要将动态库链接到可执行程序
target_link_libraries(MyExecutable PRIVATE other_dynamic_library)

# 指定安装规则（可选）
install(TARGETS MyExecutable
    RUNTIME DESTINATION bin
)

在这个示例中，假设你的主程序源文件位于 src 目录中，头文件位于 include 目录中。可执行程序将被安装到 bin 目录下。注意，使用 target_link_libraries 命令将静态库链接到可执行程序时，使用 PRIVATE 关键字表示该依赖关系仅适用于可执行程序本身，而不会传递给其他目标。

2.5 交叉编译

交叉编译官方说明 https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html#variables-and-properties

2.5.1 arm-linux

2.5.1.1. 设置系统和工具链

对于交叉编译，CMake并不知道目标系统是什么，所以需要设置一些CMake变量来告知CMake，

  • CMAKE_SYSTEM_NAME：即目标系统名，这里是Linux
  • CMAKE_SYSTEM_PROCESSOR ：目标系统的处理器名，这里是arm

对于工具链，则是通过下面2个变量来定位，

  • CMAKE_C_COMPILER：C编译器的可执行文件名称
  • CMAKE_CXX_COMPILER：C++编译器的可执行文件名称

这些变量可以在调用CMake时通过命令行传递，但是这种做法容易出错，而且用起来不方便，所以CMake提供了工具链文件的方式来传递这些变量信息。

2.5.1.2. 工具链文件

我们在工程里新建一个文件叫arm_linux_toolchain.cmake，放置位置如下（也可以放在别的地方），

1
2
3
4
5
6
set(CMAKE_SYSTEM_NAME Linux)
set(CMAKE_SYSTEM_PROCESSOR arm)

set(tools /home/wh/work/cross_compile/gcc-linaro-7.3.1-2018.05-x86_64_arm-linux-gnueabihf)
set(CMAKE_C_COMPILER ${tools}/bin/arm-linux-gnueabihf-gcc)
set(CMAKE_CXX_COMPILER ${tools}/bin/arm-linux-gnueabihf-g++)

注意：

  • 上述命令必须写入脚本中，使用 -DCMAKE_TOOLCHAIN_FILE=xxx.cmake 的方式使用。不能直接写入 CMakeLists.txt 或使用 include(xx.cmake) 。
  • set(CMAKE_SYSTEM_NAME Linux)：该指令必须存在，其目的是设置目标机使用的操作系统名称，支持Linux，QNX，WindowsCE，Android等。如果没有操作系统，那么就写 Generic。执行该指令后，cmake 变量CMAKE_CROSSCOMPILING 会自动被设置为 TRUE，此时 cmake 就会“知道“现在执行的是交叉编译；

tools是本人使用的交叉工具链路径，可以根据自己的实际文件来做修改。

2.5.1.3 编译

使用CMake的变量CMAKE_TOOLCHAIN_FILE来指定工具链文件，cd到build目录，然后执行下面的命令，

1
2
3
4
# 注意，工具链文件的指定一定要紧跟cmake命令之后，不能放到 .. 后面
cmake -DCMAKE_TOOLCHAIN_FILE=../arm_linux_toolchain.cmake ..
# 使用make开始安装编译源代码
make

使用工具链文件的好处就是只要编写一遍，然后在任意地方只需要使用CMAKE_TOOLCHAIN_FILE去指定其位置就可以了，非常方便。

2.5.2 官方的例子

2.5.2.1 Cross Compiling for Linux

1
2
3
4
5
6
7
8
9
10
11
12
13
14
set(CMAKE_SYSTEM_NAME Linux)
set(CMAKE_SYSTEM_PROCESSOR arm)

set(CMAKE_SYSROOT /home/devel/rasp-pi-rootfs)
set(CMAKE_STAGING_PREFIX /home/devel/stage)

set(tools /home/devel/gcc-4.7-linaro-rpi-gnueabihf)
set(CMAKE_C_COMPILER ${tools}/bin/arm-linux-gnueabihf-gcc)
set(CMAKE_CXX_COMPILER ${tools}/bin/arm-linux-gnueabihf-g++)

set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)

  • CMAKE_SYSTEM_NAME要构建目标平台名称。

  • CMAKE_SYSTEM_PROCESER目标系统的处理

  • CMAKE_SYSROOT是可选的，如果有Sysroot可用，则可以指定

  • CMAKE_STAGING_PREFIX也是可选的。它可用于指定主机上要安装的路径。即使在交叉编译时，CMAKE_INSTALL_PREFIX始终是运行时安装位置。

  • CMAKE_C_COMPLIER C语言编译器

  • CMAKE_CXX_COMPLIER C++语言编译器

  • CMAKE_FIND_ROOT_PATH

    一般工程都包含一些外部依赖的库或者工具，cmake提供给我们一些变量可以进行查找FIND_PROGRAM(), FIND_LIBRARY(), FIND_FILE(), FIND_PATH() and FIND_PACKAGE() 查找文件和返回结果。FIND_PACKAGE()其实并不进行查找，而是通过执行FindXXX.cmake模块，进而调用FIND_PROGRAM(), FIND_LIBRARY(), FIND_FILE(), FIND_PATH()去查找文件。例如当你编译软件时候，希望程序链接文件 /usr/lib/libjpeg.so，FIND_PACKAGE(JPEG)会直接在主机的相对位置查找此链接文件，所以我们必须设定CMake在指定的位置查找需要的文件。

    下面的设置可以帮助我们完成相应的操作

    • 这是一个文件夹列表，如果你的目标环境安装在/opt/eldk/ppc_74xx，配置CMAKE_FIND_ROOT_PATH指向此处，然后FIND_LIBRARY(BZ2_LIB bz2)将会搜索/opt/eldk/ppc_74xx/lib, /opt/eldk/ppc_74xx/usr/lib, /lib, /usr/lib 之后会将 /opt/eldk/ppc_74xx/usr/lib/libbz2.so 作为结果返回。

      CMAKE_FIND_ROOT_PATH默认设置为空。如果设置之后，cmake默认会首先搜索具有这个前缀的位置下文件，之后去其他位置查找。

      • 每个FIND_XXX()可以通过参数NO_CMAKE_FIND_ROOT_PATH, ONLY_CMAKE_FIND_ROOT_PATH 和CMAKE_FIND_ROOT_PATH_BOTH设置查找范围
      • 或者采用对所有的FIND_XXX()都起作用的的参数CMAKE_FIND_ROOT_PATH_MODE_PROGRAM, CMAKE_FIND_ROOT_PATH_MODE_LIBRARY 和 CMAKE_FIND_ROOT_PATH_MODE_INCLUDE进行设置。

      如果你的工程不仅需要toolchain里面的工具，还有目标平台的附加库。我们还需要为这些依赖包建立一个安装文件夹，例如/home/ke/install,同时需要添加这个位置进去CMAKE_FIND_ROOT_PATH，之后FIND_XXX()才可以在这些位置进行查找。

2.5.2.2 Cross Compiling for QNX

1
2
3
4
5
6
7
8
9
10
set(CMAKE_SYSTEM_NAME QNX)

set(arch gcc_ntoarmv7le)

set(CMAKE_C_COMPILER qcc)
set(CMAKE_C_COMPILER_TARGET ${arch})
set(CMAKE_CXX_COMPILER QCC)
set(CMAKE_CXX_COMPILER_TARGET ${arch})

set(CMAKE_SYSROOT $ENV{QNX_TARGET})