1 # ################################################################
2 # Copyright (c) Meta Platforms, Inc. and affiliates.
5 # This source code is licensed under both the BSD-style license (found in the
6 # LICENSE file in the root directory of this source tree) and the GPLv2 (found
7 # in the COPYING file in the root directory of this source tree).
8 # You may select, at your option, one of the above-listed licenses.
9 # ##########################################################################
10 # zstd : Command Line Utility, supporting gzip-like arguments
11 # zstd32 : Same as zstd, but forced to compile in 32-bits mode
12 # zstd-nolegacy : zstd without support of decompression of legacy versions
13 # zstd-small : minimal zstd without dictionary builder and benchmark
14 # zstd-compress : compressor-only version of zstd
15 # zstd-decompress : decompressor-only version of zstd
16 # ##########################################################################
23 include $(LIBZSTD)/libzstd.mk
25 ifeq ($(shell $(CC) -v 2>&1 | $(GREP) -c "gcc version "), 1)
26 ALIGN_LOOP = -falign-loops=32
31 ZSTDLIB_COMMON_SRC := $(sort $(ZSTD_COMMON_FILES))
32 ZSTDLIB_COMPRESS_SRC := $(sort $(ZSTD_COMPRESS_FILES))
33 ZSTDLIB_DECOMPRESS_SRC := $(sort $(ZSTD_DECOMPRESS_FILES))
34 ZSTDLIB_CORE_SRC := $(sort $(ZSTD_DECOMPRESS_FILES) $(ZSTD_COMMON_FILES) $(ZSTD_COMPRESS_FILES))
35 ZDICT_SRC := $(sort $(ZSTD_DICTBUILDER_FILES))
36 ZSTDLEGACY_SRC := $(sort $(ZSTD_LEGACY_FILES))
38 # Sort files in alphabetical order for reproducible builds
39 ZSTDLIB_FULL_SRC = $(sort $(ZSTDLIB_CORE_SRC) $(ZSTDLEGACY_SRC) $(ZDICT_SRC))
40 ZSTDLIB_LOCAL_SRC = $(notdir $(ZSTDLIB_FULL_SRC))
41 ZSTDLIB_LOCAL_OBJ0 := $(ZSTDLIB_LOCAL_SRC:.c=.o)
42 ZSTDLIB_LOCAL_OBJ := $(ZSTDLIB_LOCAL_OBJ0:.S=.o)
44 ZSTD_CLI_SRC := $(sort $(wildcard *.c))
45 ZSTD_CLI_OBJ := $(ZSTD_CLI_SRC:.c=.o)
47 ZSTD_ALL_SRC = $(ZSTDLIB_LOCAL_SRC) $(ZSTD_CLI_SRC)
48 ZSTD_ALL_OBJ0 := $(ZSTD_ALL_SRC:.c=.o)
49 ZSTD_ALL_OBJ := $(ZSTD_ALL_OBJ0:.S=.o)
51 # Define *.exe as extension for Windows systems
52 ifneq (,$(filter Windows%,$(OS)))
54 RES64_FILE = windres/zstd64.res
55 RES32_FILE = windres/zstd32.res
56 ifneq (,$(filter x86_64%,$(shell $(CC) -dumpmachine)))
57 RES_FILE = $(RES64_FILE)
59 RES_FILE = $(RES32_FILE)
66 NO_THREAD_MSG := ==> no threads, building without multithreading support
67 HAVE_PTHREAD := $(shell printf '$(NUM_SYMBOL)include <pthread.h>\nint main(void) { return 0; }' > have_pthread.c && $(CC) $(FLAGS) -o have_pthread$(EXT) have_pthread.c -pthread 2> $(VOID) && rm have_pthread$(EXT) && echo 1 || echo 0; rm have_pthread.c)
68 HAVE_THREAD := $(shell [ "$(HAVE_PTHREAD)" -eq "1" -o -n "$(filter Windows%,$(OS))" ] && echo 1 || echo 0)
69 ifeq ($(HAVE_THREAD), 1)
70 THREAD_MSG := ==> building with threading support
71 THREAD_CPP := -DZSTD_MULTITHREAD
74 THREAD_MSG := $(NO_THREAD_MSG)
78 NO_ZLIB_MSG := ==> no zlib, building zstd without .gz support
79 HAVE_ZLIB ?= $(shell printf '$(NUM_SYMBOL)include <zlib.h>\nint main(void) { return 0; }' > have_zlib.c && $(CC) $(FLAGS) -o have_zlib$(EXT) have_zlib.c -lz 2> $(VOID) && rm have_zlib$(EXT) && echo 1 || echo 0; rm have_zlib.c)
80 ifeq ($(HAVE_ZLIB), 1)
81 ZLIB_MSG := ==> building zstd with .gz compression support
82 ZLIBCPP = -DZSTD_GZCOMPRESS -DZSTD_GZDECOMPRESS
85 ZLIB_MSG := $(NO_ZLIB_MSG)
89 NO_LZMA_MSG := ==> no liblzma, building zstd without .xz/.lzma support
90 HAVE_LZMA ?= $(shell printf '$(NUM_SYMBOL)include <lzma.h>\nint main(void) { return 0; }' > have_lzma.c && $(CC) $(FLAGS) -o have_lzma$(EXT) have_lzma.c -llzma 2> $(VOID) && rm have_lzma$(EXT) && echo 1 || echo 0; rm have_lzma.c)
91 ifeq ($(HAVE_LZMA), 1)
92 LZMA_MSG := ==> building zstd with .xz/.lzma compression support
93 LZMACPP = -DZSTD_LZMACOMPRESS -DZSTD_LZMADECOMPRESS
96 LZMA_MSG := $(NO_LZMA_MSG)
100 NO_LZ4_MSG := ==> no liblz4, building zstd without .lz4 support
101 HAVE_LZ4 ?= $(shell printf '$(NUM_SYMBOL)include <lz4frame.h>\n$(NUM_SYMBOL)include <lz4.h>\nint main(void) { return 0; }' > have_lz4.c && $(CC) $(FLAGS) -o have_lz4$(EXT) have_lz4.c -llz4 2> $(VOID) && rm have_lz4$(EXT) && echo 1 || echo 0; rm have_lz4.c)
102 ifeq ($(HAVE_LZ4), 1)
103 LZ4_MSG := ==> building zstd with .lz4 compression support
104 LZ4CPP = -DZSTD_LZ4COMPRESS -DZSTD_LZ4DECOMPRESS
107 LZ4_MSG := $(NO_LZ4_MSG)
110 # explicit backtrace enable/disable for Linux & Darwin
111 ifeq ($(BACKTRACE), 0)
112 DEBUGFLAGS += -DBACKTRACE_ENABLE=0
114 ifeq (,$(filter Windows%, $(OS)))
115 ifeq ($(BACKTRACE), 1)
116 DEBUGFLAGS += -DBACKTRACE_ENABLE=1
117 DEBUGFLAGS_LD += -rdynamic
121 SET_CACHE_DIRECTORY = \
122 +$(MAKE) --no-print-directory $@ \
123 BUILD_DIR=obj/$(HASH_DIR) \
124 CPPFLAGS="$(CPPFLAGS)" \
126 LDFLAGS="$(LDFLAGS)" \
128 ZSTD_ALL_SRC="$(ZSTD_ALL_SRC)"
132 all: zstd zstd-compress zstd-decompress zstd-small
135 allVariants: all zstd-frugal zstd-nolegacy zstd-dictBuilder
137 .PHONY: zstd # must always be run
138 zstd : CPPFLAGS += $(THREAD_CPP) $(ZLIBCPP) $(LZMACPP) $(LZ4CPP)
139 zstd : LDFLAGS += $(THREAD_LD) $(DEBUGFLAGS_LD)
140 zstd : LDLIBS += $(ZLIBLD) $(LZMALD) $(LZ4LD)
141 zstd : CPPFLAGS += -DZSTD_LEGACY_SUPPORT=$(ZSTD_LEGACY_SUPPORT)
142 ifneq (,$(filter Windows%,$(OS)))
147 # generate BUILD_DIR from flags
150 $(SET_CACHE_DIRECTORY)
153 # BUILD_DIR is defined
155 ZSTD_OBJ := $(addprefix $(BUILD_DIR)/, $(ZSTD_ALL_OBJ))
156 $(BUILD_DIR)/zstd : $(ZSTD_OBJ)
157 @echo "$(THREAD_MSG)"
162 $(CC) $(FLAGS) $^ $(LDLIBS) -o $@$(EXT)
164 ifeq ($(HAVE_HASH),1)
165 SRCBIN_HASH = $(shell cat $(BUILD_DIR)/zstd$(EXT) 2> $(VOID) | $(HASH) | cut -f 1 -d " ")
166 DSTBIN_HASH = $(shell cat zstd$(EXT) 2> $(VOID) | $(HASH) | cut -f 1 -d " ")
167 BIN_ISDIFFERENT = $(if $(filter $(SRCBIN_HASH),$(DSTBIN_HASH)),0,1)
172 zstd : $(BUILD_DIR)/zstd
173 if [ $(BIN_ISDIFFERENT) -eq 1 ]; then \
174 cp -f $<$(EXT) $@$(EXT); \
175 echo zstd build completed; \
177 echo zstd already built; \
185 zstd-release: DEBUGFLAGS := -DBACKTRACE_ENABLE=0
186 zstd-release: DEBUGFLAGS_LD :=
190 zstd32 : CPPFLAGS += $(THREAD_CPP)
191 zstd32 : LDFLAGS += $(THREAD_LD)
192 zstd32 : CPPFLAGS += -DZSTD_LEGACY_SUPPORT=$(ZSTD_LEGACY_SUPPORT)
193 ifneq (,$(filter Windows%,$(OS)))
194 zstd32 : $(RES32_FILE)
196 zstd32 : $(ZSTDLIB_FULL_SRC) $(ZSTD_CLI_SRC)
197 $(CC) -m32 $(FLAGS) $^ -o $@$(EXT)
199 ## zstd-nolegacy: same scope as zstd, with removed support of legacy formats
200 CLEAN += zstd-nolegacy
201 zstd-nolegacy : LDFLAGS += $(THREAD_LD) $(ZLIBLD) $(LZMALD) $(LZ4LD) $(DEBUGFLAGS_LD)
202 zstd-nolegacy : CPPFLAGS += -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0
203 zstd-nolegacy : $(ZSTDLIB_CORE_SRC) $(ZDICT_SRC) $(ZSTD_CLI_OBJ)
204 $(CC) $(FLAGS) $^ -o $@$(EXT) $(LDFLAGS)
207 zstd-nomt : THREAD_CPP :=
208 zstd-nomt : THREAD_LD :=
209 zstd-nomt : THREAD_MSG := - multi-threading disabled
213 zstd-nogz : ZLIBCPP :=
214 zstd-nogz : ZLIBLD :=
215 zstd-nogz : ZLIB_MSG := - gzip support is disabled
219 zstd-noxz : LZMACPP :=
220 zstd-noxz : LZMALD :=
221 zstd-noxz : LZMA_MSG := - xz/lzma support is disabled
224 ## zstd-dll: zstd executable linked to dynamic library libzstd (must have same version)
226 zstd-dll : LDFLAGS+= -L$(LIBZSTD)
227 zstd-dll : LDLIBS += -lzstd
228 zstd-dll : ZSTDLIB_LOCAL_SRC = xxhash.c pool.c threading.c
232 ## zstd-pgo: zstd executable optimized with PGO.
234 zstd-pgo : LLVM_PROFDATA?=llvm-profdata
235 zstd-pgo : PROF_GENERATE_FLAGS=-fprofile-generate $(if $(findstring gcc,$(CC)),-fprofile-dir=.)
236 zstd-pgo : PROF_USE_FLAGS=-fprofile-use $(if $(findstring gcc,$(CC)),-fprofile-dir=. -Werror=missing-profile -Wno-error=coverage-mismatch)
238 $(MAKE) clean HASH_DIR=$(HASH_DIR)
239 $(MAKE) zstd HASH_DIR=$(HASH_DIR) MOREFLAGS="$(PROF_GENERATE_FLAGS)"
240 ./zstd -b19i1 $(PROFILE_WITH)
241 ./zstd -b16i1 $(PROFILE_WITH)
242 ./zstd -b9i2 $(PROFILE_WITH)
243 ./zstd -b $(PROFILE_WITH)
244 ./zstd -b7i2 $(PROFILE_WITH)
245 ./zstd -b5 $(PROFILE_WITH)
247 $(RM) zstd obj/$(HASH_DIR)/zstd obj/$(HASH_DIR)/*.o
249 $(RM) zstd $(BUILD_DIR)/zstd $(BUILD_DIR)/*.o
251 case $(CC) in *clang*) if ! [ -e default.profdata ]; then $(LLVM_PROFDATA) merge -output=default.profdata default*.profraw; fi ;; esac
252 $(MAKE) zstd HASH_DIR=$(HASH_DIR) MOREFLAGS="$(PROF_USE_FLAGS)"
254 ## zstd-small: minimal target, supporting only zstd compression and decompression. no bench. no legacy. no other format.
255 CLEAN += zstd-small zstd-frugal
256 zstd-small: CFLAGS = -Os -Wl,-s
257 zstd-frugal zstd-small: $(ZSTDLIB_CORE_SRC) zstdcli.c util.c timefn.c fileio.c fileio_asyncio.c
258 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NOTRACE -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0 $^ -o $@$(EXT)
260 CLEAN += zstd-decompress
261 zstd-decompress: $(ZSTDLIB_COMMON_SRC) $(ZSTDLIB_DECOMPRESS_SRC) zstdcli.c util.c timefn.c fileio.c fileio_asyncio.c
262 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NOCOMPRESS -DZSTD_NOTRACE -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0 $^ -o $@$(EXT)
264 CLEAN += zstd-compress
265 zstd-compress: $(ZSTDLIB_COMMON_SRC) $(ZSTDLIB_COMPRESS_SRC) zstdcli.c util.c timefn.c fileio.c fileio_asyncio.c
266 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NODECOMPRESS -DZSTD_NOTRACE -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0 $^ -o $@$(EXT)
268 ## zstd-dictBuilder: executable supporting dictionary creation and compression (only)
269 CLEAN += zstd-dictBuilder
270 zstd-dictBuilder: $(ZSTDLIB_COMMON_SRC) $(ZSTDLIB_COMPRESS_SRC) $(ZDICT_SRC) zstdcli.c util.c timefn.c fileio.c fileio_asyncio.c dibio.c
271 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODECOMPRESS -DZSTD_NOTRACE $^ -o $@$(EXT)
278 generate_res: $(RES64_FILE) $(RES32_FILE)
280 ifneq (,$(filter Windows%,$(OS)))
282 # https://stackoverflow.com/questions/708238/how-do-i-add-an-icon-to-a-mingw-gcc-compiled-executable
283 $(RES64_FILE): windres/zstd.rc
284 $(RC) -o $@ -I ../lib -I windres -i $< -O coff -F pe-x86-64
285 $(RES32_FILE): windres/zstd.rc
286 $(RC) -o $@ -I ../lib -I windres -i $< -O coff -F pe-i386
291 $(RM) $(CLEAN) core *.o tmp* result* dictionary *.zst \
292 *.gcda default*.profraw default.profdata have_zlib
294 @echo Cleaning completed
297 MD2ROFF_FLAGS = --roff --warnings --manual="User Commands" --organization="zstd $(ZSTD_VERSION)"
299 zstd.1: zstd.1.md ../lib/zstd.h
300 cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@
302 zstdgrep.1: zstdgrep.1.md ../lib/zstd.h
303 cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@
305 zstdless.1: zstdless.1.md ../lib/zstd.h
306 cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@
309 man: zstd.1 zstdgrep.1 zstdless.1
318 preview-man: clean-man man
324 # Generate .h dependencies automatically
326 DEPFLAGS = -MT $@ -MMD -MP -MF
328 $(BUILD_DIR)/%.o : %.c $(BUILD_DIR)/%.d | $(BUILD_DIR)
330 $(COMPILE.c) $(DEPFLAGS) $(BUILD_DIR)/$*.d $(OUTPUT_OPTION) $<
332 $(BUILD_DIR)/%.o : %.S | $(BUILD_DIR)
334 $(COMPILE.S) $(OUTPUT_OPTION) $<
337 $(BUILD_DIR): ; $(MKDIR) -p $@
339 DEPFILES := $(ZSTD_OBJ:.o=.d)
342 include $(wildcard $(DEPFILES))
346 #-----------------------------------------------------------------------------
347 # make install is validated only for Linux, macOS, BSD, Hurd and Solaris targets
348 #-----------------------------------------------------------------------------
349 ifneq (,$(filter $(UNAME),Linux Darwin GNU/kFreeBSD GNU OpenBSD FreeBSD NetBSD DragonFly SunOS Haiku AIX))
351 HAVE_COLORNEVER = $(shell echo a | egrep --color=never a > /dev/null 2> /dev/null && echo 1 || echo 0)
353 ifeq ($(HAVE_COLORNEVER), 1)
354 EGREP_OPTIONS += --color=never
356 EGREP = egrep $(EGREP_OPTIONS)
359 # Print a two column output of targets and their description. To add a target description, put a
360 # comment in the Makefile with the format "## <TARGET>: <DESCRIPTION>". For example:
362 ## list: Print all targets and their descriptions (if provided)
365 TARGETS=$$($(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null \
366 | $(AWK) -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' \
367 | $(EGREP) -v -e '^[^[:alnum:]]' | sort); \
369 printf "Target Name\tDescription\n"; \
370 printf "%0.s-" {1..16}; printf "\t"; printf "%0.s-" {1..40}; printf "\n"; \
371 for target in $$TARGETS; do \
372 line=$$($(EGREP) "^##[[:space:]]+$$target:" $(lastword $(MAKEFILE_LIST))); \
373 description=$$(echo $$line | $(AWK) '{i=index($$0,":"); print substr($$0,i+1)}' | xargs); \
374 printf "$$target\t$$description\n"; \
376 } | column -t -s $$'\t'
380 # directory variables : GNU conventions prefer lowercase
381 # see https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html
382 # support both lower and uppercase (BSD), use uppercase in script
385 exec_prefix ?= $(PREFIX)
386 bindir ?= $(exec_prefix)/bin
388 datarootdir ?= $(PREFIX)/share
389 mandir ?= $(datarootdir)/man
390 man1dir ?= $(mandir)/man1
392 ifneq (,$(filter $(UNAME),OpenBSD FreeBSD NetBSD DragonFly SunOS))
393 MANDIR ?= $(PREFIX)/man
394 MAN1DIR ?= $(MANDIR)/man1
396 MAN1DIR ?= $(man1dir)
399 ifneq (,$(filter $(UNAME),SunOS))
405 INSTALL_PROGRAM ?= $(INSTALL)
406 INSTALL_SCRIPT ?= $(INSTALL_PROGRAM)
407 INSTALL_DATA ?= $(INSTALL) -m 644
408 INSTALL_MAN ?= $(INSTALL_DATA)
412 # generate zstd only if not already present
413 [ -e zstd ] || $(MAKE) zstd-release
414 [ -e $(DESTDIR)$(BINDIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(BINDIR)/
415 [ -e $(DESTDIR)$(MAN1DIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(MAN1DIR)/
416 @echo Installing binaries
417 $(INSTALL_PROGRAM) zstd$(EXT) $(DESTDIR)$(BINDIR)/zstd$(EXT)
418 ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/zstdcat$(EXT)
419 ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/unzstd$(EXT)
420 ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/zstdmt$(EXT)
421 $(INSTALL_SCRIPT) zstdless $(DESTDIR)$(BINDIR)/zstdless
422 $(INSTALL_SCRIPT) zstdgrep $(DESTDIR)$(BINDIR)/zstdgrep
423 @echo Installing man pages
424 $(INSTALL_MAN) zstd.1 $(DESTDIR)$(MAN1DIR)/zstd.1
425 ln -sf zstd.1 $(DESTDIR)$(MAN1DIR)/zstdcat.1
426 ln -sf zstd.1 $(DESTDIR)$(MAN1DIR)/unzstd.1
427 $(INSTALL_MAN) zstdgrep.1 $(DESTDIR)$(MAN1DIR)/zstdgrep.1
428 $(INSTALL_MAN) zstdless.1 $(DESTDIR)$(MAN1DIR)/zstdless.1
429 @echo zstd installation completed
433 $(RM) $(DESTDIR)$(BINDIR)/zstdgrep
434 $(RM) $(DESTDIR)$(BINDIR)/zstdless
435 $(RM) $(DESTDIR)$(BINDIR)/zstdcat
436 $(RM) $(DESTDIR)$(BINDIR)/unzstd
437 $(RM) $(DESTDIR)$(BINDIR)/zstdmt
438 $(RM) $(DESTDIR)$(BINDIR)/zstd
439 $(RM) $(DESTDIR)$(MAN1DIR)/zstdless.1
440 $(RM) $(DESTDIR)$(MAN1DIR)/zstdgrep.1
441 $(RM) $(DESTDIR)$(MAN1DIR)/zstdcat.1
442 $(RM) $(DESTDIR)$(MAN1DIR)/unzstd.1
443 $(RM) $(DESTDIR)$(MAN1DIR)/zstd.1
444 @echo zstd programs successfully uninstalled