pool_memory_resource.hpp

/*
 * VecMem project, part of the ACTS project (R&D line)
 *
 * (c) 2023-2024 CERN for the benefit of the ACTS project
 *
 * Mozilla Public License Version 2.0
 */
#pragma once
 
// Local include(s).
#include "vecmem/memory/details/memory_resource_base.hpp"
#include "vecmem/memory/memory_resource.hpp"
#include "vecmem/vecmem_core_export.hpp"
 
// System include(s).
#include <cstddef>
#include <memory>
 
namespace vecmem {
 
// Forward declaration(s).
namespace details {
class pool_memory_resource_impl;
}
 
class pool_memory_resource final : public details::memory_resource_base {
 
public:
    struct VECMEM_CORE_EXPORT options {
 
        options();
 
        std::size_t min_blocks_per_chunk = 16;
        std::size_t min_bytes_per_chunk = 1024;
        std::size_t max_blocks_per_chunk = static_cast<std::size_t>(1) << 20;
        std::size_t max_bytes_per_chunk = static_cast<std::size_t>(1) << 30;
 
        std::size_t smallest_block_size = alignof(std::max_align_t);
        std::size_t largest_block_size = static_cast<std::size_t>(1) << 20;
 
        std::size_t alignment = alignof(std::max_align_t);
 
        bool cache_oversized = true;
 
        std::size_t cached_size_cutoff_factor = 16;
        std::size_t cached_alignment_cutoff_factor = 16;
 
    };  // struct options
 
    VECMEM_CORE_EXPORT
    pool_memory_resource(memory_resource& upstream,
                         const options& opts = options{});
    VECMEM_CORE_EXPORT
    pool_memory_resource(pool_memory_resource&& parent);
    pool_memory_resource(const pool_memory_resource&) = delete;
 
    VECMEM_CORE_EXPORT
    ~pool_memory_resource();
 
    VECMEM_CORE_EXPORT
    pool_memory_resource& operator=(pool_memory_resource&& rhs);
    pool_memory_resource& operator=(const pool_memory_resource&) = delete;
 
private:
 
    VECMEM_CORE_EXPORT
    virtual void* do_allocate(std::size_t, std::size_t) override final;
    VECMEM_CORE_EXPORT
    virtual void do_deallocate(void* p, std::size_t,
                               std::size_t) override final;
 
 
    std::unique_ptr<details::pool_memory_resource_impl> m_impl;
 
};  // class pool_memory_resource
 
}  // namespace vecmem