bstack 0.1.4

A persistent, fsync-durable binary stack backed by a single file
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

CC      = cc
CFLAGS  = -std=c11 -Wall -Wextra -Wpedantic -O2

# Pass extra defines via DEFINES, e.g.:
#   make DEFINES=-DBSTACK_FEATURE_SET
DEFINES =

# Windows (MinGW / MSYS2): executables need .exe, run without ./
# Unix: no extension, run with ./
ifeq ($(OS),Windows_NT)
    EXE_EXT =.exe
    RUN     =
else
    EXE_EXT =
    RUN     = ./
endif

LIB      = libbstack.a
OBJ      = bstack.o
TEST_BIN = test_bstack$(EXE_EXT)
TEST_OBJ = test_bstack.o

# Set-enabled library — required by the hashmap example.
LIB_SET  = libbstack-set.a
OBJ_SET  = bstack-set.o

EXAMPLE_NAMES = basic buffer_reuse journal reading vec_store
EXAMPLE_BINS  = $(addprefix ../examples/,$(addsuffix $(EXE_EXT),$(EXAMPLE_NAMES)))
HASHMAP_BIN   = ../examples/hashmap$(EXE_EXT)

.PHONY: all test leaks clean \
        example example-basic example-buffer_reuse example-journal \
        example-reading example-vec_store example-hashmap

all: $(LIB)


$(LIB): $(OBJ)
	ar rcs $@ $^

$(OBJ): bstack.c bstack.h
	$(CC) $(CFLAGS) $(DEFINES) -c -o $@ $<

$(OBJ_SET): bstack.c bstack.h
	$(CC) $(CFLAGS) -DBSTACK_FEATURE_SET -c -o $@ $<

$(LIB_SET): $(OBJ_SET)
	ar rcs $@ $^

$(TEST_OBJ): test_bstack.c bstack.h
	$(CC) $(CFLAGS) $(DEFINES) -c -o $@ $<

$(TEST_BIN): $(TEST_OBJ) $(LIB)
	$(CC) $(CFLAGS) $(DEFINES) -o $@ $< -L. -lbstack -lpthread

test: $(TEST_BIN)
	$(RUN)$(TEST_BIN)

# Leak detection — macOS requires Xcode developer tools; Linux uses Valgrind.
# Usage: make leaks  (or: make leaks DEFINES=-DBSTACK_FEATURE_SET)
ifneq ($(OS),Windows_NT)
leaks: $(TEST_BIN)
	@if [ "$(shell uname -s)" = "Darwin" ]; then \
		MallocStackLogging=1 leaks --atExit -- $(RUN)$(TEST_BIN); \
	elif [ "$(shell uname -s)" = "Linux" ]; then \
		valgrind --leak-check=full --show-leak-kinds=all $(RUN)$(TEST_BIN); \
	else \
		echo "Leak detection not supported on this platform"; \
		exit 1; \
	fi
endif

# ── Examples ──────────────────────────────────────────────────────────────────
# Examples write .bstack files into examples/ next to the source.

../examples/basic$(EXE_EXT): ../examples/basic.c $(LIB)
	$(CC) $(CFLAGS) -I. -o $@ $< -L. -lbstack -lpthread

../examples/buffer_reuse$(EXE_EXT): ../examples/buffer_reuse.c $(LIB)
	$(CC) $(CFLAGS) -I. -o $@ $< -L. -lbstack -lpthread

../examples/journal$(EXE_EXT): ../examples/journal.c $(LIB)
	$(CC) $(CFLAGS) -I. -o $@ $< -L. -lbstack -lpthread

../examples/reading$(EXE_EXT): ../examples/reading.c $(LIB)
	$(CC) $(CFLAGS) -I. -o $@ $< -L. -lbstack -lpthread

../examples/vec_store$(EXE_EXT): ../examples/vec_store.c $(LIB)
	$(CC) $(CFLAGS) -I. -o $@ $< -L. -lbstack -lpthread

../examples/hashmap$(EXE_EXT): ../examples/hashmap.c $(LIB_SET)
	$(CC) $(CFLAGS) -DBSTACK_FEATURE_SET -I. -o $@ $< -L. -lbstack-set -lpthread

example-basic: ../examples/basic$(EXE_EXT)
	(cd ../examples && $(RUN)basic$(EXE_EXT))

example-buffer_reuse: ../examples/buffer_reuse$(EXE_EXT)
	(cd ../examples && $(RUN)buffer_reuse$(EXE_EXT))

example-journal: ../examples/journal$(EXE_EXT)
	(cd ../examples && $(RUN)journal$(EXE_EXT))

example-reading: ../examples/reading$(EXE_EXT)
	(cd ../examples && $(RUN)reading$(EXE_EXT))

example-vec_store: ../examples/vec_store$(EXE_EXT)
	(cd ../examples && $(RUN)vec_store$(EXE_EXT))

example-hashmap: ../examples/hashmap$(EXE_EXT)
	(cd ../examples && $(RUN)hashmap$(EXE_EXT))

example: $(EXAMPLE_BINS) $(HASHMAP_BIN)
	@echo "==> basic"        && (cd ../examples && $(RUN)basic$(EXE_EXT))
	@echo "==> buffer_reuse" && (cd ../examples && $(RUN)buffer_reuse$(EXE_EXT))
	@echo "==> journal"      && (cd ../examples && $(RUN)journal$(EXE_EXT))
	@echo "==> reading"      && (cd ../examples && $(RUN)reading$(EXE_EXT))
	@echo "==> vec_store"    && (cd ../examples && $(RUN)vec_store$(EXE_EXT))
	@echo "==> hashmap"      && (cd ../examples && $(RUN)hashmap$(EXE_EXT))

clean:
	rm -f $(OBJ) $(TEST_OBJ) $(OBJ_SET) $(LIB) $(LIB_SET) $(TEST_BIN) \
	      $(EXAMPLE_BINS) $(HASHMAP_BIN)