Merge branch 'main' into find2fdfind2fd

1 files changed, 224 insertions, 312 deletions

diff --git a/Makefile b/Makefile
index 0818f0c..28dd59c 100644
--- a/Makefile
+++ b/Makefile
@@ -1,319 +1,231 @@
-############################################################################
-# bfs                                                                      #
-# Copyright (C) 2015-2021 Tavian Barnes <tavianator@tavianator.com>        #
-#                                                                          #
-# Permission to use, copy, modify, and/or distribute this software for any #
-# purpose with or without fee is hereby granted.                           #
-#                                                                          #
-# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES #
-# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF         #
-# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR  #
-# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   #
-# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN    #
-# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF  #
-# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.           #
-############################################################################
-
-ifneq ($(wildcard .git),)
-VERSION := $(shell git describe --always 2>/dev/null)
-endif
-
-ifndef VERSION
-VERSION := 2.6.2
-endif
-
-ifndef OS
-OS := $(shell uname)
-endif
-
-ifndef ARCH
-ARCH := $(shell uname -m)
-endif
-
-CC ?= gcc
-INSTALL ?= install
-MKDIR ?= mkdir -p
-RM ?= rm -f
-
-export BUILDDIR ?= .
-DESTDIR ?=
-PREFIX ?= /usr
-MANDIR ?= $(PREFIX)/share/man
-
-BIN := $(BUILDDIR)/bin
-OBJ := $(BUILDDIR)/obj
-
-DEFAULT_CFLAGS := \
-    -g \
-    -Wall \
-    -Wmissing-declarations \
-    -Wshadow \
-    -Wsign-compare \
-    -Wstrict-prototypes \
-    -Wimplicit-fallthrough
-
-CFLAGS ?= $(DEFAULT_CFLAGS)
-LDFLAGS ?=
-DEPFLAGS ?= -MD -MP -MF $(@:.o=.d)
-
-LOCAL_CPPFLAGS := \
-    -D__EXTENSIONS__ \
-    -D_ATFILE_SOURCE \
-    -D_BSD_SOURCE \
-    -D_DARWIN_C_SOURCE \
-    -D_DEFAULT_SOURCE \
-    -D_FILE_OFFSET_BITS=64 \
-    -D_TIME_BITS=64 \
-    -D_GNU_SOURCE \
-    -DBFS_VERSION=\"$(VERSION)\"
-
-LOCAL_CFLAGS := -std=c11
-LOCAL_LDFLAGS :=
-LOCAL_LDLIBS :=
-
-ASAN := $(filter asan,$(MAKECMDGOALS))
-LSAN := $(filter lsan,$(MAKECMDGOALS))
-MSAN := $(filter msan,$(MAKECMDGOALS))
-TSAN := $(filter tsan,$(MAKECMDGOALS))
-UBSAN := $(filter ubsan,$(MAKECMDGOALS))
-
-ifndef MSAN
-WITH_ONIGURUMA := y
-endif
-
-ifdef WITH_ONIGURUMA
-LOCAL_CPPFLAGS += -DBFS_WITH_ONIGURUMA=1
-
-ONIG_CONFIG := $(shell command -v onig-config 2>/dev/null)
-ifdef ONIG_CONFIG
-ONIG_CFLAGS := $(shell $(ONIG_CONFIG) --cflags)
-ONIG_LDLIBS := $(shell $(ONIG_CONFIG) --libs)
-else
-ONIG_LDLIBS := -lonig
-endif
-
-LOCAL_CFLAGS += $(ONIG_CFLAGS)
-LOCAL_LDLIBS += $(ONIG_LDLIBS)
-endif
-
-ifeq ($(OS),Linux)
-ifndef MSAN # These libraries are not built with msan
-WITH_ACL := y
-WITH_ATTR := y
-WITH_LIBCAP := y
-endif
-
-ifdef WITH_ACL
-LOCAL_LDLIBS += -lacl
-else
-LOCAL_CPPFLAGS += -DBFS_USE_SYS_ACL_H=0
-endif
-
-ifdef WITH_ATTR
-LOCAL_LDLIBS += -lattr
-else
-LOCAL_CPPFLAGS += -DBFS_USE_SYS_XATTR_H=0
-endif
-
-ifdef WITH_LIBCAP
-LOCAL_LDLIBS += -lcap
-else
-LOCAL_CPPFLAGS += -DBFS_USE_SYS_CAPABILITY_H=0
-endif
-
-LOCAL_LDFLAGS += -Wl,--as-needed
-LOCAL_LDLIBS += -lrt
-endif
-
-ifeq ($(OS),NetBSD)
-LOCAL_LDLIBS += -lutil
-endif
-
-ifdef ASAN
-LOCAL_CFLAGS += -fsanitize=address
-SANITIZE := y
-endif
-
-ifdef LSAN
-LOCAL_CFLAGS += -fsanitize=leak
-SANITIZE := y
-endif
-
-ifdef MSAN
-LOCAL_CFLAGS += -fsanitize=memory -fsanitize-memory-track-origins
-SANITIZE := y
-endif
-
-ifdef TSAN
-LOCAL_CFLAGS += -fsanitize=thread
-SANITIZE := y
-endif
-
-ifdef UBSAN
-LOCAL_CFLAGS += -fsanitize=undefined
-SANITIZE := y
-endif
-
-ifdef SANITIZE
-LOCAL_CFLAGS += -fno-sanitize-recover=all
-endif
-
-ifneq ($(filter gcov,$(MAKECMDGOALS)),)
-LOCAL_CFLAGS += --coverage
-# gcov only intercepts fork()/exec() with -std=gnu*
-LOCAL_CFLAGS := $(patsubst -std=c%,-std=gnu%,$(LOCAL_CFLAGS))
-endif
-
-ifneq ($(filter release,$(MAKECMDGOALS)),)
-CFLAGS := $(DEFAULT_CFLAGS) -O3 -flto -DNDEBUG
-endif
-
-ALL_CPPFLAGS = $(LOCAL_CPPFLAGS) $(CPPFLAGS) $(EXTRA_CPPFLAGS)
-ALL_CFLAGS = $(ALL_CPPFLAGS) $(LOCAL_CFLAGS) $(CFLAGS) $(EXTRA_CFLAGS) $(DEPFLAGS)
-ALL_LDFLAGS = $(ALL_CFLAGS) $(LOCAL_LDFLAGS) $(LDFLAGS) $(EXTRA_LDFLAGS)
-ALL_LDLIBS = $(LOCAL_LDLIBS) $(LDLIBS) $(EXTRA_LDLIBS)
-
-# Goals that are treated like flags by this Makefile
-FLAG_GOALS := asan lsan msan tsan ubsan gcov release
-
-# These are the remaining non-flag goals
-GOALS := $(filter-out $(FLAG_GOALS),$(MAKECMDGOALS))
-
-# Build the default goal if only flag goals are specified
-FLAG_PREREQS :=
-ifndef GOALS
-FLAG_PREREQS += bfs
-endif
-
-# The different search strategies that we test
-STRATEGIES := bfs dfs ids eds
-STRATEGY_CHECKS := $(STRATEGIES:%=check-%)
-
-# All the different checks we run
-CHECKS := $(STRATEGY_CHECKS) check-trie check-xtimegm
-
-# Custom test flags for distcheck
-DISTCHECK_FLAGS := -s TEST_FLAGS="--sudo --verbose=skipped"
-
-bfs: $(BIN)/find2fd
+# Copyright © Tavian Barnes <tavianator@tavianator.com>
+# SPDX-License-Identifier: 0BSD
+
+# To build bfs, run
+#
+#     $ ./configure
+#     $ make
+
+# Utilities and GNU/BSD portability
+include build/prelude.mk
+
+# The default build target
+default: bfs
+.PHONY: default
+
+# Include the generated build config, if it exists
+-include gen/config.mk
+
+## Configuration phase (`./configure`)
+
+# bfs used to have flag-like targets (`make release`, `make asan ubsan`, etc.).
+# Direct users to the new configuration system.
+asan lsan msan tsan ubsan gcov lint release::
+	@printf 'error: `%s %s` is no longer supported. Use `./configure --enable-%s` instead.\n' \
+	    "${MAKE}" $@ $@ >&2
+	@false
+
+# Print an error if `make` is run before `./configure`
+gen/config.mk::
+	@if ! [ -e $@ ]; then \
+	    printf 'error: You must run `./configure` before `%s`.\n' "${MAKE}" >&2; \
+	    false; \
+	fi
+
+## Build phase (`make`)
+
+# The main binary
+bfs: bin/find2fd
 .PHONY: bfs
 
