memory_arena
Loading...
Searching...
No Matches
arena_debug.c
Go to the documentation of this file.
1
39#include "arena_debug.h"
40#include "arena.h"
41#include "arena_stats.h"
42#include <stdarg.h>
43#include <stdatomic.h>
44#include <stdio.h>
45#include <string.h>
46
66static atomic_int g_arena_id_counter = 0;
67
103{
104 if (!arena)
105 return;
106
107 snprintf(arena->debug.id, ARENA_ID_LEN, "A#%04d", atomic_fetch_add(&g_arena_id_counter, 1));
108}
109
147void arena_set_debug_label(t_arena* arena, const char* label)
148{
149 if (arena)
150 arena->debug.label = label;
151}
152
202{
203 if (!arena)
204 return;
205
206 arena->debug.error_cb = cb ? cb : arena_default_error_callback;
207 arena->debug.error_context = cb ? context : NULL;
208}
209
253void arena_report_error(t_arena* arena, const char* fmt, ...)
254{
255 va_list args;
256 va_start(args, fmt);
257
258 char message[512];
259 vsnprintf(message, sizeof(message), fmt, args);
260 va_end(args);
261
262 if (arena && arena->debug.error_cb)
263 {
264 arena->debug.error_cb(message, arena->debug.error_context);
265 }
266 else
267 {
268 fprintf(stderr, "[ARENA ERROR]");
269 if (arena && arena->debug.label)
270 fprintf(stderr, " (%s)", arena->debug.label);
271 fprintf(stderr, " %s\n", message);
272 }
273}
274
310void arena_default_error_callback(const char* msg, void* ctx)
311{
312 (void) ctx;
313 fprintf(stderr, "[ARENA ERROR] %s\n", msg);
314}
315
354#ifdef ARENA_POISON_MEMORY
355void arena_poison_memory(void* ptr, size_t size)
356{
357 if (!ptr || size == 0)
358 return;
359
360 uint32_t* p = (uint32_t*) ptr;
361 size_t words = size / sizeof(uint32_t);
362 size_t remaining = size % sizeof(uint32_t);
363
364 for (size_t i = 0; i < words; ++i)
366
367 if (remaining)
368 memset((uint8_t*) (p + words), 0xEF, remaining);
369}
370#endif
371
426#ifdef ARENA_DEBUG_CHECKS
427
428#define LOG_LOCATION "[%s:%d] (%s)", file, line, func
429
430void arena_integrity_check(t_arena* arena, const char* file, int line, const char* func)
431{
432 if (!arena)
433 {
434 arena_report_error(NULL, LOG_LOCATION, " Arena is NULL", file, line, func);
435 return;
436 }
437
438#ifdef ARENA_ENABLE_THREAD_SAFE
439 if (!arena->use_lock || atomic_load_explicit(&arena->is_destroying, memory_order_acquire))
440 return;
441
442 if (pthread_mutex_trylock(&arena->lock) != 0)
443 return;
444#else
445 (void) file;
446 (void) line;
447 (void) func;
448#endif
449
450 if (!arena->buffer && arena->size > 0)
451 {
452 arena_report_error(arena, LOG_LOCATION, " Buffer is NULL but size is %zu", file, line, func, arena->size);
453 }
454
455 if (arena->offset > arena->size)
456 {
457 arena_report_error(arena, LOG_LOCATION, " Offset (%zu) exceeds size (%zu)", file, line, func, arena->offset,
458 arena->size);
459 }
460
461 if (arena->stats.peak_usage > arena->size)
462 {
463 arena_report_error(arena, LOG_LOCATION, " Peak usage (%zu) exceeds size (%zu)", file, line, func,
464 arena->stats.peak_usage, arena->size);
465 }
466
467 if (arena->stats.reallocations > arena->stats.allocations)
468 {
469 arena_report_error(arena, LOG_LOCATION, " Reallocations (%zu) exceed allocations (%zu)", file, line, func,
470 arena->stats.reallocations, arena->stats.allocations);
471 }
472
473 if (arena->offset > arena->stats.peak_usage)
474 {
475 arena_report_error(arena, LOG_LOCATION, " Offset (%zu) exceeds peak usage (%zu)", file, line, func,
476 arena->offset, arena->stats.peak_usage);
477 }
478
479 if (arena->stats.wasted_alignment_bytes > arena->stats.bytes_allocated)
480 {
481 arena_report_error(arena, LOG_LOCATION, " Wasted (%zu) exceeds allocated (%zu)", file, line, func,
482 arena->stats.wasted_alignment_bytes, arena->stats.bytes_allocated);
483 }
484
485 if (arena->stats.growth_history_count > 0 && !arena->stats.growth_history)
486 {
487 arena_report_error(arena, LOG_LOCATION, " Growth history count > 0 but pointer is NULL", file, line, func);
488 }
489
490#ifdef ARENA_ENABLE_THREAD_SAFE
491 pthread_mutex_unlock(&arena->lock);
492#endif
493}
494
495#endif
Core public API for the Arena memory allocator.
#define ARENA_ID_LEN
Max characters for arena ID strings.
Definition arena_config.h:6
Debugging utilities and hooks for the arena memory allocator.
void(* arena_error_callback)(const char *message, void *context)
Type for error callback functions.
Definition arena_debug.h:58
#define arena_poison_memory(ptr, size)
No-op poison macro when poisoning is disabled.
#define ARENA_POISON_PATTERN
Poison value used when overwriting memory in debug mode.
Runtime statistics tracking and diagnostics for memory arenas.
void arena_generate_id(t_arena *arena)
Generate a unique debug ID for an arena.
void arena_default_error_callback(const char *msg, void *ctx)
Default fallback error callback (prints to stderr).
void arena_set_error_callback(t_arena *arena, arena_error_callback cb, void *context)
Set a custom error callback function for reporting arena errors.
static atomic_int g_arena_id_counter
Global atomic counter for generating unique arena IDs.
Definition arena_debug.c:66
void arena_set_debug_label(t_arena *arena, const char *label)
Assign a debug label to an arena.
void arena_report_error(t_arena *arena, const char *fmt,...)
Report an error from an arena using its configured error callback.
The main memory arena structure used for fast allocation.