Implementation for vecmem::details::instrumenting_memory_resource. More...

#include </home/runner/work/vecmem/vecmem/core/src/memory/details/instrumenting_memory_resource_impl.hpp>

Public Member Functions
	instrumenting_memory_resource_impl (memory_resource &upstream)
	Constructs the instrumenting memory resource implementation.

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

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

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

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

void *	allocate (std::size_t, std::size_t)
	Allocate memory with a upstream memory resource.

void	deallocate (void *p, std::size_t, std::size_t)
	Deallocate previously allocated memory.

Detailed Description

Implementation for vecmem::details::instrumenting_memory_resource.

Constructor & Destructor Documentation

◆ instrumenting_memory_resource_impl()

vecmem::details::instrumenting_memory_resource_impl::instrumenting_memory_resource_impl ( memory_resource & upstream )

Constructs the instrumenting memory resource implementation.

Parameters

[in] upstream The upstream memory resource to use.

Member Function Documentation

◆ add_post_allocate_hook()

void vecmem::details::instrumenting_memory_resource_impl::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::details::instrumenting_memory_resource_impl::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::details::instrumenting_memory_resource_impl::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.

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

core/src/memory/details/instrumenting_memory_resource_impl.hpp
core/src/memory/details/instrumenting_memory_resource_impl.cpp