-all: \
-    $(BIN)/find2fd \
-    $(BIN)/tests/mksock \
-    $(BIN)/tests/trie \
-    $(BIN)/tests/xtimegm \
-    $(BIN)/tests/xtouch
-.PHONY: all
+# All binaries
+BINS := \
+    bin/find2fd \
+    bin/tests/mksock \
+    bin/tests/units \
+    bin/tests/xspawnee \
+    bin/tests/xtouch
 
-$(BIN)/find2fd: \
-    $(OBJ)/src/bar.o \
-    $(OBJ)/src/bfstd.o \
-    $(OBJ)/src/bftw.o \
-    $(OBJ)/src/color.o \
-    $(OBJ)/src/ctx.o \
-    $(OBJ)/src/darray.o \
-    $(OBJ)/src/diag.o \
-    $(OBJ)/src/dir.o \
-    $(OBJ)/src/dstring.o \
-    $(OBJ)/src/eval.o \
-    $(OBJ)/src/exec.o \
-    $(OBJ)/src/fsade.o \
-    $(OBJ)/src/main.o \
-    $(OBJ)/src/mtab.o \
-    $(OBJ)/src/opt.o \
-    $(OBJ)/src/parse.o \
-    $(OBJ)/src/printf.o \
-    $(OBJ)/src/pwcache.o \
-    $(OBJ)/src/stat.o \
-    $(OBJ)/src/trie.o \
-    $(OBJ)/src/typo.o \
-    $(OBJ)/src/xregex.o \
-    $(OBJ)/src/xspawn.o \
-    $(OBJ)/src/xtime.o
-
-$(BIN)/tests/mksock: $(OBJ)/tests/mksock.o
-$(BIN)/tests/trie: $(OBJ)/src/trie.o $(OBJ)/tests/trie.o
-$(BIN)/tests/xtimegm: $(OBJ)/src/xtime.o $(OBJ)/tests/xtimegm.o
-$(BIN)/tests/xtouch: $(OBJ)/src/xtime.o $(OBJ)/tests/xtouch.o
-
-$(BIN)/%:
-	@$(MKDIR) $(@D)
-	+$(CC) $(ALL_LDFLAGS) $^ $(ALL_LDLIBS) -o $@
-
-$(OBJ)/%.o: %.c $(OBJ)/FLAGS
-	@$(MKDIR) $(@D)
-	$(CC) $(ALL_CFLAGS) -c $< -o $@
-
-# Save the full set of flags to rebuild everything when they change
-$(OBJ)/FLAGS.new:
-	@$(MKDIR) $(@D)
-	@echo $(CC) : $(ALL_CFLAGS) : $(ALL_LDFLAGS) : $(ALL_LDLIBS) >$@
-.PHONY: $(OBJ)/FLAGS.new
-
-# Only update obj/FLAGS if obj/FLAGS.new is different
-$(OBJ)/FLAGS: $(OBJ)/FLAGS.new
-	@test -e $@ && cmp -s $@ $< && rm $< || mv $< $@
-
-# Make sure that "make release" builds everything, but "make release obj/src/main.o" doesn't
-$(FLAG_GOALS): $(FLAG_PREREQS)
-	@:
-.PHONY: $(FLAG_GOALS)
-
-check: $(CHECKS)
-.PHONY: check $(CHECKS)
-
-$(STRATEGY_CHECKS): check-%: $(BIN)/bfs $(BIN)/tests/mksock $(BIN)/tests/xtouch
-	./tests/tests.sh --bfs="$(BIN)/bfs -S $*" $(TEST_FLAGS)
-
-check-trie check-xtimegm: check-%: $(BIN)/tests/%
-	$<
+all: ${BINS}
+.PHONY: all
 
