【C++】使用CRT 库检测内存泄漏

CRT 库检测内存泄漏

一、CRT 库简介
二、CRT 库的使用
- 1、启用内存泄漏检测
- 2、设置应用退出时显示内存泄漏报告
- 3、丰富内存泄漏报告
- 4、演示使用

内存泄漏是 C/C++ 应用程序中最微妙、最难以发现的 bug，存泄漏是由于之前分配的内存未能正确解除分配而导致的。最开始的少量内存泄漏可能没被发现，但随时间推移，会导致各种问题，从性能变差到程序由于内存不足而崩溃。内存泄漏的应用会耗尽全部可用内存，导致其它程序崩溃，从而让人难以分辨是哪个程序引发问题。即使无害的内存泄漏也可能表明存在其他应纠正的问题。

一、CRT 库简介

内存泄漏的检测工具有很多，大多数的内存泄漏检测工具都要我们手动安装才能使用，但是CRT(C 运行时库)库，是Visual Studio 自带的，所以我们可以开箱即用，无需安装其他的内存泄漏检测工具。

所以下面我们就来一起学习一下如何使用CRT库检测内存泄漏：

CRT检测内存泄漏原理：内存分配要通过CRT在运行时实现，只要在分配内存和释放内存时分别做好记录，程序结束时对比分配内存和释放内存的记录就可以确定是不是有内存泄漏。

二、CRT 库的使用

1、启用内存泄漏检测

检测内存泄漏的主要工具是「C/C++ 调试程序」和「CRT 调试堆函数」，若要启用调试堆的所有函数，在 C++ 程序中，按以下顺序包含以下语句：

#define _CRTDBG_MAP_ALLOC
#include <stdlib.h>
#include <crtdbg.h>

#define 语句将 CRT 堆函数的基础版本映射到对应的调试版本，如果省略 #define 语句，内存泄漏转储包含的有用信息将有所简化。
#include <crtdbg.h> 会将 malloc 和 free 函数映射到其调试版本 _malloc_dbg 和_free_dbg，它们跟踪内存分配和解除分配。此映射只在包含 _DEBUG的调试版本中发生。发布版本则会使用普通的 malloc 和 free 函数。

2、设置应用退出时显示内存泄漏报告

在使用了上面的语句启用调试堆函数后，需要在应用出口点之前放置 _CrtDumpMemoryLeaks，从而在应用退出时显示内存泄漏报告。

_CrtDumpMemoryLeaks();

如果你的应用程序有多个出口点，每一个出口点都要设置这个函数也太复杂了，所以我们可以在应用程序开头调用 _CrtSetDbgFlag并传入一些参数来帮助我们简化这个操作。

_CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );

_CRTDBG_ALLOC_MEM_DF
- 含义：启用内存分配调试。
- 作用：当启用该标志时，CRT 会在每次内存分配时记录调试信息，包括分配的文件名和行号。这些信息在内存泄漏报告中非常有用，可以帮助你确定内存泄漏发生的位置。
_CRTDBG_LEAK_CHECK_DF
- 含义：启用内存泄漏检测。
- 作用：当启用该标志时，程序退出时 CRT 会自动检查未释放的内存，并生成内存泄漏报告。这可以帮助你发现和修复内存泄漏问题。
_CRTDBG_CHECK_ALWAYS_DF
- 作用：当设置该标志时，CRT会在每次分配或释放内存时检查整个堆的完整性。这意味着每次内存操作（如 malloc、free、new、delete）都会触发堆完整性检查。通过这种操作能检测一些内存越界的问题。当然也可以手动调用_CrtCheckMemory() 函数进行立即检测。

3、丰富内存泄漏报告

为了丰富我们的内存泄漏报告，我们可以重定义 new malloc 用以捕获文件名和行号

// 重定义 new malloc 以捕获文件名和行号
#ifdef _DEBUG
#define new   new(_NORMAL_BLOCK, __FILE__, __LINE__)
#define   malloc(s)  _malloc_dbg(s, _NORMAL_BLOCK, __FILE__, __LINE__)
#endif

4、演示使用

我们通过下面的一个完整的示例，展示如何使用 CRT进行内存泄漏检测：

#define _CRTDBG_MAP_ALLOC
#include <stdlib.h>
#include <crtdbg.h>
#include <iostream>

// 重定义 new malloc 以捕获文件名和行号
#ifdef _DEBUG
#define new   new(_NORMAL_BLOCK, __FILE__, __LINE__)
#define   malloc(s)  _malloc_dbg(s, _NORMAL_BLOCK, __FILE__, __LINE__)
#endif

void leakMemory() {
    int* p = new int[10]; // 这是一个内存泄漏示例
}

int main() 
{
    // 启用内存分配调试和内存泄漏检测
    _CrtSetDbgFlag(_CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF | _CRTDBG_CHECK_ALWAYS_DF);

    leakMemory();

    std::cout << "Program finished." << std::endl;
    
    return 0;
}