G3D::AreaMemoryManager Class Reference

Allocates memory in large blocks and then frees it as an area. More...

#include <AreaMemoryManager.h>

Classes
class	Buffer

Public Types
typedef shared_ptr < AreaMemoryManager >	Ref
Public Types inherited from G3D::MemoryManager
typedef shared_ptr< class MemoryManager >	Ref

Public Member Functions
	~AreaMemoryManager ()
size_t	bytesAllocated () const
virtual void *	alloc (size_t s)
virtual void	free (void *x)
virtual bool	isThreadsafe () const
void	deallocateAll ()
Public Member Functions inherited from G3D::ReferenceCountedObject
virtual	~ReferenceCountedObject ()

Static Public Member Functions
static AreaMemoryManager::Ref	create (size_t sizeHint=10 *1024 *1024)
Static Public Member Functions inherited from G3D::MemoryManager
static MemoryManager::Ref	create ()

Private Member Functions
	AreaMemoryManager (size_t sizeHint)

Private Attributes
size_t	m_sizeHint
Array< Buffer * >	m_bufferArray

Additional Inherited Members
Protected Member Functions inherited from G3D::MemoryManager
	MemoryManager ()

Detailed Description

Allocates memory in large blocks and then frees it as an area.

Useful for ensuring cache coherence and for reducing the time cost of multiple allocations and deallocations.

Not threadsafe

Member Typedef Documentation

typedef shared_ptr<AreaMemoryManager> G3D::AreaMemoryManager::Ref

Constructor & Destructor Documentation

G3D::AreaMemoryManager::AreaMemoryManager ( size_t  sizeHint )

private

 : m_sizeHint(sizeHint) {
 debugAssert(sizeHint > 0);
}

Here is the caller graph for this function:

G3D::AreaMemoryManager::~AreaMemoryManager

(

)

Invokes deallocateAll.

 {
 deallocateAll();
}

Here is the call graph for this function:

Member Function Documentation

void * G3D::AreaMemoryManager::alloc ( size_t  s )

virtual

Allocates memory out of the buffer pool.

Parameters

s	must be no larger than sizeHint

Reimplemented from G3D::MemoryManager.

 {
 void* n = (m_bufferArray.size() > 0) ? m_bufferArray.last()->alloc(s) : NULL;
 if (n == NULL) {
 // This buffer is full
 m_bufferArray.append(new Buffer(max(s, m_sizeHint)));
 return m_bufferArray.last()->alloc(s);
 } else {
 return n;
 }
}

Here is the call graph for this function:

size_t G3D::AreaMemoryManager::bytesAllocated

(

)

const

 {
 return m_sizeHint * m_bufferArray.size();
}

AreaMemoryManager::Ref G3D::AreaMemoryManager::create ( size_t  sizeHint = 10 * 1024 * 1024 )

static

Parameters

sizeHint

Total amount of memory expected to be allocated. The allocator will allocate memory from the system in increments of this size.

 {
 return shared_ptr<AreaMemoryManager>(new AreaMemoryManager(sizeHint));
}

Here is the call graph for this function:

void G3D::AreaMemoryManager::deallocateAll

(

)

Deletes all previously allocated memory. Because delete is not invoked on objects in this memory, it is not safe to simply free memory containing C++ objects that expect their destructors to be called.

 {
 m_bufferArray.invokeDeleteOnAllElements();
 m_bufferArray.clear();
}

Here is the caller graph for this function:

void G3D::AreaMemoryManager::free ( void *  x )

virtual

Ignored.

Reimplemented from G3D::MemoryManager.

 {
 // Intentionally empty; we block deallocate
}

Here is the caller graph for this function:

bool G3D::AreaMemoryManager::isThreadsafe ( ) const

virtual

Returns true if this memory manager is threadsafe (i.e., alloc and free can be called asychronously)

Reimplemented from G3D::MemoryManager.

 {
 return false;
}

Member Data Documentation

Array<Buffer*> G3D::AreaMemoryManager::m_bufferArray

private

The underlying array is stored in regular MemoryManager heap memory

size_t G3D::AreaMemoryManager::m_sizeHint

private

---

The documentation for this class was generated from the following files:

• dep/g3dlite/include/G3D/AreaMemoryManager.h
• dep/g3dlite/source/AreaMemoryManager.cpp