programming

Makefile & CMake

Makefile & CMake

想象一下我们有如下C++程序hello.cpp：

1
2
3
4
5

#include <iostream>
int main()
{
    std::cout << "hello world!" << std::endl;
}

我们需要在终端输入以下指令：

1

$ g++ hello.cpp -o hello

这时我们就可以生成可执行文件hello。但在实际应用场景中，我们可能会面临如下问题：

  • 项目中的.h文件和.cpp文件十分繁多。
  • 各.h文件、.cpp文件的依赖关系十分复杂。
  • 多文件可能会出现重复编译的情况，拖慢编译速度。
  • …

为了解决这些问题，makefile和CMake应运而生。

本讲需要使用到的工具：g++，make，cmake。可以通过以下方式安装：

1

$ sudo apt-get install g++ make cmake

Makefile

makefile文件描述了C/C++工程的编译规则，可以用来指明源文件的编译顺序、依赖关系、是否需要重新编译等，自动化编译C/C++项目（实际上也不止局限于C/C++项目）。

我们可以考虑以下实例：

1
2
3
4
5

.
├── invsqrt.cpp
├── invsqrt.h
├── main.cpp
└── makefile

makefile如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

CXXFLAGS = -std=c++17 -O2

main: main.o invsqrt.o
	$(CXX) $(CXXFLAGS) -o $@ $^  

main.o: main.cpp invsqrt.h
	$(CXX) $(CXXFLAGS) -o $@ -c $<

invsqrt.o: invsqrt.cpp invsqrt.h
	$(CXX) $(CXXFLAGS) -o $@ -c $<

.PHONY: clean
clean:
	rm main.o invsqrt.o main

我们不需要理解每一段代码的具体含义（之后我们可以看到，我们不需要手动编写makefile，而可以直接通过CMake工具生成makefile），我们只需要了解如何使用makefile：

  • 在makefile的同目录下输入make，就可以按照makefile所指定的编译规则自动编译整个工程。
  • 在makefile的同目录下输入make clean，可以删除编译生成的中间文件和可执行文件。
  • 除此之外，你还可以为makefile添加更多指令，此处由于篇幅所限，不再展开介绍。

CMake

makefile存在以下问题：

  • 语法复杂，代码可读性差，难以维护。
  • 跨平台性差。

在目前的C++工程中，我们多使用CMake来管理项目。

什么是CMake？CMake是一种跨平台的编译工具，可以用较为简洁易读的语法描述C++项目的编译、链接、安装过程等，在现代C++项目上得到了广泛应用。

1 第一个CMake项目

CMake的项目文件叫做CMakeLists.txt。其放置位置如下图所示：

1
2

├── CMakeLists.txt
└── main.cpp

该项目的CMakeLists.txt中需要添加以下内容：

1
2
3

cmake_minimum_required(VERSION 3.5)
project (hello_world)
add_executable(hello_world main.cpp)

语法总结1

  • cmake_minimum_required(VERSION 3.5) CMake需要的最小版本。CMake的版本可以在命令行中输入cmake --version获取，一般无强制要求。
  • project(<project_name>) 指定工程名称。
  • add_executable(<executable_name> <cppfile_name>) 生成可执行文件。

cmake工具的使用一般分为两步 1) 使用CMakeLists.txt生成makefile。 2) 使用makefile自动化编译项目。

  1. 输入cmake CMakeLists.txt，目录下将会生成一个Makefile文件。
  2. 输入make，即可将源代码编译生成可执行文件。此处将会在与CMakeLists.txt相同目录的位置生成一个可执行文件hello_word，输入./hello_word即可运行该可执行文件。
  3. 此外，输入make help，你也可以查看使用当前的Makefile所能执行的所有指令，例如make clean（清楚生成的可执行文件和中间文件）。

2 多文件

在平时的程设小作业中，我们习惯将所有的代码都写在一个.cpp文件中。但在实际工程中，为了方便代码复用和运行维护，通常将所有的文件划分为头文件(.h)，模块文件(.cpp)和主程序文件(.cpp)。

在本节中，我们将在头文件中声明一个计算平方根倒数的函数，在模块文件中实现其主体，然后在主函数中调用它。项目结构如下：

1
2
3
4
5
6
7

.
├── CMakeLists.txt
├── include
│   └── invsqrt.h
└── src
    ├── invsqrt.cpp
    └── main.cpp

tips: 在C++工程中，我们通常在include/目录下放置头文件，在src/目录下放置源文件。

该项目的CMakeLists.txt中需要添加以下内容：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# build part
cmake_minimum_required(VERSION 3.5)
project(invsqrt)
set(SOURCES src/invsqrt.cpp src/main.cpp)
add_executable(invsqrt ${SOURCES})
target_include_directories(invsqrt PUBLIC ${PROJECT_SOURCE_DIR}/include)

# debug part
message("CMAKE_SOURCE_DIR: ${CMAKE_SOURCE_DIR}")
message("PROJECT_SOURCE_DIR: ${PROJECT_SOURCE_DIR}")

message("SOURCES: ${SOURCES}")

语法总结2

  • set(<variable> <value>) 设置变量
  • target_include_directories(<project_name> <INTERFACE|PUBLIC|PRIVATE> <headfile_directory>) 指定所要包含的头文件。
  • message("your message") 在终端打印信息。

