os-mempool.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_RTOS_OS_MEMPOOL_H_
#define CMSIS_PLUS_RTOS_OS_MEMPOOL_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#if defined(OS_USE_OS_APP_CONFIG_H)
#include <cmsis-plus/os-app-config.h>
#endif
 
#include <cmsis-plus/rtos/os-decls.h>
#include <cmsis-plus/rtos/os-memory.h>
 
#include <cmsis-plus/diag/trace.h>
 
// ----------------------------------------------------------------------------
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#pragma clang diagnostic ignored "-Wdocumentation-unknown-command"
#endif
 
// ----------------------------------------------------------------------------
 
namespace os
{
  namespace rtos
  {
 
    // ========================================================================
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wpadded"
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wpadded"
#endif
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wsuggest-final-methods"
#pragma GCC diagnostic ignored "-Wsuggest-final-types"
#endif
    class memory_pool : public internal::object_named_system
    {
    public:
 
      // ======================================================================
 
      using size_t = uint16_t;
 
      static constexpr memory_pool::size_t max_size =
          static_cast<memory_pool::size_t> (0 - 1);
 
      // ======================================================================
 
      class attributes : public internal::attributes_clocked
      {
      public:
 
        constexpr
        attributes ();
 
        // The rule of five.
        attributes (const attributes&) = default;
        attributes (attributes&&) = default;
        attributes&
        operator= (const attributes&) = default;
        attributes&
        operator= (attributes&&) = default;
 
        ~attributes () = default;
 
      public:
 
        // Public members; no accessors and mutators required.
        // Warning: must match the type & order of the C file header.
        void* mp_pool_address = nullptr;
 
        std::size_t mp_pool_size_bytes = 0;
 
        // Add more attributes here.
 
      }; /* class attributes */
 
      static const attributes initializer;
 
      template<typename T, std::size_t blocks, std::size_t block_size_bytes>
        class arena
        {
        public:
          T pool[(blocks * block_size_bytes + sizeof(T) - 1) / sizeof(T)];
        };
 
      template<typename T>
        constexpr std::size_t
        compute_allocated_size_bytes (std::size_t blocks,
                                      std::size_t block_size_bytes)
        {
          // Align each block
          return (blocks
              * ((block_size_bytes + (sizeof(T) - 1)) & ~(sizeof(T) - 1)));
        }
 
      // ======================================================================
 
      using allocator_type = memory::allocator<thread::stack::allocation_element_t>;
 
      memory_pool (std::size_t blocks, std::size_t block_size_bytes,
                   const attributes& attr = initializer,
                   const allocator_type& allocator = allocator_type ());
      memory_pool (const char* name, std::size_t blocks,
                   std::size_t block_size_bytes, const attributes& attr =
                       initializer,
                   const allocator_type& allocator = allocator_type ());
 
    protected:
 
      // Internal constructors, used from templates.
      memory_pool ();
      memory_pool (const char* name);
 
    public:
 
      // The rule of five.
      memory_pool (const memory_pool&) = delete;
      memory_pool (memory_pool&&) = delete;
      memory_pool&
      operator= (const memory_pool&) = delete;
      memory_pool&
      operator= (memory_pool&&) = delete;
 
    public:
 
      virtual
      ~memory_pool ();
 
      bool
      operator== (const memory_pool& rhs) const;
 
    public:
 
      void*
      alloc (void);
 
      void*
      try_alloc (void);
 
      void*
      timed_alloc (clock::duration_t timeout);
 
      result_t
      free (void* block);
 
      std::size_t
      capacity (void) const;
 
      std::size_t
      count (void) const;
 
      std::size_t
      block_size (void) const;
 
      bool
      empty (void) const;
 
      bool
      full (void) const;
 
      result_t
      reset (void);
 
      void*
      pool (void);
 
    protected:
 
      void
      internal_construct_ (std::size_t blocks, std::size_t block_size_bytes,
                           const attributes& attr, void* pool_address,
                           std::size_t pool_size_bytes);
 
