malloc_allocator.hpp

Go to the documentation of this file.

// Copyright (C) 2015-2023 Jonathan Müller and foonathan/memory contributors
// SPDX-License-Identifier: Zlib
 
#ifndef WPI_MEMORY_MALLOC_ALLOCATOR_HPP_INCLUDED
#define WPI_MEMORY_MALLOC_ALLOCATOR_HPP_INCLUDED
 
/// \file
/// Class \ref wpi::memory::malloc_allocator.
/// \note Only available on a hosted implementation.
 
#include "config.hpp"
#if !WPI_HOSTED_IMPLEMENTATION
#error "This header is only available for a hosted implementation."
#endif
 
#include <cstdlib>
#include <memory>
 
#include "detail/lowlevel_allocator.hpp"
 
#if WPI_MEMORY_EXTERN_TEMPLATE
#include "allocator_traits.hpp"
#endif
 
namespace wpi
{
    namespace memory
    {
        struct allocator_info;
 
        namespace detail
        {
            struct malloc_allocator_impl
            {
                static allocator_info info() noexcept;
 
                static void* allocate(std::size_t size, std::size_t) noexcept
                {
                    return std::malloc(size);
                }
 
                static void deallocate(void* ptr, std::size_t, std::size_t) noexcept
                {
                    std::free(ptr);
                }
 
                static std::size_t max_node_size() noexcept
                {
                    return std::allocator_traits<std::allocator<char>>::max_size({});
                }
            };
 
            WPI_MEMORY_LL_ALLOCATOR_LEAK_CHECKER(malloc_allocator_impl,
                                                       malloc_alloator_leak_checker)
        } // namespace detail
 
        /// A stateless RawAllocator that allocates memory using <tt>std::malloc()</tt>.
        /// It throws \ref out_of_memory when the allocation fails.
        /// \ingroup memory_allocator
        using malloc_allocator =
            WPI_IMPL_DEFINED(detail::lowlevel_allocator<detail::malloc_allocator_impl>);
 
#if WPI_MEMORY_EXTERN_TEMPLATE
        extern template class detail::lowlevel_allocator<detail::malloc_allocator_impl>;
        extern template class allocator_traits<malloc_allocator>;
#endif
    } // namespace memory
} // namespace wpi
 
#endif //WPI_MEMORY_MALLOC_ALLOCATOR_HPP_INCLUDED