This memory resource forwards allocation and deallocation requests to the upstream resource while recording useful statistics and information about these events. More...

#include <vecmem/memory/instrumenting_memory_resource.hpp>

Inheritance diagram for vecmem::instrumenting_memory_resource:

Classes
struct	memory_event
	Structure describing a memory resource event. More...

Public Member Functions
VECMEM_CORE_EXPORT	instrumenting_memory_resource (memory_resource &upstream)
	Constructs the debug memory resource.

VECMEM_CORE_EXPORT	instrumenting_memory_resource (instrumenting_memory_resource &&parent)
	Move constructor.

	instrumenting_memory_resource (const instrumenting_memory_resource &)=delete
	Disallow copying the memory resource.

VECMEM_CORE_EXPORT	~instrumenting_memory_resource ()
	Destructor.

VECMEM_CORE_EXPORT instrumenting_memory_resource &	operator= (instrumenting_memory_resource &&rhs)
	Move assignment operator.

instrumenting_memory_resource &	operator= (const instrumenting_memory_resource &)=delete
	Disallow copying the memory resource.

VECMEM_CORE_EXPORT const std::vector< memory_event > &	get_events (void) const
	Return a list of memory allocation and deallocation events in chronological order.

VECMEM_CORE_EXPORT void	add_pre_allocate_hook (std::function< void(std::size_t, std::size_t)> f)
	Add a pre-allocation hook.

VECMEM_CORE_EXPORT void	add_post_allocate_hook (std::function< void(std::size_t, std::size_t, void *)> f)
	Add a post-allocation hook.

VECMEM_CORE_EXPORT void	add_pre_deallocate_hook (std::function< void(void *, std::size_t, std::size_t)> f)
	Add a pre-deallocation hook.

Protected Member Functions
Function(s) implementing @c vecmem::memory_resource
virtual VECMEM_CORE_EXPORT bool	do_is_equal (const memory_resource &other) const noexcept
	Compare the equality of `*this` memory resource with another.

Private Member Functions
Function(s) implementing @c vecmem::memory_resource
virtual VECMEM_CORE_EXPORT void *	do_allocate (std::size_t, std::size_t) override final
	Allocate memory with one of the underlying resources.

virtual VECMEM_CORE_EXPORT void	do_deallocate (void *p, std::size_t, std::size_t) override final
	De-allocate a previously allocated memory block.

Detailed Description

This memory resource forwards allocation and deallocation requests to the upstream resource while recording useful statistics and information about these events.

This allocator is here to allow us to debug, to profile, to test, but also to instrument user code.

Constructor & Destructor Documentation

◆ instrumenting_memory_resource()

vecmem::instrumenting_memory_resource::instrumenting_memory_resource ( memory_resource & upstream )

Constructs the debug memory resource.

Parameters

[in] upstream The upstream memory resource to use.

Member Function Documentation

◆ add_post_allocate_hook()

void vecmem::instrumenting_memory_resource::add_post_allocate_hook ( std::function< void(std::size_t, std::size_t, void *)> f )

Add a post-allocation hook.

Whenever memory is allocated, all post-allocation hooks are exectuted. This happens after we know whether the allocation was a success or not, and the pointer that was returned.

The function passed to this function should accept the size of the request as the first argument, the alignment as the second, and the pointer to the allocated memory as the third argument.

◆ add_pre_allocate_hook()

void vecmem::instrumenting_memory_resource::add_pre_allocate_hook ( std::function< void(std::size_t, std::size_t)> f )

Add a pre-allocation hook.

Whenever memory is allocated, all pre-allocation hooks are exectuted. This happens before we know whether the allocation was a success or not.

The function passed to this function should accept the size of the request as the first argument, and the alignment as the second.

◆ add_pre_deallocate_hook()

void vecmem::instrumenting_memory_resource::add_pre_deallocate_hook ( std::function< void(void *, std::size_t, std::size_t)> f )

Add a pre-deallocation hook.

Whenever memory is deallocated, all pre-deallocation hooks are exectuted.]

The function passed to this function should accept the pointer to allocate as its first argument, the size of the request as the second argument, and the alignment as the third.

◆ do_is_equal()

bool vecmem::details::memory_resource_base::do_is_equal ( const memory_resource & other ) const

protectedvirtualnoexceptinherited

Compare the equality of *this memory resource with another.

Parameters

other The other memory resource to compare with

Returns: true if the two memory resources are equal, false otherwise

Reimplemented in vecmem::identity_memory_resource, vecmem::host_memory_resource, and vecmem::terminal_memory_resource.

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

core/include/vecmem/memory/instrumenting_memory_resource.hpp
core/src/memory/instrumenting_memory_resource.cpp

Classes

Public Member Functions

Protected Member Functions

Private Member Functions