Add PoolAllocator class (#1645)

dartsim · Jan 6, 2022 · 5ef8c1f · 5ef8c1f
1 parent 4041649
commit 5ef8c1f
Show file tree

Hide file tree

Showing 9 changed files with 684 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,7 @@
 
   * Added Castable class: [#1634](https://github.com/dartsim/dart/pull/1634)
   * Added spdlog support as underlying logging framework: [#1633](https://github.com/dartsim/dart/pull/1633)
-  * Added custom memory allocators: [#1636](https://github.com/dartsim/dart/pull/1636), [#1637](https://github.com/dartsim/dart/pull/1637), [#1639](https://github.com/dartsim/dart/pull/1639)
+  * Added custom memory allocators: [#1636](https://github.com/dartsim/dart/pull/1636), [#1637](https://github.com/dartsim/dart/pull/1637), [#1639](https://github.com/dartsim/dart/pull/1639), [#1645](https://github.com/dartsim/dart/pull/1645)
   * Added Stopwatch class to replace Timer: [#1638](https://github.com/dartsim/dart/pull/1638)
 
 * Dynamics

diff --git a/dart/common/CAllocator.cpp b/dart/common/CAllocator.cpp
@@ -34,6 +34,7 @@
 
 #include "dart/common/Console.hpp"
 #include "dart/common/Logging.hpp"
+#include "dart/common/Macros.hpp"
 
 namespace dart::common {
 
@@ -97,7 +98,7 @@ void* CAllocator::allocate(size_t size) noexcept
 void CAllocator::deallocate(void* pointer, size_t size)
 {
   (void)size;
-#ifndef NDEBUG
+#ifndef NDEBUG // debug
   std::lock_guard<std::mutex> lock(mMutex);
   auto it = mMapPointerToSize.find(pointer);
   if (it != mMapPointerToSize.end())
@@ -132,6 +133,31 @@ void CAllocator::deallocate(void* pointer, size_t size)
   std::free(pointer);
 }
 
+#ifndef NDEBUG
+//==============================================================================
+bool CAllocator::isAllocated(void* pointer, size_t size) const noexcept
+{
+  std::lock_guard<std::mutex> lock(mMutex);
+
+  const auto it = mMapPointerToSize.find(pointer);
+  if (it == mMapPointerToSize.end())
+    return false;
+
+  const auto& allocatedSize = it->second;
+  if (size != allocatedSize)
+    return false;
+
+  return true;
+}
+
+//==============================================================================
+bool CAllocator::isEmpty() const noexcept
+{
+  std::lock_guard<std::mutex> lock(mMutex);
+  return mMapPointerToSize.empty();
+}
+#endif
+
 //==============================================================================
 void CAllocator::print(std::ostream& os, int indent) const
 {

diff --git a/dart/common/CAllocator.hpp b/dart/common/CAllocator.hpp
@@ -61,6 +61,15 @@ class CAllocator : public MemoryAllocator
   // Documentation inherited
   void deallocate(void* pointer, size_t size) override;
 
+#ifndef NDEBUG
+  // Documentation inherited
+  [[nodiscard]] bool isAllocated(void* pointer, size_t size) const
+      noexcept override;
+
+  // Documentation inherited
+  [[nodiscard]] bool isEmpty() const noexcept override;
+#endif
+
   // Documentation inherited
   void print(std::ostream& os = std::cout, int indent = 0) const override;
 

diff --git a/dart/common/FreeListAllocator.cpp b/dart/common/FreeListAllocator.cpp
@@ -227,6 +227,31 @@ void FreeListAllocator::deallocate(void* pointer, size_t size)
   mFreeBlock = curr;
 }
 
+#ifndef NDEBUG
+//==============================================================================
+bool FreeListAllocator::isAllocated(void* pointer, size_t size) const noexcept
+{
+  std::lock_guard<std::mutex> lock(mMutex);
+
+  const auto it = mMapPointerToSize.find(pointer);
+  if (it == mMapPointerToSize.end())
+    return false;
+
+  const auto& allocatedSize = it->second;
+  if (size != allocatedSize)
+    return false;
+
+  return true;
+}
+
+//==============================================================================
+bool FreeListAllocator::isEmpty() const noexcept
+{
+  std::lock_guard<std::mutex> lock(mMutex);
+  return mMapPointerToSize.empty();
+}
+#endif
+
 //==============================================================================
 bool FreeListAllocator::allocateMemoryBlock(size_t sizeToAllocate)
 {

diff --git a/dart/common/FreeListAllocator.hpp b/dart/common/FreeListAllocator.hpp
@@ -77,6 +77,15 @@ class FreeListAllocator : public MemoryAllocator
   // Documentation inherited
   void deallocate(void* pointer, size_t size) override;
 
+#ifndef NDEBUG
+  // Documentation inherited
+  [[nodiscard]] bool isAllocated(void* pointer, size_t size) const
+      noexcept override;
+
+  // Documentation inherited
+  [[nodiscard]] bool isEmpty() const noexcept override;
+#endif
+
   // Documentation inherited
   void print(std::ostream& os = std::cout, int indent = 0) const override;
 

diff --git a/dart/common/MemoryAllocator.hpp b/dart/common/MemoryAllocator.hpp
@@ -93,6 +93,16 @@ class MemoryAllocator : public Castable<MemoryAllocator>
   template <typename T>
   void destroy(T* object) noexcept;
 
+#ifndef NDEBUG
+  /// Returns true if a pointer is allocated by this allocator.
+  [[nodiscard]] virtual bool isAllocated(void* pointer, size_t size) const
+      noexcept
+      = 0;
+
+  /// Returns true if there is no memory allocated by this allocator.
+  [[nodiscard]] virtual bool isEmpty() const noexcept = 0;
+#endif
+
   /// Prints state of the memory allocator
   virtual void print(std::ostream& os = std::cout, int indent = 0) const;