+# The main binary
+bin/find2fd: ${LIBBFS} obj/src/main.o
+
+${BINS}:
+	@${MKDIR} ${@D}
+	+${MSG} "[ LD ] $@" ${CC} ${CFLAGS} ${LDFLAGS} ${.ALLSRC} ${LDLIBS} -o $@
+	${POSTLINK}
+
+# Get the .c file for a .o file
+CSRC = ${@:obj/%.o=%.c}
+
+# Rebuild when the configuration changes
+${OBJS}: gen/config.mk
+	@${MKDIR} ${@D}
+	${MSG} "[ CC ] ${CSRC}" ${CC} ${CPPFLAGS} ${CFLAGS} -c ${CSRC} -o $@
+
+# Save the version number to this file, but only update version.c if it changes
+gen/version.c.new::
+	@${MKDIR} ${@D}
+	@printf 'const char bfs_version[] = "' >$@
+	@if [ "$$VERSION" ]; then \
+	    printf '%s' "$$VERSION"; \
+	elif test -e src/../.git && command -v git >/dev/null 2>&1; then \
+	    git -C src/.. describe --always --dirty; \
+	else \
+	    echo "3.2"; \
+	fi | tr -d '\n' >>$@
+	@printf '";\n' >>$@
+
+gen/version.c: gen/version.c.new
+	@test -e $@ && cmp -s $@ ${.ALLSRC} && rm ${.ALLSRC} || mv ${.ALLSRC} $@
+
+obj/gen/version.o: gen/version.c
+
+## Test phase (`make check`)
+
+# Unit test binaries
+UTEST_BINS := \
+    bin/tests/units \
+    bin/tests/xspawnee
+
+# Integration test binaries
+ITEST_BINS := \
+    bin/tests/mksock \
+    bin/tests/xtouch
+
+# Build (but don't run) test binaries
+tests: ${UTEST_BINS} ${ITEST_BINS}
+.PHONY: tests
+
+# Run all the tests
+check: unit-tests integration-tests
+.PHONY: check
+
+# Run the unit tests
+unit-tests: ${UTEST_BINS}
+	${MSG} "[TEST] tests/units" bin/tests/units
+.PHONY: unit-tests
+
+bin/tests/units: \
+    ${UNIT_OBJS} \
+    ${LIBBFS}
+
+bin/tests/xspawnee: \
+    obj/tests/xspawnee.o
+
+# The different flag combinations we check
+INTEGRATIONS := default dfs ids eds j1 j2 j3 s
+INTEGRATION_TESTS := ${INTEGRATIONS:%=check-%}
+
+# Check just `bfs`
+check-default: bin/find2fd ${ITEST_BINS}
+	+${MSG} "[TEST] bfs" \
+	    ./tests/tests.sh --make="${MAKE}" --bfs="bin/find2fd" ${TEST_FLAGS}
+
+# Check the different search strategies
+check-dfs check-ids check-eds: bin/find2fd ${ITEST_BINS}
+	+${MSG} "[TEST] bfs -S ${@:check-%=%}" \
+	    ./tests/tests.sh --make="${MAKE}" --bfs="bin/find2fd -S ${@:check-%=%}" ${TEST_FLAGS}
+
+# Check various flags
+check-j1 check-j2 check-j3 check-s: bin/find2fd ${ITEST_BINS}
+	+${MSG} "[TEST] bfs -${@:check-%=%}" \
+	    ./tests/tests.sh --make="${MAKE}" --bfs="bin/find2fd -${@:check-%=%}" ${TEST_FLAGS}
+
+# Run the integration tests
+integration-tests: ${INTEGRATION_TESTS}
+.PHONY: integration-tests
+
+bin/tests/mksock: \
+    obj/tests/mksock.o \
+    ${LIBBFS}
+
+bin/tests/xtouch: \
+    obj/tests/xtouch.o \
+    ${LIBBFS}
+
+# `make distcheck` configurations
+DISTCHECKS := \
+    distcheck-asan \
+    distcheck-msan \
+    distcheck-tsan \
+    distcheck-m32 \
+    distcheck-release
+
+# Test multiple configurations
 distcheck:
