Address Sanitizer

Android NDK 从 API 级别 27 (Android O MR 1) 开始支持 Address Sanitizer（也称为 ASan）。

ASan 是一种快速的基于编译器的工具，用于检测原生代码中的内存 bug。ASan 可检测：

• 栈和堆缓冲区溢出/下溢
• 释放后使用堆
• 范围外使用栈
• 二次释放/野指针释放

ASan 的 CPU 开销约为 2 倍，代码大小开销在 50% 到 2 倍之间，内存开销很大（取决于您的分配模式，但约为 2 倍）。

示例应用

一个示例应用展示了如何配置 ASan 的构建变体。

构建

要使用 Address Sanitizer 构建应用的原生 (JNI) 代码，请执行以下操作：

APP_STL := c++_shared # Or system, or none.
APP_CFLAGS := -fsanitize=address -fno-omit-frame-pointer
APP_LDFLAGS := -fsanitize=address

LOCAL_ARM_MODE := arm

android {
    defaultConfig {
        externalNativeBuild {
            cmake {
                // Can also use system or none as ANDROID_STL.
                arguments "-DANDROID_ARM_MODE=arm", "-DANDROID_STL=c++_shared"
            }
        }
    }
}

target_compile_options(${TARGET} PUBLIC -fsanitize=address -fno-omit-frame-pointer)
set_target_properties(${TARGET} PROPERTIES LINK_FLAGS -fsanitize=address)

运行

从 Android O MR1 (API 级别 27) 开始，应用可以提供一个wrap shell 脚本，该脚本可以封装或替换应用进程。这使得可调试应用能够自定义其应用启动，从而可以在生产设备上使用 ASan。

1. 将 android:debuggable 添加到应用清单。
2. 在您的应用 build.gradle 文件中将 useLegacyPackaging 设置为 true。有关详情，请参阅wrap shell 脚本指南。
3. 将 ASan 运行时库添加到您的应用模块的 jniLibs 中。

4. 将内容如下所示的 wrap.sh 文件添加到您的 src/main/resources/lib 目录中的每个目录中。

   #!/system/bin/sh
   HERE="$(cd "$(dirname "$0")" && pwd)"
   export ASAN_OPTIONS=log_to_syslog=false,allow_user_segv_handler=1
   ASAN_LIB=$(ls $HERE/libclang_rt.asan-*-android.so)
   if [ -f "$HERE/libc++_shared.so" ]; then
       # Workaround for https://github.com/android-ndk/ndk/issues/988.
       export LD_PRELOAD="$ASAN_LIB $HERE/libc++_shared.so"
   else
       export LD_PRELOAD="$ASAN_LIB"
   fi
   "$@"
   

假设您的项目的应用模块名为 app，您的最终目录结构应包含以下内容：

<project root>
└── app
    └── src
        └── main
            ├── jniLibs
            │   ├── arm64-v8a
            │   │   └── libclang_rt.asan-aarch64-android.so
            │   ├── armeabi-v7a
            │   │   └── libclang_rt.asan-arm-android.so
            │   ├── x86
            │   │   └── libclang_rt.asan-i686-android.so
            │   └── x86_64
            │       └── libclang_rt.asan-x86_64-android.so
            └── resources
                └── lib
                    ├── arm64-v8a
                    │   └── wrap.sh
                    ├── armeabi-v7a
                    │   └── wrap.sh
                    ├── x86
                    │   └── wrap.sh
                    └── x86_64
                        └── wrap.sh

堆栈跟踪

Address Sanitizer 需要在每次调用 malloc/realloc/free 时展开堆栈。这里有两个选项：

1. 基于帧指针的“快速”展开器。这是遵循构建部分中的说明所使用的方法。

2. “慢速” CFI 展开器。在此模式下，ASan 使用 _Unwind_Backtrace。它只需要 -funwind-tables，这通常默认启用。

快速展开器是 malloc/realloc/free 的默认设置。慢速展开器是致命堆栈跟踪的默认设置。通过在 wrap.sh 中的 ASAN_OPTIONS 变量中添加 fast_unwind_on_malloc=0，可以为所有堆栈跟踪启用慢速展开器。