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 # ##########################################################################
18 # default target (when running `make` with no argument)
21 LIBZSTD_MK_DIR = ../lib
22 include $(LIBZSTD_MK_DIR)/libzstd.mk
24 ifeq ($(shell $(CC) -v 2>&1 | $(GREP) -c "gcc version "), 1)
25 ALIGN_LOOP = -falign-loops=32
30 ZSTDLIB_COMMON_SRC := $(sort $(ZSTD_COMMON_FILES))
31 ZSTDLIB_COMPRESS_SRC := $(sort $(ZSTD_COMPRESS_FILES))
32 ZSTDLIB_DECOMPRESS_SRC := $(sort $(ZSTD_DECOMPRESS_FILES))
33 ZSTDLIB_CORE_SRC := $(sort $(ZSTD_DECOMPRESS_FILES) $(ZSTD_COMMON_FILES) $(ZSTD_COMPRESS_FILES))
34 ZDICT_SRC := $(sort $(ZSTD_DICTBUILDER_FILES))
35 ZSTDLEGACY_SRC := $(sort $(ZSTD_LEGACY_FILES))
37 # Sort files in alphabetical order for reproducible builds
38 ZSTDLIB_FULL_SRC = $(sort $(ZSTDLIB_CORE_SRC) $(ZSTDLEGACY_SRC) $(ZDICT_SRC))
39 ZSTDLIB_LOCAL_SRC = $(notdir $(ZSTDLIB_FULL_SRC))
40 ZSTDLIB_LOCAL_OBJ0 := $(ZSTDLIB_LOCAL_SRC:.c=.o)
41 ZSTDLIB_LOCAL_OBJ := $(ZSTDLIB_LOCAL_OBJ0:.S=.o)
43 ZSTD_CLI_SRC := $(sort $(wildcard *.c))
44 ZSTD_CLI_OBJ := $(ZSTD_CLI_SRC:.c=.o)
46 ZSTD_ALL_SRC = $(ZSTDLIB_LOCAL_SRC) $(ZSTD_CLI_SRC)
47 ZSTD_ALL_OBJ0 := $(ZSTD_ALL_SRC:.c=.o)
48 ZSTD_ALL_OBJ := $(ZSTD_ALL_OBJ0:.S=.o)
50 # Define *.exe as extension for Windows systems
51 ifneq (,$(filter Windows%,$(OS)))
53 RES64_FILE = windres/zstd64.res
54 RES32_FILE = windres/zstd32.res
55 ifneq (,$(filter x86_64%,$(shell $(CC) -dumpmachine)))
56 RES_FILE = $(RES64_FILE)
58 RES_FILE = $(RES32_FILE)
65 NO_THREAD_MSG := ==> no threads, building without multithreading support
66 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)
67 HAVE_THREAD := $(shell [ "$(HAVE_PTHREAD)" -eq "1" -o -n "$(filter Windows%,$(OS))" ] && echo 1 || echo 0)
68 ifeq ($(HAVE_THREAD), 1)
69 THREAD_MSG := ==> building with threading support
70 THREAD_CPP := -DZSTD_MULTITHREAD
73 THREAD_MSG := $(NO_THREAD_MSG)
77 NO_ZLIB_MSG := ==> no zlib, building zstd without .gz support
78 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)
79 ifeq ($(HAVE_ZLIB), 1)
80 ZLIB_MSG := ==> building zstd with .gz compression support
81 ZLIBCPP = -DZSTD_GZCOMPRESS -DZSTD_GZDECOMPRESS
84 ZLIB_MSG := $(NO_ZLIB_MSG)
88 NO_LZMA_MSG := ==> no liblzma, building zstd without .xz/.lzma support
89 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)
90 ifeq ($(HAVE_LZMA), 1)
91 LZMA_MSG := ==> building zstd with .xz/.lzma compression support
92 LZMACPP = -DZSTD_LZMACOMPRESS -DZSTD_LZMADECOMPRESS
95 LZMA_MSG := $(NO_LZMA_MSG)
99 NO_LZ4_MSG := ==> no liblz4, building zstd without .lz4 support
100 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)
101 ifeq ($(HAVE_LZ4), 1)
102 LZ4_MSG := ==> building zstd with .lz4 compression support
103 LZ4CPP = -DZSTD_LZ4COMPRESS -DZSTD_LZ4DECOMPRESS
106 LZ4_MSG := $(NO_LZ4_MSG)
109 # explicit backtrace enable/disable for Linux & Darwin
110 ifeq ($(BACKTRACE), 0)
111 DEBUGFLAGS += -DBACKTRACE_ENABLE=0
113 ifeq (,$(filter Windows%, $(OS)))
114 ifeq ($(BACKTRACE), 1)
115 DEBUGFLAGS += -DBACKTRACE_ENABLE=1
116 DEBUGFLAGS_LD += -rdynamic
120 SET_CACHE_DIRECTORY = \
121 +$(MAKE) --no-print-directory $@ \
122 BUILD_DIR=obj/$(HASH_DIR) \
123 CPPFLAGS="$(CPPFLAGS)" \
125 LDFLAGS="$(LDFLAGS)" \
127 ZSTD_ALL_SRC="$(ZSTD_ALL_SRC)"
131 all: zstd zstd-compress zstd-decompress zstd-small
134 allVariants: all zstd-frugal zstd-nolegacy zstd-dictBuilder
136 .PHONY: zstd # must always be run
137 zstd : CPPFLAGS += $(THREAD_CPP) $(ZLIBCPP) $(LZMACPP) $(LZ4CPP)
138 zstd : LDFLAGS += $(THREAD_LD) $(DEBUGFLAGS_LD)
139 zstd : LDLIBS += $(ZLIBLD) $(LZMALD) $(LZ4LD)
140 zstd : CPPFLAGS += -DZSTD_LEGACY_SUPPORT=$(ZSTD_LEGACY_SUPPORT)
141 ifneq (,$(filter Windows%,$(OS)))
146 # generate BUILD_DIR from flags
149 $(SET_CACHE_DIRECTORY)
152 # BUILD_DIR is defined
154 ZSTD_OBJ := $(addprefix $(BUILD_DIR)/, $(ZSTD_ALL_OBJ))
155 $(BUILD_DIR)/zstd : $(ZSTD_OBJ)
156 @echo "$(THREAD_MSG)"
161 $(CC) $(FLAGS) $^ $(LDLIBS) -o $@$(EXT)
163 ifeq ($(HAVE_HASH),1)
164 SRCBIN_HASH = $(shell cat $(BUILD_DIR)/zstd$(EXT) 2> $(VOID) | $(HASH) | cut -f 1 -d " ")
165 DSTBIN_HASH = $(shell cat zstd$(EXT) 2> $(VOID) | $(HASH) | cut -f 1 -d " ")
166 BIN_ISDIFFERENT = $(if $(filter $(SRCBIN_HASH),$(DSTBIN_HASH)),0,1)
171 zstd : $(BUILD_DIR)/zstd
172 if [ $(BIN_ISDIFFERENT) -eq 1 ]; then \
173 cp -f $<$(EXT) $@$(EXT); \
174 echo zstd build completed; \
176 echo zstd already built; \
184 zstd-release: DEBUGFLAGS := -DBACKTRACE_ENABLE=0
185 zstd-release: DEBUGFLAGS_LD :=
189 zstd32 : CPPFLAGS += $(THREAD_CPP)
190 zstd32 : LDFLAGS += $(THREAD_LD)
191 zstd32 : CPPFLAGS += -DZSTD_LEGACY_SUPPORT=$(ZSTD_LEGACY_SUPPORT)
192 ifneq (,$(filter Windows%,$(OS)))
193 zstd32 : $(RES32_FILE)
195 zstd32 : $(ZSTDLIB_FULL_SRC) $(ZSTD_CLI_SRC)
196 $(CC) -m32 $(FLAGS) $^ -o $@$(EXT)
198 ## zstd-nolegacy: same scope as zstd, with removed support of legacy formats
199 CLEAN += zstd-nolegacy
200 zstd-nolegacy : LDFLAGS += $(THREAD_LD) $(ZLIBLD) $(LZMALD) $(LZ4LD) $(DEBUGFLAGS_LD)
201 zstd-nolegacy : CPPFLAGS += -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0
202 zstd-nolegacy : $(ZSTDLIB_CORE_SRC) $(ZDICT_SRC) $(ZSTD_CLI_OBJ)
203 $(CC) $(FLAGS) $^ -o $@$(EXT) $(LDFLAGS)
206 zstd-nomt : THREAD_CPP :=
207 zstd-nomt : THREAD_LD :=
208 zstd-nomt : THREAD_MSG := - multi-threading disabled
212 zstd-nogz : ZLIBCPP :=
213 zstd-nogz : ZLIBLD :=
214 zstd-nogz : ZLIB_MSG := - gzip support is disabled
218 zstd-noxz : LZMACPP :=
219 zstd-noxz : LZMALD :=
220 zstd-noxz : LZMA_MSG := - xz/lzma support is disabled
223 ## zstd-dll: zstd executable linked to dynamic library libzstd (must have same version)
225 zstd-dll : LDFLAGS+= -L$(LIB_BINDIR)
226 zstd-dll : LDLIBS += -lzstd
227 zstd-dll : ZSTDLIB_LOCAL_SRC = xxhash.c pool.c threading.c
231 ## zstd-pgo: zstd executable optimized with PGO.
233 zstd-pgo : LLVM_PROFDATA?=llvm-profdata
234 zstd-pgo : PROF_GENERATE_FLAGS=-fprofile-generate $(if $(findstring gcc,$(CC)),-fprofile-dir=.)
235 zstd-pgo : PROF_USE_FLAGS=-fprofile-use $(if $(findstring gcc,$(CC)),-fprofile-dir=. -Werror=missing-profile -Wno-error=coverage-mismatch)
237 $(MAKE) clean HASH_DIR=$(HASH_DIR)
238 $(MAKE) zstd HASH_DIR=$(HASH_DIR) MOREFLAGS="$(PROF_GENERATE_FLAGS)"
239 ./zstd -b19i1 $(PROFILE_WITH)
240 ./zstd -b16i1 $(PROFILE_WITH)
241 ./zstd -b9i2 $(PROFILE_WITH)
242 ./zstd -b $(PROFILE_WITH)
243 ./zstd -b7i2 $(PROFILE_WITH)
244 ./zstd -b5 $(PROFILE_WITH)
246 $(RM) zstd obj/$(HASH_DIR)/zstd obj/$(HASH_DIR)/*.o
248 $(RM) zstd $(BUILD_DIR)/zstd $(BUILD_DIR)/*.o
250 case $(CC) in *clang*) if ! [ -e default.profdata ]; then $(LLVM_PROFDATA) merge -output=default.profdata default*.profraw; fi ;; esac
251 $(MAKE) zstd HASH_DIR=$(HASH_DIR) MOREFLAGS="$(PROF_USE_FLAGS)"
253 ## zstd-small: minimal target, supporting only zstd compression and decompression. no bench. no legacy. no other format.
254 CLEAN += zstd-small zstd-frugal
255 zstd-small: CFLAGS = -Os -Wl,-s
256 zstd-frugal zstd-small: $(ZSTDLIB_CORE_SRC) zstdcli.c util.c timefn.c fileio.c fileio_asyncio.c
257 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NOTRACE -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0 $^ -o $@$(EXT)
259 CLEAN += zstd-decompress
260 zstd-decompress: $(ZSTDLIB_COMMON_SRC) $(ZSTDLIB_DECOMPRESS_SRC) zstdcli.c util.c timefn.c fileio.c fileio_asyncio.c
261 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NOCOMPRESS -DZSTD_NOTRACE -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0 $^ -o $@$(EXT)
263 CLEAN += zstd-compress
264 zstd-compress: $(ZSTDLIB_COMMON_SRC) $(ZSTDLIB_COMPRESS_SRC) zstdcli.c util.c timefn.c fileio.c fileio_asyncio.c
265 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NODECOMPRESS -DZSTD_NOTRACE -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0 $^ -o $@$(EXT)
267 ## zstd-dictBuilder: executable supporting dictionary creation and compression (only)
268 CLEAN += zstd-dictBuilder
269 zstd-dictBuilder: $(ZSTDLIB_COMMON_SRC) $(ZSTDLIB_COMPRESS_SRC) $(ZDICT_SRC) zstdcli.c util.c timefn.c fileio.c fileio_asyncio.c dibio.c
270 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODECOMPRESS -DZSTD_NOTRACE $^ -o $@$(EXT)
277 generate_res: $(RES64_FILE) $(RES32_FILE)
279 ifneq (,$(filter Windows%,$(OS)))
281 # https://stackoverflow.com/questions/708238/how-do-i-add-an-icon-to-a-mingw-gcc-compiled-executable
282 $(RES64_FILE): windres/zstd.rc
283 $(RC) -o $@ -I ../lib -I windres -i $< -O coff -F pe-x86-64
284 $(RES32_FILE): windres/zstd.rc
285 $(RC) -o $@ -I ../lib -I windres -i $< -O coff -F pe-i386
290 $(RM) $(CLEAN) core *.o tmp* result* dictionary *.zst \
291 *.gcda default*.profraw default.profdata have_zlib
293 @echo Cleaning completed
296 MD2ROFF_FLAGS = --roff --warnings --manual="User Commands" --organization="zstd $(ZSTD_VERSION)"
298 zstd.1: zstd.1.md ../lib/zstd.h
299 cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@
301 zstdgrep.1: zstdgrep.1.md ../lib/zstd.h
302 cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@
304 zstdless.1: zstdless.1.md ../lib/zstd.h
305 cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@
308 man: zstd.1 zstdgrep.1 zstdless.1
317 preview-man: clean-man man
323 # Generate .h dependencies automatically
325 DEPFLAGS = -MT $@ -MMD -MP -MF
327 $(BUILD_DIR)/%.o : %.c $(BUILD_DIR)/%.d | $(BUILD_DIR)
329 $(COMPILE.c) $(DEPFLAGS) $(BUILD_DIR)/$*.d $(OUTPUT_OPTION) $<
331 $(BUILD_DIR)/%.o : %.S | $(BUILD_DIR)
333 $(COMPILE.S) $(OUTPUT_OPTION) $<
336 $(BUILD_DIR): ; $(MKDIR) -p $@
338 DEPFILES := $(ZSTD_OBJ:.o=.d)
341 include $(wildcard $(DEPFILES))
345 #-----------------------------------------------------------------------------
346 # make install is validated only for Linux, macOS, BSD, Hurd and Solaris targets
347 #-----------------------------------------------------------------------------
348 ifneq (,$(filter $(UNAME),Linux Darwin GNU/kFreeBSD GNU OpenBSD FreeBSD NetBSD DragonFly SunOS Haiku AIX MSYS_NT CYGWIN_NT))
350 HAVE_COLORNEVER = $(shell echo a | egrep --color=never a > /dev/null 2> /dev/null && echo 1 || echo 0)
352 ifeq ($(HAVE_COLORNEVER), 1)
353 EGREP_OPTIONS += --color=never
355 EGREP = egrep $(EGREP_OPTIONS)
358 # Print a two column output of targets and their description. To add a target description, put a
359 # comment in the Makefile with the format "## <TARGET>: <DESCRIPTION>". For example:
361 ## list: Print all targets and their descriptions (if provided)
364 TARGETS=$$($(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null \
365 | $(AWK) -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' \
366 | $(EGREP) -v -e '^[^[:alnum:]]' | sort); \
368 printf "Target Name\tDescription\n"; \
369 printf "%0.s-" {1..16}; printf "\t"; printf "%0.s-" {1..40}; printf "\n"; \
370 for target in $$TARGETS; do \
371 line=$$($(EGREP) "^##[[:space:]]+$$target:" $(lastword $(MAKEFILE_LIST))); \
372 description=$$(echo $$line | $(AWK) '{i=index($$0,":"); print substr($$0,i+1)}' | xargs); \
373 printf "$$target\t$$description\n"; \
375 } | column -t -s $$'\t'
379 # directory variables : GNU conventions prefer lowercase
380 # see https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html
381 # support both lower and uppercase (BSD), use uppercase in script
384 exec_prefix ?= $(PREFIX)
385 bindir ?= $(exec_prefix)/bin
387 datarootdir ?= $(PREFIX)/share
388 mandir ?= $(datarootdir)/man
389 man1dir ?= $(mandir)/man1
391 ifneq (,$(filter $(UNAME),OpenBSD FreeBSD NetBSD DragonFly SunOS))
392 MANDIR ?= $(PREFIX)/man
393 MAN1DIR ?= $(MANDIR)/man1
395 MAN1DIR ?= $(man1dir)
398 ifneq (,$(filter $(UNAME),SunOS))
404 INSTALL_PROGRAM ?= $(INSTALL)
405 INSTALL_SCRIPT ?= $(INSTALL_PROGRAM)
406 INSTALL_DATA ?= $(INSTALL) -m 644
407 INSTALL_MAN ?= $(INSTALL_DATA)
411 # generate zstd only if not already present
412 [ -e zstd ] || $(MAKE) zstd-release
413 [ -e $(DESTDIR)$(BINDIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(BINDIR)/
414 [ -e $(DESTDIR)$(MAN1DIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(MAN1DIR)/
415 @echo Installing binaries
416 $(INSTALL_PROGRAM) zstd$(EXT) $(DESTDIR)$(BINDIR)/zstd$(EXT)
417 ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/zstdcat$(EXT)
418 ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/unzstd$(EXT)
419 ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/zstdmt$(EXT)
420 $(INSTALL_SCRIPT) zstdless $(DESTDIR)$(BINDIR)/zstdless
421 $(INSTALL_SCRIPT) zstdgrep $(DESTDIR)$(BINDIR)/zstdgrep
422 @echo Installing man pages
423 $(INSTALL_MAN) zstd.1 $(DESTDIR)$(MAN1DIR)/zstd.1
424 ln -sf zstd.1 $(DESTDIR)$(MAN1DIR)/zstdcat.1
425 ln -sf zstd.1 $(DESTDIR)$(MAN1DIR)/unzstd.1
426 $(INSTALL_MAN) zstdgrep.1 $(DESTDIR)$(MAN1DIR)/zstdgrep.1
427 $(INSTALL_MAN) zstdless.1 $(DESTDIR)$(MAN1DIR)/zstdless.1
428 @echo zstd installation completed
432 $(RM) $(DESTDIR)$(BINDIR)/zstdgrep
433 $(RM) $(DESTDIR)$(BINDIR)/zstdless
434 $(RM) $(DESTDIR)$(BINDIR)/zstdcat
435 $(RM) $(DESTDIR)$(BINDIR)/unzstd
436 $(RM) $(DESTDIR)$(BINDIR)/zstdmt
437 $(RM) $(DESTDIR)$(BINDIR)/zstd
438 $(RM) $(DESTDIR)$(MAN1DIR)/zstdless.1
439 $(RM) $(DESTDIR)$(MAN1DIR)/zstdgrep.1
440 $(RM) $(DESTDIR)$(MAN1DIR)/zstdcat.1
441 $(RM) $(DESTDIR)$(MAN1DIR)/unzstd.1
442 $(RM) $(DESTDIR)$(MAN1DIR)/zstd.1
443 @echo zstd programs successfully uninstalled