instrumenting_memory_resource_impl.hpp

/*
 * VecMem project, part of the ACTS project (R&D line)
 *
 * (c) 2021-2023 CERN for the benefit of the ACTS project
 *
 * Mozilla Public License Version 2.0
 */
 
#pragma once
 
// Local include(s).
#include "vecmem/memory/instrumenting_memory_resource.hpp"
#include "vecmem/memory/memory_resource.hpp"
 
// System include(s).
#include <cstddef>
#include <functional>
#include <vector>
 
namespace vecmem::details {
 
class instrumenting_memory_resource_impl {
 
public:
    instrumenting_memory_resource_impl(memory_resource& upstream);
 
    const std::vector<instrumenting_memory_resource::memory_event>& get_events(
        void) const;
 
    void add_pre_allocate_hook(std::function<void(std::size_t, std::size_t)> f);
 
    void add_post_allocate_hook(
        std::function<void(std::size_t, std::size_t, void*)> f);
 
    void add_pre_deallocate_hook(
        std::function<void(void*, std::size_t, std::size_t)> f);
 
    void* allocate(std::size_t, std::size_t);
 
    void deallocate(void* p, std::size_t, std::size_t);
 
private:
    /*
     * The upstream memory resource to which requests for allocation and
     * deallocation will be forwarded.
     */
    memory_resource& m_upstream;
 
    /*
     * This list stores a chronological set of requests that were passed to
     * this memory resource.
     */
    std::vector<instrumenting_memory_resource::memory_event> m_events;
 
    /*
     * The list of all pre-allocation hooks.
     */
    std::vector<std::function<void(std::size_t, std::size_t)>>
        m_pre_allocate_hooks;
 
    /*
     * The list of all post-allocation hooks.
     */
    std::vector<std::function<void(std::size_t, std::size_t, void*)>>
        m_post_allocate_hooks;
 
    /*
     * The list of all pre-deallocation hooks.
     */
    std::vector<std::function<void(void*, std::size_t, std::size_t)>>
        m_pre_deallocate_hooks;
 
};  // class instrumenting_memory_resource_impl
 
}  // namespace vecmem::details