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

Light Theme

Dark Theme

FMallocBinned2

Optimized virtual memory allocator.

Windows

MacOS

Linux

Inheritance Hierarchy

FUseSystemMallocForNew

FExec

FMalloc

FMallocBinned2

References

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

Syntax

class FMallocBinned2 : public FMalloc

Remarks

Optimized virtual memory allocator.

Constructors

	Name	Description
	FMallocBinned2()

Destructors

	Name	Description
	~FMallocBinned2()

Functions

		Name	Description
	uint32	BoundSizeToPoolIndex ( SIZE_T Size )
	void	FlushCurrentThreadCache()
	void	FreeExternal ( void* Ptr )
	void	FreeInline ( void* Ptr )
	bool	GetAllocationSizeExternal ( void* Ptr, SIZE_T& SizeOut )
	int64	GetTotalAllocatedSmallPoolMemory()
	void *	MallocExternalLarge ( SIZE_T Size, uint32 Alignment )
	void *	MallocExternalSmall ( SIZE_T Size, uint32 Alignment )
	void *	MallocInline ( SIZE_T Size, uint32 Alignment )
	void *	MallocSelect ( SIZE_T Size, uint32 Alignment )
	uint32	PoolIndexToBlockSize ( uint32 PoolIndex )
	void *	ReallocExternal ( void* Ptr, SIZE_T NewSize, uint32 Alignment )
	void *	ReallocInline ( void* Ptr, SIZE_T NewSize, uint32 Alignment )
	bool	UseSmallAlloc ( SIZE_T Size, uint32 Alignment )

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.
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
	FPoolInfo
	PoolHashBucket	Hash table struct for retrieving allocation book keeping information
	Private

Constants

Name	Description
Binned2TlsSlot
MallocBinned2
MemSizeToIndex	Mapping of sizes to small table indices.
OsAllocationGranularity
PageSize
SmallBlockSizesReversed

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

Take our survey

Dismiss