|
memory_arena
|
Core public API for the Arena memory allocator. More...
#include <stdlib.h>#include <string.h>#include "internal/arena_debug.h"#include "arena_hooks.h"#include "internal/arena_internal.h"#include "internal/arena_math.h"#include "arena_stats.h"
Include dependency graph for arena.h:
This graph shows which files directly or indirectly include this file:Go to the source code of this file.
Data Structures | |
| struct | s_arena |
Typedefs | |
| typedef size_t(* | arena_grow_callback) (size_t current_size, size_t requested_size) |
| typedef struct s_arena | t_arena |
| typedef size_t | t_arena_marker |
Functions | |
| void * | arena_alloc (t_arena *arena, size_t size) |
| void * | arena_alloc_aligned (t_arena *arena, size_t size, size_t alignment) |
| void * | arena_alloc_aligned_labeled (t_arena *arena, size_t size, size_t alignment, const char *label) |
| void * | arena_alloc_internal (t_arena *arena, size_t size, size_t alignment, const char *label) |
| Core internal allocator with alignment and labeling support. | |
| void * | arena_alloc_labeled (t_arena *arena, size_t size, const char *label) |
| bool | arena_alloc_sub (t_arena *parent, t_arena *child, size_t size) |
| bool | arena_alloc_sub_aligned (t_arena *parent, t_arena *child, size_t size, size_t alignment) |
| bool | arena_alloc_sub_labeled (t_arena *parent, t_arena *child, size_t size, const char *label) |
| bool | arena_alloc_sub_labeled_aligned (t_arena *parent, t_arena *child, size_t size, size_t alignment, const char *label) |
| void * | arena_calloc (t_arena *arena, size_t count, size_t size) |
| void * | arena_calloc_aligned (t_arena *arena, size_t count, size_t size, size_t alignment) |
| void * | arena_calloc_aligned_labeled (t_arena *arena, size_t count, size_t size, size_t alignment, const char *label) |
| void * | arena_calloc_labeled (t_arena *arena, size_t count, size_t size, const char *label) |
| t_arena * | arena_create (size_t size, bool allow_grow) |
| void | arena_delete (t_arena **arena) |
| void | arena_destroy (t_arena *arena) |
| bool | arena_grow (t_arena *arena, size_t required_size) |
| bool | arena_init (t_arena *arena, size_t size, bool allow_grow) |
| void | arena_init_with_buffer (t_arena *arena, void *buffer, size_t size, bool allow_grow) |
| t_arena_marker | arena_mark (t_arena *arena) |
| bool | arena_might_shrink (t_arena *arena) |
| size_t | arena_peak (t_arena *arena) |
| void | arena_pop (t_arena *arena, t_arena_marker marker) |
| void * | arena_realloc_last (t_arena *arena, void *old_ptr, size_t old_size, size_t new_size) |
| void | arena_reinit_with_buffer (t_arena *arena, void *buffer, size_t size, bool allow_grow) |
| size_t | arena_remaining (t_arena *arena) |
| void | arena_reset (t_arena *arena) |
| void | arena_shrink (t_arena *arena, size_t new_size) |
| size_t | arena_used (t_arena *arena) |
Core public API for the Arena memory allocator.
This header defines the central data structure (t_arena) and exposes all major functions for arena-based memory allocation, deallocation, initialization, and state management.
Features:
ARENA_ENABLE_THREAD_SAFE)ARENA_POISON_MEMORY)This header is the entry point to the arena system and is included by all modules using arenas for custom allocation.
Optional modules included:
arena_tlscratch.h for thread-local scratch arenasarena_stats.h, arena_debug.h, arena_hooks.h for profiling and tooling. Definition in file arena.h.
| struct s_arena |
Collaboration diagram for s_arena:| Data Fields | ||
|---|---|---|
| uint8_t * | buffer | Pointer to the memory buffer. |
| _Atomic bool | can_grow | Whether the arena supports dynamic growth. |
| t_arena_debug | debug | Debugging and diagnostic metadata. |
| arena_grow_callback | grow_cb | Optional callback for dynamic resizing. |
| t_arena_hooks | hooks | Allocation hooks for monitoring/debugging. |
| _Atomic bool | is_destroying | Indicates the arena is being destroyed. |
| t_arena_marker | marker_stack[ARENA_MAX_STACK_DEPTH] | Stack of saved markers. |
| int | marker_stack_top | Top index of marker stack. |
| size_t | offset | Current used offset (bump pointer). |
| _Atomic bool | owns_buffer | Whether this arena owns the buffer memory. |
| struct s_arena * | parent_ref | Reference to parent arena if this is a sub-arena. |
| size_t | size | Total size of the buffer. |
| t_arena_stats | stats | Allocation and memory usage statistics. |
| typedef size_t(* arena_grow_callback) (size_t current_size, size_t requested_size) |
| typedef size_t t_arena_marker |
| void * arena_alloc | ( | t_arena * | arena, |
| size_t | size | ||
| ) |
Definition at line 112 of file arena_alloc.c.
References arena_alloc_internal(), and ARENA_DEFAULT_ALIGNMENT.
| void * arena_alloc_aligned | ( | t_arena * | arena, |
| size_t | size, | ||
| size_t | alignment | ||
| ) |
Definition at line 167 of file arena_alloc.c.
References arena_alloc_internal().
| void * arena_alloc_aligned_labeled | ( | t_arena * | arena, |
| size_t | size, | ||
| size_t | alignment, | ||
| const char * | label | ||
| ) |
Definition at line 274 of file arena_alloc.c.
References arena_alloc_internal().
| void * arena_alloc_labeled | ( | t_arena * | arena, |
| size_t | size, | ||
| const char * | label | ||
| ) |
Definition at line 217 of file arena_alloc.c.
References arena_alloc_internal(), and ARENA_DEFAULT_ALIGNMENT.
Definition at line 187 of file arena_alloc_sub.c.
References arena_alloc_sub_labeled().
Definition at line 257 of file arena_alloc_sub.c.
References arena_alloc_sub_labeled_aligned().
Definition at line 327 of file arena_alloc_sub.c.
References arena_alloc_sub_labeled_aligned(), and ARENA_DEFAULT_ALIGNMENT.
| bool arena_alloc_sub_labeled_aligned | ( | t_arena * | parent, |
| t_arena * | child, | ||
| size_t | size, | ||
| size_t | alignment, | ||
| const char * | label | ||
| ) |
Definition at line 399 of file arena_alloc_sub.c.
References ALOG, arena_alloc_aligned(), arena_alloc_sub_validate(), arena_report_error(), and arena_setup_subarena().
| void * arena_calloc | ( | t_arena * | arena, |
| size_t | count, | ||
| size_t | size | ||
| ) |
Definition at line 96 of file arena_calloc.c.
References arena_calloc_labeled().
| void * arena_calloc_aligned | ( | t_arena * | arena, |
| size_t | count, | ||
| size_t | size, | ||
| size_t | alignment | ||
| ) |
Definition at line 148 of file arena_calloc.c.
References arena_calloc_aligned_labeled().
| void * arena_calloc_aligned_labeled | ( | t_arena * | arena, |
| size_t | count, | ||
| size_t | size, | ||
| size_t | alignment, | ||
| const char * | label | ||
| ) |
Definition at line 267 of file arena_calloc.c.
References arena_alloc_internal(), arena_record_failed_alloc(), arena_report_error(), validate_arena_calloc_input(), and would_overflow_mul().
| void * arena_calloc_labeled | ( | t_arena * | arena, |
| size_t | count, | ||
| size_t | size, | ||
| const char * | label | ||
| ) |
Definition at line 203 of file arena_calloc.c.
References arena_calloc_aligned_labeled(), and ARENA_DEFAULT_ALIGNMENT.
| t_arena * arena_create | ( | size_t | size, |
| bool | allow_grow | ||
| ) |
Definition at line 111 of file arena_create.c.
References arena_alloc_buffer(), arena_alloc_struct(), arena_finish_init(), arena_generate_id(), arena_log_and_teardown(), arena_report_error(), and arena_set_default_label().
| void arena_delete | ( | t_arena ** | arena | ) |
Definition at line 148 of file arena_cleanup.c.
References arena_destroy().
| void arena_destroy | ( | t_arena * | arena | ) |
Definition at line 82 of file arena_cleanup.c.
References ARENA_CHECK, arena_free_buffer_if_owned(), arena_free_growth_history(), ARENA_LOCK, ARENA_UNLOCK, and arena_zero_metadata().
| bool arena_grow | ( | t_arena * | arena, |
| size_t | required_size | ||
| ) |
Definition at line 142 of file arena_resize.c.
References arena_grow_compute_new_size(), arena_grow_realloc_buffer(), arena_grow_validate(), ARENA_LOCK, arena_report_error(), and ARENA_UNLOCK.
| bool arena_init | ( | t_arena * | arena, |
| size_t | size, | ||
| bool | allow_grow | ||
| ) |
Definition at line 190 of file arena_create.c.
References arena_alloc_buffer(), arena_finish_init(), arena_generate_id(), arena_log_and_teardown(), arena_report_error(), and arena_set_default_label().
| void arena_init_with_buffer | ( | t_arena * | arena, |
| void * | buffer, | ||
| size_t | size, | ||
| bool | allow_grow | ||
| ) |
Definition at line 286 of file arena_create.c.
References arena_generate_id(), arena_init_mutex(), arena_report_error(), arena_reset_metadata(), arena_set_default_label(), and arena_set_or_alloc_buffer().
| t_arena_marker arena_mark | ( | t_arena * | arena | ) |
Definition at line 227 of file arena_state.c.
References ARENA_LOCK, and ARENA_UNLOCK.
| bool arena_might_shrink | ( | t_arena * | arena | ) |
Definition at line 385 of file arena_resize.c.
References ARENA_CHECK, ARENA_LOCK, arena_should_maybe_shrink(), arena_shrink(), arena_shrink_target(), ARENA_UNLOCK, should_attempt_shrink(), and used.
| size_t arena_peak | ( | t_arena * | arena | ) |
Definition at line 175 of file arena_state.c.
References ARENA_LOCK, and ARENA_UNLOCK.
| void arena_pop | ( | t_arena * | arena, |
| t_arena_marker | marker | ||
| ) |
Definition at line 283 of file arena_state.c.
References ARENA_LOCK, arena_poison_memory, arena_report_error(), and ARENA_UNLOCK.
| void * arena_realloc_last | ( | t_arena * | arena, |
| void * | old_ptr, | ||
| size_t | old_size, | ||
| size_t | new_size | ||
| ) |
Definition at line 122 of file arena_realloc_last.c.
References ARENA_CHECK, ARENA_LOCK, arena_realloc_validate(), ARENA_UNLOCK, is_last_allocation(), realloc_fallback(), and realloc_in_place().
| void arena_reinit_with_buffer | ( | t_arena * | arena, |
| void * | buffer, | ||
| size_t | size, | ||
| bool | allow_grow | ||
| ) |
Definition at line 361 of file arena_create.c.
References arena_destroy(), and arena_init_with_buffer().
| size_t arena_remaining | ( | t_arena * | arena | ) |
Definition at line 122 of file arena_state.c.
References ARENA_LOCK, and ARENA_UNLOCK.
| void arena_reset | ( | t_arena * | arena | ) |
Definition at line 345 of file arena_state.c.
References ARENA_ASSERT_VALID, ARENA_LOCK, arena_poison_memory, and ARENA_UNLOCK.
| void arena_shrink | ( | t_arena * | arena, |
| size_t | new_size | ||
| ) |
Definition at line 267 of file arena_resize.c.
References ARENA_CHECK, ARENA_LOCK, arena_shrink_apply(), arena_shrink_validate(), and ARENA_UNLOCK.
| size_t arena_used | ( | t_arena * | arena | ) |
Definition at line 73 of file arena_state.c.
References ARENA_LOCK, ARENA_UNLOCK, and used.