初識Visual Leak Detector

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

       Visual Leak Detector是一款用于Visual C++的免費的內存泄露檢測工具。可以在http://www.codeproject.com/tools/visualleakdetector.asp 下載到。相比較其它的內存泄露檢測工具，它在檢測到內存泄漏的同時，還具有如下特點：

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

2、  可以得到泄露內存的完整數(shù)據(jù)；

3、  可以設置內存泄露報告的級別；

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

5、  他的源代碼使用GNU許可發(fā)布，并有詳盡的文檔及注釋。對于想深入了解堆內存管理的讀者，是一個不錯的選擇。

       可見，從使用角度來講，Visual Leak Detector簡單易用，對于使用者自己的代碼，唯一的修改是#include Visual Leak Detector的頭文件后正常運行自己的程序，就可以發(fā)現(xiàn)內存問題。從研究的角度來講，如果深入Visual Leak Detector源代碼，可以學習到堆內存分配與釋放的原理、內存泄漏檢測的原理及內存操作的常用技巧等。

       本文首先將介紹Visual Leak Detector的使用方法與步驟，然后再和讀者一起初步的研究Visual Leak Detector的源代碼，去了解Visual Leak Detector的工作原理。

使用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拷貝到你的程序的運行目錄下，或其他可以引用到的目錄。

注：我下載的是較新版1.9，直接安裝到系統(tǒng)中。因此使用時必須先在VC中設置一下目錄。

       接下來需要將其加入到自己的代碼中。方法很簡單，只要在包含入口函數(shù)的.cpp文件中包含vld.h就可以。如果這個cpp文件包含了stdafx.h，則將包含vld.h的語句放在stdafx.h的包含語句之后，否則放在最前面。如下是一個示例程序：

#include <vld.h>

void main()

{

…                

}

       接下來讓我們來演示如何使用Visual Leak Detector檢測內存泄漏。下面是一個簡單的程序，用new分配了一個int大小的堆內存，并沒有釋放。其申請的內存地址用printf輸出到屏幕上。

編譯運行后，在標準輸出窗口得到：

p=003a89c0

在Visual C++的Output窗口得到：

WARNING: Visual Leak Detector detected memory leaks!

---------- Block 57 at 0x003A89C0: 4 bytes ----------  --57號塊0x003A89C0地址泄漏了4個字節(jié)

  Call Stack:                                               --下面是調用堆棧

    d:\test\testvldconsole\testvldconsole\main.cpp (7): f  --表示在main.cpp第7行的f()函數(shù)

    d:\test\testvldconsole\testvldconsole\main.cpp (14): main –雙擊以引導至對應代碼處

    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:                                   --這是泄漏內存的內容，0x12345678

    78 56 34 12                                                  xV4..... ........

Visual Leak Detector detected 1 memory leak.   

第二行表示57號塊有4字節(jié)的內存泄漏，地址為0x003A89C0，根據(jù)程序控制臺的輸出，可以知道，該地址為指針p。程序的第7行，f()函數(shù)里，在該地址處分配了4字節(jié)的堆內存空間，并賦值為0x12345678，這樣在報告中，我們看到了這4字節(jié)同樣的內容。

可以看出，對于每一個內存泄漏，這個報告列出了它的泄漏點、長度、分配該內存時的調用堆棧、和泄露內存的內容（分別以16進制和文本格式列出）。雙擊該堆棧報告的某一行，會自動在代碼編輯器中跳到其所指文件的對應行。這些信息對于我們查找內存泄露將有很大的幫助。

這是一個很方便易用的工具，安裝后每次使用時，僅僅需要將它頭文件包含進來重新build就可以。而且，該工具僅在build Debug版的時候會連接到你的程序中，如果build Release版，該工具不會對你的程序產生任何性能等方面影響。所以盡可以將其頭文件一直包含在你的源代碼中。

Visual Leak Detector工作原理

       下面讓我們來看一下該工具的工作原理。

       在這之前，我們先來看一下Visual C++內置的內存泄漏檢測工具是如何工作的。Visual C++內置的工具CRT Debug Heap工作原來很簡單。在使用Debug版的malloc分配內存時，malloc會在內存塊的頭中記錄分配該內存的文件名及行號。當程序退出時CRT會在main()函數(shù)返回之后做一些清理工作，這個時候來檢查調試堆內存，如果仍然有內存沒有被釋放，則一定是存在內存泄漏。從這些沒有被釋放的內存塊的頭中，就可以獲得文件名及行號。

       這種靜態(tài)的方法可以檢測出內存泄漏及其泄漏點的文件名和行號，但是并不知道泄漏究竟是如何發(fā)生的，并不知道該內存分配語句是如何被執(zhí)行到的。要想了解這些，就必須要對程序的內存分配過程進行動態(tài)跟蹤。Visual Leak Detector就是這樣做的。它在每次內存分配時將其上下文記錄下來，當程序退出時，對于檢測到的內存泄漏，查找其記錄下來的上下文信息，并將其轉換成報告輸出。

