CMake编译过程深度剖析与精细控制

摘要：本文面向对CMake有一定基础的开发者，深入探讨CMake如何影响编译过程，以及如何利用CMake提供的机制来获取和控制编译过程的详细信息。区别于简单的`CMAKE_VERBOSE_MAKEFILE`，本文旨在提供一种更高级的、可定制的编译信息控制方案，帮助开发者更好地理解和优化嵌入式系统的编译过程。

CMake编译过程深度剖析与精细控制

作为一名嵌入式系统工程师，我深知编译过程的每一个细节都至关重要。一个看似简单的编译错误，背后可能隐藏着复杂的配置问题。而对于资源受限的嵌入式系统，优化编译选项，减少代码体积，提高运行效率更是永恒的追求。然而，仅仅依靠“拿来主义”式的教程，复制粘贴几条命令，是无法真正掌握编译过程的精髓的。授人以鱼不如授人以渔，本文旨在帮助读者深入理解CMake与编译过程的内在联系，并掌握更精细的控制编译过程信息输出的手段。

1. 引言：超越`CMAKE_VERBOSE_MAKEFILE`的局限

CMAKE_VERBOSE_MAKEFILE无疑是CMake中最为人熟知的显示编译过程信息的手段。其原理简单粗暴，本质上就是将-v参数传递给make命令。虽然方便，但其局限性也显而易见：

信息量过大： -v参数会输出所有编译指令，包括一些无关紧要的信息，容易淹没关键信息。
无法控制输出格式： 输出格式固定，无法根据需要进行定制。
无法在CMake配置阶段输出信息： 只能在编译阶段输出，无法在CMake配置阶段进行调试。

因此，本文将带领读者探索更高级的编译过程信息控制方法，实现对编译过程的精细化管理。

2. CMake与编译过程的内在联系

CMake本质上是一个构建系统生成器。它读取CMakeLists.txt文件，根据用户的配置和目标平台的特性，生成用于构建项目的本地构建系统文件，例如Makefile（用于Unix系统）或Visual Studio解决方案（用于Windows系统）。

CMake通过变量 (Variables)、目标属性 (Target Properties) 和 命令 (Commands) 来影响最终的编译指令。

2.1 CMake变量的影响

CMake变量可以分为以下几类：

环境变量： 例如ENV{PATH}，影响CMake查找编译器和工具链的路径。
缓存变量： 例如CMAKE_BUILD_TYPE，控制构建类型（Debug, Release等），会被保存在CMakeCache.txt文件中。
普通变量： 例如用户自定义的变量，用于控制构建过程的各个方面。

一些关键的CMake变量会直接影响编译选项，例如：

CMAKE_CXX_FLAGS：C++编译器的全局编译选项。
CMAKE_C_FLAGS：C编译器的全局编译选项。
CMAKE_DEFINITIONS：全局预处理器定义。
CMAKE_INCLUDE_PATH：全局头文件搜索路径。
CMAKE_LIBRARY_PATH：全局库文件搜索路径。

示例：

# 设置全局编译选项
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -std=c++17")

# 设置全局预处理器定义
add_definitions(-DDEBUG)

# 输出CMAKE_CXX_FLAGS的值
message(STATUS "CMAKE_CXX_FLAGS: ${CMAKE_CXX_FLAGS}")

# 输出CMAKE_DEFINITIONS的值
message(STATUS "CMAKE_DEFINITIONS: ${CMAKE_DEFINITIONS}")

这段代码首先使用set()命令设置了CMAKE_CXX_FLAGS变量，添加了-Wall、-Wextra和-std=c++17编译选项。然后，使用add_definitions()命令添加了DEBUG预处理器定义。最后，使用message(STATUS ...)命令输出这两个变量的值，以便在CMake配置阶段查看。如果在CMakeLists.txt中设置CMAKE_BUILD_TYPE为Debug，则通常CMake会自动添加-g编译选项以支持调试。

2.2 Target Properties的影响

Target Properties是针对特定目标（例如可执行文件或库）的属性。它们可以覆盖全局CMake变量的设置，提供更精细的控制。

一些常用的Target Properties包括：

COMPILE_DEFINITIONS：目标特定的预处理器定义。
COMPILE_FLAGS：目标特定的编译选项。
INCLUDE_DIRECTORIES：目标特定的头文件搜索路径。
LINK_LIBRARIES：目标特定的链接库。

示例：

# 创建一个可执行文件目标
add_executable(my_app main.cpp)

