身为一名iOS开发,最近在帮安卓的同事研究排查安卓原生C++代码内存问题
的方案... 在iOS中非常简单,但到了安卓中就有点复杂了。折腾了好几天,发现网上很多人发的内容不是很全面,反正我跑不起来。后来在stackoverflow上看到一个帖子,验证了一下是可行的方案,但使用起来有点繁琐。正好想学shell脚本,就边学边做,做了个小工具 ValgrindHelperForAndroid, 我把它提交到了GitHub上。
现在有很多安卓应用因为性能或安全方面原因,会通过JNI调用原生代码。排查原生的C、C++代码时可以使用Valgrind。Valgrind工具包括Memcheck(用于检测C和C++中与内存相关的错误)、Cachegrind(缓存分析器)、Massif(堆分析器)和其他几种工具。Valgrind在Linux开发中应用广泛,但在安卓开发中用起来比较麻烦,官方文档和网上的资料也比较少。这就是这个工具诞生的原因。
关于Valgrind这个工具,这里就不多做介绍了,大家可以参考官网或google.
原创文章,如需转载请在下面留言让我知道😊。不留言不在开头标明出处链接的坏同学,1字1元索赔😡
- 开始之前的说明:
1.你的安卓设备需要root.(有兴趣完善这个脚本的朋友可以尝试一下把这条限制去掉)
2.目前,在下面的电脑和安卓设备中测试成功了(欢迎提交Pull request或在留言里发出你运行成功的环境和设备,我会添加到这里),其他PC和设备可能需要修改脚本。如果需要修改脚本,可以参考原理中的内容。-
macOS 10.13
华为荣耀3C(H30-T00) 4.4.2
-
*原理和FAQ在Wiki里。
如果你优化了这个脚本的兼容性或修改了bug,(或者有能力把这篇文章和Wiki里的内容翻译成英文😂)欢迎提交Pull request❤️
使用
-
将Valgrind安装到安卓设备上:
- 1.下载ValgrindHelperForAndroid.zip和对应你手机cpu架构的Valgrind压缩包:
ARMv7,
ARM64. - 2.解压ValgrindHelperForAndroid.zip,把Valgrind压缩包放到ValgrindHelperForAndroid文件夹中。就像这样:
[图片上传失败...(image-20520f-1512456953110)] - 3.在终端中执行下面的命令:
cd <ValgrindHelperForAndroid Path> ./sss_valgrind_android.sh -I
- 4.出现下面的提示说明安装成功:
DONE, install valgrind success!
- 1.下载ValgrindHelperForAndroid.zip和对应你手机cpu架构的Valgrind压缩包:
-
用Valgrind启动安卓app:
- 1.安装app。建议用ValgrindHelperForAndroid中的valgrind_test工程测试,make project, debug app。
- 2.在终端中执行下面的命令:
cd <ValgrindHelperForAndroid Path> ./sss_valgrind_android.sh
- 3.输入Valgrind命令参数。(可以直接输入回车,用Valgrind默认的参数)
- 4.输入app的包名。(valgrind_test工程为com.sunshushu.test)
- 5.输入app的MainActivity的名称。(valgrind_test工程为MainActivity)
- 6.输入工程中带符号表的库的路径。(valgrind_test工程为valgrind_test/app/build/intermediates/cmake/debug/obj/armeabi-v7a)
- 7.等待app启动。这个过程可能会很长,设备中途可能会无响应或黑屏,你可以先去喝杯咖啡☕️(先不要关闭终端)
- 8.测试app。valgrind_test中,点击app的“MEMORY ISSUES”按钮,会产生3个内存问题。然后点击“EXIT”按钮,正常退出app.
(由于Valgrind在应用结束之前要进行一些工作,如果直接强制关闭app可能导致内存问题排查不全面,所以这里设计了EXIT按钮。)
强制关闭app,并从安卓设备取回Valgrind的日志。
在终端中继续执行下面的命令:
DONE
等待终端中出现下面的提示时,到ValgrindHelperForAndroid文件夹中查看Valgrind日志即可。
DONE. Check the log(s) in ...
(如果你在上面的第8步中点击“EXIT”按钮关闭了app,这里的强制关闭不会影响Valgrind彻底排查内存问题。)查看日志。在日志中搜索app的包名,看一下是不是有内存问题吧。
(日志文件名中的数字是线程ID(PID)。)
原理
- 安装Valgrind:
解压valgrind压缩包,将压缩包中的Inst/Data/Local/Inst拷贝到设备上的/data/local。
(你也可以自己去Valgrind官网下载源码,自己编译。) - 用Valgrind启动安卓app:
1.引导用户输入后面要用到的信息。
2.把下面的内容写到文件中,(我把它命名为了start_valgrind.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的库。测试的时候我发现,即使是debug的安装包,Android Studio安装到设备上的app库也不包含符号表。这会导致导出的Valgrind日志中没法显示出问题的文件名、函数名等信息。所以这个脚本会把带符号表的库替换到设备的/data/data/$PACKAGE_NAME/lib中。
(如果想判断一个库中是否带有符号表,可以用nm命令)
4.设置安卓设备的系统属性。在终端中执行下面的命令:
adb shell setprop wrap.$PACKAGE_NAME "logwrapper /data/local/start_valgrind.sh"
5.强制关闭并启动app
adb shell am force-stop $PACKAGE_NAME
adb shell am start -a android.intent.action.MAIN -n "$PACKAGE_NAME/.$APP_MAIN_ACTIVITY"
6.用上面的命令,强制关闭app。之后从设备上取回Valgrind日志。
adb pull "/sdcard/$LOG_PATH"
FAQ
Q: valgrind_test测试正常,但是我自己的工程中没有产生日志?
A: app需要有读写sd卡文件的权限。
Q: 用完这个脚本之后,为什么我的app启动速度变得特别慢?
A: 可能是因为使用这个脚本启动了你的app之后,直接退出了脚本,没有用这个脚本关闭app。可以尝试重启你的安卓设备。
Q: 用脚本启动了我的app之后,可以断开设备和电脑的连接吗?
A: 可以。只要在测试完app之后,重新把设备和电脑连上,继续执行脚本就可以了。
Q: 我不想用你提供的Valgrind,我可以自己从官网下载吗?
A: 没有任何问题,其实我提供的压缩包就是官方代码编译的。如果你想自己编译Valgrind,可以参考官网,只要将编译好的Inst文件夹放到设备/data/local中就可以了。
Q: 你的脚本对输入参数做的检查太严格了,比如说我没有带符号表的库,怎么用这个脚本呢?
A: 你可以直接在脚本后面加4个参数,分别为Valgrind参数、app包名、MainActivity名、带符号表的库文件夹路径。哪个参数不想填,可以直接留空。比如:
./sss_valgrind_android.sh "" "com.sunshushu.test" "MainActivity" ""
One more thing
感谢stackoverflow上bitek的回答