MemoryPoolAllocator< BaseAllocator > Class Template Reference

Default memory allocator used by the parser and DOM. More...

#include <allocators.h>

Classes
struct	ChunkHeader
	Chunk header for perpending to each chunk. More...

Public Member Functions
	MemoryPoolAllocator (size_t chunkSize=kDefaultChunkCapacity, BaseAllocator *baseAllocator=0)
	Constructor with chunkSize. More...
	MemoryPoolAllocator (void *buffer, size_t size, size_t chunkSize=kDefaultChunkCapacity, BaseAllocator *baseAllocator=0)
	Constructor with user-supplied buffer. More...
	~MemoryPoolAllocator ()
	Destructor. More...
void	Clear ()
	Deallocates all memory chunks, excluding the user-supplied buffer. More...
size_t	Capacity () const
	Computes the total capacity of allocated memory chunks. More...
size_t	Size () const
	Computes the memory blocks allocated. More...
void *	Malloc (size_t size)
	Allocates a memory block. (concept Allocator) More...
void *	Realloc (void *originalPtr, size_t originalSize, size_t newSize)
	Resizes a memory block (concept Allocator) More...

Static Public Member Functions
static void	Free (void *ptr)
	Frees a memory block (concept Allocator) More...

Static Public Attributes
static const bool	kNeedFree = false
	Tell users that no need to call Free() with this allocator. (concept Allocator) More...

Private Member Functions
	MemoryPoolAllocator (const MemoryPoolAllocator &rhs)
	Copy constructor is not permitted. More...
MemoryPoolAllocator &	operator= (const MemoryPoolAllocator &rhs)
	Copy assignment operator is not permitted. More...
bool	AddChunk (size_t capacity)
	Creates a new chunk. More...

Private Attributes
ChunkHeader *	chunkHead_
	Head of the chunk linked-list. Only the head chunk serves allocation. More...
size_t	chunk_capacity_
	The minimum capacity of chunk when they are allocated. More...
void *	userBuffer_
	User supplied buffer. More...
BaseAllocator *	baseAllocator_
	base allocator for allocating memory chunks. More...
BaseAllocator *	ownBaseAllocator_
	base allocator created by this object. More...

Static Private Attributes
static const int	kDefaultChunkCapacity = RAPIDJSON_ALLOCATOR_DEFAULT_CHUNK_CAPACITY
	Default chunk capacity. More...

Detailed Description

template<typename BaseAllocator = CrtAllocator>
class MemoryPoolAllocator< BaseAllocator >

Default memory allocator used by the parser and DOM.

This allocator allocate memory blocks from pre-allocated memory chunks.

It does not free memory blocks. And Realloc() only allocate new memory.

The memory chunks are allocated by BaseAllocator, which is CrtAllocator by default.

User may also supply a buffer as the first chunk.

If the user-buffer is full then additional chunks are allocated by BaseAllocator.

The user-buffer is not deallocated by this allocator.

Template Parameters

BaseAllocator

the allocator type for allocating memory chunks. Default is CrtAllocator.

Note

implements Allocator concept

Definition at line 115 of file allocators.h.

Constructor & Destructor Documentation

template<typename BaseAllocator = CrtAllocator>

MemoryPoolAllocator< BaseAllocator >::MemoryPoolAllocator ( size_t  chunkSize = kDefaultChunkCapacity, BaseAllocator *  baseAllocator = 0  )

inline

Constructor with chunkSize.

Parameters

chunkSize	The size of memory chunk. The default is kDefaultChunkSize.
baseAllocator	The allocator for allocating memory chunks.

Definition at line 123 of file allocators.h.

                                                                                                    : 
        chunkHead_(0), chunk_capacity_(chunkSize), userBuffer_(0), baseAllocator_(baseAllocator), ownBaseAllocator_(0)
    {
    }

template<typename BaseAllocator = CrtAllocator>

MemoryPoolAllocator< BaseAllocator >::MemoryPoolAllocator ( void *  buffer, size_t  size, size_t  chunkSize = kDefaultChunkCapacity, BaseAllocator *  baseAllocator = 0  )

