C / C++ / 系统课时
把 Sanitizer 加进调试构建
把 Sanitizer 加进调试构建
手工在命令行追加 Sanitizer 参数很容易遗漏,尤其当项目同时有应用、单元测试和多个库目标时。更稳妥的做法是把编译与链接参数封装成可复用的 CMake 目标,并只在调试配置中启用,让本地开发和 CI 使用同一套检查规则。
学习目标
- 用 CMake
INTERFACE目标集中管理 Sanitizer 参数 - 只让 Debug 构建启用检查,避免无意污染 Release
- 通过实际构建确认编译和链接阶段都带上 Sanitizer 选项
为什么不要把参数写到每个目标
Sanitizer 往往既需要编译参数,也需要链接参数。若在 app、unit_test、tool 等目标上分别复制,后续很容易出现某个目标只加了编译选项、另一个目标忘记更新的情况。
把这些选项放入一个 INTERFACE 库后,真正需要检查的目标只要链接这个配置目标,就能继承一致的编译和链接要求。再用 CMake 生成器表达式限制为 Debug,可避免 Release 构建意外携带 Sanitizer 运行库。

用 INTERFACE 目标封装配置
以下示例以 GCC 或 Clang 为前提,同时启用 AddressSanitizer 和 UBSan。project_sanitizers 本身不会生成库文件,它只承载使用要求。
cmake_minimum_required(VERSION 3.20)
project(c_sanitizer_demo LANGUAGES C)
option(ENABLE_SANITIZERS "Enable sanitizers in Debug builds" ON)
add_library(project_sanitizers INTERFACE)
if(ENABLE_SANITIZERS)
if(CMAKE_C_COMPILER_ID MATCHES "GNU|Clang")
target_compile_options(project_sanitizers INTERFACE
"$<$<CONFIG:Debug>:-fsanitize=address,undefined>"
"$<$<CONFIG:Debug>:-fno-omit-frame-pointer>"
)
target_link_options(project_sanitizers INTERFACE
"$<$<CONFIG:Debug>:-fsanitize=address,undefined>"
)
else()
message(WARNING
"ENABLE_SANITIZERS is ON, but this compiler is not configured")
endif()
endif()
add_executable(app src/main.c)
target_link_libraries(app PRIVATE project_sanitizers)
enable_testing()
add_test(NAME app_test COMMAND app)target_compile_options 负责插桩相关的编译参数,target_link_options 负责把相应运行库正确带入最终链接。两处都不能只写一处,否则某些工具链会在链接阶段失败或生成不完整的 Sanitizer 构建。
示例程序保持正常执行,用来确认启用 Sanitizer 后项目仍能完成构建和测试。
#include <stdio.h>
int main(void) {
puts("sanitizers ready");
return 0;
}将源码保存为 src/main.c。这段程序本身不故意制造错误;后续测试只验证配置能够稳定复用。
配置、构建并验证
在单配置生成器中,CMAKE_BUILD_TYPE=Debug 会让 $<CONFIG:Debug> 条件成立。下面命令使用独立构建目录,并通过详细构建输出确认编译和链接命令都包含 Sanitizer 参数。
cmake -S . -B build-sanitize -DCMAKE_BUILD_TYPE=Debug -DENABLE_SANITIZERS=ON >/dev/null
cmake --build build-sanitize --verbose 2>&1 | grep -- '-fsanitize=address,undefined'
ctest --test-dir build-sanitize --output-on-failure预期输出
<COMPILER> ... -fsanitize=address,undefined ... -c <PATH>/src/main.c ...
<COMPILER> ... -fsanitize=address,undefined ... -o app ...
1/1 Test #1: app_test ... Passed <TIME>
100% tests passed, 0 tests failed out of 1编译器路径、参数顺序、目标文件路径和耗时都可能不同;验证重点是编译命令与链接命令都出现 -fsanitize=address,undefined,并且测试通过。
单配置与多配置生成器不要混用
Makefiles 和普通 Ninja 通常通过 CMAKE_BUILD_TYPE 选择 Debug。Visual Studio、Xcode 和 Ninja Multi-Config 属于多配置生成器,配置阶段往往不设置 CMAKE_BUILD_TYPE,而是在构建时选择配置,例如使用 cmake --build <PATH> --config Debug。
由于本例把开关写成 $<CONFIG:Debug>,同一份 CMake 配置可以适配这两类生成器。Release 构建不会继承 Sanitizer 参数,而 ENABLE_SANITIZERS=OFF 则可以在需要时完全关闭这组规则。
当项目增加新的测试程序或工具目标时,只需让目标链接 project_sanitizers,不用复制一组编译选项。这样 Sanitizer 就成为构建系统中的显式能力,而不是依赖开发者记忆的临时命令。