A reimplementation of Mario Kart Wii's physics engine in C++
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | Static Protected Attributes | List of all members
EGG::Heap Class Referenceabstract

#include <Heap.hh>

Description

A high-level representation of a memory heap for managing dynamic memory allocation. Interface for allocating and freeing memory blocks.

Definition at line 22 of file Heap.hh.

Inheritance diagram for EGG::Heap:

Public Types

enum class  Kind {
  None ,
  Expanded ,
  Frame ,
  Unit ,
  Assert
}
 

Public Member Functions

 Heap (Abstract::Memory::MEMiHeapHead *handle)
 
virtual void destroy ()=0
 
virtual Kind getHeapKind () const =0
 
virtual void * alloc (size_t size, s32 align)=0
 
virtual void free (void *block)=0
 
virtual u32 getAllocatableSize (s32 align=4) const =0
 
void dispose ()
 
void disableAllocation ()
 
void enableAllocation ()
 
bool tstDisableAllocation () const
 
void appendDisposer (Disposer *disposer)
 
void removeDisposer (Disposer *disposer)
 
Heap * becomeAllocatableHeap ()
 
Heap * becomeCurrentHeap ()
 
void registerHeapBuffer (void *buffer)
 
void * getStartAddress ()
 
void * getEndAddress ()
 
const char * getName () const
 
Heap * getParentHeap () const
 
void setName (const char *name)
 
void setParentHeap (Heap *heap)
 

Static Public Member Functions

static void initialize ()
 
static void * alloc (size_t size, int align, Heap *pHeap)
 
static void free (void *block, Heap *pHeap)
 
static Heap * findHeap (Abstract::Memory::MEMiHeapHead *handle)
 
static Heap * findContainHeap (const void *block)
 
static ExpHeap * dynamicCastToExp (Heap *heap)
 
static Heap * getCurrentHeap ()
 
static constexpr uintptr_t getOffset ()
 

Protected Types

enum class  eFlags { Lock = 0 }
 
typedef TBitFlag< u16, eFlags > Flags
 

Protected Attributes

Abstract::Memory::MEMiHeapHead * m_handle
 
void * m_block
 
Heap * m_parentHeap
 
Flags m_flags
 
Abstract::Memory::MEMLink m_link
 
Abstract::Memory::MEMList m_children
 
const char * m_name
 

Static Protected Attributes

static Abstract::Memory::MEMList s_heapList = MEMList(EGG::Heap::getOffset())
 
static Heap * s_currentHeap = nullptr
 
static Heap * s_allocatableHeap = nullptr
 

Additional Inherited Members

- Private Member Functions inherited from EGG::Disposer
- Static Private Member Functions inherited from EGG::Disposer
static constexpr u16 getLinkOffset ()
 

Member Typedef Documentation

◆ Flags

TBitFlag<u16, eFlags> EGG::Heap::Flags
protected

Definition at line 121 of file Heap.hh.

Member Enumeration Documentation

◆ eFlags

enum class EGG::Heap::eFlags
strongprotected

Definition at line 118 of file Heap.hh.

◆ Kind

enum class EGG::Heap::Kind
strong

Definition at line 26 of file Heap.hh.

Constructor & Destructor Documentation

◆ Heap()

EGG::Heap::Heap ( Abstract::Memory::MEMiHeapHead * handle)
0x802296E8

Definition at line 8 of file Heap.cc.

◆ ~Heap()

EGG::Heap::~Heap ( )
override0x80229780

Definition at line 18 of file Heap.cc.

Member Function Documentation

◆ alloc()

void * EGG::Heap::alloc ( size_t size,
int align,
Heap * pHeap )
staticnodiscard0x80229814

Definition at line 46 of file Heap.cc.

◆ appendDisposer()

void EGG::Heap::appendDisposer ( Disposer * disposer)
inline

Definition at line 57 of file Heap.hh.

◆ becomeAllocatableHeap()

Heap * EGG::Heap::becomeAllocatableHeap ( )

Definition at line 32 of file Heap.cc.

◆ becomeCurrentHeap()

Heap * EGG::Heap::becomeCurrentHeap ( )
0x80229D74

Definition at line 39 of file Heap.cc.

◆ disableAllocation()

void EGG::Heap::disableAllocation ( )
inline

Definition at line 45 of file Heap.hh.

◆ dispose()

void EGG::Heap::dispose ( )
0x80229C5C

Definition at line 23 of file Heap.cc.

◆ dynamicCastToExp()

static ExpHeap * EGG::Heap::dynamicCastToExp ( Heap * heap)
inlinestaticnodiscard

Definition at line 104 of file Heap.hh.

◆ enableAllocation()

void EGG::Heap::enableAllocation ( )
inline

Definition at line 49 of file Heap.hh.

◆ findContainHeap()

Heap * EGG::Heap::findContainHeap ( const void * block)
staticnodiscard0x80229ADC

Definition at line 128 of file Heap.cc.

◆ findHeap()

Heap * EGG::Heap::findHeap ( Abstract::Memory::MEMiHeapHead * handle)
staticnodiscard

Definition at line 116 of file Heap.cc.

◆ free()

void EGG::Heap::free ( void * block,
Heap * pHeap )
static0x80229B84

Definition at line 95 of file Heap.cc.

◆ getCurrentHeap()

static Heap * EGG::Heap::getCurrentHeap ( )
inlinestaticnodiscard

Definition at line 108 of file Heap.hh.

◆ getEndAddress()

void * EGG::Heap::getEndAddress ( )
inlinenodiscard

Definition at line 76 of file Heap.hh.

◆ getName()

const char * EGG::Heap::getName ( ) const
inlinenodiscard

Definition at line 80 of file Heap.hh.

◆ getOffset()

static constexpr uintptr_t EGG::Heap::getOffset ( )
inlinestaticnodiscardconstexpr

Definition at line 112 of file Heap.hh.

◆ getParentHeap()

Heap * EGG::Heap::getParentHeap ( ) const
inlinenodiscard0x80229AD4

Definition at line 85 of file Heap.hh.

◆ getStartAddress()

void * EGG::Heap::getStartAddress ( )
inlinenodiscard

Definition at line 72 of file Heap.hh.

◆ registerHeapBuffer()

void EGG::Heap::registerHeapBuffer ( void * buffer)
inline

Definition at line 68 of file Heap.hh.

◆ removeDisposer()

void EGG::Heap::removeDisposer ( Disposer * disposer)
inline

Definition at line 61 of file Heap.hh.

◆ setName()

void EGG::Heap::setName ( const char * name)
inline

Definition at line 89 of file Heap.hh.

◆ setParentHeap()

void EGG::Heap::setParentHeap ( Heap * heap)
inline

Definition at line 93 of file Heap.hh.

◆ tstDisableAllocation()

bool EGG::Heap::tstDisableAllocation ( ) const
inlinenodiscard

Definition at line 53 of file Heap.hh.

Member Data Documentation

◆ m_block

void* EGG::Heap::m_block
protected

Definition at line 124 of file Heap.hh.

◆ m_children

Abstract::Memory::MEMList EGG::Heap::m_children
protected

Definition at line 128 of file Heap.hh.

◆ m_flags

Flags EGG::Heap::m_flags
protected

Definition at line 126 of file Heap.hh.

◆ m_handle

Abstract::Memory::MEMiHeapHead* EGG::Heap::m_handle
protected

Definition at line 123 of file Heap.hh.

◆ m_link

Abstract::Memory::MEMLink EGG::Heap::m_link
protected

Definition at line 127 of file Heap.hh.

◆ m_name

const char* EGG::Heap::m_name
protected

Definition at line 129 of file Heap.hh.

◆ m_parentHeap

Heap* EGG::Heap::m_parentHeap
protected

Definition at line 125 of file Heap.hh.

◆ s_allocatableHeap

EGG::Heap * EGG::Heap::s_allocatableHeap = nullptr
staticprotected0x80386EA8

Definition at line 134 of file Heap.hh.

◆ s_currentHeap

EGG::Heap * EGG::Heap::s_currentHeap = nullptr
staticprotected0x80386EA0

Definition at line 133 of file Heap.hh.

◆ s_heapList

MEMList EGG::Heap::s_heapList = MEMList(EGG::Heap::getOffset())
staticprotected0x80384320

Definition at line 131 of file Heap.hh.