Makefile

# General Variables
SHELL := bash

# Build configuration
CC ?= clang # or gcc
ENABLE_ASAN ?= 0
BUILD_TYPE ?= debug

# Directories
BIN_DIR    := bin
TEST_DIR   := test
INC_DIR    := include
DOC_DIR    := doc
ASSET_DIR := assets

# Flags
CFLAGS_BASE := -Wall -Wextra -pedantic -std=c11 -I$(INC_DIR)
LDFLAGS :=
LIBS      :=

# Sanitizer configuration
ifeq ($(ENABLE_ASAN),1)
  CFLAGS_SAN := -fsanitize=address
  LDFLAGS   += -fsanitize=address
  export ASAN_OPTIONS=verbosity=0:detect_leaks=1:log_path=asan.log
endif

# Build type configuration
ifeq ($(BUILD_TYPE),release)
  CFLAGS_TYPE := -O2 -DNDEBUG
else
  CFLAGS_TYPE := -g -O0
endif

# Combine flags
CFLAGS := $(CFLAGS_BASE) $(CFLAGS_SAN) $(CFLAGS_TYPE)

# Binary names
TEST_BINARY    := $(BIN_DIR)/test_bptree
BENCH_BINARY   := $(BIN_DIR)/bench_bptree
EXAMPLE_BINARY := $(BIN_DIR)/example

# Default target
.DEFAULT_GOAL := help

.PHONY: help
help: ## Show available targets
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
	awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

$(BIN_DIR):
	mkdir -p $(BIN_DIR)

##############################################################################################################
## Pattern Rule for Building Binaries
##############################################################################################################
# This rule compiles a C file in the TEST_DIR into a binary in BIN_DIR
$(BIN_DIR)/%: $(TEST_DIR)/%.c | $(BIN_DIR)
	$(CC) $(CFLAGS) -o $@ $< $(LDFLAGS) $(LIBS)

##############################################################################################################
## Conventional Targets
##############################################################################################################

.PHONY: all
all: clean test bench example doc ## Build everything, run tests, benchmarks, and generate docs

.PHONY: test
test: $(TEST_BINARY) ## Build and run tests
	@echo "Running tests..."
	./$(TEST_BINARY)

.PHONY: bench
bench: $(BENCH_BINARY) ## Build and run benchmarks
	@echo "Running benchmarks..."
	./$(BENCH_BINARY)

.PHONY: example
example: $(EXAMPLE_BINARY) ## Run example program
	@echo "Running the example..."
	./$(EXAMPLE_BINARY)

