Class NullMemoryResource

Inheritance Relationships

Base Type

Class Documentation

class NullMemoryResource : public umpire::resource::MemoryResource

Public Functions

NullMemoryResource(Platform platform, const std::string &name, int id, MemoryResourceTraits traits)
void *allocate(std::size_t bytes)

Allocate bytes of memory.

This function is pure virtual and must be implemented by the inheriting class.

Return

Pointer to start of allocation.

Parameters
  • bytes: Number of bytes to allocate.

void deallocate(void *ptr)

Free the memory at ptr.

This function is pure virtual and must be implemented by the inheriting class.

Parameters
  • ptr: Pointer to free.

std::size_t getCurrentSize() const

Return the current size of this MemoryResource.

This is sum of the sizes of all the tracked allocations. Note that this doesn’t ever have to be equal to getHighWatermark.

Return

current total size of active allocations in this MemoryResource.

std::size_t getHighWatermark() const

Return the memory high watermark for this MemoryResource.

This is the largest amount of memory allocated by this Allocator. Note that this may be larger than the largest value returned by getCurrentSize.

Return

Memory high watermark.

Platform getPlatform()

Get the Platform assocatiated with this MemoryResource.

This function is pure virtual and must be implemented by the inheriting class.

Return

Platform associated with this MemoryResource.

MemoryResourceTraits getTraits()
void release()

Release any and all unused memory held by this AllocationStrategy.

std::size_t getActualSize() const

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.

const std::string &getName()

Get the name of this AllocationStrategy.

Return

The name of this AllocationStrategy.

int getId()

Get the id of this AllocationStrategy.

Return

The id of this AllocationStrategy.

Protected Attributes

Platform m_platform
MemoryResourceTraits m_traits
std::string m_name
int m_id