This class allocate, and destroy CPU memory. More...

Detailed Description

This class allocate, and destroy CPU memory.

Allocate memory

Resize memory

Shrink memory

Definition at line 39 of file HeapMemory.hpp.

#include <HeapMemory.hpp>

Inheritance diagram for HeapMemory:

Public Member Functions
bool	copyDeviceToDevice (const HeapMemory &m)
	copy from same Heap to Heap More...

virtual bool	flush ()
	flush the memory

virtual bool	allocate (size_t sz)
	allocate memory More...

virtual void	destroy ()
	destroy memory More...

virtual bool	copy (const memory &m)
	copy memory More...

virtual size_t	size () const
	the the size of the allocated memory More...

virtual bool	resize (size_t sz)
	resize the memory allocated More...

virtual void *	getPointer ()
	get a readable pointer with the data More...

virtual const void *	getPointer () const
	get a readable pointer with the data More...

virtual void *	getDevicePointer ()
	get a device pointer for HeapMemory getPointer and getDevicePointer are equivalents More...

virtual void	fill (unsigned char c)
	fill host and device memory with the selected byte More...

virtual void	hostToDevice ()
	Do nothing.

virtual void	deviceToHost ()
	Do nothing.

virtual void	deviceToHost (size_t start, size_t stop)
	Do nothing.

virtual void	hostToDevice (size_t start, size_t stop)
	Do nothing.

virtual void	incRef ()
	Increment the reference counter.

virtual void	decRef ()
	Decrement the reference counter.

virtual long int	ref ()
	Return the reference counter.

bool	isInitialized ()
	Allocated Memory is never initialized. More...

HeapMemory &	operator= (const HeapMemory &mem)

	HeapMemory (const HeapMemory &mem)

	HeapMemory (HeapMemory &&mem) noexcept

	HeapMemory ()
	Constructor, we choose a default alignment of 32 for avx.

void	swap (HeapMemory &mem)
	Swap the memory. More...

Public Member Functions inherited from memory
virtual	~memory ()
	destructor More...

Static Public Member Functions
static constexpr bool	isDeviceHostSame ()
	Return true if the device and the host pointer are the same. More...

Private Member Functions
bool	copyFromPointer (const void *ptr, size_t sz)
	copy from Pointer to Heap More...

void	setAlignment (size_t align)
	Set alignment the memory will be aligned with this number. More...

Private Attributes
size_t	alignement
	memory alignment

size_t	sz
	Size of the memory.

byte *	dm
	device memory

byte *	dmOrig
	original pointer (before alignment)

long int	ref_cnt
	Reference counter.

Constructor & Destructor Documentation

◆ HeapMemory()

HeapMemory::HeapMemory ( HeapMemory && mem )

inlinenoexcept

move

Definition at line 143 of file HeapMemory.hpp.

Member Function Documentation

◆ allocate()

bool HeapMemory::allocate ( size_t sz )

virtual

allocate memory

Allocate a chunk of memory.

Parameters

sz	size of the chunk of memory to allocate in byte

Allocate the device memory

Implements memory.

Definition at line 33 of file HeapMemory.cpp.

◆ copy()

bool HeapMemory::copy ( const memory & m )

virtual

copy memory

copy the memory

Parameters

m	a memory interface

Here we try to cast memory into HeapMemory

if we fail we get the pointer and simply copy from the pointer

Implements memory.

Definition at line 123 of file HeapMemory.cpp.

◆ copyDeviceToDevice()

bool HeapMemory::copyDeviceToDevice ( const HeapMemory & m )

copy from same Heap to Heap

copy from device to device

copy a piece of memory from device to device

Parameters

m	from where to copy

The source buffer is too big to copy it

Definition at line 103 of file HeapMemory.cpp.

◆ copyFromPointer()

bool HeapMemory::copyFromPointer	(	const void *	ptr,
		size_t	sz
	)

private

copy from Pointer to Heap

copy the data from a pointer

Parameters

ptr

Definition at line 89 of file HeapMemory.cpp.

◆ destroy()

void HeapMemory::destroy ( )

virtual

destroy memory

Destroy the internal memory.

Implements memory.

Definition at line 73 of file HeapMemory.cpp.

◆ fill()

void HeapMemory::fill ( unsigned char c )

virtual

fill host and device memory with the selected byte

Parameters

byte to fill

Implements memory.

Definition at line 22 of file HeapMemory.cpp.

◆ getDevicePointer()

void * HeapMemory::getDevicePointer ( )

virtual

get a device pointer for HeapMemory getPointer and getDevicePointer are equivalents

Return a readable pointer with your data.

Return a readable pointer with your data

Implements memory.

Definition at line 218 of file HeapMemory.cpp.

◆ getPointer() [1/2]

void * HeapMemory::getPointer ( )

virtual

get a readable pointer with the data

Return a readable pointer with your data.

Return a readable pointer with your data

Implements memory.

Definition at line 228 of file HeapMemory.cpp.

◆ getPointer() [2/2]

const void * HeapMemory::getPointer ( ) const

virtual

get a readable pointer with the data

Return a readable pointer with your data.

Return a readable pointer with your data

Implements memory.

Definition at line 239 of file HeapMemory.cpp.

◆ isDeviceHostSame()

static constexpr bool HeapMemory::isDeviceHostSame ( )

inlinestatic

Return true if the device and the host pointer are the same.

Returns: true if they are the same

Definition at line 207 of file HeapMemory.hpp.

◆ isInitialized()

bool HeapMemory::isInitialized ( )

inlinevirtual

Allocated Memory is never initialized.

Returns: false

Implements memory.

Definition at line 123 of file HeapMemory.hpp.

◆ resize()

bool HeapMemory::resize ( size_t sz )

virtual

resize the memory allocated

Resize the allocated memory.

Resize the allocated memory, if request is smaller than the allocated memory is not resized

Parameters

sz size

Returns: true if the resize operation complete correctly

Allocate the device memory if not done yet

Create a new buffer if sz is bigger than the actual size

size plus alignment

align it

copy from the old buffer to the new one

free the old buffer

change to the new buffer

Implements memory.

Definition at line 167 of file HeapMemory.cpp.

◆ setAlignment()

void HeapMemory::setAlignment ( size_t align )

private

Set alignment the memory will be aligned with this number.

set the memory block to be aligned by this number

Definition at line 64 of file HeapMemory.cpp.

◆ size()

size_t HeapMemory::size ( ) const

virtual

the the size of the allocated memory

Get the size of the allocated memory.

Get the size of the allocated memory

Returns: the size of the allocated memory

Implements memory.

Definition at line 153 of file HeapMemory.cpp.

◆ swap()

void HeapMemory::swap ( HeapMemory & mem )

inline

Swap the memory.

Parameters

mem	memory to swap

Definition at line 175 of file HeapMemory.hpp.

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

openfpm_devices/src/memory/HeapMemory.hpp
openfpm_devices/src/memory/HeapMemory.cpp

Detailed Description

Allocate memory

Resize memory

Shrink memory

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ HeapMemory()

Member Function Documentation

◆ allocate()

◆ copy()

◆ copyDeviceToDevice()

◆ copyFromPointer()

◆ destroy()

◆ fill()

◆ getDevicePointer()

◆ getPointer() [1/2]

◆ getPointer() [2/2]

◆ isDeviceHostSame()

◆ isInitialized()

◆ resize()

◆ setAlignment()

◆ size()

◆ swap()