nn::fnd::ExpHeapTemplate::Create Member Function

Syntax

static ExpHeapTemplate * Create(
     HeapBase * parent,
     void * addr,
     size_t size,
     bit32 option = 0,
     bit32 placement = HEAP_INFOPLACEMENT_HEAD
);

Arguments

Name Description
in parent Specifies the parent heap whose region contains addr.
in addr The starting address of the memory block to be allocated to the heap.
in size The size of the memory block to be allocated to the heap.
in option Specifies options.
in placement Specifies the location where the management region (ExpHeap object) is located.

Return Values

Description

Creates an expanded heap within a parent heap.

Heaps that are created with this function must be destroyed using HeapBase::Destroy.

The actual ExpHeap object is created within the region defined by the values specified for the addr and size arguments. This means that the actual size allocated to the heap is the size of the specified region minus sizeof(ExpHeap).

Use the placement argument to specify where the ExpHeap object is placed. If you specify HEAP_INFOPLACEMENT_HEAD for placement, the actual ExpHeap object is placed at the start of the region (in other words, the region that starts at addr and ends at addr+sizeof(ExpHeap). If you specify HEAP_INFOPLACEMENT_TAIL for placement, the actual ExpHeap object is placed at the end of the region (in other words, the region that starts at addr+size-sizeof(ExpHeap) and ends at addr+size.

Revision History

2010/01/08
Added the placement argument, which is used to specify where to place the management region.
2010/01/07
Initial version.

CONFIDENTIAL