C/C++應用程式記憶體洩漏檢查統計方案

　　一、前緒

　　C/C++程式給某些程式設計師的幾大印象之一就是記憶體自己管理容易洩漏容易崩，筆者曾經在一個產品中使用C語言開發維護部分模組，只要產品有記憶體洩漏和崩潰的問題，就被甩鍋“我的程式是C#開發的記憶體都是託管的，C++那邊也沒有記憶體（庇護其好友），肯定是C這邊的問題”（話說一個十幾年的程式設計師還停留在語言層面不覺得有點low嗎），筆者畢業不到一年，聽到此語心裡一萬頭草泥馬奔騰而過，默默地修改了程式，注意不是修改bug（哈哈），而是把所有malloc和free都替換成了自定義巨集MALLOC和FREE，debug版本所有記憶體分配釋放都打了日誌，程式結束自動報告類似“Core Memory Leaks: 位元組數”，此後記憶體洩漏的問題再也沒人敢甩過來了。語言僅僅是個工具，人心是大道。

　　二、C程式記憶體洩漏檢測方案參考

　　C語言應用程式一般使用malloc和free兩個函式分配和釋放記憶體，對它們做記憶體洩漏檢測還是很好想到完美方案的。所謂的完美：1）當記憶體洩漏時能迅速定位到是哪一行程式碼分配的；2）使用簡單與原先無異；3）release時或者不需要除錯記憶體的時候，仍然使用原生態函式，不影響效率。

#ifdef DEBUG_MEMORY
#define MALLOC MallocDebug(__FILE__, __LINE__, size)
#define FREE FreeDebug(__FILE__, __LINE__, p)
#else
#define MALLOC malloc
#define FREE free
#endif

#ifdef DEBUG_MEMORY
#define MEM_OP_MALLOC 1
#define MEM_OP_FREE 0

void LogMemory(const char* file, int line, void* p, int operation, size_t size);

void* MallocDebug(const char* file, int line, size_t size)
{
    void* p = malloc(size);
    LogMemory(file, line, p, MEM_OP_MALLOC, size);
    return p;
}

void FreeDebug(const char* file, int line, void* p)
{
    LogMemory(file, line, p, MEM_OP_FREE, 0);
     free(p);     
}    

void LogMemory(const char* file, int line, void* p, int operation, size_t size)
{
    //列印日誌（malloc/free、指標、檔名、行號、指標、第幾次分配的序號），分配序號可以實現類似與crtdbg的CrtSetBreakAlloc函式的功能
    //操作為malloc時，向map插入一條記錄，增加記憶體使用大小；
    //操作為free時，在map中找到記錄並刪除，減少記憶體使用大小。
}

void DetectMemoryLeaks()
{
    //列印當前記憶體管理的map中剩餘的沒有釋放的記憶體指標、檔名、行號、大小、分配序號
}

#endif

void Program()
{
    int *pArray = MALLOC(sizeof(int) * 10);
    FREE(pArray);

#ifdef DEBUG_MEMORY
    DetectMemoryLeaks();
#endif
}

    C語言應用程式中的上述記憶體洩漏檢測方案至此完美收官，記錄分配序號，也可以向CrtSetBreakAlloc那樣除錯記憶體洩漏哦。

    三、C++程式記憶體洩漏檢測方案參考

    近期在跟蹤C++專案的記憶體洩漏，專案包含多個工程（1個exe+多個自開發dll+多個第三方dll）。

    1.首先考慮的第一個方案是利用crtdbg。踩得第一個坑是記得看下工程配置執行時庫選項用debug版本（/MTd或/MDd），否則無效。非MFC程式報不出可疑洩漏記憶體的檔名及行號，要在整個程式所有使用new的檔案中包含"#define new new(_NORMAL_BLOCK, __FILE__, __LINE__)"的巨集定義。對於單個工程程式而言除錯比較簡單方便；對於多個dll尤其是有第三方庫時，/MTd配置下要非常小心，/MDd配置要好很多，但實際中使用crtdbg除錯還是偶爾會崩在系統底層記憶體分配的地方，出現的問題不在個人解決能力之內，放棄了。

    2.其次的第二個方案，考慮自己過載operator new和operator delete，當然是要過載operator new(size_t size, const char* file, int line)這個版本才能在洩漏時定位到行號。同樣也是要所有使用new的檔案中包含"#define new new( __FILE__, __LINE__)"的巨集定義。問題是雖然可以過載operator delete(void* p,  const char* file, int line)這個版本，但是這個版本只會在placement new失敗時才會呼叫，正常時候還是呼叫的operator delete(void* p)版本，所以還需要過載operator delete(void* p)版本，問題是沒有過載的系統內建的operator new(size_t size)版本分配的所有記憶體也會走使用者過載後的operator delete(void* p)版本，不配對，一起把operator new(size_t size)也過載了。    

      第二個方案的另外一個問題是程式要包含巨集"#define new new( __FILE__, __LINE__)"，但第三方庫標頭檔案中有placement new的用法new(pointer)classA()，專案大一點標頭檔案順序不好調，編譯失敗。還有就是這個方案實踐中（多dll全部設定的相同的執行時庫配置）也在系統底層分配記憶體的方法崩潰過，也可能是個人在哪裡的處理有問題，總之不再考慮前兩個方案了，打算在應用層做處理。

    3.最後確定在最上層想方案，首先C++不能自定義操作符，否則就能定義一個操作符A* pA = debugnew A(1， 2)了。巨集不能有空格只能考慮函式debugnew(A, 1, 2)了。下面上方案。

    所有要分配或釋放記憶體的檔案中包含DebugMemory.h標頭檔案（虛擬碼）：

