heap.h

Go to the documentation of this file.

#ifndef DW3_HEAP_H
#define DW3_HEAP_H
 
/* The heap (system/heap.c) */
 
#include "common.h"
#include <sys/types.h>
#include <libgte.h>
#include <libgpu.h>
 
/* The heap: a doubly linked list of blocks from HEAP_START to HEAP_END */
#define HEAP_END ((MemBlock *)0x801FF000)
 
/* MemBlock.tag */
#define MEM_FREE 0
#define MEM_END 1 /* the marker that ends the list */
#define MEM_MODE 2 /* the current mode's: freed by main whenever the mode task ends */
#define MEM_FILE_CACHE 3
#define MEM_LOCKED 4 /* kept across mode changes (lockMem) */
 
/* The heap (HEAP) */
typedef struct Heap {
    /* 0x00 */ s32 size;
    /* 0x04 */ struct MemBlock *first;
    /* 0x08 */ struct MemBlock *end;
    /* 0x0C */ void (*init)();
    /* 0x10 */ void (*free)(void *ptr);
    /* 0x14 */ void (*freeByTag)();
    /* 0x18 */ void *(*alloc)(s32 size, s32 tag);
    /* 0x1C */ void *(*allocHigh)(s32 size, s32 tag); /* from the end of the heap */
    /* 0x20 */ void *(*allocZeroed)(s32 size, s32 tag);
    /* 0x24 */ void (*zero)(void *ptr, s32 size);
    /* 0x28 */ void (*fill)(void *ptr, s32 value, s32 size);
    /* 0x2C */ void (*lock)();
    /* 0x30 */ void (*nop)();
} Heap;
 
/* Header of a heap block; the data follows it. Sizes are in bytes, so the
   allocator measures and splits blocks through u8 pointers. */
typedef struct MemBlock {
    /* 0x0 */ struct MemBlock *prev;
    /* 0x4 */ struct MemBlock *next;
    /* 0x8 */ s32 tag; /* MEM_* */
} MemBlock;
 
void freeMem(void *ptr);
void heapNop(void);
void freeMemByTag(s32 tag);
void initHeap(void);
void zeroMem(void *dst, s32 size);
void fillMem(s8 *dst, s8 value, s32 count);
void *allocMem(s32 size, s32 tag);
void allocMemHigh(s32 size, s32 tag);
void *allocMemZeroed(s32 size, s32 tag);
void lockMem(void *ptr, s32 lock);
void *tryAllocMem(u32 size, s32 tag);
void *tryAllocMemHigh(u32 size, s32 tag);
 
extern Heap HEAP;
extern MemBlock *HEAP_START;
/* The heap's first block, after the overlays: a linker symbol (tools/link_heap.py) */
extern MemBlock HEAP_BASE[];
 
#endif /* DW3_HEAP_H */