3 #include <AMReX_Config.H>
14 #include <unordered_set>
46 [[nodiscard]]
void*
alloc (std::size_t nbytes)
final;
51 [[nodiscard]] std::pair<void*,std::size_t>
52 alloc_in_place (
void* pt, std::size_t szmin, std::size_t szmax)
final;
64 void free (
void* vp)
final;
83 std::
size_t sizeOf (
void* p) const noexcept;
85 void PrintUsage (std::
string const& name) const;
87 void PrintUsage (std::ostream& os, std::
string const& name, std::
string const& space) const;
102 Node (
void* a_block,
void* a_owner, std::size_t a_size,
MemStat* a_stat=
nullptr) noexcept
104 m_block(a_block), m_owner(a_owner), m_size(a_size), m_stat(a_stat) {}
107 bool operator< (
const Node& rhs)
const noexcept
109 return std::less<>{}(m_block, rhs.m_block);
115 return m_block == rhs.m_block;
119 [[nodiscard]]
void*
block () const noexcept {
return m_block; }
122 void block (
void* blk) noexcept { m_block = blk; }
125 [[nodiscard]] std::size_t
size () const noexcept {
return m_size; }
128 void size (std::size_t sz) noexcept { m_size = sz; }
130 [[nodiscard]]
void*
owner () const noexcept {
return m_owner; }
133 return m_owner == rhs.m_owner;
143 std::size_t operator() (
const Node& n)
const noexcept {
144 return std::hash<void*>{}(n.m_block);
160 std::vector<std::pair<void*,std::size_t> >
m_alloc;
166 using NL = std::set<Node>;
A virtual base class for objects that manage their own dynamic memory allocation.
Definition: AMReX_Arena.H:100
static void PrintUsage()
Definition: AMReX_Arena.cpp:432
The nodes in our free list and block list.
Definition: AMReX_CArena.H:100
MemStat * m_stat
Used for profiling if this Node represents a user allocated block of memory.
Definition: AMReX_CArena.H:156
MemStat * mem_stat() const
Get the MemStat object of the function where this block was allocated.
Definition: AMReX_CArena.H:137
std::size_t size() const noexcept
The size of the memory block.
Definition: AMReX_CArena.H:125
void * block() const noexcept
The block address.
Definition: AMReX_CArena.H:119
std::size_t m_size
The size of the block we represent.
Definition: AMReX_CArena.H:154
void block(void *blk) noexcept
Set block address.
Definition: AMReX_CArena.H:122
void size(std::size_t sz) noexcept
Set size.
Definition: AMReX_CArena.H:128
void * m_owner
The starting address of the original allocation.
Definition: AMReX_CArena.H:152
void mem_stat(MemStat *a_stat) noexcept
Set MemStat.
Definition: AMReX_CArena.H:140
void * m_block
The block of memory we reference.
Definition: AMReX_CArena.H:150
bool coalescable(const Node &rhs) const noexcept
Definition: AMReX_CArena.H:132
void * owner() const noexcept
Definition: AMReX_CArena.H:130
Node(void *a_block, void *a_owner, std::size_t a_size, MemStat *a_stat=nullptr) noexcept
Definition: AMReX_CArena.H:102
A Concrete Class for Dynamic Memory Management using first fit. This is a coalescing memory manager....
Definition: AMReX_CArena.H:28
NL m_freelist
The free list of allocated but not currently used blocks. Maintained in lo to hi memory sorted order.
Definition: AMReX_CArena.H:172
std::size_t sizeOf(void *p) const noexcept
Return the amount of memory in this pointer. Return 0 for unknown pointer.
Definition: AMReX_CArena.cpp:433
CArena(const CArena &rhs)=delete
friend std::ostream & operator<<(std::ostream &os, const CArena &arena)
Definition: AMReX_CArena.cpp:481
void * shrink_in_place(void *pt, std::size_t new_size) final
Definition: AMReX_CArena.cpp:198
CArena(std::size_t hunk_size=0, ArenaInfo info=ArenaInfo())
Construct a coalescing memory manager. hunk_size is the minimum size of hunks of memory to allocate f...
Definition: AMReX_CArena.cpp:14
std::mutex carena_mutex
Definition: AMReX_CArena.H:188
std::size_t freeUnused_protected() final
Definition: AMReX_CArena.cpp:353
std::size_t heap_space_actually_used() const noexcept
Return the total amount of memory given out via alloc.
Definition: AMReX_CArena.cpp:427
std::size_t heap_space_used() const noexcept
The current amount of heap space used by the CArena object.
Definition: AMReX_CArena.cpp:421
constexpr static std::size_t DefaultHunkSize
The default memory hunk size to grab from the heap.
Definition: AMReX_CArena.H:90
std::pair< void *, std::size_t > alloc_in_place(void *pt, std::size_t szmin, std::size_t szmax) final
Definition: AMReX_CArena.cpp:127
std::set< Node > NL
The type of our freelist and blocklist. We use a set sorted from lo to hi memory addresses.
Definition: AMReX_CArena.H:166
std::size_t m_hunk
The minimal size of hunks to request from system.
Definition: AMReX_CArena.H:181
std::size_t freeUnused() final
Free unused memory back to the system. Return value is the amount memory freed.
Definition: AMReX_CArena.cpp:346
std::size_t m_used
The amount of heap space currently allocated.
Definition: AMReX_CArena.H:183
std::unordered_set< Node, Node::hash > m_busylist
The list of busy blocks. A block is either on the freelist or on the blocklist, but not on both.
Definition: AMReX_CArena.H:179
void * alloc(std::size_t nbytes) final
Allocate some memory.
Definition: AMReX_CArena.cpp:30
CArena(CArena &&rhs)=delete
void free(void *vp) final
Free up allocated memory. Merge neighboring free memory chunks into largest possible chunk.
Definition: AMReX_CArena.cpp:256
~CArena() override
The destructor.
Definition: AMReX_CArena.cpp:22
bool hasFreeDeviceMemory(std::size_t sz) final
Does the device have enough free memory for allocating this much memory? For CPU builds,...
Definition: AMReX_CArena.cpp:379
void * alloc_protected(std::size_t nbytes)
Definition: AMReX_CArena.cpp:38
std::vector< std::pair< void *, std::size_t > > m_alloc
The list of blocks allocated via ::operator new().
Definition: AMReX_CArena.H:160
CArena & operator=(const CArena &rhs)=delete
std::size_t m_actually_used
The amount of memory given out via alloc().
Definition: AMReX_CArena.H:185
Definition: AMReX_Amr.cpp:49
bool operator==(A1 const &a1, A2 const &a2)
Definition: AMReX_GpuAllocators.H:203
Definition: AMReX_Arena.H:53
Definition: AMReX_CArena.H:142
Definition: AMReX_Arena.H:12