PoolAllocator.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2022, The DART development contributors
 * All rights reserved.
 *
 * The list of contributors can be found at:
 *   https://github.com/dartsim/dart/blob/master/LICENSE
 *
 * This file is provided under the following "BSD-style" License:
 *   Redistribution and use in source and binary forms, with or
 *   without modification, are permitted provided that the following
 *   conditions are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 *   CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 *   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 *   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 *   AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *   POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef DART_COMMON_POOLALLOCATOR_HPP_
#define DART_COMMON_POOLALLOCATOR_HPP_
 
#include <array>
#include <mutex>
 
#include "dart/common/MemoryAllocator.hpp"
#include "dart/common/MemoryAllocatorDebugger.hpp"
 
namespace dart::common {
 
class PoolAllocator : public MemoryAllocator
{
public:
  using Debug = MemoryAllocatorDebugger<PoolAllocator>;
 
  explicit PoolAllocator(
      MemoryAllocator& baseAllocator = MemoryAllocator::GetDefault());
 
  ~PoolAllocator() override;
 
  DART_STRING_TYPE(PoolAllocator);
 
  [[nodiscard]] const MemoryAllocator& getBaseAllocator() const;
 
  [[nodiscard]] MemoryAllocator& getBaseAllocator();
 
  [[nodiscard]] int getNumAllocatedMemoryBlocks() const;
 
  // Documentation inherited
  [[nodiscard]] void* allocate(size_t bytes) noexcept override;
 
  // Documentation inherited
  void deallocate(void* pointer, size_t bytes) override;
 
  // Documentation inherited
  void print(std::ostream& os = std::cout, int indent = 0) const override;
 
private:
  struct MemoryUnit
  {
    MemoryUnit* mNext;
  };
 
  struct MemoryBlock
  {
    MemoryUnit* mMemoryUnits;
  };
 
  inline static constexpr int HEAP_COUNT = 128;
 
  inline static constexpr size_t MAX_UNIT_SIZE = 1024;
 
  inline static constexpr size_t BLOCK_SIZE = 16 * MAX_UNIT_SIZE;
 
  inline static std::array<size_t, HEAP_COUNT> mUnitSizes;
 
  inline static std::array<int, MAX_UNIT_SIZE + 1> mMapSizeToHeapIndex;
 
  inline static bool mInitialized = false;
 
  MemoryAllocator& mBaseAllocator;
 
  mutable std::mutex mMutex;
 
  MemoryBlock* mMemoryBlocks;
 
  int mMemoryBlocksSize;
 
  int mCurrentMemoryBlockIndex;
 
  std::array<MemoryUnit*, HEAP_COUNT> mFreeMemoryUnits;
};
 
} // namespace dart::common
 
#endif // DART_COMMON_POOLALLOCATOR_HPP_