Benchmarked memory models for Toy_Array, read more

The results can be found in
'tests/benchmarks/array_allocation/results.md'

The results are disappointing, as 'malloc()' is simply faster in every
possible situation compared to my custom arena allocator.

tests/benchmarks/bucket_ideal/bench_main.c

@@ -0,0 +1,78 @@
+#include "toy.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+
+//generate an immense series of Toy_String instances to fill the buckets, thrn compare the time taken for each possible vale of TOY_BUCKET_IDEAL
+
+static unsigned int hash(unsigned int x) {
+	x = ((x >> 16) ^ x) * 0x45d9f3b;
+	x = ((x >> 16) ^ x) * 0x45d9f3b;
+	x = ((x >> 16) ^ x);
+	return x;
+}
+
+static unsigned int seed = 42;
+
+static unsigned int rng() {
+	return seed = hash(seed);
+}
+
+#define MAX 9
+const char* samples[] = { //9 entries
+	"the",
+	"quick",
+	"brown",
+	"fox",
+	"jumped",
+	"over",
+	"the",
+	"lazy",
+	"dog",
+};
+
+void stress_fillBucket(Toy_Bucket** bucketHandle) {
+	for (unsigned int i = 0; i < 10000000; i++) {
+		//create some leaf and node strings
+		Toy_String* a = Toy_createString(bucketHandle, samples[rng() % MAX]);
+		Toy_String* b = Toy_createString(bucketHandle, samples[rng() % MAX]);
+		Toy_String* c = Toy_createString(bucketHandle, samples[rng() % MAX]);
+		Toy_String* d = Toy_createString(bucketHandle, samples[rng() % MAX]);
+
+		Toy_String* l = Toy_concatStrings(bucketHandle, a, b);
+		Toy_String* r = Toy_concatStrings(bucketHandle, c, d);
+		Toy_concatStrings(bucketHandle, l, r);
+
+//		char* buffer = Toy_getStringRawBuffer(s);
+//		printf("%s\n", buffer);
+//		free(buffer);
+	}
+}
+
+static unsigned long long int measureDepth(Toy_Bucket* bucket) {
+	return bucket == NULL ? 0 : 1 + measureDepth(bucket->next);
+}
+
+static unsigned long long int measureCapacity(Toy_Bucket* bucket) {
+	return bucket == NULL ? 0 : bucket->capacity + measureCapacity(bucket->next);
+}
+
+static unsigned long long int measureCount(Toy_Bucket* bucket) {
+	return bucket == NULL ? 0 : bucket->count + measureCount(bucket->next);
+}
+
+int main() {
+	Toy_Bucket* bucket = Toy_allocateBucket(TOY_BUCKET_IDEAL);
+
+	stress_fillBucket(&bucket);
+
+	unsigned long long int depth = measureDepth(bucket);
+	unsigned long long int capacity = measureCapacity(bucket);
+	unsigned long long int count = measureCount(bucket);
+
+	printf(TOY_CC_FONT_RED TOY_CC_BACK_YELLOW "Result: %u: %llu, %llu, %llu" TOY_CC_RESET "\n", TOY_BUCKET_IDEAL, depth, capacity, count);
+
+	Toy_freeBucket(&bucket);
+
+	return 0;
+}

tests/benchmarks/bucket_ideal/makefile

