Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType > Class Template Reference

#include <GenericGrowableAllocator.h>

+ Inheritance diagram for TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >:
+ Collaboration diagram for TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >:

Classes

struct  AllocationInfo
 
struct  AllocFreeCounts
 

Public Member Functions

 TGenericGrowableAllocator (uint64 InitialSize, uint32 InType, uint32 InSubAllocationAlignment, FName InStatRegionName, const FName *InOwnerTypeToStatIdMap, void *InUserData)
 
virtual ~TGenericGrowableAllocator ()
 
GrowableAllocationBaseType * Malloc (uint32 Size, uint32 Alignment, int32 OwnerType)
 
bool Free (GrowableAllocationBaseType *Memory)
 
void GetAllocationInfo (uint32 &Chunks, uint64 &Used, uint64 &Free)
 
bool DoesAllocatorContainAddress (const void *Address)
 
void ShowAllocationInfo ()
 
void ShowFullAllocationInfo ()
 
void DumpMemoryInfo ()
 
- Public Member Functions inherited from FGrowableMallocBase
 FGrowableMallocBase ()
 
virtual ~FGrowableMallocBase ()
 
virtual uint64 GetWasteApproximation ()
 

Private Member Functions

void UpdateMemoryStatMaxSizes ()
 
ChunkAllocatorType * CreateAllocChunk (uint64 Size)
 
void RemoveAllocChunk (ChunkAllocatorType *Chunk)
 
void OutOfMemory (uint32 Size)
 

Private Attributes

const uint32 SubAllocationAlignment
 
uint64 CurSizeAllocated
 
uint64 TotalAllocationSize
 
uint64 NumAllocations
 
uint32 MemoryType
 
FName StatRegionName
 
const FName * OwnerTypeToStatIdMap
 
TArray< ChunkAllocatorType * > AllocChunks
 
void * UserData
 
FCriticalSection CriticalSection
 
TMap< int32, AllocationInfo > PerTypeAllocationInfo
 
TMap< uint64, uint32 > TotalAllocationsHistogram
 
TMap< uint64, uint32 > OutstandingAllocationsHistogram
 
TMap< uint64, uint32 > PeakAllocationsHistogram
 

Additional Inherited Members

- Protected Attributes inherited from FGrowableMallocBase
uint64 TotalAllocated
 
uint64 TotalWaste
 
uint64 CurrentAllocs
 
uint64 TotalAllocs
 

Detailed Description

template<typename ChunkAllocatorType, typename GrowableAllocationBaseType>
class TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >

Allocator that will grow as needed with direct mapped memory for a given memory type

Definition at line 512 of file GenericGrowableAllocator.h.

Constructor & Destructor Documentation

◆ TGenericGrowableAllocator()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::TGenericGrowableAllocator ( uint64 InitialSize,
uint32 InType,
uint32 InSubAllocationAlignment,
FName InStatRegionName,
const FName * InOwnerTypeToStatIdMap,
void * InUserData )
inline

Constructor Internally allocates address space for use only by this allocator

Parameters
Type- The templated memory type to allocate with this allocator
StatRegion- The region of memory this is responsible for, for updating the region max sizes

Definition at line 523 of file GenericGrowableAllocator.h.

◆ ~TGenericGrowableAllocator()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
virtual TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::~TGenericGrowableAllocator ( )
inlinevirtual

Destructor

Definition at line 541 of file GenericGrowableAllocator.h.

Member Function Documentation

◆ CreateAllocChunk()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
ChunkAllocatorType * TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::CreateAllocChunk ( uint64 Size)
inlineprivate

Create a new allocation chunk to fit the requested size. All chunks are aligned to MIN_CHUNK_ALIGNMENT

Parameters
Size- size of chunk

Definition at line 804 of file GenericGrowableAllocator.h.

◆ DoesAllocatorContainAddress()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
bool TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::DoesAllocatorContainAddress ( const void * Address)
inline

Definition at line 716 of file GenericGrowableAllocator.h.

◆ DumpMemoryInfo()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
void TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::DumpMemoryInfo ( )
inline

Definition at line 766 of file GenericGrowableAllocator.h.

◆ Free()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
bool TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::Free ( GrowableAllocationBaseType * Memory)
inline

