LeakTracer - 跟踪和分析 C++ 程序中的内存泄漏，使用方法及分析报告转换

目录

1、首先把代码拉下来

2、构建

3、嵌入到代码中

4、生成报告

---

LeakTracer 是一款轻量级的内存泄漏检测工具，主要用于追踪 C/C++ 程序中的内存分配与释放问题，LeakTracer 通过重写 C/C++ 的内存管理函数（如 malloc、free、new、delete），记录所有内存分配和释放操作，并将其保存在内部链表中。在程序运行结束后，分析未释放的内存块，生成泄漏报告。

有两种用法，第一种是使用工具自带的脚本进行内存泄露检测，使用方法可以参考下面的官方文档，或者github上面的文档：

LeakTracer - trace and analyze memory leaks in C++ programs

GitHub - fredericgermain/LeakTracer: Continuation of the LeakTracer project

这里演示第二种用法，将LeakTracer 的库文件嵌入到代码当中，我这边是linux环境：

---

 

1、首先把代码拉下来

因为我的环境问题，我是直接下载了他们的zip:

LeakTracer-master.zip，

https://codeload.github.com/fredericgermain/LeakTracer/zip/refs/heads/master

解压缩：

unzip LeakTracer-master.zip

这里介绍一下目录：

LeakTracer-master/libleaktracer/include/        LeakTracer头文件所在目录

helpers/                                                           pers脚本文件所在目录，用来转换内存泄露报告的

2、构建

进入目录到解压缩后的目录

cd LeakTracer-master

直接make：

make

自动构建，会在LeakTracer-master目录生成一个 build目录，生成的库文件所在路径为：
LeakTracer-master/build/x86_64-linux-gnu/4.9.2/

3、嵌入到代码中

我这里用的是QT Creator，首先将 libleaktracer 目录复制到项目路径下，

将库文件 libleaktracer.so 或 libleaktracer.a 复制到项目路径下，
 

#目录结构
project
├── include
│   └── libleaktracer
│       └── include
├── lib
│   ├── libleaktracer.a
│   └── libleaktracer.so
├── main.cpp
└── test.pro

在pro文件中：

INCLUDEPATH += ./include/libleaktracer/include \   #内存泄露检测工具

LIB += ./lib -lleaktracer \ #内存泄露检测工具

在 main.cpp 中

C API
在程序中包含文件“leaktracer.h”
C++API
在程序中包含文件“MemoryTrace.hpp”

#include <iostream>

// 内存泄露检测工具
#include "MemoryTrace.hpp"   // C++ 引入
//#include "leaktracer.h"    // C   引入


void StopLeaktracer()
{
    // 将检测报告生成到当前目录下
    leaktracer::MemoryTrace::GetInstance().writeLeaksToFile("./leaks_20240318.out");
    leaktracer::MemoryTrace::GetInstance().stopMonitoringAllocations();
    leaktracer::MemoryTrace::GetInstance().stopAllMonitoring();
}

void signalHandler(int signum)
{
    StopLeaktracer();
    std::cout << "User manually closes program, stop signal:" << signum << std::endl;
    exit(0);
}

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

    std::signal(SIGINT, signalHandler);
    std::signal(SIGTSTP, signalHandler);
    std::signal(SIGTERM ,signalHandler);
    leaktracer::MemoryTrace::GetInstance().Setup();
    leaktracer::MemoryTrace::GetInstance().startMonitoringAllThreads();

     其他业务




     其他业务

    StopLeaktracer();
    return 0;
}

4、生成报告

生成的报告长这样，这里截取小部分，实际上特别长，几百M也有，直接读懂比较困难：

