Polaris: HeapStats.h Source File

HeapStats.h Go to the documentation of this file. /// /// #ifndef HEAPSTATS_H #define HEAPSTATS_H /// /// \class HeapStats /// \brief A module for detecting and finding memory leaks /// \defgroup Polaris /// \ingroup Polaris /// Base /// \see HeapStats.h /// \see HeapStats.h /// \see HeapStats.cc /// /// \endcode /// \section Overview Overview /// This module keeps tracks of the number of new\'s and delete\'s a /// program has generated. The module also keeps track of the /// addresses of objects that have been allocated but not deleted. /// This module is primarily used for spotting memory leaks. /// /// \endcode /// \section Description Description /// The tracking the number of new\'s and delete\`s in a program can /// be started and stopped by the functions HeapStats::start() and /// HeapStats::stop(). These numbers can be printed out by the /// HeapStats::report() function. They can also be set back to zero /// by the HeapStats::reset() function. /// /// In addition to keeping track of the numbers of new\`s and /// delete\`s in a program, HeapStats also keeps track of the /// addresses and sizes of objects that have been allocated but not /// deleted. The function HeapStats::print_memory_leaks() can be /// used to print out these undeleted objects. Like the tracking /// of the numbers of new\`s and delete\`s, the collection of these /// statistics is controlled by the start(), stop(), and reset() /// functions. /// #ifdef POLARIS_GNU_PRAGMAS #pragma interface #endif /// #include <new> #include <iostream.h> #include <stdlib.h> #include "Listable.h" #include "Collection/Map.h" #include "Collection/Zombie.h" /// typedef int HeapObject; /// class HeapElem : public Listable { public: void *ptr; ///< size_t size; unsigned int size; Listable* listable_clone() const; void print(ostream &o) const; }; class HeapStats { ///< friend void* operator new(size_t); friend void* operator new(unsigned int) throw (std::bad_alloc); friend void operator delete(void *) throw (); ///< friend void remember_memory( void *ptr, size_t size ); friend void remember_memory( void *ptr, unsigned int size ); ///< friend void* recall_memory( size_t size ); friend void* recall_memory( unsigned int size ); public: static void start(); ///< Start collecting statistics. static void stop(); ///< Stop collecting statistics. static void start_news(); ///< Start collecting "new" statistics static void start_dels(); ///< Start collecting delete statistics static void stop_news(); ///< Stop collecting "new" statistics static void stop_dels(); ///< Stop collecting delete statistics static void restart(); ///< Start collecting statistics again. Functions identically ///< to HeapStats::start(). static void report(ostream &o = cout); ///< Print out number of new\'s and delete\'s static void reset(void); ///< Reset the counters static int memory_leak(void); ///< Return TRUE if number of new\'s do not match number of ///< delete\'s static void print_memory_leaks(ostream &o = cout); ///< Print all memory leaks that has been detected. private: static int collect_dels; ///< True if HeapStats should collect statistics on deletes static int collect_news; ///< True if HeapStats should collect statistics on news static int num_news; ///< # of calls to operator new static int num_deletes; ///< # of calls to operator delete static Map<HeapObject,HeapElem> *objs; ///< List of objects allocated on heap ///< static void *_hs_new(size_t); static void *_hs_new(unsigned int); ///< static void *_hs_record( void *new_obj, size_t sz ); static void *_hs_record( void *new_obj, unsigned int sz ); static void _hs_delete(void *); static void _hs_remove(void *); }; #endif

© 1995-2005 University of Illinois, Urbana-Champaign. All rights reserved.  Fri Mar 25 23:05:54 2005