# 设置目标特定的编译选项
set_target_properties(my_app PROPERTIES
    COMPILE_FLAGS "-O2 -DNDEBUG"
)

# 设置目标特定的预处理器定义
target_compile_definitions(my_app PRIVATE MY_CUSTOM_DEFINE)

# 输出my_app的COMPILE_FLAGS的值
get_target_property(COMPILE_FLAGS_VALUE my_app COMPILE_FLAGS)
message(STATUS "my_app COMPILE_FLAGS: ${COMPILE_FLAGS_VALUE}")

# 输出my_app的COMPILE_DEFINITIONS的值
get_target_property(COMPILE_DEFINITIONS_VALUE my_app COMPILE_DEFINITIONS)
message(STATUS "my_app COMPILE_DEFINITIONS: ${COMPILE_DEFINITIONS_VALUE}")

这段代码首先使用add_executable()命令创建了一个名为my_app的可执行文件目标。然后，使用set_target_properties()命令设置了my_app目标的COMPILE_FLAGS属性，添加了-O2和-DNDEBUG编译选项。使用target_compile_definitions()添加了目标特定的预处理器定义。最后，使用get_target_property()命令获取COMPILE_FLAGS属性的值，并使用message(STATUS ...)命令输出。注意target_compile_definitions的PRIVATE关键字，这意味着该定义只对my_app目标可见，而不会传递给其他目标。使用PUBLIC关键字则会将定义传递给链接到该目标的其他目标。

2.3 CMake命令的影响

CMake命令用于执行各种操作，例如添加编译选项、链接库、查找文件等。一些常用的CMake命令包括：

add_compile_options()：添加全局编译选项。
target_link_libraries()：链接库到目标。
find_package()：查找并导入外部库。
include_directories()：添加头文件搜索路径。

示例：

# 添加全局编译选项
add_compile_options(-Wall -Wextra)

# 查找并导入Boost库
find_package(Boost REQUIRED COMPONENTS system filesystem)

# 链接Boost库到目标
target_link_libraries(my_app Boost::system Boost::filesystem)

这段代码首先使用add_compile_options()命令添加了-Wall和-Wextra编译选项。然后，使用find_package()命令查找并导入Boost库。最后，使用target_link_libraries()命令将Boost库链接到my_app目标。

3. 控制编译过程信息输出的手段

3.1 利用`message()`命令进行自定义输出

message()命令是CMake中最常用的输出信息的手段。它可以用于输出各种类型的信息，例如状态信息、警告信息、错误信息等。

message()命令的语法如下：

message([STATUS|WARNING|AUTHOR_WARNING|ERROR|FATAL_ERROR] message...)

其中，STATUS表示状态信息，WARNING表示警告信息，ERROR表示错误信息，FATAL_ERROR表示致命错误信息。

示例：

# 输出当前使用的编译器版本和路径
execute_process(COMMAND ${CMAKE_CXX_COMPILER} --version OUTPUT_VARIABLE CXX_COMPILER_VERSION)
message(STATUS "C++ Compiler: ${CMAKE_CXX_COMPILER}")
message(STATUS "C++ Compiler Version: ${CXX_COMPILER_VERSION}")