# LeakTracer report diff_utc_mono=1742244754.252312
leak, time=19847.797617, stack=0x4952de 0x495368 0x4796fa 0x45af80 0x4852c1, size=16, data= .......YxG.;...
leak, time=19847.747195, stack=0x4952de 0x495368 0x4796fa 0x45af80 0x4852c1, size=16, data= ...............
leak, time=19844.228222, stack=0x4952de 0x495368 0x4796fa 0x45af80 0x4852c1, size=16, data= .......w.G.;...
leak, time=19843.602289, stack=0x4952de 0x495368 0x4796fa 0x45af80 0x4852c1, size=16, data= .......[&G.;...
leak, time=19843.096957, stack=0x4952de 0x495368 0x4796fa 0x45af80 0x4852c1, size=16, data= .......t.......
leak, time=19839.543897, stack=0x4952de 0x495368 0x4796fa 0x45af80 0x4852c1, size=16, data= ...............
leak, time=19838.725576, stack=0x7f0fc1450a17 0x7f0fc144df65 0x7f0fc1459e00 0x7f0fc144e7b1 0x7f0fc3ece329, size=8, data=crammd5.
leak, time=19838.686366, stack=0x7f0fbff07378 0x7f0fbff91883 0x7f0fbff93efa 0x7f0fbff938cb 0x7f0fbfff5f3e, size=24, data=0.(.......#......`./....
leak, time=19742.406077, stack=0x49aadf 0x48912e 0x4aeb6c 0x4a47b9 0x4ac50d, size=16, data=................
leak, time=19740.071215, stack=0x49aadf 0x48912e 0x4aeb6c 0x4a47b9 0x4ac50d, size=16, data=P[..............
leak, time=19740.030656, stack=0x49aadf 0x48912e 0x4aeb6c 0x4a47b9 0x4ac50d, size=16, data=.........L......
leak, time=19720.473644, stack=0x49aadf 0x48912e 0x4aeb6c 0x4a47b9 0x4ac50d, size=16, data=.........o......data=.B........F.;...
leak, time=18870.025662, stack=0x49aadf 0x48912e 0x4aeb6c 0x4a47b9 0x4ac50d, size=16, data= .i......MG.;...
leak, time=18869.971012, stack=0x49aadf 0x48912e 0x4aeb6c 0x4a47b9 0x4ac50d, size=16, data=@.......%.F.;...
leak, time=18866.245253, stack=0x49aadf 0x48912e 0x4aeb6c 0x4a47b9 0x4ac50d, size=16, data= .Q.......F.;...

这里我们直接使用官方自带的脚本来解析栈信息，
前面说到过，官方脚本所在路径为：LeakTracer-master/helpers

leak-analyze-addr2line        它使用addr2line命令将内存地址转换为源代码中的位置
leak-analyze-gdb                 通过gdb（GNU调试器）来获取有关泄漏的详细信息

它们都是Perl脚本，因此需要安装Perl模块

#对于CentOS
sudo yum update
sudo yum install perl


#对于Debian
sudo apt update
sudo apt install perl

使用方法：

将我们生成的可执行文件和leaks_20240318.out，复制到 LeakTracer-master/helpers 目录中

在这个路径中：
 

perl leak-analyze-addr2line test_app leaks_20240318.out

在终端会出现大量的解析，这里截取小部分：

960 bytes lost in 20 blocks (one of them allocated at 18267.535296), from following call stack:
	/usr/include/c++/4.9/bits/stl_pair.h:127
	/usr/include/c++/4.9/bits/stl_tree.h:1223
	/usr/include/c++/4.9/bits/stl_tree.h:676
	/usr/include/c++/4.9/bits/stl_vector.h:923
	/usr/include/c++/4.9/bits/basic_string.h:725
139776 bytes lost in 2912 blocks (one of them allocated at 20037.185878), from following call stack:
	/usr/include/c++/4.9/bits/stl_tree.h:560
	/usr/include/c++/4.9/bits/stl_tree.h:1452
	/usr/include/c++/4.9/bits/stl_tree.h:1458
	/usr/include/c++/4.9/bits/stl_tree.h:1570
32 bytes lost in 1 blocks (one of them allocated at 20039.805045), from following call stack:
	/usr/include/c++/4.9/bits/shared_ptr_base.h:496
	/usr/include/c++/4.9/bits/alloc_traits.h:399
	/usr/include/c++/4.9/bits/alloc_traits.h:399
	/usr/include/c++/4.9/bits/stl_tree.h:430
	/usr/include/c++/4.9/bits/stl_tree.h:1573
1232792 bytes lost in 14009 blocks (one of them allocated at 20040.686414), from following call stack:
	/usr/include/c++/4.9/bits/alloc_traits.h:252
	/usr/include/c++/4.9/bits/alloc_traits.h:252
	/usr/include/c++/4.9/bits/stl_tree.h:420
	/usr/include/c++/4.9/bits/alloc_traits.h:281
	/usr/include/c++/4.9/bits/stl_tree.h:1573

记录到一个文档中：
将终端输出的打印全部记录到 test_leaks_0318.txt 中

script test_leaks_0318.txt

然后再运行

perl leak-analyze-addr2line test_app leaks_20240318.out

这样就可以将解析出来的栈信息全部打印到文件中了

leak-analyze-gdb 工具的用法与上面步骤相同