README.md

Arena Allocator

Arena allocators are region based allocators that tie many allocations to a single region of memory. Benefits are massivly simplified allocation and deallocation for complex structures, increased performance due to improved cache locality, and reduced memory fragmentation as long as individual items don't need to be deallocated. For programs that need to micro-manage individual allocations this is not an ideal solution.

Deallocating a region of memory with arenas is extremely fast, because the arena length is just set to 0. Allocating memory is also extremely fast. This implementation also grows the arena on demand using mmap and mprotect. Extending the library with a new type of allocation strategy should be easy.

Reference

arena_t arena_new()

Allocate a new arena.

If arena_new() fails, the struct member data is set to NULL. This can be checked with arena_new_failed()

bool arena_new_failed(arena_t *a)

Returns true if creating a new arena failed

int arena_delete(arena_t *a)

Delete underlying buffer of arena. Should only be used with arenas from arena_new().

Returns 0 on success, -1 on failure

arena_t arena_attach(void *ptr, size_t size)

Attach an arena to an existing memory region. The arena will not expand if capacity is exceeded.

void *arena_detatch(arena_t arena)

Detach an arena from an existing memory region. Returns the underlying data.

void arena_reset(arena_t *a)

Resets an arena.

void *arena_alloc(arena_t *a, size_t len)

Allocate memory with an arena. Returns NULL and sets errno on failure.

void *arena_calloc(arena_t *a, size_t nmemb, size_t size)

Allocate and zero memory with an arena. Returns NULL and sets errno on failure.