ippl::LoggingBufferHandler< MemorySpace > Class Template Reference

Decorator class for buffer management that adds logging capabilities to buffer operations. More...

#include <LoggingBufferHandler.h>

Inheritance diagram for ippl::LoggingBufferHandler< MemorySpace >:

Collaboration diagram for ippl::LoggingBufferHandler< MemorySpace >:

Public Types
using	buffer_type = typename BufferHandler< MemorySpace >::buffer_type
using	size_type = typename BufferHandler< MemorySpace >::size_type
Public Types inherited from ippl::BufferHandler< MemorySpace >
using	archive_type = ippl::detail::Archive< MemorySpace >
using	buffer_type = std::shared_ptr< archive_type >
using	size_type = ippl::detail::size_type

Public Member Functions
	LoggingBufferHandler (std::shared_ptr< BufferHandler< MemorySpace > > handler, int rank)
	Constructs a LoggingBufferHandler with an existing buffer handler.
	LoggingBufferHandler ()
	Default constructor, creates an internal BufferHandler for managing buffers. This constructor also initializes the rank by calling MPI_Comm_rank.
buffer_type	getBuffer (size_type size, double overallocation) override
	Allocates or retrieves a buffer and logs the action.
void	freeBuffer (buffer_type buffer) override
	Frees a buffer and logs the action.
void	freeAllBuffers () override
	Frees all buffers and logs the action.
void	deleteAllBuffers () override
	Deletes all buffers and logs the action.
size_type	getUsedSize () const override
	Retrieves the total size of allocated buffers.
size_type	getFreeSize () const override
	Retrieves the total size of free buffers.
const std::vector< LogEntry > &	getLogs () const
	Retrieves the list of log entries.

Detailed Description

template<typename MemorySpace>
class ippl::LoggingBufferHandler< MemorySpace >

Decorator class for buffer management that adds logging capabilities to buffer operations.

LoggingBufferHandler extends the basic functionality of BufferHandler by recording detailed logs of buffer operations, such as allocation, deallocation, and resizing. This allows tracking of memory usage patterns and provides a record of buffer activity.

Template Parameters

MemorySpace

The memory space in which buffers are managed (e.g., HostSpace, CudaSpace).

This class is a decorator for BufferHandler and does not modify buffer management logic. Instead, it adds logging for monitoring purposes.

Constructor & Destructor Documentation

LoggingBufferHandler()

template<typename MemorySpace >

ippl::LoggingBufferHandler< MemorySpace >::LoggingBufferHandler	(	std::shared_ptr< BufferHandler< MemorySpace > >	handler,
		int	rank
	)

Constructs a LoggingBufferHandler with an existing buffer handler.

Parameters

handler	A shared pointer to an BufferHandler instance used for buffer operations.
rank	The MPI rank for logging purposes, used to identify the source of logs.

Member Function Documentation

deleteAllBuffers()

template<typename MemorySpace >

void ippl::LoggingBufferHandler< MemorySpace >::deleteAllBuffers ( )

overridevirtual

Deletes all buffers and logs the action.

Overrides BufferHandler::deleteAllBuffers. Calls BufferHandler::deleteAllBuffers and logs the operation.

Implements ippl::BufferHandler< MemorySpace >.

freeAllBuffers()

template<typename MemorySpace >

void ippl::LoggingBufferHandler< MemorySpace >::freeAllBuffers ( )

overridevirtual

Frees all buffers and logs the action.

Overrides BufferHandler::freeAllBuffers. Calls BufferHandler::freeAllBuffers and logs the operation.

Implements ippl::BufferHandler< MemorySpace >.

freeBuffer()

template<typename MemorySpace >

void ippl::LoggingBufferHandler< MemorySpace >::freeBuffer ( buffer_type  buffer )

overridevirtual

Frees a buffer and logs the action.

Overrides BufferHandler::freeBuffer. Calls BufferHandler::freeBuffer and records the operation in the log.

Parameters

buffer

The buffer to be freed.

Implements ippl::BufferHandler< MemorySpace >.

getBuffer()

template<typename MemorySpace >

LoggingBufferHandler< MemorySpace >::buffer_type ippl::LoggingBufferHandler< MemorySpace >::getBuffer ( size_type  size, double  overallocation  )

overridevirtual

Allocates or retrieves a buffer and logs the action.

Overrides BufferHandler::getBuffer, providing the same buffer allocation behavior while recording an entry in the log with the operation details.

Parameters

size	Requested size of the buffer.
overallocation	Optional multiplier to allocate extra buffer space.

Returns

A buffer object.

Implements ippl::BufferHandler< MemorySpace >.

getFreeSize()

template<typename MemorySpace >

LoggingBufferHandler< MemorySpace >::size_type ippl::LoggingBufferHandler< MemorySpace >::getFreeSize ( ) const

overridevirtual

Retrieves the total size of free buffers.

Returns

The size of free buffers.

Implements ippl::BufferHandler< MemorySpace >.

getLogs()

template<typename MemorySpace >

const std::vector< LogEntry > & ippl::LoggingBufferHandler< MemorySpace >::getLogs

(

)

const

Retrieves the list of log entries.

Returns

A constant reference to a vector containing log entries.

getUsedSize()

template<typename MemorySpace >

LoggingBufferHandler< MemorySpace >::size_type ippl::LoggingBufferHandler< MemorySpace >::getUsedSize ( ) const

overridevirtual

Retrieves the total size of allocated buffers.

Returns

The size of allocated buffers.

Implements ippl::BufferHandler< MemorySpace >.

---

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

• ippl-src/src/Communicate/LoggingBufferHandler.h
• ippl-src/src/Communicate/LoggingBufferHandler.hpp