MemoryLeakIndicator.h

gehe zur Dokumentation dieser Datei

#ifndef INC_MEMORYLEAKINDICATOR_H
#define INC_MEMORYLEAKINDICATOR_H
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
#ifdef _MSC_VER
  /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
  #pragma warning( disable : 4251 )
#endif
//-----------------------------------------------------------------------------
#if __cplusplus >= 201103L
  #include <mutex>
#endif
#include <unordered_map>
 
#if defined(_MSC_VER) || defined(__MINGW32__) || defined(__MINGW64__)
  #include <basetsd.h>
#elif defined(__GNUC__)
  #define INT_PTR intptr_t
#endif
#include <stdarg.h>
#include <windows.h>
//-----------------------------------------------------------------------------
// DLL Define __MEM_LEAK_INDICATOR_EXPORT_DLL
#if defined(_MSC_VER) || defined(__MINGW32__) || defined(__MINGW64__)
  #ifdef __MEM_LEAK_INDICATOR_EXPORT_DLL
    #define __mem_leak_indicator_export_dll  __declspec(dllexport)
    #if defined(_MSC_VER)
      #pragma message ( "Benutze Export defines fuer __mem_leak_indicator_export_dll" )
    #endif
  #else
    #define __mem_leak_indicator_export_dll  //__declspec(dllimport)
    #if defined(_MSC_VER)
      #pragma message ( "Benutze Import defines fuer __mem_leak_indicator_export_dll" )
    #endif
  #endif
#elif defined(__GNUC__)
  #ifdef __MEM_LEAK_INDICATOR_EXPORT_DLL
    #define __mem_leak_indicator_export_dll  //__attribute__ ((visibility("default")))
  #else
    #define __mem_leak_indicator_export_dll  //__attribute__ ((visibility ("hidden")))
  #endif
#endif
//-----------------------------------------------------------------------------
#ifndef NULL_PTR
  #if __cplusplus >= 201103L
    #define NULL_PTR nullptr
  #else
    #define NULL_PTR NULL
  #endif // __cplusplus >= 201103L
#endif
//-----------------------------------------------------------------------------
namespace MemSpy
{
  //---------------------------------------------------------------------------
  typedef bool TbExceptionMode;
  //---------------------------------------------------------------------------
  const TbExceptionMode NOTHROW = false;
  //---------------------------------------------------------------------------
  const TbExceptionMode THROW = true;
  //---------------------------------------------------------------------------
 
  //---------------------------------------------------------------------------
  typedef int TiOutput;
  //---------------------------------------------------------------------------
  const TiOutput OUTPUT_NON = 0;
  //---------------------------------------------------------------------------
  const TiOutput OUTPUT_CONSOLE = 1;
  //---------------------------------------------------------------------------
  const TiOutput OUTPUT_TRACE = 2;
  //---------------------------------------------------------------------------
 
  //---------------------------------------------------------------------------
  enum SeekMode
  {
    START,
    NEXT,
    CURRENT
  };
  //---------------------------------------------------------------------------
 
  //---------------------------------------------------------------------------
  class __mem_leak_indicator_export_dll Trace
  {
    public:
      void operator()( PCSTR pszFormat, ... );
      void operator()( PCWSTR pszFormat, ... );
  };
 
  //---------------------------------------------------------------------------
  class __mem_leak_indicator_export_dll LeakMap
  {
    public:
      //-----------------------------------------------------------------------
      // >>>>>>>>>>>>>>>>>>>>>>>>> MemoryItem >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
      //-----------------------------------------------------------------------
      struct MemoryItem
      {
        //============== Attribute
        //---------------------------------------------------------------------
        INT_PTR m_pItemPtr;
        //---------------------------------------------------------------------
        char const * m_FileName;
        //---------------------------------------------------------------------
        int m_iLineNumber;
        //---------------------------------------------------------------------
      };
      //-----------------------------------------------------------------------
      // <<<<<<<<<<<<<<<<<<<<<<<<< MemoryItem <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
      //-----------------------------------------------------------------------
 
    private:
      //============== Attribute
      //-----------------------------------------------------------------------
      #if __cplusplus >= 201103L
        std::mutex m_LocalCriticalSection;
      #else
        CRITICAL_SECTION m_LocalCriticalSection;
      #endif
      //-----------------------------------------------------------------------
      std::unordered_map< INT_PTR, MemoryItem * > m_ObjectList;
      //-----------------------------------------------------------------------
      std::unordered_map< INT_PTR, MemoryItem * >::iterator m_ObjectListIterator;
      //-----------------------------------------------------------------------
      unsigned long long m_ullInsertCounter;
      //-----------------------------------------------------------------------
 
      //========== static Attribute =========
      //-----------------------------------------------------------------------
       static bool ms_bUseLeakMap;
      //-----------------------------------------------------------------------
      static int ms_iReferenceCounter;
      //-----------------------------------------------------------------------
 
    protected:
      //============== Konstruktoren
      //-----------------------------------------------------------------------
      LeakMap();
      //-----------------------------------------------------------------------
      virtual ~LeakMap();
      //-----------------------------------------------------------------------
 
    private:
      //============== Konstruktoren
      //-----------------------------------------------------------------------
      LeakMap( const LeakMap & );
      //-----------------------------------------------------------------------
 
    public:
      //========== static Methoden =========
      //-----------------------------------------------------------------------
      static LeakMap * create();
      //-----------------------------------------------------------------------
      static int destroy();
      //-----------------------------------------------------------------------
      static void destroyAbsolutely();
      //-----------------------------------------------------------------------
      static LeakMap * getGlobalLeakMapInstance();
      //-----------------------------------------------------------------------
 
    public:
      //============== Methoden
      //-----------------------------------------------------------------------
      void setLeakMapUseAllowed( bool bAllowed = true );
      //-----------------------------------------------------------------------
      bool leakMapUseAllowed() const;
      //-----------------------------------------------------------------------
      unsigned long long numberOfProcessedObjects() const;
      //-----------------------------------------------------------------------
      std::size_t sizeOfObjectList() const;
      //-----------------------------------------------------------------------
      MemoryItem * getSpyObject( SeekMode eMode );
      //-----------------------------------------------------------------------
      MemoryItem * getSpyObject( INT_PTR ipAddress );
      //-----------------------------------------------------------------------
      void insertSpyObject( void * pNewObject, char const * chFileName, int iLine );
      //-----------------------------------------------------------------------
      void removeSpyObject( void * pObjectToDelete );
      //-----------------------------------------------------------------------
 
    private:
      //============== Operatoren
      //-----------------------------------------------------------------------
      LeakMap & operator= ( const LeakMap & );
      //-----------------------------------------------------------------------
  };
  //---------------------------------------------------------------------------
  
  //---------------------------------------------------------------------------
  __mem_leak_indicator_export_dll MemSpy::LeakMap * activateMemoryMonitoring( MemSpy::TbExceptionMode bExceptionMode = MemSpy::THROW );
  //---------------------------------------------------------------------------
  void __mem_leak_indicator_export_dll finishMemoryMonitoring( MemSpy::TiOutput iOutput = MemSpy::OUTPUT_CONSOLE );
  //---------------------------------------------------------------------------
} // namespace MemSpy
//-----------------------------------------------------------------------------
#ifdef _MSC_VER
  /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
  #pragma warning( default : 4251 )
#endif
//-----------------------------------------------------------------------------
#endif