EasyGC is a simple, header-only garbage collector which is most suited for generated C code.
- Small: EasyGC is less than 200 lines long, making it easy to embed into generated C code.
- Simple: There are only four functions in the library that you need to use.
- Slowish: Since EasyGC is a reference-counter, it takes slightly longer than other algorithms to actually do stuff.
- Uses Malloc: I'm too lazy to implement my own memory allocator that is cross-platform 😔
- EasyGC doesn't require any initialization.
- To allocate memory on the heap, call the function
easygc_alloc. This function takes the size of an object you want to allocate, and returns avoid*to a new chunk of memory. This data is always pointer-aligned (ie: allocating 6 bytes would give you 8 bytes, 21 would give 24, etc...). If this function fails to allocate memory, it prints an error and exits.
void *easygc_alloc(size_t size);- You can resize a chunk of memory on the heap by calling
easygc_reallocwhich takes the pointer to the memory you want to resize, and its new size. If a pointer that is not on the heap is passed into the function, it prints an error and exits. The same happens if the program fails to allocate more memory.
void easygc_realloc(void *ptr, size_t new_size);- Every time you pass the pointer around (new variable, function call), you have to call the function
easygc_count_ref. This function literally just increments the reference counter for the pointer passed in.
void easygc_count_ref(void *ptr);- When a process is done with the pointer, you must call the function
easygc_collect. This function takes the pointer you finished using and decrements its reference counter. If the reference counter hits 0, it then scans all of the chunks looking for pointers which are tracked by EasyGC, and recursively callseasygc_count_refon them to clear out all unused data.
void easygc_collect(void *root);- Once the whole program is done, you can call
easygc_cleanto free up all the memory used. It takes no arguments.