allocator that uses array of (ring) buffers to coalesce memory. Requires This allocator propagates on container swap and container move assignment. Use TIMEMORY_RING_BUFFER_ALLOCATOR_BUFFER_COUNT env variable to specify the default number of allocations or use the set_buffer_count / set_buffer_count_cb. When a reserve is requested and the request is greater than the free spaces in the buffer, the free spaces are stored in a "dangling" array of spaces which are used when single allocations are requested. More...

#include "timemory/data/ring_buffer_allocator.hpp"

Collaboration diagram for tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >:

Classes
struct	rebind

Public Types
using	value_type = Tp

using	pointer = Tp *

using	reference = Tp &

using	const_pointer = const Tp *

using	const_reference = const Tp &

using	size_type = size_t

using	difference_type = ptrdiff_t

using	base_type = std::allocator< Tp >

using	buffer_type = data_storage::ring_buffer< Tp >

using	propagate_on_container_move_assignment = std::true_type

using	propagate_on_container_swap = std::true_type

Public Member Functions
	ring_buffer_allocator ()=default

	~ring_buffer_allocator ()=default

	ring_buffer_allocator (const ring_buffer_allocator &)=default

	ring_buffer_allocator (ring_buffer_allocator &&) noexcept=default

ring_buffer_allocator &	operator= (const ring_buffer_allocator &)=default

ring_buffer_allocator &	operator= (ring_buffer_allocator &&) noexcept=default

bool	operator== (const ring_buffer_allocator &rhs) const

bool	operator!= (const ring_buffer_allocator &rhs) const

Tp *	address (Tp &_r) const

const Tp *	address (const Tp &_r) const

size_t	max_size () const

void	construct (Tp *const _p, const Tp &_v) const

void	construct (Tp *const _p, Tp &&_v) const

template<typename... ArgsT>
void	construct (Tp *const _p, ArgsT &&... _args) const

void	destroy (Tp *const _p) const

Tp *	allocate (const size_t n) const

void	deallocate (Tp *const ptr, const size_t n) const

Tp *	allocate (const size_t n, const void *const) const

void	reserve (const size_t n)

void	steal_resources (ring_buffer_allocator &rhs)
	transfers the buffers to another allocator More...

Static Public Member Functions
template<typename FuncT >
static void	set_buffer_count_cb (FuncT &&_f)
	define a callback function for initializing the buffer size. Will throw if a request for the buffer size has already occured. More...

static void	set_buffer_count (size_t _buff_sz)
	set the minimum number of objects for the ring buffer. Will throw if a request for the buffer size has already occured. More...

Detailed Description

template<typename Tp, bool MMapV, size_t BuffCntV>
class tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >

allocator that uses array of (ring) buffers to coalesce memory. Requires This allocator propagates on container swap and container move assignment. Use TIMEMORY_RING_BUFFER_ALLOCATOR_BUFFER_COUNT env variable to specify the default number of allocations or use the set_buffer_count / set_buffer_count_cb. When a reserve is requested and the request is greater than the free spaces in the buffer, the free spaces are stored in a "dangling" array of spaces which are used when single allocations are requested.

Template Parameters

Tp	The data type for the allocator
MMapV	Whether to use mmap (if available)
BuffCntV	The default buffer count (will be rounded up to multiple of page size)

Definition at line 57 of file ring_buffer_allocator.hpp.

Class Documentation

◆ tim::data::ring_buffer_allocator::rebind

struct tim::data::ring_buffer_allocator::rebind

template<typename Tp, bool MMapV, size_t BuffCntV>
template<typename U>
struct tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::rebind< U >

Definition at line 99 of file ring_buffer_allocator.hpp.

Collaboration diagram for tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::rebind< U >:

Class Members
typedef ring_buffer_allocator< U, MMapV, BuffCntV >	other

Member Typedef Documentation

◆ base_type

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::base_type = std::allocator<Tp>