@@ -0,0 +1,111 @@
+#compiler settings
+CC=gcc
+CFLAGS+=-std=c17 -g -Wall -Werror -Wextra -Wpedantic -Wformat=2
+LIBS+=-lm
+LDFLAGS+=
+
+ifeq ($(shell uname),Linux)
+LDFLAGS=-Wl,--gc-sections
+else ifeq ($(OS),Windows_NT)
+LDFLAGS=-Wl,--gc-sections
+else ifeq ($(shell uname),Darwin)
+LDFLAGS=-Wl,-dead_strip
+else
+	@echo "LDFLAGS set failed - what platform is this?"
+endif
+
+#patched incl
+TOY_SOURCEDIR=source
+
+#directories
+TEST_ROOTDIR=../../..
+TEST_SOURCEDIR=$(TEST_ROOTDIR)/$(TOY_SOURCEDIR)
+TEST_CASESDIR=.
+
+TEST_OUTDIR=out
+TEST_OBJDIR=obj
+
+#file names
+TEST_SOURCEFILES=$(wildcard $(TEST_SOURCEDIR)/*.c)
+TEST_CASESFILES=$(wildcard $(TEST_CASESDIR)/bench_*.c)
+
+#build the object files, compile the test cases, and run
+all: clean
+	$(MAKE) TOY_BUCKET_IDEAL=16372 all-override
+	$(MAKE) TOY_BUCKET_IDEAL=32756 all-override
+	$(MAKE) TOY_BUCKET_IDEAL=65524 all-override
+	$(MAKE) TOY_BUCKET_IDEAL=131060 all-override
+	$(MAKE) TOY_BUCKET_IDEAL=262132 all-override
+
+all-override: clean
+	$(MAKE) build-source
+	$(MAKE) build-cases
+	$(MAKE) build-link
+	$(MAKE) build-run
+
+#targets for each step
+.PHONY: build-source
+build-source: $(TEST_OUTDIR) $(TEST_OBJDIR) $(addprefix $(TEST_OBJDIR)/,$(notdir $(TEST_SOURCEFILES:.c=.o)))
+
+.PHONY: build-cases
+build-cases: $(TEST_OUTDIR) $(TEST_OBJDIR) $(addprefix $(TEST_OBJDIR)/,$(notdir $(TEST_CASESFILES:.c=.o)))
+
+.PHONY: build-link
+build-link: $(TEST_OUTDIR) $(TEST_OBJDIR) $(addprefix $(TEST_OUTDIR)/,$(notdir $(TEST_CASESFILES:%.c=%.exe)))
+
+.PHONY: build-run
+build-run: $(addprefix $(TEST_OUTDIR)/,$(notdir $(TEST_CASESFILES:%.c=%.exe))) $(addprefix $(TEST_OUTDIR)/,$(notdir $(TEST_CASESFILES:%.c=%.run)))
+
+#compilation steps
+$(TEST_OBJDIR)/%.o: $(TEST_SOURCEDIR)/%.c
+	$(CC) -DTOY_BUCKET_IDEAL=$(TOY_BUCKET_IDEAL) -c -o $@ $< $(addprefix -I,$(TEST_SOURCEDIR)) $(CFLAGS) -fdata-sections -ffunction-sections
+
+$(TEST_OBJDIR)/%.o: $(TEST_CASESDIR)/%.c
+	$(CC) -DTOY_BUCKET_IDEAL=$(TOY_BUCKET_IDEAL) -c -o $@ $< $(addprefix -I,$(TEST_SOURCEDIR) $(TEST_CASESDIR)) $(CFLAGS) -fdata-sections -ffunction-sections
+
+$(TEST_OUTDIR)/%.exe: $(TEST_OBJDIR)/%.o
+	@$(CC) -DTOY_BUCKET_IDEAL=$(TOY_BUCKET_IDEAL) -o $@ $< $(addprefix $(TEST_OBJDIR)/,$(notdir $(TEST_SOURCEFILES:.c=.o))) $(CFLAGS) $(LIBS) $(LDFLAGS)
+	strip $@
+
+.PRECIOUS: $(TEST_OUTDIR)/%.run
+$(TEST_OUTDIR)/%.run: $(TEST_OUTDIR)/%.exe
+	@/usr/bin/time --format "User System\n%U %E" $<
+
+#util targets
+$(TEST_OUTDIR):
+	mkdir $(TEST_OUTDIR)
+
+$(TEST_OBJDIR):
+	mkdir $(TEST_OBJDIR)
+
+#util commands
+.PHONY: clean
+clean:
+ifeq ($(shell uname),Linux)
+	find . -type f -name '*.o' -delete
+	find . -type f -name '*.a' -delete
+	find . -type f -name '*.exe' -delete
+	find . -type f -name '*.dll' -delete
+	find . -type f -name '*.lib' -delete
+	find . -type f -name '*.so' -delete
+	find . -type f -name '*.dylib' -delete
+	find . -type d -name 'out' -delete
+	find . -type d -name 'obj' -delete
+else ifeq ($(OS),Windows_NT)
+	$(RM) *.o *.a *.exe *.dll *.lib *.so *.dylib
+	$(RM) out
+	$(RM) obj
+else ifeq ($(shell uname),Darwin)
+	find . -type f -name '*.o' -delete
+	find . -type f -name '*.a' -delete
+	find . -type f -name '*.exe' -delete
+	find . -type f -name '*.dll' -delete
+	find . -type f -name '*.lib' -delete
+	find . -type f -name '*.so' -delete
+	find . -type f -name '*.dylib' -delete
+	find . -type d -name 'out' -delete
+	find . -type d -name 'obj' -delete
+else
+	@echo "Deletion failed - what platform is this?"
+endif
+