mtrace-内存使用追踪

本文转自：https://www.jianshu.com/p/d9e12b66096a

1. 函数格式：

       #include <mcheck.h>

       void mtrace(void);

       void muntrace(void);

mtrace 用于开启内存使用记录，muntrace用于取消内存使用记录。内存使用情况记录到一个文件，值由环境变量：MALLOC_TRACE决定。

2. 范例：

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

int main(int argc, char **argv)
{
        mtrace();

        char * p = malloc(100);

        free(p);

        p = malloc(1000);

        muntrace();

        return 0;
}

编译：
$ gcc mtrace.c -g
加上 -g 参数，在程序中记录调试信息。是为了后面进行程序地址转换为代码文件位置。

导出内存记录文件路径的环境变量：
$ export MALLOC_TRACE=/home/centos/gnuc/c3/trace.log

运行结果：

$ ./a.out

$ cat trace.log
= Start
@ ./a.out:[0x40062b] + 0xf15460 0x64
@ ./a.out:[0x40063b] - 0xf15460
@ ./a.out:[0x400645] + 0xf154d0 0x3e8
= End

3. 分析结果：

从记录文件可以看出，其格式如下：
@ 程序名称:[内存分配调用的地址] +/- 操作的内存地址部分参数
+ 表示分配；- 表示释放

可以使用 mtrace 命令来分析记录文件。mtrace 命令是 glibc-utils 的工具，是一个 perl 脚本文件，通过调用 addr2line 命令来进行解析代码文件位置。如果无该命令，可以安装 glibc-utils 来安装该命令。

使用mtrace命令分析：

$ mtrace a.out trace.log
Memory not freed:
-----------------
           Address     Size     Caller
0x00000000013fc4d0    0x3e8  at /home/centos/gnuc/c3/mtrace.c:13

mtrace 函数是通过修改 malloc_hook 等内存操作接口的回调来实现记录内存使用的。如何取得内存分配函数的调用地址呢？gcc 有一个内置的函数，用于返回本函数将要返回的地址。

内置返回地址函数：

void * __builtin_return_address (unsigned int level);

返回的是处于 level 级堆栈的地址。 level 为 0 表示本函数返回的地址，为 1 表示本函数的上一个函数返回的地址，依次类推。
该函数细节可参考：gcc online 文档

范例：

#include <stdio.h>

int test(int argc, char **argv)
{
        void *ret =  __builtin_return_address(0);
        printf("%p\n", ret - 1); 

        void *caller = __builtin_frame_address(0);

        printf("%p\n", caller);
        return 0;
}

int main(int argc, char **argv)
{
        test(argc, argv);
        return 0;
}

内置函数返回的是本函数返回的地址，是函数调用的下一条语句，所以使用ret - 1来记录函数被调用地址。

编译：
$ gcc retaddr.c -g

运行结果：

$ ./a.out
0x40059e
0x7ffdb38621f0

将地址转换为代码位置：

$ addr2line -f -e a.out -a 0x40059e
0x000000000040059e
main
/home/centos/gnuc/c3/retaddr.c:16

4. 使用场景：

mtrace 采用 malloc_hook + return_addr 这两个机制来实现的。

mtrace 会记录所有的分配、释放，包括所有的模块、线程。内存使用记录必将很多，所以官方推荐使用 SIGUSR1或SIGUSR2 来进行开启和关闭内存记录功能。
从 mtrace 记录和分析结果可以看到，内存记录日志只记录到 malloc 层面。而实际项目开发时，很多接口都是封装多层才会实际调用到 malloc，对于上面几层的地址，mtrace 没有记录。而上面几层的调用关系才是追踪内存泄漏问题的关键所在。所以在实际开发的项目中，使用 mtrace 不是一个特别好的方法。这里推荐使用 valgrind 工具进行跑流程的方式追踪内存泄漏。如果想要自己记录内存使用情况，可以考虑以下两种方式：

封装一层内存分配、释放的接口函数来记录内存使用情况。项目开发时，统一使用这个接口来进行内存管理。适用于项目尚未开始。

使用 malloc_hook 的方式进行记录，项目代码可以不变。适合于项目已经比较庞大了。