Comments, adding Region to Heap

include/arena.h

@@ -36,6 +36,8 @@
 #include "region.h"
 
 namespace mimir {
+
+// Arena memory allocator, baed by a mimir::Region
 class Arena
 {
 public:

include/heap.h

@@ -33,14 +33,18 @@
 
 #include <cstddef>
 
+#include "region.h"
+
 namespace mimir {
+
+// Heap implementation based on Two-Level Segregated Fit (TLSF) memory allocation
 class Heap
 {
 public:
   Heap();
   ~Heap();
 
-  bool init(size_t minSize = 1ULL << 24, size_t maxSize = 1ULL << 32);
+  bool init(size_t maxSize = 1ULL << 32);
 
   // Allocate `size` bytes
   std::byte* alloc(size_t size);
@@ -50,6 +54,9 @@ public:
 
   // Allocate `size` bytes, aligned to 64 bytes and padded to next 64-byte offset.
   std::byte* allocA64(size_t size);
+
+private:
+  Region m_region;
 };
 
 } // namespace mimir

include/region.h

@@ -34,6 +34,9 @@
 #include <cstddef>
 
 namespace mimir {
+
+// Dynamically growable memory region with a contiguous address range.
+// Provides OS and hardware agnostic reservation and committing of memory pages.
 class Region
 {
 public:

src/heap.cpp

@@ -38,6 +38,8 @@
 
 namespace mimir {
 
+// Two-Level Segregated Fit (TLSF): http://www.gii.upv.es/tlsf/files/papers/ecrts04_tlsf.pdf
+
 Heap::Heap()
 {
 }
@@ -46,9 +48,12 @@ Heap::~Heap()
 {
 }
 
-bool Heap::init(size_t minSize, size_t maxSize)
+bool Heap::init(size_t maxSize)
 {
-  return false; // not implemented
+  if (!m_region.init(maxSize)) {
+    return false;
+  }
+  return true;
 }
 
 // Allocate `size` bytes