memory_block_cache.hpp

/*****************************************************************************
 * \file
 * \brief This header contains definitions for an intrinsically linked list
 *        of available memory_blocks
 *****************************************************************************/

/*
  The MIT License (MIT)

  Copyright (c) 2018 Matthew Rodusek

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
#ifndef BIT_MEMORY_UTILITIES_MEMORY_BLOCK_CACHE_HPP
#define BIT_MEMORY_UTILITIES_MEMORY_BLOCK_CACHE_HPP

#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)

#include "owner.hpp"                 // owner
#include "memory_block.hpp"          // memory_block
#include "pointer_utilities.hpp"     // align_of
#include "uninitialized_storage.hpp" // uninitialized_construct_at

#include <cassert> // assert

namespace bit {
  namespace memory {

    class memory_block_cache
    {
      //-----------------------------------------------------------------------
      // Constructor / Assignment
      //-----------------------------------------------------------------------
    public:

      memory_block_cache() noexcept;

      memory_block_cache( memory_block_cache&& other ) noexcept = default;

      // Deleted copy constructor
      memory_block_cache( const memory_block_cache& other ) = delete;

      //-----------------------------------------------------------------------

      // Deleted move assignment
      memory_block_cache& operator=( memory_block_cache&& other ) = delete;

      // Deleted copy assignment
      memory_block_cache& operator=( const memory_block_cache& other ) = delete;

      //-----------------------------------------------------------------------
      // Observers
      //-----------------------------------------------------------------------
    public:

      bool empty() const noexcept;

      std::size_t size() const noexcept;

      std::size_t size_bytes() const noexcept;

      bool contains( const void* ptr ) const noexcept;

      //-----------------------------------------------------------------------
      // Element Access
      //-----------------------------------------------------------------------
    public:

      const memory_block& peek() const noexcept;

      owner<memory_block> request_block() noexcept;

      template<typename BlockAllocator>
      owner<memory_block> request_block( BlockAllocator& alloc );

      void steal_block( memory_block_cache& other ) noexcept;

      void store_block( owner<memory_block> block ) noexcept;

      //----------------------------------------------------------------------
      // Modifiers
      //----------------------------------------------------------------------
    public:

      void swap( memory_block_cache& other ) noexcept;

      //----------------------------------------------------------------------
      // Private Members
      //----------------------------------------------------------------------
    private:

      memory_block m_head; 
    };

    //------------------------------------------------------------------------
    // Public Functions
    //------------------------------------------------------------------------

    void swap( memory_block_cache& lhs, memory_block_cache& rhs ) noexcept;

  } // namespace memory
} // namespace bit

#include "detail/memory_block_cache.inl"

#endif /* BIT_MEMORY_UTILITIES_MEMORY_BLOCK_CACHE_HPP */