Definition at line 68 of file ring_buffer_allocator.hpp.

◆ buffer_type

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::buffer_type = data_storage::ring_buffer<Tp>

Definition at line 69 of file ring_buffer_allocator.hpp.

◆ const_pointer

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::const_pointer = const Tp*

Definition at line 64 of file ring_buffer_allocator.hpp.

◆ const_reference

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::const_reference = const Tp&

Definition at line 65 of file ring_buffer_allocator.hpp.

◆ difference_type

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::difference_type = ptrdiff_t

Definition at line 67 of file ring_buffer_allocator.hpp.

◆ pointer

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::pointer = Tp*

Definition at line 62 of file ring_buffer_allocator.hpp.

◆ propagate_on_container_move_assignment

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::propagate_on_container_move_assignment = std::true_type

Definition at line 70 of file ring_buffer_allocator.hpp.

◆ propagate_on_container_swap

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::propagate_on_container_swap = std::true_type

Definition at line 71 of file ring_buffer_allocator.hpp.

◆ reference

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::reference = Tp&

Definition at line 63 of file ring_buffer_allocator.hpp.

◆ size_type

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::size_type = size_t

Definition at line 66 of file ring_buffer_allocator.hpp.

◆ value_type

template<typename Tp , bool MMapV, size_t BuffCntV>

using tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::value_type = Tp

Definition at line 61 of file ring_buffer_allocator.hpp.

Constructor & Destructor Documentation

◆ ring_buffer_allocator() [1/3]

template<typename Tp , bool MMapV, size_t BuffCntV>

tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::ring_buffer_allocator ( )

default

◆ ~ring_buffer_allocator()

template<typename Tp , bool MMapV, size_t BuffCntV>

tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::~ring_buffer_allocator ( )

default

◆ ring_buffer_allocator() [2/3]

template<typename Tp , bool MMapV, size_t BuffCntV>

tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::ring_buffer_allocator ( const ring_buffer_allocator< Tp, MMapV, BuffCntV > & )

default

◆ ring_buffer_allocator() [3/3]

template<typename Tp , bool MMapV, size_t BuffCntV>

tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::ring_buffer_allocator ( ring_buffer_allocator< Tp, MMapV, BuffCntV > && )

defaultnoexcept

Member Function Documentation

◆ address() [1/2]

template<typename Tp , bool MMapV, size_t BuffCntV>

const Tp * tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::address ( const Tp & _r ) const

inline

Definition at line 89 of file ring_buffer_allocator.hpp.

89{ return &_r; }

◆ address() [2/2]

template<typename Tp , bool MMapV, size_t BuffCntV>

Tp * tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::address ( Tp & _r ) const

inline

Definition at line 88 of file ring_buffer_allocator.hpp.

88{ return &_r; }

◆ allocate() [1/2]

template<typename Tp , bool MMapV, size_t BuffCntV>

Tp * tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::allocate ( const size_t n ) const

inline

Definition at line 116 of file ring_buffer_allocator.hpp.

    {
        if(n == 0)
            return nullptr;
 
        // integer overflow check that throws std::length_error in case of overflow
        if(n > max_size())
        {
            throw std::length_error(
                "ring_buffer_allocator<Tp>::allocate() - Integer overflow.");
        }
 
        // for a single allocation, try to reuse dangling allocations
        if(n == 1 && !m_buffer_data->dangles.empty())
        {
            Tp* _p = m_buffer_data->dangles.back();
            m_buffer_data->dangles.pop_back();
            return _p;
        }
 
        // ensure m_buffer_data->current is assigned and a buffer has been created
        init_current(n);
 
        // when n is greater than the remainder of the ring buffer allocation,
        // add the remainder of the allocation to the dangling allocations and
        // then reinitialize current with n to ensure that the memory is contiguous
        if(n > m_buffer_data->current->free())
        {
            m_buffer_data->dangles.reserve(m_buffer_data->dangles.size() +
                                           m_buffer_data->current->free());
            for(size_t i = 0; i < m_buffer_data->current->free(); ++i)
            {
                auto _req = m_buffer_data->current->request();
                if(_req)
                    break;
                m_buffer_data->dangles.emplace_back(_req);
            }
            // ensure a new buffer is created
            m_buffer_data->current = nullptr;
            // new buffer will have at least n pages of contiguous memory
            init_current(n);
        }
 
        // get first entry
        auto* _p = m_buffer_data->current->request();
 
        // ensure that extra remainder is marked as used by ring buffer
        for(size_t i = 1; i < n; ++i)
            m_buffer_data->current->request();
 
        return _p;
    }

References tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::max_size().

Referenced by tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::allocate().

◆ allocate() [2/2]

template<typename Tp , bool MMapV, size_t BuffCntV>

Tp * tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::allocate	(	const size_t	n,
		const void * const
	)		const

inline

Definition at line 182 of file ring_buffer_allocator.hpp.

    {
        return allocate(n);
    }

References tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::allocate().

◆ construct() [1/3]

template<typename Tp , bool MMapV, size_t BuffCntV>

template<typename... ArgsT>

void tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::construct	(	Tp *const	_p,
		ArgsT &&...	_args
	)		const

inline

Definition at line 109 of file ring_buffer_allocator.hpp.

    {
        ::new((void*) _p) Tp{ std::forward<ArgsT>(_args)... };
    }

References tim::_args.

◆ construct() [2/3]

template<typename Tp , bool MMapV, size_t BuffCntV>

void tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::construct	(	Tp *const	_p,
		const Tp &	_v
	)		const

inline

Definition at line 104 of file ring_buffer_allocator.hpp.

104{ ::new((void*) _p) Tp{ _v }; }

◆ construct() [3/3]

template<typename Tp , bool MMapV, size_t BuffCntV>

void tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::construct	(	Tp *const	_p,
		Tp &&	_v
	)		const

inline

Definition at line 106 of file ring_buffer_allocator.hpp.

106{ ::new((void*) _p) Tp{ std::move(_v) }; }

◆ deallocate()

template<typename Tp , bool MMapV, size_t BuffCntV>

void tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::deallocate	(	Tp *const	ptr,
		const size_t	n
	)		const

inline

Definition at line 169 of file ring_buffer_allocator.hpp.

    {
        // reserve if n > 1
        if(n > 1)
            m_buffer_data->dangles.reserve(m_buffer_data->dangles.size() + n);
        // place all "deallocated" pointers in dangling array
        for(size_t i = 0; i < n; ++i)
        {
            Tp* _p = ptr + i;
            m_buffer_data->dangles.emplace_back(_p);
        }
    }

◆ destroy()

template<typename Tp , bool MMapV, size_t BuffCntV>

void tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::destroy ( Tp *const _p ) const

inline

Definition at line 114 of file ring_buffer_allocator.hpp.

114{ _p->~Tp(); }

◆ max_size()

template<typename Tp , bool MMapV, size_t BuffCntV>

size_t tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::max_size ( ) const

inline

Definition at line 91 of file ring_buffer_allocator.hpp.

    {
        // avoid signed/unsigned warnings independent of size_t definition
        return (static_cast<size_t>(0) - static_cast<size_t>(1)) / sizeof(Tp);
    }

Referenced by tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::allocate().

◆ operator!=()

template<typename Tp , bool MMapV, size_t BuffCntV>

bool tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::operator!= ( const ring_buffer_allocator< Tp, MMapV, BuffCntV > & rhs ) const

inline

Definition at line 85 of file ring_buffer_allocator.hpp.

85{ return (this != &rhs); }

◆ operator=() [1/2]

template<typename Tp , bool MMapV, size_t BuffCntV>

ring_buffer_allocator & tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::operator= ( const ring_buffer_allocator< Tp, MMapV, BuffCntV > & )

default

◆ operator=() [2/2]

