message_pool_memory_strategy.hpp

// Copyright 2015 Open Source Robotics Foundation, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef RCLCPP__STRATEGIES__MESSAGE_POOL_MEMORY_STRATEGY_HPP_
#define RCLCPP__STRATEGIES__MESSAGE_POOL_MEMORY_STRATEGY_HPP_
 
#include <array>
#include <cstring>
#include <memory>
#include <mutex>
#include <stdexcept>
#include <type_traits>
 
#include "rosidl_runtime_cpp/traits.hpp"
 
#include "rclcpp/logger.hpp"
#include "rclcpp/macros.hpp"
#include "rclcpp/message_memory_strategy.hpp"
#include "rclcpp/visibility_control.hpp"
 
namespace rclcpp
{
namespace strategies
{
namespace message_pool_memory_strategy
{
 
 
template<
  typename MessageT,
  size_t Size,
  typename std::enable_if<
    rosidl_generator_traits::has_fixed_size<MessageT>::value
  >::type * = nullptr
>
class MessagePoolMemoryStrategy
  : public message_memory_strategy::MessageMemoryStrategy<MessageT>
{
public:
  RCLCPP_SMART_PTR_DEFINITIONS(MessagePoolMemoryStrategy)
 
  MessagePoolMemoryStrategy()
  {
    pool_mutex_ = std::make_shared<std::mutex>();
 
    pool_ = std::shared_ptr<std::array<MessageT *, Size>>(
      new std::array<MessageT *, Size>,
      [](std::array<MessageT *, Size> * arr) {
        for (size_t i = 0; i < Size; ++i) {
          free((*arr)[i]);
        }
        delete arr;
      });
 
    free_list_ = std::make_shared<CircularArray<Size>>();
 
    for (size_t i = 0; i < Size; ++i) {
      (*pool_)[i] = static_cast<MessageT *>(malloc(sizeof(MessageT)));
      free_list_->push_back(i);
    }
  }
 
 
  std::shared_ptr<MessageT> borrow_message()
  {
    std::lock_guard<std::mutex> lock(*pool_mutex_);
    if (free_list_->size() == 0) {
      throw std::runtime_error("No more free slots in the pool");
    }
 
    size_t current_index = free_list_->pop_front();
 
    return std::shared_ptr<MessageT>(
      new((*pool_)[current_index]) MessageT(),
      [pool = this->pool_, pool_mutex = this->pool_mutex_,
      free_list = this->free_list_](MessageT * p) {
        std::lock_guard<std::mutex> lock(*pool_mutex);
        for (size_t i = 0; i < Size; ++i) {
          if ((*pool)[i] == p) {
            p->~MessageT();
            free_list->push_back(i);
            break;
          }
        }
      });
  }
 
 
  void return_message([[maybe_unused]] std::shared_ptr<MessageT> & msg)
  {
    // This function is intentionally left empty.
  }
 
protected:
  template<size_t N>
  class CircularArray
  {
public:
    void push_back(const size_t v)
    {
      if (size_ + 1 > N) {
        throw std::runtime_error("Tried to push too many items into the array");
      }
      array_[(front_ + size_) % N] = v;
      ++size_;
    }
 
    size_t pop_front()
    {
      if (size_ < 1) {
        throw std::runtime_error("Tried to pop item from empty array");
      }
 
      size_t val = array_[front_];
 
      front_ = (front_ + 1) % N;
      --size_;
 
      return val;
    }
 
    size_t size() const
    {
      return size_;
    }
 
private:
    size_t front_ = 0;
    size_t size_ = 0;
    std::array<size_t, N> array_;
  };
 
  // It's very important that these are shared_ptrs, since users of this class might hold a
  // reference to a pool item longer than the lifetime of the class.  In that scenario, the
  // shared_ptr ensures that the lifetime of these variables outlives this class, and hence ensures
  // the custom destructor for each pool item can successfully run.
  std::shared_ptr<std::mutex> pool_mutex_;
  std::shared_ptr<std::array<MessageT *, Size>> pool_;
  std::shared_ptr<CircularArray<Size>> free_list_;
};
 
}  // namespace message_pool_memory_strategy
}  // namespace strategies
}  // namespace rclcpp
 
#endif  // RCLCPP__STRATEGIES__MESSAGE_POOL_MEMORY_STRATEGY_HPP_