Sanitizer——自动 Bug 狩猎 on Dorkytiger 的小屋

AddressSanitizer（ASan）

Mon, 01 Jan 0001 00:00:00 +0000

一、它能抓到什么

// 1. 堆越界访问（Heap buffer overflow）
void heap_oob() {
    auto* arr = new int[10];
    arr[10] = 42;  // ASan 在这里崩溃，告诉你越界了
    delete[] arr;
}

// 2. 栈越界访问（Stack buffer overflow）
void stack_oob() {
    int arr[10];
    arr[10] = 42;  // ASan 捕获
}

// 3. Use-After-Free（释放后使用）
void use_after_free() {
    auto* p = new int(42);
    delete p;
    *p = 0;  // ASan 捕获：Address 0x... is a wild pointer
}

// 4. Double-Free
void double_free() {
    auto* p = new int(42);
    delete p;
    delete p;  // ASan 捕获：double free
}

二、用法

# 编译：加入 sanitize 标志
g++ -fsanitize=address -fno-omit-frame-pointer -g -O1 -o test test.cpp

# 运行（不用任何额外命令，直接运行即可）
./test

# 出错了会类似这样输出：
# ==============================================================
# ==12345==ERROR: AddressSanitizer: heap-buffer-overflow
#     WRITE of size 4 at 0x602000000014 thread T0
#     #0 0x400b12 in heap_oob() test.cpp:4
#     #1 0x400bf1 in main test.cpp:10
#     #2 0x7f1234567890 in __libc_start_main
#
# 0x602000000014 is located 0 bytes after 40-byte region
#   allocated by thread T0 here:
#     #0 0x7f123456abcd in operator new[](unsigned long)
#     #1 0x400adf in heap_oob() test.cpp:3
#
# SUMMARY: AddressSanitizer: heap-buffer-overflow test.cpp:4
# ==============================================================

# 关键信息：
# heap-buffer-overflow → 堆越界
# test.cpp:4            → 第 4 行出了问题
# 0 bytes after 40-byte region → 在 40 字节分配区域之后越界了 0 字节（正好最后一个 int）

三、和你的两个项目相关的例子

// SimpleAsyncLogger 中可能出现的 Use-After-Free
// ring_buffer.cpp 中的无锁队列
void producer_race_example() {
    uint8_t* buffer = new uint8_t[1024];
    std::thread producer([&] {
        // 假设这里操作 buffer
        buffer[0] = 1;
    });
    std::thread consumer([&] {
        // 假设这里也操作 buffer
        buffer[0] = 2;
    });

    producer.join();
    consumer.join();

    // ⚠️ 如果 consumer 删除了 buffer 而 producer 还在用 → ASan 帮你抓到
    // 编译时带上 -fsanitize=address 就能自动检测这种问题
}

// ScoreMaster 中的 DMA-BUF fd 泄漏
void dma_buf_leak() {
    // 如果忘记 close DMA buffer 的 fd
    // ASan 不会直接捕获（因为 fd 是内核资源）
    // 但堆上的 fd 包装对象泄漏了 ASan 是能看到的
}

四、性能影响

ASan 开启后：
  运行速度：慢约 2 倍
  内存占用：多约 2-3 倍

所以只在测试/CI 构建中开启，生产环境关闭。

推荐：CMake 中按构建类型启用
  # CMakeLists.txt
  if(CMAKE_BUILD_TYPE STREQUAL "Debug")
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address -fno-omit-frame-pointer")
  endif()

UndefinedBehaviorSanitizer（UBSan）

Mon, 01 Jan 0001 00:00:00 +0000

一、它能抓到什么

// 1. 整数溢出
void int_overflow() {
    int x = INT_MAX;
    x++;  // UBSan：signed integer overflow
}

// 2. 移位越界
void shift_overflow() {
    int x = 1;
    x <<= 33;  // UBSan：shift exponent 33 is too large for 32-bit type
}

// 3. 空指针解引用
void null_deref() {
    int* p = nullptr;
    *p = 42;  // UBSan：null pointer dereference
}

// 4. dynamic_cast 到错误类型
class Base { virtual ~Base() = default; };
class Derived1 : public Base {};
class Derived2 : public Base {};

void bad_cast() {
    Base* b = new Derived1;
    auto* d = dynamic_cast<Derived2*>(b);
    // 不会崩溃（返回 nullptr），但如果你忘了检查 → 后续解引用会 UB
}

二、用法

# 编译：可以在 ASan 的基础上叠加 UBSan
g++ -fsanitize=address,undefined -fno-omit-frame-pointer -g -O1 -o test test.cpp

./test

# 可能会在标准输出中看到：
# test.cpp:4:5: runtime error: signed integer overflow
# test.cpp:9:5: runtime error: shift exponent 33 is too large

建议：你的所有 C++ 项目都应该在 Debug 构建中开启 UBSan，因为它捕到的错误都是真正的 Bug，不应该是正常行为。

ThreadSanitizer（TSan）

Mon, 01 Jan 0001 00:00:00 +0000

一、它能抓到什么

// 数据竞争（Data Race）—— 无锁编程最常见的 Bug

int shared_counter = 0;

void worker() {
    for (int i = 0; i < 100000; i++) {
        shared_counter++;  // 不是原子的！多个线程同时写
    }
}

void test_race() {
    std::thread t1(worker);
    std::thread t2(worker);
    t1.join();
    t2.join();
    // 最终结果不一定是 200000，且 TSan 会报告数据竞争
}

TSan 的输出：

WARNING: ThreadSanitizer: data race
  Write of size 4 at 0x7f1234567890 by thread T2:
    #0 worker() test.cpp:5 (test+0x...)

  Previous write of size 4 at 0x7f1234567890 by thread T1:
    #0 worker() test.cpp:5 (test+0x...)

  Location is global 'shared_counter' at 0x7f1234567890

二、用法

g++ -fsanitize=thread -g -O1 -o test test.cpp
./test

三、TSan 的限制

1. 要求所有代码（含第三方静态库）都加 -fsanitize=thread 编译。
   如果一个 .a 文件没有 TSan 检测，里面即使有 race 也检测不到。

2. 不能和 ASan 同时使用（TSan 用 shadow memory 检测 race，ASan 也用它检测越界）。

3. 运行速度慢约 5-10 倍。

4. 假阳性：有些"逻辑上不会出问题"的数据竞争也会被报告。
   比如你的 SPSC 队列中，生产者和消费者操作不同变量但在同一缓存行，
   TSan 可能因为同一缓存行的两个不同变量而报 false positive。

第三阶段总结

Mon, 01 Jan 0001 00:00:00 +0000

ASan（内存错误）：
    堆/栈越界、Use-After-Free、Double-Free
    编译：-fsanitize=address
    速度：慢 2x，内存多 2-3x

UBSan（未定义行为）：
    整数溢出、移位越界、空指针解引用
    编译：-fsanitize=undefined
    建议：所有项目 Debug 构建都应该开启

TSan（数据竞争）：
    多线程无锁编程的 Bug
    编译：-fsanitize=thread
    限制：不能和 ASan 一起用，要求全量重编

最佳实践：
    Debug 构建：-fsanitize=address,undefined
    CI 测试构建：-fsanitize=thread（单独跑）
    生产构建：不要带 sanitizer（性能影响太大）