Question

NOTE : 此示例代码可以在 https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-5/recipe-07 中找到，其中包含一个 C++例子。该示例在 CMake 3.5 版（或更高版本) 中是有效的，并且已经在 GNU/Linux、macOS 和 Windows 上进行过测试。

设置编译器标志，对是否能正确编译至关重要。不同的编译器供应商，为类似的特性实现有不同的标志。即使是来自同一供应商的不同编译器版本，在可用标志上也可能存在细微的差异。有时，会引入一些便于调试或优化目的的新标志。本示例中，我们将展示如何检查所选编译器是否可用某些标志。

准备工作

Sanitizers(请参考 https://github.com/google/Sanitizers ) 已经成为静态和动态代码分析的非常有用的工具。通过使用适当的标志重新编译代码并链接到必要的库，可以检查内存错误（地址清理器)、未初始化的读取（内存清理器)、线程安全（线程清理器) 和未定义的行为（未定义的行为清理器) 相关的问题。与同类型分析工具相比，Sanitizers 带来的性能损失通常要小得多，而且往往提供关于检测到的问题的更详细的信息。缺点是，代码（可能还有工具链的一部分) 需要使用附加的标志重新编译。

本示例中，我们将设置一个项目，使用不同的 Sanitizers 来编译代码，并展示如何检查，编译器标志是否正确使用。

具体实施

Clang 编译器已经提供了 Sanitizers，GCC 也将其引入工具集中。它们是为 C 和 C++程序而设计的。最新版本的 Fortran 也能使用这些编译标志，并生成正确的仪表化库和可执行程序。不过，本文将重点介绍 C++示例。

1. 声明一个 C++11 项目：

   cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
   project(recipe-07 LANGUAGES CXX)
   set(CMAKE_CXX_STANDARD 11)
   set(CMAKE_CXX_EXTENSIONS OFF)
   set(CMAKE_CXX_STANDARD_REQUIRED ON)

2. 声明列表 CXX_BASIC_FLAGS ，其中包含构建项目时始终使用的编译器标志 -g3 和 -O1 :

   list(APPEND CXX_BASIC_FLAGS "-g3" "-O1")

3. 这里需要包括 CMake 模块 CheckCXXCompilerFlag.cmake 。C 的模块为 CheckCCompilerFlag.cmake ，Fotran 的模块为 CheckFortranCompilerFlag.cmake (Fotran 的模块是在 CMake 3.3 添加)：

   include(CheckCXXCompilerFlag)

4. 我们声明一个 ASAN_FLAGS 变量，它包含 Sanitizer 所需的标志，并设置 CMAKE_REQUIRED_FLAGS 变量， check_cxx_compiler_flag 函数在内部使用该变量:

   set(ASAN_FLAGS "-fsanitize=address -fno-omit-frame-pointer")
   set(CMAKE_REQUIRED_FLAGS ${ASAN_FLAGS})

5. 我们调用 check_cxx_compiler_flag 来确保编译器理解 ASAN_FLAGS 变量中的标志。调用函数后，我们取消设置 CMAKE_REQUIRED_FLAGS :

   check_cxx_compiler_flag(${ASAN_FLAGS} asan_works)
   unset(CMAKE_REQUIRED_FLAGS)

6. 如果编译器理解这些选项，我们将变量转换为一个列表，用分号替换空格:

   if(asan_works)
       string(REPLACE " " ";" _asan_flags ${ASAN_FLAGS})

7. 我们添加了一个可执行的目标，为代码定位 Sanitizer:

   add_executable(asan-example asan-example.cpp)

8. 我们为可执行文件设置编译器标志，以包含基本的和 Sanitizer 标志:

   target_compile_options(asan-example
     PUBLIC
       ${CXX_BASIC_FLAGS}
       ${_asan_flags}
     )

9. 最后，我们还将 Sanitizer 标志添加到链接器使用的标志集中。这将关闭 if(asan_works) 块:

   target_link_libraries(asan-example PUBLIC ${_asan_flags})
   endif()

完整的示例源代码还展示了如何编译和链接线程、内存和未定义的行为清理器的示例可执行程序。这里不详细讨论这些，因为我们使用相同的模式来检查编译器标志。

NOTE : 在 GitHub 上可以找到一个定制的 CMake 模块，用于在您的系统上寻找对 Sanitizer 的支持: https://github.com/arsenm/sanitizers-cmake ​

工作原理

check_<lang>_compiler_flag 函数只是 check_<lang>_source_compiles 函数的包装器。这些包装器为特定代码提供了一种快捷方式。在用例中，检查特定代码片段是否编译并不重要，重要的是编译器是否理解一组标志。

Sanitizer 的编译器标志也需要传递给链接器。可以使用 check_<lang>_compiler_flag 函数来实现，我们需要在调用之前设置 CMAKE_REQUIRED_FLAGS 变量。否则，作为第一个参数传递的标志将只对编译器使用。

当前配置中需要注意的是，使用字符串变量和列表来设置编译器标志。使用 target_compile_options 和 target_link_libraries 函数的字符串变量，将导致编译器和/或链接器报错。CMake 将传递引用的这些选项，从而导致解析错误。这说明有必要用列表和随后的字符串操作来表示这些选项，并用分号替换字符串变量中的空格。实际上，CMake 中的列表是分号分隔的字符串。

更多信息

我们将在第 7 章，编写一个函数来测试和设置编译器标志，到时候再来回顾，并概括测试和设置编译器标志的模式。