memory_arena
Loading...
Searching...
No Matches
arena.h
Go to the documentation of this file.
1
33#ifndef ARENA_H
34#define ARENA_H
35
36#include <stdlib.h>
37#include <string.h>
38
40#include "arena_hooks.h"
42#include "internal/arena_math.h"
43#include "arena_stats.h"
44
45#ifdef ARENA_ENABLE_THREAD_SAFE
46#include <pthread.h>
47#endif
48
49#ifdef ARENA_ENABLE_THREAD_LOCAL_SCRATCH
50#include "arena_tlscratch.h"
51#endif
52
53#ifdef __cplusplus
54extern "C"
55{
56#endif
57
79 typedef size_t (*arena_grow_callback)(size_t current_size, size_t requested_size);
80
91 typedef size_t t_arena_marker;
92
150
151 t_arena* arena_create(size_t size, bool allow_grow);
152 bool arena_init(t_arena* arena, size_t size, bool allow_grow);
153 void arena_init_with_buffer(t_arena* arena, void* buffer, size_t size, bool allow_grow);
154 void arena_reinit_with_buffer(t_arena* arena, void* buffer, size_t size, bool allow_grow);
155 void arena_destroy(t_arena* arena);
156 void arena_delete(t_arena** arena);
157 void arena_reset(t_arena* arena);
158
159 void* arena_alloc_internal(t_arena* arena, size_t size, size_t alignment, const char* label);
160
161 void* arena_alloc(t_arena* arena, size_t size);
162 void* arena_alloc_aligned(t_arena* arena, size_t size, size_t alignment);
163 void* arena_alloc_labeled(t_arena* arena, size_t size, const char* label);
164 void* arena_alloc_aligned_labeled(t_arena* arena, size_t size, size_t alignment, const char* label);
165
166 void* arena_calloc(t_arena* arena, size_t count, size_t size);
167 void* arena_calloc_aligned(t_arena* arena, size_t count, size_t size, size_t alignment);
168 void* arena_calloc_labeled(t_arena* arena, size_t count, size_t size, const char* label);
169 void* arena_calloc_aligned_labeled(t_arena* arena, size_t count, size_t size, size_t alignment, const char* label);
170
173 bool arena_alloc_sub_labeled(t_arena* parent, t_arena* child, size_t size, const char* label);
175 const char* label);
176
177 void* arena_realloc_last(t_arena* arena, void* old_ptr, size_t old_size, size_t new_size);
178
179 bool arena_grow(t_arena* arena, size_t required_size);
180 void arena_shrink(t_arena* arena, size_t new_size);
181 bool arena_might_shrink(t_arena* arena);
182
183 size_t arena_used(t_arena* arena);
184 size_t arena_remaining(t_arena* arena);
185 size_t arena_peak(t_arena* arena);
187 void arena_pop(t_arena* arena, t_arena_marker marker);
188
189#ifdef __cplusplus
190}
191#endif
192
193#endif // ARENA_H
t_arena_stats stats
Allocation and memory usage statistics.
Definition arena.h:146
_Atomic bool owns_buffer
Whether this arena owns the buffer memory.
Definition arena.h:137
bool arena_alloc_sub(t_arena *parent, t_arena *child, size_t size)
void * arena_calloc_aligned_labeled(t_arena *arena, size_t count, size_t size, size_t alignment, const char *label)
struct s_arena * parent_ref
Reference to parent arena if this is a sub-arena.
Definition arena.h:134
size_t size
Total size of the buffer.
Definition arena.h:131
void * arena_calloc_aligned(t_arena *arena, size_t count, size_t size, size_t alignment)
void arena_reset(t_arena *arena)
void * arena_alloc(t_arena *arena, size_t size)
bool arena_grow(t_arena *arena, size_t required_size)
bool arena_init(t_arena *arena, size_t size, bool allow_grow)
bool arena_alloc_sub_labeled(t_arena *parent, t_arena *child, size_t size, const char *label)
size_t arena_used(t_arena *arena)
Definition arena_state.c:73
t_arena_hooks hooks
Allocation hooks for monitoring/debugging.
Definition arena.h:148
size_t arena_remaining(t_arena *arena)
void * arena_alloc_aligned_labeled(t_arena *arena, size_t size, size_t alignment, const char *label)
void * arena_alloc_aligned(t_arena *arena, size_t size, size_t alignment)
bool arena_might_shrink(t_arena *arena)
void arena_pop(t_arena *arena, t_arena_marker marker)
void arena_init_with_buffer(t_arena *arena, void *buffer, size_t size, bool allow_grow)
void arena_destroy(t_arena *arena)
void * arena_realloc_last(t_arena *arena, void *old_ptr, size_t old_size, size_t new_size)
size_t arena_peak(t_arena *arena)
void arena_delete(t_arena **arena)
_Atomic bool is_destroying
Indicates the arena is being destroyed.
Definition arena.h:139
size_t offset
Current used offset (bump pointer).
Definition arena.h:132
t_arena_marker marker_stack[ARENA_MAX_STACK_DEPTH]
Stack of saved markers.
Definition arena.h:135
struct s_arena t_arena
arena_grow_callback grow_cb
Optional callback for dynamic resizing.
Definition arena.h:133
int marker_stack_top
Top index of marker stack.
Definition arena.h:136
void * arena_calloc(t_arena *arena, size_t count, size_t size)
t_arena_debug debug
Debugging and diagnostic metadata.
Definition arena.h:147
void arena_reinit_with_buffer(t_arena *arena, void *buffer, size_t size, bool allow_grow)
size_t(* arena_grow_callback)(size_t current_size, size_t requested_size)
Definition arena.h:79
t_arena_marker arena_mark(t_arena *arena)
bool arena_alloc_sub_labeled_aligned(t_arena *parent, t_arena *child, size_t size, size_t alignment, const char *label)
void arena_shrink(t_arena *arena, size_t new_size)
void * arena_alloc_labeled(t_arena *arena, size_t size, const char *label)
t_arena * arena_create(size_t size, bool allow_grow)
size_t t_arena_marker
Definition arena.h:91
_Atomic bool can_grow
Whether the arena supports dynamic growth.
Definition arena.h:138
uint8_t * buffer
Pointer to the memory buffer.
Definition arena.h:130
bool arena_alloc_sub_aligned(t_arena *parent, t_arena *child, size_t size, size_t alignment)
void * arena_calloc_labeled(t_arena *arena, size_t count, size_t size, const char *label)
#define ARENA_MAX_STACK_DEPTH
Max nested frame depth for arena_mark/pop.
Debugging utilities and hooks for the arena memory allocator.
Debug metadata associated with an arena.
Definition arena_debug.h:65
Allocation hook system for arena-based memory tracking and introspection.
Internal utilities and helpers for arena memory management.
Math utility functions for memory alignment and overflow-safe arithmetic.
Runtime statistics tracking and diagnostics for memory arenas.
Thread-local scratch arena interface for fast temporary allocations.
void * arena_alloc_internal(t_arena *arena, size_t size, size_t alignment, const char *label)
Core internal allocator with alignment and labeling support.
Structure holding runtime statistics for an arena.
Definition arena_stats.h:54
The main memory arena structure used for fast allocation.
Internal structure for managing arena hooks.
Definition arena_hooks.h:68