UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMallocDebug Class Reference

#include <MallocDebug.h>

+ Inheritance diagram for FMallocDebug:

Public Member Functions

 FMallocDebug ()
 
virtual voidMalloc (SIZE_T Size, uint32 Alignment) override
 
virtual voidRealloc (void *InPtr, SIZE_T NewSize, uint32 Alignment) override
 
virtual void Free (void *InPtr) override
 
virtual bool GetAllocationSize (void *Original, SIZE_T &SizeOut) override
 
virtual void DumpAllocatorStats (FOutputDevice &Ar) override
 
virtual bool ValidateHeap () override
 
virtual bool Exec (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar) override
 
virtual const TCHARGetDescriptiveName () override
 
- Public Member Functions inherited from FMalloc
virtual CORE_API voidTryMalloc (SIZE_T Count, uint32 Alignment=DEFAULT_ALIGNMENT)
 
virtual CORE_API voidTryRealloc (void *Original, SIZE_T Count, uint32 Alignment=DEFAULT_ALIGNMENT)
 
virtual CORE_API voidMallocZeroed (SIZE_T Count, uint32 Alignment=DEFAULT_ALIGNMENT)
 
virtual CORE_API voidTryMallocZeroed (SIZE_T Count, uint32 Alignment=DEFAULT_ALIGNMENT)
 
virtual SIZE_T QuantizeSize (SIZE_T Count, uint32 Alignment)
 
virtual void Trim (bool bTrimThreadCaches)
 
virtual void SetupTLSCachesOnCurrentThread ()
 
virtual void MarkTLSCachesAsUsedOnCurrentThread ()
 
virtual void MarkTLSCachesAsUnusedOnCurrentThread ()
 
virtual void ClearAndDisableTLSCachesOnCurrentThread ()
 
virtual CORE_API void InitializeStatsMetadata ()
 
virtual CORE_API void UpdateStats ()
 
virtual CORE_API void GetAllocatorStats (FGenericMemoryStats &out_Stats)
 
virtual bool IsInternallyThreadSafe () const
 
virtual void OnMallocInitialized ()
 
virtual void OnPreFork ()
 
virtual void OnPostFork ()
 
virtual uint64 GetImmediatelyFreeableCachedMemorySize () const
 
virtual uint64 GetTotalFreeCachedMemorySize () const
 
- Public Member Functions inherited from FUseSystemMallocForNew
CORE_API voidoperator new (size_t Size)
 
CORE_API void operator delete (void *Ptr)
 
voidoperator new[] (size_t Size)
 
void operator delete[] (void *Ptr)
 
- Public Member Functions inherited from FExec
virtual CORE_API ~FExec ()
 

Additional Inherited Members

- Static Public Attributes inherited from FMalloc
static CORE_API TAtomic< uint64MaxSingleAlloc
 
- Protected Member Functions inherited from FExec
virtual bool Exec_Runtime (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
 
virtual bool Exec_Dev (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
 
virtual bool Exec_Editor (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
 

Constructor & Destructor Documentation

◆ FMallocDebug()

FMallocDebug::FMallocDebug ( )
inline

Member Function Documentation

◆ DumpAllocatorStats()

virtual void FMallocDebug::DumpAllocatorStats ( FOutputDevice Ar)
inlineoverridevirtual

Dumps details about all allocations to an output device

Parameters
Ar[in] Output device

Reimplemented from FMalloc.

◆ Exec()

virtual bool FMallocDebug::Exec ( UWorld InWorld,
const TCHAR Cmd,
FOutputDevice Ar 
)
inlineoverridevirtual

Exec handler

Parameters
InWorldWorld context
CmdCommand to parse
ArOutput device to log to
Returns
true if command was handled, false otherwise

Reimplemented from FExec.

◆ Free()

virtual void FMallocDebug::Free ( void InPtr)
inlineoverridevirtual

Free

Implements FMalloc.

◆ GetAllocationSize()

virtual bool FMallocDebug::GetAllocationSize ( void Original,
SIZE_T SizeOut 
)
inlineoverridevirtual

If possible determine the size of the memory allocated at the given address

Parameters
Original- Pointer to memory we are checking the size of
SizeOut- If possible, this value is set to the size of the passed in pointer
Returns
true if succeeded

Reimplemented from FMalloc.

◆ GetDescriptiveName()

virtual const TCHAR * FMallocDebug::GetDescriptiveName ( )
inlineoverridevirtual

Gets descriptive name for logging purposes.

Returns
pointer to human-readable malloc name

Reimplemented from FMalloc.

◆ Malloc()

virtual void * FMallocDebug::Malloc ( SIZE_T  Size,
uint32  Alignment 
)
inlineoverridevirtual

Malloc

Implements FMalloc.

◆ Realloc()

virtual void * FMallocDebug::Realloc ( void InPtr,
SIZE_T  NewSize,
uint32  Alignment 
)
inlineoverridevirtual

Realloc

Implements FMalloc.

◆ ValidateHeap()

virtual bool FMallocDebug::ValidateHeap ( )
inlineoverridevirtual

Validates the allocator's heap

Reimplemented from FMalloc.


The documentation for this class was generated from the following file: