libk: Finally, a proper kmalloc()!

3 files changed, 453 insertions, 41 deletions

diff --git a/kernel/include/libk/liballoc.h b/kernel/include/libk/liballoc.h
index ff40054..b1568e9 100644
--- a/kernel/include/libk/liballoc.h
+++ b/kernel/include/libk/liballoc.h
@@ -20,25 +20,32 @@
 #define __libk_liballoc_h
 
 #include <stddef.h>
-#include <stdint.h>
 
 namespace LibAlloc
 {
 
-class Block
-{
-public:
-  Block *m_next;
-  uint32_t m_size;
+/** This is a boundary tag which is prepended to the
+ * page or section of a page which we have allocated. It is
+ * used to identify valid memory blocks that the
+ * application is trying to free.
+ */
+struct boundary_tag {
+  unsigned int magic;     //< It's a kind of ...
+  unsigned int size;      //< Requested size.
+  unsigned int real_size; //< Actual size.
+  int index;              //< Location in the page table.
 
-public:
-  void initialize(uint32_t size);
+  struct boundary_tag *split_left;  //< Linked-list info for broken pages.
+  struct boundary_tag *split_right; //< The same.
 
-  void *get_chunk(void);
+  struct boundary_tag *next; //< Linked list info.
+  struct boundary_tag *prev; //< Linked list info.
 };
 
-bool initialized(void);
-void initialize(void);
+void *kmalloc(size_t);
+void *krealloc(void *, size_t);
+void *kcalloc(size_t, size_t);
+void kfree(void *);
 
 }
 
diff --git a/kernel/kernel/kernel.cc b/kernel/kernel/kernel.cc
index a1e6856..9143bec 100644
--- a/kernel/kernel/kernel.cc
+++ b/kernel/kernel/kernel.cc
@@ -44,17 +44,25 @@ kernel_main(uint32_t magic, multiboot_info_t *multiboot_info)
   MemoryMap::load(multiboot_info);
   PhysicalMM::initialize();
   VirtualMM::initialize();
-  // LibAlloc::initialize();
-
   PageTableAllocator::prepare();
 
   // uint32_t *page = (uint32_t *) VirtualMM::alloc_pages(1);
   // printk("debug", "page(0x%x)", page);
 
-  // int *x = (int *) LibAlloc::kmalloc(sizeof(int) * 8192);
-  // for (uint32_t i = 0; i < 8192; i++)
-  //   x[i] = i;
-  // printk("debug", "x(0x%x) *x(0x%x)", x, x[12]);
+  int *x = (int *) LibAlloc::kmalloc(14 * MiB);
+  for (uint32_t i = 0; i < 8192; i++)
+    x[i] = i;
+  printk("debug", "x(0x%x) *x(0x%x)", x, x[12]);
+
+  int *y = (int *) LibAlloc::kmalloc(sizeof(int) * 8192);
+  for (uint32_t i = 0; i < 8192; i++)
+    y[i] = i;
+  printk("debug", "x(0x%x) *x(0x%x)", y, y[12]);
+
+  int *z = (int *) LibAlloc::kmalloc(sizeof(int) * 8192);
+  for (uint32_t i = 0; i < 8192; i++)
+    z[i] = i;
+  printk("debug", "x(0x%x) *x(0x%x)", z, z[12]);
 
   printk("\nKernel", "Started.");
 
diff --git a/kernel/libk/liballoc.cc b/kernel/libk/liballoc.cc
index 0bf43c0..6596f53 100644
--- a/kernel/libk/liballoc.cc
+++ b/kernel/libk/liballoc.cc
@@ -17,54 +17,451 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <kernel/spinlock.h>
 #include <libk/liballoc.h>
-#include <libk/stdio.h>
-#include <libk/string.h>
 #include <mm/virtual_mm.h>
 #include <stddef.h>
 
-/* TODO: Kmalloc must have space for a page table *at all times*. */
-
 namespace LibAlloc
 {
 
-/* Block */
+Spinlock lock;
 
-void
-Block::initialize(uint32_t size)
+inline int
+liballoc_lock(void)
 {
-  m_size = size - sizeof(Block);
-  m_next = NULL;
+  lock.acquire();
+  return 0;
 }
 
-inline void *
-Block::get_chunk(void)
+inline int
+liballoc_unlock(void)
 {
-  return this + sizeof(Block);
+  lock.release();
+  return 0;
+}
+
+#define liballoc_alloc VirtualMM::alloc_pages
+#define liballoc_free VirtualMM::free_pages
+
+#define LIBALLOC_MAGIC 0xc001c0de
+#define MAXCOMPLETE 5
+#define MAXEXP 32
+#define MINEXP 8
+
+#define MODE_BEST 0
+#define MODE_INSTANT 1
+
+#define MODE MODE_BEST
+
+struct boundary_tag *l_freePages[MAXEXP]; //< Allowing for 2^MAXEXP blocks
+int l_completePages[MAXEXP];              //< Allowing for 2^MAXEXP blocks
+
+static unsigned int l_initialized = 0; //< Flag to indicate initialization.
+static unsigned int l_pageSize = 4096; //< Individual page size
+static unsigned int l_pageCount = 1;   //< Minimum number of pages to allocate.
+
+static inline int
+getexp(int size)
+{
+  if (size < (1 << MINEXP)) {
+    return -1; // Smaller than the quantum.
+  }
+
+  int shift = MINEXP;
+
+  while (shift < MAXEXP) {
+    if ((1 << shift) > size)
+      break;
+    shift += 1;
+  }
+
+  return shift - 1;
+}
+
+static void *
+liballoc_memset(void *s, int c, size_t n)
+{
+  size_t i;
+  for (i = 0; i < n; i++)
+    ((char *) s)[i] = c;
+
+  return s;
+}
+
+static void *
+liballoc_memcpy(void *s1, const void *s2, size_t n)
+{
+  char *cdest;
+  char *csrc;
+  unsigned int *ldest = (unsigned int *) s1;
+  unsigned int *lsrc = (unsigned int *) s2;
+
+  while (n >= sizeof(unsigned int)) {
+    *ldest++ = *lsrc++;
+    n -= sizeof(unsigned int);
+  }
+
+  cdest = (char *) ldest;
+  csrc = (char *) lsrc;
+
+  while (n > 0) {
+    *cdest++ = *csrc++;
+    n -= 1;
+  }
+
+  return s1;
+}
+
+static inline void
+insert_tag(struct boundary_tag *tag, int index)
+{
+  int realIndex;
+
+  if (index < 0) {
+    realIndex = getexp(tag->real_size - sizeof(struct boundary_tag));
+    if (realIndex < MINEXP)
+      realIndex = MINEXP;
+  } else
+    realIndex = index;
+
+  tag->index = realIndex;
+
+  if (l_freePages[realIndex] != NULL) {
+    l_freePages[realIndex]->prev = tag;
+    tag->next = l_freePages[realIndex];
+  }
+
+  l_freePages[realIndex] = tag;
+}
+
+static inline void
+remove_tag(struct boundary_tag *tag)
+{
+  if (l_freePages[tag->index] == tag)
+    l_freePages[tag->index] = tag->next;
+
+  if (tag->prev != NULL)
+    tag->prev->next = tag->next;
+  if (tag->next != NULL)
+    tag->next->prev = tag->prev;
+
+  tag->next = NULL;
+  tag->prev = NULL;
+  tag->index = -1;
+}
+static inline struct boundary_tag *
+melt_left(struct boundary_tag *tag)
+{
+  struct boundary_tag *left = tag->split_left;
+
+  left->real_size += tag->real_size;
+  left->split_right = tag->split_right;
+
+  if (tag->split_right != NULL)
+    tag->split_right->split_left = left;
+
+  return left;
+}
+static inline struct boundary_tag *
+absorb_right(struct boundary_tag *tag)
+{
+  struct boundary_tag *right = tag->split_right;
+
+  remove_tag(right); // Remove right from free pages.
+
+  tag->real_size += right->real_size;
+
+  tag->split_right = right->split_right;
+  if (right->split_right != NULL)
+    right->split_right->split_left = tag;
+
+  return tag;
+}
+
+static inline struct boundary_tag *
+split_tag(struct boundary_tag *tag)
+{
+  unsigned int remainder
+      = tag->real_size - sizeof(struct boundary_tag) - tag->size;
+
+  struct boundary_tag *new_tag
+      = (struct boundary_tag *) ((unsigned int) tag
+                                 + sizeof(struct boundary_tag) + tag->size);
+
+  new_tag->magic = LIBALLOC_MAGIC;
+  new_tag->real_size = remainder;
+
+  new_tag->next = NULL;
+  new_tag->prev = NULL;
+
+  new_tag->split_left = tag;
+  new_tag->split_right = tag->split_right;
+
+  if (new_tag->split_right != NULL)
+    new_tag->split_right->split_left = new_tag;
+  tag->split_right = new_tag;
+
+  tag->real_size -= new_tag->real_size;
+
+  insert_tag(new_tag, -1);
+
+  return new_tag;
 }
 
-/* LibAlloc */
+static struct boundary_tag *
+allocate_new_tag(unsigned int size)
+{
+  unsigned int pages;
+  unsigned int usage;
+  struct boundary_tag *tag;
+
+  // This is how much space is required.
+  usage = size + sizeof(struct boundary_tag);
+
+  // Perfect amount of space
+  pages = usage / l_pageSize;
+  if ((usage % l_pageSize) != 0)
+    pages += 1;
+
+  // Make sure it's >= the minimum size.
+  if (pages < l_pageCount)
+    pages = l_pageCount;
+
+  tag = (struct boundary_tag *) liballoc_alloc(pages);
+
+  if (tag == NULL)
+    return NULL; // uh oh, we ran out of memory.
 
-bool l_initialized = false;
-uint32_t l_heap_size = 0;
+  tag->magic = LIBALLOC_MAGIC;
+  tag->size = size;
+  tag->real_size = pages * l_pageSize;
+  tag->index = -1;
 
-Block *l_first_block = 0;
+  tag->next = NULL;
+  tag->prev = NULL;
+  tag->split_left = NULL;
+  tag->split_right = NULL;
 
-bool
-initialized(void)
+  return tag;
+}
+
+void *
+kmalloc(size_t size)
 {
-  return l_initialized;
+  int index;
+  void *ptr;
+  struct boundary_tag *tag = NULL;
+
+  liballoc_lock();
+
+  if (l_initialized == 0) {
+    for (index = 0; index < MAXEXP; index++) {
+      l_freePages[index] = NULL;
+      l_completePages[index] = 0;
+    }
+    l_initialized = 1;
+  }
+
+  index = getexp(size) + MODE;
+  if (index < MINEXP)
+    index = MINEXP;
+
+  // Find one big enough.
+  tag = l_freePages[index]; // Start at the front of the list.
+  while (tag != NULL) {
+    // If there's enough space in this tag.
+    if ((tag->real_size - sizeof(struct boundary_tag))
+        >= (size + sizeof(struct boundary_tag))) {
+      break;
+    }
+
+    tag = tag->next;
+  }
+
+  // No page found. Make one.
+  if (tag == NULL) {
+    if ((tag = allocate_new_tag(size)) == NULL) {
+      liballoc_unlock();
+      return NULL;
+    }
+
+    index = getexp(tag->real_size - sizeof(struct boundary_tag));
+  } else {
+    remove_tag(tag);
+
+    if ((tag->split_left == NULL) && (tag->split_right == NULL))
+      l_completePages[index] -= 1;
+  }
+
+  // We have a free page.  Remove it from the free pages list.
+
+  tag->size = size;
+
+  // Removed... see if we can re-use the excess space.
+
+  unsigned int remainder
+      = tag->real_size - size
+        - sizeof(struct boundary_tag) * 2; // Support a new tag + remainder
+
+  if (((int) (remainder)
+       > 0) /*&& ( (tag->real_size - remainder) >= (1<<MINEXP))*/) {
+    int childIndex = getexp(remainder);
+
+    if (childIndex >= 0) {
+      struct boundary_tag *new_tag = split_tag(tag);
+      (void) new_tag;
+    }
+  }
+
+  ptr = (void *) ((unsigned int) tag + sizeof(struct boundary_tag));
+  liballoc_unlock();
+  return ptr;
 }
 
 void
-initialize(void)
+kfree(void *ptr)
 {
-  l_first_block = (Block *) VirtualMM::alloc_pages(1);
-  l_first_block->initialize(PAGE_SIZE);
+  int index;
+  struct boundary_tag *tag;
+
+  if (ptr == NULL)
+    return;
+
+  liballoc_lock();
+
+  tag = (struct boundary_tag *) ((unsigned int) ptr
+                                 - sizeof(struct boundary_tag));
+
+  if (tag->magic != LIBALLOC_MAGIC) {
+    liballoc_unlock(); // release the lock
+    return;
+  }
+
+#ifdef DEBUG
+  l_inuse -= tag->size;
+  printf("free: %x, %i, %i\n",
+         ptr,
+         (int) l_inuse / 1024,
+         (int) l_allocated / 1024);
+#endif
+
+  // MELT LEFT...
+  while ((tag->split_left != NULL) && (tag->split_left->index >= 0)) {
+#ifdef DEBUG
+    printf("Melting tag left into available memory. Left was %i, becomes %i "
+           "(%i)\n",
+           tag->split_left->real_size,
+           tag->split_left->real_size + tag->real_size,
+           tag->split_left->real_size);
+#endif
+    tag = melt_left(tag);
+    remove_tag(tag);
+  }
+
+  // MELT RIGHT...
+  while ((tag->split_right != NULL) && (tag->split_right->index >= 0)) {
+#ifdef DEBUG
+    printf("Melting tag right into available memory. This was was %i, becomes "
+           "%i (%i)\n",
+           tag->real_size,
+           tag->split_right->real_size + tag->real_size,
+           tag->split_right->real_size);
+#endif
+    tag = absorb_right(tag);
+  }
+
+  // Where is it going back to?
+  index = getexp(tag->real_size - sizeof(struct boundary_tag));
+  if (index < MINEXP)
+    index = MINEXP;
+
+  // A whole, empty block?
+  if ((tag->split_left == NULL) && (tag->split_right == NULL)) {
+
+    if (l_completePages[index] == MAXCOMPLETE) {
+      // Too many standing by to keep. Free this one.
+      unsigned int pages = tag->real_size / l_pageSize;
+
+      if ((tag->real_size % l_pageSize) != 0)
+        pages += 1;
+      if (pages < l_pageCount)
+        pages = l_pageCount;
+
+      liballoc_free(tag, pages);
+
+#ifdef DEBUG
+      l_allocated -= pages * l_pageSize;
+      printf("Resource freeing %x of %i pages\n", tag, pages);
+      dump_array();
+#endif
+
+      liballoc_unlock();
+      return;
+    }
+
+    l_completePages[index] += 1; // Increase the count of complete pages.
+  }
+
+  // ..........
+
+  insert_tag(tag, index);
+
+#ifdef DEBUG
+  printf("Returning tag with %i bytes (requested %i bytes), which has "
+         "exponent: %i\n",
+         tag->real_size,
+         tag->size,
+         index);
+  dump_array();
+#endif
+
+  liballoc_unlock();
+}
+
+void *
+kcalloc(size_t nobj, size_t size)
+{
+  int real_size;
+  void *p;
+
+  real_size = nobj * size;
+
+  p = kmalloc(real_size);
+
+  liballoc_memset(p, 0, real_size);
+
+  return p;
+}
+
+void *
+krealloc(void *p, size_t size)
+{
+  void *ptr;
+  struct boundary_tag *tag;
+  size_t real_size;
+
+  if (size == 0) {
+    kfree(p);
+    return NULL;
+  }
+  if (p == NULL)
+    return kmalloc(size);
+
+  liballoc_lock(); // lockit
+  tag = (struct boundary_tag *) ((unsigned int) p
+                                 - sizeof(struct boundary_tag));
+  real_size = tag->size;
+  liballoc_unlock();
+
+  if (real_size > size)
+    real_size = size;
 
-  l_heap_size += l_first_block->m_size;
+  ptr = kmalloc(size);
+  liballoc_memcpy(ptr, p, real_size);
+  kfree(p);
 
-  l_initialized = true;
+  return ptr;
 }
 
 }