Naming refactor

src/arena.c

@@ -14,8 +14,8 @@ static MemoryBlock *memoryblock_allocate(U32 size, U32 commit_size, U32 page_siz
 
     block->base          = (U8 *)block;
     block->size          = aligned_size;
-    block->pos           = MemoryBlock_Header_Size;
+    block->first_free    = MemoryBlock_Header_Size;
-    block->base_pos      = 0;
+    block->arena_offset  = 0;
     block->prev          = NULL;
     block->committed_end = aligned_commit_size;
 
@@ -24,7 +24,7 @@ static MemoryBlock *memoryblock_allocate(U32 size, U32 commit_size, U32 page_siz
     return block;
 }
 
-void arena_init(Arena *arena, const ArenaParams *params)
+void arena_init(Arena *arena, const ArenaOptions *params)
 {
     U32 page_size = platform_page_size();
     Assert(params->size > MemoryBlock_Header_Size);
@@ -62,7 +62,7 @@ void *arena_push(Arena *arena, U32 size, U32 align)
     Assert(IsPow2(align));
 
     MemoryBlock *block = arena->current;
-    U32 start_pos = AlignUpPow2(block->pos, align);  // might align past block->size, handled in below check
+    U32 start_pos = AlignUpPow2(block->first_free, align);  // might align past block->size, handled in below check
     U32 available = block->size - start_pos;
 
     if (start_pos > block->size || available < size) {
@@ -76,11 +76,11 @@ void *arena_push(Arena *arena, U32 size, U32 align)
         MemoryBlock *new_block  = memoryblock_allocate(block_size, new_commit_size, arena->page_size);
         // base_pos tracks the virtual absolute position within an arena
         // This is not a contiguous space, we use it to free blocks when popping the arena
-        new_block->base_pos     = block->base_pos + block->size;
+        new_block->arena_offset = block->arena_offset + block->size;
         new_block->prev         = block;
         arena->current          = new_block;
         block                   = new_block;
-        start_pos               = AlignUpPow2(block->pos, align);
+        start_pos               = AlignUpPow2(block->first_free, align);
     }
 
     U32 end_pos = start_pos + size;
@@ -97,30 +97,30 @@ void *arena_push(Arena *arena, U32 size, U32 align)
         block->committed_end  += aligned_size;
         Assert(block->committed_end <= block->size);
     }
-    block->pos  = end_pos;
+    block->first_free  = end_pos;
 
     ASAN_UNPOISON_MEMORY_REGION(mem, size);
     return mem;
 }
 
