# AddressSanitizer（ASan）使用说明

AddressSanitizer（ASan）是 Google 在 LLVM/GCC 生态中提供的一种内存错误检测工具，常用于定位 C/C++ 程序中的越界访问、空指针解引用、Use After Free、栈溢出等问题。它最早被总结为“AddressSanitizer: A Fast Address Sanity Checker (opens new window)”，核心思想是通过在编译期和运行期插入额外的检测逻辑，实时检查内存访问是否合法。

# 1. ASan 是什么

ASan 的作用可以简单理解为：

它不是普通的调试器，而是一种“编译期 + 运行期”的内存检测工具。
它会在程序运行时自动检查每一次内存访问是否越界、是否使用了已释放的内存。
这类错误在 C/C++ 中非常常见，往往不会立刻显式报错，而是导致后续程序行为异常，排查起来很困难。

相比传统的“程序崩溃后再猜原因”，ASan 能更早、更准确地告诉你问题发生在哪里。

# 2. 基本原理

ASan 的运行机制大致分为三步：

编译阶段插桩
- 编译器会在代码中插入额外的检查逻辑。
运行阶段维护影子内存
- ASan 会维护一份“影子内存”（shadow memory）来标记某块地址是否可访问。
发现非法访问并报错
- 当程序访问非法内存时，ASan 会立即报告错误，并显示调用栈和出错位置。

因此，ASan 的核心价值是把“隐式错误”变成“可定位的报错”。

# 3. 主要功能

ASan 常见能检测的错误包括：

堆缓冲区越界（heap-buffer-overflow）
栈缓冲区越界（stack-buffer-overflow）
全局缓冲区越界（global-buffer-overflow）
释放后再使用（use-after-free）
空指针解引用（null-deref）
重复释放（double-free）
作用域结束后继续使用局部变量（use-after-scope）

# 4. 编译器支持情况

ASan 目前已经被 GCC 和 Clang 广泛支持：

GCC：从 GCC 4.8 开始就支持 -fsanitize=address。
Clang：主流版本都支持，通常在现代 Clang 上体验更好。
如果只是为了学习和日常调试，GCC 7+ 或 Clang 的较新版本更推荐。

# 5. 使用依赖与编译方式

使用 ASan 时，通常需要：

GCC 或 Clang 编译器
代码编译时开启地址消毒器支持
推荐同时加上调试信息和保留调用栈信息

常见编译命令：

g++ -fsanitize=address -fno-omit-frame-pointer -g -O1 -o asan_demo asan_demo.cpp

其中：

-fsanitize=address：开启 ASan 检测
-g：保留调试信息，便于定位源码行号
-O1：降低优化影响，减少“优化后看不懂”的情况
-fno-omit-frame-pointer：保留调用栈信息，便于定位调用链

# 6. 示例代码：堆缓冲区越界

下面是一个典型的越界写入示例：

#include <iostream>

int main() {
  int* array = new int[10];
  for (int i = 0; i < 10; ++i) {
    array[i] = i;
  }

  // 越界写入第 11 个元素
  array[10] = 10;

  delete[] array;
  return 0;
}

编译并运行：

g++ -fsanitize=address -fno-omit-frame-pointer -g -O1 -o asan_demo asan_demo.cpp
./asan_demo

# 7. 输出结果分析

运行后，ASan 通常会输出类似下面的错误信息：

=================================================================
==5335==ERROR: AddressSanitizer: heap-buffer-overflow on address 0x504000000038
WRITE of size 4 at 0x504000000038 thread T0
    #0 0x5555a3650d78 in main /home/rox/codes/asan.cpp:14
    ...
SUMMARY: AddressSanitizer: heap-buffer-overflow /home/rox/codes/asan.cpp:14 in main
=================================================================

我们可以从输出中重点看这几个部分：

ERROR: AddressSanitizer: ...：说明检测到了内存错误。
heap-buffer-overflow：说明这是堆上缓冲区越界。
WRITE of size 4：说明发生了 4 字节的写操作。
#0 ... in main ...：表示错误触发位置在源码中的具体函数和代码行。
SUMMARY：给出错误类型和定位结果，便于快速定位问题。

此外，ASan 的输出中还可能包含“shadow bytes”以及红区（redzone）信息。它们的作用是帮助你理解为什么这次访问被认为非法，比如：

fa：表示堆红区被污染
fd：表示已释放内存区域
00：表示正常可访问区域

# 8. 典型使用场景

ASan 在以下场景下特别有用：

调试缓冲区越界问题
排查野指针和空指针错误
发现释放后使用的问题
诊断多线程或资源释放相关的内存问题

# 9. 使用建议

在实际开发中，建议在调试阶段经常开启 ASan：

先在本地复现问题，再修复代码。
对测试用例和关键模块优先开启。
与调试器、日志和单元测试结合使用，可以显著提升问题排查效率。
对生产环境的发布构建，通常不建议长期启用 ASan，因为它会增加运行开销和内存占用。

# 10. 小结

ASan 是 C/C++ 程序中非常实用的内存错误检测工具。它通过在编译和运行阶段插入额外检查，能够快速发现越界访问、使用已释放内存等问题。对于排查野指针、缓冲区溢出和释放后使用问题非常有效，是调试 C++ 程序时不可或缺的工具之一。

← std::variant用法