malloc: defined gc_chunk, functions hide and magic

include/gc_alloc.h

@@ -1,19 +0,0 @@
-#ifndef GC_ALLOC_H
-#define GC_ALLOC_H
-
-#include <stdio.h>
-
-// Metadata for allocated memory
-struct gc_block_header {
-	size_t size;
-	int free;
-	struct gc_block_header *next;
-};
-
-// Performs allocations of SIZE bytes
-void *gc_malloc(size_t size);
-
-// Frees blocks of memory allocated by 'gc_alloc'
-void gc_free(void *ptr);
-
-#endif /* GC_ALLOC_H */

include/gc_malloc.h

@@ -0,0 +1,45 @@
+#ifndef GC_MALLOC_H
+#define GC_MALLOC_H
+
+#include <stdint.h>
+#include <unistd.h>
+
+// Generally, inline functions are preferable to macros resembling functions.
+// https://www.kernel.org/doc/html/v4.10/process/coding-style.html#data-structures
+
+#define OVERHEAD 1 /* Number of 8-byte segments for chunk size & flags */
+#define MAGIC 2 /* Number of 8-byte segments from top of chunk to fields */
+#define MIN 3 /* Minimum number of 8-byte segments for data in a chunk */
+
+/*
+ * Metadata for allocated memory
+ *
+ * footer: user data for previous chunk
+ * size: size of chunk in bytes
+ * merge: flag to identify when the chunk can be coalesced
+ * free: flag to identify when the chunk is free
+ * next: pointer to next chunk in the free list
+ * prev: pointer to previous chunk in the free list
+ */
+struct gc_chunk {
+	uint64_t footer;
+	uint32_t size;
+	uint16_t merge;
+	uint16_t free;
+	struct gc_chunk *next;
+	struct gc_chunk *prev;
+};
+
+// Hides chunk header
+inline void *hide(struct gc_chunk *curr);
+
+// Reveals chunk header
+inline struct gc_chunk *magic(void *mem);
+
+// Performs allocations of SIZE bytes
+void *gc_malloc(size_t size);
+
+// Frees blocks of memory allocated by 'gc_alloc'
+void gc_free(void *ptr);
+
+#endif /* GC_MALLOC_H */

src/gc_alloc.c

@@ -1,2 +0,0 @@
-#include "gc_alloc.h"
-

src/gc_malloc.c

@@ -0,0 +1,16 @@
+#include <assert.h>
+#include <sys/mman.h>
+
+#include "gc_malloc.h"
+
+// Hides chunk header
+inline void *hide(struct gc_chunk *curr)
+{
+	return (void *)((uint64_t *)curr + MAGIC);
+}
+
+// Reveals chunk header
+inline struct gc_chunk *magic(void *mem)
+{
+	return (struct gc_chunk *)((uint64_t *)mem - MAGIC);
+}