C++內存管理之一（檢測內存泄露）

C++程序的複雜性很大一部分在於他的內存管理，沒有C#那樣的垃圾回收機制，內存管理對初學者來講很困難。常常會出現內存泄露的狀況。那麼咱們寫程序如何避免內存泄露呢？首先咱們須要知道程序有沒有內存泄露，而後定位究竟是哪行代碼出現內存泄露了，這樣才能將其修復。
本文描述瞭如何檢測內存泄露。最主要的是純C，C++的程序如何檢測內存泄露。
如今有不少專業的檢測工具，好比比較有名的BoundsCheck, 可是這類工具也有他的缺點，我認爲首先BoundsCheck是商業軟件，呵呵。而後呢須要安裝，使用起來不太方便。由於咱們檢測的時候不必定常常會啓動他來檢測。這樣常常會積累不少問題，那時要解決就麻煩了。最好就是從開始編碼，一步一步的都能隨時提醒咱們內存泄露。咱們編程序會常常調試，假如能在每次調試程序的時候都能自動檢測內存泄露就行了。

  一. 在 MFC 中檢測內存泄漏
假如是用MFC的程序的話，很簡單。默認的就有內存泄露檢測的功能。
咱們用VS2005生成了一個MFC的對話框的程序,發現他能夠自動的檢測內存泄露.不用咱們作任何特殊的操做. 仔細觀察,發如今每一個CPP文件中,都有下面的代碼:

 #ifdef _DEBUG
 #define new DEBUG_NEW
 #endif

DEBUG_NEW 這個宏定義在afx.h文件中，就是它幫助咱們定位內存泄漏。

    在含有以上代碼的cpp文件中分配內存後假如沒有刪除，那麼中止程序的時候，VisualStudio的Output窗口就會顯示以下的信息了：

 Detected memory leaks!
 Dumping objects ->
 d:/code/mfctest/mfctest.cpp(80) : {157} normal block at 0x003AF170, 4 bytes long.
 Data: < > 00 00 00 00
 Object dump complete.

 

 

    在Output窗口雙擊粗體字那一行，那麼IDE就會打開該文件，定位到該行，很容易看出是哪出現了內存泄露。

    二．檢測純C++的程序內存泄露

我試了下用VisualStudio創建的Win32 Console Application和Win32 Project項目，結果都不能檢測出內存泄露。
下面一步一步來把程序的內存泄露檢測的機制創建起來。
首先，咱們須要知道C運行庫的Debug版本提供了許多檢測功能，使得咱們更容易的Debug程序。在MSDN中有專門的章節講這個，叫作Debug Routines，建議你們先看看裏面的內容吧。
咱們會用到裏面很重要的幾個函數。其中最重要的是 _CrtDumpMemoryLeaks();本身看MSDN裏的幫助吧。使用這個函數，須要包含頭文件crtdbg.h
該函數只在Debug版本纔有用，當在調試器下運行程序時，_CrtDumpMemoryLeaks 將在「Output(輸出)」窗口中顯示內存泄漏信息.寫段代碼試驗一下吧，以下：
  檢測內存泄露版本一：

 #include "stdafx.h"
 #include <crtdbg.h>
 int _tmain(int argc, _TCHAR* argv[])
 {
     int* p = new int();
     _CrtDumpMemoryLeaks();
     return 0;
 }

  運行後，在Output（輸出）窗口，顯示了以下的信息：

 Detected memory leaks!
 Dumping objects ->
 {112} normal block at 0x003AA770, 4 bytes long.
 Data: <    > 00 00 00 00
 Object dump complete.

  可是這個只是告訴咱們程序有內存泄露，到底在哪泄露了一眼看不出來啊。
  看咱們的檢測內存泄露版本二：

 #include "stdafx.h"
 #ifdef _DEBUG
 #define DEBUG_CLIENTBLOCK   new( _CLIENT_BLOCK, __FILE__, __LINE__)
 #else
 #define DEBUG_CLIENTBLOCK
 #endif
 #define _CRTDBG_MAP_ALLOC
 #include <crtdbg.h>
 #ifdef _DEBUG
 #define new DEBUG_CLIENTBLOCK
 #endif
 int _tmain(int argc, _TCHAR* argv[])
 {
     int* p = new int();
     _CrtDumpMemoryLeaks();
     return 0;
 }

  該程序定義了幾個宏，經過宏將Debug版本下的new給替換了，新的new記錄下了調用new時的文件名和代碼行.運行後，能夠看到以下的結果：

 

 

 

 

 Detected memory leaks!
 Dumping objects ->
 d:/code/consoletest/consoletest.cpp(21) : {112} client block at 0x003A38B0, subtype 0, 4 bytes long.
 Data: <    > 00 00 00 00
 Object dump complete.

  呵呵，已經和MFC程序的效果同樣了，可是等一等。看下以下的代碼吧：

 int _tmain(int argc, _TCHAR* argv[])
 {
     int* p = new int();
     _CrtDumpMemoryLeaks();
     delete p;
     return 0;
 }

 

 

 

  運行後能夠發現咱們刪除了指針，可是它仍然報內存泄露。因此能夠想象，每調用一次new，程序內部都會將該調用記錄下來，相似於有個數組記錄，假如delete了，那麼就將其從數組中刪除，而_CrtDumpMemoryLeaks()就是把這個數組當前的狀態打印出來。