inline

Constructor with user-supplied buffer.

The user buffer will be used firstly. When it is full, memory pool allocates new chunk with chunk size.

The user buffer will not be deallocated when this allocator is destructed.

Parameters

buffer	User supplied buffer.
size	Size of the buffer in bytes. It must at least larger than sizeof(ChunkHeader).
chunkSize	The size of memory chunk. The default is kDefaultChunkSize.
baseAllocator	The allocator for allocating memory chunks.

Definition at line 138 of file allocators.h.

                                                                                                                               :
        chunkHead_(0), chunk_capacity_(chunkSize), userBuffer_(buffer), baseAllocator_(baseAllocator), ownBaseAllocator_(0)
    {
        RAPIDJSON_ASSERT(buffer != 0);
        RAPIDJSON_ASSERT(size > sizeof(ChunkHeader));
        chunkHead_ = reinterpret_cast<ChunkHeader*>(buffer);
        chunkHead_->capacity = size - sizeof(ChunkHeader);
        chunkHead_->size = 0;
        chunkHead_->next = 0;
    }

template<typename BaseAllocator = CrtAllocator>

MemoryPoolAllocator< BaseAllocator >::~MemoryPoolAllocator ( )

inline

Destructor.

This deallocates all memory chunks, excluding the user-supplied buffer.

Definition at line 152 of file allocators.h.

                           {
        Clear();
        RAPIDJSON_DELETE(ownBaseAllocator_);
    }

template<typename BaseAllocator = CrtAllocator>

MemoryPoolAllocator< BaseAllocator >::MemoryPoolAllocator ( const MemoryPoolAllocator< BaseAllocator > &  rhs )

private

Copy constructor is not permitted.

Member Function Documentation

template<typename BaseAllocator = CrtAllocator>

bool MemoryPoolAllocator< BaseAllocator >::AddChunk ( size_t  capacity )

inlineprivate

Creates a new chunk.

Parameters

capacity

Capacity of the chunk in bytes.

Returns

true if success.

Definition at line 250 of file allocators.h.

                                   {
        if (!baseAllocator_)
            ownBaseAllocator_ = baseAllocator_ = RAPIDJSON_NEW(BaseAllocator)();
        if (ChunkHeader* chunk = reinterpret_cast<ChunkHeader*>(baseAllocator_->Malloc(RAPIDJSON_ALIGN(sizeof(ChunkHeader)) + capacity))) {
            chunk->capacity = capacity;
            chunk->size = 0;
            chunk->next = chunkHead_;
            chunkHead_ =  chunk;
            return true;
        }
        else
            return false;
    }

template<typename BaseAllocator = CrtAllocator>

size_t MemoryPoolAllocator< BaseAllocator >::Capacity ( ) const

inline

Computes the total capacity of allocated memory chunks.

Returns

total capacity in bytes.

Definition at line 171 of file allocators.h.

                            {
        size_t capacity = 0;
        for (ChunkHeader* c = chunkHead_; c != 0; c = c->next)
            capacity += c->capacity;
        return capacity;
    }

template<typename BaseAllocator = CrtAllocator>

void MemoryPoolAllocator< BaseAllocator >::Clear ( )

inline

Deallocates all memory chunks, excluding the user-supplied buffer.

Definition at line 158 of file allocators.h.

                 {
        while (chunkHead_ && chunkHead_ != userBuffer_) {
            ChunkHeader* next = chunkHead_->next;
            baseAllocator_->Free(chunkHead_);
            chunkHead_ = next;
        }
        if (chunkHead_ && chunkHead_ == userBuffer_)
            chunkHead_->size = 0; // Clear user buffer
    }

template<typename BaseAllocator = CrtAllocator>

static void MemoryPoolAllocator< BaseAllocator >::Free ( void *  ptr )

inlinestatic

Frees a memory block (concept Allocator)

Definition at line 238 of file allocators.h.

{ (void)ptr; } // Do nothing

template<typename BaseAllocator = CrtAllocator>

void* MemoryPoolAllocator< BaseAllocator >::Malloc ( size_t  size )

