kit

maint.mk (4636B)

---

 # mk/maint.mk
 # ===========================================================================
 # Developer maintenance targets: source formatting, the clangd compilation
 # database, optimizer benchmarking, and clean.
 
 .PHONY: format compile-commands bench-opt bench-cc perf-golden perf-gate code-size clean \
         regen-gram-meta regen-gram-unicode-props
 
 # Format only the .c/.h files changed in the working tree (staged, unstaged, or
 # new/untracked), restricted to the formatted roots and excluding test/pp. When
 # nothing has changed, fall back to formatting every source file.
 format:
 	@files=$$( { git diff --name-only --diff-filter=ACMR HEAD -- '*.c' '*.h'; \
 	             git ls-files --others --exclude-standard -- '*.c' '*.h'; } 2>/dev/null \
 	           | grep -E '^(src|include|driver|lang|test|rt)/' \
 	           | grep -vE '^test/pp/' \
 	           | sort -u ); \
 	if [ -n "$$files" ]; then \
 	  echo "$$files" | xargs clang-format -i --style=google; \
 	  echo "$$files" | sed 's/^/formatted /'; \
 	else \
 	  echo "no changed sources; formatting all"; \
 	  find src include driver lang test rt -path test/pp -prune -o \( -name '*.c' -o -name '*.h' \) -print | xargs clang-format -i --style=google; \
 	fi
 
 # Regenerate the gram meta-grammar parse tables (src/gram/meta_tables.{c,h})
 # from src/gram/meta.ebnf using the just-built `kit gram`. Output is checked in
 # so ordinary builds need no generator bootstrap; commit the result and `git
 # diff` shows any drift.
 regen-gram-meta: bin
 	$(BIN) gram --prefix kit_gram_meta_ -o src/gram/meta_tables.c \
 	  --header src/gram/meta_tables.h src/gram/meta.ebnf
 
 # Regenerate the gram Unicode property tables (src/gram/unicode_props.{c,h})
 # from the vendored, checksummed UCD. Offline and reproducible; run after
 # bumping data/ucd/<version>/ and commit (git diff = drift). No build needed.
 regen-gram-unicode-props:
 	python3 scripts/gen_gram_unicode_props.py data/ucd/17.0.0/ppucd.txt \
 	  --header src/gram/unicode_props.h --source src/gram/unicode_props.c
 
 # Regenerate the clangd compilation database (build/compile_commands.json).
 # clangd auto-discovers it under build/; re-run after adding/removing sources
 # or after `make clean`.
 compile-commands:
 	python3 scripts/gen_compile_commands.py
 
 bench-opt:
 	$(MAKE) RELEASE=1 bin
 	@KIT='$(abspath build/release/kit)' bash scripts/opt_bench.sh
 
 # -O0 C compile+link throughput/scaling benchmark + hotspot sampling. Builds a
 # release kit with clang (-O2, but with -g and without the symbol strip so
 # `sample` can attribute hotspots) into build/bench/kit, then sweeps each input
 # axis and fits a scaling exponent. Design + findings: doc/plan/PERF.md.
 bench-cc:
 	$(MAKE) RELEASE=1 PROFILE=1 CC=clang BUILD_DIR=build/bench bin
 	@KIT='$(abspath build/bench/kit)' bash scripts/cc_bench.sh
 
 # Perf A/B harness. `perf-golden` builds the current source as RELEASE and
 # snapshots it as a SELF-CONTAINED golden under build/release/golden/: the
 # copied binary sits next to its own support/rt symlink (the `%/support/rt`
 # pattern rule in Makefile), so it resolves its runtime from any cwd without
 # living in the checkout's build dir — the old "support dir not found" gotcha
 # when a golden was copied to /tmp. Workflow (see doc/plan/PERF.md):
 #   make perf-golden               # snapshot the pre-change build as golden
 #   <edit>; make bin RELEASE=1     # rebuild build/release/kit as the candidate
 #   make perf-gate                 # byte-identity gate: golden vs candidate
 PERF_GOLDEN_DIR = build/release/golden
 perf-golden: $(PERF_GOLDEN_DIR)/support/rt
 	$(MAKE) RELEASE=1 bin
 	cp build/release/kit $(PERF_GOLDEN_DIR)/kit
 	@echo "perf golden snapshot: $(PERF_GOLDEN_DIR)/kit (self-contained; runs from any cwd)"
 
 perf-gate:
 	@GOLDEN='$(abspath $(PERF_GOLDEN_DIR)/kit)' CAND='$(abspath build/release/kit)' \
 	  bash scripts/perf_identity_gate.sh
 
 # Regenerate doc/CODE_SIZE.md: per-component cloc line counts plus a binary
 # code-size section attributed from the release linker map. Requires cloc.
 # The map step relinks the release objects explicitly (not via libkit.a) so the
 # full object paths survive in the map and dead_strip still prunes unused code.
 RELMAP = build/release/kit.map
 ifeq ($(HOST_OS),darwin)
 RELMAP_LDFLAG = -Wl,-map,$(RELMAP)
 else
 RELMAP_LDFLAG = -Wl,-Map=$(RELMAP)
 endif
 
 code-size:
 	$(MAKE) RELEASE=1 bin
 	$(MAKE) RELEASE=1 $(RELMAP)
 	bash scripts/code_size.sh $(RELMAP)
 
 # Release binary relinked with a linker map (consumed by code-size).
 $(RELMAP): $(DRIVER_OBJS) $(LIB_OBJS)
 	$(CC) $(HOST_LDFLAGS) $(RELMAP_LDFLAG) -o $(BIN) $(DRIVER_OBJS) $(LIB_OBJS) $(HOST_LDLIBS)
 
 clean:
 	rm -rf $(BUILD_DIR)