大型工程的管理，CMake快速入门

绝大多数开源存储系统都是基于Linux操作系统构建，本号在介绍存储技术相关知识的同时也捎带介绍一些Linux的内容，内容偏重实用性。无论是对应用程序开发还是内核理解都会有所帮助。

当我们的工程有成千上万文件构成是，手动写Makefile文件将是噩梦。幸好CMake帮我们解决了最为棘手的问题。今天我们就介绍一下自动生成Makefile文件的工具，CMake。

我们先从一个最简单的场景开始，这种场景就是只有一个源文件的场景。当然，对于单文件的场景我们可以直接通过gcc进行编译，但是为了说明CMake的用法，我们以此作为起点。后面我们会逐步介绍更加复杂的场景。目的很简单，主要是为了降低入门的门槛，然后让大家像上台阶一样，不知不觉的爬到泰山之巅。

单文件的软件工程

我们可以先创建一个目录，比如simple，然后在这个目录中创建一个名称为main.cpp的C++程序，程序代码如下所示。

#include <iostream>

int main(int argc, char** argv)
{
    std::cout << "this is a simple example!" << "\n";
    return 0;
}

再创建一个名称为CMakeLists.txt的文件，这个文件正是cmake使用的文件。文件的内容如下，是不是很简单。

cmake_minimum_required(VERSION 3.16)
project(CMakeSunny
    VERSION 1.0
    DESCRIPTION "A CMake Tutorial"
    LANGUAGES CXX)

add_executable(cmlearn
    main.cpp)

上面文件中cmake_minimum_required用于指定cmake的最低版本号。project用于名称功能，其中包含工程名称、版本信息和工程描述等信息。最后add_executable则用于指定编程后的可执行文件名称以及源代码文件。

具备上述两个文件后，在根目录下面创建一个名称为build的目录，然后切换到目录下面，执行cmake就可以生成一个Makefile文件。然后执行make命令就可以编译出二进制文件来。具体执行的命令如下：

mkdir build
cd build
cmake ..
make

下图展示了上述文件的关系，main.cpp和CMakeLists.txt是我们创建的。目录build中的目录和文件分别是通过cmake和make命令生成的。最终生成的二进制文件也是在build目录中，名称为cmlearn，这个名称是在CMakeLists.txt定义的。    

多文件的软件工程

更进一步，如果我们的软件工程通常包含不止一个文件，比如我们这里增加一个做加法的函数，这个函数在一个独立的文件中。此时工程中包含3个独立的文件，分别为main.cpp、add.cpp和头文件add.h。此时我们自己创建的文件目录结构如下图所示。

接下来我们只需要做很简单的改动就可以将新文件的内容编译进来。如下代码所示，我们在add_executable中添加add.cpp文件即可。

cmake_minimum_required(VERSION 3.16)
project(CMakeSunny
    VERSION 1.0
    DESCRIPTION "A CMake Tutorial"
    LANGUAGES CXX)

add_executable(add
    main.cpp
    add.cpp)

上述add.cpp文件的内容如下所示，其功能很简单，就是实现一个加法功能。         

int add(int a, int b)
{
    return a+b;
}

头文件的实现更加简单，具体内容如下所示。需要注意的是，我们这里仅仅是为了延时CMake的功能，很多产品级必须的代码名没有写到这里。

int add(int a, int b);

为了验证实现的正确性，我们可以在main.cpp中做一些修改，引用在add.cpp中实现的函数。具体修改后的内容如下所示。

#include <iostream>
#include "add.h"

int main(int argc, char** argv)
{
    int r = add(1, 3);
    std::cout << "this is a simple example!" << r << "\n";
    return 0;
}

完成上述修改后，大家可以切回到build目录中，重新执行cmake ..和make命令，可以看到生成了新的二进制文件cmlearn。我们可以执行一下这个程序，可以看到结果符合预期。

包含子目录的软件工程

实际的大型项目比上面介绍的还要复杂的多。比如上文我们提到实现了一个加法功能的add.cpp文件。比如我们又要实现减法、乘法和除法等功能，也都是在独立的文件中实现。那么这些计算的实现最好放到一个目录中，比如math目录。在大型项目中经常会这样组织源代码，一个功能模块的代码，或者详细功能的代码被组织在一个子目录中。

这是源代码会被组织成如下图所示的结构，而且在子目录math中也需要新建一个名称为CMakeLists.txt文件。该文件的内容可以非常简单，具体如下所示，是不是很简单！    

add_library(math  OBJECT  sub.cpp
                          add.cpp)

函数add_library用于创建一个库，这里的库与Linux的动态库和静态库的概念基本对应，但不完全一样。本例是创建一个OBJECT类型的库，其实就是生成目标文件。如前文所述，这个函数可以创建Linux的动态库和静态库，我们后面会详细介绍一下这方面的内容。

如下是该函数的几种应用场景，比如STATIC是静态库，SHARED是动态库，OBJECT则是我们当前使用的目标文件。另外还有MODULE、INTERFACE和IMPORTED等类型。

add_library(<name> [STATIC | SHARED | MODULE]
            [EXCLUDE_FROM_ALL]
            [<source>...])
add_library(<name> OBJECT [<source>...])
add_library(<name> INTERFACE)
add_library(<name> <type> IMPORTED [GLOBAL])

有了子目录中的CMakeLists.txt还不够，我们需要在根目录的CMakeLists.txt添加一些内容，建立根目录与子目录math的联系。建立联系很简单，我们只需要在根目录的CMakeLists.txt中添加如下一行代码即可。    

add_subdirectory(math)

当添加上述代码后，我们在build目录再次执行cmake命令的时候可以触发子目录生成Makefile文件。而执行make命令进行编译的时候，可以触发子目录的编译，生成目标文件。

target_link_libraries(cmlearn PUBLIC math)

上述函数实现了链接的功能，将子模块math链接到了主模块main上，最终会生成一个可执行程序。但是我们在源代码层面还没有任何更该，主程序也没有调用add.cpp和sub.cpp中的任何函数，所以实际上也不存在链接的过程。

如果让主程序调用math中的函数，首先需要在主程序中包含头文件。在CMakeLists.txt中需要添加如下代码来告诉编译器头文件的位置。否则在编译的时候会有找不到头文件的错误提示。

target_include_directories(cmlearn PUBLIC
                          "${PROJECT_SOURCE_DIR}/math"
                          )

完成CMakeLists.txt的修改后，我们最后需要修改一下主程序。修改主程序的目的主要是让主程序调用math中实现的函数。修改后的主程序如下所示，在主程序中调用了add和sub两个函数，并且在一开始包含了add.h和sub.h两个文件。         

#include <iostream>
#include "add.h"
#include "sub.h"

int main(int argc, char** argv)
{
    int sum = add(1, 3);
    int diff = sub(3, 1);
    std::cout << "The sum of 1 and 3 is " << sum << std::endl;
    std::cout << "The diff of 3 and 1 is " << diff << std::endl;
    return 0;
}

完成上述修改后，我们可以在build目录执行“cmake ..”命令，然后执行make命令编译程序，最后可以得到一个可执行程序。

通过上面的举例，我们对通过CMake来维护一个大型的软件项目有了一个初步的了解。实际上CMake实现的功能还要丰富的多， 我们在后续会详细介绍。

存储相关文章