初始化

       Visual Leak Detector要記錄每一次的內存分配，而它是如何監(jiān)視內存分配的呢？Windows提供了分配鉤子(allocation hooks)來監(jiān)視調試堆內存的分配。它是一個用戶定義的回調函數(shù)，在每次從調試堆分配內存之前被調用。在初始化時，Visual Leak Detector使用_CrtSetAllocHook注冊這個鉤子函數(shù)，這樣就可以監(jiān)視從此之后所有的堆內存分配了。

       如何保證在Visual Leak Detector初始化之前沒有堆內存分配呢？全局變量是在程序啟動時就初始化的，如果將Visual Leak Detector作為一個全局變量，就可以隨程序一起啟動。但是C/C++并沒有約定全局變量之間的初始化順序，如果其它全局變量的構造函數(shù)中有堆內存分配，則可能無法檢測到。Visual Leak Detector使用了C/C++提供的#pragma init_seg來在某種程度上減少其它全局變量在其之前初始化的概率。根據(jù)#pragma init_seg的定義，全局變量的初始化分三個階段：首先是compiler段，一般c語言的運行時庫在這個時候初始化；然后是lib段，一般用于第三方的類庫的初始化等；最后是user段，大部分的初始化都在這個階段進行。Visual Leak Detector將其初始化設置在compiler段，從而使得它在絕大多數(shù)全局變量和幾乎所有的用戶定義的全局變量之前初始化。

記錄內存分配

       一個分配鉤子函數(shù)需要具有如下的形式：

int YourAllocHook( int allocType, void *userData, size_t size, int blockType, long requestNumber, const unsigned char*filename, int lineNumber);

       就像前面說的，它在Visual Leak Detector初始化時被注冊，每次從調試堆分配內存之前被調用。這個函數(shù)需要處理的事情是記錄下此時的調用堆棧和此次堆內存分配的唯一標識——requestNumber。

       得到當前的堆棧的二進制表示并不是一件很復雜的事情，但是因為不同體系結構、不同編譯器、不同的函數(shù)調用約定所產生的堆棧內容略有不同，要解釋堆棧并得到整個函數(shù)調用過程略顯復雜。不過windows提供一個StackWalk64函數(shù)，可以獲得堆棧的內容。StackWalk64的聲明如下：

BOOL StackWalk64(

  DWORD MachineType,

  HANDLE hProcess,

  HANDLE hThread,

  LPSTACKFRAME64 StackFrame,

  PVOID ContextRecord,

  PREAD_PROCESS_MEMORY_ROUTINE64 ReadMemoryRoutine,

  PFUNCTION_TABLE_ACCESS_ROUTINE64 FunctionTableAccessRoutine,

  PGET_MODULE_BASE_ROUTINE64 GetModuleBaseRoutine,

  PTRANSLATE_ADDRESS_ROUTINE64 TranslateAddress

);

STACKFRAME64結構表示了堆棧中的一個frame。給出初始的STACKFRAME64，反復調用該函數(shù)，便可以得到內存分配點的調用堆棧了。

    // 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;

        }

        if (frame.AddrFrame.Offset == 0) {

            // End of stack.

            break;

        }

        // Push this frame's program counter onto the provided CallStack.

        callstack->push_back((DWORD_PTR)frame.AddrPC.Offset);

    }

       那么，如何得到初始的STACKFRAME64結構呢？在STACKFRAME64結構中，其他的信息都比較容易獲得，而當前的程序計數(shù)器(EIP)在x86體系結構中無法通過軟件的方法直接讀取。Visual Leak Detector使用了一種方法來獲得當前的程序計數(shù)器。首先，它調用一個函數(shù)，則這個函數(shù)的返回地址就是當前的程序計數(shù)器，而函數(shù)的返回地址可以很容易的從堆棧中拿到。下面是Visual Leak Detector獲得當前程序計數(shù)器的程序：

#if defined(_M_IX86) || defined(_M_X64)

#pragma auto_inline(off)

DWORD_PTR VisualLeakDetector::getprogramcounterx86x64 ()