template<typename Tp , bool MMapV, size_t BuffCntV>

ring_buffer_allocator & tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::operator= ( ring_buffer_allocator< Tp, MMapV, BuffCntV > && )

defaultnoexcept

◆ operator==()

template<typename Tp , bool MMapV, size_t BuffCntV>

bool tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::operator== ( const ring_buffer_allocator< Tp, MMapV, BuffCntV > & rhs ) const

inline

Definition at line 84 of file ring_buffer_allocator.hpp.

84{ return (this == &rhs); }

◆ reserve()

template<typename Tp , bool MMapV, size_t BuffCntV>

void tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::reserve ( const size_t n )

inline

Definition at line 187 of file ring_buffer_allocator.hpp.

187{ init_current(n); }

◆ set_buffer_count()

template<typename Tp , bool MMapV, size_t BuffCntV>

static void tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::set_buffer_count ( size_t _buff_sz )

inlinestatic

set the minimum number of objects for the ring buffer. Will throw if a request for the buffer size has already occured.

Definition at line 201 of file ring_buffer_allocator.hpp.

    {
        set_buffer_count_cb([_buff_sz]() { return _buff_sz; });
    }

References tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::set_buffer_count_cb().

◆ set_buffer_count_cb()

template<typename Tp , bool MMapV, size_t BuffCntV>

template<typename FuncT >

static void tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::set_buffer_count_cb ( FuncT && _f )

inlinestatic

define a callback function for initializing the buffer size. Will throw if a request for the buffer size has already occured.

Definition at line 192 of file ring_buffer_allocator.hpp.

    {
        if(BuffCntV > 0 || get_config_data().initialized)
            throw std::runtime_error("Error! Buffer size has already been fixed");
        get_config_data().buffer_count_cb = std::forward<FuncT>(_f);
    }

Referenced by tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::set_buffer_count().

◆ steal_resources()

template<typename Tp , bool MMapV, size_t BuffCntV>

void tim::data::ring_buffer_allocator< Tp, MMapV, BuffCntV >::steal_resources ( ring_buffer_allocator< Tp, MMapV, BuffCntV > & rhs )

inline

transfers the buffers to another allocator

Definition at line 207 of file ring_buffer_allocator.hpp.

    {
        m_buffer_data->buffers.reserve(m_buffer_data->buffers.size() +
                                       rhs.m_buffer_this.buffers.size());
        m_buffer_data->dangles.reserve(m_buffer_data->dangles.size() +
                                       rhs.m_buffer_this.dangles.size());
        for(auto& itr : rhs.m_buffer_this.buffers)
            m_buffer_data->buffers.emplace_back(std::move(itr));
        for(auto& itr : rhs.m_buffer_this.dangles)
            m_buffer_data->dangles.emplace_back(itr);
        if(m_buffer_data->current == nullptr)
            m_buffer_data->current = rhs.m_buffer_this.current;
        rhs.m_buffer_data = m_buffer_data;
    }

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

timemory/data/ring_buffer_allocator.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Class Documentation

◆ tim::data::ring_buffer_allocator::rebind

Member Typedef Documentation

◆ base_type

◆ buffer_type

◆ const_pointer

◆ const_reference

◆ difference_type

◆ pointer

◆ propagate_on_container_move_assignment

◆ propagate_on_container_swap

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ ring_buffer_allocator() [1/3]

◆ ~ring_buffer_allocator()

◆ ring_buffer_allocator() [2/3]

◆ ring_buffer_allocator() [3/3]

Member Function Documentation

◆ address() [1/2]

◆ address() [2/2]

◆ allocate() [1/2]

◆ allocate() [2/2]

◆ construct() [1/3]

◆ construct() [2/3]

◆ construct() [3/3]

◆ deallocate()

◆ destroy()

◆ max_size()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ reserve()

◆ set_buffer_count()

◆ set_buffer_count_cb()

◆ steal_resources()