prj/tech/libsrc/lgalloc/poolimp.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // $Source: x:/prj/tech/libsrc/lgalloc/RCS/poolimp.h $
   3 // $Author: TOML $
   4 // $Date: 1997/08/14 12:22:16 $
   5 // $Revision: 1.6 $
   6 //
   7 // Implementation details of allocation pools.  Most clients should only
   8 // concern themselves with pool.h
   9 //
  10
  11 #ifndef __POOLIMP_H
  12 #define __POOLIMP_H
  13
  14 #include <malloc.h>
  15 #include <heaptool.h>
  16
  17 #undef Free
  18
  19 ///////////////////////////////////////////////////////////////////////////////
  20 //
  21 // Macros to specify how pools should get thier memory.
  22 //
  23
  24 #ifndef _WIN32
  25 #define PoolCoreAllocPage()   malloc(kPageSize)
  26 #define PoolCoreFreePage(p)   free(p)
  27 #else
  28 #define PoolCoreAllocPage()   cPoolCore::AllocPage()
  29 #define PoolCoreFreePage(p)   cPoolCore::FreePage(p)
  30 #endif
  31
  32 ///////////////////////////////////////////////////////////////////////////////
  33 //
  34 // CLASS: cPoolAllocator
  35 //
  36 // Pooled Allocator to be used by operator new, operator delete overrides and
  37 // by the Multi-heap
  38 //
  39 // cPoolAllocator will keep a freelist of items of the same size.
  40 // When the freelist is empty it will alloc them in multiple blocks
  41 //
  42 // Instances of cPoolAllocator *must* be staticly allocated,
  43 // typically as static instance variables of the client class,
  44 // as there is no destructor and thus there would be a memory leak if NOT static.
  45 //
  46
  47 struct sPoolBlock;
  48
  49 class cPoolAllocator
  50 {
  51 public:
  52
  53     cPoolAllocator();
  54     cPoolAllocator(size_t elemSize); // How big will each item be, and howMany per alloc()'d Bucket
  55
  56     void Init(size_t elemSize);
  57
  58     void * Alloc();
  59     void Free(void *);
  60
  61     void DumpAllocs();
  62
  63     static void DumpPools();
  64
  65     #ifdef TRACK_ALLOCS
  66     // For debugging/optimization:
  67     unsigned long GetBlockNum();
  68     unsigned long GetTakes();
  69     unsigned long GetBlockSize();
  70     unsigned long GetFrees();
  71     unsigned long GetMaxTakes();
  72     #endif
  73
  74 private:
  75     void ThreadNewBlock();
  76
  77     sPoolBlock *    m_pFreeList;
  78     size_t          m_nElementSize;
  79     unsigned        m_nBlockingFactor;
  80
  81     cPoolAllocator * m_pNextPool;
  82
  83     #ifdef TRACK_ALLOCS
  84     unsigned long m_nBlocks;
  85     unsigned long m_nInUse;
  86     unsigned long m_nAllocs;
  87     unsigned long m_nFrees;
  88     unsigned long m_nMaxTakes;
  89     sPoolBlock *  m_pAllocList;
  90     #endif
  91
  92     static cPoolAllocator * m_pPools;
  93 };
  94
  95 ///////////////////////////////////////
  96
  97 inline cPoolAllocator::cPoolAllocator()
  98 {
  99
 100 }
 101
 102 ///////////////////////////////////////
 103
 104 inline cPoolAllocator::cPoolAllocator(size_t elemSize)
 105 {
 106     Init(elemSize);
 107 }
 108
 109 ///////////////////////////////////////
 110
 111 #ifdef TRACK_ALLOCS
 112 inline unsigned long cPoolAllocator::GetBlockNum()
 113 {
 114     return m_nBlocks;
 115 }
 116
 117 ///////////////////////////////////////
 118
 119 inline unsigned long cPoolAllocator::GetTakes()
 120 {
 121     return m_nAllocs;
 122 }
 123
 124 ///////////////////////////////////////
 125
 126 inline unsigned long cPoolAllocator::GetFrees()
 127 {
 128     return m_nFrees;
 129 }
 130
 131 ///////////////////////////////////////
 132
 133 inline unsigned long cPoolAllocator::GetMaxTakes()
 134 {
 135     return m_nMaxTakes;
 136 }
 137 #endif
 138
 139 ///////////////////////////////////////////////////////////////////////////////
 140
 141 #endif /* !__POOLIMP_H */