内存泄露的检测工具——Valgrind

1.1 下载安装

         Valgrind是在linux系统下开发应用程序时用于调试内存问题的工具。它尤其擅长发现内存管理的问题，它可以检查程序运行时的内存泄漏问题。

        它的官方网址是 http://www.valgrind.org/，下载最新版本的Valgrind，目前是3.11.0。

         Linux下下载：wget http://www.valgrind.org/downloads/valgrind-3.11.0.tar.bz2 

       按照里面的README提示，采用标准gnu软件安装方式，先使用tar进行解压缩，然后是./configure — make —- makeinstall，安装后，输入valgrind ls -l验证一下该工具是否工作正常（这是README里面的方法，实际上是验证一下对ls -l命令的内存检测），如果你看到一堆的信息说明你的工具可以使用了。

         注意：不要移动Valgrind到一个与--prefix指定的不一样的目录，这将导致一些莫名其妙的错误，大多数在Valgrind处理/fork/exec调用时。

1.2  功能介绍

         Valgrind是一个GPL的软件，用于Linux（For x86,amd64 and ppc32）程序的内存调试和代码剖析。你可以在它的环境中运行你的程序来监视内存的使用情况，比如C 语言中的malloc和free或者 C++中的new和 delete。使用Valgrind的工具包，你可以自动的检测许多内存管理和线程的bug，避免花费太多的时间在bug寻找上，使得你的程序更加稳固。

         Valgrind工具包包含多个工具，如Memcheck,Cachegrind,Helgrind,Callgrind，Massif。下面分别介绍个工具的作用：

1)      Memcheck 工具主要检查下面的程序错误：

使用未初始化的内存 (Use of uninitialised memory)

使用已经释放了的内存 (Reading/writing memory after it has been free’d)

使用超过 malloc分配的内存空间(Reading/writing off the end of malloc’d blocks)

对堆栈的非法访问 (Reading/writing inappropriate areas on the stack)

申请的空间是否有释放 (Memory leaks – where pointers to malloc’d blocks are lost forever)

malloc/free/new/delete申请和释放内存的匹配(Mismatcheduse of malloc/new/new [] vs free/delete/delete [])

src和dst的重叠(Overlappingsrc and dst pointers in memcpy() and related functions)

2)      Callgrind

Callgrind收集程序运行时的一些数据，函数调用关系等信息，还可以有选择地进行cache 模拟。在运行结束时，它会把分析数据写入一个文件。callgrind_annotate可以把这个文件的内容转化成可读的形式。

3)      Cachegrind

它模拟 CPU中的一级缓存I1,D1和L2二级缓存，能够精确地指出程序中 cache的丢失和命中。如果需要，它还能够为我们提供cache丢失次数，内存引用次数，以及每行代码，每个函数，每个模块，整个程序产生的指令数。这对优化程序有很大的帮助。

4)      Helgrind

它主要用来检查多线程程序中出现的竞争问题。Helgrind 寻找内存中被多个线程访问，而又没有一贯加锁的区域，这些区域往往是线程之间失去同步的地方，而且会导致难以发掘的错误。Helgrind实现了名为” Eraser” 的竞争检测算法，并做了进一步改进，减少了报告错误的次数。

5)      Massif

堆栈分析器，它能测量程序在堆栈中使用了多少内存，告诉我们堆块，堆管理块和栈的大小。Massif能帮助我们减少内存的使用，在带有虚拟内存的现代系统中，它还能够加速我们程序的运行，减少程序停留在交换区中的几率。

         具体应用场景如下：

1、  检查内存错误：

例如我们原来有一个程序test，这是一个用gcc –g参数编译的程序，运行它需要：

#./a.out

如果我们想用valgrind的内存检测工具，我们就要用如下方法调用：

#valgrind --leak-check=full--show-reachable=yes --trace-children= yes   ./a.out

logfile加上会好些，程序在执行期间stderr会有一些输出。加上logfile的话可以像dmalloc那样打开logfile来查看错误信息。

其中--leak-check=full 指的是完全检查内存泄漏，--show-reachable=yes是显示内存泄漏的地点，--trace-children=yes是跟入子进程。

