使用Microsoft Visual C++来检测和隔离内存泄漏
作者: Edward Wright
日期: 2000年05月24日
简介
具有动态的分配和释放内存的能力是C/C++程序语言的重要特色之一，但是中国的哲人孙子指出，最强有力的也是最脆弱的。对C/C++应用程序来说这当然是正确的，内存管理错误通常是bug起源之一。非常微妙且难于检测的bug之一就是内存泄漏——不能正确地去分配已经分配了的内存。一个仅仅发生一次的轻微内存泄漏不可能引起注意，但是泄漏了大量内存或者日益增多的泄漏的程序可能表现出征兆，从可怜的（和慢慢地减少）性能到内存不足而完全失灵。更坏的是，一个有泄漏的程序可能占用很多的内存以至于导致另一个程序失灵，留给用户的只是对问题的一无所知。此外，一个严重的内存泄漏甚至可能是其他问题的征兆。
幸运的是，Visual C++ debugger 和 CRT库提供给你一系列有效的检测和鉴定内存泄漏的工具。这片文章阐述了如何使用这些工具去有效并系统的隔离内存泄漏。
设置内存泄漏检测
检测内存泄漏的基本工具是调试器和CRT调试堆函数。为了使用调试堆函数，在你的程序中你必须含有下面的说明：
#define _CRTDBG_MAP_ALLOC
#include <stdlib.h>
#include <crtdbg.h>
#include说明必须按顺序说明。如果你改变了顺序，你所用的函数可能不能正常工作。包含crtdbg.h的_malloc_dbg和 _free_dbg将 malloc和free函数映射到测试版中，它可以跟踪内存的分配和释放。这种映射仅仅在一个测试体系中发生(也就是说，仅仅当_DEBUG被定义的时候)。释放的体系使用通常的malloc和 free功能。
#define说明映射CRT堆函数的低级版本到相应的测试版本。这个说明是不需要的，但是没有它，内存泄漏处含有的只是没有多大用处的信息。
一旦你已经增加了刚才的说明，你能够通过在你的程序中包含下面的说明来释放内存信息：
_CrtDumpMemoryLeaks();
当你在调试情况下运行你的程序时，在输出窗口的Debug 标签处_CrtDumpMemoryLeaks表现出内存泄漏的信息。内存泄漏信息类似下面这样：
Detected memory leaks!
Dumping objects ->
C:\PROGRAM FILES\VISUAL STUDIO\MyProjects\leaktest\leaktest.cpp(20) : {18} normal block at 0x00780E80, 64 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说明，内存漏洞堆存处类似下面这样：
Detected memory leaks!
Dumping objects ->
{18} normal block at 0x00780E80, 64 bytes long.
Data: < > CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD
Object dump complete.
像你所知道的，当_CRTDBG_MAP_ALLOC被定义时，_CrtDumpMemoryLeaks给了你更多的有用信息。如果_CRTDBG_MAP_ALLOC没有被定义，那么将向你如下显示：
内存分配数值（花括号内）
模块的类型（normal、client或者CRT）
以十六进制格式定位的内存
以字节计模块的大小
第一个十六字节的内容（也可以用十六进制）
当定义了_CRTDBG_MAP_ALLOC的时候，显示的内容也向你展现了出现泄漏内存所分配地方的文件。在文件名之后括号内的数字（20，以此为例）是文件内的行数值。如果你双击包含行数值和文件名的输出行，
C:\PROGRAM FILES\VISUAL STUDIO\MyProjects\leaktest\leaktest.cpp(20) : {18} normal block at 0x00780E80, 64 bytes long.
指针将会跳到源文件中内存被分配地方的行（在上面的情况下，leaktest.cpp的行号为20）。选择输出行并按F4将有同样的效果。
使用_CrtSetDbgFlag
如果你的程序总是在同一各地方存在，那么调用_CrtDumpMemoryLeaks时非常容易的。但是，如果你的程序需要在多个位置退出该怎么办？在每一个可能的出口处如果不调用_CrtDumpMemoryLeaks，你可在你的程序开始处包含下面的调用：
_CrtSetDbgFlag( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF);
当你的程序退出时，这个说明自动地调用_CrtDumpMemoryLeaks。你必须设置两个位域，_CRTDBG_ALLOC_MEM_DF和 _CRTDBG_LEAK_CHECK_DF，像以前说明的一样。
翻译内存模块的类型
像早期声明的一样，内存泄漏信息鉴别泄漏内存的每一个模块作为一个普通的模块、一个客户模块或者一个CRT模块。实际上，普通的模块和客户模块是你可能留心的唯一类型。
一个普通模块(normal block)是由你的程序分配的普通内存。
一个客户模块(client block)是一种特殊的内存模块，它由于需要一个析构函数的对象而被Microsoft Foundation Classes (MFC)所使用。MFC new操作子建立一个普通模块或者一个客户模块，来适合被创建的模块。
一个CTR模块是由CRT库提供自己使用而分配的内存模块。CRT库对这些模块来管理自己的去分配，因此你不可能在内存泄漏报告中注意到这些，除非有些地方有严重的错误（例如，CRT库崩溃）。
在内存泄漏信息中有两种你从来没有见过的模块类型：
空闲模块（free block）是一种被释放的内存模块
Ignore block是你已经特殊标记过以至于在内存泄漏报告中不会出现的模块。
设置CRT报告样式
像以前描写的一样，按默认方式，_CrtDumpMemoryLeaks倾卸内存泄漏信息到输出窗口的Debug窗格。你可以运用_CrtSetReportMode重新设置它到堆存处，到另一个位置。如果你使用一个库，它可能重新设置输出到另一个位置。在这种情况下，你能够利用下面的说明来设置输出位置回到输出窗口：
_CrtSetReportMode( _CRT_ERROR, _CRTDBG_MODE_DEBUG );
关于使用_CrtSetReportMode去发送输出信息到另一个位置，要看Visual C++文件的_CrtSetReportMode节。
在内存分配数目处设置一个断点
在内存泄漏报告中的文件名和行号可告诉你泄漏的内存在那里被分配，但是了解内存在那里分配对于鉴定问题不总是充分的。在一个程序运行过程中，经常是一个分配将会被调用很多次，但是它可能在某次调用中泄漏内存。为了确定问题，你必须不但知道泄漏的内存在那里分配，还要知道泄漏发生的条件。对你来说，使它成为可能的那条信息是内存分配号。当那些被显示的时候，文件名和行号之后，这是在curly brace中出现的数值。例如，在下面的输出中，“18”是内存分配号。它的意思是泄漏的内存是你程序中内存分配的第十八个模块。
Detected memory leaks!
Dumping objects ->
C:\PROGRAM FILES\VISUAL STUDIO\MyProjects\leaktest\leaktest.cpp(20) : {18} normal block at 0x00780E80, 64 bytes long.
Data: < > CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD
Object dump complete.
CRT库计算在程序运行期间分配的所用内存模块，包括CRT自己分配的内存或者诸如MFC的其它模块。因此带有分配号n的一个对象是在你的程序中分配的第n个对象，但不可能是由代码分配的第n个对象。（在大部分情况下，它是不会的。）
你可以利用分配号在内存分配的地方设置一个断点。为了做这些，你可以距离你的程序开始很近处，设置一个位置断点。当你的程序在那一点暂停时，你能够从QuickWatch对话框或者Watch窗口设置这样一个位置断点。例如，在Watch窗口中，在Name栏键入下面的表达式：
_crtBreakAlloc
如果你正在用CRT库的多线程的dynamic-link library (DLL)版本，你必须含有上下文操作符，像这里说明的：
{,,msvcrtd.dll}_crtBreakAlloc
现在，按RETURN。调试器评估调用并且把结果放置在Value栏。如果你在内存分配过程中还没有设置任何断点，那么这个值是－1。使用你想中断处内存分配的分配数值来代替Value表中的值——例如，18 去中断早期在输出过程中展现的分配.
当你在你感兴趣的内存分配处设置断点之后，你能够继续调试。在与从前相同的条件下，运行程序时一定要小心，因而分配的顺序不会改变。当你的程序在一个特殊的内存分配点中断的时候，你能够查看Call Stack窗口和其他的测试信息来确定在此条件下内存的分配。如果需要的话，你可以继续从那一点执行程序，以至于了解对象到底发生了什么事，同时还可能确定为了没有正确地被去分配。（对对象设置一个数据断点是很有帮助的。）
虽然在调试器中设置内存分配断点通常更加容易，但是如果你喜欢的话，你可以在你的代码中设置它们。为了在你的代码中设置一个内存分配断点，可以增加这样一行（对于第十八个内存分配）：
_crtBreakAlloc = 18;
最为一个选择，你可以使用有相同效果的_CrtSetBreakAlloc函数。
_CrtSetBreakAlloc(18);
比较内存状态
定位内存泄漏的另一个方法就是在关键点对应用程序的内存状态做快照。CRT库提供了一个结构类型，_CrtMemState。你可以使用它来存储内存状态的一个快照。
_CrtMemState s1, s2, s3;
为了在特定点对内存状态进行快照，可以传递一个_CrtMemState结构到he _CrtMemCheckpoint函数。此函数用当时内存状态的一个快照来填充此结构：
_CrtMemCheckpoint( &s1 );
你可以通过传递此结构到_CrtMemDumpStatistics函数来倾卸_CrtMemState结构的任意点的内容：
_CrtMemDumpStatistics( &s3 );( &s1 );
此函数打印出类似于下面这样的一堆内存分配信息：
0 bytes in 0 Free Blocks.
0 bytes in 0 Normal Blocks.
3071 bytes in 16 CRT Blocks.
0 bytes in 0 Ignore Blocks.
0 bytes in 0 Client Blocks.
Largest number used: 3071 bytes.
Total allocations: 3764 bytes.
为了确定一个内存泄漏是否在一节代码中出现，你可以在此节前和此节后对内存状态作快照，然后用_CrtMemDifference比较两种状态：
_CrtMemCheckpoint( &s1 );
// memory allocations take place here
_CrtMemCheckpoint( &s2 );
if ( _CrtMemDifference( &s3, &s1, &s2) )
_CrtMemDumpStatistics( &s3 );
像名字暗示的一样，_CrtMemDifference比较两个内存状态（最先的两个参数）并且产生一个不同于这两个状态的结果（第三个参数）。在你的程序开始和结尾处的_CrtMemCheckpoint调用和使有_CrtMemDifference来比较结果为检测内存泄漏提供了另一种方法。如果一个泄漏被检测到，那么可以使用_CrtMemCheckpoint调用来分割你的程序并且使用二元binary search technique来定位泄漏。