这里需要特别说明一下CMake中的变量使用。CMake中的变量分为两种：

  • 显式变量：使用set指令定义的变量。
  • 隐式变量：通过其它指令隐式生成的变量。如该项目中会隐式生成PROJECT_SOURCE_DIR变量，默认为CMakeLists.txt所在的文件夹。

CMake中有丰富的变量，用于定义工程目录、编译选项等，此处不做过多展开。想要了解更多，可以参考文末列出的参考文档。

3 静态库和动态库

有些时候，出于方便复用、防止源码泄露等原因，我们需要将代码封装为静态库和动态库。CMake同样提供了生成静态库和动态库的功能。

3.1 静态库

在此处，我们将上一小节中计算平方根倒数的程序封装为静态库。项目结构如下：

1
2
3
4
5
6
7

.
├── CMakeLists.txt
├── include
│   └── invsqrt.h
└── src
    ├── invsqrt.cpp
    └── main.cpp

该项目的CMakeLists.txt中需要添加以下内容：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

cmake_minimum_required(VERSION 3.5)
project(invsqrt)

# create static library
add_library(invsqrt_static STATIC src/invsqrt.cpp)
target_include_directories(invsqrt_static PUBLIC ${PROJECT_SOURCE_DIR}/include)

# create executable
add_executable(invsqrt src/main.cpp)
target_link_libraries(invsqrt PRIVATE invsqrt_static)

语法总结3

  • add_library(<library_name> STATIC <cppfile_name>) 生成静态库
  • target_link_libraries(<executable> <INTERFACE|PUBLIC|PRIVATE> <library_name>) 指定所要链接的库。

此处我们使用一种更为优雅的生成方式——我们期望将生成的静态库、可执行文件输出到build文件夹里，而不是和主项目混杂在一起。为此我们需要输入以下指令：

1
2
3
4

$ mkdir build
$ cd build
$ cmake .. # 使用的是上一层目录的CMakeLists.txt，因此需要输入'..'
$ make

我们将会在build/目录下看到静态库libinvsqrt_static.a和可执行文件invsqrt。

3.2 动态库

项目目录结构同静态库一节。

该项目的CMakeLists.txt中需要添加以下内容：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

cmake_minimum_required(VERSION 3.5)
project(invsqrt)

# create shared library
add_library(invsqrt_shared SHARED src/invsqrt.cpp)
target_include_directories(invsqrt_shared PUBLIC ${PROJECT_SOURCE_DIR}/include)

# create executable
add_executable(invsqrt src/main.cpp)
target_link_libraries(invsqrt PRIVATE invsqrt_shared)

语法总结4

  • add_library(<library_name> SHARED <cppfile_name>) 生成动态库

同样按照上小节的方法生成项目。我们将会在build/目录下看到动态库libinvsqrt_shared.so和可执行文件invsqrt。

4 使用第三方库

在实际的C++工程中，我们可能需要链接一些开源的第三方库。CMake也提供了相关的配置方式。我们以谷歌开发的单元测试框架googletest为例：

googletest的安装方法：

1
2
3
4
5
6
7
8
9

$ git clone https://github.com/google/googletest.git
# or git clone git@github.com:google/googletest.git
$ cd googletest
$ mkdir build 
$ cd build
$ cmake ../
$ make -j all
$ make install 
# or sudo make install

在默认情况下，与该第三方库相关的头文件将会被放置在/usr/local/include目录下，与该第三方库相关的库文件将会被放置在/usr/local/lib目录下，与该第三方库相关的可执行文件将会被放置在/usr/local/bin目录下。

项目结构如下：

1
2
3
4
5
6
7

.
├── CMakeLists.txt
├── include
│   └── mysqrt.h
└── src
    ├── mysqrt.cpp
    └── main.cpp

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

cmake_minimum_required(VERSION 2.6)

project(cmake_with_gtest)

set(SOURCES src/mysqrt.cpp src/main.cpp)

find_package(GTest)
message("GTEST_LIBRARIES: ${GTEST_LIBRARIES}")
message("GTEST_INCLUDE_DIRS: ${GTEST_INCLUDE_DIRS}")

include_directories(${GTEST_INCLUDE_DIRS} ${PROJECT_SOURCE_DIR}/include)

add_executable(cmake_with_gtest ${SOURCES})
target_link_libraries(cmake_with_gtest ${GTEST_LIBRARIES} pthread)

语法总结5

  • find_package(<package_name>) 查询第三方库的位置。若查找成功，则初始化变量<package_name>_INCLUDE_DIR（第三方库的头文件目录）以及<package_name>_LIBRARIES（第三方库的静态/动态库目录）。

CMake支持的所有第三方库可以在https://cmake.org/cmake/help/latest/manual/cmake-modules.7.html中找到。

写在最后

CMake还有很多强大的功能：

  • 设置C++工程的语言标准、编译优化选项。
  • 层级文件之间CMakeLists.txt的相互调用，以便应用于目录层级更加复杂的C++工程。
  • 对生成的库、可执行文件等进行安装。
  • …

略过上述内容不会对我们的教学产生太大影响。感兴趣的同学可以参考以下文章：

© 2022 - 2023 Ther's Blog
Built with Hugo
Theme Stack designed by Jimmy
visitors: total visits: time(s) reads: time(s)