以基于MLIR的项目为例子学习用Cmake管理项目

前言

学习Cmake的原因：在之前接触过使用MLIR编译器框架开发的项目，但是MLIR框架用CMake工具来管理多个文件，导致框架开发难度高学习成本高。于是开始探究在IDE中点击运行按钮后的一系列工作原理。最后将结合MLIR开源的项目Hector来逐步讲解Cmake编译过程。

Cmake概览

Cmake简介

CMake是一个跨平台的构建系统生成器，可以轻松地使用相同的CMake配置在不同的操作系统中构建项目，极大地简化了跨平台开发的复杂性。

Cmake工作流程

Cmake整个过程包括了三个部分，分别是配置、生成和构建
1. CMakeLists.txt文件位置
CMakeList文件中包含了CMake的配置信息，用于指导CMake如何构建软件项目
下图展示了Hector项目中的二级文件树状图，每一个文件夹中包含了CmakeList.txt，CmakeLists.txt文件总是定位在项目的每一个顶层文件夹中

2.配置文件
在配置阶段总共涉及三个步骤

1. 读取CMakeList.txt
2. 生成CMakeCache.txt
   CMakeCache.txt存储CMake变量，包括编译路径和库路径，下图中说明了在CMakeCache中存储的C++ 编译器绝对路径
   3. 执行CMakeLists.txt中的命令

3.生成文件
使用Ninja生成器时，将生成一系列构建文件，例如build.ninja。build.ninja文件中包含了一些列详细的构建规则，包含指导原文件生成目标文件的一系列指令。

4.构建
在上一个步骤中已经产生了所有指导产生结果的命令，需要在构建环节中逐一执行这些指令，经过再一次编译、链接生成最终的产物(可执行文件)

上述的整体流程图如下：

Cmake基本命令

配置命令

配置命令作用在配置和生成的阶段，用于生成构建文件，需要制定一些构建选项：
比如构建类型、生成器类型以及其他的变量
首先需要创建一个构建文件夹，用于隔离代码源文件和构建文件

mkdir build && cd build

执行配置命令，通常需要指定命令行选项：

选项	含义
-G	生成器类型
-D	设置CMake变量
-B	构建目录
-S	源文件目录

例子：

cmake -G "Ninja" -B <构建目录> -S <源代码目录> -D <varibale>

构建命令

配置完成后可以执行构建命令，得到最终的执行文件

ninja 

或者

cmake --build .  --target <target_object> -j <process_number>

个人人为Cmake构建命令采取的是一种更加自动化完善的方式，不需要在命令行中指定额外的参数。直接编译文件需要用参数来指定文件的搜索路经、库文件搜索路经等，复杂度较高,可变化性较差。比如：

clang -I </path/to/include> -L </path/to/library>source.cpp -o output

采取自动化的Cmake配置命令后，可以降低命令行输入的复杂程度

CmakeLists中的脚本命令

命令	解释
set()	设置缓存或者环境变量
message()	打印日志消息
include()	加载运行CMake 代码
foreach()	执行循环

CmakeLists中的项目管理命令

Cmake提供了大量的项目管理命令用于说明项目的构建规则，确定可执行文件、编译目标，CPP标准

命令	解释
cmake_minimum_required()	设置缓存或者环境变量
message(STATUS " ")	在CMake配置过程中打印状态消息
add_subdirectory()	向构建中添加一个子目录
include_directories()	包含头文件目录
find_package()	查找并使用外部库和包
target_link_libraries()	指定链接给定目标所需的库
add_executable()	用于指定要生成的可执行文件以及该文件
add_library()	生成一个库

特别讲解find_package()项目管理命令

在使用MLIR框架时，需要桥接到MLIR的第三方库，加载MLIR框架的头文件路径、库文件路径以及MLIR其他的Cmake模块。
find_package()采用了两种搜索模式,一种是模搜索模式另一种配置模式，MLIR框架使用的配置搜索模式，Config模式会尝试定位提供的配置文件，需要在缓存中设置一个名为<PackageName>_DIR 的缓存条目。因此在配置standalone模块项目时，会额外增加DMLIR_DIR 缓存条目，来添加MLIRConfig.cmake文件路径