身為一名iOS開(kāi)發(fā),最近在幫安卓的同事研究排查安卓原生C++代碼內(nèi)存問(wèn)題
的方案... 在iOS中非常簡(jiǎn)單,但到了安卓中就有點(diǎn)復(fù)雜了。折騰了好幾天,發(fā)現(xiàn)網(wǎng)上很多人發(fā)的內(nèi)容不是很全面,反正我跑不起來(lái)。后來(lái)在stackoverflow上看到一個(gè)帖子,驗(yàn)證了一下是可行的方案,但使用起來(lái)有點(diǎn)繁瑣。正好想學(xué)shell腳本,就邊學(xué)邊做,做了個(gè)小工具 ValgrindHelperForAndroid, 我把它提交到了GitHub上。
現(xiàn)在有很多安卓應(yīng)用因?yàn)樾阅芑虬踩矫嬖颍瑫?huì)通過(guò)JNI調(diào)用原生代碼。排查原生的C、C++代碼時(shí)可以使用Valgrind。Valgrind工具包括Memcheck(用于檢測(cè)C和C++中與內(nèi)存相關(guān)的錯(cuò)誤)、Cachegrind(緩存分析器)、Massif(堆分析器)和其他幾種工具。Valgrind在Linux開(kāi)發(fā)中應(yīng)用廣泛,但在安卓開(kāi)發(fā)中用起來(lái)比較麻煩,官方文檔和網(wǎng)上的資料也比較少。這就是這個(gè)工具誕生的原因。
關(guān)于Valgrind這個(gè)工具,這里就不多做介紹了,大家可以參考官網(wǎng)或google.
原創(chuàng)文章,如需轉(zhuǎn)載請(qǐng)?jiān)谙旅媪粞宰屛抑??。不留言不在開(kāi)頭標(biāo)明出處鏈接的壞同學(xué),1字1元索賠??
- 開(kāi)始之前的說(shuō)明:
1.你的安卓設(shè)備需要root.(有興趣完善這個(gè)腳本的朋友可以嘗試一下把這條限制去掉)
2.目前,在下面的電腦和安卓設(shè)備中測(cè)試成功了(歡迎提交Pull request或在留言里發(fā)出你運(yùn)行成功的環(huán)境和設(shè)備,我會(huì)添加到這里),其他PC和設(shè)備可能需要修改腳本。如果需要修改腳本,可以參考原理中的內(nèi)容。-
macOS 10.13
華為榮耀3C(H30-T00) 4.4.2
-
*原理和FAQ在Wiki里。
如果你優(yōu)化了這個(gè)腳本的兼容性或修改了bug,(或者有能力把這篇文章和Wiki里的內(nèi)容翻譯成英文??)歡迎提交Pull request??
使用
-
將Valgrind安裝到安卓設(shè)備上:
- 1.下載ValgrindHelperForAndroid.zip和對(duì)應(yīng)你手機(jī)cpu架構(gòu)的Valgrind壓縮包:
ARMv7,
ARM64. - 2.解壓ValgrindHelperForAndroid.zip,把Valgrind壓縮包放到ValgrindHelperForAndroid文件夾中。就像這樣:
[圖片上傳失敗...(image-20520f-1512456953110)] - 3.在終端中執(zhí)行下面的命令:
cd <ValgrindHelperForAndroid Path> ./sss_valgrind_android.sh -I
- 4.出現(xiàn)下面的提示說(shuō)明安裝成功:
DONE, install valgrind success!
- 1.下載ValgrindHelperForAndroid.zip和對(duì)應(yīng)你手機(jī)cpu架構(gòu)的Valgrind壓縮包:
-
用Valgrind啟動(dòng)安卓app:
- 1.安裝app。建議用ValgrindHelperForAndroid中的valgrind_test工程測(cè)試,make project, debug app。
- 2.在終端中執(zhí)行下面的命令:
cd <ValgrindHelperForAndroid Path> ./sss_valgrind_android.sh
- 3.輸入Valgrind命令參數(shù)。(可以直接輸入回車(chē),用Valgrind默認(rèn)的參數(shù))
- 4.輸入app的包名。(valgrind_test工程為com.sunshushu.test)
- 5.輸入app的MainActivity的名稱(chēng)。(valgrind_test工程為MainActivity)
- 6.輸入工程中帶符號(hào)表的庫(kù)的路徑。(valgrind_test工程為valgrind_test/app/build/intermediates/cmake/debug/obj/armeabi-v7a)
- 7.等待app啟動(dòng)。這個(gè)過(guò)程可能會(huì)很長(zhǎng),設(shè)備中途可能會(huì)無(wú)響應(yīng)或黑屏,你可以先去喝杯咖啡??(先不要關(guān)閉終端)
- 8.測(cè)試app。valgrind_test中,點(diǎn)擊app的“MEMORY ISSUES”按鈕,會(huì)產(chǎn)生3個(gè)內(nèi)存問(wèn)題。然后點(diǎn)擊“EXIT”按鈕,正常退出app.
(由于Valgrind在應(yīng)用結(jié)束之前要進(jìn)行一些工作,如果直接強(qiáng)制關(guān)閉app可能導(dǎo)致內(nèi)存問(wèn)題排查不全面,所以這里設(shè)計(jì)了EXIT按鈕。)
強(qiáng)制關(guān)閉app,并從安卓設(shè)備取回Valgrind的日志。
在終端中繼續(xù)執(zhí)行下面的命令:
DONE
等待終端中出現(xiàn)下面的提示時(shí),到ValgrindHelperForAndroid文件夾中查看Valgrind日志即可。
DONE. Check the log(s) in ...
(如果你在上面的第8步中點(diǎn)擊“EXIT”按鈕關(guān)閉了app,這里的強(qiáng)制關(guān)閉不會(huì)影響Valgrind徹底排查內(nèi)存問(wèn)題。)查看日志。在日志中搜索app的包名,看一下是不是有內(nèi)存問(wèn)題吧。
(日志文件名中的數(shù)字是線程ID(PID)。)
原理
- 安裝Valgrind:
解壓valgrind壓縮包,將壓縮包中的Inst/Data/Local/Inst拷貝到設(shè)備上的/data/local。
(你也可以自己去Valgrind官網(wǎng)下載源碼,自己編譯。) - 用Valgrind啟動(dòng)安卓app:
1.引導(dǎo)用戶(hù)輸入后面要用到的信息。
2.把下面的內(nèi)容寫(xiě)到文件中,(我把它命名為了start_valgrind.sh),然后移到設(shè)備的/data/local文件夾中。
#!/system/bin/sh
PACKAGE="${PACKAGE_NAME}"
VGPARAMS='${VALGRIND_PARAMS}'
export TMPDIR=/data/data/$PACKAGE
exec /data/local/Inst/bin/valgrind $VGPARAMS $*
3.替換app的庫(kù)。測(cè)試的時(shí)候我發(fā)現(xiàn),即使是debug的安裝包,Android Studio安裝到設(shè)備上的app庫(kù)也不包含符號(hào)表。這會(huì)導(dǎo)致導(dǎo)出的Valgrind日志中沒(méi)法顯示出問(wèn)題的文件名、函數(shù)名等信息。所以這個(gè)腳本會(huì)把帶符號(hào)表的庫(kù)替換到設(shè)備的/data/data/$PACKAGE_NAME/lib中。
(如果想判斷一個(gè)庫(kù)中是否帶有符號(hào)表,可以用nm命令)
4.設(shè)置安卓設(shè)備的系統(tǒng)屬性。在終端中執(zhí)行下面的命令:
adb shell setprop wrap.$PACKAGE_NAME "logwrapper /data/local/start_valgrind.sh"
5.強(qiáng)制關(guān)閉并啟動(dòng)app
adb shell am force-stop $PACKAGE_NAME
adb shell am start -a android.intent.action.MAIN -n "$PACKAGE_NAME/.$APP_MAIN_ACTIVITY"
6.用上面的命令,強(qiáng)制關(guān)閉app。之后從設(shè)備上取回Valgrind日志。
adb pull "/sdcard/$LOG_PATH"
FAQ
Q: valgrind_test測(cè)試正常,但是我自己的工程中沒(méi)有產(chǎn)生日志?
A: app需要有讀寫(xiě)sd卡文件的權(quán)限。
Q: 用完這個(gè)腳本之后,為什么我的app啟動(dòng)速度變得特別慢?
A: 可能是因?yàn)槭褂眠@個(gè)腳本啟動(dòng)了你的app之后,直接退出了腳本,沒(méi)有用這個(gè)腳本關(guān)閉app。可以嘗試重啟你的安卓設(shè)備。
Q: 用腳本啟動(dòng)了我的app之后,可以斷開(kāi)設(shè)備和電腦的連接嗎?
A: 可以。只要在測(cè)試完app之后,重新把設(shè)備和電腦連上,繼續(xù)執(zhí)行腳本就可以了。
Q: 我不想用你提供的Valgrind,我可以自己從官網(wǎng)下載嗎?
A: 沒(méi)有任何問(wèn)題,其實(shí)我提供的壓縮包就是官方代碼編譯的。如果你想自己編譯Valgrind,可以參考官網(wǎng),只要將編譯好的Inst文件夾放到設(shè)備/data/local中就可以了。
Q: 你的腳本對(duì)輸入?yún)?shù)做的檢查太嚴(yán)格了,比如說(shuō)我沒(méi)有帶符號(hào)表的庫(kù),怎么用這個(gè)腳本呢?
A: 你可以直接在腳本后面加4個(gè)參數(shù),分別為Valgrind參數(shù)、app包名、MainActivity名、帶符號(hào)表的庫(kù)文件夾路徑。哪個(gè)參數(shù)不想填,可以直接留空。比如:
./sss_valgrind_android.sh "" "com.sunshushu.test" "MainActivity" ""
One more thing
感謝stackoverflow上bitek的回答