VC內存洩露檢查工具:VisualLeakDetector

　　初識VisualLeakDetector靈活自由是C/C++語言的一大特色，而這也為C/C++程序員出了一個難題。當程序越來越復雜時，內存的管理也會變得越加復雜，稍有不慎就會出現內存問題。內存洩漏是最常見的內存問題之一。內存洩漏如果不是很嚴重，在短時間內對程序不會有太大的影響，這也使得內存洩漏問題有很強的隱蔽性，不容易被發現。然而不管內存洩漏多麼輕微，當程序長時間運行時，其破壞力是驚人的，從性能下降到內存耗盡，甚至會影響到其他程序的正常運行。另外內存問題的一個共同特點是，內存問題本身並不會有很明顯的現象，當有異常現象出現時已時過境遷，其現場已非出現問題時的現場了，這給調試內存問題帶來了很大的難度。

　　VisualLeakDetector是一款用於VisualC++的免費的內存洩露檢測工具。可以在VisualLeakDetector1.9-VC內存洩露檢查工具下載到。相比較其它的內存洩露檢測工具，它在檢測到內存洩漏的同時，還具有如下特點：

　　1、可以得到內存洩漏點的調用堆棧，如果可以的話，還可以得到其所在文件及行號;

　　2、可以得到洩露內存的完整數據;

　　3、可以設置內存洩露報告的級別;

　　4、它是一個已經打包的lib，使用時無須編譯它的源代碼。而對於使用者自己的代碼，也只需要做很小的改動;

　　5、他的源代碼使用GNU許可發布，並有詳盡的文檔及注釋。對於想深入了解堆內存管理的讀者，是一個不錯的選擇。可見，從使用角度來講，VisualLeakDetector簡單易用，對於使用者自己的代碼，唯一的修改是#includeVisualLeakDetector的頭文件後正常運行自己的程序，就可以發現內存問題。從研究的角度來講，如果深入VisualLeakDetector源代碼，可以學習到堆內存分配與釋放的原理、內存洩漏檢測的原理及內存操作的常用技巧等。本文首先將介紹VisualLeakDetector的使用方法與步驟，然後再和讀者一起初步的研究 VisualLeakDetector的源代碼，去了解VisualLeakDetector的工作原理。使用 VisualLeakDetector(1.0)下面讓我們來介紹如何使用這個小巧的工具。首先從網站上下載zip包，解壓之後得到 vld.h,vldapi.h,vld.lib,vldmt.lib,vldmtdll.lib,dbghelp.dll等文件。將.h文件拷貝到 VisualC++的默認include目錄下，將.lib文件拷貝到VisualC++的默認lib目錄下，便安裝完成了。因為版本問題，如果使用 windows2000或者以前的版本，需要將dbghelp.dll拷貝到你的程序的運行目錄下，或其他可以引用到的目錄。

　　接下來需要將其加入到自己的代碼中。方法很簡單，只要在包含入口函數的.cpp文件中包含vld.h就可以。如果這個cpp文件包含了 stdafx.h，則將包含vld.h的語句放在stdafx.h的包含語句之後，否則放在最前面。如下是一個示例程序：#includevoidmain(){…}接下來讓我們來演示如何使用VisualLeakDetector檢測內存洩漏。下面是一個簡單的程序，用new分配了一個int大小的堆內存，並沒有釋放。其申請的內存地址用printf輸出到屏幕上。#include#include#includevoidf() {int*p=newint(0x12345678);printf("p=%08x,",p);}voidmain(){f();}編譯運行後，在標准輸出窗口得到：p=003a89c0在VisualC++的Output窗口得到：WARNING:VisualLeakDetectordetectedmemoryleaks!----------Block57at0x003A89C0:4bytes------------ 57號塊0x003A89C0地址洩漏了4個字節CallStack:--下面是調用堆棧d:testtestvldconsole testvldconsolemain.cpp(7):f--表示在main.cpp第7行的f()函數d:test testvldconsoletestvldconsolemain.cpp(14):main–雙擊以引導至對應代碼處f:rtm vctoolscrt_bldself_x86crtsrccrtexe.c(586):__tmainCRTStartupf:rtm vctoolscrt_bldself_x86crtsrc crtexe.c(403):mainCRTStartup0x7C816D4F(Fileandlinenumbernotavailable):RegisterWaitForInputIdleData:-- 這是洩漏內存的內容，0x1234567878563412xV4.............VisualLeakDetectordetected1memoryleak. 第二行表示57號塊有4字節的內存洩漏，地址為0x003A89C0，根據程序控制台的輸出，可以知道，該地址為指針p。程序的第7行，f()函數裡，在該地址處分配了4字節的堆內存空間，並賦值為0x12345678，這樣在報告中，我們看到了這4字節同樣的內容。

