HWAddress Sanitizer

Android NDK 支持 HWAddress Sanitizer（也称为 HWASan），从 NDK r21 和 Android 10（API 级别 29）开始提供支持。HWASan 仅适用于 64 位 Arm 设备。

HWASan 是一款类似于 ASan 的内存错误检测工具。与经典的 ASan 相比，HWASan 具有以下特点：

相似的 CPU 开销（约 2 倍）
相似的代码大小开销（40% – 50%）
小得多的 RAM 开销（10% – 35%）

HWASan 检测的错误类型与 ASan 相同

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

此外，HWASan 还会检测

返回后使用栈

示例应用

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

构建

如需使用 HWAddress Sanitizer 构建应用的原生 (JNI) 代码，请按以下步骤操作：

ndk-build

在您的 Application.mk 文件中

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

CMake

在您模块的 build.gradle 文件中

android {
    defaultConfig {
        externalNativeBuild {
            cmake {
                # Can also use system or none as ANDROID_STL, but not c++_static.
                arguments "-DANDROID_STL=c++_shared"
            }
        }
    }
}

对于您的 CMakeLists.txt 中的每个目标

target_compile_options(${TARGET} PUBLIC -fsanitize=hwaddress -fno-omit-frame-pointer)
target_link_options(${TARGET} PUBLIC -fsanitize=hwaddress)

使用 NDK 27 或更高版本时，您还可以在 build.gradle 中使用以下内容，无需更改 CMakeLists.txt

android {
    defaultConfig {
        externalNativeBuild {
            cmake {
                arguments "-DANDROID_SANITIZE=hwaddress"
            }
        }
    }
}

当使用 ANDROID_USE_LEGACY_TOOLCHAIN_FILE=false 时，此方法不起作用。

Android 14 或更高版本：添加 wrap.sh

如果您运行的是 Android 14 或更高版本，可以使用 wrap.sh 脚本在任何搭载 Android 系统的设备上运行您的可调试应用。如果您选择按照设置说明中的步骤操作，则可以跳过此步骤。

按照打包 wrap.sh 脚本的说明，为 arm64-v8a 添加以下 wrap.sh 脚本。

#!/system/bin/sh
LD_HWASAN=1 exec "$@"

运行

如果您运行的是 Android 14 之前的版本，或者没有添加 wrap.sh 脚本，请在运行应用之前按照设置说明操作。

照常运行应用。检测到内存错误时，应用会因 SIGABRT 而崩溃，并将详细消息输出到 logcat。消息的副本可在 /data/tombstones 下的文件中找到，如下所示：

ERROR: HWAddressSanitizer: tag-mismatch on address 0x0042a0826510 at pc 0x007b24d90a0c
WRITE of size 1 at 0x0042a0826510 tags: 32/3d (ptr/mem) in thread T0
    #0 0x7b24d90a08  (/data/app/com.example.hellohwasan-eRpO2UhYylZaW0P_E0z7vA==/lib/arm64/libnative-lib.so+0x2a08)
    #1 0x7b8f1e4ccc  (/apex/com.android.art/lib64/libart.so+0x198ccc)
    #2 0x7b8f1db364  (/apex/com.android.art/lib64/libart.so+0x18f364)
    #3 0x7b8f2ad8d4  (/apex/com.android.art/lib64/libart.so+0x2618d4)

0x0042a0826510 is located 0 bytes to the right of 16-byte region [0x0042a0826500,0x0042a0826510)
allocated here:
    #0 0x7b92a322bc  (/apex/com.android.runtime/lib64/bionic/libclang_rt.hwasan-aarch64-android.so+0x212bc)
    #1 0x7b24d909e0  (/data/app/com.example.hellohwasan-eRpO2UhYylZaW0P_E0z7vA==/lib/arm64/libnative-lib.so+0x29e0)
    #2 0x7b8f1e4ccc  (/apex/com.android.art/lib64/libart.so+0x198ccc)

该消息后面可能会包含其他调试信息，例如应用中的实时线程列表、附近内存分配的标签以及 CPU 寄存器值。

如需详细了解 HWASan 错误消息，请参阅理解 HWASan 报告。

构建命令行可执行文件

您可以在 Android 14 及更高版本上构建并运行使用 HWASan 检测的可执行文件。您可以为您的可执行文件使用与构建中为 ndk-build 或 CMake 所述相同的配置。将可执行文件推送到运行 Android 14 或更高版本的设备上，并像平常一样使用 shell 运行它。

如果您使用的是 libc++，请确保您使用的是共享 STL 并将其推送到设备上，并在运行二进制文件时将 LD_LIBRARY_PATH 设置为包含它的目录。

如果您不使用 Gradle，请参阅 NDK 文档，了解如何使用 CMake 和 ndk-build 从命令行构建。

Android 13 或更早版本：设置

如果您的设备运行的是 Android 14 或更高版本，则可以跳过此步骤，并按照构建部分中使用 wrap.sh 的说明操作。您也可以选择遵循此部分，并跳过使用 wrap.sh 的说明。

在 Android 14 之前，HWASan 应用需要 Android 的 HWASan 构建版本才能运行。您可以将预构建的 HWASan 镜像刷入受支持的 Pixel 设备。这些构建版本可在 ci.android.com 上获取，您可以点击所需构建版本对应的方块以获取 Flash Build 链接。这要求您知道您手机的代号。

Flash a device build