Arcane::AllocatedMemoryInfo Class Reference

Information about an allocated memory region. More...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/common/arccore/common/AllocatedMemoryInfo.h>

Collaboration diagram for Arcane::AllocatedMemoryInfo:

Public Member Functions
	AllocatedMemoryInfo (void *base_address)
	AllocatedMemoryInfo (void *base_address, Int64 size)
	AllocatedMemoryInfo (void *base_address, Int64 size, Int64 capacity)
void *	baseAddress () const
	Address of the start of the allocated region.
Int64	size () const
	Size in bytes of the used memory region. (-1) if unknown.
Int64	capacity () const
	Size in bytes of the allocated memory region. (-1) if unknown.

Public Attributes
void *	m_base_address = nullptr
Int64	m_size = -1
Int64	m_capacity = -1

Detailed Description

Information about an allocated memory region.

Definition at line 31 of file AllocatedMemoryInfo.h.

Constructor & Destructor Documentation

AllocatedMemoryInfo() [1/3]

Arcane::AllocatedMemoryInfo::AllocatedMemoryInfo ( void * base_address )

inlineexplicit

Definition at line 36 of file AllocatedMemoryInfo.h.

AllocatedMemoryInfo() [2/3]

Arcane::AllocatedMemoryInfo::AllocatedMemoryInfo ( void * base_address, Int64 size )

inline

Definition at line 39 of file AllocatedMemoryInfo.h.

AllocatedMemoryInfo() [3/3]

Arcane::AllocatedMemoryInfo::AllocatedMemoryInfo ( void * base_address, Int64 size, Int64 capacity )

inline

Definition at line 44 of file AllocatedMemoryInfo.h.

Member Function Documentation

baseAddress()

void * Arcane::AllocatedMemoryInfo::baseAddress ( ) const

inline

Address of the start of the allocated region.

Definition at line 51 of file AllocatedMemoryInfo.h.

Referenced by Arcane::PrintableMemoryAllocator::allocate(), Arcane::IMemoryAllocator::copyMemory(), Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase::deallocate(), Arcane::AlignedMemoryAllocator::deallocate(), Arcane::DefaultMemoryAllocator::deallocate(), Arcane::MachineShMemWinMemoryAllocator::deallocate(), Arcane::PrintableMemoryAllocator::deallocate(), Arcane::Accelerator::AcceleratorMemoryAllocatorBase::reallocate(), Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase::reallocate(), Arcane::AlignedMemoryAllocator::reallocate(), Arcane::DefaultMemoryAllocator::reallocate(), Arcane::Impl::StackMemoryAllocator::reallocate(), Arcane::MachineShMemWinMemoryAllocator::reallocate(), Arcane::PrintableMemoryAllocator::reallocate(), and Arcane::MachineShMemWinVariableBase::segmentView().

Here is the caller graph for this function:

capacity()

Int64 Arcane::AllocatedMemoryInfo::capacity ( ) const

inline

Size in bytes of the allocated memory region. (-1) if unknown.

Definition at line 55 of file AllocatedMemoryInfo.h.

Referenced by Arcane::Accelerator::AcceleratorMemoryAllocatorBase::reallocate().

Here is the caller graph for this function:

size()

Int64 Arcane::AllocatedMemoryInfo::size ( ) const

inline

Size in bytes of the used memory region. (-1) if unknown.

Definition at line 53 of file AllocatedMemoryInfo.h.

Referenced by Arcane::MachineShMemWinMemoryAllocator::deallocate(), Arcane::Accelerator::AcceleratorMemoryAllocatorBase::reallocate(), and Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase::reallocate().

Here is the caller graph for this function:

Member Data Documentation

m_base_address

void* Arcane::AllocatedMemoryInfo::m_base_address = nullptr

Definition at line 59 of file AllocatedMemoryInfo.h.

m_capacity

Int64 Arcane::AllocatedMemoryInfo::m_capacity = -1

Definition at line 61 of file AllocatedMemoryInfo.h.

m_size

Int64 Arcane::AllocatedMemoryInfo::m_size = -1

Definition at line 60 of file AllocatedMemoryInfo.h.

---

The documentation for this class was generated from the following file:

• AllocatedMemoryInfo.h