　　可以看出，對於每一個內存洩漏，這個報告列出了它的洩漏點、長度、分配該內存時的調用堆棧、和洩露內存的內容(分別以16進制和文本格式列出)。雙擊該堆棧報告的某一行，會自動在代碼編輯器中跳到其所指文件的對應行。這些信息對於我們查找內存洩露將有很大的幫助。這是一個很方便易用的工具，安裝後每次使用時，僅僅需要將它頭文件包含進來重新build就可以。而且，該工具僅在buildDebug版的時候會連接到你的程序中，如果 buildRelease版，該工具不會對你的程序產生任何性能等方面影響。所以盡可以將其頭文件一直包含在你的源代碼中。 VisualLeakDetector工作原理下面讓我們來看一下該工具的工作原理。在這之前，我們先來看一下VisualC++內置的內存洩漏檢測工具是如何工作的。VisualC++內置的工具CRTDebugHeap工作原來很簡單。在使用Debug版的malloc分配內存時，malloc會在內存塊的頭中記錄分配該內存的文件名及行號。當程序退出時CRT會在main()函數返回之後做一些清理工作，這個時候來檢查調試堆內存，如果仍然有內存沒有被釋放，則一定是存在內存洩漏。從這些沒有被釋放的內存塊的頭中，就可以獲得文件名及行號。

　　這種靜態的方法可以檢測出內存洩漏及其洩漏點的文件名和行號，但是並不知道洩漏究竟是如何發生的，並不知道該內存分配語句是如何被執行到的。要想了解這些，就必須要對程序的內存分配過程進行動態跟蹤。VisualLeakDetector就是這樣做的。它在每次內存分配時將其上下文記錄下來，當程序退出時，對於檢測到的內存洩漏，查找其記錄下來的上下文信息，並將其轉換成報告輸出。初始化VisualLeakDetector要記錄每一次的內存分配，而它是如何監視內存分配的呢?Windows提供了分配鉤子(allocationhooks)來監視調試堆內存的分配。它是一個用戶定義的回調函數，在每次從調試堆分配內存之前被調用。在初始化時，VisualLeakDetector使用_CrtSetAllocHook注冊這個鉤子函數，這樣就可以監視從此之後所有的堆內存分配了。如何保證在VisualLeakDetector初始化之前沒有堆內存分配呢?全局變量是在程序啟動時就初始化的，如果將 VisualLeakDetector作為一個全局變量，就可以隨程序一起啟動。但是C/C++並沒有約定全局變量之間的初始化順序，如果其它全局變量的構造函數中有堆內存分配，則可能無法檢測到。

　　VisualLeakDetector使用了C/C++提供的#pragmainit_seg來在某種程度上減少其它全局變量在其之前初始化的概率。根據#pragmainit_seg的定義，全局變量的初始化分三個階段：首先是compiler段，一般c語言的運行時庫在這個時候初始化;然後是lib 段，一般用於第三方的類庫的初始化等;最後是user段，大部分的初始化都在這個階段進行。VisualLeakDetector將其初始化設置在 compiler段，從而使得它在絕大多數全局變量和幾乎所有的用戶定義的全局變量之前初始化。記錄內存分配一個分配鉤子函數需要具有如下的形式：intYourAllocHook(intallocType,void*userData,size_tsize,intblockType,longrequestNumber,constunsignedchar*filename,intlineNumber); 就像前面說的，它在VisualLeakDetector初始化時被注冊，每次從調試堆分配內存之前被調用。這個函數需要處理的事情是記錄下此時的調用堆棧和此次堆內存分配的唯一標識——requestNumber。得到當前的堆棧的二進制表示並不是一件很復雜的事情，但是因為不同體系結構、不同編譯器、不同的函數調用約定所產生的堆棧內容略有不同，要解釋堆棧並得到整個函數調用過程略顯復雜。不過windows提供一個StackWalk64函數，可以獲得堆棧的內容。StackWalk64的聲明如下：BOOLStackWalk64(DWORDMachineType,HANDLEhProcess,HANDLEhThread,LPSTACKFRAME64StackFrame,PVOIDContextRecord,

PREAD_PROCESS_MEMORY_ROUTINE64ReadMemoryRoutine,PFUNCTION_TABLE_ACCESS_ROUTINE64FunctionTableAccessRoutine,

PGET_MODULE_BASE_ROUTINE64GetModuleBaseRoutine,PTRANSLATE_ADDRESS_ROUTINE64TranslateAddress);STACKFRAME64 結構表示了堆棧中的一個frame。給出初始的STACKFRAME64，反復調用該函數，便可以得到內存分配點的調用堆棧了。 //Walkthestack.while(count<_VLD_maxtraceframes){count++;if(!pStackWalk64(architecture,m_process,m_thread,&frame,&context,NULL,pSymFunctionTableAccess64,

pSymGetModuleBase64,NULL)){//Couldn'ttracebackthroughanymoreframes.break;}if(frame.AddrFrame.Offset==0){//Endofstack.break;}//Pushthisframe'sprogramcounterontotheprovidedCallStack.callstack->push_back((DWORD_PTR)frame.AddrPC.Offset);}

　　那麼，如何得到初始的STACKFRAME64結構呢?在STACKFRAME64結構中，其他的信息都比較容易獲得，而當前的程序計數器(EIP)在 x86體系結構中無法通過軟件的方法直接讀取。VisualLeakDetector使用了一種方法來獲得當前的程序計數器。首先，它調用一個函數，則這個函數的返回地址就是當前的程序計數器，而函數的返回地址可以很容易的從堆棧中拿到。下面是VisualLeakDetector獲得當前程序計數器的程序：#ifdefined(_M_IX86)||defined(_M_X64)#pragmaauto_inline(off)DWORD_PTRVisualLeakDetector::getprogramcounterx86x64() {DWORD_PTRprogramcounter;__asmmovAXREG, [BPREG+SIZEOFPTR]//Getthereturnaddressoutofthecu