Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > HAL > FMallocCallstackHandler

Light Theme

Dark Theme

FMallocCallstackHandler

Windows

MacOS

Linux

Inheritance Hierarchy

FUseSystemMallocForNew

FExec

FMalloc

FMallocCallstackHandler

	FMallocDoubleFreeFinder
	FMallocFrameProfiler

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/HAL/MallocCallstackHandler.h
Include	#include "HAL/MallocCallstackHandler.h"

Syntax

class FMallocCallstackHandler : public FMalloc

Variables

	Name	Description
TArray< FCallSt...	CallStackInfoArray
TMap< FCallStac...	CallStackMapKeyToCallStackIndexMap
FCriticalSectio...	CriticalSection
uint32	DisabledTLS
bool	Initialized
FRWLock	RWLock
FMalloc *	UsedMalloc	Malloc we're based on, aka using under the hood

Constructors

	Name	Description
	FMallocCallstackHandler ( FMalloc* InMalloc )

Functions

		Name	Description
	void	DecDisabled()
	void	DumpStackTraceToLog ( int32 StackIndex )
	int32	GetCallStackIndex()
	void	IncDisabled()
	void	Init()
	bool	IsDisabled()
	void	TrackFree ( void* Ptr, uint32 OldSize, int32 CallStackIndex )
	void	TrackMalloc ( void* Ptr, uint32 Size, int32 CallStackIndex )
	void	TrackRealloc ( void* OldPtr, void* NewPtr, uint32 NewSize, uint32 OldSize, int32 CallStackIndex )

Overridden from FMalloc

	Name	Description
void	ClearAndDisableTLSCachesOnCurrentThread()	Clears the TLS caches on the current thread and disables any future caching.
void	DumpAllocatorStats ( FOutputDevice& Ar )	Dumps current allocator stats to the log.
void	Free ( void* Original )	Free
bool	GetAllocationSize ( void* Original, SIZE_T& SizeOut )	If possible determine the size of the memory allocated at the given address
void	GetAllocatorStats ( FGenericMemoryStats& out_Stats )	Writes allocator stats from the last update into the specified destination.
const TCHAR ...	GetDescriptiveName()	Gets descriptive name for logging purposes.
void	InitializeStatsMetadata()	Initializes stats metadata.
bool	IsInternallyThreadSafe()	Returns if the allocator is guaranteed to be thread-safe and therefore doesn't need a unnecessary thread-safety wrapper around it.
void *	Malloc ( SIZE_T Count, uint32 Alignment )	Malloc
SIZE_T	QuantizeSize ( SIZE_T Count, uint32 Alignment )	For some allocators this will return the actual size that should be requested to eliminate internal fragmentation.
void *	Realloc ( void* Original, SIZE_T Count, uint32 Alignment )	Realloc
void	SetupTLSCachesOnCurrentThread()	Set up TLS caches on the current thread. These are the threads that we can trim.
void	Trim ( bool bTrimThreadCaches )	Releases as much memory as possible. Must be called from the main thread.
void	UpdateStats()	Called once per frame, gathers and sets all memory allocator statistics into the corresponding stats.
bool	ValidateHeap()	Validates the allocator's heap

Classes

	Name	Description
	FCallStackInfo
	FCallStackMapKey	Used as a key in our current allocations/freed allocations maps

Constants

Name	Description
CallStackEntriesToSkipCount
MaxCallStackDepth

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss