GUIMemLeakDetection.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef GUIMEMLEAKDETECTION__H_
#define GUIMEMLEAKDETECTION__H_
 
#include "eC_Types.h"
#include "eC_File.h"
 
#define LEAK_DETECTION CGUIMemLeakDetection::GetInstance()
 
 
 
class CGUIMemLeakDetection
{
public:
    /* The memory allocation functions need to access the private memory management methods
        in this class, thus they are friend to this class.
    */
 
    friend void* Guiliani_malloc(size_t uiSize, const char* pFile, int iLine, const char* pFunction);
    friend void Guiliani_free(void* pMemory, const char* pFile, int iLine, const char* pFunction);
    friend void* Guiliani_realloc(void* pMemory, size_t uiSize, const char* pFile, int iLine, const char* pFunction);
    friend void* Guiliani_new(size_t uiSize, const char* pFile, int iLine, const char* pFunction);
    friend void* Guiliani_newArray(size_t uiSize, const char* pFile, int iLine, const char* pFunction);
    friend void Guiliani_delete(void* pMemory, const char* pFile, int iLine, const char* pFunction);
    friend void Guiliani_deleteArray(void* pMemory, const char* pFile, int iLine, const char* pFunction);
 
    friend void* operator new(size_t uiSize, const char* pcFile, int iLine, const char* pcFunction);
 
    friend void* operator new[](size_t uiSize, const char* pcFile, int iLine, const char* pcFunction);
 
    friend void operator delete(void* Memory) throw();
 
    friend void operator delete[](void* Memory) throw();
 
    void WriteResultsToFile(const eC_Char* sFilename = "MemoryAnalysisResults.log", const eC_Bool& bAsTable = true);
 
    void ShowResults();
 
    const eC_UInt GetUsedMemory() const;
 
    const eC_UInt GetMaxObject() const;
 
    const eC_UInt GetLargestObject() const;
 
    const eC_UInt GetCurrentlyLargestObject() const;
 
    void SetActive(const eC_Bool& bActive);
 
public:
    static CGUIMemLeakDetection& GetInstance()
    {
#ifdef GUILIANI_MEMORY_ALLOCATION_LOGGING
        static CGUIMemLeakDetection s_MemLeakDetection(true);
#else
        static CGUIMemLeakDetection s_MemLeakDetection(false);
#endif
        return s_MemLeakDetection;
    }
 
private:
    struct BlockHead_t
    {
        eC_UInt m_uiMagicNumber;
 
        size_t m_uiObjectSize;
    };
 
    struct BlockInfo_t
    {
        BlockInfo_t()
        {
            m_pcFilename = NULL;
            m_uiLine = 0;
            m_pcFunction = NULL;
            m_pMemoryAddress = NULL;
            m_uiObjectSize = 0;
            m_bIsArrayAlloc = false;
        }
 
        bool operator==(const BlockInfo_t& kValue) const
        {
            return m_pMemoryAddress == kValue.m_pMemoryAddress;
        }
 
        const eC_Char* m_pcFilename;
 
        eC_UInt m_uiLine;
 
        const eC_Char* m_pcFunction;
 
        void* m_pMemoryAddress;
 
        size_t m_uiObjectSize;
 
        eC_Bool m_bIsArrayAlloc;
    };
 
private:
    static const eC_UInt ms_cuiMagicNr = 395743214;
 
private:
    void* MemAlloc(
        size_t Size,
        const eC_Char* pFile,
        eC_Int iLine,
        const eC_Char* pFunction,
        const eC_Char* pNewTypeName,
        eC_Bool bIsArray);
 
    void FreeMem(
        void* pMemory,
        const eC_Char* pFile,
        eC_Int iLine,
        const eC_Char* pFunction,
        const eC_Char* pDeleteTypeName,
        eC_Bool bIsArray);
 
    void* MemRealloc(
        void* pMemory,
        size_t uiSize,
        const eC_Char* pFile,
        eC_Int iLine,
        const eC_Char* pFunction);
 
    CGUIMemLeakDetection(const eC_Bool& rkLogging);
 
    CGUIMemLeakDetection(const CGUIMemLeakDetection& kSource);
 
    CGUIMemLeakDetection& operator=(const CGUIMemLeakDetection& kSource);
 
    ~CGUIMemLeakDetection();
 
private:
    eC_File* m_pkOutputFile;
 
    const eC_Bool m_bLogState;
 
    eC_UInt m_uiMemoryAllocSteps;
 
    eC_UInt m_uiMemoryAllocStepsCounterDelete;
 
    eC_UInt m_uiMemoryAllocStepsCounterNew;
 
    BlockInfo_t** m_kList;
 
    eC_UInt m_uiCurrentListSize;
 
    eC_UInt m_uiFirstFreeIndexInList;
 
    size_t m_uiUsedMemory;
 
    size_t m_uiMaxMem;
 
    size_t m_uiCurrentlyLargestObject;
 
    size_t m_uiLargestObject;
 
    eC_Int m_iAllocatedBlockCount;
};
 
#endif