MemTest

Documentation

About

MemTest (which obviously is short for Memory Tester) is a memory leak/corruption detection system for C++/C programs. It is a cpp file and a header file which, when included in other source code files, will track all the usage of memory allocations/deallocations to tell the user if there were any memory leaks or memory corruptions within the code.

It does this by tracking all calls to new/delete/malloc/realloc/calloc/free. Of course, this adds a minor slowdown to whatever program it is being used in, but the slowdown is minor, and far worth the benefit. I'm using it in my own programs and am quite pleased.

Features

• Uses:
• Undeleted memory (memory leaks)
• Inappropriate new/delete combinations (ie: allocating with new[], and deleting with delete)
• Memory underflows (changing memory before the pointer)
• Memory overflows (changing memory after the end of the data)
• Debug case to randomly initialize memory to "garbage"
• Debug case to cause random failures (based on a percent failure rate)
• Debug case to cap memory allocation size, and fail to create memory after reaching that point
• Dumping all memory to a text file
• Dumping statistics to a text file
• Various forms of output including stdout, stderr, and a log file
• Other features
• Multithreading safe
• Throw/nothrow safe
• Designed to work with 32 bit and 64 bit systems (untested.. someone let me know?)
• Designed to work with Linux/Unix, Mac, and Windows.
• (Other than that it's just a memory manager..)

To Use

To use simply #include memtest.h at the beginning of each cpp file in your project. The #include should be after all other includes.

Functions

Most functions are built in and well documented within memtest.cpp. You may want to use the following functions in addition to the automatic ones.

This function is used to dump a memory report to a filename. This is done at the end of the program if the appropriate flag is set in memtest.cpp. It can be done in the middle of the application running here. If stats=true it will about program statistics. If leaks=true, it will output all current memory leaks (which will be a great deal if this is called in the middle of the program). If mem is true, it will do a hex memory dump of all allocated memory on the heap. This may take a large amount of hard drive space to do (so only use it if you need it).

Returns the number of bytes currently allocated in the program.

Returns the maximum number of bytes allocated by your program at any one time. This can be used as a system to accurately detect how much memory on the heap your program uses.

Return the total bytes allocated throughout the duration of the program. This number will always be greater or equal to the number returned by getMaximumAllocBytes()

License

This software is licensed under the LGPLv3

Download

Versions

Contact