From: Brendan Hansen <brendan.f.hansen@gmail.com>
Date: Mon, 17 Jan 2022 04:55:25 +0000 (-0600)
Subject: updated comment in heap.onyx
X-Git-Url: https://git.brendanfh.com/?a=commitdiff_plain;h=d9040e4e4fdcf712c7e84a804fe6df483c2dd76e;p=onyx.git

updated comment in heap.onyx
---

diff --git a/core/alloc/heap.onyx b/core/alloc/heap.onyx
index e20a5712..0dfe3018 100644
--- a/core/alloc/heap.onyx
+++ b/core/alloc/heap.onyx
@@ -182,9 +182,6 @@ get_freed_size :: () => {
 
         #if Enable_Debug do memory_fill(ptr, ~~0xcc, orig_size);
 
-        // CLEANUP: This is not complete. This only checks if the block after the freed block is also free.
-        // There are three other cases related to the block before this one that need to be handled for
-        // the best efficiency and minimal fragmentation.
         if cast(uintptr) hb_ptr + hb_ptr.size < cast(uintptr) heap_state.next_alloc {
             next_block := cast(^heap_freed_block) (cast(uintptr) hb_ptr + hb_ptr.size);
 
@@ -200,6 +197,14 @@ get_freed_size :: () => {
             }
         }
 
+        // This is an awful way to do this, BUT it works for now.
+        // This looks for the block before the block being freed in order
+        // to merge them into one large continuous block. This should just
+        // be able to peek behind the block being freed and see if it is
+        // another freed block, but in order to do that, a footer needs to
+        // be placed every freed block. This sounds like too much work right
+        // now as it will envitably require hours of debugging one incorrect
+        // statement.                               - brendanfh 2022/01/16
         {
             walker := heap_state.free_list;
             while walker != null {