qalloc.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012, 2013 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_BASICS_QALLOC_H_INCLUDED
#define RIPPLE_BASICS_QALLOC_H_INCLUDED
 
#include <ripple/basics/ByteUtilities.h>
#include <ripple/basics/contract.h>
#include <boost/intrusive/list.hpp>
#include <cstddef>
#include <cstdint>
#include <cstdlib>
#include <limits>
#include <memory>
#include <new>
#include <sstream>
#include <type_traits>
 
namespace ripple {
 
namespace detail {
 
template <class = void>
class qalloc_impl
{
private:
    class block
    {
    private:
        std::size_t count_ = 0;
        std::size_t bytes_;
        std::size_t remain_;
        std::uint8_t* free_;
 
    public:
        block* next;
 
        block(block const&) = delete;
        block&
        operator=(block const&) = delete;
 
        explicit block(std::size_t bytes);
 
        void*
        allocate(std::size_t bytes, std::size_t align);
 
        bool
        deallocate();
    };
 
    block* used_ = nullptr;
    block* free_ = nullptr;
 
public:
    static constexpr auto block_size = kilobytes(256);
 
    qalloc_impl() = default;
    qalloc_impl(qalloc_impl const&) = delete;
    qalloc_impl&
    operator=(qalloc_impl const&) = delete;
 
    ~qalloc_impl();
 
    void*
    allocate(std::size_t bytes, std::size_t align);
 
    void
    deallocate(void* p);
};
 
}  // namespace detail
 
template <class T, bool ShareOnCopy = true>
class qalloc_type
{
private:
    template <class, bool>
    friend class qalloc_type;
 
    std::shared_ptr<detail::qalloc_impl<>> impl_;
 
public:
    using value_type = T;
    using pointer = T*;
    using const_pointer = T const*;
    using reference = typename std::add_lvalue_reference<T>::type;
    using const_reference = typename std::add_lvalue_reference<T const>::type;
    using propagate_on_container_move_assignment = std::true_type;
 
    template <class U>
    struct rebind
    {
        explicit rebind() = default;
 
        using other = qalloc_type<U, ShareOnCopy>;
    };
 
    qalloc_type(qalloc_type const&) = default;
    qalloc_type(qalloc_type&& other) noexcept = default;
    qalloc_type&
    operator=(qalloc_type const&) = default;
    qalloc_type&
    operator=(qalloc_type&&) noexcept = default;
 
    qalloc_type();
 
    template <class U>
    qalloc_type(qalloc_type<U, ShareOnCopy> const& u);
 
    template <class U>
    U*
    alloc(std::size_t n);
 
    template <class U>
    void
    dealloc(U* p, std::size_t n);
 
    T*
    allocate(std::size_t n);
 
    void
    deallocate(T* p, std::size_t n);
 
    template <class U>
    bool
    operator==(qalloc_type<U, ShareOnCopy> const& u);
 
    template <class U>
    bool
    operator!=(qalloc_type<U, ShareOnCopy> const& u);
 
    qalloc_type
    select_on_container_copy_construction() const;
 
private:
    qalloc_type select_on_copy(std::true_type) const;
 
