C++内存泄漏检测工具(Valgrind之memcheck)

应用场景

请想象以下场景：
辛苦了几个星期，新鲜出炉的几K代码，终于运行起来了。开始测试各项功能指标，一顿操作猛如虎，几个小时过去了，正当准备测试最后一项的时候，程序崩溃了。经过一顿定位，查看日志，发现内存申请失败了。

其实，对于程序员来说，这再正常不过的家常便饭了，谁还没写出过bug，谁还没写出过内存泄漏的代码，只是泄漏多与少的问题。不要慌，不要乱，带上你的排坑卫士Valgrind一起跑，等程序运行结束了，就会给出坑位在哪儿的地图，然后再根据地图指示进行快速填坑。

内存泄漏的常见情况

一句话：内存申请使用后，未释放内存。

细分：

• malloc/calloc/realloc之后，未使用free释放内存
• new之后，未使用delete释放内存
• 多线程场景下：未做多线程保护，重复为同一个变量申请内存
• 线程未正常退出，资源未释放

内存泄漏检测工具局限性

• 只能检测程序运行过的流程中的内存资源是否存在泄漏，未运行的流程分支，都无法检测。因为未运行，就不涉及内存的申请与释放。因此，需要覆盖完全的话，则需要覆盖所有的分支和流程。
• 如果程序退出时，还与申请内存的变量在同一个作用域范围内，无法检测到内存泄漏
• 仅支持程序的正常退出和信号为SIGINT(ctrl+c)的程序退出，不支持kill -9程序的操作

工具安装

1. 下载开源软件包

请点击valgrind 3.21.0.tar.bz2下载。或直接在valgrind官网下载最新的版本。

2. 编译安装

解压软件包：

tar -xf valgrind-3.21.0.tar.bz2

编译软件包：

cd valgrind-3.21.0
sudo mkdir -p /home/soft/valgrind
./configure --prefix=/home/soft/valgrind    # 软件包安装位置:/home/soft/valgrind
sudo make install

3.配置环境变量

配置环境变量，支持在Linux的任何一个目录，都支持访问valgrind可执行程序.

vim ~/.bashrc

# begin: 以下内存为 ~/.bashrc 文件尾部追加
export PATH=$PATH:/home/soft/valgrind/bin
# end: 以上内存为 ~/.bashrc 文件尾部追加

source ~/.bashrc

4.检查安装结果

valgrind --version # 在Linux的任何一个目录中执行此命令

工具使用

1.编译未优化，且带调试信息版本的可执行程序

g++ Xxxx.cpp -O0 -o Xxxx 

2.程序运行

日志文件中%p，代表不同的进程，每次运行避免日志文件被覆盖。

valgrind --tool=memcheck --leak-check=full --log-file=Xxxx%p.log ./Xxxx

3.查看报告结果
找到运行输出的日志文件Xxxx%.log。

• definitely lost：表示明确的内存泄漏，必须解决清0
• indirectly lost:表示间接的内存泄漏，必须解决清0
• possibly lost:可能内存泄漏，需要再排查一下，是否在进程退出时，内存的泄漏。

常见场景举例

不存在内存泄漏

代码示例：

#include <cstdlib>

void Demo()
{
    int* ptr = reinterpret_cast<int*>(malloc(10 * sizeof(int)));    
    if (ptr != nullptr) {
        free(ptr);
    }
}

int main()
{
    Demo();

    return 0;
}

通过工具使用章节，运行后的结果如下：

==273== Memcheck, a memory error detector
==273== Copyright (C) 2002-2017, and GNU GPL'd, by Julian Seward et al.
==273== Using Valgrind-3.15.0 and LibVEX; rerun with -h for copyright info
==273== Command: ./test
==273== Parent PID: 186
==273== 
==273== 
==273== HEAP SUMMARY:
==273==     in use at exit: