module Memory Allocation

Classes

Functions

Defines

virtual Geo::MemoryAllocator::~MemoryAllocator

---

public: virtual ~MemoryAllocator()

---

Force a virtual destructor. This is not called by GeoMemory.

virtual void* Geo::MemoryAllocator::Allocate

---

public: void * Allocate
(
    size_t size,
    size_t align,
    const char * filename,
    Geo::s32 lineNumber,
    const char * message
)

---

Allocate a block of memory with the given size.

If alignment is 0, use unaligned allocation. Otherwise, alignment must be a power of two.

virtual void Geo::MemoryAllocator::Free

---

public: void Free
(
    void * mem,
    bool aligned,
    const char * filename,
    Geo::s32 lineNumber,
    const char * message
)

---

Free a block of memory, possibly aligned.

void Geo::GEO_DELETE_ARRAY_T

---

public: void GEO_DELETE_ARRAY_T
(
    T *& p
)

---

Templated function equivalent of GEO_DELETE_ARRAY A handy template so you don't have to enter the type param (and potentially get it wrong)

void Geo::GEO_DELETE_T

---

public: void GEO_DELETE_T
(
    T *& p
)

---

Templated function equivalent of GEO_DELETE A handy template so you don't have to enter the type param (and potentially get it wrong)

void Geo::GeoDestruct

---

public: void GeoDestruct
(
    T & object
)

---

Calls destructor on object.

void Geo::GeoDestruct

---

public: void GeoDestruct
(
    v128 &
)

---

Calls destructor on object.

MemoryAllocator* GEO_CALL Geo::GetMemoryAllocator

---

public: MemoryAllocator *GEO_CALL GetMemoryAllocator()

---

Gets the currently set memory allocator, or NULL if none has been set yet.

Geo::s64 GEO_CALL Geo::GetNumPageFaults

---

public: Geo::s64GEO_CALL GetNumPageFaults()

---

The number of page faults that occurred during the process life.

Geo::s64 GEO_CALL Geo::GetPeakProcessMemoryInfo

---

public: Geo::s64GEO_CALL GetPeakProcessMemoryInfo()

---

The peak amount of memory allocated by the process.

virtual Geo::s64 Geo::MemoryAllocator::GetTotalMemoryAllocated

---

public: virtual Geo::s64 GetTotalMemoryAllocated()

---

The total amount of memory we've allocated to date (not subtracting deallocations).

virtual Geo::s64 Geo::MemoryAllocator::GetTotalMemoryAllocationCalls

---

public: virtual Geo::s64 GetTotalMemoryAllocationCalls()

---

The number of times we've allocated memory through GeoMemory.

virtual Geo::s64 Geo::MemoryAllocator::GetTotalMemoryDeallocated

---

public: virtual Geo::s64 GetTotalMemoryDeallocated()

---

The total amount of memory we've deallocated so far.

virtual Geo::s64 Geo::MemoryAllocator::GetTotalMemoryInUse

---

public: virtual Geo::s64 GetTotalMemoryInUse()

---

The total amount of memory currently allocated (allocations minus deallocations)

Geo::s64 GEO_CALL Geo::GetTotalMemoryInUse

---

public: Geo::s64GEO_CALL GetTotalMemoryInUse()

---

The total amount of memory currently allocated (allocations minus deallocations)

Geo::s64 GEO_CALL Geo::GetTotalProcessMemoryInfo

---

public: Geo::s64GEO_CALL GetTotalProcessMemoryInfo()

---

The total amount of memory currently allocated by the process.

Geo::u64 GEO_CALL Geo::GetTotalSystemMemory

---

public: Geo::u64GEO_CALL GetTotalSystemMemory()

---

Get the total amount of system physical memory.

Returns

0 on error or if unsupported, otherwise the total system physical memory in bytes

virtual bool Geo::MemoryAllocator::IsTotalMemorySummarySupported

---

public: virtual bool IsTotalMemorySummarySupported()

---

Returns true if the memory summary functionality is supported with this allocator.

void GEO_CALL Geo::MemoryTrackerReport

---

public: void GEO_CALL MemoryTrackerReport
(
    s16 exitCode,
    bool pauseOnError
)

---

This will generate a report on memory leaks, and attempt to release the leaks.

It should be called when an application has shut down just before it exits completely. Because it attempts to release any leaks this must be the very last thing an application does.

bool GEO_CALL Geo::PrintTotalMemorySummaryForMarker

---

public: bool GEO_CALL PrintTotalMemorySummaryForMarker
(
    const char * name,
    const char * filename,
    s32 lineNumber
)

---

Print a basic report to the LOG_INFO stream.

Returns

Returns true if a log was printed. It will only be printed if IsTotalMemorySummarySupported() returns true.

virtual void* Geo::MemoryAllocator::Realloc

---

public: void * Realloc
(
    void * mem,
    size_t size,
    size_t align,
    const char * filename,
    s32 lineNumber,
    const char * message
)

---

Reallocate a block of memory, preserving as much data as will fit in the new block size.

Requires the same alignment as in the original allocation.

void Geo::SafeRelease

---

public: void SafeRelease
(
    T & a
)

---

Scoped safe release function.

void GEO_CALL Geo::SetMemoryAllocator

---

public: void GEO_CALL SetMemoryAllocator
(
    MemoryAllocator * allocator
)

---

Set the memory allocator.

You must call this before ANY other Geo calls are made. It can only be set once and cannot be unset. No Geo-derived module is robust to incomplete, slow or buggy MemoryAllocators so be careful!