使用_CrtSetDbgFlag检测内存泄露

一、

介绍：

动态分配、回收内存是C/C++编程语言一个最强的特点，但是中国哲学家孙（Sun Tzu，我不知道是谁？那位知道？）指出，最强的同时也是最弱的。这句话对C/C++应用来说非常正确，在内存处理出错的地方通常就是BUGS产生的地方。一个最敏感和难检测的BUG就是内存泄漏-没有把前边分配的内存成功释放，一个小的内存泄漏可能不需要太注意，但是程序泄漏大块内存，或者渐增式的泄漏内存可能引起的现象是：先是性能低下，再就是引起复杂的内存耗尽错误。最坏的是，一个内存泄漏程序可能用完了如此多的内存以至于引起其他的程序出错，留给用户的是不能知道错误到底来自哪里。另外，一个看上去无害的内存泄漏可能是另一个问题的先兆。幸运的是VC++DEBUGER和CRT库提供了一组有效的检测和定位内存泄漏的工具。本文描述如何使用这些工具有效和系统的排除内存泄漏。

_CrtDumpMemoryLeaks()就是检测从程序开始到执行该函数进程的堆使用情况，通过使用_CrtDumpMemoryLeaks()我们可以进行简单的内存泄露检测。

启用内存泄露检测：

检测内存泄漏的主要工具是调试器和 C 运行时库 (CRT) 调试堆函数。若要启用调试堆函数，请在程序中包括以下语句：

[cpp]  view plain copy

1. #define _CRTDBG_MAP_ALLOC  
2.   
3. #include <stdlib.h>  
4.   
5. #include <crtdbg.h>  

 

注意：

#include必须按照以上所示顺序。如果更改了顺序，所使用的函数可能无法使用。

通过包括crtdbg.h，将 malloc 和 free 函数映射到其“Debug”版本 _malloc_dbg 和 _free_dbg，这些函数将跟踪内存分配和释放。此映射只在调试版本（在其中定义了_DEBUG）中发生。发布版本使用普通的malloc 和 free 函数。

注意：在编译时要把工程属性中的“代码生成”中的“运行时库”改为：“多线程调试（/MTd)”，否则编译报以下错:

[plain]  view plain copy

1. 1>正在链接...  
2. 1>LINK : 没有找到 C:\Users\Chenyj\Desktop\test\Debug\test.exe 或上一个增量链接没有生成它；正在执行完全链接  
3. 1>main.obj : error LNK2019: 无法解析的外部符号 "void * __cdecl operator new(unsigned int,int,char const *,int)" (??2@YAPAXIHPBDH@Z)，该符号在函数 "void * __cdecl operator new(unsigned int)" (??2@YAPAXI@Z) 中被引用  
4. 1>main.obj : error LNK2019: 无法解析的外部符号 __CrtDumpMemoryLeaks，该符号在函数 _main 中被引用  
5. 1>main.obj : error LNK2019: 无法解析的外部符号 "void * __cdecl operator new[](unsigned int,int,char const *,int)" (??_U@YAPAXIHPBDH@Z)，该符号在函数 _main 中被引用  

 

#define语句将 CRT 堆函数的基版本映射到对应的“Debug”版本。并非绝对需要该语句，但如果没有该语句，内存泄漏转储包含的有用信息将较少。

在添加了上面所示语句之后，可以通过在程序中包括以下语句来转储内存泄漏信息：

_CrtDumpMemoryLeaks()

使用示范：

[cpp]  view plain copy

1. #define _CRTDBG_MAP_ALLOC  
2.   
3.   
4. #include <stdlib.h>  
5. #include <crtdbg.h>  
6.   
7.   
8.   
9. #define new  new(_CLIENT_BLOCK, __FILE__, __LINE__)  
10.   
11.   
12. int main()  
13. {  
14.   
15.     int* leak = new int[10];  
16.   
17.     _CrtDumpMemoryLeaks();  
18.   
19.     system("pause");  
20.     return 0;  
21.   
22. }  

这个示范程序与前面讲的多了一个宏定义：

#define new new( _CLIENT_BLOCK, __FILE__, __LINE__)

原因稍后再说，我们先看看程序运行（提醒：不要按Ctrl+F5，按F5）后的结果。

程序调试后在“输出”窗口输出如下：

[plain]  view plain copy

1. Detected memory leaks!  
2. Dumping objects ->  
3. .\main.cpp(15) : {56} client block at 0x005F0F90, subtype 0, 40 bytes long.  
4.  Data: <                > CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD   
5. Object dump complete.  

 

“输出”很明显的告诉了你在test.cpp文件的第57行分配了一个40字节的内存而没有释放。在“输出”窗口中选择包含文件名和行号的行，然后按 F4 键即可进入到源文件中分配内存的行。

现在我们再来看看如果不加之前那个new的宏定义会出现怎么样的结果。

程序调试后在“输出”窗口输出如下：

Detected memory leaks!

Dumping objects ->

{48} normal block at 0x00392BB0, 40 bytes long.

Data: <> CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD

Object dump complete.

与之前的对比，这次的输出并没有告诉我们这个内存泄露具体是在哪个位置引起的。另外如果没定义

#define_CRTDBG_MAP_ALLOC

也会引起同样的结果。

 二、

[cpp]  view plain copy

1. //on_ff 为true 打印内存泄漏, 为false则不打印  
2. void detect_memory_leaks( bool on_off )  
3. {  
4.     int flags = _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG);  
5.     if(!on_off)  
6.         flags &= ~_CRTDBG_LEAK_CHECK_DF;  
7.     else {  
8.         flags |= _CRTDBG_LEAK_CHECK_DF;  
9.         _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);  
10.         _CrtSetReportFile(_CRT_WARN, _CRTDBG_FILE_STDOUT);  
11.     }  
12.     _CrtSetDbgFlag( flags );  
13. }  

 

这个函数在主程序的入口处调用，在程序正常退出时会打印出内存泄漏

 

测试程序

[cpp]  view plain copy

1. int _tmain(int argc, _TCHAR* argv[])  
2. {  
3.     detect_memory_leaks(true);  
4.     char *p = new char[20];  
5.     return 0;  
6. }  

 

控制台打印信息：

Detected memory leaks!

Dumping objects ->

{114} normal block at 0x0039BC90, 20 bytes long.

 Data: <                > CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD

Object dump complete.

请按任意键继续. . .

 

 

测试环境：win32 xp  vc2008