Linux编程：使用 AddressSanitizer (ASan) 进行C/C++内存错误检测

0. 概要

AddressSanitizer（ASan）是内存错误检测的强大工具，本文将介绍如何在 ARM64 系统中有效配置和使用 ASan，提供一个示例程序的检测流程，最后总结一些常见的最佳实践和注意事项。

1. ASan 的配置与运行时优化

CMake 配置

在 ARM64 平台，通过 CMake 启用 ASan 的配置如下：

option(USE_ASAN "Enable AddressSanitizer for ARM64" OFF)

if(USE_ASAN)
  add_compile_options(-fsanitize=address -fsanitize-recover=address)
  add_link_options(-lasan)
endif()

运行时环境变量

在 ARM64 上运行 ASan 编译的程序时，环境变量的设置至关重要：

export ASAN_OPTIONS="\
halt_on_error=0:\
log_path=/logs/asan.log:\
quarantine_size_mb=128"
export LD_PRELOAD=/path/to/libasan.so.5

• halt_on_error=0 默认情况下，运行检测到异常，Asan会将程序Abort，并打印出错误时的堆栈信息。
  如果要检测出错误时程序不退出，则需要在编译时设置-fsanitize-recover=address，并且在环境变量halt_on_error=0。防止 ASan 在首次检测到错误时立即终止程序，便于观察更多错误。
• log_path 设置 ASan 日志的存储路径。
• quarantine_size_mb 控制 ASan 的缓存大小，Asan默认需要的缓存大小是256M，开发板不一定有足够的空间，因此考虑修改为128M;
• LD_PRELOAD表示libasan.so.5需要在程序启动前加载。

2. ARM64 ASan库交叉编译

准备工作
在llvm-project中下载LLVM相应版本的源码。需要编译的模块在compiler-rt/lib目录，因此，只需要在compiler目录下进行操作。

• 采用gcc交叉编译的shell脚本：

mkdir -p build
 
cd build && cmake .. \
-DCOMPILER_RT_BUILD_BUILTINS=ON \
-DCOMPILER_RT_BUILD_SANITIZERS=ON \
-DCOMPILER_RT_BUILD_XRAY=ON \
-DCOMPILER_RT_BUILD_LIBFUZZER=ON \
-DCOMPILER_RT_BUILD_PROFILE=ON \
-DCMAKE_SYSROOT=/path/to/aarch64-linux-gnu/libc \
-DCMAKE_ASM_COMPILER_TARGET="aarch64-linux-gnu" \
-DCMAKE_C_COMPILER_TARGET="aarch64-linux-gnu" \
-DCOMPILER_RT_DEFAULT_TARGET_ONLY=ON \
-DCMAKE_C_COMPILER=/path/to/bin/aarch64-linux-gcc
 
make -j10

3. 动态链接 VS 静态链接

在 ARM64 系统上，动态链接 ASan 运行时库更为推荐，一般不适用静态链接。
因为它：

• 减少可执行文件的体积。
• 提高了与其他动态库的兼容性。
• 方便更新 ASan 库而无需重新编译应用程序。
• 例如，使用 LD_PRELOAD 环境变量来加载 ASan 运行时库：

LD_PRELOAD=/path/to/libasan.so.5 ./my_program

4. 示例：内存泄漏检测

下面是一个包含内存泄漏的 C++ 程序示例：

#include <iostream>

void memoryLeak() {
    int* ptr = new int(5);
    // 忽略 delete ptr;
}

int main() {
    std::cout << "Starting program..." << std::endl;
    memoryLeak();
    std::cout << "Program finished." << std::endl;
    return 0;
}

编译并运行程序，使用 ASan 查找内存泄漏：

g++ -fsanitize=address -fsanitize-recover=address -g -o my_program my_program.cpp
LD_PRELOAD=/path/to/libasan.so.5 ./my_program

ASan 检测结果

当运行程序时，ASan 将会检测到内存泄漏，并输出详细的报告。例如，ASan 的输出可能会类似于：

=================================================================
==1==ERROR: LeakSanitizer: detected memory leaks

Direct leak of 4 byte(s) in 1 object(s) allocated from:
    #0 0x7f906e857e60 in operator new(unsigned long) (/usr/lib/x86_64-linux-gnu/libasan.so.5+0xe8e60)
    #1 0x5555555560dc in memoryLeak() /path/to/my_program.cpp:5
    #2 0x5555555560f4 in main /path/to/my_program.cpp:11
    #3 0x7f906e61a0b2 in __libc_start_main (/lib/x86_64-linux-gnu/libc.so.6+0x270b2)

SUMMARY: AddressSanitizer: 4 byte(s) leaked in 1 allocation(s).

这个报告指出了程序中发生的内存泄漏，包括泄漏的字节数、分配的位置和泄漏发生的调用栈信息。开发者可以根据这些信息来定位并修复内存泄漏问题，从而提高程序的内存管理效率和稳定性。

5. 其他最佳实践

注意内存消耗

• 使用 ASan 会增加程序运行时的内存消耗，特别是对于小型分配而言。
• 堆栈内存的使用可能增加至原始值的三倍，因而限制quarantine_size_mb 是不错的选择。

内存分配问题导致的无法启动

如果在运行时遇到内存分配问题，例如：

ERROR: AddressSanitizer failed to allocate 0x400000000 (17179869184) bytes at address 67fff8000 (errno: 12)

可能是因为系统可用内存不足，可以尝试增大系统的可用内存，或者修改quarantine_size_mb的大小。

启用内存泄漏检测

ASan 包含 LeakSanitizer 用于内存泄漏检测，可通过设置 ASAN_OPTIONS=detect_leaks=1 在 Linux 上启用。

更严格的检测模式

可以通过启用更严格的检测模式来增强 ASan 的功能。例如：

ASAN_OPTIONS=strict_string_checks=1:detect_stack_use_after_return=1:check_initialization_order=1:strict_init_order=1

初始化顺序检查

ASan 可以检测动态初始化顺序问题，通过设置 ASAN_OPTIONS=check_initialization_order=1 来启用。

返回后堆栈使用（UAR）

ASan 可以检测返回后的堆栈使用情况，默认情况下启用，可以通过设置 ASAN_OPTIONS=detect_stack_use_after_return=0 来禁用或调整检测级别。

问题抑制

• 如果遇到误报，可以使用抑制机制或条件编译来处理。例如，使用 ASAN_OPTIONS=suppressions=MyASan.supp 来忽略特定问题。

• 某些情况下，可能需要禁用 AddressSanitizer 对特定函数或全局变量的检测。可以使用 __attribute__((no_sanitize("address"))) 属性来实现。例如：

__attribute__((no_sanitize("address")))
void myFunction() {
    // 禁用 AddressSanitizer 对此函数的检测
}

动态加载库的问题

ASan 不支持使用 RTLD_DEEPBIND 标志动态加载库，但是支持LD_PRELOAD 。

6. 参考

• llvm-AddressSanitizer
• wiki-AddressSanitizer