heap.h

Go to the documentation of this file.

#ifndef STRUCT_HEAP_H
#define STRUCT_HEAP_H

#include "cfg/cfg_heap.h"
#include <cfg/compiler.h>
#include <cfg/macros.h> // IS_POW2()

/* NOTE: struct size must be a 2's power! */
typedef struct _MemChunk
{
    struct _MemChunk *next;
    size_t size;
} MemChunk;

STATIC_ASSERT(IS_POW2(sizeof(MemChunk)));

typedef MemChunk heap_buf_t;

typedef struct Heap
{
    struct _MemChunk *FreeList;     
} Heap;

#define HEAP_DEFINE_BUF(name, size) \
    heap_buf_t name[((size) + sizeof(heap_buf_t) - 1) / sizeof(heap_buf_t)]

void heap_init(struct Heap* heap, void* memory, size_t size);

void *heap_allocmem(struct Heap* heap, size_t size);

void heap_freemem(struct Heap* heap, void *mem, size_t size);

size_t heap_freeSpace(struct Heap *h);

#define HNEW(heap, type) \
    (type*)heap_allocmem(heap, sizeof(type))

#define HNEWVEC(heap, type, nelem) \
    (type*)heap_allocmem(heap, sizeof(type) * (nelem))

#define HDELETE(heap, type, mem) \
    heap_freemem(heap, mem, sizeof(type))

#define HDELETEVEC(heap, type, nelem, mem) \
    heap_freemem(heap, mem, sizeof(type) * (nelem))


#if CONFIG_HEAP_MALLOC

void *heap_malloc(struct Heap* heap, size_t size);
void *heap_calloc(struct Heap* heap, size_t size);
void heap_free(struct Heap* heap, void * mem);

#endif

int heap_testSetup(void);
int heap_testRun(void);
int heap_testTearDown(void);

#endif /* STRUCT_HEAP_H */