.PHONY: clean
clean: ## Remove build artifacts
	@echo "Cleaning up build artifacts..."
	rm -rf $(BIN_DIR) $(DOC_DIR)/* *.gcno *.gcda *.gcov

.PHONY: format
format: ## Format source code
	@echo "Formatting source code..."
	@command -v clang-format >/dev/null 2>&1 || { echo "clang-format not found."; exit 1; }
	clang-format -i $(TEST_DIR)/*.c $(INC_DIR)/*.h

.PHONY: lint
lint: ## Run linter checks
	@echo "Running linters..."
	cppcheck --enable=all --inconclusive --quiet --std=c11 -I$(INC_DIR) --suppress=missingIncludeSystem $(TEST_DIR)

.PHONY: install
install: ## Install header file system-wide
	@echo "Installing bptree.h..."
	install -d /usr/local/include
	install -m 0644 $(INC_DIR)/bptree.h /usr/local/include/

.PHONY: uninstall
uninstall: ## Remove installed header file
	@echo "Uninstalling bptree.h..."
	rm -f /usr/local/include/bptree.h

.PHONY: install-deps
install-deps: ## Install development dependencies (Debian-based)
	@echo "Installing development dependencies..."
	sudo apt-get update && sudo apt-get install -y \
		gcc gdb clang clang-format clang-tools cppcheck valgrind graphviz \
		kcachegrind graphviz linux-tools-common linux-tools-generic linux-tools-$(shell uname -r)

.PHONY: coverage
coverage: CFLAGS += -fprofile-arcs -ftest-coverage
coverage: LDFLAGS += -lgcov
coverage: clean $(TEST_BINARY) ## Generate code coverage report
	@echo "Running tests for coverage..."
	./$(TEST_BINARY)
	@echo "Generating code coverage report..."
	gcov -o $(BIN_DIR) $(TEST_DIR)/test_bptree.c
	@echo "Coverage report generated"

.PHONY: doc
doc: ## Generate documentation using Doxygen
	@echo "Generating documentation..."
	@test -f Doxyfile || { echo "Error: Doxyfile not found."; exit 1; }
	doxygen Doxyfile

##############################################################################################################
## Release and Debugging Targets
##############################################################################################################

.PHONY: release
release: BUILD_TYPE=release
release: all ## Like 'all', but builds with code optimizations
	@echo "Built in release mode."

.PHONY: memcheck
memcheck: $(EXAMPLE_BINARY) $(TEST_BINARY) $(BENCH_BINARY) ## Run Valgrind memory checks
	@echo "Running Valgrind memory checks..."
	valgrind --leak-check=full --show-leak-kinds=all ./$(EXAMPLE_BINARY)
	valgrind --leak-check=full --show-leak-kinds=all ./$(TEST_BINARY)
	valgrind --leak-check=full --show-leak-kinds=all ./$(BENCH_BINARY)
	@echo "Valgrind checks completed"

.PHONY: profile
profile: CFLAGS += -pg
profile: LDFLAGS += -pg
profile: clean $(BENCH_BINARY) ## Build and run with gprof profiling
	@echo "Running profiling (gprof)..."
	./$(BENCH_BINARY)
	gprof $(BENCH_BINARY) gmon.out > profile_report.txt
	@echo "Profile report saved as profile_report.txt"

.PHONY: ubsan
ubsan: CFLAGS += -fsanitize=undefined
ubsan: LDFLAGS += -fsanitize=undefined
ubsan: clean $(TEST_BINARY) $(BENCH_BINARY) $(EXAMPLE_BINARY) ## Run `undefined behavior sanitizer` tests
	@echo "Running UBSan tests..."
	UBSAN_OPTIONS=print_stacktrace=1 ./$(EXAMPLE_BINARY)
	UBSAN_OPTIONS=print_stacktrace=1 ./$(TEST_BINARY)
	UBSAN_OPTIONS=print_stacktrace=1 ./$(BENCH_BINARY)

.PHONY: asan
asan: CFLAGS += -fsanitize=address
asan: LDFLAGS += -fsanitize=address
asan: clean $(TEST_BINARY) $(BENCH_BINARY) $(EXAMPLE_BINARY) ## Run `address sanitizer` tests
	@echo "Running ASan tests..."
	ASAN_OPTIONS=detect_leaks=1 ./$(EXAMPLE_BINARY)
	ASAN_OPTIONS=detect_leaks=1 ./$(TEST_BINARY)
	ASAN_OPTIONS=detect_leaks=1 ./$(BENCH_BINARY)

.PHONY: analyze
analyze: ## Run Clang Static Analyzer
	@echo "Running Clang Static Analyzer..."
	scan-build --status-bugs $(MAKE) clean all

.PHONY: perf
perf: $(BENCH_BINARY) ## Profile using Linux perf
	@echo "Recording perf data..."
	@echo "If necessary, run: sudo sh -c 'echo 1 > /proc/sys/kernel/perf_event_paranoid'"
	perf record -g ./$(BENCH_BINARY)
	@echo "Launching perf report..."
	perf report

.PHONY: callgrind
callgrind: $(BENCH_BINARY) ## Profile using Valgrind's callgrind
	valgrind --tool=callgrind --callgrind-out-file=callgrind.out ./$(BENCH_BINARY)
	@echo "Callgrind output saved to callgrind.out"
	@echo "Use 'kcachegrind callgrind.out' to visualize"

.PHONY: cachegrind
cachegrind: $(BENCH_BINARY) ## Profile CPU cache usage using Valgrind's cachegrind
	valgrind --tool=cachegrind --cachegrind-out-file=cachegrind.out ./$(BENCH_BINARY)
	@echo "Cachegrind output saved to cachegrind.out"
	@echo "Use 'cg_annotate cachegrind.out' to read the report"

.PHONY: trace
trace: $(BENCH_BINARY) ## Trace syscalls using strace
	strace -o trace.log -T -tt ./$(BENCH_BINARY)
	@echo "Syscall trace saved to trace.log"

.PHONY: setup-hooks
setup-hooks: ## Install Git hooks (pre-commit and pre-push)
	@echo "Setting up Git hooks..."
	@if ! command -v pre-commit &> /dev/null; then \
	   echo "pre-commit not found. Please install it using 'pip install pre-commit'"; \
	   exit 1; \
	fi
	@pre-commit install --hook-type pre-commit
	@pre-commit install --hook-type pre-push
	@pre-commit install-hooks

.PHONY: test-hooks
test-hooks: ## Test Git hooks on all files
	@echo "Testing Git hooks..."
	@pre-commit run --all-files --show-diff-on-failure