基於 crt debug 實現的 Windows 程序內存泄漏檢測工具

　　Windows 程序內存泄漏檢測是一項十分重要的工作，基於 GUI 的應用程序通常在調試結束時也有內存泄漏報告，但這個報告的信息不全面，不能定位到產生泄漏的具體行號。其實自己實現一個內存泄漏檢測工具是一件非常簡單的事情，但看過網上寫的很多例子，普遍存在兩種問題：

1. 1. 要么考慮不周全，一種環境下能用，而在另外一種環境下卻不能很好工作，或者漏洞報告的輸出方式不合理。
   2. 要么過於保守，例如：完全沒有必要在 _malloc_dbg() 和 _free_dbg() 的調用前后用 CriticalSection 進行保護（跟蹤一下多線程環境下 new 和 malloc 的代碼就會明白）。

　　內存檢測主要用到以下幾個 API，這些 API 能跟蹤 new 和 malloc 系列方法申請的內存，具體說明參考幫助文檔：

struct _CrtMemState;

_CrtSetDbgFlag();
_CrtMemCheckpoint();
_CrtMemCheckpoint();
_CrtMemDifference();
_CrtMemDumpStatistics();
_malloc_dbg();
_free_dbg();

 

• 　　頭文件：win32_crtdbg.h

#pragma once

#if defined _DEBUG && defined _DETECT_MEMORY_LEAK

#ifdef new
    #undef new
#endif

#ifdef delete
    #undef delete
#endif

#ifndef _CRTDBG_MAP_ALLOC
    #define _CRTDBG_MAP_ALLOC
#endif

#include <crtdbg.h>

namespace __dbg_impl
{
    class CDebugEnv
    {
    public:
        CDebugEnv()
        {
            ::_CrtSetDbgFlag( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
            ::_CrtMemCheckpoint(&s1);
        }

        ~CDebugEnv()
        {
            ::_CrtMemCheckpoint(&s2);

            if (::_CrtMemDifference( &s3, &s1, &s2))
            {
                TRACE0("!! Memory stats !!\n");
                TRACE0("----------------------------------------\n");
                ::_CrtMemDumpStatistics(&s3);
                TRACE0("----------------------------------------\n");
            }
        }

    private:
        _CrtMemState s1, s2, s3;
    };

    static __dbg_impl::CDebugEnv __dbgEnv;
}

inline void* __cdecl operator new(size_t nSize, const char* lpszFileName, int nLine)
{
    return ::_malloc_dbg(nSize, _NORMAL_BLOCK, lpszFileName, nLine);
}

inline void* __cdecl operator new[](size_t nSize, const char* lpszFileName, int nLine)
{
    return operator new(nSize, lpszFileName, nLine);
}

inline void* __cdecl operator new(size_t nSize)
{
    return operator new(nSize, __FILE__, __LINE__);
}

inline void* __cdecl operator new[](size_t nSize)
{
    return operator new(nSize, __FILE__, __LINE__);
}

inline void* __cdecl operator new(size_t nSize, const std::nothrow_t&)
{
    return operator new(nSize, __FILE__, __LINE__);
}

inline void* __cdecl operator new[](size_t nSize, const std::nothrow_t&)
{
    return operator new(nSize, __FILE__, __LINE__);
}

inline void __cdecl operator delete(void* p)
{
    ::_free_dbg(p, _NORMAL_BLOCK);
}

inline void __cdecl operator delete[](void* p)
{
    operator delete(p);
}

inline void __cdecl operator delete(void* p, const char* lpszFileName, int nLine)
{
    operator delete(p);
}

inline void __cdecl operator delete[](void* p, const char* lpszFileName, int nLine)
{
    operator delete(p);
}

inline void __cdecl operator delete(void *p, const std::nothrow_t&)
{
    operator delete(p);
}

inline void __cdecl operator delete[](void *p, const std::nothrow_t&)
{
    operator delete(p);
}

#define new new(__FILE__, __LINE__)

#endif // _DEBUG && defined _DETECT_MEMORY_LEAK

 

• 　　實現文件：win32_crtdbg.cpp

#include "stdafx.h"
#include "win32_crtdbg.h"

#if defined _DEBUG && defined _DETECT_MEMORY_LEAK

__dbg_impl::CDebugEnv __dbgEnv;

#endif // _DEBUG && defined _DETECT_MEMORY_LEAK

 

• 使用方法

1. 在 stdafx.h 或其他公共頭文件中： #define_DETECT_MEMORY_LEAK，#include"win32_crtdbg.h"。
2. 刪除項目工程模板中自動生成的 new 操作符重定義，通常自動生成的 cpp 文件在 DEBUG 環境下會把 new 重定義為 DEBUG_NEW。

• 存在問題

　　　　對於某些全局變量指向的堆內存，如果 ~CDebugEnv() 被調用之時還沒釋放，則可能存在誤報現象。這是一個老大難問題了，目前還沒有完美的解決方法。

CodeProject