檢測(cè)C++中的內(nèi)存泄漏
對(duì)于C/C++程序員來(lái)說(shuō)，內(nèi)存泄漏是一個(gè)常見(jiàn)的也是令人頭疼的問(wèn)題。一般我們常說(shuō)的內(nèi)存泄漏是指對(duì)內(nèi)存的泄漏對(duì)內(nèi)存是指程序從堆中分配的，大小任意的，使用完后必須顯示釋放的內(nèi)存。
首先我們需要知道程序有沒(méi)有內(nèi)存泄露，然后定位到底是哪行代碼出現(xiàn)內(nèi)存泄露了，這樣才能將其修復(fù)。
最簡(jiǎn)單的方法當(dāng)然是借助于專(zhuān)業(yè)的檢測(cè)工具，比較有名如BoundsCheck,功能非常強(qiáng)大，相信做C++開(kāi)發(fā)的人都離不開(kāi)它。此外就是不使用任何工具，而是自己來(lái)實(shí)現(xiàn)對(duì)內(nèi)存泄露的監(jiān)控，分如下兩種情況：
一. 在 MFC 中檢測(cè)內(nèi)存泄漏
假如是用MFC的程序的話，很簡(jiǎn)單。默認(rèn)的就有內(nèi)存泄露檢測(cè)的功能。
我們用VS2005生成了一個(gè)MFC的對(duì)話框的程序,發(fā)現(xiàn)他可以自動(dòng)的檢測(cè)內(nèi)存泄露.不用我們做任何特殊的操作. 仔細(xì)觀察,發(fā)現(xiàn)在每個(gè)CPP文件中,都有下面的代碼:
- #ifdef _DEBUG
- #define new DEBUG_NEW
- #endif
DEBUG_NEW 這個(gè)宏定義在afx.h文件中，就是它幫助我們定位內(nèi)存泄漏。
在含有以上代碼的cpp文件中分配內(nèi)存后假如沒(méi)有刪除，那么停止程序的時(shí)候，VisualStudio的Output窗口就會(huì)顯示如下的信息了：
- Detected memory leaks!
- Dumping objects ->
- d:\code\mfctest\mfctest.cpp(80) : {157} normal block at 0x003AF170, 4 bytes long.
- Data: < > 00 00 00 00
- Object dump complete.
在Output窗口雙擊粗體字那一行，那么IDE就會(huì)打開(kāi)該文件，定位到該行，很容易看出是哪出現(xiàn)了內(nèi)存泄露。
#p#
二．檢測(cè)純C++的程序內(nèi)存泄露
我試了下用VisualStudio建立的Win32 Console Application和Win32 Project項(xiàng)目，結(jié)果都不能檢測(cè)出內(nèi)存泄露。
下面一步一步來(lái)把程序的內(nèi)存泄露檢測(cè)的機(jī)制建立起來(lái)。
首先，我們需要知道C運(yùn)行庫(kù)的Debug版本提供了許多檢測(cè)功能，使得我們更容易的Debug程序。在MSDN中有專(zhuān)門(mén)的章節(jié)講這個(gè)，叫做Debug Routines，建議大家先看看里面的內(nèi)容吧。
我們會(huì)用到里面很重要的幾個(gè)函數(shù)。其中最重要的是 _CrtDumpMemoryLeaks;自己看MSDN里的幫助吧。使用這個(gè)函數(shù)，需要包含頭文件crtdbg.h
該函數(shù)只在Debug版本才有用，當(dāng)在調(diào)試器下運(yùn)行程序時(shí)，_CrtDumpMemoryLeaks 將在“Output(輸出)”窗口中顯示內(nèi)存泄漏信息.寫(xiě)段代碼試驗(yàn)一下吧，如下：
檢測(cè)內(nèi)存泄露版本一：
- #include "stdafx.h"
- #include <crtdbg.h>
- int _tmain(int argc, _TCHAR* argv[])
- {
- int* p = new int;
- _CrtDumpMemoryLeaks;
- return 0;
- }
運(yùn)行后，在Output（輸出）窗口，顯示了如下的信息：
- Detected memory leaks!
- Dumping objects ->
- {112} normal block at 0x003AA770, 4 bytes long.
- Data: < > 00 00 00 00
- Object dump complete.
但是這個(gè)只是告訴我們程序有內(nèi)存泄露，到底在哪泄露了一眼看不出來(lái)啊。
看我們的檢測(cè)內(nèi)存泄露版本二：
- #include "stdafx.h"
- #ifdef _DEBUG
- #define DEBUG_CLIENTBLOCK new( _CLIENT_BLOCK, __FILE__,__LINE__)
- #else
- #define DEBUG_CLIENTBLOCK
- #endif
- #define _CRTDBG_MAP_ALLOC
- #include <crtdbg.h>
- #ifdef _DEBUG
- #define new DEBUG_CLIENTBLOCK
- #endif
- int _tmain(int argc, _TCHAR* argv[])
- {
- int* p = new int;
- _CrtDumpMemoryLeaks;
- return 0;
- }
該程序定義了幾個(gè)宏，通過(guò)宏將Debug版本下的new給替換了，新的new記錄下了調(diào)用new時(shí)的文件名和代碼行.運(yùn)行后，可以看到如下的結(jié)果：
- Detected memory leaks!
- Dumping objects ->
- d:\code\consoletest\consoletest.cpp(21) : {112} client block at 0x003A38B0, subtype 0, 4 bytes long.
- Data: < > 00 00 00 00
- Object dump complete.
呵呵，已經(jīng)和MFC程序的效果一樣了，但是等一等?？聪氯缦碌拇a吧：
- int _tmain(int argc, _TCHAR* argv[])
- {
- int* p = new int;
- _CrtDumpMemoryLeaks;
- delete p;
- return 0;
- }
運(yùn)行后可以發(fā)現(xiàn)我們刪除了指針，但是它仍然報(bào)內(nèi)存泄露。所以可以想象，每調(diào)用一次new，程序內(nèi)部都會(huì)將該調(diào)用記錄下來(lái)，類(lèi)似于有個(gè)數(shù)組記錄，假如delete了，那么就將其從數(shù)組中刪除，而_CrtDumpMemoryLeaks就是把這個(gè)數(shù)組當(dāng)前的狀態(tài)打印出來(lái)。
所以除了在必要的時(shí)候Dump出內(nèi)存信息外，最重要的就是在程序退出的時(shí)候需要掉用一次_CrtDumpMemoryLeaks;
假如程序有不止一個(gè)出口，那么我們就需要在多個(gè)地方都調(diào)用該函數(shù)。
更進(jìn)一步，假如程序在類(lèi)的析構(gòu)函數(shù)里刪除指針，怎么辦？例如：
- #include "stdafx.h"
- #ifdef _DEBUG
- #define DEBUG_CLIENTBLOCK new( _CLIENT_BLOCK, __FILE__, __LINE__)
- #else
- #define DEBUG_CLIENTBLOCK
- #endif
- #define _CRTDBG_MAP_ALLOC
- #include <crtdbg.h>
- #ifdef _DEBUG
- #define new DEBUG_CLIENTBLOCK
- #endif
- class Test
- {
- public:
- Test { _p = new int; }
- ~Test { delete _p; }
- int* _p;
- };
- int _tmain(int argc, _TCHAR* argv[])
- {
- int* p = new int;
- delete p;
- Test t;
- _CrtDumpMemoryLeaks;
- return 0;
- }
可以看到析構(gòu)函數(shù)在程序退出的時(shí)候才調(diào)用，明明沒(méi)有內(nèi)存泄露，但是這樣的寫(xiě)法還是報(bào)了。
#p#
如何改進(jìn)呢,看檢測(cè)內(nèi)存泄露版本三：
- #include "stdafx.h"
- #ifdef _DEBUG
- #define DEBUG_CLIENTBLOCK new( _CLIENT_BLOCK, __FILE__, __LINE__)
- #else
- #define DEBUG_CLIENTBLOCK
- #endif
- #define _CRTDBG_MAP_ALLOC
- #include <crtdbg.h>
- #ifdef _DEBUG
- #define new DEBUG_CLIENTBLOCK
- #endif
- class Test
- {
- public:
- Test { _p = new int; }
- ~Test { delete _p; }
- int* _p;
- };
- int _tmain(int argc, _TCHAR* argv[])
- {
- _CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
- int* p = new int;
- delete p;
- Test t;
- return 0;
- }
- _CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
該語(yǔ)句在程序退出時(shí)自動(dòng)調(diào)用 _CrtDumpMemoryLeaks。必須同時(shí)設(shè)置 _CRTDBG_ALLOC_MEM_DF 和 _CRTDBG_LEAK_CHECK_DF.
這樣，該版本已經(jīng)達(dá)到了MFC一樣的效果了,但是我覺(jué)得光這樣還不夠，因?yàn)槲覀冎皇窃贠utput窗口中輸出信息，對(duì)開(kāi)發(fā)人員的提醒還不明顯，經(jīng)常會(huì)被遺漏，而且很多人就算發(fā)現(xiàn)了內(nèi)存泄露，但是不好修復(fù)，不會(huì)嚴(yán)重影響到程序外在表現(xiàn)，都不會(huì)修復(fù)。怎么樣能讓開(kāi)發(fā)人員主動(dòng)的修復(fù)內(nèi)存泄露的問(wèn)題呢？記得曾經(jīng)和人配合寫(xiě)程序，我的函數(shù)參數(shù)有要求，不能為空，但是別人老是傳空值，沒(méi)辦法了，只好在函數(shù)開(kāi)始驗(yàn)證函數(shù)參數(shù)，給他assert住，這樣程序運(yùn)行時(shí)老是不停的彈出assert，調(diào)試程序那個(gè)煩壓，最后其他程序員煩了，就把這個(gè)問(wèn)題給改好了，輸入?yún)?shù)就正確了。所以我覺(jué)得咱要讓程序員主動(dòng)去做一件事，首先要讓他覺(jué)得做這個(gè)事是能減輕自己負(fù)擔(dān)，讓自己工作輕松的。呵呵，那咱們也這樣，當(dāng)程序退出時(shí)，檢測(cè)到內(nèi)存泄露就讓程序提示出來(lái)。
看檢測(cè)內(nèi)存泄露版本四：
- #include "stdafx.h"
- #include <assert.h>
- #ifdef _DEBUG
- #define DEBUG_CLIENTBLOCK new( _CLIENT_BLOCK, __FILE__, __LINE__)
- #else
- #define DEBUG_CLIENTBLOCK
- #endif
- #define _CRTDBG_MAP_ALLOC
- #include <crtdbg.h>
- #ifdef _DEBUG
- #define new DEBUG_CLIENTBLOCK
- #endif
- void Exit
- {
- int i = _CrtDumpMemoryLeaks;
- assert( i == 0);
- }
- int _tmain(int argc, _TCHAR* argv[])
- {
- atexit(Exit);
- int* p = new int;
- return 0;
- }
該版本會(huì)在程序退出時(shí)檢查內(nèi)存泄露，假如存在就會(huì)彈出提示對(duì)話框.
atexit(Exit);設(shè)置了在程序退出時(shí)執(zhí)行Exit函數(shù)。Exit函數(shù)中,假如存在內(nèi)存泄露，_CrtDumpMemoryLeaks會(huì)返回非0值，就會(huì)被assert住了。
到這個(gè)版本已經(jīng)達(dá)到可以使用的程度了。但是我們還可以做些改進(jìn)，因?yàn)檎嬉獪?zhǔn)確的檢測(cè)到代碼中所有的內(nèi)存泄露，需要把代碼中的#define……拷貝到所有使用new的文件中。不可能每個(gè)文件都拷貝這么多代碼，所以我們可以將他提取出來(lái)，放在一個(gè)文件中，比如我是放在KDetectMemoryLeak.h中，該文件內(nèi)容如下：
- #pragma once
- #ifdef _DEBUG
- #define DEBUG_CLIENTBLOCK new( _CLIENT_BLOCK, __FILE__, __LINE__)
- #else
- #define DEBUG_CLIENTBLOCK
- #endif
- #define _CRTDBG_MAP_ALLOC
- #include <stdlib.h>
- #include <crtdbg.h>
- #ifdef _DEBUG
- #define new DEBUG_CLIENTBLOCK
- #endif
然后將KDetectMemoryLeak.h包含在項(xiàng)目的通用文件中，例如用VS建的項(xiàng)目就將其包含在stdafx.h中?；蛘呶易约航ǖ囊粋€(gè)Common.h文件中，該文件包含一些通用的，基本所有文件都會(huì)用到的代碼。
【編輯推薦】
