C++Builder 内存泄漏检查工具-CodeGuard

关于如何在BCB中使用CodeGuard

一、为什么写这篇东西

自己在使用BCB5写一些程序时需要检查很多东西，例如内存泄漏、资源是否有释放等等，在使用了很多工具后，发觉BCB5本身自带的工具——CodeGuard，非常不错，使用也挺方便的，但是摸索了很久（以及翻查了一些资料，包括HELP）才算是会用了。写这篇文章的目的希望有这方面的问题的朋友可以借鉴一下，大家互相学习，共同进步。我的联系方法：Email：[email protected]，希望志同道合的朋友来信互相交流。以下这篇文章算是拼凑出来的一篇文章，一些资料是在书上找的，一些是在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;

<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

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！！！希望大家的程序越来越强壮，越来越稳定。。。呵呵