cohtml::IAllocator Class Reference

Allocator interface used by Cohtml for all memory allocations. The user has to provide an object that imlements this interface. Memory allocations in Cohtml are tagged, so the user knows the relative distribution of memory among subsystems. More...

Public Member Functions
	IAllocator ()
virtual void *	Allocate (unsigned size, cohtml::MemTags::MemTagsType memtag)=0
	Allocate size bytes. More...
virtual void *	Reallocate (void *ptr, unsigned size, cohtml::MemTags::MemTagsType memtag)=0
	Reallocates the given area of memory. It must be previously allocated by Allocate. More...
virtual void	Deallocate (void *ptr, cohtml::MemTags::MemTagsType memtag)=0
	Deallocates the memory previously allocated by Allocate. More...
virtual void *	AlignedAllocate (unsigned size, unsigned alignment, cohtml::MemTags::MemTagsType memtag)=0
	Allocate size bytes whose alignment is specified by alignment. More...
virtual void	AlignedDeallocate (void *ptr, cohtml::MemTags::MemTagsType memtag)=0
	Deallocates the memory previously allocated by AlignedAllocate. More...
virtual void *	VirtualAllocate (void *hint, unsigned size, int protection, int flags, cohtml::MemTags::MemTagsType memtag)=0
	Reserves, commits, or changes the state of a memory region. More...
virtual bool	VirtualFree (void *ptr, unsigned size, int flags, cohtml::MemTags::MemTagsType memtag)=0
	Releases and decommits a memory region. More...
virtual	~IAllocator ()

Detailed Description

Allocator interface used by Cohtml for all memory allocations. The user has to provide an object that imlements this interface. Memory allocations in Cohtml are tagged, so the user knows the relative distribution of memory among subsystems.

Constructor & Destructor Documentation

IAllocator()

cohtml::IAllocator::IAllocator

(

)

~IAllocator()

virtual cohtml::IAllocator::~IAllocator ( )

virtual

Member Function Documentation

AlignedAllocate()

virtual void* cohtml::IAllocator::AlignedAllocate ( unsigned  size, unsigned  alignment, cohtml::MemTags::MemTagsType  memtag  )

pure virtual

Allocate size bytes whose alignment is specified by alignment.

Parameters

size	number of bytes to allocate
alignment	specifies the alignment
memtag	tag of the subsystem from which the request came

Returns

the pointer to the beginning of newly allocated memory

Warning

when specified, memory alignment for allocations should be perserved

AlignedDeallocate()

virtual void cohtml::IAllocator::AlignedDeallocate ( void *  ptr, cohtml::MemTags::MemTagsType  memtag  )

pure virtual

Deallocates the memory previously allocated by AlignedAllocate.

Parameters

ptr	the pointer to the memory to deallocate
memtag	tag of the subsystem from which the request came

Allocate()

virtual void* cohtml::IAllocator::Allocate ( unsigned  size, cohtml::MemTags::MemTagsType  memtag  )

pure virtual

Allocate size bytes.

Parameters

size	the number of bytes to allocate
memtag	tag of the subsystem from which the request came

Returns

the pointer to the beginning of newly allocated memory.

Warning

the memory must be aligned on 8

Deallocate()

virtual void cohtml::IAllocator::Deallocate ( void *  ptr, cohtml::MemTags::MemTagsType  memtag  )

pure virtual

Deallocates the memory previously allocated by Allocate.

Parameters

ptr	the pointer to the memory to deallocate
memtag	tag of the subsystem from which the request came

Reallocate()

virtual void* cohtml::IAllocator::Reallocate ( void *  ptr, unsigned  size, cohtml::MemTags::MemTagsType  memtag  )

pure virtual

Reallocates the given area of memory. It must be previously allocated by Allocate.

Parameters

ptr	the pointer to the memory area to be reallocated
size	number of bytes to allocate
memtag	tag of the subsystem from which the request came

VirtualAllocate()

virtual void* cohtml::IAllocator::VirtualAllocate ( void *  hint, unsigned  size, int  protection, int  flags, cohtml::MemTags::MemTagsType  memtag  )

pure virtual

Reserves, commits, or changes the state of a memory region.

Parameters

hint	address of the region to allocate. Address is rounded down to the nearest page boundary.
size	the size of the region, in bytes.
protection	specifies a protection type for the memory region
flags	type of the allocation (commit, reserve etc)
memtag	tag of the subsystem from which the request came

Returns

address of the allocated memory region.

Note

the return address must be aligned with the system page size

Warning

all newly commited memory by the provided implementation should be zeroed out

VirtualFree()

virtual bool cohtml::IAllocator::VirtualFree ( void *  ptr, unsigned  size, int  flags, cohtml::MemTags::MemTagsType  memtag  )

pure virtual

Releases and decommits a memory region.

Parameters

ptr	a pointer to the address of the memory region.
size	the size of the region in bytes.
flags	type of the allocation (decommit, release etc).
memtag	tag of the subsystem from which the request came

Returns

true if the function succeeds, otherwise false.`