Core memory management system for the Toshi engine. More...

#include "Toshi/TNodeList.h"

Classes
class	TMemory
	Core memory management class that handles all memory allocations and deallocations. More...

class	TMemory::MemNode
	Represents a node in the memory allocation system. More...

struct	TMemory::MemBlock
	Represents a contiguous block of memory that can be allocated from. More...

struct	TMemory::MemBlockFooter
	Footer structure at the end of each memory block for validation. More...

struct	TMemory::MemBlockSlot
	Slot for tracking memory blocks in the block list. More...

struct	TMemory::MemInfo
	Structure containing memory usage statistics. More...

struct	TMemory::HALMemInfo
	Hardware abstraction layer memory information. More...

Macros
#define	TMEMORY_ROUNDUP 4
	Minimum alignment for memory blocks.

#define	TMEMORY_FLAGS_HOLE_PROCESS 1
	Flag indicating a memory block is in use.

#define	TMEMORY_FLAGS_MASK ( ( 1 << 2 ) - 1 )
	Mask for memory block flags.

#define	TMEMORY_NUM_FREELISTS 9
	Number of free list buckets for different sizes.

#define	TMEMORY_NUM_BLOCK_SLOTS 128
	Maximum number of memory block slots.

#define	TMEMORY_ALLOC_MEMNODE_SIZE sizeof( Toshi::TMemory::MemNode )
	Size of memory node structure.

#define	TMEMORY_ALLOC_RESERVED_SIZE ( TMEMORY_ALLOC_MEMNODE_SIZE - sizeof( void* ) )
	Reserved space in allocations.

Functions
TOSHI_NAMESPACE_END void *	TMalloc (TSIZE a_uiSize)
	Allocates memory with default alignment.

void *	TMalloc (TSIZE a_uiSize, const TCHAR *a_szFileName, TINT a_iLineNum)
	Allocates memory with debug information.

void *	TMalloc (TSIZE a_uiSize, Toshi::TMemory::MemBlock a_pMemBlock, const TCHAR a_szFileName=TNULL, TINT a_iLineNum=-1)
	Allocates memory from a specific memory block.

void *	TMemalign (TSIZE a_uiSize, TSIZE a_uiAlignment)
	Allocates aligned memory.

void *	TMemalign (TSIZE a_uiAlignment, TSIZE a_uiSize, Toshi::TMemory::MemBlock *a_pMemBlock)
	Allocates aligned memory from a specific memory block.

void	TFree (void *a_pMem)
	Frees previously allocated memory.

template<class T, class... Args>
TFORCEINLINE T *	TConstruct (T *a_pMemory, Args &&... args)
	Constructs an object in place.

template<class T, class... Args>
TFORCEINLINE T *	TConstructArray (T *a_pMemory, TSIZE a_uiNumTimes, Args &&... args)
	Constructs an array of objects in place.

template<class T>
TFORCEINLINE void	TDestruct (T *a_pPtr)
	Destructs an object.

TFORCEINLINE void *__CRTDECL	operator new (size_t size, Toshi::TMemory::MemBlock *block)
	Placement new operator for memory blocks.

TFORCEINLINE void *__CRTDECL	operator new[] (size_t size, Toshi::TMemory::MemBlock *block)
	Placement new[] operator for memory blocks.

TFORCEINLINE void __CRTDECL	operator delete (void ptr, Toshi::TMemory::MemBlock block) noexcept
	Placement delete operator for memory blocks.

TFORCEINLINE void __CRTDECL	operator delete[] (void ptr, Toshi::TMemory::MemBlock block) noexcept
	Placement delete[] operator for memory blocks.

Variables
TOSHI_NAMESPACE_START class TMemory *	g_pMemory

Detailed Description

Core memory management system for the Toshi engine.

This file implements a custom memory allocator that provides:

Memory block management with alignment support
Memory tracking and debugging capabilities
Support for both custom allocator and dlmalloc implementations

Definition in file TMemory.h.

Macro Definition Documentation

◆ TMEMORY_ALLOC_MEMNODE_SIZE

#define TMEMORY_ALLOC_MEMNODE_SIZE sizeof( Toshi::TMemory::MemNode )

Size of memory node structure.

Definition at line 30 of file TMemory.h.

◆ TMEMORY_ALLOC_RESERVED_SIZE

#define TMEMORY_ALLOC_RESERVED_SIZE ( TMEMORY_ALLOC_MEMNODE_SIZE - sizeof( void* ) )

Reserved space in allocations.

Definition at line 31 of file TMemory.h.

◆ TMEMORY_FLAGS_HOLE_PROCESS

#define TMEMORY_FLAGS_HOLE_PROCESS 1

Flag indicating a memory block is in use.

Definition at line 26 of file TMemory.h.

◆ TMEMORY_FLAGS_MASK

#define TMEMORY_FLAGS_MASK ( ( 1 << 2 ) - 1 )

Mask for memory block flags.

Definition at line 27 of file TMemory.h.