    qalloc_type select_on_copy(std::false_type) const;
};
 
using qalloc = qalloc_type<int, true>;
 
//------------------------------------------------------------------------------
 
namespace detail {
 
template <class _>
qalloc_impl<_>::block::block(std::size_t bytes)
    : bytes_(bytes - sizeof(*this))
    , remain_(bytes_)
    , free_(reinterpret_cast<std::uint8_t*>(this + 1))
{
}
 
template <class _>
void*
qalloc_impl<_>::block::allocate(std::size_t bytes, std::size_t align)
{
    align = std::max(align, std::alignment_of<block*>::value);
    auto pad = [](void const* p, std::size_t a) {
        auto const i = reinterpret_cast<std::uintptr_t>(p);
        return (a - (i % a)) % a;
    };
 
    auto const n0 = pad(free_ + sizeof(block*), align);
    auto const n1 = n0 + sizeof(block*) + bytes;
    if (remain_ < n1)
        return nullptr;
    auto p = reinterpret_cast<block**>(free_ + n0 + sizeof(block*));
    assert(pad(p - 1, std::alignment_of<block*>::value) == 0);
    p[-1] = this;
    ++count_;
    free_ += n1;
    remain_ -= n1;
    return p;
}
 
template <class _>
bool
qalloc_impl<_>::block::deallocate()
{
    --count_;
    if (count_ > 0)
        return false;
    remain_ = bytes_;
    free_ = reinterpret_cast<std::uint8_t*>(this + 1);
    return true;
}
 
template <class _>
qalloc_impl<_>::~qalloc_impl()
{
    if (used_)
    {
        used_->~block();
        std::free(used_);
    }
    while (free_)
    {
        auto const next = free_->next;
        free_->~block();
        std::free(free_);
        free_ = next;
    }
}
 
template <class _>
void*
qalloc_impl<_>::allocate(std::size_t bytes, std::size_t align)
{
    if (used_)
    {
        auto const p = used_->allocate(bytes, align);
        if (p)
            return p;
        used_ = nullptr;
    }
    if (free_)
    {
        auto const p = free_->allocate(bytes, align);
        if (p)
        {
            used_ = free_;
            free_ = free_->next;
            return p;
        }
    }
    std::size_t const adj_align =
        std::max(align, std::alignment_of<block*>::value);
    std::size_t const min_alloc =  // align up
        ((sizeof(block) + sizeof(block*) + bytes) + (adj_align - 1)) &
        ~(adj_align - 1);
    auto const n = std::max<std::size_t>(block_size, min_alloc);
    block* const b = new (std::malloc(n)) block(n);
    if (!b)
        Throw<std::bad_alloc>();
    used_ = b;
    // VFALCO This has to succeed
    return used_->allocate(bytes, align);
}
 
template <class _>
void
qalloc_impl<_>::deallocate(void* p)
{
    auto const b = reinterpret_cast<block**>(p)[-1];
    if (b->deallocate())
    {
        if (used_ == b)
            used_ = nullptr;
        b->next = free_;
        free_ = b;
    }
}
 
}  // namespace detail
 
//------------------------------------------------------------------------------
 
template <class T, bool ShareOnCopy>
qalloc_type<T, ShareOnCopy>::qalloc_type()
    : impl_(std::make_shared<detail::qalloc_impl<>>())
{
}
 
template <class T, bool ShareOnCopy>
template <class U>
qalloc_type<T, ShareOnCopy>::qalloc_type(qalloc_type<U, ShareOnCopy> const& u)
    : impl_(u.impl_)
{
}
 
template <class T, bool ShareOnCopy>
template <class U>
U*
qalloc_type<T, ShareOnCopy>::alloc(std::size_t n)
{
    if (n > std::numeric_limits<std::size_t>::max() / sizeof(U))
        Throw<std::bad_alloc>();
    auto const bytes = n * sizeof(U);
    return static_cast<U*>(impl_->allocate(bytes, std::alignment_of<U>::value));
}
 
template <class T, bool ShareOnCopy>
template <class U>
inline void
qalloc_type<T, ShareOnCopy>::dealloc(U* p, std::size_t n)
{
    impl_->deallocate(p);
}
 
template <class T, bool ShareOnCopy>
T*
qalloc_type<T, ShareOnCopy>::allocate(std::size_t n)
{
    return alloc<T>(n);
}
 
template <class T, bool ShareOnCopy>
inline void
qalloc_type<T, ShareOnCopy>::deallocate(T* p, std::size_t n)
{
    dealloc(p, n);
}
 
template <class T, bool ShareOnCopy>
template <class U>
inline bool
qalloc_type<T, ShareOnCopy>::operator==(qalloc_type<U, ShareOnCopy> const& u)
{
    return impl_.get() == u.impl_.get();
}
 
template <class T, bool ShareOnCopy>
template <class U>
inline bool
qalloc_type<T, ShareOnCopy>::operator!=(qalloc_type<U, ShareOnCopy> const& u)
{
    return !(*this == u);
}
 
template <class T, bool ShareOnCopy>
auto
qalloc_type<T, ShareOnCopy>::select_on_container_copy_construction() const
    -> qalloc_type
{
    return select_on_copy(std::integral_constant<bool, ShareOnCopy>{});
}
 
template <class T, bool ShareOnCopy>
auto qalloc_type<T, ShareOnCopy>::select_on_copy(std::true_type) const
    -> qalloc_type
{
    return *this;  // shared arena
}
 
template <class T, bool ShareOnCopy>
auto qalloc_type<T, ShareOnCopy>::select_on_copy(std::false_type) const
    -> qalloc_type
{
    return {};  // new arena
}
 
}  // namespace ripple
 
#endif