| 一、 為什么寫這篇東西 自己在使用 BCB5 寫一些程序時需要檢查很多東西,例如內存泄漏、資源是否有釋放等等,在使用了很多工具后,發覺 BCB5 本身自帶的工具—— CodeGuard ,非常不錯,使用也挺方便的,但是摸索了很久(以及翻查了一些資料,包括 HELP )才算是會用了。寫這篇文章的目的希望有這方面的問題的朋友可以借鑒一下,大家互相學習,共同進步。我的聯系方法: Email : szbug@szbug.com ,希望志同道合的朋友來信互相交流。以下這篇文章算是拼湊出來的一篇文章,一些資料是在書上找的,一些是在 HELP 上看到了。 二、 什么是 CodeGuard CodeGuard 是在是 C++Builder5 才出現的一個工具。 CodeGuard 是 C++Builder 中一個程序在運行時期的檢查器,用于檢查內存或者資源的使用,以及函數調用的驗證。 CodeGuard 可以檢測到以下的程序運行期錯誤: l 非法的內存釋放。 l 無效的句柄或者文件流。 l 非法指針。 l 使用已被釋放的指針。 l 內存泄漏。 l 分配但最后沒有釋放的內存變量。 l 傳遞給函數的不正確的參數(包括 VCL 以及 Win32 函數)。 l 函數返回值的錯誤。(包括 VCL 以及 Win32 函數)。 例如:在應用程序中試圖多次釋放相同的資源(或者已經釋放了的資源)、試圖訪問已經被釋放的內存。 三、 在 BCB5 中怎樣使用 CodeGuard ——配置 CodeGuard 如果要使用 CodeGuard 的話,必須有些代碼編譯進你的應用程序,所以在改變以下這些設置后。必須全部重新編譯(切記切記!!!)。第一、打開應用程序的工程選項的 CodeGuard 頁框,把 CodeGuard Validation 前面打勾 工程選項里,還有其他三個選項。第一個選項允許 CodeGuard 檢查指向局部、全局和靜態變量的無效指針和數據溢出。第二個選項允許 CodeGuard 檢測對非法的(無效的、已刪除的)對象的方法的調用。第三個選項允許 CodeGuard 驗證內嵌指針的訪問(在某些資料上說,開啟這個選項會造成程序執行速度變得很慢,我測試過了,如果工程不是很大的話不是很明顯,可以接受。)一般的調試是開打所有的選項(默認選擇也是全部打開)。 通過 CodeGuard 的配置工具,可以配置 CodeGuard 的一些選項,在命令行方式執行 CGCONFIG.EXE 。可以見到一個對話框 Preferences 標簽頁用于設置 CodeGuard 這個工具的全局選項。 Enable 選項可以在應用程序不重新編譯的情況下使用或者不使用 CodeGuard ,一般來說是都是啟用她。如果使用 CodeGuard 的話,建議設置工程選項來禁止或者使用 CodeGuard 。 Stack fill frequency 填充棧頻率是檢測對運行期棧的無效訪問。 Report 和 Error Message Box 選項是設置 CodeGuard 報告錯誤的方式。在 Report 里, Stiatistics 選項打開 CodeGuard 輸出分配和釋放內存的統計表、被使用的 Win32API 的調用、資源的使用情況,并在日志文件中加上一個模塊列表,以便檢查錯誤。 Resource Leaks 選項是告訴 CodeGuard 在應用程序結束后報告資源泄漏的情況。選定了 Error Message Box 選項后,當應用程序不在 IDE 里運行時,如果 CodeGuard 檢測到錯誤信息,那么將采用一個對話框的方式告訴使用者。其他選項一般不常用,可以參見 C++Builder 的聯機 HELP 。 CodeGuard 配置工具中的 Resource Options 和 Function Options 頁框允許用戶對應用程序的資源、文件和函數調用設置各種跟蹤選項。除非特殊的原因需要改變默認的配置,否則使用缺省的設定就行了。 Function Options 頁上有一個比較常用的選項就是記錄一個特定函數的每次調用情況。 Ignored Modules 頁框允許你告訴 CodeGuard ,當檢測的時候可以忽略一些運行期的錯誤(一般是指某些 DLL 或者包)。這個選項一般不常用。 四、 使用 CodeGuard 使用 CodeGuard 其實很簡單,只要像之前那樣配置了 CodeGuard ,然后運行你的應用程序,無論你的應用程序是否在 IDE 中運行, CodeGuard 都將會按照 CodeGuard 配置的選項監視你的應用程序。同時,他還會向一個日志文件里輸出所有的信息(文件存放在你的工程所在目錄中,文件名和工程名一樣,擴展名為 .cgl )。例如你的工程名為 C:\Word\Test.prg ,那么 CodeGuard 的日志文件為 C:\Word\Test.cgl ,它是一個文本文件,可以用任何的文本編輯器來編輯它。 在 IDE 中,可以通過 < 菜單 >View->Debug Window->CodeGuard Log 來查看 CodeGuard 的日志文件(或者用快捷鍵 Ctrl+Atl+O )。 如果你的程序在運行是出現屬于 CodeGuard 監視的錯誤的時候, CodeGuard 會把它輸出到 CodeGuard Log 中。并將錯誤信息用一顆“樹”的方式顯示(使用很方便,就像使用 Windows 的資源管理器一樣簡單)。每個錯誤都可以展開,以顯示某種錯誤類型所特有的一些信息。例如:一個資源那個地方使用了、分配以及釋放;發生錯誤時的棧信息;并且指出了出錯的代碼行。這樣就可以很快的找到錯誤的根源! CodeGuard Log 窗口上有兩個按鈕 Stop 和 Clear 。當 Stop 選中的時候,如果這個時候程序遇到了錯誤, CodeGuard 將停止應用程序。如果未選中,那么程序就算遇到了錯誤也會繼續,這樣可以運行一次記錄很多錯誤信息。當 Clear 選中的時候,應用程序每次重新運行將清空日志中的信息。 在 CodeGuard Log 窗口中,雙擊單個錯誤的節點的時候,如果存在源代碼的話, IDE 窗口會自動跳到那一行代碼上。如果不存在源代碼的話,則顯示 CPU 窗口。圖三中,出現的錯誤是資源泄漏。當你的鼠標雙擊 Tform1 : Button1Click 這一行的時候,會自動跳到源代碼中出現錯誤的那一行。 當 CodeGuard 檢測到一個錯誤的時候,并找到出現問題的源代碼時,剩下的工作就是如果改正你的代碼。這個過程可以配合監視和數據斷點來實現,效果更加好! 五、 CodeGuard 中的錯誤以及原因 CodeGuard 可以檢測到很多運行期的錯誤!通常很容易就可以從 CodeGuard 的含義找出錯誤的根源。對于大多數的錯誤, CodeGuard 一般會顯示的包括:發生錯誤的地方、資源分配、資源釋放、資源被分配以及被訪問字節數。 1. Access In Freed Memory 如果內存被釋放了,在后面還繼續訪問,就會發生這個錯誤。在 C/C++ 中,通常使用 new 或者 malloc 分配內存,用 delete 和 free 釋放。以下是一個訪問了被釋放的內存的例子: void foo() { TMyClass *MyClass = new TMyClass(); delete MyClass; MyClass->xxxx = 10; //MyClass 已經被釋放了 } CodeGuard 會報告已被釋放的內存在何處被訪問,內存原來被分配的地方以及內存在哪里被釋放的。 2. Method Called On Freed Object 這個錯誤跟前一個錯誤類似。起因是由于調用了已被釋放的對象的方法而不是訪問已被釋放的內存! void foo() { TMyClass *MyClass = new TMyClass(); delete MyClass; MyClass->xxxx (10); } CodeGuard 將顯示在何處調用了已釋放對象的方法,對象被創建的地方以及對象被釋放的地方。 3. Reference To Freed Resource 在程序中試圖多次(兩次以上)釋放同一個資源, CodeGuard 將檢測到這個錯誤,有好幾種方法都會產生這個錯誤!例如: void foo() { TMyClass *MyClass = new TMyClass(); delete MyClass; delete MyClass; } CodeGuard 將報告資源在何處第二次被釋放,從而引起這個錯誤的。還會報告資源在何處分配,在何處首次釋放。 4. Method Called On Illegally Casted Object 如果在程序中對有效的內存范圍之外的方法的調用將會引起這個錯誤。 void foo() { TMyClass *MyClass = new TMyClass[5]; MyClass[5].xxxx(); //No such MyClass[5] delete []MyClass; } CodeGuard 將報告對象調用的方法定義的地方,以及這個方法被調用的地方以及對象或者內存被分配地方。 5. Resource Type Mismatch 如果在程序中釋放資源和定義(分配)時候不一致,會出現這個錯誤。 void foo() { TMyClass *MyClass = new TMyClass[2]; delete MyClass; //Code1 TMyClass *MyClass = new TMyClass(); delete []MyClass; //Code2 } 在 Code1 以及 Code2 都會引發 Resource Type Mismatch 錯誤, CodeGuard 將會報告資源在何處以不一致的方式被釋放,以及資源是在哪里被分配的地方。 6. Access Overrun 當訪問非法內存區域的內存時會造成這個錯誤(所訪問的內存在合法內存區域之后),通常情況下是數組下標引用超出原來定義的。 void foo() { TMyClass *MyClass = new TMyClass[2]; MyClass[2].abc = 10; //No such MyClass[2] delete [] MyClass; char *ch = new char[5]; strcpy(ch, “123456”); //Error delete []ch; } CodeGuard 報告出錯的地方,資源在哪里分配的。 7. Access Underrun 當訪問非法內存區域的內存時會造成這個錯誤(所訪問的內存在合法內存區域之前)。 void foo() { TMyClass *MyClass = new TMyClass[2]; MyClass[-1].abc = 10; //No such MyClass[2] delete [] MyClass; } CodeGuard 報告出錯的地方,資源在哪里分配的。 8. Uninitialized Stack Accessing 訪問棧中為被初始化的區域將會造成這個錯誤。 void foo1(int **Ptr) { int Var; *Ptr = &Var; } void foo() { int *Ptr; foo1(&Ptr); *Ptr = 100; } CodeGuard 將會報告何處訪問還沒有被初始化的棧。 9. Access In Invalid Stack 當在程序中嘗試訪問棧底部的內存的時候出現這個錯誤! void foo() { char str[20]; strcpy(&str[-1], “szbug”); } CodeGuard 報告發生錯誤的地方。 10. Bad Parameter 這個錯誤通常是出現無效的文件或者其他資源句柄作為參數傳遞給 VCL 或者 Win32API 函數時發生的。 Void foo() { FILE *Stream; fclose(Stream); } CodeGuard 將報告使用了不正確參數的函數在何處被調用。 11. Function Failure 這個錯誤是 CodeGuard 在捕獲 VCL 以及 Win32API 函數的返回值如果出現錯誤時引發的。 viod foo() { CopyFile(“c:\abc\abc.txt”, “d:\abc\acb.txt”, true); // 如果這個函數由于某種原因失敗了, // 那么 CodeGuard 將會捕獲并報告 Function Failure 錯誤! } 12. Resource Leak 如果在程序中資源(包括 Winwos 資源,內存資源等等),分配了,在程序的最后沒有釋放!將引發 Resource Leak 錯誤。 Void foo() { char *ch = new char[10]; } CodeGuard 將報告資源創建的地方,以及所泄漏的字節數。 六 運行后會生產同名的CGL文件,里面包括函數的調用次數和使用到的DLL.如果有泄露的話,會指出在來!!!! Functions called: delete (35 times) SysReallocMem (26 times) SysFreeMem (464 times) SysGetMem (472 times) realloc (1 times) memcpy (1 times) delete[] (2 times) free (26 times) new[] (14 times) new (40 times) calloc (5 times) malloc (20 times) Resource types used: object array (14 allocs, 13 max) object (40 allocs, 28 max) Modules used: 00400000 02/07/2003 09:56:24 D:\Project1.exe 01190000 02/01/2002 22:00:00 C:\Program Files\Borland\Delphi7\Bin\BORLNDMM.DLL 0CD00000 02/01/2002 22:00:00 C:\PROGRA~1\Borland\CBUILD~1\Bin\CG32.DLL 10000000 03/09/2001 18:42:32 C:\WINNT\mui\fallback\0404\msctf.dll.mui 32600000 08/20/2002 16:40:24 C:\WINNT\System32\CC3260MT.DLL 37210000 12/28/2002 18:25:22 C:\WINNT\DOWNLO~1\CnsMin.dll 40000000 10/21/2002 06:03:00 C:\WINNT\System32\rtl60.bpl 400B0000 02/01/2002 22:00:00 C:\WINNT\System32\vcl60.bpl 60000000 03/09/2001 17:06:24 C:\WINNT\System32\MSCTF.dll 70BD0000 08/29/2002 09:33:44 C:\WINNT\system32\SHLWAPI.DLL 71710000 08/29/2002 09:33:44 C:\WINNT\system32\comctl32.dll 74FA0000 01/10/2000 20:00:00 C:\WINNT\System32\WS2HELP.DLL 74FB0000 07/22/2002 12:05:04 C:\WINNT\System32\WS2_32.DLL 74FD0000 07/22/2002 12:05:04 C:\WINNT\System32\wsock32.dll 75010000 07/22/2002 12:05:04 C:\WINNT\system32\mpr.dll 75280000 01/10/2000 20:00:00 C:\WINNT\System32\oledlg.dll 75950000 01/10/2000 20:00:00 C:\WINNT\system32\LZ32.DLL 75E00000 07/22/2002 12:05:04 C:\WINNT\System32\IMM32.DLL 76AF0000 07/22/2002 12:05:04 C:\WINNT\system32\comdlg32.dll 777C0000 11/01/2002 16:41:30 C:\WINNT\System32\winspool.drv 777E0000 01/10/2000 20:00:00 C:\WINNT\system32\version.dll 77990000 07/22/2002 12:05:04 C:\WINNT\system32\oleaut32.dll 77A30000 07/22/2002 12:05:04 C:\WINNT\system32\ole32.dll 77D90000 11/11/2002 15:34:36 C:\WINNT\system32\advapi32.dll 77DF0000 11/04/2002 10:59:22 C:\WINNT\system32\user32.dll 77E60000 11/04/2002 10:59:30 C:\WINNT\system32\kernel32.dll 77F40000 07/23/2002 16:34:08 C:\WINNT\system32\GDI32.dll 77F80000 07/22/2002 12:05:04 C:\WINNT\System32\ntdll.dll 78000000 07/22/2002 12:05:04 C:\WINNT\system32\MSVCRT.DLL 786F0000 07/22/2002 12:05:04 C:\WINNT\system32\RPCRT4.dll 78F90000 12/11/2002 17:50:30 C:\WINNT\system32\SHELL32.DLL ==========================================
七、 CodeGuard 還可以檢測到應用程序的很多錯誤 ,這里只說說一些常見的錯誤,其他的錯誤和例子請參見 C++Builder 的 HELP 。希望大家通過 CodeGuard 找出程序中的錯誤以及 Bug !!!希望大家的程序越來越強壯,越來越穩定。。。呵呵 |