第4章：AddressSanitizer入门

内存泄漏，说白了就是程序申请了内存，但忘了还回去。我见过太多项目，跑着跑着内存就爆了，最后查出来都是些不起眼的小地方。今天咱们聊聊AddressSanitizer——一个能帮你自动揪出这些问题的利器。

4.1 ASan是什么？

AddressSanitizer（简称ASan）是Google开发的一款内存错误检测工具。它不是跑在虚拟机里的，而是直接编译进你的程序里。嗯，这里要注意：它需要编译器配合。

ASan能检测的问题包括：

堆内存越界——比如你malloc了10个字节，却写了第11个
栈内存越界——局部数组访问超了
全局变量越界——全局数组也跑不掉
释放后使用——free了还在读，这叫use-after-free
双重释放——同一个指针free两次
内存泄漏——申请了没释放

我刚开始用ASan时，觉得它就是个黑魔法。后来研究了一下原理，发现其实挺巧妙的。

4.2 ASan的工作原理

ASan的核心思路是：用空间换时间。它在你的程序内存周围，额外分配一块叫"影子内存"的区域，专门记录每8个字节的状态。

核心思想：每8字节的应用内存，对应1字节的影子内存。影子内存的值表示这8字节是否可访问。

举个例子：

影子值为0，表示全部可访问
影子值为负数，表示全部不可访问
影子值为正数k，表示前k字节可访问，后面不可访问

每次读写内存时，ASan都会插入检查代码，看看影子内存的状态。如果发现违规，立刻报错并打印调用栈。

下面这张图能帮你理解ASan的内存布局：

小提示：ASan的检查是在运行时做的，所以程序会变慢（大约2倍），内存占用也会增加（大约2-3倍）。但为了找到bug，这点代价值得。

4.3 如何集成到Makefile

集成ASan到Makefile其实很简单。你只需要在编译和链接时加上一个flag：-fsanitize=address。

我个人习惯这样写：

# 调试模式开启ASan
DEBUG ?= 1

ifeq ($(DEBUG), 1)
    SANITIZE_FLAGS = -fsanitize=address -fno-omit-frame-pointer
    CFLAGS += $(SANITIZE_FLAGS)
    LDFLAGS += $(SANITIZE_FLAGS)
endif

# 示例目标
TARGET = my_program
SRCS = main.c utils.c
OBJS = $(SRCS:.c=.o)

$(TARGET): $(OBJS)
    $(CC) $(LDFLAGS) -o $@ $^

%.o: %.c
    $(CC) $(CFLAGS) -c -o $@ $<

clean:
    rm -f $(OBJS) $(TARGET)

这里有几个要点：

-fsanitize=address 是核心flag，编译和链接都要加
-fno-omit-frame-pointer 保留栈帧指针，报错时能打印更清晰的调用栈
建议只在调试模式下开启，发布版本关掉

注意：如果你用了静态链接，记得加上 -static-libasan。否则运行时可能找不到ASan的库。我曾经因为这个折腾了半天，最后发现是链接顺序的问题。

4.4 运行时环境变量

ASan在运行时支持很多环境变量，用来控制它的行为。我常用的几个：

环境变量	作用	示例
`ASAN_OPTIONS`	设置ASan的各种选项	`export ASAN_OPTIONS=detect_leaks=1`
`LSAN_OPTIONS`	专门控制内存泄漏检测	`export LSAN_OPTIONS=suppressions=supp.txt`
`ASAN_SYMBOLIZER_PATH`	指定符号化工具路径	`export ASAN_SYMBOLIZER_PATH=/usr/bin/llvm-symbolizer`

常用的ASAN_OPTIONS配置：

# 开启内存泄漏检测（默认关闭）
export ASAN_OPTIONS=detect_leaks=1

# 检测use-after-return（默认关闭）
export ASAN_OPTIONS=detect_stack_use_after_return=1

# 出错后立即退出（默认是1）
export ASAN_OPTIONS=abort_on_error=1

# 多个选项用冒号分隔
export ASAN_OPTIONS="detect_leaks=1:abort_on_error=1:log_path=./asan_log"

实战经验：我在项目中遇到过一个问题——ASan报内存泄漏，但怎么都定位不到。后来发现是第三方库的静态变量没释放。这时候可以用 suppressions 功能忽略它：

# 创建 supp.txt 文件
leak:^libfoo\.so$

# 运行时指定
export LSAN_OPTIONS=suppressions=supp.txt

4.5 一个完整的例子

咱们写个有内存泄漏的小程序，看看ASan怎么抓：

// leak.c
#include <stdlib.h>

void leak_memory() {
    int *p = (int*)malloc(100 * sizeof(int));
    // 忘记free了！
}

int main() {
    leak_memory();
    return 0;
}

编译运行：

# 编译
gcc -fsanitize=address -g -o leak leak.c

# 运行
./leak

# 输出类似：
# =================================================================
# ==12345==ERROR: LeakSanitizer: detected memory leaks
# 
# Direct leak of 400 byte(s) in 1 object(s) allocated from:
#     #0 0x7f... in malloc
#     #1 0x4... in leak_memory /home/user/leak.c:4
#     #2 0x4... in main /home/user/leak.c:8
# 
# SUMMARY: AddressSanitizer: 400 byte(s) leaked in 1 allocation(s).

看到没？ASan直接告诉你在leak.c:4分配了400字节没释放。这就是它的威力。

小技巧：加上 -g 编译选项，ASan报错时能显示源码行号。不然你只能看到地址，还得自己用addr2line去查，麻烦得很。

4.6 常见问题与避坑

用ASan时，我遇到过几个坑：

编译太慢？ 正常，ASan会插入很多检查代码。建议只对需要调试的模块开启。
报错信息看不懂？ 确保安装了llvm-symbolizer，或者设置ASAN_SYMBOLIZER_PATH。
和某些库冲突？ 比如OpenMP，可能需要加detect_odr_violation=0。
内存占用翻倍？ 这是ASan的代价。如果内存不够，可以试试ASAN_OPTIONS=quarantine_size_mb=10缩小隔离区。

我曾经在一个大型C++项目里集成ASan，编译时间从5分钟变成了15分钟。但第一次运行就抓到了3个隐藏了两年的内存泄漏。值不值？你自己想想看。

好了，ASan入门就聊到这儿。记住：工具再好，也得会用。下次遇到内存问题，别急着加日志，先试试ASan。

一句话总结：ASan = 编译时插桩 + 影子内存 + 运行时检查。集成到Makefile只需加一个flag，运行时用环境变量控制。简单、粗暴、有效。

可可精品资料库

📚 课程目录

第4章：AddressSanitizer入门

4.1 ASan是什么？

4.2 ASan的工作原理

4.3 如何集成到Makefile

4.4 运行时环境变量

4.5 一个完整的例子

4.6 常见问题与避坑