Android C++ Native 内存泄露检查工具Raphael使用介绍

字节跳动memory-leak-detector
MemoryLeakDetector 是西瓜视频基础技术团队开发的一款 native 内存泄漏监控工具，具有接入简单、监控范围广、性能优良、 稳定性好的特点。广泛用于字节跳动旗下各大 App 的 native 内存泄漏治理，收益显著！

实现原理

raphael实现原理

使用方法

步骤如下：

1. 添加Raphael到要检测的apk，编译运行
2. 启动泄露检测监控
3. 生成泄露报告：打印堆栈内容到文件
4. 使用工具泄露数据文件和mmap文件

Raphael添加到测试apk

添加项目依赖

在Android studio的工程根目录下的build.gradle中的allprojects添加：maven { url ‘https://jitpack.io’ }，如下图：

allprojects {
    repositories {
        google()
        jcenter()
        flatDir {
            dirs 'libs'
        }
        maven { url 'https://jitpack.io' }
    }
}

添加依赖项目到测试工程的app目录下的build.gradle中添加：
implementation ‘com.github.bytedance:memory-leak-detector:0.2.1’

dependencies {
    implementation 'com.github.bytedance:memory-leak-detector:0.2.1'
}

同步gradle

点击工具栏中的Sync project with gradle files 同步按钮

启动泄露检测功能

有2种方法启动，使用其中的一种即可：

1. 使用Android的boardcast
2. 添加到代码中

直接使用boardcast功能控制

监控指定so:

## 通过本地广播监控指定的so
## 0x0CF0400=Raphael.MAP64_MODE|Raphael.ALLOC_MODE|0x0F0000|1024
adb shell am broadcast -a com.bytedance.raphael.ACTION_START -f 0x01000000 --es configs 0xCF0400 --es regex ".*libXXX\\.so$"

监控进程：

## 监控整个进程（RaphaelReceiver 组件所在的进程）
## 0x0CF0400=Raphael.MAP64_MODE|Raphael.ALLOC_MODE|0x0F0000|1024
adb shell am broadcast -a com.bytedance.raphael.ACTION_START -f 0x01000000 --es configs 0xCF0400

在测试代码中启动

本步骤是可选步骤
添加Raphael.start到测试工程的kotlin/java代码里面。使用Android Studio自动import功能补全引用。
参数、条件说明：

1. 需要设备位置权限，比如sdcard的读写权限
2. 可以指定具体名称如libdemo.so

class MyApplication : Application() {
    override fun onCreate() {
        // Todo: use clientID and businessID get from xiaodu
        EdgeManager.init(this, "testClient", 3001);
        Log.d(TAG, "edgeSDK:" + EdgeManager.getVersion())
        Raphael.start(
            Raphael.MAP64_MODE or Raphael.ALLOC_MODE or 0x0F0000 or 1024,
            "/storage/emulated/0/raphael",  // need sdcard permission
            ".*libdemo.so$"
        )
        super.onCreate()
    }
 }

生成泄露报告

只有调用打印功能或者stop功能才生成泄露报告到指定目录

调用打印功

## broadcast command
adb shell am broadcast -a com.bytedance.raphael.ACTION_PRINT -f 0x01000000

分析报告

## 聚合 report，该文件在 print/stop 之后生成，需要手动 pull 出来
## 用到离线符号符号化功能的，需将raphael.py里的addr2line改为自己本地的NDK路径
##   -r: 日志路径, 必需，手机端生成的report文件
##   -o: 输出文件名，非必需，默认为 leak-doubts.txt
##   -s: 符号表目录，非必需，有符号化需求时可传，符号表文件需跟so同名，如：libXXX.so，多个文件需放在同一目录下儿
python3 library/src/main/python/raphael.py -r report -o leak-doubts.txt -s ./symbol/

## 数据格式说明
##  201,852,591	totals // 单指raphael拦截到的未释放的虚拟内存总和
##  118,212,424	libandroid_runtime.so
##   28,822,002	libhwui.so
##   24,145,920	libstagefright.so
##   15,679,488	libv8.cr.so
##    9,566,192	libc++_shared.so
##       25,536	libsqlite.so
##       12,288	libv8_libbase.cr.so
##    5,388,741	extras // raphael.py里预设了一些通用配置，可以通过修改规则进一步识别分组到extras里的数据
##
##
## bdb11000, 70828032, 66 => bdb11000是report里此堆栈第一次分配出的内存地址，70828032是report里此堆栈的内存总和，66是report里此堆栈的总次数
## 0x000656cf /system/lib/libc.so (pthread_create + 246)
## 0x0037c129 /system/lib/libart.so (art::Thread::CreateNativeThread(_JNIEnv*, _jobject*, unsigned int, bool) + 448)
## 0x00112137 /system/framework/arm/boot.oat (java.lang.Thread.nativeCreate + 142)

分析 maps

## 分析 maps
##  -m: maps文件路径，必需
python3 library/src/main/python/mmap.py -m maps

停止监控

## 广播控制
adb shell am broadcast -a com.bytedance.raphael.ACTION_STOP -f 0x01000000

参考