Initial commit

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,76 @@
+# Compiler Flags
+CC := gcc
+CFLAGS := -g -Wall -Wextra -Werror -pedantic -fsanitize=address,undefined -fno-omit-frame-pointer
+
+# Directory variables 
+LIBDIR := lib
+OBJ := obj
+INC := include
+SRC := src
+TEST := tests
+
+# Filepath Pattern Matching
+LIB := $(LIBDIR)/lib.a
+SRCS := $(wildcard $(SRC)/*.c)
+OBJS := $(patsubst $(SRC)/%.c, $(OBJ)/%.o, $(SRCS))
+TESTS := $(wildcard $(TEST)/*.c)
+TESTBINS := $(patsubst $(TEST)/%.c, $(TEST)/bin/%, $(TESTS))
+
+# Commands must be labeled PHONY
+.PHONY: all release clean test
+
+# Compiler Release Flags 
+release: CFLAGS := -Wall -Wextra -Werror -pedantic -fsanitize=address,undefined -fno-omit-frame-pointer -O2 -DNDEBUG
+release: clean $(LIB)
+
+# Target for compilation.
+all: $(LIB)
+
+# Target / Dependencies
+$(LIB): $(OBJS) | $(LIBDIR)
+	$(RM) $(LIB)
+	ar -cvrs $@ $^
+
+$(OBJ)/%.o: $(SRC)/%.c $(SRC)/%.h | $(OBJ)
+	$(CC) $(CFLAGS) -c $< -o $@
+
+$(OBJ)/%.o: $(SRC)/%.c | $(OBJ)
+	$(CC) $(CFLAGS) -c $< -o $@
+
+$(TEST)/bin/%: $(TEST)/%.c $(LIB) | $(TEST)/bin
+	$(CC) $(CFLAGS) $< $(LIB) -o $@
+
+# Make directories if none. 
+$(LIBDIR):
+	mkdir $@
+
+$(INC):
+	mkdir $@
+
+$(OBJ):
+	mkdir $@
+
+$(TEST)/bin:
+	mkdir $@
+
+# Run the tests in the bin folder and track results
+test: $(LIB) $(TEST)/bin $(TESTBINS)
+	@SUCCESS_COUNT=0; FAILURE_COUNT=0; \
+	for test in $(TESTBINS); do \
+		./$$test; \
+		EXIT_CODE=$$?; \
+		TEST_NAME=$(notdir $$test); \
+		if [ $$EXIT_CODE -eq 0 ]; then \
+			echo "\033[0;32m$$TEST_NAME: EXIT CODE: $$EXIT_CODE (SUCCESS)\033[0m"; \
+			SUCCESS_COUNT=$$((SUCCESS_COUNT + 1)); \
+		else \
+			echo "\033[0;31m$$TEST_NAME: EXIT CODE: $$EXIT_CODE (FAILURE)\033[0m"; \
+			FAILURE_COUNT=$$((FAILURE_COUNT + 1)); \
+		fi; \
+	done; \
+	echo "\n\nTests completed"; \
+	echo "SUCCESS: $$SUCCESS_COUNT"; \
+	echo "FAILURE: $$FAILURE_COUNT";
+
+clean:
+	$(RM) -r $(LIBDIR) $(OBJ) $(TEST)/bin/

README.md

@@ -0,0 +1,31 @@
+# Arena 
+
+## Description
+Arena based memory management written in C.
+
+## Table of Contents
+
+- [Description](#description)
+- [Features](#features) 
+- [Usage](#usage)
+- [Credits / Resources](#credits--resources)
+- [License](#license)
+
+## Features / TODOS
+- [ ] No need for FREE.
+- [ ] One allocation to rule them all.
+- [ ] Flags for SOFTFAIL or Exceptions.
+- [ ] Flags for NOZERO allocations.
+
+## Usage
+make <br>
+make test
+
+## Credits / Resources
+[Null Program - Arena tips and tricks.](https://nullprogram.com/blog/2023/09/27/)<br>
+[Ginger Bill - Memory Allocation Strategies](https://www.gingerbill.org/series/memory-allocation-strategies/)<br>
+[Dave Hanson - Interfaces and Implementations](https://github.com/drh/cii)<br>
+
+
+## License
+This project is licensed under MIT - see the [LICENSE](LICENSE) file for details.

include/arena.h

@@ -0,0 +1,27 @@
+#ifndef ARENA_INCLUDED
+#define ARENA_INCLUDED
+
+#include <stddef.h>
+
+#define SIZEOF(x)    (ptrdiff_t)sizeof(x)
+#define NELEMS(a)   (sizeof(a) / sizeof(*(a)))
+#define LEN(s)  (NELEMS(s) - 1)
+#define KB(x) ((size_t)(x) << 10)  // 1 KB = 1024 bytes
+#define MB(x) ((size_t)(x) << 20)  // 1 MB = 1024 * 1024 bytes
+#define GB(x) ((size_t)(x) << 30)  // 1 GB = 1024 * 1024 * 1024 bytes
+                                   
+typedef struct {
+    char* beg;
+    char* end;
+} Arena;
+
+typedef enum {
+    NOZERO   = 0x1,
+    SOFTFAIL = 0x2,
+} ArenaFlags;
+
+Arena arena_new(ptrdiff_t cap, int flags);
+char* arena_alloc(Arena* a, ptrdiff_t nb, ptrdiff_t align, ptrdiff_t count, int flags);
+
+
+#endif

include/except.h

@@ -0,0 +1,80 @@
+#ifndef EXCEPT_INCLUDED
+#define EXCEPT_INCLUDED
+
+#include <setjmp.h>
+
+struct Exception {
+	const char *reason;
+};
+typedef struct Exception Exception;
+
+struct ExceptFrame {
+	struct ExceptFrame *prev;   // Exception Stack
+	jmp_buf env;                // Enviroment Buffer
+    	const char *file;           // Exception File
+	int line;                   // Exception Line
+	const Exception *exception; // Exception Reason
+};
+typedef struct ExceptFrame ExceptFrame;
+
+// Exception States 
+enum { EXCEPT_ENTERED=0, EXCEPT_RAISED, EXCEPT_HANDLED, EXCEPT_FINALIZED};
+
+void except_raise(const Exception *e, const char *file,int line); // Raise exceptions
+
+// External declarations 
+extern ExceptFrame *except_stack; // Global exception stack
+extern const Exception assert_failed; // Forward declaration for assert. 
+extern void asserted(int e);
+
+#ifdef NDEBUG
+#define ASSERTED(e) ((void)0)
+#else
+#define ASSERTED(e) ((void)((e)||(RAISE(assert_failed),0)))
+#endif
+
+// Raise an Exception.
+#define RAISE(e) except_raise(&(e), __FILE__, __LINE__)
+
+// Reraise the currect exception.
+#define RERAISE except_raise(except_frame.exception, \
+	except_frame.file, except_frame.line)
+
+// Switch to the previous exception frame and return.
+#define RETURN switch (except_stack = except_stack->prev,0) default: return
+
+// Start a try block.
+#define TRY do { \
+	volatile int except_flag; \
+	ExceptFrame except_frame; \
+	except_frame.prev = except_stack; \
+	except_stack = &except_frame;  \
+	except_flag = setjmp(except_frame.env); \
+	if (except_flag == EXCEPT_ENTERED) {
+
+// Handle specific example.
+#define EXCEPT(e) \
+		if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \
+	} else if (except_frame.exception == &(e)) { \
+		except_flag = EXCEPT_HANDLED;
+
+// Catch all other exceptions.        
+#define ELSE \
+		if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \
+	} else { \
+		except_flag = EXCEPT_HANDLED;
+
+// Execute finalization code.        
+#define FINALLY \
+		if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \
+	} { \
+		if (except_flag == EXCEPT_ENTERED) \
+			except_flag = EXCEPT_FINALIZED;
+
+// End Try block.         
+#define END_TRY \
+		if (except_flag == EXCEPT_ENTERED) except_stack = except_stack->prev; \
+		} if (except_flag == EXCEPT_RAISED) RERAISE; \
+} while (0)
+
+#endif

src/arena.c

@@ -0,0 +1,32 @@
+#include "../include/except.h"
+#include "../include/arena.h"
+#include <string.h> // memset
+#include <stdlib.h> // malloc 
+
+const Exception out_of_memory = { "Out Of Memory" }; // OOM Exception.
+                                                     
+Arena arena_new(ptrdiff_t cap, int flags){
+    Arena a = {0};
+    a.beg   = (char*)malloc(cap);
+    a.end   = a.beg ? a.beg + cap : 0;
+
+    if(!(flags & SOFTFAIL)) RAISE(out_of_memory);
+    if(!(flags & NOZERO)) memset(a.beg,0,cap);    
+
+    return a;
+}
+
+char* arena_alloc(Arena* a, ptrdiff_t nb, ptrdiff_t align, ptrdiff_t count, int flags){
+    ptrdiff_t pad = -(ptrdiff_t)a->beg & (align - 1);
+    
+    if (count > (a->end - a->beg - pad) / nb){
+        if (flags & SOFTFAIL) return 0;
+        RAISE(out_of_memory);
+    }
+
+    ptrdiff_t total  = count * nb;
+    char* p      = a->beg + pad;
+    a->beg      += pad + total;
+    return flags & NOZERO ? p : (char*)memset(p, 0, total);
+}
+

src/except.c

@@ -0,0 +1,30 @@
+#include "../include/except.h"
+#include <stdlib.h>
+#include <stdio.h>
+
+ExceptFrame *except_stack = NULL; // Global exception stack.
+const Exception assert_failed = { "Assertion Failure!" }; // If ASSERT fails.
+
+void except_raise(const Exception *e, const char *file,int line) {
+    // An exception was raised, grab the exception stack.
+	ExceptFrame *p = except_stack;
+    asserted(e != NULL);  // Ensure exception pointer is not NULL
+	if (p == NULL) { // Uncaught Exception
+        const char *msg = e->reason ? e->reason : "Uncaught Exception!"; 
+		fprintf(stderr,"\033[31m%s | Address: 0x%p | Raised at %s@%d \033[0m" ,msg,(void *)e,file,line);
+        fflush(stderr);
+        abort();
+    }
+   // Set the exception details to the current frame. 
+	p->exception = e; // Exception reason
+	p->file = file;
+	p->line = line;
+    // Move to the previous frame in the stack.
+	except_stack = except_stack->prev;
+    // Jump to the saved context environment.
+	longjmp(p->env, EXCEPT_RAISED);
+}
+void asserted(int e) {
+	ASSERTED(e);
+    (void)e;
+}

tests/01_arena_new.c

@@ -0,0 +1,27 @@
+#define DEBUG
+#include <stdio.h>
+#include "../include/arena.h"
+#include "../include/except.h"
+#include <string.h>
+#include <stdlib.h>
+#include <stdbool.h>
+
+#define BUFSZ MB(20)
+
+static bool isZeroed(void *memory, unsigned int size){
+    unsigned char *mm = (unsigned char*)memory;
+
+    // early out for empty size
+    if (size == 0) return true;
+
+    return (*mm == 0) && memcmp(mm, mm + 1, size - 1) == 0;
+}
+
+int main(void){
+    
+    Arena a = arena_new(BUFSZ, NOZERO | SOFTFAIL);
+    ASSERTED(a.beg != NULL);
+    ASSERTED(isZeroed(a.beg, BUFSZ) == false);
+    
+    return EXIT_SUCCESS;
+}

tests/02_arena_new.c

@@ -0,0 +1,27 @@
+#define DEBUG
+#include <stdio.h>
+#include "../include/arena.h"
+#include "../include/except.h"
+#include <string.h>
+#include <stdlib.h>
+#include <stdbool.h>
+
+#define BUFSZ MB(20)
+
+static bool isZeroed(void *memory, unsigned int size){
+    unsigned char *mm = (unsigned char*)memory;
+
+    // early out for empty size
+    if (size == 0) return true;
+
+    return (*mm == 0) && memcmp(mm, mm + 1, size - 1) == 0;
+}
+
+int main(void){
+    
+    Arena a = arena_new(BUFSZ,SOFTFAIL);
+    ASSERTED(a.beg != NULL);
+    ASSERTED(isZeroed(a.beg, BUFSZ) == true);
+    
+    return EXIT_SUCCESS;
+}

tests/03_arena_alloc.c

@@ -0,0 +1,30 @@
+#define DEBUG
+#include <stdio.h>
+#include "../include/arena.h"
+#include "../include/except.h"
+#include <string.h>
+#include <stdlib.h>
+#include <stdbool.h>
+
+#define BUFSZ MB(20)
+#define ASIZE MB(1)
+
+static bool isZeroed(void *memory, unsigned int size){
+    unsigned char *mm = (unsigned char*)memory;
+
+    // early out for empty size
+    if (size == 0) return true;
+
+    return (*mm == 0) && memcmp(mm, mm + 1, size - 1) == 0;
+}
+
+int main(void){
+    
+    Arena a = arena_new(BUFSZ, NOZERO | SOFTFAIL);
+    ASSERTED(a.beg != NULL);
+    ASSERTED(isZeroed(a.beg, BUFSZ) == false);
+    char *ptr = arena_alloc(&a, ASIZE, 1, 2, NOZERO);
+    ASSERTED(ptr != NULL);
+    ASSERTED(isZeroed(ptr,ASIZE ) == false);   
+    return EXIT_SUCCESS;
+}

tests/04_arena_alloc.c

@@ -0,0 +1,30 @@
+#define DEBUG
+#include <stdio.h>
+#include "../include/arena.h"
+#include "../include/except.h"
+#include <string.h>
+#include <stdlib.h>
+#include <stdbool.h>
+
+#define BUFSZ MB(20)
+#define ASIZE MB(1)
+
+static bool isZeroed(void *memory, unsigned int size){
+    unsigned char *mm = (unsigned char*)memory;
+
+    // early out for empty size
+    if (size == 0) return true;
+
+    return (*mm == 0) && memcmp(mm, mm + 1, size - 1) == 0;
+}
+
+int main(void){
+    
+    Arena a = arena_new(BUFSZ, NOZERO | SOFTFAIL);
+    ASSERTED(a.beg != NULL);
+    ASSERTED(isZeroed(a.beg, BUFSZ) == false);
+    char *ptr = arena_alloc(&a, ASIZE, 1, 2, 0);
+    ASSERTED(ptr != NULL);
+    ASSERTED(isZeroed(ptr,ASIZE ) == true);   
+    return EXIT_SUCCESS;
+}