◆ TMEMORY_NUM_BLOCK_SLOTS

#define TMEMORY_NUM_BLOCK_SLOTS 128

Maximum number of memory block slots.

Definition at line 29 of file TMemory.h.

◆ TMEMORY_NUM_FREELISTS

#define TMEMORY_NUM_FREELISTS 9

Number of free list buckets for different sizes.

Definition at line 28 of file TMemory.h.

◆ TMEMORY_ROUNDUP

#define TMEMORY_ROUNDUP 4

Minimum alignment for memory blocks.

Definition at line 25 of file TMemory.h.

Function Documentation

◆ operator delete()

TFORCEINLINE void __CRTDECL operator delete	(	void *	ptr,
		Toshi::TMemory::MemBlock *	block )

noexcept

Placement delete operator for memory blocks.

Parameters

ptr	Pointer to memory to free
block	Memory block (unused)

Definition at line 505 of file TMemory.h.

{
    TFree( ptr );
}

◆ operator delete[]()

TFORCEINLINE void __CRTDECL operator delete[]	(	void *	ptr,
		Toshi::TMemory::MemBlock *	block )

noexcept

Placement delete[] operator for memory blocks.

Parameters

ptr	Pointer to memory to free
block	Memory block (unused)

Definition at line 515 of file TMemory.h.

{
    TFree( ptr );
}

◆ operator new()

TFORCEINLINE void *__CRTDECL operator new	(	size_t	size,
		Toshi::TMemory::MemBlock *	block )

Placement new operator for memory blocks.

Parameters

size	Size to allocate
block	Memory block to allocate from

Returns: Pointer to allocated memory

Definition at line 476 of file TMemory.h.

{
#ifdef TOSHI_PROFILER_MEMORY
    return TMalloc( size, block, TMemory__FILE__, TMemory__LINE__ );
#else
    return TMalloc( size, block, TNULL, -1 );
#endif // TOSHI_PROFILER_MEMORY
}

◆ operator new[]()

TFORCEINLINE void *__CRTDECL operator new[]	(	size_t	size,
		Toshi::TMemory::MemBlock *	block )

Placement new[] operator for memory blocks.

Parameters

size	Size to allocate
block	Memory block to allocate from

Returns: Pointer to allocated memory

Definition at line 491 of file TMemory.h.

{
#ifdef TOSHI_PROFILER_MEMORY
    return TMalloc( size, block, TMemory__FILE__, TMemory__LINE__ );
#else
    return TMalloc( size, block, TNULL, -1 );
#endif // TOSHI_PROFILER_MEMORY
}

◆ TConstruct()

template<class T, class... Args>

TFORCEINLINE T * TConstruct	(	T *	a_pMemory,
		Args &&...	args )

Constructs an object in place.

Template Parameters

T	Type of object to construct
Args	Types of constructor arguments

Parameters

a_pMemory	Memory location to construct in
args	Constructor arguments

Returns: Pointer to constructed object

Definition at line 431 of file TMemory.h.

{
    return new ( a_pMemory ) T( std::forward<Args>( args )... );
}

◆ TConstructArray()

template<class T, class... Args>

TFORCEINLINE T * TConstructArray	(	T *	a_pMemory,
		TSIZE	a_uiNumTimes,
		Args &&...	args )

Constructs an array of objects in place.

Template Parameters

T	Type of objects to construct
Args	Types of constructor arguments

Parameters

a_pMemory	Memory location to construct in
a_uiNumTimes	Number of objects to construct
args	Constructor arguments

Returns: Pointer to first constructed object

Definition at line 446 of file TMemory.h.

{
    for ( TSIZE i = 0; i < a_uiNumTimes; i++ )
    {
        new ( a_pMemory + i ) T( std::forward<Args>( args )... );
    }
 
    return a_pMemory;
}

◆ TDestruct()

template<class T>

TFORCEINLINE void TDestruct ( T * a_pPtr )

Destructs an object.

Template Parameters

T	Type of object to destruct

Parameters

a_pPtr Pointer to object to destruct

Definition at line 462 of file TMemory.h.

{
    if ( a_pPtr )
    {
        a_pPtr->~T();
    }
}

◆ TFree()

void TFree ( void * a_pMem )

Frees previously allocated memory.

Parameters

a_pMem Pointer to memory to free

Definition at line 1054 of file TMemory.cpp.

{
    Toshi::g_pMemory->Free( a_pMem );
}

◆ TMalloc() [1/3]

TOSHI_NAMESPACE_END void * TMalloc ( TSIZE a_uiSize )

Allocates memory with default alignment.

Parameters

a_uiSize Size of memory to allocate

Returns: Pointer to allocated memory

Definition at line 1005 of file TMemory.cpp.

{
    auto pMemBlock = Toshi::g_pMemory->GetGlobalBlock();
 
    auto pMem = Toshi::g_pMemory->Alloc( a_uiSize, 16, pMemBlock, TNULL, -1 );
 
    if ( !pMem )
    {
        Toshi::TMemory::DebugPrintHALMemInfo( "Out of Toshi Memory on block [%s]\n", pMemBlock->m_szName );
    }
 
    return pMem;
}