inline

Allocates a memory block. (concept Allocator)

Definition at line 189 of file allocators.h.

                              {
        if (!size)
            return NULL;

        size = RAPIDJSON_ALIGN(size);
        if (chunkHead_ == 0 || chunkHead_->size + size > chunkHead_->capacity)
            if (!AddChunk(chunk_capacity_ > size ? chunk_capacity_ : size))
                return NULL;

        void *buffer = reinterpret_cast<char *>(chunkHead_) + RAPIDJSON_ALIGN(sizeof(ChunkHeader)) + chunkHead_->size;
        chunkHead_->size += size;
        return buffer;
    }

template<typename BaseAllocator = CrtAllocator>

MemoryPoolAllocator& MemoryPoolAllocator< BaseAllocator >::operator= ( const MemoryPoolAllocator< BaseAllocator > &  rhs )

private

Copy assignment operator is not permitted.

template<typename BaseAllocator = CrtAllocator>

void* MemoryPoolAllocator< BaseAllocator >::Realloc ( void *  originalPtr, size_t  originalSize, size_t  newSize  )

inline

Resizes a memory block (concept Allocator)

Definition at line 204 of file allocators.h.

                                                                          {
        if (originalPtr == 0)
            return Malloc(newSize);

        if (newSize == 0)
            return NULL;

        originalSize = RAPIDJSON_ALIGN(originalSize);
        newSize = RAPIDJSON_ALIGN(newSize);

        // Do not shrink if new size is smaller than original
        if (originalSize >= newSize)
            return originalPtr;

        // Simply expand it if it is the last allocation and there is sufficient space
        if (originalPtr == reinterpret_cast<char *>(chunkHead_) + RAPIDJSON_ALIGN(sizeof(ChunkHeader)) + chunkHead_->size - originalSize) {
            size_t increment = static_cast<size_t>(newSize - originalSize);
            if (chunkHead_->size + increment <= chunkHead_->capacity) {
                chunkHead_->size += increment;
                return originalPtr;
            }
        }

        // Realloc process: allocate and copy memory, do not free original buffer.
        if (void* newBuffer = Malloc(newSize)) {
            if (originalSize)
                std::memcpy(newBuffer, originalPtr, originalSize);
            return newBuffer;
        }
        else
            return NULL;
    }

template<typename BaseAllocator = CrtAllocator>

size_t MemoryPoolAllocator< BaseAllocator >::Size ( ) const

inline

Computes the memory blocks allocated.

Returns

total used bytes.

Definition at line 181 of file allocators.h.

                        {
        size_t size = 0;
        for (ChunkHeader* c = chunkHead_; c != 0; c = c->next)
            size += c->size;
        return size;
    }

Member Data Documentation

template<typename BaseAllocator = CrtAllocator>

BaseAllocator* MemoryPoolAllocator< BaseAllocator >::baseAllocator_

private

base allocator for allocating memory chunks.

Definition at line 278 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

size_t MemoryPoolAllocator< BaseAllocator >::chunk_capacity_

private

The minimum capacity of chunk when they are allocated.

Definition at line 276 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

ChunkHeader* MemoryPoolAllocator< BaseAllocator >::chunkHead_

private

Head of the chunk linked-list. Only the head chunk serves allocation.

Definition at line 275 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

const int MemoryPoolAllocator< BaseAllocator >::kDefaultChunkCapacity = RAPIDJSON_ALLOCATOR_DEFAULT_CHUNK_CAPACITY

staticprivate

Default chunk capacity.

Definition at line 264 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

const bool MemoryPoolAllocator< BaseAllocator >::kNeedFree = false

static

Tell users that no need to call Free() with this allocator. (concept Allocator)

Definition at line 117 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

BaseAllocator* MemoryPoolAllocator< BaseAllocator >::ownBaseAllocator_

private

base allocator created by this object.

Definition at line 279 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

void* MemoryPoolAllocator< BaseAllocator >::userBuffer_

private

User supplied buffer.

Definition at line 277 of file allocators.h.

---

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

• art/rapidjson/allocators.h