memory_arena
Loading...
Searching...
No Matches
arena_debug.h
Go to the documentation of this file.
1
28#ifndef ARENA_DEBUG_H
29#define ARENA_DEBUG_H
30
31#include "arena_config.h"
32#include <stdarg.h>
33#include <stdatomic.h>
34#include <stddef.h>
35#include <stdint.h>
36#include <stdio.h>
37
38#ifdef __cplusplus
39extern "C"
40{
41#endif
42
43 // ─────────────────────────────────────────────────────────────
44 // Error Reporting & Debug Metadata
45 // ─────────────────────────────────────────────────────────────
46
50 typedef struct s_arena t_arena;
51
58 typedef void (*arena_error_callback)(const char* message, void* context);
59
72
77 void arena_set_debug_label(t_arena* arena, const char* label);
78
83 void arena_generate_id(t_arena* arena);
84
89 void arena_set_error_callback(t_arena* arena, arena_error_callback cb, void* context);
90
95 void arena_report_error(t_arena* arena, const char* fmt, ...);
96
101 void arena_default_error_callback(const char* msg, void* ctx);
102
103// ─────────────────────────────────────────────────────────────
104// Memory Poisoning
105// ─────────────────────────────────────────────────────────────
106
111#define ARENA_POISON_PATTERN 0xDEADBEEF
112
113#ifdef ARENA_POISON_MEMORY
118 void arena_poison_memory(void* ptr, size_t size);
119#else
123#define arena_poison_memory(ptr, size) ((void) (ptr), (void) (size))
124#endif
125
126 // ─────────────────────────────────────────────────────────────
127 // Debug Assertions and Internal Checks
128 // ─────────────────────────────────────────────────────────────
129
130#ifdef ARENA_DEBUG_CHECKS
131#include <assert.h>
132
136#define ARENA_ASSERT(cond) assert(cond)
137
142#define ARENA_CHECK(arena) arena_integrity_check((arena), __FILE__, __LINE__, __func__)
143
148#define ARENA_ASSERT_VALID(arena) ARENA_ASSERT(arena_is_valid(arena))
149
154 void arena_integrity_check(t_arena* arena, const char* file, int line, const char* func);
155
156#else
157#define ARENA_ASSERT(cond) ((void) 0)
158#define ARENA_CHECK(arena) ((void) 0)
159#define ARENA_ASSERT_VALID(arena) ((void) 0)
160#endif
161
162// ─────────────────────────────────────────────────────────────
163// Logging
164// ─────────────────────────────────────────────────────────────
165
170#if ARENA_DEBUG_LOG
171#define ALOG(...) fprintf(stderr, __VA_ARGS__)
172#else
173#define ALOG(...) ((void) 0)
174#endif
175
176#ifdef __cplusplus
177}
178#endif
179
180#endif // ARENA_DEBUG_H
size_t size
Total size of the buffer.
Definition arena.h:131
#define ARENA_ID_LEN
Max characters for arena ID strings.
Definition arena_config.h:6
const char * label
Optional user-provided label for logging/debug.
Definition arena_debug.h:67
void * error_context
Optional context passed to the error callback.
Definition arena_debug.h:69
void(* arena_error_callback)(const char *message, void *context)
Type for error callback functions.
Definition arena_debug.h:58
atomic_int subarena_counter
Internal counter for sub-arenas.
Definition arena_debug.h:70
struct s_arena_debug t_arena_debug
Debug metadata associated with an arena.
#define arena_poison_memory(ptr, size)
No-op poison macro when poisoning is disabled.
arena_error_callback error_cb
Callback function for reporting errors.
Definition arena_debug.h:68
Debug metadata associated with an arena.
Definition arena_debug.h:65
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.
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.