如果您的程序是会正常退出的程序，那么当程序退出的时候valgrind自然会输出内存泄漏的信息。如果您的程序是个守护进程，那么也不要紧，我们只要在别的终端下杀死memcheck进程（因为valgrind默认使用memcheck工具，就是默认参数—tools=memcheck）：

#killall memcheck

这样我们的程序（./a.out）就被kill了

2、  检查代码覆盖和性能瓶颈：

我们调用valgrind的工具执行程序：

#valgrind --tool=callgrind ./sec_infod

会在当前路径下生成callgrind.out.pid（当前生产的是callgrind.out.19689），如果我们想结束程序，可以：

#killall callg rind

然后我们看一下结果：

#callgrind_annotate --auto=yescallgrind.out.19689   >log

#vim log

3、  Valgrind使用参数

         --log-fd=N 默认情况下，输出信息是到标准错误stderr，也可以通过—log-fd=8，输出到描述符为8的文件

         --log-file=filename将输出的信息写入到filename.PID的文件里，PID是运行程序的进行ID。可以通过--log- file exactly=filename指定就输出到filename文件。

         --log-file-qualifier=<VAR>,取得环境变量的值来做为输出信息的文件名。如—log-file- qualifier=$FILENAME。

         --log-socket=IP:PORT 也可以把输出信息发送到网络中指定的IP:PORT去

         --error-limit=no 对错误报告的个数据进行限制，默认情况不做限制

         --tool=<toolname> [default: memcheck]

--tool=memcheck：要求用memcheck这个工具对程序进行分析

     --leak-ckeck=yes 要求对leak给出详细信息

    --trace-children=<yes|no> [default: no]跟踪到子进程里去，默认请况不跟踪

    --xml=<yes|no> [default: no]将信息以xml格式输出，只有memcheck可用

    --gen-suppressions=<yes|no|all> [default: no]如果为yes，valgrind会在每发现一个错误便停下让用户做选择是继续还是退出

         更多选项请参看：http://www.valgrind.org/docs/manual/manual-core.html可以把一些默认选项编辑在~/.valgrindrc文件里。

         这里使用valgrind的memcheck和callgrind两个工具的用法，其实valgrind还有几个工具：“cachegrind”,用于检查缓存使用的；“helgrind”用于检测多线程竞争资源的，等等。

          与dmalloc相比，Valgrind使用范围更广，它不但能够检测出堆内存的泄露，对线程间使用共同资源所带来的内存泄露也能够察觉出来，但是valgrind所产生的log信息往往比dmalloc多得多，有时候就是一千多行的log信息，让人看到就头痛。

1.3 使用步骤：

基本步骤就两步：

1)      编译程序，生成可执行文件：

gcc –Wall example.c –g –o example

2)      使用valgrind工具，运行文件检测：

valgrind --tool=memcheck --leak-check=yes./example

程序demo：

filename：example.c

#include <stdio.h>
 
void f()
{
         int*ptr = malloc(10 * sizeof(int));
         ptr[10]= 0;    //first error
         return;   //return without free
}
 
int main()
{
         f();
         return0;
}

编译：

gcc –Wall example.c –g –o example  #-g指定可用于debug的信息选项

 

分析：

valgrind --tool=memcheck --leak-check=yes  --log-file=output.log -q ./example

(选项含义可用valgrind–help查看)

执行结果如下：

==21072== Invalid writeof size 4         

==21072==   at 0x80483DF: f (example.c:6)

==21072==   by 0x80483F2: main (example.c:12)

==21072== Address 0x4021050 is 0 bytes after a block of size 40 alloc'd

==21072==   at 0x40079C5: malloc (vg_replace_malloc.c:299)

==21072==   by 0x80483D5: f (example.c:5)

==21072==   by 0x80483F2: main (example.c:12)

==21072==

==21072== 40 bytes in 1blocks are definitely lost in loss record 1 of 1

==21072==   at 0x40079C5: malloc (vg_replace_malloc.c:299)

==21072==   by 0x80483D5: f (example.c:5)

==21072==   by 0x80483F2: main (example.c:12)

==21072==

其中标红的行指示了程序中的两个bug

引用链接：

http://blog.163.com/cp7618@yeah/blog/static/702347772012728105356157/