nkMemory::FreeListPager< T, U > Class Template Reference

A pager implementing the free list pattern. More...

Public Member Functions
	FreeListPager (unsigned long long pageSize, UniquePtr< MemorySpaceAllocator< U >> allocator=makeUnique< DefaultMemorySpaceAllocator< U >>()) noexcept
unsigned long long	getPageSize () const
unsigned long long	getAllocatedPageCount () const
const FreeListMemorySpaceWrapper< T, U > &	getPage (unsigned long long index)
FreeListAllocation< T >	allocate (unsigned long long size, unsigned long long alignment=1)
void	free (unsigned long long allocationIndex)

Detailed Description

template<typename T = char*, typename U = DefaultMemorySpace>
class nkMemory::FreeListPager< T, U >

A pager implementing the free list pattern.

This pattern keeps track of allocations within the pages, and returns allocations fitting the requirements within the memory space allocated. Allocations can be freed individually. This pager can be used when data will be kept around, with no knowledge about the lifetime of it.
For instance, in a 3d renderer, gpu resources can be placed within a memory space as they come and go, reducing the need for memory allocations.

• T represents the returned type from an allocation request.
• U Represents the kind of memory space to use.

Constructor & Destructor Documentation

FreeListPager()

template<typename T = char*, typename U = DefaultMemorySpace>

nkMemory::FreeListPager< T, U >::FreeListPager ( unsigned long long  pageSize, UniquePtr< MemorySpaceAllocator< U >>  allocator = makeUnique< DefaultMemorySpaceAllocator< U >>()  )

noexcept

Constructor.

Parameters

pageSize	The size to use for pages, in number of elements.
allocator	The memory space allocator, allowing to customize how the pages are allocated.

Member Function Documentation

getPageSize()

template<typename T = char*, typename U = DefaultMemorySpace>

unsigned long long nkMemory::FreeListPager< T, U >::getPageSize

(

)

const

Returns

The page size used by the pager.

getAllocatedPageCount()

template<typename T = char*, typename U = DefaultMemorySpace>

unsigned long long nkMemory::FreeListPager< T, U >::getAllocatedPageCount

(

)

const

Returns

The number of pages currently allocated.

getPage()

template<typename T = char*, typename U = DefaultMemorySpace>

const FreeListMemorySpaceWrapper<T, U>& nkMemory::FreeListPager< T, U >::getPage

(

unsigned long long

index

)

Returns

Returns a page kept internally. Should not be called by external code.

allocate()

template<typename T = char*, typename U = DefaultMemorySpace>

FreeListAllocation<T> nkMemory::FreeListPager< T, U >::allocate	(	unsigned long long	size,
		unsigned long long	alignment = 1
	)

Requests an allocation.

Parameters

size	The size of the allocation needed, in number of elements.
alignment	The needed alignment in the memory space.

Returns

An allocation fitting requested conditions, if possible.

Remarks

Typically, a failure in allocating is caused by the page size being too small.

free()

template<typename T = char*, typename U = DefaultMemorySpace>

void nkMemory::FreeListPager< T, U >::free

(

unsigned long long

allocationIndex

)

Releases an allocation so that it returns within the pager.

Parameters

allocationIndex

The index for the allocation to free. Provided by allocate().

---

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

• Documentation/Headers/NilkinsMemory/Pagers/FreeList/FreeListPager.h