SHELL := /bin/bash
.DEFAULT_GOAL := help
CARGO ?= cargo
DOCKER ?= docker
DIST ?= dist
VERSION := $(shell sed -n 's/^version = "\(.*\)"/\1/p' Cargo.toml | head -1)
LZ4_FEATURE := --features liblz4
VARIANTS := glibc-amd64 glibc-arm64 musl-amd64 musl-arm64
.PHONY: help
help:
@echo "lzvolt $(VERSION)"
@echo
@grep -hE '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \
| sort \
| awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-22s\033[0m %s\n", $$1, $$2}'
@echo
@echo " Release binaries land in $(DIST)/."
.PHONY: build
build:
$(CARGO) build
.PHONY: release
release:
$(CARGO) build --release
.PHONY: no-asm
no-asm:
$(CARGO) build --release --no-default-features
.PHONY: test
test:
$(CARGO) test --release $(LZ4_FEATURE)
$(CARGO) test --release --no-default-features
.PHONY: test-fast
test-fast:
$(CARGO) test
.PHONY: miri
miri:
MIRIFLAGS="-Zmiri-disable-isolation" \
$(CARGO) +nightly miri test --no-default-features --lib format
.PHONY: miri-full
miri-full:
MIRIFLAGS="-Zmiri-disable-isolation -Zmiri-ignore-leaks" \
LZVOLT_MIRI_FULL=1 \
$(CARGO) +nightly miri test --no-default-features --lib format -- --nocapture
.PHONY: sanitize
sanitize: asan ub-checks
.PHONY: asan
asan:
RUSTFLAGS="-Zsanitizer=address" \
$(CARGO) +nightly test --release --target $(shell rustc -vV | sed -n 's/host: //p') --lib
.PHONY: ub-checks
ub-checks:
RUSTFLAGS="-Zub-checks -Cdebug-assertions=on" \
$(CARGO) +nightly test --release --target $(shell rustc -vV | sed -n 's/host: //p') --lib
.PHONY: soak
soak:
$(CARGO) run --release $(LZ4_FEATURE) --example soak
.PHONY: c-example
c-example: release
@mkdir -p $(DIST)
$(CC) -O2 -Wall -Wextra -Werror -Iinclude \
examples/capi.c target/release/liblzvolt.a \
-o $(DIST)/capi $(shell [ "$$(uname)" = Darwin ] || echo -lpthread -ldl -lm)
@echo
@$(DIST)/capi
.PHONY: header-check
header-check:
@echo '#include "lzvolt.h"' > /tmp/lzvolt_hdr.c
@echo 'int main(void){return 0;}' >> /tmp/lzvolt_hdr.c
$(CC) -std=c99 -Wall -Wextra -Werror -Iinclude -fsyntax-only /tmp/lzvolt_hdr.c
@cp /tmp/lzvolt_hdr.c /tmp/lzvolt_hdr.cpp
$(CXX) -std=c++17 -Wall -Wextra -Werror -Iinclude -fsyntax-only /tmp/lzvolt_hdr.cpp
@echo " header is clean as C99 and C++17"
.PHONY: fmt
fmt:
$(CARGO) fmt
.PHONY: fmt-check
fmt-check:
$(CARGO) fmt --check
.PHONY: clippy
clippy:
$(CARGO) clippy --all-targets --release $(LZ4_FEATURE) -- -D warnings
$(CARGO) clippy --all-targets --release --no-default-features -- -D warnings
.PHONY: doc
doc:
RUSTDOCFLAGS="-D warnings" $(CARGO) doc --no-deps
.PHONY: lint-workflows
lint-workflows:
@if command -v actionlint > /dev/null; then \
actionlint && echo " workflows are valid"; \
else \
echo " actionlint not installed, skipping."; \
echo " A workflow can be valid YAML and invalid Actions schema --"; \
echo " `secrets` in a job-level `if` cost one silent release. Install it:"; \
echo " brew install actionlint"; \
fi
.PHONY: check
check: fmt-check clippy doc test header-check c-example lint-workflows
@echo
@echo " all checks passed"
.PHONY: quick
quick:
$(CARGO) run --release $(LZ4_FEATURE) --example quick
.PHONY: quick-save
quick-save:
$(CARGO) run --release $(LZ4_FEATURE) --example quick -- --save
.PHONY: bench
bench:
$(CARGO) bench $(LZ4_FEATURE)
.PHONY: vectors
vectors:
$(CARGO) run --release --example make_vectors
PREFIX ?= /usr/local
DESTDIR ?=
ifeq ($(shell uname),Darwin)
SHARED_NAME := liblzvolt.dylib
PRIVATE_LIBS :=
else
SHARED_NAME := liblzvolt.so
PRIVATE_LIBS := -lpthread -ldl -lm
endif
.PHONY: packaging
packaging:
@mkdir -p $(DIST)
@for f in lzvolt.pc lzvolt-config.cmake lzvolt-config-version.cmake; do \
sed -e 's|@PREFIX@|$(PREFIX)|g' \
-e 's|@VERSION@|$(VERSION)|g' \
-e 's|@SHARED_NAME@|$(SHARED_NAME)|g' \
-e 's|@PRIVATE_LIBS@|$(PRIVATE_LIBS)|g' \
packaging/$$f.in > $(DIST)/$$f; \
echo " $(DIST)/$$f"; \
done
.PHONY: install
install: release packaging
install -d $(DESTDIR)$(PREFIX)/lib $(DESTDIR)$(PREFIX)/include \
$(DESTDIR)$(PREFIX)/lib/pkgconfig \
$(DESTDIR)$(PREFIX)/lib/cmake/lzvolt
install -m 644 target/release/liblzvolt.a $(DESTDIR)$(PREFIX)/lib/
install -m 755 target/release/$(SHARED_NAME) $(DESTDIR)$(PREFIX)/lib/
install -m 644 include/lzvolt.h $(DESTDIR)$(PREFIX)/include/
install -m 644 $(DIST)/lzvolt.pc $(DESTDIR)$(PREFIX)/lib/pkgconfig/
install -m 644 $(DIST)/lzvolt-config.cmake \
$(DIST)/lzvolt-config-version.cmake \
$(DESTDIR)$(PREFIX)/lib/cmake/lzvolt/
@echo
@echo " installed under $(DESTDIR)$(PREFIX)"
@echo " pkg-config --cflags --libs lzvolt"
@echo " find_package(lzvolt $(VERSION) REQUIRED)"
.PHONY: uninstall
uninstall:
rm -f $(DESTDIR)$(PREFIX)/lib/liblzvolt.a \
$(DESTDIR)$(PREFIX)/lib/$(SHARED_NAME) \
$(DESTDIR)$(PREFIX)/include/lzvolt.h \
$(DESTDIR)$(PREFIX)/lib/pkgconfig/lzvolt.pc
rm -rf $(DESTDIR)$(PREFIX)/lib/cmake/lzvolt
.PHONY: docker-build-all
docker-build-all: $(addprefix docker-build-,$(VARIANTS))
@echo
@ls -la $(DIST)/
.PHONY: docker-build-%
docker-build-%:
@set -e; \
variant='$*'; \
libc=$${variant%%-*}; arch=$${variant##*-}; \
case "$$arch" in \
amd64) triple=x86_64; platform=linux/amd64 ;; \
arm64) triple=aarch64; platform=linux/arm64 ;; \
*) echo "unknown architecture: $$arch" >&2; exit 1 ;; \
esac; \
case "$$libc" in \
glibc) target=$$triple-unknown-linux-gnu; file=docker/Dockerfile.glibc ;; \
musl) target=$$triple-unknown-linux-musl; file=docker/Dockerfile.musl ;; \
*) echo "unknown libc: $$libc" >&2; exit 1 ;; \
esac; \
mkdir -p $(DIST); \
echo "==> $$libc-$$arch ($$target)"; \
out=$(DIST)/.export-$$libc-$$arch; rm -rf $$out; \
$(DOCKER) build --platform $$platform -f $$file \
--build-arg TARGET=$$target --output type=local,dest=$$out .; \
mv $$out/liblzvolt.a $(DIST)/liblzvolt-$$libc-$$arch.a; \
if [ -f $$out/liblzvolt.so ]; then \
mv $$out/liblzvolt.so $(DIST)/liblzvolt-$$libc-$$arch.so; \
else \
echo " (no shared object for this target; the archive is the artifact)"; \
fi; \
rm -rf $$out
.PHONY: checksums
checksums:
@cd $(DIST) && { command -v sha256sum > /dev/null \
&& sha256sum liblzvolt-* lzvolt.h lzvolt.pc lzvolt-config*.cmake \
|| shasum -a 256 liblzvolt-* lzvolt.h lzvolt.pc lzvolt-config*.cmake; } \
> SHA256SUMS && cat SHA256SUMS
.PHONY: dist
dist: docker-build-all packaging
@cp include/lzvolt.h $(DIST)/
@$(MAKE) --no-print-directory checksums
.PHONY: changelog
changelog:
git cliff --output CHANGELOG.md
.PHONY: publish-dry
publish-dry:
$(CARGO) publish --dry-run --allow-dirty
.PHONY: clean
clean:
$(CARGO) clean
rm -rf $(DIST)
.PHONY: version
version:
@echo $(VERSION)