NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
CObjectMemoryPool Class Reference

Search Toolkit Book for CObjectMemoryPool

#include <corelib/ncbimempool.hpp>

+ Inheritance diagram for CObjectMemoryPool:
+ Collaboration diagram for CObjectMemoryPool:

Public Member Functions

 CObjectMemoryPool (size_t chunk_size=0)
 constructor More...
 
 ~CObjectMemoryPool (void)
 destructor More...
 
size_t GetChunkSize (void) const
 configurable parameters More...
 
void SetChunkSize (size_t chunk_size)
 Change chunks' size. More...
 
size_t GetMallocThreshold (void) const
 Get threshold for direct allocation from system heap. More...
 
void SetMallocThreshold (size_t malloc_threshold)
 Change threshold for direct allocation from system heap. More...
 
void * Allocate (size_t size)
 Allocate memory block. More...
 
void Deallocate (void *ptr)
 Deallocate memory block. More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Static Public Member Functions

static void Delete (const CObject *object)
 Check if object is allocated from some memory pool, and delete it correspondingly. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 

Private Member Functions

 CObjectMemoryPool (const CObjectMemoryPool &)
 
void operator= (const CObjectMemoryPool &)
 

Private Attributes

size_t m_ChunkSize
 
size_t m_MallocThreshold
 
CRef< CObjectMemoryPoolChunkm_CurrentChunk
 

Additional Inherited Members

- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1, eAllocFillZero, eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 54 of file ncbimempool.hpp.

Constructor & Destructor Documentation

CObjectMemoryPool::CObjectMemoryPool ( size_t  chunk_size = 0)

constructor

Parameters
chunk_sizeSize of chunks to allocate from system heap. If it's zero, use some default size.

Definition at line 214 of file ncbimempool.cpp.

References SetChunkSize().

CObjectMemoryPool::~CObjectMemoryPool ( void  )

destructor

Definition at line 220 of file ncbimempool.cpp.

CObjectMemoryPool::CObjectMemoryPool ( const CObjectMemoryPool )
private

Member Function Documentation

void * CObjectMemoryPool::Allocate ( size_t  size)
void CObjectMemoryPool::Deallocate ( void *  ptr)

Deallocate memory block.

Deallocated momory is not reused, but block counter is decremented, and if it goes to zero, full memory chunk is freed.

Definition at line 276 of file ncbimempool.cpp.

References CObjectMemoryPoolChunk::DecrementObjectCount(), and CObjectMemoryPoolChunk::GetChunk().

void CObjectMemoryPool::Delete ( const CObject object)
static

Check if object is allocated from some memory pool, and delete it correspondingly.

Definition at line 285 of file ncbimempool.cpp.

References CObject::CObject(), Critical(), CObjectMemoryPoolChunk::DecrementObjectCount(), ERR_POST_X, and CObjectMemoryPoolChunk::GetChunk().

Referenced by CObject::DeleteThis().

void CObjectMemoryPool::operator= ( const CObjectMemoryPool )
private
void CObjectMemoryPool::SetChunkSize ( size_t  chunk_size)

Change chunks' size.

Parameters
chunk_sizeSize of chunks to allocate from system heap. If it's zero, use some default size.

Definition at line 225 of file ncbimempool.cpp.

References chunk_size, kDefaultChunkSize, kMinChunkSize, m_ChunkSize, and SetMallocThreshold().

Referenced by CObjectMemoryPool().

void CObjectMemoryPool::SetMallocThreshold ( size_t  malloc_threshold)

Change threshold for direct allocation from system heap.

Parameters
malloc_thresholdObjects with size greater than this value will be allocated directly from system heap. If it's zero, use some default threshold.

Definition at line 238 of file ncbimempool.cpp.

References kDefaultThresholdRatio, kMinThreshold, kMinThresholdRatio, m_ChunkSize, and m_MallocThreshold.

Referenced by SetChunkSize().

Member Data Documentation

size_t CObjectMemoryPool::m_ChunkSize
private

Definition at line 99 of file ncbimempool.hpp.

Referenced by Allocate(), GetChunkSize(), SetChunkSize(), and SetMallocThreshold().

CRef<CObjectMemoryPoolChunk> CObjectMemoryPool::m_CurrentChunk
private

Definition at line 101 of file ncbimempool.hpp.

Referenced by Allocate().

size_t CObjectMemoryPool::m_MallocThreshold
private

Definition at line 100 of file ncbimempool.hpp.

Referenced by Allocate(), GetMallocThreshold(), and SetMallocThreshold().


The documentation for this class was generated from the following files:
Modified on Tue May 22 12:46:26 2018 by modify_doxy.py rev. 546573