C++ `sanitizers` (ASan, UBSan, MSan)：编译期与运行时错误检测的极致应用

哈喽，各位好！今天咱们来聊聊C++里那些“找茬”专家——Sanitizers（ASan, UBSan, MSan）。它们就像是你的代码的严格监工，专门揪出你代码里那些潜藏的bug，防患于未然。与其等到程序崩溃或者产生莫名其妙的结果，不如让Sanitizers提前告诉你问题所在，让你有充足的时间去解决。

什么是Sanitizers？

Sanitizers是一组强大的运行时错误检测工具，它们通过在编译时插入额外的检查代码，然后在程序运行时监控内存访问、未定义行为等。一旦发现问题，Sanitizers会立即报告错误信息，包括错误类型、发生位置等等。它们能帮助我们发现很多用传统调试方法难以发现的bug。

Sanitizers家族成员

AddressSanitizer (ASan): 内存错误检测专家。它能检测出诸如堆溢出、栈溢出、使用释放后的内存、使用未初始化的栈内存等问题。可以理解为内存管理方面的“啄木鸟”。
UndefinedBehaviorSanitizer (UBSan): 未定义行为检测大师。 C++标准定义了很多行为，但同时也留下了很多“未定义行为”的灰色地带。UBSan就是专门来揪出这些未定义行为的，比如整数溢出、空指针解引用、访问未对齐的内存等。
MemorySanitizer (MSan): 未初始化内存读取检测。它可以检测使用未初始化内存的情况。与ASan关注内存边界不同，MSan关注的是数据本身是否被初始化。

为什么我们需要Sanitizers？

C++以其性能和灵活性著称，但也因此容易出现各种难以调试的bug，特别是内存错误和未定义行为。这些bug往往潜伏得很深，可能在特定的输入条件下才会触发，而且一旦触发，后果可能非常严重。

Sanitizers的出现，就是为了解决这些问题。它们能够在开发和测试阶段尽早地发现这些bug，从而降低修复成本，提高代码质量。

如何使用Sanitizers？

使用Sanitizers非常简单，只需要在编译和链接时加上相应的编译选项即可。

GCC/Clang:
- ASan: -fsanitize=address
- UBSan: -fsanitize=undefined
- MSan: -fsanitize=memory (需要额外的链接选项，见下文)
MSVC (Visual Studio):
- ASan: /fsanitize=address
- UBSan: /fsanitize=undefined (部分功能)
- MSan 不原生支持，但可以使用第三方工具或者其他内存检测工具。

ASan：内存错误检测

ASan的工作原理是在程序运行时，对内存进行额外的保护和监控。它会在每个分配的内存块前后添加“红区”（redzone），用于检测堆溢出和堆下溢。同时，ASan还会记录每个内存块的分配和释放信息，用于检测使用释放后的内存。

示例代码：堆溢出

#include <iostream>

int main() {
  int *arr = new int[5];
  for (int i = 0; i <= 5; ++i) { // 故意越界访问
    arr[i] = i;
  }
  delete[] arr;
  return 0;
}

编译并运行：

g++ -fsanitize=address heap_overflow.cpp -o heap_overflow
./heap_overflow

ASan会输出详细的错误信息，告诉你发生了堆溢出，以及溢出的位置。

示例代码：使用释放后的内存

#include <iostream>

int main() {
  int *ptr = new int(10);
  delete ptr;
  *ptr = 20; // 使用释放后的内存
  return 0;
}

编译并运行：

g++ -fsanitize=address use_after_free.cpp -o use_after_free
./use_after_free

ASan会检测到使用了已经释放的内存，并报告错误。

示例代码：栈溢出

#include <iostream>

void recursive_function(int n) {
  char buffer[1024]; // 栈上的缓冲区
  if (n > 0) {
    recursive_function(n - 1);
  } else {
    buffer[2048] = 'A'; // 栈溢出
  }
}

int main() {
  recursive_function(10);
  return 0;
}

编译并运行：

g++ -fsanitize=address stack_overflow.cpp -o stack_overflow
./stack_overflow

ASan会检测到栈溢出。

UBSan：未定义行为检测

UBSan的工作原理是在编译时插入额外的检查代码，用于检测各种未定义行为。一旦检测到未定义行为，UBSan会立即报告错误信息。

示例代码：整数溢出

#include <iostream>
#include <limits>

int main() {
  int x = std::numeric_limits<int>::max();
  int y = x + 1; // 整数溢出
  std::cout << "y = " << y << std::endl;
  return 0;
}

编译并运行：

g++ -fsanitize=undefined integer_overflow.cpp -o integer_overflow
./integer_overflow

UBSan会检测到整数溢出。

示例代码：空指针解引用

#include <iostream>

int main() {
  int *ptr = nullptr;
  std::cout << *ptr << std::endl; // 空指针解引用
  return 0;
}

编译并运行：

g++ -fsanitize=undefined null_dereference.cpp -o null_dereference
./null_dereference

UBSan会检测到空指针解引用。

示例代码：访问未对齐的内存

#include <iostream>

struct Aligned {
  char c;
  int i;
};