# 输出关键CMake变量的值
message(STATUS "CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
message(STATUS "CMAKE_INSTALL_PREFIX: ${CMAKE_INSTALL_PREFIX}")

# 输出目标文件的编译选项
get_target_property(COMPILE_FLAGS_VALUE my_app COMPILE_FLAGS)
message(STATUS "my_app COMPILE_FLAGS: ${COMPILE_FLAGS_VALUE}")

这段代码首先使用execute_process()命令执行C++编译器，并获取其版本信息。然后，使用message(STATUS ...)命令输出编译器版本、关键CMake变量和目标文件的编译选项。

3.2 使用`execute_process()`命令捕获编译器的输出

execute_process()命令可以用于执行外部命令，并捕获其标准输出和标准错误。这可以用于更灵活地分析和展示编译过程信息。

execute_process()命令的语法如下：

execute_process(COMMAND command... 
                [WORKING_DIRECTORY directory] 
                [TIMEOUT seconds] 
                [RESULT_VARIABLE variable] 
                [OUTPUT_VARIABLE variable] 
                [ERROR_VARIABLE variable] 
                [INPUT_FILE filename] 
                [OUTPUT_FILE filename] 
                [ERROR_FILE filename] 
                [OUTPUT_QUIET] 
                [ERROR_QUIET] 
                [COMMAND_ECHO [NONE|STDOUT|STDERR|BOTH]]
               )

示例：

# 构建一个简单的C++程序
add_executable(my_app main.cpp)

# 获取可执行文件的完整路径
get_target_property(EXECUTABLE_PATH my_app LOCATION)

# 执行编译命令，并捕获标准输出和标准错误
execute_process(COMMAND ${CMAKE_CXX_COMPILER} ${CMAKE_CXX_FLAGS} -c main.cpp -o main.o
                RESULT_VARIABLE COMPILE_RESULT
                OUTPUT_VARIABLE COMPILE_OUTPUT
                ERROR_VARIABLE COMPILE_ERROR)

# 输出编译结果、标准输出和标准错误
message(STATUS "Compile Result: ${COMPILE_RESULT}")
message(STATUS "Compile Output: ${COMPILE_OUTPUT}")
message(STATUS "Compile Error: ${COMPILE_ERROR}")

#链接可执行文件
execute_process(COMMAND ${CMAKE_CXX_COMPILER} main.o -o ${EXECUTABLE_PATH}
                RESULT_VARIABLE LINK_RESULT
                OUTPUT_VARIABLE LINK_OUTPUT
                ERROR_VARIABLE LINK_ERROR)

# 输出链接结果、标准输出和标准错误
message(STATUS "Link Result: ${LINK_RESULT}")
message(STATUS "Link Output: ${LINK_OUTPUT}")
message(STATUS "Link Error: ${LINK_ERROR}")

这段代码首先使用add_executable()命令构建了一个简单的C++程序。然后，使用execute_process()命令执行编译命令，并捕获编译器的标准输出和标准错误。最后，使用message(STATUS ...)命令输出编译结果、标准输出和标准错误。通过这种方式，可以精确地获得编译器在编译过程中产生的各种信息，例如警告、错误、优化信息等。注意，在嵌入式系统中，编译器通常会输出更多的信息，例如内存使用情况、代码大小等，这些信息对于优化嵌入式系统至关重要。

警告： 使用execute_process()命令捕获编译器的输出可能会影响编译速度，特别是当编译过程非常复杂时。因此，应该谨慎使用该方法，只在必要时才启用。

3.3 利用CMake生成自定义的编译脚本

CMake可以生成各种类型的编译脚本，例如Makefile、Ninja构建文件等。我们可以编写CMake脚本，根据不同的配置生成定制化的编译脚本，并在脚本中添加更详细的编译过程信息输出。

示例：

# 设置自定义的编译脚本路径
set(CUSTOM_BUILD_SCRIPT "${CMAKE_BINARY_DIR}/build.sh")

# 生成自定义的编译脚本
configure_file(build.sh.in "${CUSTOM_BUILD_SCRIPT}" @ONLY)

# 设置构建命令为自定义的编译脚本
set_property(DIRECTORY ${CMAKE_SOURCE_DIR} PROPERTY BUILDSYSTEM_TARGETS "${CUSTOM_BUILD_SCRIPT}")

# build.sh.in文件内容
#!/bin/bash

echo "Starting build process..."

# 输出编译选项
echo "CXX Flags: ${CMAKE_CXX_FLAGS}"

# 执行编译命令
g++ main.cpp -o my_app ${CMAKE_CXX_FLAGS}

if [ $? -eq 0 ]; then
  echo "Build succeeded."
else
  echo "Build failed."
  exit 1
fi

这段代码首先使用set()命令设置了自定义的编译脚本路径。然后，使用configure_file()命令生成自定义的编译脚本。configure_file()命令会将build.sh.in文件中的变量替换为CMake变量的值，并将结果保存到CUSTOM_BUILD_SCRIPT指定的路径。@ONLY选项确保只有CMake变量被替换。最后，使用set_property()命令将构建命令设置为自定义的编译脚本。这样，每次构建项目时，CMake都会执行自定义的编译脚本。

4. 高级技巧

4.1 使用`CMAKE_EXPORT_COMPILE_COMMANDS`生成compile_commands.json

CMAKE_EXPORT_COMPILE_COMMANDS是CMake提供的一个非常有用的特性，它可以生成一个包含所有编译选项的JSON文件（compile_commands.json）。该文件可以被其他工具（例如clangd、bear）用于代码分析、自动补全、错误检查等。

使用方法：

在CMakeLists.txt文件中添加以下代码：

set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

然后，执行CMake配置和构建过程。CMake会在构建目录中生成一个compile_commands.json文件。该文件包含了所有编译单元的完整编译命令，包括编译器路径、编译选项、头文件搜索路径等。

示例：

[
  {
    "directory": "/path/to/build",
    "command": "/usr/bin/c++  -I/path/to/include -Wall -Wextra -std=c++17 -o CMakeFiles/my_app.dir/main.cpp.o -c /path/to/source/main.cpp",
    "file": "/path/to/source/main.cpp"
  }
]

优点：

方便其他工具进行代码分析和调试。
提供了一种标准化的方式来获取编译选项。

缺点：

生成的文件可能比较大，特别是当项目非常复杂时。
需要额外的工具来解析和使用该文件。

4.2 自定义编译器包装器（Compiler Wrapper）

编译器包装器是一个脚本，它位于编译器和构建系统之间，用于在编译前后执行自定义操作。例如，可以使用编译器包装器来记录编译时间、收集代码覆盖率信息、进行静态代码分析等。

原理：

编译器包装器通过修改CMAKE_CXX_COMPILER和CMAKE_C_COMPILER变量来实现。将这两个变量设置为指向包装器脚本，而不是真正的编译器。

示例：

创建包装器脚本（例如：wrapper.sh）：

#!/bin/bash

# 记录开始时间
start_time=$(date +%s)

# 执行真正的编译器
/usr/bin/g++ "$@"

# 记录结束时间
end_time=$(date +%s)

# 计算编译时间
compile_time=$((end_time - start_time))

# 输出编译时间
echo "Compile time: ${compile_time} seconds"

# 将编译器的输出保存到日志文件
echo "$@" >> compile.log

echo "Compiler Output:" >> compile.log
/usr/bin/g++ "$@" 2>&1 | tee -a compile.log

exit $?

在CMakeLists.txt文件中设置编译器变量：

# 设置编译器包装器
set(CMAKE_CXX_COMPILER "${CMAKE_SOURCE_DIR}/wrapper.sh")
set(CMAKE_C_COMPILER "${CMAKE_SOURCE_DIR}/wrapper.sh")

# 确保包装器脚本具有可执行权限
execute_process(COMMAND chmod +x "${CMAKE_SOURCE_DIR}/wrapper.sh")

优点：

可以灵活地控制编译过程，执行各种自定义操作。
可以收集编译过程的详细信息，例如编译时间、代码覆盖率等。

缺点：

需要编写和维护包装器脚本，增加了一定的复杂性。
可能会影响编译速度，特别是当包装器脚本执行的操作比较耗时时。

警告： 使用编译器包装器需要深入了解编译器的工作原理，并小心处理各种边界情况，以避免引入新的问题。例如，需要确保包装器脚本能够正确处理各种编译选项和参数。

5. 案例分析

5.1 分析开源项目的编译选项

以libjpeg-turbo为例，该项目是一个流行的JPEG图像编解码库。我们可以利用上述技巧来分析其编译选项，并尝试优化其编译过程。

生成compile_commands.json文件：

在libjpeg-turbo的CMakeLists.txt文件中添加set(CMAKE_EXPORT_COMPILE_COMMANDS ON)，然后执行CMake配置和构建过程。

分析compile_commands.json文件：

使用文本编辑器打开compile_commands.json文件，可以看到libjpeg-turbo的编译选项。例如，可以看到使用了-O3优化选项，以及一些平台特定的编译选项。

修改CMake配置，优化编译选项：

可以尝试修改CMakeLists.txt文件，例如，可以尝试使用-Ofast优化选项，或者添加一些额外的编译选项，例如-fomit-frame-pointer，以提高编译速度或减小目标文件的大小。

使用编译器包装器，记录编译时间：

可以编写一个编译器包装器，记录libjpeg-turbo的编译时间，并分析不同编译选项对编译时间的影响。

5.2 交叉编译环境下的CMake编译过程显示

在交叉编译环境中，CMAKE_SYSTEM_NAME 和 CMAKE_SYSTEM_PROCESSOR 变量至关重要。它们告诉 CMake 目标平台的操作系统和处理器架构。例如，为 ARM Cortex-M4 处理器构建时，您可能需要设置 CMAKE_SYSTEM_NAME 为 Generic 和 CMAKE_SYSTEM_PROCESSOR 为 cortex-m4。此外，你需要指定交叉编译工具链的位置，通过设置 CMAKE_C_COMPILER 和 CMAKE_CXX_COMPILER 变量指向交叉编译器的路径。

示例：

cmake_minimum_required(VERSION 3.15)
project(CrossCompileExample C CXX)

set(CMAKE_SYSTEM_NAME Generic)
set(CMAKE_SYSTEM_PROCESSOR cortex-m4)

# 指定交叉编译工具链
set(CMAKE_C_COMPILER /opt/arm-none-eabi-gcc/bin/arm-none-eabi-gcc)
set(CMAKE_CXX_COMPILER /opt/arm-none-eabi-gcc/bin/arm-none-eabi-g++)

# 设置编译和链接标志
set(CMAKE_C_FLAGS "-mcpu=cortex-m4 -mthumb -O2 -Wall -Wextra -ffunction-sections -fdata-sections -g")
set(CMAKE_CXX_FLAGS "${CMAKE_C_FLAGS} -fno-exceptions -fno-rtti")
set(CMAKE_EXE_LINKER_FLAGS "-Wl,--gc-sections")

include_directories(include)

add_executable(CrossCompileExample main.c)

# 显示编译信息
message(STATUS "CMAKE_SYSTEM_NAME: ${CMAKE_SYSTEM_NAME}")
message(STATUS "CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR}")
message(STATUS "CMAKE_C_COMPILER: ${CMAKE_C_COMPILER}")
message(STATUS "CMAKE_CXX_COMPILER: ${CMAKE_CXX_COMPILER}")
message(STATUS "CMAKE_C_FLAGS: ${CMAKE_C_FLAGS}")
message(STATUS "CMAKE_CXX_FLAGS: ${CMAKE_CXX_FLAGS}")
message(STATUS "CMAKE_EXE_LINKER_FLAGS: ${CMAKE_EXE_LINKER_FLAGS}")

在交叉编译环境下，务必仔细检查工具链的路径和编译选项，确保它们与目标平台兼容。

6. 结论

深入理解CMake和编译过程对于开发高质量的嵌入式系统至关重要。本文介绍了一些高级的编译过程控制技巧，包括利用message()命令进行自定义输出、使用execute_process()命令捕获编译器的输出、利用CMake生成自定义的编译脚本、使用CMAKE_EXPORT_COMPILE_COMMANDS生成compile_commands.json文件以及自定义编译器包装器。希望读者能够积极探索和实践这些技巧，掌握更高级的编译过程控制能力，为开发更高效、更可靠的嵌入式系统奠定坚实的基础。记住，只有真正理解编译过程的每一个细节，才能在嵌入式开发的道路上走得更远。

理解CMake命令，变量和属性如何影响编译过程至关重要。通过掌握本文介绍的技巧，您可以有效地控制和监控编译过程，从而构建出更健壮和优化的嵌入式系统。记住，深入理解构建系统是成为一名卓越的嵌入式工程师的关键一步。掌握编译选项的控制能有效优化性能

相关话题：cmake显示详细编译过程CMake 如何创建子进程?CMake和编译有什么关系?CMake如何生成可执行文件?CMake如何调整或扩展编译器标志?cmake 打印编译过程cmake 打印编译选项cmake 打印详细编译过程cmake 指定编译器cmake 显示编译命令cmake 查看编译过程

参考来源：

亚星爱游戏华体会爱游戏华体会天天盈球华体会华体会开云 MK体育 MK体育

上一篇佳能18-55自动对焦疑难杂症终结指南：镜头终结

下一篇王师傅教你：电脑下载的东西老往C盘跑？这可不行！

CMake编译过程深度剖析与精细控制

CMake编译过程深度剖析与精细控制

CMake编译过程深度剖析与精细控制

1. 引言：超越CMAKE_VERBOSE_MAKEFILE的局限

2. CMake与编译过程的内在联系

2.1 CMake变量的影响

2.2 Target Properties的影响

2.3 CMake命令的影响

3. 控制编译过程信息输出的手段

3.1 利用message()命令进行自定义输出

3.2 使用execute_process()命令捕获编译器的输出

3.3 利用CMake生成自定义的编译脚本

4. 高级技巧

4.1 使用CMAKE_EXPORT_COMPILE_COMMANDS生成compile_commands.json

4.2 自定义编译器包装器（Compiler Wrapper）

5. 案例分析

5.1 分析开源项目的编译选项

5.2 交叉编译环境下的CMake编译过程显示

6. 结论

参考来源：

1. 引言：超越`CMAKE_VERBOSE_MAKEFILE`的局限

3.1 利用`message()`命令进行自定义输出

3.2 使用`execute_process()`命令捕获编译器的输出

4.1 使用`CMAKE_EXPORT_COMPILE_COMMANDS`生成compile_commands.json