微软Debug CRT库是如何追踪C++内存泄露的？

之前已经写过四篇关于Windows中如何查找内存泄露的方法，基本上可以帮你找到内存泄露的问题所在。查看系列文章请发送关键字 内存泄漏 获取。

那么为什么要写这篇文章呢？

本人在逛知乎的时候，看到一个问题<<C++不用工具，如何检测内存泄漏？>>, 不乏很多高手的回答。我正好也写了几篇通过工具去分析内存泄露的文章，那先说说工具的方法原理:

1. 对内存的分配的监测: 记录内存申请时候函数调用栈。一种方法是通过gflag配置让程序在分配内存的时候，记录函数调用栈；还有一种就是通过hook的方式去获取申请内存时候函数调用时候的位置。
2. 对比程序运行时两个不同时间点的内存分配状况，通过对比找到较多的内存分配点对应的函数调用栈

那么回到正题，如果自己去实现无非就是要实现以上两点。本人正好在上学的时候用过微软 DEBUG CRT库检测过内存泄露，那就让我们一起再来看看其原理，也正是可以自己去实现的一种方法，要做到知其然知其所以然。

微软Debug CRT库检测C++内存泄露原理？

我们先来解决上述的两个问题。

问题一: 如何获取函数调用栈？

那么你首先要知道什么时候申请了内存？在C++中也就关键字new或者函数malloc，等等。那如何感知到呢？我们知道hook大致可以理解为就是改变原有的函数调用地址，改为你自己实现的函数。是不是有点类似于python中的装饰器了，在自定义的函数内部实现一些逻辑。不过本文要讲的不是hook，而是宏替换。以malloc为例，我们是不是可以通过宏定义，将malloc更改为my_malloc，然后在my_malloc中记录这次内存申请的信息。然后记录的信息要包括:

1. 申请的内存信息，比如申请的内存状态
2. 申请内存时候函数调用栈，一般来说可以通过StackWalk获取。不过本文讲解的微软DBUG的CRT库采用的是另外的方式，记录内存申请时候文件名和行号等信息。这样虽然没有函数调用栈精确，但是也基本可以用于定位问题了。

在Visual Studio (本文示例采用Visual Studio 2017)中，选择工程的默认的Debug模式，并且工程配置宏定义_CRTDBG_MAP_ALLOC, 此时将宏定义替换malloc为_malloc_dbg。注意看新的函数会传入文件名字__FILE__和所在行__LINE__

#define malloc(s) _malloc_dbg(s, _NORMAL_BLOCK, __FILE__, __LINE__)

那么malloc做的事情和_malloc_dbg有什么区别呢? 在Release版本中malloc底层其实就直接调用HeapAlloc申请内存(VS2017中)。而_malloc_dbg会申请额外的空间用来做调试用。如下图所示: 在_malloc_dbg中在实际要用的内存UserPtr前面还加了一段_CrtMemBlockHeader用于记录内存申请的相关信息，而No Main's Land部分为一个4个字节填充了0xFDFDFDFD，主要用来校验内存是否溢出或者破坏，这个不是本文的重点。接下来看看_CrtMemBlockHeader是如何记录调用相关的信息的呢? 我们看下它的结构便一目了然。其是一个双向链表的节点，有前后指针，还有文件名,行号等。

struct _CrtMemBlockHeader
{
    _CrtMemBlockHeader* _block_header_next;
    _CrtMemBlockHeader* _block_header_prev;
    char const*         _file_name;
    int                 _line_number;

    int                 _block_use;
    size_t              _data_size;

    long                _request_number;
    unsigned char       _gap[no_mans_land_size];

    // Followed by:
    // unsigned char    _data[_data_size];
    // unsigned char    _another_gap[no_mans_land_size];
};

那么当申请了内存后，这些内存的关系是如何的呢，如下图:

那通过以上方法我们便可以对每一个内存申请做记录了，而这个记录则存储在全局的链表中__acrt_first_block。

那么内存释放的时候，是如何进行释放的呢？同样的free也会通过宏替换为_free_dbg，这里在进行内存释放的时候，会根据UserPtr寻找到对应的_CrtMemBlockHeader, 也就知道了链表节点的位置，双向链表，也便于我们删除节点。

看到这里可能有同学会发现了，那还有C++的关键字new和delete呢。首先我们要知道new是C++的关键字，对于有构造函数的类一般做了以下两个事情:

1. 申请对象所需的内存空间。而这个时候内部其实调用的是函数operator new或者operator new[]
2. 调用对象的构造函数

而在微软crt中也有对new记录文件名和行号的实现。

    void* __CRTDECL operator new(
        size_t const size,
        int const    block_use,
        char const*  file_name,
        int const    line_number
        )

本人没有找到哪个头文件直接定义了宏替换，那么我们可以自己写一个宏进行替换如下:

#define new new(_NORMAL_BLOCK, __FILE__, __LINE__) 

那么不难理解其他的内存操作函数如何去做替换了吧。

问题二: 对比不同时间点的内存分配情况

那么我们如何去对比呢？我先写了一个样例程序:

#define _CRTDBG_MAP_ALLOC
#include <iostream>
#include <crtdbg.h>
#define new   new(_NORMAL_BLOCK, __FILE__, __LINE__) 
int main()
{
 //_CRTDBG_REPORT_FLAG:表示获取当前的标示位
    //_CRTDBG_LEAK_CHECK_DF:表示检测内存泄露
 _CrtSetDbgFlag(_CrtSetDbgFlag(_CRTDBG_REPORT_FLAG) | _CRTDBG_LEAK_CHECK_DF);
 int iSize = 100;
 char * pStr = new char [iSize];
 pStr = (char*)malloc(iSize);
 strcpy_s(pStr, iSize, "Memory Leak!");
 _CrtDumpMemoryLeaks();
 return 0;
}

因为这个是一个简单的样例程序，但是足以说明是如何检测的。

1. 一种方式是自己在程序中主动打印出来可能泄露的内存。这个时候其实就是遍历上述的双向链表，查看正在使用的内存，并将其打印到Visual Studio的output窗口中。
2. 另一种方式就是设置_CRTDBG_LEAK_CHECK_DF这个标记位，则在main函数退出后，在Debug的CRT库中主动调用了_CrtDumpMemoryLeaks。其实和方法1原理一样，只是时间点不同。

检测到的结果打印在Visual Studio的Output窗口中，如下图所示。

总结

简单总结下，微软Debug CRT库的实现，完全可以在项目中自己实现。就是通过在申请的内存头部记录当前分配内存的相关信息，比如文件名和行号，并且通过双向链表将所有申请的节点串起来。然后在合适的时间点（比如感知到内存泄露的情况下）打印出可能的内存泄露的内存关联的信息。这种做法简单，但只针对小型的项目，适合采用这种方法，而且对于第三方库的内存泄露无法进行检测。本文旨在通过分析微软Debug CRT库的实现的检测内存泄露的方式，从而阐述自我实现简易C++内存泄露检测的思想。若平时分析内存泄露问题，建议还是采用本文开头提到的几篇文章的方法。

参考

• Walking the callstack：https://www.codeproject.com/Articles/11132/Walking-the-callstack-2
• C++不用工具，如何检测内存泄漏？：https://www.zhihu.com/question/29859828
• new vs operator new in C++：*https://www.geeksforgeeks.org/new-vs-operator-new-in-cpp/

- EOF -

推荐阅读  点击标题可跳转

关注『CPP开发者』

看精选C++技术文章 . 加C++开发者专属圈子

点赞和在看就是最大的支持❤️