-void arena_pop_to(Arena *arena, U64 abs_pos)
+void arena_reset_to(Arena *arena, U64 total_offset)
 {
     MemoryBlock *block = arena->current;
-    abs_pos = Max(MemoryBlock_Header_Size, abs_pos);
+    total_offset = Max(MemoryBlock_Header_Size, total_offset);
     while (block) {
         MemoryBlock *prev = block->prev;
 
-        if (block->base_pos >= abs_pos) {
+        if (block->arena_offset >= total_offset) {
             ASAN_UNPOISON_MEMORY_REGION(block->base, block->size);
             memory_free(block->base, block->size);
             arena->current = prev;
         } else {
-            U64 new_pos = abs_pos - block->base_pos;
+            U64 new_pos = total_offset - block->arena_offset;
             new_pos = Max(MemoryBlock_Header_Size, new_pos);
-            // Disallow arbirary pops to positions that previously were not commited.
+            // Disallow arbitrary pops to positions that previously were not commited.
             Assert(new_pos <= block->committed_end);
-            block->pos = new_pos;
+            block->first_free = new_pos;
-            ASAN_POISON_MEMORY_REGION(&block->base[block->pos], memoryblock_available(block));
+            ASAN_POISON_MEMORY_REGION(&block->base[block->first_free], memoryblock_available(block));
             break;
         }
 
@@ -132,7 +132,7 @@ ArenaCheckpoint arena_temp_begin(Arena *arena)
 {
     ArenaCheckpoint checkpoint = {};
     checkpoint.arena           = arena;
-    checkpoint.absolute_pos    = arena_used(arena);
+    checkpoint.total_offset    = arena_used(arena);
     arena->checkpoint_level++;
 
     return checkpoint;
@@ -142,11 +142,11 @@ void arena_temp_end(ArenaCheckpoint *checkpoint)
 {
     Arena *arena = checkpoint->arena;
     Assert(arena->checkpoint_level > 0);
-    arena_pop_to(arena, checkpoint->absolute_pos);
+    arena_reset_to(arena, checkpoint->total_offset);
     arena->checkpoint_level--;
 }
 
 void arena_reset(Arena *arena)
 {
-    arena_pop_to(arena, 0);
+    arena_reset_to(arena, 0);
 }

src/arena.h

@@ -2,10 +2,9 @@
 #include "base_core.h"
 
 
-typedef U32 ArenaFlags; // no flags defined yet
+typedef U32 ArenaFlags;
-
+typedef struct ArenaOptions ArenaOptions;
-typedef struct ArenaParams ArenaParams;
+struct ArenaOptions {
-struct ArenaParams {
     U32 size;
     U32 commit_size;
     ArenaFlags flags; // No flags defined yet
@@ -15,8 +14,8 @@ typedef struct MemoryBlock MemoryBlock;
 struct MemoryBlock {
     U8 *base;
     U32 size;           // Block size, page aligned
-    U32 pos;            // start of next allocation
+    U32 first_free;     // start of next allocation
-    U64 base_pos;       // absolute position of base relative to the first linked arena
+    U64 arena_offset;   // absolute offset of base relative to the first linked arena
     U32 committed_end;  // end of committed region. Will be page aligned
     MemoryBlock *prev;
 };
@@ -34,7 +33,7 @@ struct Arena {
 typedef struct ArenaCheckpoint ArenaCheckpoint;
 struct ArenaCheckpoint {
     Arena *arena;
-    U64 absolute_pos;
+    U64 total_offset;
 };
 #ifndef ArenaParams_Default
 #define ArenaParams_Default { .size = MB(32), .commit_size = KB(64) }
@@ -44,7 +43,7 @@ StaticAssert(sizeof(MemoryBlock) <= 64);
 // Try keep start of user memory at a cacheline
 #define MemoryBlock_Header_Size 64u
 
-void arena_init(Arena *arena, const ArenaParams *params);
+void arena_init(Arena *arena, const ArenaOptions *params);
 void arena_free(Arena *arena);
 void *arena_push(Arena *arena, U32 size, U32 align);
 
@@ -54,16 +53,16 @@ void *arena_push(Arena *arena, U32 size, U32 align);
 
 ArenaCheckpoint arena_temp_begin(Arena *arena);
 void arena_temp_end(ArenaCheckpoint *checkpoint);
-void arena_pop_to(Arena *arena, U64 abs_pos);
+void arena_reset_to(Arena *arena, U64 total_offset);
 void arena_reset(Arena *arena);
 
 static INLINE U32 memoryblock_available(const MemoryBlock *block)
 {
-    return block->size - block->pos;
+    return block->size - block->first_free;
 }
 
 static INLINE U64 arena_used(const Arena *arena)
 {
     const MemoryBlock *block = arena->current;
-    return block->base_pos + block->pos;
+    return block->arena_offset + block->first_free;
 }

src/base_core.h

@@ -108,7 +108,7 @@ typedef unsigned __int128 U128;
 #define AlignDownPow2(val, align)   ((val) & ~((align) - 1UL))
 #define IsPow2(x)                   ((x) && !((x) & ((x) - 1UL)))
 #define IsPow2OrZero(x)             (!((x) & ((x) - 1UL)))
-#define IsAlignedTo(x, y)           (IsPow2(y) && !((x) & ((y) - 1UL)))
+#define IsAlignedToPow2(x, y)           (IsPow2(y) && !((x) & ((y) - 1UL)))
 
 #define GetBit(val, idx) (((val) >> (idx)) & 1)
 // Get n_bits starting at idx going left

src/main.c

@@ -12,8 +12,8 @@ void arena_dump(const Arena *arena)
         puts("-----Arena-----");
         printf("base:        %p\n", block->base);
         printf("size:        %u\n", block->size);
-        printf("pos:         %u\n", block->pos);
+        printf("first_free:         %u\n", block->first_free);
-        printf("base_pos:    %lu\n",block->base_pos);
+        printf("total_used:    %lu\n",block->arena_offset);
         printf("prev: %p\n", block->prev);
         puts("-----Arena  end-");
         block = block->prev;
@@ -22,7 +22,7 @@ void arena_dump(const Arena *arena)
 static void arena_test_1(void)
 {
     TRACEF("\n");
-    ArenaParams arena_params = {};
+    ArenaOptions arena_params = {};
     U32 arena_size = MB(1) + MemoryBlock_Header_Size;
     U32 commit_size = KB(8);
     arena_params.size = arena_size;
@@ -50,7 +50,7 @@ static void arena_test_2(void)
 {
     TRACEF("\n");
 
-    ArenaParams arena_params = {};
+    ArenaOptions arena_params = {};
     U32 arena_size = MB(1) + MemoryBlock_Header_Size;
     U32 commit_size = KB(16);
     U32 push_size = KB(32);
@@ -81,7 +81,7 @@ static void arena_test_2(void)
     arena_temp_end(&checkpoint2);
 
     arena_temp_end(&checkpoint);
-    arena_pop_to(&arena, 1088);
+    arena_reset_to(&arena, 1088);
     arena_dump(&arena);
     ptr = arena_push(&arena, 1, KB(16));
     ((U8*)ptr)[0] = 0x37;
@@ -89,9 +89,9 @@ static void arena_test_2(void)
     ((U8*)ptr)[0] = 0x73;
     ptr = arena_push(&arena, 0, KB(4));
     //((U8*)ptr)[0] = 0x73;
-    arena_pop_to(&arena, 1089);
+    arena_reset_to(&arena, 1089);
     arena_dump(&arena);
-    arena_pop_to(&arena, 0);
+    arena_reset_to(&arena, 0);
     ptr = arena_push(&arena, MB(1), 8);
     MemoryZero(ptr, MB(1));
     arena_free(&arena);
@@ -101,7 +101,7 @@ static void arena_test_3(void)
 {
     TRACEF("\n");
 
-    ArenaParams arena_params = {};
+    ArenaOptions arena_params = {};
     U32 arena_size = KB(97) + MemoryBlock_Header_Size;
     U32 commit_size = KB(97);
     arena_params.size = arena_size;

src/platform.c

@@ -6,7 +6,7 @@
 #include <sys/mman.h>
 
 
-#define IsPageAligned(x) (IsAlignedTo(x, platform_page_size()))
+#define IsPageAligned(x) (IsAlignedToPow2(x, platform_page_size()))
 
 U32 platform_page_size(void)
 {