FW:VC記憶體洩露檢查工具:Visual Lea…

VC記憶體洩露檢查工具:Visual Leak Detector 收藏

初識Visual Leak Detector

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

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

1、 可以得到記憶體洩漏點的調用堆棧，如果可以的話，還可以得到其所在檔案及行号；

2、 可以得到洩露記憶體的完整資料；

3、 可以設定記憶體洩露報告的級别；

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

5、 他的源代碼使用GNU許可釋出，并有詳盡的文檔及注釋。對于想深入了解堆記憶體管理的讀者，是一個不錯的選擇。

       可見，從使用角度來講，Visual Leak Detector簡單易用，對于使用者自己的代碼，唯一的修改是#include Visual Leak Detector的頭檔案後正常運作自己的程式，就可以發現記憶體問題。從研究的角度來講，如果深入Visual Leak Detector源代碼，可以學習到堆記憶體配置設定與釋放的原理、記憶體洩漏檢測的原理及記憶體操作的常用技巧等。

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

使用Visual Leak Detector(1.0)

       下面讓我們來介紹如何使用這個小巧的工具。

       首先從網站上下載下傳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拷貝到你的程式的運作目錄下，或其他可以引用到的目錄。

       接下來需要将其加入到自己的代碼中。方法很簡單，隻要在包含入口函數的.cpp檔案中包含vld.h就可以。如果這個cpp檔案包含了stdafx.h，則将包含vld.h的語句放在stdafx.h的包含語句之後，否則放在最前面。如下是一個示例程式：

#include <vld.h>

void main()

{

…

}

       接下來讓我們來示範如何使用Visual Leak Detector檢測記憶體洩漏。下面是一個簡單的程式，用new配置設定了一個int大小的堆記憶體，并沒有釋放。其申請的記憶體位址用printf輸出到螢幕上。

#include <vld.h>

#include <stdlib.h>

#include <stdio.h>

void f()

{

    int *p = new int(0x12345678);

    printf("p=x, ", 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個位元組

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

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

    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位元組的記憶體洩漏，位址為0x003A89C0，根據程式控制台的輸出，可以知道，該位址為指針p。程式的第7行，f()函數裡，在該位址處配置設定了4位元組的堆記憶體空間，并指派為0x12345678，這樣在報告中，我們看到了這4位元組同樣的内容。

可以看出，對于每一個記憶體洩漏，這個報告列出了它的洩漏點、長度、配置設定該記憶體時的調用堆棧、和洩露記憶體的内容（分别以16進制和文本格式列出）。輕按兩下該堆棧報告的某一行，會自動在代碼編輯器中跳到其所指檔案的對應行。這些資訊對于我們查找記憶體洩露将有很大的幫助。

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

Visual Leak Detector工作原理

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

       在這之前，我們先來看一下Visual C++内置的記憶體洩漏檢測工具是如何工作的。Visual C++内置的工具CRT Debug Heap工作原來很簡單。在使用Debug版的malloc配置設定記憶體時，malloc會在記憶體塊的頭中記錄配置設定該記憶體的檔案名及行号。當程式退出時CRT 會在main()函數傳回之後做一些清理工作，這個時候來檢查調試堆記憶體，如果仍然有記憶體沒有被釋放，則一定是存在記憶體洩漏。從這些沒有被釋放的記憶體塊的 頭中，就可以獲得檔案名及行号。

       這種靜态的方法可以檢測出記憶體洩漏及其洩漏點的檔案名和行号，但是并不知道洩漏究竟是如何發生的，并不知道該記憶體配置設定語句是如何被執行到的。要想了解這 些，就必須要對程式的記憶體配置設定過程進行動态跟蹤。Visual Leak Detector就是這樣做的。它在每次記憶體配置設定時将其上下文記錄下來，當程式退出時，對于檢測到的記憶體洩漏，查找其記錄下來的上下文資訊，并将其轉換成 報告輸出。

初始化

       Visual Leak Detector要記錄每一次的記憶體配置設定，而它是如何監視記憶體配置設定的呢？Windows提供了配置設定鈎子(allocation hooks)來監視調試堆記憶體的配置設定。它是一個使用者定義的回調函數，在每次從調試堆配置設定記憶體之前被調用。在初始化時，Visual Leak Detector使用_CrtSetAllocHook注冊這個鈎子函數，這樣就可以監視從此之後所有的堆記憶體配置設定了。

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

記錄記憶體配置設定

       一個配置設定鈎子函數需要具有如下的形式：

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

       就像前面說的，它在Visual Leak Detector初始化時被注冊，每次從調試堆配置設定記憶體之前被調用。這個函數需要處理的事情是記錄下此時的調用堆棧和此次堆記憶體配置設定的唯一辨別——requestNumber。

       得到目前的堆棧的二進制表示并不是一件很複雜的事情，但是因為不同體系結構、不同編譯器、不同的函數調用約定所産生的堆棧内容略有不同，要解釋堆棧并得到 整個函數調用過程略顯複雜。不過windows提供一個StackWalk64函數，可以獲得堆棧的内容。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，反複調用該函數，便可以得到記憶體配置設定點的調用堆棧了。

    // 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結構中，其他的資訊都比較容易獲得，而目前的程式計數器(EIP)在 x86體系結構中無法通過軟體的方法直接讀取。Visual Leak Detector使用了一種方法來獲得目前的程式計數器。首先，它調用一個函數，則這個函數的傳回位址就是目前的程式計數器，而函數的傳回位址可以很容易 的從堆棧中拿到。下面是Visual Leak Detector獲得目前程式計數器的程式：

#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的資料結構來記錄該資訊。這樣可以友善的從requestNumber查找到其調用堆棧。配置設定鈎子函數的 allocType參數表示此次堆記憶體配置設定的類型，包括_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()函數得到目前堆棧，并将目前堆棧與requestNumber加入到類似map的資料結構中。hookfree()函數從類 似map的資料結構中删除該資訊。hookrealloc()函數依次調用了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步，首先在初始化注冊一個鈎子函數；然後在記憶體配置設定時該鈎子函數被調用以記錄下當時的現場；最後檢查堆記憶體配置設定連結清單以确定是 否存在記憶體洩漏并将洩漏記憶體的現場轉換成可讀的形式輸出。有興趣的讀者可以閱讀Visual Leak Detector的源代碼。

總結

       在使用上，Visual Leak Detector簡單友善，結果報告一目了然。在原理上，Visual Leak Detector針對記憶體洩漏問題的特點，可謂對症下藥——記憶體洩漏不是不容易發現嗎？那就每次記憶體配置設定是都給記錄下來，程式退出時算總賬；記憶體洩漏現象 出現時不是已時過境遷，并非當時洩漏點的現場了嗎？那就把現場也記錄下來，清清楚楚的告訴使用者那塊洩漏的記憶體就是在如何一個調用過程中洩漏掉的。

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

發表于 @ 2009年02月11日　10:26:00 | 評論( 0 ) | 舉報| 收藏

舊一篇:Edit控件單行顯示文字垂直居中的辦法