mem_arena.h

Go to the documentation of this file.

 
#ifndef MEM_ARENA_H
#define MEM_ARENA_H
 
#include "base/base_macros.h"
#include "base/base_types.h"
 
C_LINKAGE_BEGIN


#define ARENA_DEFAULT_ALIGN 8

#define ARENA_COMMIT_SIZE KB(64)

typedef struct Arena {
    u8   *base; 
    usize cap;  
    usize pos;  
    usize cmt;  
} Arena;

typedef struct ArenaTemp {
    Arena *arena; 
    usize  pos;   
} ArenaTemp;
 
// Core API

Arena
arena_create(usize reserve_size);

void
arena_release(Arena *arena);

void *
arena_push(Arena *arena, usize size);

void *
arena_push_zero(Arena *arena, usize size);

void *
arena_push_aligned(Arena *arena, usize size, usize alignment);

void
arena_pop_to(Arena *arena, usize pos);

void
arena_clear(Arena *arena);
 
// Temporary / Scratch API

ArenaTemp
arena_temp_begin(Arena *arena);

void
arena_temp_end(ArenaTemp temp);
 
// Convenience Macros

#define PUSH_STRUCT(arena, type) ((type *)arena_push_zero((arena), sizeof(type)))

#define PUSH_ARRAY(arena, type, count) ((type *)arena_push_zero((arena), sizeof(type) * (count)))

#define PUSH_ARRAY_ALIGNED(arena, type, count, alignment)                                          \
    ((type *)arena_push_aligned((arena), sizeof(type) * (count), (alignment)))
 // end arena_alloc
 
C_LINKAGE_END
 
#endif // MEM_ARENA_H