Memory Arenas and Allocators

Memory arenas and allocators. More...

Classes
struct	amrex::ArenaInfo
	Configuration options for constructing an Arena. More...
class	amrex::CArena
	A Concrete Class for Dynamic Memory Management using first fit. This is a coalescing memory manager. It allocates (possibly) large chunks of heap space and apportions it out as requested. It merges together neighboring chunks on each free(). More...
class	amrex::ArenaAllocator< T >
class	amrex::DeviceArenaAllocator< T >
class	amrex::PinnedArenaAllocator< T >
class	amrex::ManagedArenaAllocator< T >
class	amrex::AsyncArenaAllocator< T >
class	amrex::PolymorphicArenaAllocator< T >
class	amrex::SArena
	A STREAM-ordered memory arena. More...
class	amrex::Arena
	Abstract base class for memory arenas. More...
class	amrex::BArena
	Basic Arena that allocates aligned memory on the host heap. More...

Functions
std::size_t	amrex::aligned_size (std::size_t align_requirement, std::size_t size) noexcept
	Return the smallest multiple of align_requirement that is >= size.
bool	amrex::is_aligned (const void *p, std::size_t alignment) noexcept
Arena *	amrex::The_Arena ()
Arena *	amrex::The_Async_Arena ()
Arena *	amrex::The_Device_Arena ()
Arena *	amrex::The_Managed_Arena ()
Arena *	amrex::The_Pinned_Arena ()
Arena *	amrex::The_Comms_Arena ()
Arena *	amrex::The_Cpu_Arena ()

Detailed Description

Memory arenas and allocators.

AMReX provides a number of memory arenas and allocators:

• amrex::The_Arena
• amrex::The_Device_Arena
• amrex::The_Managed_Arena
• amrex::The_Async_Arena
• amrex::The_Pinned_Arena
• amrex::The_Cpu_Arena
• amrex::ArenaAllocator
• amrex::DeviceArenaAllocator
• amrex::ManagedArenaAllocator
• amrex::AsyncArenaAllocator
• amrex::PinnedArenaAllocator
• amrex::PolymorphicArenaAllocator
• amrex::Arena
• amrex::CArena
• amrex::SArena

Function Documentation

aligned_size()

std::size_t amrex::aligned_size ( std::size_t  align_requirement, std::size_t  size  )

inlinenoexcept

Return the smallest multiple of align_requirement that is >= size.

is_aligned()

bool amrex::is_aligned ( const void *  p, std::size_t  alignment  )

inlinenoexcept

Return whether the address p is aligned to alignment bytes.

The_Arena()

Arena * amrex::The_Arena

(

)

Return a pointer to The_Arena, the main memory arena.

The_Async_Arena()

Arena * amrex::The_Async_Arena

(

)

Return a pointer to The_Async_Arena, the async-safe GPU device arena.

The_Comms_Arena()

Arena * amrex::The_Comms_Arena

(

)

Return a pointer to The_Comms_Arena, the memory arena used by communication buffers.

The_Cpu_Arena()

Arena * amrex::The_Cpu_Arena

(

)

Return a pointer to The_Cpu_Arena, the CPU memory arena.

The_Device_Arena()

Arena * amrex::The_Device_Arena

(

)

Return a pointer to The_Device_Arena, the GPU device memory arena. It may be an alias to The_Arena.

The_Managed_Arena()

Arena * amrex::The_Managed_Arena

(

)

Return a pointer to The_Managed_Arena, the GPU managed memory arena. It may be an alias to The_Arena.

The_Pinned_Arena()

Arena * amrex::The_Pinned_Arena

(

)

Return a pointer to The_Pinned_Arena, the pinned memory arena.