      void
      internal_init_ (void);
 
      void*
      internal_try_first_ (void);
 
    protected:
 
#if !defined(OS_USE_RTOS_PORT_MEMORY_POOL)
      internal::waiting_threads_list list_;
      clock* clock_ = nullptr;
#endif
      void* pool_addr_ = nullptr;
      void* allocated_pool_addr_ = nullptr;
 
      const void* allocator_ = nullptr;
 
#if defined(OS_USE_RTOS_PORT_MEMORY_POOL)
      friend class port::memory_pool;
      os_mempool_port_data_t port_;
#endif
 
      std::size_t pool_size_bytes_ = 0;
      std::size_t allocated_pool_size_elements_ = 0;
 
      memory_pool::size_t blocks_ = 0;
 
      memory_pool::size_t block_size_bytes_ = 0;
 
      volatile memory_pool::size_t count_ = 0;
 
      void* volatile first_ = nullptr;
 
    };
#pragma GCC diagnostic pop
 
    // ========================================================================
 
    template<typename Allocator = memory::allocator<void*>>
      class memory_pool_allocated : public memory_pool
      {
      public:
 
        using allocator_type = Allocator;
 
        memory_pool_allocated (std::size_t blocks, std::size_t block_size_bytes,
                               const attributes& attr = initializer,
                               const allocator_type& allocator =
                                   allocator_type ());
 
        memory_pool_allocated (const char* name, std::size_t blocks,
                               std::size_t block_size_bytes,
                               const attributes& attr = initializer,
                               const allocator_type& allocator =
                                   allocator_type ());
 
        // The rule of five.
        memory_pool_allocated (const memory_pool_allocated&) = delete;
        memory_pool_allocated (memory_pool_allocated&&) = delete;
        memory_pool_allocated&
        operator= (const memory_pool_allocated&) = delete;
        memory_pool_allocated&
        operator= (memory_pool_allocated&&) = delete;
 
        virtual
        ~memory_pool_allocated () override;
 
      };
 
    // ========================================================================
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wsuggest-final-methods"
#pragma GCC diagnostic ignored "-Wsuggest-final-types"
#endif
    template<typename T, typename Allocator = memory::allocator<void*>>
      class memory_pool_typed : public memory_pool_allocated<Allocator>
      {
      public:
 
        using value_type = T;
        using allocator_type = Allocator;
 
        memory_pool_typed (std::size_t blocks,
                           const memory_pool::attributes& attr =
                               memory_pool::initializer,
                           const allocator_type& allocator = allocator_type ());
 
        memory_pool_typed (const char* name, std::size_t blocks,
                           const memory_pool::attributes& attr =
                               memory_pool::initializer,
                           const allocator_type& allocator = allocator_type ());
 
        // The rule of five.
        memory_pool_typed (const memory_pool_typed&) = delete;
        memory_pool_typed (memory_pool_typed&&) = delete;
        memory_pool_typed&
        operator= (const memory_pool_typed&) = delete;
        memory_pool_typed&
        operator= (memory_pool_typed&&) = delete;
 
        virtual
        ~memory_pool_typed () override;
 
      public:
 
        value_type*
        alloc (void);
 
        value_type*
        try_alloc (void);
 
        value_type*
        timed_alloc (clock::duration_t timeout);
 
        result_t
        free (value_type* block);
 
      };
#pragma GCC diagnostic pop
 
    // ========================================================================
 
    template<typename T, std::size_t N>
      class memory_pool_inclusive : public memory_pool
      {
      public:
 
        using value_type = T;
 
        static const std::size_t blocks = N;
 
        memory_pool_inclusive (const attributes& attr = initializer);
 
        memory_pool_inclusive (const char* name, const attributes& attr =
                                   initializer);
 
        // The rule of five.
        memory_pool_inclusive (const memory_pool_inclusive&) = delete;
        memory_pool_inclusive (memory_pool_inclusive&&) = delete;
        memory_pool_inclusive&
        operator= (const memory_pool_inclusive&) = delete;
        memory_pool_inclusive&
        operator= (memory_pool_inclusive&&) = delete;
 
