NDK (C++) 開(kāi)發(fā)中如何使用 ASan 檢測(cè)內(nèi)存越界等內(nèi)存錯(cuò)誤

什么是 ASan

ASan 是 Address Sanitizer 簡(jiǎn)稱胎食，它是是一種基于編譯器用于快速檢測(cè)原生代碼中內(nèi)存錯(cuò)誤的工具怠惶。

簡(jiǎn)而言之，ASan 就是一個(gè)用于快速檢測(cè)內(nèi)存錯(cuò)誤的工具。這里很多朋友有誤解奸例，ASan 其實(shí)并不能用于內(nèi)存泄漏檢測(cè)，Android 平臺(tái)內(nèi)存泄漏檢測(cè)推薦 MallocDebug 哈误。

另外需要注意的是 Android O（API >= 27）及以上版本才支持 ASan 哩至，NDK 需要選用 r20 及以上版本躏嚎。

ASan 可以檢測(cè)到內(nèi)存錯(cuò)誤類型如下：

Stack and heap buffer overflow/underflow 棧和堆緩沖區(qū)上溢/下溢；
Heap use after free 堆內(nèi)存被釋放之后還在使用其指針菩貌；
Stack use outside scope 在某個(gè)局部變量的作用域之外卢佣，使用其指針；
Double free/wild free 指針重復(fù)釋放的情況箭阶。

ASan 支持 arm 和 x86 平臺(tái)虚茶，使用 ASan 時(shí)，APP 性能會(huì)變慢且內(nèi)存占用會(huì)飆升仇参。針對(duì) arm64 平臺(tái)嘹叫，Android 官方推薦使用 HWAddress Sanitizer （HWASan），后面會(huì)介紹诈乒。

關(guān)于 ASan 的原理本文不做深入討論罩扇，該文章的主要目的是幫助開(kāi)發(fā)者快速上手 ASan 的使用。

這里感性地介紹下 ASan 的工作原理：ASan 相當(dāng)于接管了內(nèi)存的分配怕磨，當(dāng)分配一塊內(nèi)存時(shí)喂饥，會(huì)在這塊內(nèi)存的前后添加"標(biāo)志位"，然后再次使用該內(nèi)存的時(shí)候檢查"標(biāo)志位"是否被修改肠鲫，當(dāng)發(fā)現(xiàn)"標(biāo)志位"被修改時(shí)员帮，判斷出現(xiàn)內(nèi)存錯(cuò)誤。

怎么使用 ASan

之所以寫這篇文件导饲，就是因?yàn)榘l(fā)現(xiàn)一些文章介紹 ASan 使用方法搞得非常復(fù)雜捞高，不易上手。

其實(shí) Android 官方的使用說(shuō)明非常簡(jiǎn)潔渣锦，就是復(fù)制黏貼硝岗，添加兩行代碼就搞定。

官方文檔：developer.android.com/ndk/guides/…

修改編譯腳本

CMake

APP 下面的 build.gradle 添加：

android {
    defaultConfig {
        externalNativeBuild {
            cmake {
                # Can also use system or none as ANDROID_STL.
                arguments "-DANDROID_ARM_MODE=arm", "-DANDROID_STL=c++_shared"
            }
        }
    }
}
復(fù)制代碼

CMakeLists.txt 腳本添加:

target_compile_options(${libname} PUBLIC -fsanitize=address -fno-omit-frame-pointer)
set_target_properties(${libname} PROPERTIES LINK_FLAGS -fsanitize=address)
復(fù)制代碼

NDK-BUILD

Application.mk 文件添加：

APP_STL := c++_shared # Or system, or none.
APP_CFLAGS := -fsanitize=address -fno-omit-frame-pointer
APP_LDFLAGS := -fsanitize=address
復(fù)制代碼

Android.mk 文件添加：

APP_STL := c++_shared # Or system, or none.
APP_CFLAGS := -fsanitize=address -fno-omit-frame-pointer
APP_LDFLAGS := -fsanitize=address
復(fù)制代碼

拷貝 Asan 庫(kù)到 jniLibs 目錄下

Asan 庫(kù)位于下面路徑下：

android-ndk-r21\toolchains\llvm\prebuilt\windows-x86_64\lib64\clang\9.0.8\lib\linux
復(fù)制代碼

64 位 libclang_rt.asan-aarch64-android.so , 32 位 libclang_rt.asan-arm-android.so 泡挺，分別拷貝兩個(gè)庫(kù)到 jniLibs 相應(yīng)的目錄下辈讶。