◆ TMalloc() [2/3]

void * TMalloc	(	TSIZE	a_uiSize,
		const TCHAR *	a_szFileName,
		TINT	a_iLineNum )

Allocates memory with debug information.

Parameters

a_uiSize	Size of memory to allocate
a_szFileName	Source file name
a_iLineNum	Source line number

Returns: Pointer to allocated memory

Definition at line 990 of file TMemory.cpp.

{
    auto pMemBlock = Toshi::g_pMemory->GetGlobalBlock();
 
    auto pMem = Toshi::g_pMemory->Alloc( a_uiSize, 16, pMemBlock, a_szFileName, a_iLineNum );
 
    if ( !pMem )
    {
        Toshi::TMemory::DebugPrintHALMemInfo( "Out of Toshi Memory on block [%s]\n", pMemBlock->m_szName );
    }
 
    return pMem;
}

◆ TMalloc() [3/3]

void * TMalloc	(	TSIZE	a_uiSize,
		Toshi::TMemory::MemBlock *	a_pMemBlock,
		const TCHAR *	a_szFileName = TNULL,
		TINT	a_iLineNum = -1 )

Allocates memory from a specific memory block.

Parameters

a_uiSize	Size of memory to allocate
a_pMemBlock	Memory block to allocate from
a_szFileName	Source file name (optional)
a_iLineNum	Source line number (optional)

Returns: Pointer to allocated memory

Definition at line 973 of file TMemory.cpp.

{
    if ( !a_pMemBlock )
    {
        a_pMemBlock = Toshi::g_pMemory->GetGlobalBlock();
    }
 
    auto pMem = Toshi::g_pMemory->Alloc( a_uiSize, 16, a_pMemBlock, a_szFileName, a_iLineNum );
 
    if ( !pMem )
    {
        Toshi::TMemory::DebugPrintHALMemInfo( "Out of Toshi Memory on block [%s]\n", a_pMemBlock->m_szName );
    }
 
    return pMem;
}

◆ TMemalign() [1/2]

void * TMemalign	(	TSIZE	a_uiAlignment,
		TSIZE	a_uiSize,
		Toshi::TMemory::MemBlock *	a_pMemBlock )

Allocates aligned memory from a specific memory block.

Parameters

a_uiAlignment	Alignment requirement
a_uiSize	Size of memory to allocate
a_pMemBlock	Memory block to allocate from

Returns: Pointer to allocated memory

Definition at line 1020 of file TMemory.cpp.

{
    if ( !a_pMemBlock )
    {
        a_pMemBlock = Toshi::g_pMemory->GetGlobalBlock();
    }
 
    auto pMem = Toshi::g_pMemory->Alloc( a_uiSize, a_uiAlignment, a_pMemBlock, TNULL, -1 );
 
    if ( !pMem )
    {
        Toshi::TMemory::DebugPrintHALMemInfo( "Out of Toshi Memory on block [%s]\n", a_pMemBlock->m_szName );
    }
 
    return pMem;
}

◆ TMemalign() [2/2]

void * TMemalign	(	TSIZE	a_uiSize,
		TSIZE	a_uiAlignment )

Allocates aligned memory.

Parameters

a_uiSize	Size of memory to allocate
a_uiAlignment	Alignment requirement

Returns: Pointer to allocated memory

Definition at line 1038 of file TMemory.cpp.

{
    auto pMemBlock = Toshi::g_pMemory->GetGlobalBlock();
 
    auto pMem = Toshi::g_pMemory->Alloc( a_uiSize, a_uiAlignment, pMemBlock, TNULL, -1 );
 
    if ( !pMem )
    {
        Toshi::TMemory::DebugPrintHALMemInfo( "Out of Toshi Memory on block [%s]\n", pMemBlock->m_szName );
    }
 
    return pMem;
}

Variable Documentation

◆ g_pMemory

TOSHI_NAMESPACE_START class TMemory* g_pMemory

extern

Classes

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ TMEMORY_ALLOC_MEMNODE_SIZE

◆ TMEMORY_ALLOC_RESERVED_SIZE

◆ TMEMORY_FLAGS_HOLE_PROCESS

◆ TMEMORY_FLAGS_MASK

◆ TMEMORY_NUM_BLOCK_SLOTS

◆ TMEMORY_NUM_FREELISTS

◆ TMEMORY_ROUNDUP

Function Documentation

◆ operator delete()

◆ operator delete[]()

◆ operator new()

◆ operator new[]()

◆ TConstruct()

◆ TConstructArray()

◆ TDestruct()

◆ TFree()

◆ TMalloc() [1/3]

◆ TMalloc() [2/3]

◆ TMalloc() [3/3]

◆ TMemalign() [1/2]

◆ TMemalign() [2/2]

Variable Documentation

◆ g_pMemory