        virtual
        ~memory_pool_inclusive () override;
 
      protected:
 
        arena<void*, blocks, sizeof(T)> arena_;
 
      public:
 
        value_type*
        alloc (void);
 
        value_type*
        try_alloc (void);
 
        value_type*
        timed_alloc (clock::duration_t timeout);
 
        result_t
        free (value_type* block);
 
      };
 
#pragma GCC diagnostic pop
 
  } /* namespace rtos */
} /* namespace os */
 
// ===== Inline & template implementations ====================================
 
namespace os
{
  namespace rtos
  {
    constexpr
    memory_pool::attributes::attributes ()
    {
    }
 
    // ========================================================================
 
    inline bool
    memory_pool::operator== (const memory_pool& rhs) const
    {
      return this == &rhs;
    }
 
    inline std::size_t
    memory_pool::capacity (void) const
    {
      return blocks_;
    }
 
    inline std::size_t
    memory_pool::block_size (void) const
    {
      return block_size_bytes_;
    }
 
    inline std::size_t
    memory_pool::count (void) const
    {
      return count_;
    }
 
    inline bool
    memory_pool::empty (void) const
    {
      return (count () == 0);
    }
 
    inline bool
    memory_pool::full (void) const
    {
      return (count () == capacity ());
    }
 
    inline void*
    memory_pool::pool (void)
    {
      return pool_addr_;
    }
 
    // ========================================================================
 
    template<typename Allocator>
      inline
      memory_pool_allocated<Allocator>::memory_pool_allocated (
          std::size_t blocks, std::size_t block_size_bytes,
          const attributes& attr, const allocator_type& allocator) :
          memory_pool_allocated
            { nullptr, blocks, block_size_bytes, attr, allocator }
      {
      }
 
    template<typename Allocator>
      memory_pool_allocated<Allocator>::memory_pool_allocated (
          const char* name, std::size_t blocks, std::size_t block_size_bytes,
          const attributes& attr, const allocator_type& allocator) :
          memory_pool
            { name }
      {
#if defined(OS_TRACE_RTOS_MEMPOOL)
        trace::printf ("%s() @%p %s %d %d\n", __func__, this, this->name (),
                       blocks, block_size_bytes);
#endif
        if (attr.mp_pool_address != nullptr)
          {
            // Do not use any allocator at all.
            internal_construct_ (blocks, block_size_bytes, attr, nullptr, 0);
          }
        else
          {
            allocator_ = &allocator;
 
            // If no user storage was provided via attributes,
            // allocate it dynamically via the allocator.
            allocated_pool_size_elements_ = (compute_allocated_size_bytes<
                typename allocator_type::value_type> (blocks, block_size_bytes)
                + sizeof(typename allocator_type::value_type) - 1)
                / sizeof(typename allocator_type::value_type);
 
            allocated_pool_addr_ =
                const_cast<allocator_type&> (allocator).allocate (
                    allocated_pool_size_elements_);
 
            internal_construct_ (
                blocks,
                block_size_bytes,
                attr,
                allocated_pool_addr_,
                allocated_pool_size_elements_
                    * sizeof(typename allocator_type::value_type));
          }
      }
 
    template<typename Allocator>
      memory_pool_allocated<Allocator>::~memory_pool_allocated ()
      {
#if defined(OS_TRACE_RTOS_MEMPOOL)
        trace::printf ("%s() @%p %s\n", __func__, this, name ());
#endif
        typedef typename std::allocator_traits<allocator_type>::pointer pointer;
 
        if (allocated_pool_addr_ != nullptr)
          {
            static_cast<allocator_type*> (const_cast<void*> (allocator_))->deallocate (
                static_cast<pointer> (allocated_pool_addr_),
                allocated_pool_size_elements_);
 
            allocated_pool_addr_ = nullptr;
          }
      }
 
    // ========================================================================
 