新建 wrap.sh 文件，拷貝下面內(nèi)容到文件中：

#!/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
"$@"
復(fù)制代碼

在 main 文件夾下新建目錄 resources\lib 然后將 wrap.sh 文件拷貝到相應(yīng)的目錄下面娄猫，最終的目錄結(jié)構(gòu)是這樣的：

<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
復(fù)制代碼

自此 ASan 接入完成贱除，是不是很簡(jiǎn)單？

ASan 檢測(cè)內(nèi)存錯(cuò)誤

這一節(jié)我們?cè)诖a中故意設(shè)置一些常見(jiàn)的內(nèi)存錯(cuò)誤（內(nèi)存越界等）用來(lái)測(cè)試 ASan 檢測(cè)出來(lái)的結(jié)果是否正確媳溺。需要注意的是月幌，當(dāng) ASan 檢測(cè)出內(nèi)存錯(cuò)誤，程序就會(huì)立即 crash 悬蔽，不再往下執(zhí)行扯躺，log 中會(huì)出現(xiàn)關(guān)鍵字 AddressSanitizer 。

堆內(nèi)存溢出

static void HeapBufferOverflow() {
    int *arr = new int[1024];
    arr[0] = 11;
    arr[1024] = 12;
    LOGCATE("HeapBufferOverflow arr[0]=%d, arr[1024]",arr[0], arr[1024]);
}
復(fù)制代碼

ASan 檢測(cè)結(jié)果（crash log）中出現(xiàn)關(guān)鍵字 heap-buffer-overflow ：

05-13 19:52:16.247  4194  4194 I com.byteflow.learnffmpeg: =================================================================
05-13 19:52:16.247  4194  4194 I com.byteflow.learnffmpeg: ==4194==ERROR: AddressSanitizer: heap-buffer-overflow on address 0x004f0d5a8100 at pc 0x0074f822b648 bp 0x007ff0227a00 sp 0x007ff02279f8
05-13 19:52:16.247  4194  4194 I com.byteflow.learnffmpeg: WRITE of size 4 at 0x004f0d5a8100 thread T0
05-13 19:52:16.257 23334 23334 D Launcher_UnlockAnimationStateMachine: mResetIdleStateRunnable
05-13 19:52:16.265  4194  4194 I com.byteflow.learnffmpeg:     #0 0x74f822b644  (/data/app/com.byteflow.learnffmpeg-mVg7CcQSTXVnJhfo7u0XLA==/lib/arm64/liblearn-ffmpeg.so+0x146644)
05-13 19:52:16.265  4194  4194 I com.byteflow.learnffmpeg:     #1 0x74f8229b20  (/data/app/com.byteflow.learnffmpeg-mVg7CcQSTXVnJhfo7u0XLA==/lib/arm64/liblearn-ffmpeg.so+0x144b20)
05-13 19:52:16.265  4194  4194 I com.byteflow.learnffmpeg:     #2 0x74f8229a7c  (/data/app/com.byteflow.learnffmpeg-mVg7CcQSTXVnJhfo7u0XLA==/lib/arm64/liblearn-ffmpeg.so+0x144a7c)
05-13 19:52:16.265  4194  4194 I com.byteflow.learnffmpeg:     #3 0x74fdaac0a0  (/data/app/com.byteflow.learnffmpeg-mVg7CcQSTXVnJhfo7u0XLA==/oat/arm64/base.odex+0xb0a0)
05-13 19:52:16.265  4194  4194 I com.byteflow.learnffmpeg: ........
復(fù)制代碼

棧內(nèi)存溢出

 //stack-buffer-overflow
 static void StackBufferOverflow() {
     int arr[1024];
     arr[0] = 11;
     arr[1024] = 12;
     LOGCATE("StackBufferOverflow arr[0]=%d, arr[1024]",arr[0], arr[1024]);
 }
復(fù)制代碼

ASan 檢測(cè)結(jié)果（crash log）中出現(xiàn)關(guān)鍵字 stack-buffer-overflow ：

05-13 19:54:30.371  5002  5002 I com.byteflow.learnffmpeg: =================================================================
05-13 19:54:30.371  5002  5002 I com.byteflow.learnffmpeg: ==5002==ERROR: AddressSanitizer: stack-buffer-overflow on address 0x007ff02278c0 at pc 0x0074f8bd6640 bp 0x007ff0226890 sp 0x007ff0226888
05-13 19:54:30.372  5002  5002 I com.byteflow.learnffmpeg: WRITE of size 4 at 0x007ff02278c0 thread T0
05-13 19:54:30.389  5002  5002 I com.byteflow.learnffmpeg:     #0 0x74f8bd663c  (/data/app/com.byteflow.learnffmpeg-aaLGh4G_-2c2WC7sX0ibag==/lib/arm64/liblearn-ffmpeg.so+0x14663c)
05-13 19:54:30.389  5002  5002 I com.byteflow.learnffmpeg:     #1 0x74f8bd4a20  (/data/app/com.byteflow.learnffmpeg-aaLGh4G_-2c2WC7sX0ibag==/lib/arm64/liblearn-ffmpeg.so+0x144a20)
05-13 19:54:30.389  5002  5002 I com.byteflow.learnffmpeg:     #2 0x74f8bd497c  (/data/app/com.byteflow.learnffmpeg-aaLGh4G_-2c2WC7sX0ibag==/lib/arm64/liblearn-ffmpeg.so+0x14497c)
......
復(fù)制代碼

使用已釋放的指針

//heap-use-after-free
static void UseAfterFree() {
    int *arr = new int[1024];
    arr[0] = 11;
    delete [] arr;
    LOGCATE("UseAfterFree arr[0]=%d, arr[1024]",arr[0], arr[1024]);
}
復(fù)制代碼

ASan 檢測(cè)結(jié)果（crash log）中出現(xiàn)關(guān)鍵字 heap-use-after-free ：

05-13 19:56:44.430  5235  5235 I com.byteflow.learnffmpeg: =================================================================
05-13 19:56:44.430  5235  5235 I com.byteflow.learnffmpeg: ==5235==ERROR: AddressSanitizer: heap-use-after-free on address 0x004f0d5a7100 at pc 0x0074f7ac945c bp 0x007ff02279d0 sp 0x007ff02279c8
05-13 19:56:44.430  5235  5235 I com.byteflow.learnffmpeg: READ of size 4 at 0x004f0d5a7100 thread T0
05-13 19:56:44.447  5235  5235 I com.byteflow.learnffmpeg:     #0 0x74f7ac9458  (/data/app/com.byteflow.learnffmpeg-w2WNuKKPLEj7i4_8_Oj3Sw==/lib/arm64/liblearn-ffmpeg.so+0x146458)
05-13 19:56:44.448  5235  5235 I com.byteflow.learnffmpeg:     #1 0x74f7ac7920  (/data/app/com.byteflow.learnffmpeg-w2WNuKKPLEj7i4_8_Oj3Sw==/lib/arm64/liblearn-ffmpeg.so+0x144920)
05-13 19:56:44.448  5235  5235 I com.byteflow.learnffmpeg:     #2 0x74f7ac787c  (/data/app/com.byteflow.learnffmpeg-w2WNuKKPLEj7i4_8_Oj3Sw==/lib/arm64/liblearn-ffmpeg.so+0x14487c)
......
復(fù)制代碼

局部變量的作用域之外使用其指針

//stack-use-after-scope
static int *p;
static void UseAfterScope()
{
    {
        int a = 0;
        p = &a;
    }
    *p = 1111;
    LOGCATE("UseAfterScope *p=%d",*p);
}
復(fù)制代碼

ASan 檢測(cè)結(jié)果（crash log）中出現(xiàn)關(guān)鍵字 stack-use-after-scope ：

https://developer.android.com/ndk/guides/asan#cmake05-13 20:01:19.447  5907  5907 I com.byteflow.learnffmpeg: =================================================================
05-13 20:01:19.447  5907  5907 I com.byteflow.learnffmpeg: ==5907==ERROR: AddressSanitizer: stack-use-after-scope on address 0x007ff02279a0 at pc 0x0074f8236438 bp 0x007ff0227970 sp 0x007ff0227968
05-13 20:01:19.448  5907  5907 I com.byteflow.learnffmpeg: WRITE of size 4 at 0x007ff02279a0 thread T0
05-13 20:01:19.462 23334 23334 D Launcher_UnlockAnimationStateMachine: mResetIdleStateRunnable
05-13 20:01:19.464  5907  5907 I com.byteflow.learnffmpeg:     #0 0x74f8236434  (/data/app/com.byteflow.learnffmpeg-jx_Xi14rwGHag_VZ9KWXYA==/lib/arm64/liblearn-ffmpeg.so+0x146434)
05-13 20:01:19.465  5907  5907 I com.byteflow.learnffmpeg:     #1 0x74f8234860  (/data/app/com.byteflow.learnffmpeg-jx_Xi14rwGHag_VZ9KWXYA==/lib/arm64/liblearn-ffmpeg.so+0x144860)
05-13 20:01:19.465  5907  5907 I com.byteflow.learnffmpeg:     #2 0x74f82347bc  (/data/app/com.byteflow.learnffmpeg-jx_Xi14rwGHag_VZ9KWXYA==/lib/arm64/liblearn-ffmpeg.so+0x1447bc)
05-13 20:01:19.465  5907  5907 I com.byteflow.learnffmpeg:     #3 0x74fdabe0a0  (/data/app/com.byteflow.learnffmpeg-jx_Xi14rwGHag_VZ9KWXYA==/oat/arm64/base.odex+0xb0a0)
.....
復(fù)制代碼

重復(fù)釋放指針

//double-free
static void DoubleFree() {
    int *arr = new int[1024];
    arr[0] = 11;
    delete [] arr;
    delete [] arr;
    LOGCATE("UseAfterFree arr[0]=%d",arr[0]);
}
復(fù)制代碼

ASan 檢測(cè)結(jié)果（crash log）中出現(xiàn)關(guān)鍵字 double-free ：

05-13 20:02:16.474  6102  6102 I com.byteflow.learnffmpeg: =================================================================
05-13 20:02:16.475  6102  6102 I com.byteflow.learnffmpeg: ==6102==ERROR: AddressSanitizer: attempting double-free on 0x004f0d5a7100 in thread T0:
05-13 20:02:16.492  6102  6102 I com.byteflow.learnffmpeg:     #0 0x74f9f2b7b0  (/data/app/com.byteflow.learnffmpeg-kjj44NZxl-eyA06gf3E2MA==/lib/arm64/libclang_rt.asan-aarch64-android.so+0xd57b0)
05-13 20:02:16.492  6102  6102 I com.byteflow.learnffmpeg:     #1 0x74f88cd210  (/data/app/com.byteflow.learnffmpeg-kjj44NZxl-eyA06gf3E2MA==/lib/arm64/liblearn-ffmpeg.so+0x146210)
05-13 20:02:16.492  6102  6102 I com.byteflow.learnffmpeg:     #2 0x74f88cb720  (/data/app/com.byteflow.learnffmpeg-kjj44NZxl-eyA06gf3E2MA==/lib/arm64/liblearn-ffmpeg.so+0x144720)
05-13 20:02:16.492  6102  6102 I com.byteflow.learnffmpeg:     #3 0x74f88cb67c  (/data/app/com.byteflow.learnffmpeg-kjj44NZxl-eyA06gf3E2MA==/lib/arm64/liblearn-ffmpeg.so+0x14467c)
......
復(fù)制代碼

ASan 基本上可以覆蓋到常見(jiàn)的內(nèi)存錯(cuò)誤問(wèn)題，還有其他 Case 就不一一展示了录语，

音視頻入門到精通在開(kāi)源項(xiàng)目：https://github.com/Android-Alvin/Android-LearningNotes中已收錄倍啥，里面還包含不同方向的自學(xué)編程路線、面試題集合/面經(jīng)澎埠、及系列技術(shù)文章等虽缕，資源持續(xù)更新中...

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者

