FMallocBinned4

Optimized virtual memory allocator.

API > API/Runtime > API/Runtime/Core

Optimized virtual memory allocator.

   
Name FMallocBinned4
Type class
Header File /Engine/Source/Runtime/Core/Public/HAL/MallocBinned4.h
Include Path #include "HAL/MallocBinned4.h"

Syntax

class FMallocBinned4 : public TMallocBinnedCommon< FMallocBinned4, 52, >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FMallocBinned4()

   HAL/MallocBinned4.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMallocBinned4()

   HAL/MallocBinned4.h  

Structs

Name Remarks
FFreeBlock Information about a piece of free memory.
FPoolInfo  
FPoolList  
FPoolTable Pool table.
Private  

Enums

Public

Name Remarks
EBlockCanary Canary value used in FFreeBlock A constant value unless we're compiled with fork support in which case there are two values identifying whether the page was allocated pre- or post-fork

Constants

Name Type Remarks Include Path
CurrentCanary EBlockCanary   HAL/MallocBinned4.h
MallocBinned4 FMallocBinned4 *   HAL/MallocBinned4.h
MemSizeToPoolIndex uint8 Mapping of sizes to small table indices. HAL/MallocBinned4.h
PoolIndexMask uint8   HAL/MallocBinned4.h
PreForkFlag uint8 Side-table entry encoding: bits[6:0] = PoolIndex, bit 7 = pre-fork flag. HAL/MallocBinned4.h
SmallBinSizes uint16   HAL/MallocBinned4.h
UnregisteredBlock uint8   HAL/MallocBinned4.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
SmallPoolTables FPoolTable Pool tables for different pool sizes. HAL/MallocBinned4.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
BlockPoolL1Table uint8 **   HAL/MallocBinned4.h  
CachedOSPageAllocator TCachedOSPageAllocator<(64),(64 *1024 *1024) >   HAL/MallocBinned4.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CanaryFail ( const void* Ptr
) const

   HAL/MallocBinned4.h  

void CanaryTest ( const void* Ptr
) const

   HAL/MallocBinned4.h  

void FlushCurrentThreadCacheInternal ( bool bNewEpochOnly
)

   HAL/MallocBinned4.h  

void FreeBundles ( FBundleNode* Bundles,
uint32 PoolIndex
)

   HAL/MallocBinned4.h  

bool GetSmallAllocationSize ( void* Ptr,
SIZE_T& SizeOut
) const

   HAL/MallocBinned4.h  

void * MallocExternalLarge ( SIZE_T Size,
uint32 Alignment
)

   HAL/MallocBinned4.h  

void * MallocExternalSmall ( SIZE_T Size,
uint32 Alignment
)

   HAL/MallocBinned4.h  

uint32 PoolIndexToBinSize ( uint32 PoolIndex
) const

   HAL/MallocBinned4.h  

Public Virtual

Overridden from FMalloc

Name Remarks Include Path Unreal Specifiers

virtual void DumpAllocatorStats ( FOutputDevice& Ar
)

 Dumps current allocator stats to the log. HAL/MallocBinned4.h  

virtual UE_AUTORTFM_NOAUTORTFM void Free ( void* Original
)

 Free HAL/MallocBinned4.h  

virtual bool GetAllocationSize ( void* Original,
SIZE_T& SizeOut
)

 If possible determine the size of the memory allocated at the given address HAL/MallocBinned4.h  

virtual const TCHAR * GetDescriptiveName()

 Gets descriptive name for logging purposes. HAL/MallocBinned4.h  

virtual uint64 GetImmediatelyFreeableCachedMemorySize()

 Returns the amount of free memory cached by the allocator that can be returned to the system in case of a memory shortage HAL/MallocBinned4.h  

virtual uint64 GetTotalFreeCachedMemorySize ()

 Returns the amount of total free memory cached by the allocator. HAL/MallocBinned4.h  

virtual bool IsInternallyThreadSafe()

 Returns if the allocator is guaranteed to be thread-safe and therefore doesn't need a unnecessary thread-safety wrapper around it. HAL/MallocBinned4.h  

virtual UE_AUTORTFM_NOAUTORTFM void * Malloc ( SIZE_T Count,
uint32 Alignment
)

 Malloc HAL/MallocBinned4.h  

virtual void OnMallocInitialized()

 Notifies the malloc implementation that initialization of all allocators in GMalloc is complete, so it's safe to initialize any extra features that require "regular" allocations HAL/MallocBinned4.h  

virtual void OnPostFork()

 Notifies the malloc implementation that the process has forked so we can try and avoid dirtying pre-fork pages. HAL/MallocBinned4.h  

virtual void OnPreFork ()

 Notifies the malloc implementation that the process is about to fork. HAL/MallocBinned4.h  

virtual 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. HAL/MallocBinned4.h  

virtual UE_AUTORTFM_NOAUTORTFM void * Realloc ( void* Original,
SIZE_T Count,
uint32 Alignment
)

 Realloc HAL/MallocBinned4.h  

virtual void Trim ( bool bTrimThreadCaches
)

 Releases as much memory as possible. Must be called from the main thread. HAL/MallocBinned4.h  

virtual void UpdateStats ()

 Called once per frame, gathers and sets all memory allocator statistics into the corresponding stats. HAL/MallocBinned4.h  

virtual bool ValidateHeap()

 Validates the allocator's heap HAL/MallocBinned4.h  

Static

Name Remarks Include Path Unreal Specifiers

static void * AllocateMetaDataMemory ( SIZE_T Size
)

   HAL/MallocBinned4.h  

static void FreeMetaDataMemory ( void* Ptr,
SIZE_T Size
)

   HAL/MallocBinned4.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page