Class AllocationAdvisor¶
Defined in File AllocationAdvisor.hpp
Inheritance Relationships¶
Base Type¶
public umpire::strategy::AllocationStrategy
(Class AllocationStrategy)
Class Documentation¶
-
class
umpire::strategy
::
AllocationAdvisor
: public umpire::strategy::AllocationStrategy¶ Applies the given MemoryOperation to every allocation.
This AllocationStrategy is designed to be used with the following operations:
Using this AllocationStrategy when combined with a pool like DynamicPool is a good way to mitigate the overhead of applying the memory advice.
Public Functions
-
AllocationAdvisor
(const std::string &name, int id, Allocator allocator, const std::string &advice_operation, int device_id = 0)¶
-
AllocationAdvisor
(const std::string &name, int id, Allocator allocator, const std::string &advice_operation, Allocator accessing_allocator, int device_id = 0)¶
-
void *
allocate
(std::size_t bytes) override¶ Allocate bytes of memory.
- Return
Pointer to start of allocated bytes.
- Parameters
bytes
: Number of bytes to allocate.
-
void
deallocate
(void *ptr) override¶ Free the memory at ptr.
- Parameters
ptr
: Pointer to free.
-
Platform
getPlatform
() noexcept override¶ Get the platform associated with this AllocationStrategy.
The Platform distinguishes the appropriate place to execute operations on memory allocated by this AllocationStrategy.
- Return
The platform associated with this AllocationStrategy.
-
MemoryResourceTraits
getTraits
() const noexcept override¶
-
void
release
()¶ Release any and all unused memory held by this AllocationStrategy.
-
std::size_t
getCurrentSize
() const noexcept¶ Get current (total) size of the allocated memory.
This is the total size of all allocation currently ‘live’ that have been made by this AllocationStrategy object.
- Return
Current total size of allocations.
-
std::size_t
getHighWatermark
() const noexcept¶ Get the high watermark of the total allocated size.
This is equivalent to the highest observed value of getCurrentSize.
- Return
High watermark allocation size.
-
std::size_t
getActualSize
() const noexcept¶ Get the current amount of memory allocated by this allocator.
Note that this can be larger than getCurrentSize(), particularly if the AllocationStrategy implements some kind of pooling.
- Return
The total size of all the memory this object has allocated.
-
std::size_t
getAllocationCount
() const noexcept¶ Get the total number of active allocations by this allocator.
- Return
The total number of active allocations this object has allocated.
-
const std::string &
getName
() noexcept¶ Get the name of this AllocationStrategy.
- Return
The name of this AllocationStrategy.
-
int
getId
() noexcept¶ Get the id of this AllocationStrategy.
- Return
The id of this AllocationStrategy.
-
AllocationStrategy *
getParent
() const noexcept¶ Traces where the allocator came from.
- Return
Pointer to the parent AllocationStrategy.