因此除了在必要的時候Dump出內存信息外，最重要的就是在程序退出的時候須要掉用一次_CrtDumpMemoryLeaks();
假如程序有不止一個出口，那麼咱們就須要在多個地方都調用該函數。
更進一步，假如程序在類的析構函數裏刪除指針，怎麼辦？例如：

 #include "stdafx.h"
 #ifdef _DEBUG
 #define DEBUG_CLIENTBLOCK   new( _CLIENT_BLOCK, __FILE__, __LINE__)
 #else
 #define DEBUG_CLIENTBLOCK
 #endif
 #define _CRTDBG_MAP_ALLOC
 #include <crtdbg.h>
 #ifdef _DEBUG
 #define new DEBUG_CLIENTBLOCK
 #endif
 class Test
 {
 public:
     Test()      {   _p = new int();     }
     ~Test()     {   delete _p;          }
     int* _p;
 };
 int _tmain(int argc, _TCHAR* argv[])
 {
     int* p = new int();
     delete p;
     Test t;
     _CrtDumpMemoryLeaks();
     return 0;
 }

  能夠看到析構函數在程序退出的時候才調用，明明沒有內存泄露，可是這樣的寫法仍是報了。
  如何改進呢,看檢測內存泄露版本三：

 #include "stdafx.h"
 #ifdef _DEBUG
 #define DEBUG_CLIENTBLOCK   new( _CLIENT_BLOCK, __FILE__, __LINE__)
 #else
 #define DEBUG_CLIENTBLOCK
 #endif
 #define _CRTDBG_MAP_ALLOC
 #include <crtdbg.h>
 #ifdef _DEBUG
 #define new DEBUG_CLIENTBLOCK
 #endif
 class Test
 {
 public:
     Test()      {   _p = new int();     }
     ~Test()     {   delete _p;          }
     int* _p;
 };
 int _tmain(int argc, _TCHAR* argv[])
 {
     _CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
     int* p = new int();
     delete p;
     Test t;
     return 0;
 }

 

 

 

  _CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
該語句在程序退出時自動調用 _CrtDumpMemoryLeaks。必須同時設置 _CRTDBG_ALLOC_MEM_DF 和 _CRTDBG_LEAK_CHECK_DF.
  這樣，該版本已經達到了MFC同樣的效果了，可是我以爲光這樣還不夠，由於咱們只是在Output窗口中輸出信息，對開發人員的提醒還不明顯，常常會被遺漏，並且不少人就算髮現了內存泄露，可是很差修復，不會嚴重影響到程序外在表現，都不會修復。怎麼樣能讓開發人員主動的修復內存泄露的問題呢？記得曾經和人配合寫程序，個人函數參數有要求，不能爲空，可是別人總是傳空值，沒辦法了，只好在函數開始驗證函數參數，給他assert住，這樣程序運行時總是不停的彈出assert，調試程序那個煩壓，最後其餘程序員煩了，就把這個問題給改好了，輸入參數就正確了。因此我以爲咱要讓程序員主動去作一件事，首先要讓他以爲作這個事是能減輕本身負擔，讓本身工做輕鬆的。呵呵，那我們也這樣，當程序退出時，檢測到內存泄露就讓程序提示出來。
  看檢測內存泄露版本四：

 #include "stdafx.h"
 #include <assert.h>
 #ifdef _DEBUG
 #define DEBUG_CLIENTBLOCK   new( _CLIENT_BLOCK, __FILE__, __LINE__)
 #else
 #define DEBUG_CLIENTBLOCK
 #endif
 #define _CRTDBG_MAP_ALLOC
 #include <crtdbg.h>
 #ifdef _DEBUG
 #define new DEBUG_CLIENTBLOCK
 #endif
 void Exit()
 {
     int i = _CrtDumpMemoryLeaks();
     assert( i == 0);
 }
 int _tmain(int argc, _TCHAR* argv[])
 {
     atexit(Exit);
     int* p = new int();
     return 0;
 }

  該版本會在程序退出時檢查內存泄露，假如存在就會彈出提示對話框.
atexit(Exit);設置了在程序退出時執行Exit()函數。
Exit()函數中,假如存在內存泄露，_CrtDumpMemoryLeaks()會返回非0值，就會被assert住了。

   到這個版本已經達到可使用的程度了。可是咱們還能夠作些改進，由於真要準確的檢測到代碼中全部的內存泄露，須要把代碼中的#define……拷貝到全部使用new的文件中。不可能每一個文件都拷貝這麼多代碼，因此咱們能夠將他提取出來，放在一個文件中，好比我是放在KDetectMemoryLeak.h中，該文件內容以下：

 

 

 

 

 #pragma once
 #ifdef _DEBUG
 #define DEBUG_CLIENTBLOCK   new( _CLIENT_BLOCK, __FILE__, __LINE__)
 #else
 #define DEBUG_CLIENTBLOCK
 #endif
 #define _CRTDBG_MAP_ALLOC
 #include <stdlib.h>
 #include <crtdbg.h>
 #ifdef _DEBUG
 #define new DEBUG_CLIENTBLOCK
 #endif

  而後將KDetectMemoryLeak.h包含在項目的通用文件中，例如用VS建的項目就將其包含在stdafx.h中。或者我本身建的一個Common.h文件中，該文件包含一些通用的，基本全部文件都會用到的代碼東東。

  好了，到如今，檢測內存泄露總算完成了，並且他還能定位到究竟是代碼中哪一個文件，哪行出現了內存泄露。下一篇文章將會講些實際遇到的一些問題，例如只知道有內存泄露，可是不知道到底內存泄露的具體位置，如何利用內存斷點等技術來定位內存泄露的位置啊，最後會從代碼的角度講下，怎麼樣才能避免內存泄露吧。