人面猴
序言：七十年代末，一起剝皮案震驚了整個(gè)濱河市蒲稳，隨后出現(xiàn)的幾起案子氮趋，更是在濱河造成了極大的恐慌，老刑警劉巖江耀，帶你破解...
沈念sama閱讀 217,277評(píng)論 6贊 503
死咒
序言：濱河連續(xù)發(fā)生了三起死亡事件剩胁，死亡現(xiàn)場(chǎng)離奇詭異，居然都是意外死亡祥国，警方通過(guò)查閱死者的電腦和手機(jī)昵观，發(fā)現(xiàn)死者居然都...
沈念sama閱讀 92,689評(píng)論 3贊 393
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進(jìn)店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)舌稀，“玉大人索昂，你說(shuō)我怎么就攤上這事±┙瑁” “怎么了？”我有些...
開(kāi)封第一講書(shū)人閱讀 163,624評(píng)論 0贊 353
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵缤至，是天一觀的道長(zhǎng)潮罪。經(jīng)常有香客問(wèn)我，道長(zhǎng)领斥，這世上最難降的妖魔是什么嫉到？我笑而不...
開(kāi)封第一講書(shū)人閱讀 58,356評(píng)論 1贊 293
?港島之戀（遺憾婚禮）
正文為了忘掉前任，我火速辦了婚禮月洛，結(jié)果婚禮上何恶，老公的妹妹穿的比我還像新娘。我一直安慰自己嚼黔，他們只是感情好细层，可當(dāng)我...
茶點(diǎn)故事閱讀 67,402評(píng)論 6贊 392
惡毒庶女頂嫁案：這布局不是一般人想出來(lái)的
文/花漫我一把揭開(kāi)白布。她就那樣靜靜地躺著唬涧，像睡著了一般疫赎。火紅的嫁衣襯著肌膚如雪。梳的紋絲不亂的頭發(fā)上碎节，一...
開(kāi)封第一講書(shū)人閱讀 51,292評(píng)論 1贊 301
城市分裂傳說(shuō)
那天捧搞，我揣著相機(jī)與錄音，去河邊找鬼。笑死胎撇，一個(gè)胖子當(dāng)著我的面吹牛介粘，可吹牛的內(nèi)容都是我干的。我是一名探鬼主播晚树，決...
沈念sama閱讀 40,135評(píng)論 3贊 418
雙鴛鴦連環(huán)套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開(kāi)眼姻采，長(zhǎng)吁一口氣：“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼！你這毒婦竟也來(lái)了题涨？” 一聲冷哼從身側(cè)響起偎谁，我...
開(kāi)封第一講書(shū)人閱讀 38,992評(píng)論 0贊 275
萬(wàn)榮殺人案實(shí)錄
序言：老撾萬(wàn)榮一對(duì)情侶失蹤，失蹤者是張志新（化名）和其女友劉穎纲堵，沒(méi)想到半個(gè)月后巡雨，有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體，經(jīng)...
沈念sama閱讀 45,429評(píng)論 1贊 314
?護(hù)林員之死
正文獨(dú)居荒郊野嶺守林人離奇死亡席函，尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛以下內(nèi)容為張勛視角年9月15日...
茶點(diǎn)故事閱讀 37,636評(píng)論 3贊 334
?白月光啟示錄
正文我和宋清朗相戀三年铐望，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片茂附。...
茶點(diǎn)故事閱讀 39,785評(píng)論 1贊 348
活死人
序言：一個(gè)原本活蹦亂跳的男人離奇死亡正蛙，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出营曼，到底是詐尸還是另有隱情乒验，我是刑警寧澤，帶...
沈念sama閱讀 35,492評(píng)論 5贊 345
?日本核電站爆炸內(nèi)幕
正文年R本政府宣布蒂阱，位于F島的核電站锻全，受9級(jí)特大地震影響，放射性物質(zhì)發(fā)生泄漏录煤。R本人自食惡果不足惜鳄厌，卻給世界環(huán)境...
茶點(diǎn)故事閱讀 41,092評(píng)論 3贊 328
男人毒藥：我在死后第九天來(lái)索命
文/蒙蒙一、第九天我趴在偏房一處隱蔽的房頂上張望妈踊。院中可真熱鬧了嚎，春花似錦、人聲如沸廊营。這莊子的主人今日做“春日...
開(kāi)封第一講書(shū)人閱讀 31,723評(píng)論 0贊 22
一樁弒父案，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽(yáng)赘风。三九已至夹囚，卻和暖如春，著一層夾襖步出監(jiān)牢的瞬間邀窃，已是汗流浹背荸哟。一陣腳步聲響...
開(kāi)封第一講書(shū)人閱讀 32,858評(píng)論 1贊 269
情欲美人皮
我被黑心中介騙來(lái)泰國(guó)打工假哎，沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留，地道東北人鞍历。一個(gè)月前我還...
沈念sama閱讀 47,891評(píng)論 2贊 370
代替公主和親
正文我出身青樓舵抹，卻偏偏與公主長(zhǎng)得像，于是被迫代替她去往敵國(guó)和親劣砍。傳聞我的和親對(duì)象是個(gè)殘疾皇子惧蛹，可洞房花燭夜當(dāng)晚...
茶點(diǎn)故事閱讀 44,713評(píng)論 2贊 354