    template<typename T, typename Allocator>
      inline
      memory_pool_typed<T, Allocator>::memory_pool_typed (
          std::size_t blocks, const memory_pool::attributes& attr,
          const allocator_type& allocator) :
          memory_pool_allocated<allocator_type> (blocks, sizeof(T), attr,
                                                 allocator)
      {
      }
 
    template<typename T, typename Allocator>
      inline
      memory_pool_typed<T, Allocator>::memory_pool_typed (
          const char* name, std::size_t blocks,
          const memory_pool::attributes& attr, const allocator_type& allocator) :
          memory_pool_allocated<allocator_type> (name, blocks, sizeof(T), attr,
                                                 allocator)
      {
      }
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wsuggest-final-methods"
#endif
    template<typename T, typename Allocator>
      memory_pool_typed<T, Allocator>::~memory_pool_typed ()
      {
      }
#pragma GCC diagnostic pop
 
    template<typename T, typename Allocator>
      inline typename memory_pool_typed<T, Allocator>::value_type*
      memory_pool_typed<T, Allocator>::alloc (void)
      {
        return static_cast<value_type*> (memory_pool_allocated<allocator_type>::alloc ());
      }
 
    template<typename T, typename Allocator>
      inline typename memory_pool_typed<T, Allocator>::value_type*
      memory_pool_typed<T, Allocator>::try_alloc (void)
      {
        return static_cast<value_type*> (memory_pool_allocated<allocator_type>::try_alloc ());
      }
 
    template<typename T, typename Allocator>
      inline typename memory_pool_typed<T, Allocator>::value_type*
      memory_pool_typed<T, Allocator>::timed_alloc (clock::duration_t timeout)
      {
        return static_cast<value_type*> (memory_pool_allocated<allocator_type>::timed_alloc (
            timeout));
      }
 
    template<typename T, typename Allocator>
      inline result_t
      memory_pool_typed<T, Allocator>::free (value_type* block)
      {
        return memory_pool_allocated<allocator_type>::free (block);
      }
 
    // ========================================================================
 
    template<typename T, std::size_t N>
      memory_pool_inclusive<T, N>::memory_pool_inclusive (
          const attributes& attr)
      {
        internal_construct_ (blocks, sizeof(T), attr, &arena_, sizeof(arena_));
      }
 
    template<typename T, std::size_t N>
      memory_pool_inclusive<T, N>::memory_pool_inclusive (
          const char* name, const attributes& attr) :
          memory_pool
            { name }
      {
        internal_construct_ (blocks, sizeof(T), attr, &arena_, sizeof(arena_));
      }
 
    template<typename T, std::size_t N>
      memory_pool_inclusive<T, N>::~memory_pool_inclusive ()
      {
      }
 
    template<typename T, std::size_t N>
      inline typename memory_pool_inclusive<T, N>::value_type*
      memory_pool_inclusive<T, N>::alloc (void)
      {
        return static_cast<value_type*> (memory_pool::alloc ());
      }
 
    template<typename T, std::size_t N>
      inline typename memory_pool_inclusive<T, N>::value_type*
      memory_pool_inclusive<T, N>::try_alloc (void)
      {
        return static_cast<value_type*> (memory_pool::try_alloc ());
      }
 
    template<typename T, std::size_t N>
      inline typename memory_pool_inclusive<T, N>::value_type*
      memory_pool_inclusive<T, N>::timed_alloc (clock::duration_t timeout)
      {
        return static_cast<value_type*> (memory_pool::timed_alloc (timeout));
      }
 
    template<typename T, std::size_t N>
      inline result_t
      memory_pool_inclusive<T, N>::free (value_type* block)
      {
        return memory_pool::free (block);
      }
 
  } /* namespace rtos */
} /* namespace os */
 
#pragma GCC diagnostic pop
 
// ----------------------------------------------------------------------------
 
#endif /* __cplusplus */
 
// ----------------------------------------------------------------------------
 
#endif /* CMSIS_PLUS_RTOS_OS_MEMPOOL_H_ */