int main() {
  char buffer[sizeof(Aligned) + 1];
  Aligned *ptr = reinterpret_cast<Aligned*>(buffer + 1); // 未对齐的指针
  ptr->i = 10; // 访问未对齐的内存
  return 0;
}

编译并运行：

g++ -fsanitize=undefined unaligned_access.cpp -o unaligned_access
./unaligned_access

UBSan会检测到访问未对齐的内存。

MSan：未初始化内存读取检测

MSan检查的是程序是否读取了未初始化的内存。这与ASan检查内存边界不同，MSan关注的是数据本身是否被赋初值。

示例代码：读取未初始化的变量

#include <iostream>

int main() {
  int x; // 未初始化的变量
  std::cout << x << std::endl; // 读取未初始化的变量
  return 0;
}

编译和运行MSan比较特殊，需要一些额外的步骤：

g++ -fsanitize=memory -fno-omit-frame-pointer -g uninitialized_read.cpp -o uninitialized_read
LD_LIBRARY_PATH=/usr/lib/llvm-版本号/lib ./uninitialized_read

解释：

-fsanitize=memory：启用MSan。
-fno-omit-frame-pointer：MSan需要帧指针来更好地进行分析。
-g：添加调试信息，可以帮助MSan提供更准确的错误报告。
LD_LIBRARY_PATH：设置动态链接库的路径，因为MSan的运行时库可能不在默认路径下。你需要根据你的系统安装的llvm版本号进行修改。

MSan会检测到读取了未初始化的变量。

Sanitizers 的局限性与注意事项

性能开销: Sanitizers会带来一定的性能开销，因为它们需要在运行时进行额外的检查。因此，建议只在开发和测试阶段使用Sanitizers，不要在生产环境中使用。虽然性能开销在现在CPU性能富裕的时代已经可以忽略不计，但在一些对性能有极致要求的场合，仍然需要注意。
误报: 少数情况下，Sanitizers可能会产生误报，特别是对于一些复杂的代码。如果遇到误报，需要仔细检查代码，确认是否真的存在问题。
并非万能: Sanitizers只能检测运行时错误，对于编译时错误和其他类型的错误，它们无能为力。
MSan的使用: MSan 的使用相对复杂，需要注意链接库的配置，并且与一些优化选项可能不兼容。同时， MSan对代码的侵入性也比较大，会导致编译时间显著增加。
与其它工具的配合: 可以将Sanitizers与静态分析工具（例如 Clang Static Analyzer）结合使用，以获得更好的代码质量保证。

Sanitizers 的配置与自定义

Sanitizers 提供了一些环境变量，可以用来配置其行为，例如：

ASAN_OPTIONS: 用于配置 ASan 的行为，例如设置错误报告的详细程度、控制是否在发生错误时终止程序等。
UBSAN_OPTIONS: 用于配置 UBSan 的行为。
MSAN_OPTIONS: 用于配置 MSan 的行为。

例如，可以使用 ASAN_OPTIONS=halt_on_error=0 来禁止 ASan 在发生错误时终止程序，而是继续运行，以便发现更多的错误。

你还可以通过编写自定义的错误处理函数，来替换 Sanitizers 默认的错误报告机制。这可以让你更好地控制错误报告的格式和内容，或者将错误信息发送到远程服务器进行分析。

表格总结

Sanitizer	功能	编译选项 (GCC/Clang)	编译选项 (MSVC)	性能开销	备注
ASan	内存错误检测 (堆溢出, 栈溢出, Use-After-Free)	`-fsanitize=address`	`/fsanitize=address`	中等	强烈推荐使用，能够发现大部分内存相关的错误。
UBSan	未定义行为检测 (整数溢出, 空指针解引用)	`-fsanitize=undefined`	`/fsanitize=undefined`	轻微	能够发现很多隐蔽的bug，但需要注意误报的情况。
MSan	未初始化内存读取检测	`-fsanitize=memory`	不原生支持	较高	使用较为复杂，需要额外的配置，对编译时间影响较大。

最佳实践

尽早集成: 尽早在开发过程中集成 Sanitizers，最好在每次构建时都运行 Sanitizers。
自动化测试: 将 Sanitizers 集成到自动化测试流程中，以便在每次代码提交后自动检测错误。
仔细分析错误报告: Sanitizers 提供的错误报告通常非常详细，仔细分析错误报告，可以帮助你快速定位问题。
持续改进: 根据 Sanitizers 的报告，持续改进代码质量，减少错误发生的可能性。

总结

Sanitizers是C++开发者的得力助手，它们能够帮助我们发现并修复各种难以调试的bug，提高代码质量，减少程序崩溃的风险。尽管有一定的性能开销，但在开发和测试阶段使用Sanitizers是非常值得的。希望大家都能熟练掌握Sanitizers的使用，让自己的代码更加健壮、可靠。

记住，代码就像你的孩子，需要细心呵护，而Sanitizers就是你手中的放大镜，能帮你发现孩子身上的小毛病，让它健康成长！祝大家编程愉快，bug 退散！

发表回复 取消回复

发表回复取消回复