1.初識Visual Leak Detector
靈活自由是C/C++語言的一大特色,而這也為C/C++程序員出了一個難題。當程序越來越復雜時,內(nèi)存的管理也會變得越加復雜,稍有不慎就會出現(xiàn)內(nèi)存問題。內(nèi)存泄漏是最常見的內(nèi)存問題之一。內(nèi)存泄漏如果不是很嚴重,在短時間內(nèi)對程序不會有太大的影響,這也使得內(nèi)存泄漏問題有很強的隱蔽性,不容易被發(fā)現(xiàn)。然而不管內(nèi)存泄漏多么輕微,當程序長時間運行時,其破壞力是驚人的,從性能下降到內(nèi)存耗盡,甚至會影響到其他程序的正常運行。另外內(nèi)存問題的一個共同特點是,內(nèi)存問題本身并不會有很明顯的現(xiàn)象,當有異常現(xiàn)象出現(xiàn)時已時過境遷,其現(xiàn)場已非出現(xiàn)問題時的現(xiàn)場了,這給調(diào)試內(nèi)存問題帶來了很大的難度。
Visual Leak Detector是一款用于Visual C++的免費的內(nèi)存泄露檢測工具。可以在http://www.codeproject.com/tools/visualleakdetector.asp下載到。相比較其它的內(nèi)存泄露檢測工具,它在檢測到內(nèi)存泄漏的同時,還具有如下特點:
1、 可以得到內(nèi)存泄漏點的調(diào)用堆棧,如果可以的話,還可以得到其所在文件及行號;
2、 可以得到泄露內(nèi)存的完整數(shù)據(jù);
3、 可以設(shè)置內(nèi)存泄露報告的級別;
4、 它是一個已經(jīng)打包的lib,使用時無須編譯它的源代碼。而對于使用者自己的代碼,也只需要做很小的改動;
5、 他的源代碼使用GNU許可發(fā)布,并有詳盡的文檔及注釋。對于想深入了解堆內(nèi)存管理的讀者,是一個不錯的選擇。
可見,從使用角度來講,Visual Leak Detector簡單易用,對于使用者自己的代碼,唯一的修改是#include Visual Leak Detector的頭文件后正常運行自己的程序,就可以發(fā)現(xiàn)內(nèi)存問題。從研究的角度來講,如果深入Visual Leak Detector源代碼,可以學習到堆內(nèi)存分配與釋放的原理、內(nèi)存泄漏檢測的原理及內(nèi)存操作的常用技巧等。 本文首先將介紹Visual Leak Detector的使用方法與步驟,然后再和讀者一起初步的研究Visual Leak Detector的源代碼,去了解Visual Leak Detector的工作原理。
2.使用Visual Leak Detector(1.0)
下面讓我們來介紹如何使用這個小巧的工具。
首先從網(wǎng)站上下載zip包,解壓之后得到vld.h, vldapi.h, vld.lib, vldmt.lib, vldmtdll.lib, dbghelp.dll等文件。將.h文件拷貝到Visual C++的默認include目錄下,將.lib文件拷貝到Visual C++的默認lib目錄下,便安裝完成了。因為版本問題,如果使用windows 2000或者以前的版本,需要將dbghelp.dll拷貝到你的程序的運行目錄下,或其他可以引用到的目錄。
接下來需要將其加入到自己的代碼中。方法很簡單,只要在包含入口函數(shù)的.cpp文件中包含vld.h就可以。如果這個cpp文件包含了stdafx.h,則將包含vld.h的語句放在stdafx.h的包含語句之后,否則放在最前面。如下是一個示例程序:
#include<vld.h>
void main()
{
…
}
接下來讓我們來演示如何使用Visual Leak Detector檢測內(nèi)存泄漏。下面是一個簡單的程序,用new分配了一個int大小的堆內(nèi)存,并沒有釋放。其申請的內(nèi)存地址用printf輸出到屏幕上。
#include<vld.h>
#include<stdlib.h>
#include<stdio.h>
void f()
{
int*p =newint(0x12345678);
printf("p=%08x, ", p);
}
void main()
{
f();
}
編譯運行后,在標準輸出窗口得到:
p=003a89c0
在Visual C++的Output窗口得到:
WARNING: Visual Leak Detector detected memory leaks!
---------- Block 57 at 0x003A89C0: 4 bytes ---------- --57號塊0x003A89C0地址泄漏了4個字節(jié)
Call Stack: --下面是調(diào)用堆棧
d:\test\testvldconsole\testvldconsole\main.cpp (7): f --表示在main.cpp第7行的f()函數(shù)
d:\test\testvldconsole\testvldconsole\main.cpp (14): main–雙擊以引導至對應(yīng)代碼處
f:\rtm\vctools\crt_bld\self_x86\crt\src\crtexe.c (586): __tmainCRTStartup
f:\rtm\vctools\crt_bld\self_x86\crt\src\crtexe.c (403): mainCRTStartup
0x7C816D4F (File and line number not available): RegisterWaitForInputIdle
Data: --這是泄漏內(nèi)存的內(nèi)容,0x12345678 78 56 34 12
xV4..... ........
Visual Leak Detector detected 1 memory leak.
第二行表示57號塊有4字節(jié)的內(nèi)存泄漏,地址為0x003A89C0,根據(jù)程序控制臺的輸出,可以知道,該地址為指針p。程序的第7行,f()函數(shù)里,在該地址處分配了4字節(jié)的堆內(nèi)存空間,并賦值為0x12345678,這樣在報告中,我們看到了這4字節(jié)同樣的內(nèi)容。
可以看出,對于每一個內(nèi)存泄漏,這個報告列出了它的泄漏點、長度、分配該內(nèi)存時的調(diào)用堆棧、和泄露內(nèi)存的內(nèi)容(分別以16進制和文本格式列出)。雙擊該堆棧報告的某一行,會自動在代碼編輯器中跳到其所指文件的對應(yīng)行。這些信息對于我們查找內(nèi)存泄露將有很大的幫助。
這是一個很方便易用的工具,安裝后每次使用時,僅僅需要將它頭文件包含進來重新build就可以。而且,該工具僅在build Debug版的時候會連接到你的程序中,如果build Release版,該工具不會對你的程序產(chǎn)生任何性能等方面影響。所以盡可以將其頭文件一直包含在你的源代碼中。
3.Visual Leak Detector工作原理
下面讓我們來看一下該工具的工作原理。
在這之前,我們先來看一下Visual C++內(nèi)置的內(nèi)存泄漏檢測工具是如何工作的。Visual C++內(nèi)置的工具CRT Debug Heap工作原來很簡單。在使用Debug版的malloc分配內(nèi)存時,malloc會在內(nèi)存塊的頭中記錄分配該內(nèi)存的文件名及行號。當程序退出時CRT會在main()函數(shù)返回之后做一些清理工作,這個時候來檢查調(diào)試堆內(nèi)存,如果仍然有內(nèi)存沒有被釋放,則一定是存在內(nèi)存泄漏。從這些沒有被釋放的內(nèi)存塊的頭中,就可以獲得文件名及行號。 這種靜態(tài)的方法可以檢測出內(nèi)存泄漏及其泄漏點的文件名和行號,但是并不知道泄漏究竟是如何發(fā)生的,并不知道該內(nèi)存分配語句是如何被執(zhí)行到的。要想了解這些,就必須要對程序的內(nèi)存分配過程進行動態(tài)跟蹤。Visual Leak Detector就是這樣做的。它在每次內(nèi)存分配時將其上下文記錄下來,當程序退出時,對于檢測到的內(nèi)存泄漏,查找其記錄下來的上下文信息,并將其轉(zhuǎn)換成報告輸出。
3.1初始化
Visual Leak Detector要記錄每一次的內(nèi)存分配,而它是如何監(jiān)視內(nèi)存分配的呢?Windows提供了分配鉤子(allocation hooks)來監(jiān)視調(diào)試堆內(nèi)存的分配。它是一個用戶定義的回調(diào)函數(shù),在每次從調(diào)試堆分配內(nèi)存之前被調(diào)用。在初始化時,Visual Leak Detector使用_CrtSetAllocHook注冊這個鉤子函數(shù),這樣就可以監(jiān)視從此之后所有的堆內(nèi)存分配了。
如何保證在Visual Leak Detector初始化之前沒有堆內(nèi)存分配呢?全局變量是在程序啟動時就初始化的,如果將Visual Leak Detector作為一個全局變量,就可以隨程序一起啟動。但是C/C++并沒有約定全局變量之間的初始化順序,如果其它全局變量的構(gòu)造函數(shù)中有堆內(nèi)存分配,則可能無法檢測到。Visual Leak Detector使用了C/C++提供的#pragma init_seg來在某種程度上減少其它全局變量在其之前初始化的概率。根據(jù)#pragma init_seg的定義,全局變量的初始化分三個階段:首先是compiler段,一般c語言的運行時庫在這個時候初始化;然后是lib段,一般用于第三方的類庫的初始化等;最后是user段,大部分的初始化都在這個階段進行。Visual Leak Detector將其初始化設(shè)置在compiler段,從而使得它在絕大多數(shù)全局變量和幾乎所有的用戶定義的全局變量之前初始化。
4.記錄內(nèi)存分配
一個分配鉤子函數(shù)需要具有如下的形式:intYourAllocHook(intallocType,void*userData, size_t size,intblockType,longrequestNumber,constunsignedchar*filename,intlineNumber); 就像前面說的,它在Visual Leak Detector初始化時被注冊,每次從調(diào)試堆分配內(nèi)存之前被調(diào)用。這個函數(shù)需要處理的事情是記錄下此時的調(diào)用堆棧和此次堆內(nèi)存分配的唯一標識——requestNumber。
得到當前的堆棧的二進制表示并不是一件很復雜的事情,但是因為不同體系結(jié)構(gòu)、不同編譯器、不同的函數(shù)調(diào)用約定所產(chǎn)生的堆棧內(nèi)容略有不同,要解釋堆棧并得到整個函數(shù)調(diào)用過程略顯復雜。不過windows提供一個StackWalk64函數(shù),可以獲得堆棧的內(nèi)容。StackWalk64的聲明如下:BOOLStackWalk64( DWORDMachineType, HANDLEhProcess, HANDLEhThread, LPSTACKFRAME64StackFrame, PVOIDContextRecord, PREAD_PROCESS_MEMORY_ROUTINE64ReadMemoryRoutine, PFUNCTION_TABLE_ACCESS_ROUTINE64FunctionTableAccessRoutine, PGET_MODULE_BASE_ROUTINE64GetModuleBaseRoutine, PTRANSLATE_ADDRESS_ROUTINE64TranslateAddress);STACKFRAME64結(jié)構(gòu)表示了堆棧中的一個frame。給出初始的STACKFRAME64,反復調(diào)用該函數(shù),便可以得到內(nèi)存分配點的調(diào)用堆棧了。 // Walk the stack. while(count < _VLD_maxtraceframes) { count++; if(!pStackWalk64(architecture, m_process, m_thread, &frame, &context, NULL, pSymFunctionTableAccess64, pSymGetModuleBase64, NULL)) { // Couldn't trace back through any more frames. break; }