lifo.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ distribution.
 *   (https://github.com/micro-os-plus)
 * Copyright (c) 2016-2023 Liviu Ionescu. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software
 * for any purpose is hereby granted, under the terms of the MIT license.
 *
 * If a copy of the license was not distributed with this file, it can
 * be obtained from https://opensource.org/licenses/mit/.
 */
 
#ifndef CMSIS_PLUS_MEMORY_LIFO_H_
#define CMSIS_PLUS_MEMORY_LIFO_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#include <cmsis-plus/memory/first-fit-top.h>
 
// ----------------------------------------------------------------------------
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
 
// ----------------------------------------------------------------------------
 
namespace os
{
  namespace memory
  {
 
    // ========================================================================
 
    class lifo : public os::memory::first_fit_top
    {
    public:
 
      lifo (void* addr, std::size_t bytes);
 
      lifo (const char* name, void* addr, std::size_t bytes);
 
    protected:
 
      lifo () = default;
 
      lifo (const char* name);
 
    public:
 
      // The rule of five.
      lifo (const lifo&) = delete;
      lifo (lifo&&) = delete;
      lifo&
      operator= (const lifo&) = delete;
      lifo&
      operator= (lifo&&) = delete;
 
      virtual
      ~lifo () override;
 
    protected:
 
      virtual void*
      do_allocate (std::size_t bytes, std::size_t alignment) override;
 
    };
 
    // ========================================================================
 
    template<std::size_t N>
      class lifo_inclusive : public lifo
      {
      public:
 
        static const std::size_t bytes = N;
 
        lifo_inclusive (void);
 
        lifo_inclusive (const char* name);
 
      public:
 
        // The rule of five.
        lifo_inclusive (const lifo_inclusive&) = delete;
        lifo_inclusive (lifo_inclusive&&) = delete;
        lifo_inclusive&
        operator= (const lifo_inclusive&) = delete;
        lifo_inclusive&
        operator= (lifo_inclusive&&) = delete;
 
        virtual
        ~lifo_inclusive ();
 
      protected:
 
        char arena_[bytes];
 
      };
 
    // ========================================================================
 
    template<typename A = os::rtos::memory::allocator<char>>
      class lifo_allocated : public lifo
      {
      public:
 
        using value_type = char;
 
        using allocator_type = A;
 
        using allocator_traits = std::allocator_traits<A>;
 
        // It is recommended to have the same type, but at least the types
        // should have the same size.
        static_assert(sizeof(value_type) == sizeof(typename allocator_traits::value_type),
            "The allocator must be parametrised with a type of same size.");
 
        lifo_allocated (std::size_t bytes, const allocator_type& allocator =
                            allocator_type ());
 
        lifo_allocated (const char* name, std::size_t bytes,
                        const allocator_type& allocator = allocator_type ());
 
      public:
 
        // The rule of five.
        lifo_allocated (const lifo_allocated&) = delete;
        lifo_allocated (lifo_allocated&&) = delete;
        lifo_allocated&
        operator= (const lifo_allocated&) = delete;
        lifo_allocated&
        operator= (lifo_allocated&&) = delete;
 
        virtual
        ~lifo_allocated ();
 
      protected:
 
        allocator_type* allocator_ = nullptr;
 
      };
 
  // -------------------------------------------------------------------------
  } /* namespace memory */
} /* namespace os */
 
// ===== Inline & template implementations ====================================
 
namespace os
{
  namespace memory
  {
 
    // ========================================================================
 
    inline
    lifo::lifo (void* addr, std::size_t bytes) :
        first_fit_top
          { nullptr, addr, bytes }
    {
      trace::printf ("%s(%p,%u) @%p %s\n", __func__, addr, bytes, this,
                     this->name ());
    }
 
    inline
    lifo::lifo (const char* name, void* addr, std::size_t bytes) :
        first_fit_top
          { name, addr, bytes }
    {
      trace::printf ("%s(%p,%u) @%p %s\n", __func__, addr, bytes, this,
                     this->name ());
    }
 
    // ========================================================================
 
    template<std::size_t N>
      inline
      lifo_inclusive<N>::lifo_inclusive () :
          lifo_inclusive (nullptr)
      {
      }
 
    template<std::size_t N>
      inline
      lifo_inclusive<N>::lifo_inclusive (const char* name) :
          lifo
            { name }
      {
        trace::printf ("%s() @%p %s\n", __func__, this, this->name ());
 
        internal_construct_ (&arena_[0], bytes);
      }
 
    template<std::size_t N>
      lifo_inclusive<N>::~lifo_inclusive ()
      {
        trace::printf ("%s() @%p %s\n", __func__, this, this->name ());
      }
 
    // ========================================================================
 
    template<typename A>
      inline
      lifo_allocated<A>::lifo_allocated (std::size_t bytes,
                                         const allocator_type& allocator) :
          lifo_allocated (nullptr, bytes, allocator)
      {
      }
 
    template<typename A>
      lifo_allocated<A>::lifo_allocated (const char* name, std::size_t bytes,
                                         const allocator_type& allocator) :
          lifo
            { name }
      {
        trace::printf ("%s(%u) @%p %s\n", __func__, bytes, this, this->name ());
 
        // Remember the allocator, it'll be used by the destructor.
        allocator_ =
            static_cast<allocator_type*> (&const_cast<allocator_type&> (allocator));
 
        void* addr = allocator_->allocate (bytes);
        if (addr == nullptr)
          {
            estd::__throw_bad_alloc ();
          }
 
        internal_construct_ (addr, bytes);
      }
 
    template<typename A>
      lifo_allocated<A>::~lifo_allocated ()
      {
        trace::printf ("%s() @%p %s\n", __func__, this, this->name ());
 
        // Skip in case a derived class did the deallocation.
        if (allocator_ != nullptr)
          {
            allocator_->deallocate (
                static_cast<typename allocator_traits::pointer> (arena_addr_),
                total_bytes_);
 
            // Prevent another deallocation.
            allocator_ = nullptr;
          }
      }
 
  // --------------------------------------------------------------------------
 
  } /* namespace memory */
} /* namespace os */
 
#pragma GCC diagnostic pop
 
// ----------------------------------------------------------------------------
 
#endif /* __cplusplus */
 
// ----------------------------------------------------------------------------
 
#endif /* CMSIS_PLUS_MEMORY_LIFO_H_ */