//檔名：DebugMemory.h

#ifdef DEBUG_MEMORY
#define NEW(T, ...) DebugNew<T>(__FILE__, __LINE__, __VA_ARGS__)
#define DEL(p) DebugDelete(__FILE__, __LINE__, p)
#define NEW_ARRAY(T, size) DebugNewArray<T>(__FILE__, __LINE__, size)
#define DEL_ARRAY(p) DebugDeleteArray(__FILE__, __LINE__, p)
#else
#define NEW(T, ...) new T(__VA_ARGS__)
#define DEL(p) delete(p)
#define NEW_ARRAY(T, size) new T[size]
#define DEL_ARRAY(p) delete[] p
#endif

#ifdef DEBUG_MEMORY

template<class T, class... Args>
T* DebugNew(const char* file, int line, Args&&... args)
{
    T* p = new T(std::forward<Args>(args)...);
    //todo:記錄操作(new)、指標、檔案、行號、分配號
    return p;
}

template<class T>
void DebugDelete(const char* file, int line, T* p)
{
    //todo:記錄操作(delete)、指標、檔案、行號
    delete p;
}

template<class T>
T* DebugNewArray(const char* file, int line, size_t size)
{
    T* p = new T[size];
    //todo:記錄操作(new[])、指標、檔案、行號、分配號
    return p;
}

template<class T>
void DebugDeleteArray(const char* file, int line, T* p)
{
    //todo:記錄操作(delete)、指標、檔案、行號        
    delete[] p;
}

void DetectMemoryLeaks()
{
    //todo:統計並列印未釋放的記憶體資訊
}

#endif

    使用DebugMemory.h標頭檔案：

//檔名：main.cpp

#include "DebugMemory.h"

class A
{
public:
    A(){}
    A(int a, int b):m_a(a), m_b(b){}
private:
    int m_a;
    int m_b;
}

int main()
{
    A* pA = NEW(A, 1, 2);         //new A(1, 2)
    DEL(pA);                      //delete pA;

    A* pArray = NEW_ARRAY(A, 10); //new A[10]
    DEL_ARRAY(pArray);            //delete[] pArray

#ifdef DEBUG_MEMORY
    DetectMemoryLeaks();          //記憶體洩漏檢測
#endif

    return 0;
}

    四、方案評價

1.C語言應用程式的記憶體洩漏解決方案：完美。

2.C++語言應用程式的記憶體洩漏解決方案

           優點：沒有改變預設的operator new和operator delete行為，畢竟危險。

           優點：實用性通用性強，完全在應用程式設計師的控制範圍內。因為在應用層，不管什麼版本都可以檢測記憶體洩漏，不用考慮跨dll呼叫產生的問題。

           不足：寫法習慣改變，原來是new A(1,2)，要寫成NEW(A, 1, 2)，如果C++能實現自定義操作符，那麼方案就完美了。