Split the Makefile into Mk fragments and fix the default target

5 files changed, 131 insertions, 0 deletions

diff --git a/Mk/gzip.mk b/Mk/gzip.mk
new file mode 100644
index 0000000..70d6d62
--- /dev/null
+++ b/Mk/gzip.mk
@@ -0,0 +1,4 @@
+FEATURES+=-DWANT_COMPRESSION_GZIP
+#FEATURES+=-DWANT_COMPRESSION_GZIP_ALWAYS
+
+LDFLAGS+=-lz
diff --git a/Mk/proxy.mk b/Mk/proxy.mk
new file mode 100644
index 0000000..2e876e9
--- /dev/null
+++ b/Mk/proxy.mk
@@ -0,0 +1,25 @@
+# The proxy relays sync traffic between trackers and between multicast domains
+# that cannot reach each other. It does not build; see the note at the top of
+# proxy.c. Scheduled for v1.1.0, when these rules come back.
+#
+# LIBOWFAT_HEADERS=$(PREFIX)/libowfat
+# LIBOWFAT_LIBRARY=$(PREFIX)/libowfat
+# CFLAGS_libowfat=-I$(LIBOWFAT_HEADERS)
+# LDFLAGS_libowfat=-L$(LIBOWFAT_LIBRARY) -lowfat
+#
+# SOURCES_proxy=proxy.c ot_batch.c ot_fdstate.c ot_vector.c ot_mutex.c ot_random.c ot_scan.c ot_ip.c ot_socket.c
+# CFLAGS_proxy=$(CFLAGS_production) $(CFLAGS_libowfat) -DWANT_SYNC_LIVE
+# CFLAGS_proxy_debug=$(CFLAGS_debug) $(CFLAGS_libowfat) -DWANT_SYNC_LIVE
+#
+# BINARIES+=proxy proxy.debug
+#
+# proxy: $(SOURCES_proxy) $(HEADERS) $(BUILDDEPS)
+#       $(CC) -o $@ $(CFLAGS_proxy) $(SOURCES_proxy) $(LDFLAGS) $(LDFLAGS_libowfat)
+# proxy.debug: $(SOURCES_proxy) $(HEADERS) $(BUILDDEPS)
+#       $(CC) -o $@ $(CFLAGS_proxy_debug) $(SOURCES_proxy) $(LDFLAGS) $(LDFLAGS_libowfat)
+
+proxy proxy.debug:
+        @echo "$@ is out of service until v1.1.0, see the note at the top of proxy.c"
+        @false
+
+.PHONY: proxy proxy.debug
diff --git a/Mk/release.mk b/Mk/release.mk
new file mode 100644
index 0000000..63429ad
--- /dev/null
+++ b/Mk/release.mk
@@ -0,0 +1,27 @@
+# .tarball-version is what dist wrote into the tarball
+# In a checkout it is absent and git answers instead. A release is always
+# tagged, so in a tarball both of these are that tag, and the gitweb link
+# is to it. Between releases there is no tag and the version is the commit.
+VERSION=1.0.0
+
+TARBALL_VERSION=test -r .tarball-version && read v < .tarball-version && echo "$$v"
+HAVE_GIT=command -v git >/dev/null && test -d .git
+GIT_VERSION=`sh -c '$(TARBALL_VERSION) || { $(HAVE_GIT) && git describe --tags --match "v*" --always --dirty 2>/dev/null; }'`
+OT_TAG=`sh -c '$(TARBALL_VERSION) || { $(HAVE_GIT) && git describe --tags --match "v*" --exact-match 2>/dev/null; }'`
+
+CFLAGS+=-DOT_VERSION=\"$(VERSION)\" -DGIT_VERSION=\"$(GIT_VERSION)\" -DOT_TAG=\"$(OT_TAG)\"
+
+# Roll a release: tag it v$(VERSION), then make dist. The tarball is HEAD by
+# construction, so the working tree it was rolled from does not enter into it.
+DISTNAME=opentracker-$(VERSION)
+
+dist:
+        @test "`git describe --tags --match 'v*' --exact-match 2>/dev/null`" = "v$(VERSION)" || \
+                { echo "HEAD must carry the tag v$(VERSION). Tag the release, or correct VERSION."; exit 1; }
+        rm -rf $(DISTNAME) $(DISTNAME).tar.gz
+        git archive --format=tar --prefix=$(DISTNAME)/ HEAD | tar -xf -
+        git describe --tags --match "v*" --always > $(DISTNAME)/.tarball-version
+        tar -czf $(DISTNAME).tar.gz $(DISTNAME)
+        rm -rf $(DISTNAME)
+
+.PHONY: dist
diff --git a/Mk/tests.mk b/Mk/tests.mk
new file mode 100644
index 0000000..d542044
--- /dev/null
+++ b/Mk/tests.mk
@@ -0,0 +1,72 @@
+BUILDDEPS+=Mk/tests.mk
+
+# The modules under test are compiled straight into the test binary, so a test
+# may reach a static function by including the source. tests/stubs.c supplies
+# the few symbols those modules reference but the tests never reach.
+TESTBIN=tests/runner
+TEST_SOURCES=tests/runner.c tests/test.c tests/stubs.c tests/t_urlencoded.c tests/t_iovec.c tests/t_vector.c tests/t_random.c tests/t_hex.c tests/t_accesslist.c tests/t_scan.c tests/t_buf.c tests/t_ip.c tests/t_socket.c tests/t_mutex.c tests/t_trackerlogic.c tests/t_workqueue.c tests/t_batch.c tests/t_fdstate.c tests/t_event.c tests/t_fmt.c
+TEST_UNITS=ot_urlencoded.c ot_fmt.c ot_event.c ot_batch.c ot_fdstate.c ot_buf.c ot_ip.c ot_socket.c ot_iovec.c ot_vector.c ot_random.c ot_hex.c ot_scan.c ot_accesslist.c ot_mutex.c ot_workqueue.c trackerlogic.c
+TEST_HEADERS=tests/test.h $(HEADERS)
+
+# A test binary is not a production binary, so it is built with the features
+# the tests need to reach.
+FEATURES_test=$(FEATURES) -DWANT_ACCESSLIST_BLACK -DWANT_SYNC_LIVE
+CFLAGS_test=$(CFLAGS) -I. -g -O1 $(FEATURES_test)
+
+# clang over $(CC) because the two toolchains do not check the same things.
+CC_sanitize?=clang
+CFLAGS_sanitize=$(CFLAGS_test) -fsanitize=address,undefined -fno-omit-frame-pointer
+LDFLAGS_sanitize=$(LDFLAGS) -fsanitize=address,undefined
+
+# Black box tests drive the real binary over the wire, so they cover the event
+# loop and the parsers working together. The client timeout is cut right down
+# so a test can reach the expiry sweep; tests/integration/test_expiry.py
+# mirrors these two numbers.
+PYTHON?=python3
+FEATURES_integration=$(FEATURES) -DWANT_IP_FROM_QUERY_STRING -DWANT_ACCESSLIST_BLACK -DWANT_DYNAMIC_ACCESSLIST -DWANT_KEEPALIVE -DOT_CLIENT_TIMEOUT=5 -DOT_CLIENT_TIMEOUT_CHECKINTERVAL=1
+CFLAGS_integration=$(CFLAGS) $(OPTS_debug) $(FEATURES_integration) -fsanitize=address,undefined -fno-omit-frame-pointer
+LDFLAGS_integration=$(LDFLAGS) -fsanitize=address,undefined
+CFLAGS_tsan=$(CFLAGS) $(OPTS_debug) $(FEATURES_integration) -fsanitize=thread -fno-omit-frame-pointer
+LDFLAGS_tsan=$(LDFLAGS) -fsanitize=thread
+
+BINARIES+=$(TESTBIN) $(TESTBIN).poll $(TESTBIN).sanitize opentracker.integration opentracker.tsan
+
+$(TESTBIN): $(TEST_SOURCES) $(TEST_UNITS) $(TEST_HEADERS) $(BUILDDEPS)
+        $(CC) -o $@ $(CFLAGS_test) $(TEST_SOURCES) $(TEST_UNITS)
+
+$(TESTBIN).poll: $(TEST_SOURCES) $(TEST_UNITS) $(TEST_HEADERS) $(BUILDDEPS)
+        $(CC) -o $@ $(CFLAGS_test) -DOT_EVENT_FORCE_POLL $(TEST_SOURCES) $(TEST_UNITS)
+
+$(TESTBIN).sanitize: $(TEST_SOURCES) $(TEST_UNITS) $(TEST_HEADERS) $(BUILDDEPS)
+        $(CC_sanitize) -o $@ $(CFLAGS_sanitize) $(TEST_SOURCES) $(TEST_UNITS) $(LDFLAGS_sanitize)
+
+opentracker.integration: $(SOURCES) $(HEADERS) $(BUILDDEPS)
+        $(CC) -o $@ $(CFLAGS_integration) $(SOURCES) $(LDFLAGS_integration)
+
+opentracker.tsan: $(SOURCES) $(HEADERS) $(BUILDDEPS)
+        $(CC) -o $@ $(CFLAGS_tsan) $(SOURCES) $(LDFLAGS_tsan)
+
+check: $(TESTBIN) $(BINARY)
+        ./$(TESTBIN)
+
+check-poll: $(TESTBIN).poll
+        ./$(TESTBIN).poll ot_event
+
+check-sanitize: $(TESTBIN).sanitize
+        ./$(TESTBIN).sanitize
+
+check-integration: opentracker.integration
+        OPENTRACKER=./opentracker.integration $(PYTHON) -m unittest discover -s tests/integration
+
+check-tsan: opentracker.tsan
+        OPENTRACKER=./opentracker.tsan $(PYTHON) -m unittest discover -s tests/integration
+
+# Cheapest first, so a quick failure comes back quickly.
+check-all:
+        $(MAKE) check
+        $(MAKE) check-poll
+        $(MAKE) check-sanitize
+        $(MAKE) check-integration
+        $(MAKE) check-tsan
+
+.PHONY: check check-poll check-sanitize check-integration check-tsan check-all
diff --git a/Mk/zstd.mk b/Mk/zstd.mk
new file mode 100644
index 0000000..2bb56be
--- /dev/null
+++ b/Mk/zstd.mk
@@ -0,0 +1,3 @@
+FEATURES+=-DWANT_COMPRESSION_ZSTD
+#FEATURES+=-DWANT_COMPRESSION_ZSTD_ALWAYS
+LDFLAGS+=-lzstd