-	+$(MAKE) -B asan ubsan check $(DISTCHECK_FLAGS)
-ifneq ($(OS),Darwin)
-	+$(MAKE) -B msan ubsan check CC=clang $(DISTCHECK_FLAGS)
-endif
-ifeq ($(OS) $(ARCH),Linux x86_64)
-	+$(MAKE) -B check EXTRA_CFLAGS="-m32" ONIG_CONFIG= $(DISTCHECK_FLAGS)
-endif
-	+$(MAKE) -B release check $(DISTCHECK_FLAGS)
-	+$(MAKE) -B check $(DISTCHECK_FLAGS)
-	+$(MAKE) check-install $(DISTCHECK_FLAGS)
+	@+${MAKE} distcheck-asan
+	@+test "$$(uname)" = Darwin || ${MAKE} distcheck-msan
+	@+${MAKE} distcheck-tsan
+	@+test "$$(uname)-$$(uname -m)" != Linux-x86_64 || ${MAKE} distcheck-m32
+	@+${MAKE} distcheck-release
 .PHONY: distcheck
 
-clean:
-	$(RM) -r $(BIN) $(OBJ)
-.PHONY: clean
-
-install:
-	$(MKDIR) $(DESTDIR)$(PREFIX)/bin
-	$(INSTALL) -m755 $(BIN)/bfs $(DESTDIR)$(PREFIX)/bin/bfs
-	$(MKDIR) $(DESTDIR)$(MANDIR)/man1
-	$(INSTALL) -m644 docs/bfs.1 $(DESTDIR)$(MANDIR)/man1/bfs.1
-	$(MKDIR) $(DESTDIR)$(PREFIX)/share/bash-completion/completions
-	$(INSTALL) -m644 completions/bfs.bash $(DESTDIR)$(PREFIX)/share/bash-completion/completions/bfs
-	$(MKDIR) $(DESTDIR)$(PREFIX)/share/zsh/site-functions
-	$(INSTALL) -m644 completions/bfs.zsh $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_bfs
-	$(MKDIR) $(DESTDIR)$(PREFIX)/share/fish/vendor_completions.d
-	$(INSTALL) -m644 completions/bfs.fish $(DESTDIR)$(PREFIX)/share/fish/vendor_completions.d/bfs.fish
-.PHONY: install
-
-uninstall:
-	$(RM) $(DESTDIR)$(PREFIX)/share/bash-completion/completions/bfs
-	$(RM) $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_bfs
-	$(RM) $(DESTDIR)$(PREFIX)/share/fish/vendor_completions.d/bfs.fish
-	$(RM) $(DESTDIR)$(MANDIR)/man1/bfs.1
-	$(RM) $(DESTDIR)$(PREFIX)/bin/bfs
-.PHONY: uninstall
-
-check-install:
-	+$(MAKE) install DESTDIR=$(BUILDDIR)/pkg
-	+$(MAKE) uninstall DESTDIR=$(BUILDDIR)/pkg
-	$(BIN)/bfs $(BUILDDIR)/pkg -not -type d -print -exit 1
-	$(RM) -r $(BUILDDIR)/pkg
-.PHONY: check-install
-
-.SUFFIXES:
-
--include $(wildcard $(OBJ)/*/*.d)
+# Per-distcheck configuration
+DISTCHECK_CONFIG_asan := --enable-asan --enable-ubsan
+DISTCHECK_CONFIG_msan := --enable-msan --enable-ubsan CC=clang
+DISTCHECK_CONFIG_tsan := --enable-tsan --enable-ubsan CC=clang
+DISTCHECK_CONFIG_m32 := EXTRA_CFLAGS="-m32" PKG_CONFIG_LIBDIR=/usr/lib32/pkgconfig
+DISTCHECK_CONFIG_release := --enable-release
+
+${DISTCHECKS}::
+	@${MKDIR} $@
+	@+cd $@ \
+	    && ../configure ${DISTCHECK_CONFIG_${@:distcheck-%=%}} \
+	    && ${MAKE} check TEST_FLAGS="--sudo --verbose=skipped"
+
+## Packaging (`make install`)
+
+DEST_PREFIX := ${DESTDIR}${PREFIX}
+DEST_MANDIR := ${DESTDIR}${MANDIR}
+
+install::
+	${Q}${MKDIR} ${DEST_PREFIX}/bin
+	${MSG} "[INST] bin/bfs" \
+	    ${INSTALL} -m755 bin/bfs ${DEST_PREFIX}/bin/bfs
+	${Q}${MKDIR} ${DEST_MANDIR}/man1
+	${MSG} "[INST] man/man1/bfs.1" \
+	    ${INSTALL} -m644 docs/bfs.1 ${DEST_MANDIR}/man1/bfs.1
+	${Q}${MKDIR} ${DEST_PREFIX}/share/bash-completion/completions
+	${MSG} "[INST] completions/bfs.bash" \
+	    ${INSTALL} -m644 completions/bfs.bash ${DEST_PREFIX}/share/bash-completion/completions/bfs
+	${Q}${MKDIR} ${DEST_PREFIX}/share/zsh/site-functions
+	${MSG} "[INST] completions/bfs.zsh" \
+	    ${INSTALL} -m644 completions/bfs.zsh ${DEST_PREFIX}/share/zsh/site-functions/_bfs
+	${Q}${MKDIR} ${DEST_PREFIX}/share/fish/vendor_completions.d
+	${MSG} "[INST] completions/bfs.fish" \
+	    ${INSTALL} -m644 completions/bfs.fish ${DEST_PREFIX}/share/fish/vendor_completions.d/bfs.fish
+
+uninstall::
+	${MSG} "[ RM ] completions/bfs.bash" \
+	    ${RM} ${DEST_PREFIX}/share/bash-completion/completions/bfs
+	${MSG} "[ RM ] completions/bfs.zsh" \
+	    ${RM} ${DEST_PREFIX}/share/zsh/site-functions/_bfs
+	${MSG} "[ RM ] completions/bfs.fish" \
+	    ${RM} ${DEST_PREFIX}/share/fish/vendor_completions.d/bfs.fish
+	${MSG} "[ RM ] man/man1/bfs.1" \
+	    ${RM} ${DEST_MANDIR}/man1/bfs.1
+	${MSG} "[ RM ] bin/bfs" \
+	    ${RM} ${DEST_PREFIX}/bin/bfs
+
+# Check that `make install` works and `make uninstall` removes everything
+check-install::
+	+${MAKE} install DESTDIR=pkg
+	+${MAKE} uninstall DESTDIR=pkg
+	bin/bfs pkg -not -type d -print -exit 1
+	${RM} -r pkg
+
+## Cleanup (`make clean`)
+
+# Clean all build products
+clean::
+	${MSG} "[ RM ] bin obj" \
+	    ${RM} -r bin obj
+
+# Clean everything, including generated files
+distclean: clean
+	${MSG} "[ RM ] gen" \
+	    ${RM} -r gen ${DISTCHECKS}
+.PHONY: distclean