{

    DWORD_PTR programcounter;

    __asm mov AXREG, [BPREG + SIZEOFPTR] // Get the return address out of the current stack frame

    __asm mov [programcounter], AXREG    // Put the return address into the variable we'll return

    return programcounter;

}

#pragma auto_inline(on)

#endif // defined(_M_IX86) || defined(_M_X64)

       得到了調用堆棧，自然要記錄下來。Visual Leak Detector使用一個類似map的數(shù)據(jù)結構來記錄該信息。這樣可以方便的從requestNumber查找到其調用堆棧。分配鉤子函數(shù)的allocType參數(shù)表示此次堆內存分配的類型，包括_HOOK_ALLOC, _HOOK_REALLOC, 和 _HOOK_FREE，下面代碼是Visual Leak Detector對各種情況的處理。

    switch (type) {

    case _HOOK_ALLOC:

        visualleakdetector.hookmalloc(request);

        break;

    case _HOOK_FREE:

        visualleakdetector.hookfree(pdata);

        break;

    case _HOOK_REALLOC:

        visualleakdetector.hookrealloc(pdata, request);

        break;

    default:

        visualleakdetector.report("WARNING: Visual Leak Detector: in allochook(): Unhandled allocation type (%d).\n", type);

        break;

    }

這里，hookmalloc()函數(shù)得到當前堆棧，并將當前堆棧與requestNumber加入到類似map的數(shù)據(jù)結構中。hookfree()函數(shù)從類似map的數(shù)據(jù)結構中刪除該信息。hookrealloc()函數(shù)依次調用了hookfree()和hookmalloc()。

檢測內存泄露

       前面提到了Visual C++內置的內存泄漏檢測工具的工作原理。與該原理相同，因為全局變量以構造的相反順序析構，在Visual Leak Detector析構時，幾乎所有的其他變量都已經析構，此時如果仍然有未釋放之堆內存，則必為內存泄漏。

       分配的堆內存是通過一個鏈表來組織的，檢查內存泄漏則是檢查此鏈表。但是windows沒有提供方法來訪問這個鏈表。Visual Leak Detector使用了一個小技巧來得到它。首先在堆上申請一塊臨時內存，則該內存的地址可以轉換成指向一個_CrtMemBlockHeader結構，在此結構中就可以獲得這個鏈表。代碼如下：

    char *pheap = new char;

    _CrtMemBlockHeader *pheader = pHdr(pheap)->pBlockHeaderNext;

delete pheap;

其中pheader則為鏈表首指針。

報告生成

       前面講了Visual Leak Detector如何檢測、記錄內存泄漏及其其調用堆棧。但是如果要這個信息對程序員有用的話，必須轉換成可讀的形式。Visual Leak Detector使用SymGetLineFromAddr64()及SymFromAddr()生成可讀的報告。

            // Iterate through each frame in the call stack.

            for (frame = 0; frame < callstack->size(); frame++) {

                // Try to get the source file and line number associated with

                // this program counter address.

                if (pSymGetLineFromAddr64(m_process,

                   (*callstack)[frame], &displacement, &sourceinfo)) {

                    ...

                }

                // Try to get the name of the function containing this program

                // counter address.

                if (pSymFromAddr(m_process, (*callstack)[frame],

                    &displacement64, pfunctioninfo)) {

                    functionname = pfunctioninfo->Name;

                }

                else {

                    functionname = "(Function name unavailable)";

                }

                ...

            }

       概括講來，Visual Leak Detector的工作分為3步，首先在初始化注冊一個鉤子函數(shù)；然后在內存分配時該鉤子函數(shù)被調用以記錄下當時的現(xiàn)場；最后檢查堆內存分配鏈表以確定是否存在內存泄漏并將泄漏內存的現(xiàn)場轉換成可讀的形式輸出。有興趣的讀者可以閱讀Visual Leak Detector的源代碼。

總結

       在使用上，Visual Leak Detector簡單方便，結果報告一目了然。在原理上，Visual Leak Detector針 對內存泄漏問題的特點，可謂對癥下藥——內存泄漏不是不容易發(fā)現(xiàn)嗎？那就每次內存分配是都給記錄下來，程序退出時算總賬；內存泄漏現(xiàn)象出現(xiàn)時不是已時過境 遷，并非當時泄漏點的現(xiàn)場了嗎？那就把現(xiàn)場也記錄下來，清清楚楚的告訴使用者那塊泄漏的內存就是在如何一個調用過程中泄漏掉的。

       Visual Leak Detector是一個簡單易用內存泄漏檢測工具。現(xiàn)在最新的版本是1.9a，采用了新的檢測機制，并在功能上有了很多改進。讀者不妨體驗一下