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 MEM_ARENA_ALIGNMENT 8

typedef struct MemArena {
    u8   *base;    
    usize pos;     
    usize commit;  
    usize reserve; 
} MemArena;

typedef struct MemArenaTemp {
    MemArena *arena; 
    usize     pos;   
} MemArenaTemp;

MemArena
mem_arena_create(usize reserve_size);

void *
mem_arena_push(MemArena *arena, usize size);

void *
mem_arena_push_zero(MemArena *arena, usize size);

void *
mem_arena_push_aligned(MemArena *arena, usize size, usize alignment);

char *
mem_arena_push_cstr(MemArena *arena, const char *str, usize len);

void
mem_arena_pop_to(MemArena *arena, usize pos);

void
mem_arena_clear(MemArena *arena);

void
mem_arena_clear_and_decommit(MemArena *arena);

void
mem_arena_release(MemArena *arena);

 
// Forward declaration of MemAllocator so we don't need a heavy include
struct MemAllocator;

struct MemAllocator
mem_arena_allocator(MemArena *arena);


MemArenaTemp
mem_arena_temp_begin(MemArena *arena);

void
mem_arena_temp_end(MemArenaTemp temp);


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

#define PUSH_ARRAY(arena, type, count)                                                             \
    ((type *)mem_arena_push_zero((arena), sizeof(type) * (count)))

#define PUSH_STRUCT_ALIGNED(arena, type, alignment)                                                \
    ((type *)mem_arena_push_aligned((arena), sizeof(type), (alignment)))

#define PUSH_ARRAY_ALIGNED(arena, type, count, alignment)                                          \
    ((type *)mem_arena_push_aligned((arena), sizeof(type) * (count), (alignment)))

#define PUSH_CSTR(arena, cstr) (mem_arena_push_cstr((arena), (cstr), strlen(cstr)))

 
C_LINKAGE_END
 
#endif // MEM_ARENA_H