diff --git a/CHANGELOG.md b/CHANGELOG.md index 5881269..f7bbe13 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [3.6.0] - 2026-11-22 + +### Added + +- Functionality to query memory allocator usage + ## [3.5.0] - 2026-11-16 ### Changed diff --git a/VERSION b/VERSION index 1545d96..40c341b 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -3.5.0 +3.6.0 diff --git a/src/base/mem/allocator/mem_allocator.c b/src/base/mem/allocator/mem_allocator.c index 5a12af3..f379dd0 100644 --- a/src/base/mem/allocator/mem_allocator.c +++ b/src/base/mem/allocator/mem_allocator.c @@ -76,6 +76,16 @@ void wpMemAllocatorTempEnd(const WpAllocator *allocator) { allocator->temp_end(allocator->obj); } +WpAllocatorUsage wpMemAllocatorQueryUsage(const WpAllocator *allocator) { + wpDebugAssert(allocator != NULL, "`allocator` should not be NULL"); + + if (!wpMemAllocatorOpSupported(allocator, WP_MEM_OP_QUERY_USAGE)) { + return (WpAllocatorUsage){0}; + } + + return allocator->query_usage(allocator->obj); +} + b8 wpMemAllocatorOpSupported(const WpAllocator *allocator, WpMemOp op) { wpDebugAssert(allocator != NULL, "`allocator` should not be NULL"); @@ -94,6 +104,8 @@ b8 wpMemAllocatorOpSupported(const WpAllocator *allocator, WpMemOp op) { return allocator->temp_begin != NULL; case WP_MEM_OP_TEMP_END: return allocator->temp_end != NULL; + case WP_MEM_OP_QUERY_USAGE: + return allocator->query_usage != NULL; case COUNT_MEM_OPS: default: break; diff --git a/src/base/mem/allocator/mem_allocator.h b/src/base/mem/allocator/mem_allocator.h index eea284b..f62dd71 100644 --- a/src/base/mem/allocator/mem_allocator.h +++ b/src/base/mem/allocator/mem_allocator.h @@ -19,17 +19,24 @@ typedef enum WpMemOp { WP_MEM_OP_FREE, WP_MEM_OP_TEMP_BEGIN, WP_MEM_OP_TEMP_END, + WP_MEM_OP_QUERY_USAGE, COUNT_MEM_OPS } WpMemOp; -typedef void *(WpMemAllocFunc)(u64 size, void *alloc_obj); -typedef void *(WpMemAllocAlignedFunc)(u64 size, u64 alignment, void *alloc_obj); -typedef void *(WpMemReallocFunc)(void *ptr, u64 old_size, u64 new_size, void *alloc_obj); -typedef void *(WpMemReallocAlignedFunc)(void *ptr, u64 old_size, u64 new_size, u64 alignment, void *alloc_obj); -typedef void (WpMemFreeFunc)(void **ptr, u64 size, void *alloc_obj); -typedef void (WpMemTempBeginFunc)(void *alloc_obj); -typedef void (WpMemTempEndFunc)(void *alloc_obj); +typedef struct WpAllocatorUsage { + u64 capacity; + u64 used; +} WpAllocatorUsage; + +typedef void *(WpMemAllocFunc)(u64 size, void *alloc_obj); +typedef void *(WpMemAllocAlignedFunc)(u64 size, u64 alignment, void *alloc_obj); +typedef void *(WpMemReallocFunc)(void *ptr, u64 old_size, u64 new_size, void *alloc_obj); +typedef void *(WpMemReallocAlignedFunc)(void *ptr, u64 old_size, u64 new_size, u64 alignment, void *alloc_obj); +typedef void (WpMemFreeFunc)(void **ptr, u64 size, void *alloc_obj); +typedef void (WpMemTempBeginFunc)(void *alloc_obj); +typedef void (WpMemTempEndFunc)(void *alloc_obj); +typedef WpAllocatorUsage (WpMemQueryUsageFunc)(void *alloc_obj); typedef struct WpAllocator WpAllocator; struct WpAllocator { @@ -41,6 +48,7 @@ struct WpAllocator { WpMemFreeFunc *free; WpMemTempBeginFunc *temp_begin; WpMemTempEndFunc *temp_end; + WpMemQueryUsageFunc *query_usage; }; #ifdef WP_PLATFORM_CPP @@ -52,15 +60,16 @@ struct WpAllocator { #define wpMemAllocatorInvalid(ALLOCATOR) (memcmp(ALLOCATOR, &((WpAllocator){0}), sizeof(WpAllocator)) == 0) #endif // !WP_PLATFORM_CPP -void *wpMemAllocatorAlloc(const WpAllocator *allocator, u64 size); -void *wpMemAllocatorAllocAligned(const WpAllocator *allocator, u64 size, u64 alignment); -void *wpMemAllocatorRealloc(const WpAllocator *allocator, void *ptr, u64 old_size, u64 new_size); -void *wpMemAllocatorReallocAligned(const WpAllocator *allocator, void *ptr, u64 old_size, - u64 new_size, u64 alignment); -void wpMemAllocatorFree(const WpAllocator *allocator, void **ptr, u64 size); -void wpMemAllocatorTempBegin(const WpAllocator *allocator); -void wpMemAllocatorTempEnd(const WpAllocator *allocator); -b8 wpMemAllocatorOpSupported(const WpAllocator *allocator, WpMemOp op); +void *wpMemAllocatorAlloc(const WpAllocator *allocator, u64 size); +void *wpMemAllocatorAllocAligned(const WpAllocator *allocator, u64 size, u64 alignment); +void *wpMemAllocatorRealloc(const WpAllocator *allocator, void *ptr, u64 old_size, u64 new_size); +void *wpMemAllocatorReallocAligned(const WpAllocator *allocator, void *ptr, u64 old_size, + u64 new_size, u64 alignment); +void wpMemAllocatorFree(const WpAllocator *allocator, void **ptr, u64 size); +void wpMemAllocatorTempBegin(const WpAllocator *allocator); +void wpMemAllocatorTempEnd(const WpAllocator *allocator); +WpAllocatorUsage wpMemAllocatorQueryUsage(const WpAllocator *allocator); +b8 wpMemAllocatorOpSupported(const WpAllocator *allocator, WpMemOp op); #ifdef WP_PLATFORM_CPP END_C_LINKAGE diff --git a/src/os/allocators/arena/mem_arena.c b/src/os/allocators/arena/mem_arena.c index 79d3173..b925270 100644 --- a/src/os/allocators/arena/mem_arena.c +++ b/src/os/allocators/arena/mem_arena.c @@ -172,6 +172,15 @@ void wpMemArenaTempEnd(WpArena *arena) { arena->prev_offset = NULL; } +WpAllocatorUsage wpMemArenaQueryUsage(WpArena *arena) { + wpDebugAssert(arena != NULL, "`arena` should not be NULL"); + + return (WpAllocatorUsage){ + .capacity = arena->capacity, + .used = arena->offset - arena->buf, + }; +} + void wpMemArenaClear(WpArena *arena) { wpDebugAssert(arena != NULL, "`arena` should not be NULL"); diff --git a/src/os/allocators/arena/mem_arena.h b/src/os/allocators/arena/mem_arena.h index 5e4c516..72fdb97 100644 --- a/src/os/allocators/arena/mem_arena.h +++ b/src/os/allocators/arena/mem_arena.h @@ -6,6 +6,7 @@ #include "../../mem/mem_os.h" #include "../../../common/aliases/aliases.h" #include "../../../common/platform/platform.h" +#include "../../../base/mem/allocator/mem_allocator.h" #ifdef WP_PLATFORM_CPP BEGIN_C_LINKAGE @@ -27,16 +28,17 @@ typedef struct WpArena WpArena; * control over how the WpArena is initialised. Wrapper macros are provided for * easier use. */ -b8 wpMemArenaInitAllocatedCustom(WpArena **arena, u64 base_capacity, WpMemAllocFlags flags, b8 zero_buffer); -b8 wpMemArenaInitBuffer(WpArena **arena, u8 *buffer, u64 buffer_size); -void *wpMemArenaAlloc(WpArena *arena, u64 size); -void *wpMemArenaAllocAligned(WpArena *arena, u64 size, u64 alignment); -void *wpMemArenaRealloc(WpArena *arena, void *ptr, u64 old_size, u64 new_size); -void *wpMemArenaReallocAligned(WpArena *arena, void *ptr, u64 old_size, u64 new_size, u64 alignment); -void wpMemArenaTempBegin(WpArena *arena); -void wpMemArenaTempEnd(WpArena *arena); -void wpMemArenaClear(WpArena *arena); -void wpMemArenaDestroy(WpArena **arena); +b8 wpMemArenaInitAllocatedCustom(WpArena **arena, u64 base_capacity, WpMemAllocFlags flags, b8 zero_buffer); +b8 wpMemArenaInitBuffer(WpArena **arena, u8 *buffer, u64 buffer_size); +void *wpMemArenaAlloc(WpArena *arena, u64 size); +void *wpMemArenaAllocAligned(WpArena *arena, u64 size, u64 alignment); +void *wpMemArenaRealloc(WpArena *arena, void *ptr, u64 old_size, u64 new_size); +void *wpMemArenaReallocAligned(WpArena *arena, void *ptr, u64 old_size, u64 new_size, u64 alignment); +void wpMemArenaTempBegin(WpArena *arena); +void wpMemArenaTempEnd(WpArena *arena); +WpAllocatorUsage wpMemArenaQueryUsage(WpArena *arena); +void wpMemArenaClear(WpArena *arena); +void wpMemArenaDestroy(WpArena **arena); #ifdef WP_PLATFORM_CPP END_C_LINKAGE diff --git a/src/os/allocators/arena/mem_arena_allocator.c b/src/os/allocators/arena/mem_arena_allocator.c index 1c77c64..9a6d827 100644 --- a/src/os/allocators/arena/mem_arena_allocator.c +++ b/src/os/allocators/arena/mem_arena_allocator.c @@ -5,14 +5,15 @@ #include "../../../common/aliases/aliases.h" #include "../../../common/assert/assert.h" -wp_intern void initialiseArenaAllocator(WpAllocator *allocator); -wp_intern void *memArenaAlloc(u64 size, void *alloc_obj); -wp_intern void *memArenaAllocAligned(u64 size, u64 alignment, void *alloc_obj); -wp_intern void *memArenaRealloc(void *ptr, u64 old_size, u64 new_size, void *alloc_obj); -wp_intern void *memArenaReallocAligned(void *ptr, u64 old_size, u64 new_size, u64 alignment, - void *alloc_obj); -wp_intern void memArenaTempBegin(void *alloc_obj); -wp_intern void memArenaTempEnd(void *alloc_obj); +wp_intern void initialiseArenaAllocator(WpAllocator *allocator); +wp_intern void *memArenaAlloc(u64 size, void *alloc_obj); +wp_intern void *memArenaAllocAligned(u64 size, u64 alignment, void *alloc_obj); +wp_intern void *memArenaRealloc(void *ptr, u64 old_size, u64 new_size, void *alloc_obj); +wp_intern void *memArenaReallocAligned(void *ptr, u64 old_size, u64 new_size, u64 alignment, + void *alloc_obj); +wp_intern void memArenaTempBegin(void *alloc_obj); +wp_intern void memArenaTempEnd(void *alloc_obj); +wp_intern WpAllocatorUsage memArenaQueryUsage(void *alloc_obj); WpAllocator wpMemArenaAllocatorInitWithBuffer(u8 *buffer, u64 buffer_size) { WpAllocator allocator = {0}; @@ -56,6 +57,7 @@ wp_intern void initialiseArenaAllocator(WpAllocator *allocator) { allocator->realloc_aligned = memArenaReallocAligned; allocator->temp_begin = memArenaTempBegin; allocator->temp_end = memArenaTempEnd; + allocator->query_usage = memArenaQueryUsage; } wp_intern void *memArenaAlloc(u64 size, void *alloc_obj) { @@ -74,7 +76,7 @@ wp_intern void *memArenaRealloc(void *ptr, u64 old_size, u64 new_size, void *all } wp_intern void *memArenaReallocAligned(void *ptr, u64 old_size, u64 new_size, u64 alignment, - void *alloc_obj) { + void *alloc_obj) { WpArena *arena = (WpArena *)alloc_obj; return wpMemArenaReallocAligned(arena, ptr, old_size, new_size, alignment); } @@ -88,3 +90,8 @@ wp_intern void memArenaTempEnd(void *alloc_obj) { WpArena *arena = (WpArena *)alloc_obj; wpMemArenaTempEnd(arena); } + +wp_intern WpAllocatorUsage memArenaQueryUsage(void *alloc_obj) { + WpArena *arena = (WpArena *)alloc_obj; + return wpMemArenaQueryUsage(arena); +}