memory_arena
Loading...
Searching...
No Matches
Functions
arena_state.c File Reference

Arena state inspection and control utilities. More...

#include "arena.h"
+ Include dependency graph for arena_state.c:

Go to the source code of this file.

Functions

t_arena_marker arena_mark (t_arena *arena)
 
size_t arena_peak (t_arena *arena)
 
void arena_pop (t_arena *arena, t_arena_marker marker)
 
size_t arena_remaining (t_arena *arena)
 
void arena_reset (t_arena *arena)
 
size_t arena_used (t_arena *arena)
 

Detailed Description

Arena state inspection and control utilities.

Author
Toonsa
Date
2025

This module provides utility functions for inspecting and manipulating the state of a memory arena without modifying its underlying buffer directly. These functions support read-only queries (e.g., used, remaining, peak usage), as well as efficient bulk memory rollback via markers (arena_mark() and arena_pop()) and full arena reset.

Features:

These utilities are thread-safe and lock the arena internally before accessing or modifying its state.

Note
These functions are designed for convenience and performance in scenarios like:
  • Frame-based memory reuse (e.g., in games or simulations).
  • Temporary scopes for allocation and rollback.
  • Profiling and diagnostics (e.g., monitoring peak usage).

Definition in file arena_state.c.

Function Documentation

◆ arena_mark()

t_arena_marker arena_mark ( t_arena *  arena)

Definition at line 227 of file arena_state.c.

228{
229 if (!arena)
230 return 0;
231
232 ARENA_LOCK(arena);
233 size_t offset = arena->offset;
234 ARENA_UNLOCK(arena);
235 return offset;
236}
#define ARENA_UNLOCK(arena)
#define ARENA_LOCK(arena)
Acquire the mutex lock if thread safety is enabled.

References ARENA_LOCK, and ARENA_UNLOCK.

◆ arena_peak()

size_t arena_peak ( t_arena *  arena)

Definition at line 175 of file arena_state.c.

176{
177 if (!arena)
178 return 0;
179
180 ARENA_LOCK(arena);
181 size_t peak = arena->stats.peak_usage;
182 ARENA_UNLOCK(arena);
183 return peak;
184}

References ARENA_LOCK, and ARENA_UNLOCK.

◆ arena_pop()

void arena_pop ( t_arena *  arena,
t_arena_marker  marker 
)

Definition at line 283 of file arena_state.c.

284{
285 if (!arena)
286 return;
287
288 ARENA_LOCK(arena);
289 if (marker > arena->offset)
290 {
291 arena_report_error(arena, "arena_pop failed: invalid marker %zu (offset: %zu)", marker, arena->offset);
292 ARENA_UNLOCK(arena);
293 return;
294 }
295
296 arena_poison_memory(arena->buffer + marker, arena->offset - marker);
297 arena->offset = marker;
298 ARENA_UNLOCK(arena);
299}
#define arena_poison_memory(ptr, size)
No-op poison macro when poisoning is disabled.
void arena_report_error(t_arena *arena, const char *fmt,...)
Report an error from an arena using its configured error callback.

References ARENA_LOCK, arena_poison_memory, arena_report_error(), and ARENA_UNLOCK.

◆ arena_remaining()

size_t arena_remaining ( t_arena *  arena)

Definition at line 122 of file arena_state.c.

123{
124 if (!arena)
125 return 0;
126
127 ARENA_LOCK(arena);
128 size_t remaining = arena->size - arena->offset;
129 ARENA_UNLOCK(arena);
130 return remaining;
131}

References ARENA_LOCK, and ARENA_UNLOCK.

◆ arena_reset()

void arena_reset ( t_arena *  arena)

Definition at line 345 of file arena_state.c.

346{
347 if (!arena)
348 return;
349
350 ARENA_LOCK(arena);
351 ARENA_ASSERT_VALID(arena);
352
353 arena_poison_memory(arena->buffer, arena->size);
354 arena->offset = 0;
355
356 ARENA_UNLOCK(arena);
357}
#define ARENA_ASSERT_VALID(arena)

References ARENA_ASSERT_VALID, ARENA_LOCK, arena_poison_memory, and ARENA_UNLOCK.

◆ arena_used()

size_t arena_used ( t_arena *  arena)

Definition at line 73 of file arena_state.c.

74{
75 if (!arena)
76 return 0;
77
78 ARENA_LOCK(arena);
79 size_t used = arena->offset;
80 ARENA_UNLOCK(arena);
81 return used;
82}
size_t used
Number of bytes used in the arena buffer.
Definition arena_io.h:2

References ARENA_LOCK, ARENA_UNLOCK, and used.