spl/collection/MemoryPool.h

/*
 *   This file is part of the Standard Portable Library (SPL).
 *
 *   SPL is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   SPL is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with SPL.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef _memorypool_h
#define _memorypool_h

#include <spl/types.h>
#include <spl/Debug.h>
#include <spl/collection/Array.h>
#include <spl/Memory.h>

typedef struct MemoryBlock
{
        int32 m_blockId;                
        byte* m_data;                   
        int m_size;                             
        int m_freeSize;                 
        int m_pos;                              
        MemoryBlock *m_next;    
        int m_checkBits;
} MemoryBlock;

static const int DEFAULT_MEMORY_POOL_BLOCK_SIZE = 1024 ;        

class MemoryPool : public IMemoryValidate
{
private:
        // Copy constructor doesn't make sense for this class
        inline MemoryPool(const MemoryPool& mp) {}
        inline void operator =(const MemoryPool& mp) {}

    MemoryBlock m_head;  

    int m_totalMemoryPoolSize ;  
    int m_usedMemoryPoolSize ;   
    int m_freeMemoryPoolSize ;   

    int m_memoryBlockSize ;     
    int m_memoryBlockCount ;  

        bool m_setMemoryData ;                      

        MemoryBlock *AllocateBlock(int size);

public:
    MemoryPool(const int blockSize = DEFAULT_MEMORY_POOL_BLOCK_SIZE, bool bSetMemoryData = false);    
        virtual ~MemoryPool();

    void *Malloc(int size) ;
    
        void Free(void *ptr);

    bool WriteMemoryDumpToFile(const char *fileName) const;

        bool IsValidPointer(const void *ptr) const;
 
#ifdef DEBUG
        virtual void ValidateMem () const;
        virtual void CheckMem () const;
#endif
};

void *operator new (size_t size, MemoryPool& pool);
void operator delete (void *ptr, MemoryPool& pool);

REGISTER_TYPEOF( 400, MemoryPool );

#endif