内存泄漏定位工具之 mtrace（一）

1 前言

        mtrace（memory trace），是 GNU Glibc 自带的内存问题检测工具，它可以用来协助定位内存泄露问题。它的实现源码在glibc源码的malloc目录下，其基本设计原理为设计一个函数 void mtrace ()，函数对 libc 库中的 malloc/free 等函数的调用进行追踪，由此来检测内存是否存在泄漏的情况。

---

2 使用方式

2.1 修改源码

在使用之前，需要修改我们的源码，用来跟踪内存分配和释放，其中需要使用两个函数

#include <mcheck.h>

/* 开启内存分配跟踪 */
void mtrace(void);

/* 取消内存分配跟踪 */
void muntrace(void);

mtrace() 函数中会为那些和动态内存分配有关的函数（譬如 malloc()、realloc()、memalign() 以及 free()）安装 “钩子（hook）” 函数，这些 hook 函数会为我们记录所有有关内存分配和释放的跟踪信息，而 muntrace() 则会卸载相应的 hook 函数。基于这些 hook 函数生成的调试跟踪信息，我们就可以分析是否存在 “内存泄露” 这类问题了。

例如：

#include <mcheck.h>
#include <stdlib.h>
#include <stdio.h>

int main(int argc, char **argv)
{
    mtrace();  // 开始跟踪

    char *p = (char *)malloc(100);

    free(p);
    p = NULL;

    p = (char *)malloc(100);

    muntrace();   // 结束跟踪，并生成日志信息

    return 0;
}

        从上述代码中，我们希望能够在程序开始到结束检查内存是否泄漏的问题，例子简单，一眼就能看出存在内存泄漏的问题，所以我们需要验证 mtrace 是否能够检查出来内存泄漏问题，且检查的结果如何分析定位。

2.2 编译源码

编译修改后的源码，生成可执行文件（一定加上 -g 参数选项，能够帮我们定位代码中的具体位置，否则看到的只是执行文件中的地址信息）

gcc -g test.c -o test

2.3 设置日志生成路径

        mtrace 机制需要我们实际运行一下程序，然后才能生成跟踪的日志，但在实际运行程序之前还有一件要做的事情是需要告诉 mtrace （即前文提到的 hook 函数）生成日志文件的路径。具体的方法是通过定义并导出一个环境变量 "MALLOC_TRACE"，如下所示。

export MALLOC_TRACE=./test.log  // 当前目录下

2.4 运行程序

./test

程序运行结束，会在当前目录生成 test.log 文件，打开可以看到一下内容：

= Start
@ ./test:[0x400624] + 0x21ed450 0x64
@ ./test:[0x400634] - 0x21ed450
@ ./test:[0x400646] + 0x21ed450 0x64
= End

从这个文件中可以看出中间三行分别对应源码中的 malloc -> free -> malloc 操作；解读：./test 指的是我们执行的程序名字，[0x400624] 是第一次调用 malloc 函数机器码中的地址信息，+ 表示申请内存（ - 表示释放），0x21ed450 是 malloc 函数申请到的地址信息，0x64 表示的是申请的内存大小。由此分析第一次申请已经释放，第二次申请没有释放，存在内存泄漏的问题。

---

3 分析定位

        通过上面的日志简单分析确定存在内存泄漏，但是程序不可能这么简单，如果按上述去分析，得累死，因此通过下面的方式可快速定位。

3.1 定位源码所在行数

通过使用 "addr2line" 命令工具，得到源文件的行数（通过这个可以根据机器码地址定位到具体源码位置）。

# addr2line -e test 0x400624
/home/const/workspace/memtest/test.c:9

3.2 分析内存泄漏

上述指令仅仅只是可以定位源码位置，但是没法分析存在内存泄漏的问题，因此需要通过下述指令分析日志信息（mtrace + 可执行文件路径 + 日志文件路径）。

# mtrace test ./test.log

Memory not freed:
-----------------
           Address     Size     Caller
0x00000000021ed450     0x64  at /home/const/WorkSpace/memtest/test.c:14