Definition at line 637 of file GenericGrowableAllocator.h.

◆ GetAllocationInfo()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
void TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::GetAllocationInfo ( uint32 & Chunks,
uint64 & Used,
uint64 & Free )
inline

Definition at line 694 of file GenericGrowableAllocator.h.

◆ Malloc()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
GrowableAllocationBaseType * TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::Malloc ( uint32 Size,
uint32 Alignment,
int32 OwnerType )
inline

Definition at line 563 of file GenericGrowableAllocator.h.

◆ OutOfMemory()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
void TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::OutOfMemory ( uint32 Size)
inlineprivate

triggered during out of memory failure for this allocator

Definition at line 855 of file GenericGrowableAllocator.h.

◆ RemoveAllocChunk()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
void TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::RemoveAllocChunk ( ChunkAllocatorType * Chunk)
inlineprivate

Removes an existing allocated chunk. Unmaps its memory, decommits physical memory back to OS, flushes address entries associated with it, and deletes it

Parameters
Chunk- existing chunk to remove

Definition at line 835 of file GenericGrowableAllocator.h.

◆ ShowAllocationInfo()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
void TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::ShowAllocationInfo ( )
inline

Definition at line 733 of file GenericGrowableAllocator.h.

◆ ShowFullAllocationInfo()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
void TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::ShowFullAllocationInfo ( )
inline

Definition at line 740 of file GenericGrowableAllocator.h.

◆ UpdateMemoryStatMaxSizes()

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
void TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::UpdateMemoryStatMaxSizes ( )
inlineprivate

Updates the memory stat max sizes when chunks are added/removed

Definition at line 795 of file GenericGrowableAllocator.h.

Member Data Documentation

◆ AllocChunks

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
TArray<ChunkAllocatorType*> TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::AllocChunks
private

list of currently allocated chunks

Definition at line 883 of file GenericGrowableAllocator.h.

◆ CriticalSection

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
FCriticalSection TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::CriticalSection
private

Definition at line 889 of file GenericGrowableAllocator.h.

◆ CurSizeAllocated

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
uint64 TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::CurSizeAllocated
private

total currently allocated from OS

Definition at line 867 of file GenericGrowableAllocator.h.

◆ MemoryType

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
uint32 TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::MemoryType
private

The type of memory this allocator allocates from the kernel

Definition at line 874 of file GenericGrowableAllocator.h.

◆ NumAllocations

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
uint64 TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::NumAllocations
private

Definition at line 871 of file GenericGrowableAllocator.h.

◆ OutstandingAllocationsHistogram

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
TMap<uint64, uint32> TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::OutstandingAllocationsHistogram
private

Definition at line 909 of file GenericGrowableAllocator.h.

◆ OwnerTypeToStatIdMap

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
const FName* TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::OwnerTypeToStatIdMap
private

For stats/dumping, we use this to convert OwnerType of an allocation to a printable name

Definition at line 880 of file GenericGrowableAllocator.h.

◆ PeakAllocationsHistogram

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
TMap<uint64, uint32> TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::PeakAllocationsHistogram
private

Definition at line 910 of file GenericGrowableAllocator.h.

◆ PerTypeAllocationInfo

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
TMap<int32, AllocationInfo> TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::PerTypeAllocationInfo
private

Definition at line 906 of file GenericGrowableAllocator.h.

◆ StatRegionName

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
FName TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::StatRegionName
private

The stat memory region to update max size

Definition at line 877 of file GenericGrowableAllocator.h.

◆ SubAllocationAlignment

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
const uint32 TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::SubAllocationAlignment
private

Definition at line 864 of file GenericGrowableAllocator.h.

◆ TotalAllocationsHistogram

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
TMap<uint64, uint32> TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::TotalAllocationsHistogram
private

Definition at line 908 of file GenericGrowableAllocator.h.

◆ TotalAllocationSize

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
uint64 TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::TotalAllocationSize
private

Just stat tracking

Definition at line 870 of file GenericGrowableAllocator.h.

◆ UserData

template<typename ChunkAllocatorType , typename GrowableAllocationBaseType >
void* TGenericGrowableAllocator< ChunkAllocatorType, GrowableAllocationBaseType >::UserData
private

Definition at line 886 of file GenericGrowableAllocator.h.

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