C++ AddressSanitizer 内存错误检测指南

在编写和调试 C++ 程序时，内存错误是一个常见的问题。这些错误可能导致程序崩溃、数据损坏或安全漏洞。为了帮助开发者更有效地定位和修复这些问题，Google 提供了一个强大的工具——AddressSanitizer (ASan)。

什么是 AddressSanitizer？

AddressSanitizer 是一个运行时内存错误检测器，它可以在程序运行时检查各种内存相关错误，包括：

• 堆溢出：访问分配给其他对象或未分配的内存。
• 栈溢出：访问超出函数局部变量范围的内存。
• 野指针：使用已经释放的内存地址。
• 双重释放：多次释放同一个内存块。
• 使用未初始化的内存：读取未初始化的内存值。

通过实时监控内存使用情况，AddressSanitizer 可以快速定位到错误发生的位置，从而大大提高了开发效率。

如何安装和使用 AddressSanitizer？

安装 AddressSanitizer

大多数现代编译器都支持 AddressSanitizer，包括 GCC 和 Clang。以下是安装步骤：

在 Ubuntu 上安装

sudo apt-get update
sudo apt-get install clang

在 macOS 上安装

brew install llvm

使用 AddressSanitizer 编译程序

假设你有一个简单的 C++ 程序 example.cpp，你可以使用以下命令来编译并启用 AddressSanitizer：

clang++ -fsanitize=address -g example.cpp -o example

解释：

• -fsanitize=address：启用 AddressSanitizer。
• -g：生成调试信息，方便定位错误位置。

运行程序

编译完成后，运行你的程序：

./example

如果程序中存在内存错误，AddressSanitizer 会立即报告错误信息，例如：

=================================================================
==12345==ERROR: AddressSanitizer: heap-buffer-overflow on address 0x6020000000b8 at pc 0x0000004007c6 bp 0x7ffc0a3f9d10 sp 0x7ffc0a3f9d08
WRITE of size 4 at 0x6020000000b8 thread T0
    #0 0x4007c5 in main /path/to/example.cpp:10
    #1 0x7ffff7bae82f in __libc_start_main (/lib/x86_64-linux-gnu/libc.so.6+0x2082f)
    #2 0x4006e8 in _start (/path/to/example)

0x6020000000b8 is located 8 bytes to the right of 4-byte region [0x6020000000b0,0x6020000000b4)
allocated by thread T0 here:
    #0 0x4007b0 in operator new(unsigned long) /usr/bin/../lib/gcc/x86_64-linux-gnu/9/../../../../include/c++/9/new:84
    #1 0x4007b0 in main /path/to/example.cpp:8
    #2 0x7ffff7bae82f in __libc_start_main (/lib/x86_64-linux-gnu/libc.so.6+0x2082f)
    #3 0x4006e8 in _start (/path/to/example)

SUMMARY: AddressSanitizer: heap-buffer-overflow /path/to/example.cpp:10 in main
Shadow bytes around the buggy address:
  0x0c047fff7fe0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  0x0c047fff7ff0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  0x0c047fff8000: fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa
  0x0c047fff8010: fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa
  0x0c047fff8020: fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa
=>0x0c047fff8030: fa fa fa fa fa fa fa fa fa[fa]fa fa fa fa fa fa
  0x0c047fff8040: fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa
  0x0c047fff8050: fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa
  0x0c047fff8060: fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa
  0x0c047fff8070: fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa
  0x0c047fff8080: fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa fa
Shadow byte legend (one shadow byte represents 8 application bytes):
  Addressable:           00
  Partially addressable: 01 02 03 04 05 06 07 
  Heap left redzone:       fa
  Freed heap region:     fd
  Stack left redzone:      f1
  Stack mid redzone:       f2
  Stack right redzone:     f3
  Stack after return:      f5
  Stack use after scope:   f8
  Global redzone:          f9
  Global init order:       f6
  Poisoned by user:        fc
  Container overflow:      fc
  Array cookie:            ac
  Intra object redzone:    bb
  ASan internal:           fe
  Left alloca redzone:     ca
  Right alloca redzone:    cb
  Shadow gap:              cc
==12345==ABORTING

这个错误信息告诉我们，在 example.cpp 的第 10 行发生了堆缓冲区溢出，尝试写入 4 字节的数据到地址 0x6020000000b8。

常见问题及解决方法

1. 忽略已知的内存泄漏

有时候，你可能希望忽略一些已知的内存泄漏，可以使用 --asan-incompatible-module 参数来指定不需要检测的模块：

clang++ -fsanitize=address --asan-incompatible-module=/path/to/module example.cpp -o example

2. 忽略特定的错误类型

如果你只想检测某些类型的错误，可以使用 --asan-suppressions-file 参数来指定一个抑制文件：

clang++ -fsanitize=address --asan-suppressions-file=suppressions.txt example.cpp -o example

抑制文件示例：

# Suppress heap-use-after-free errors
heap-use-after-free {
  fun:myFunction
}

3. 性能优化

AddressSanitizer 会对性能产生一定影响，特别是在大型项目中。可以通过以下方式优化性能：

• 使用 --asan-detect-leaks=0 来禁用泄漏检测。
• 使用 --asan-globals=0 来禁用全局变量的检测。
• 使用 --asan-thread-leak=0 来禁用线程泄漏检测。

结论

AddressSanitizer 是一个非常强大且易于使用的工具，可以帮助开发者高效地发现和修复 C++ 程序中的内存错误。通过理解其工作原理和正确使用方法，你可以在开发过程中显著提高代码质量和稳定性。希望本文对你有所帮助！