FOSAllocationDescriptor Struct Reference

Public Types
enum	MagicType : uint64 { Marker = 0xd0c233ccf493dfb0 , Marker = 0xd0c233ccf493dfb0 }
enum class	MagicType : uint64 { Marker = 0xd0c233ccf493dfb0 , Marker = 0xd0c233ccf493dfb0 }

Public Attributes
MagicType	Magic
void *	PointerToUnmap
SIZE_T	SizeToUnmap
SIZE_T	OriginalSizeAsPassed

Detailed Description

This structure is stored in the page after each OS allocation and checks that its properties are valid on Free. Should be less than the page size (4096 on all platforms we support)

Member Enumeration Documentation

MagicType [1/2]

enum FOSAllocationDescriptor::MagicType : uint64

strong

Enumerator
Marker
Marker

MagicType [2/2]

enum class FOSAllocationDescriptor::MagicType : uint64

strong

Enumerator
Marker
Marker

Member Data Documentation

Magic

MagicType FOSAllocationDescriptor::Magic

Magic that makes sure that we are not passed a pointer somewhere into the middle of the allocation (and/or the structure wasn't stomped).

OriginalSizeAsPassed

SIZE_T FOSAllocationDescriptor::OriginalSizeAsPassed

Debug info that makes sure that the correct size is preserved.

PointerToUnmap

void * FOSAllocationDescriptor::PointerToUnmap

This should include the descriptor itself.

SizeToUnmap

SIZE_T FOSAllocationDescriptor::SizeToUnmap

This should include the total size of allocation, so after unmapping it everything is gone, including the descriptor

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Core/Private/Apple/ApplePlatformMemory.cpp
• Engine/Source/Runtime/Core/Private/Unix/UnixPlatformMemory.cpp