1# ################################################################ 2# Copyright (c) Yann Collet, Facebook, Inc. 3# All rights reserved. 4# 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# ########################################################################## 17 18.PHONY: default 19default: zstd-release 20 21LIBZSTD := ../lib 22 23include $(LIBZSTD)/libzstd.mk 24 25ifeq ($(shell $(CC) -v 2>&1 | $(GREP) -c "gcc version "), 1) 26 ALIGN_LOOP = -falign-loops=32 27else 28 ALIGN_LOOP = 29endif 30 31ZSTDLIB_COMMON_SRC := $(sort $(ZSTD_COMMON_FILES)) 32ZSTDLIB_COMPRESS_SRC := $(sort $(ZSTD_COMPRESS_FILES)) 33ZSTDLIB_DECOMPRESS_SRC := $(sort $(ZSTD_DECOMPRESS_FILES)) 34ZSTDLIB_CORE_SRC := $(sort $(ZSTD_DECOMPRESS_FILES) $(ZSTD_COMMON_FILES) $(ZSTD_COMPRESS_FILES)) 35ZDICT_SRC := $(sort $(ZSTD_DICTBUILDER_FILES)) 36ZSTDLEGACY_SRC := $(sort $(ZSTD_LEGACY_FILES)) 37 38# Sort files in alphabetical order for reproducible builds 39ZSTDLIB_FULL_SRC = $(sort $(ZSTDLIB_CORE_SRC) $(ZSTDLEGACY_SRC) $(ZDICT_SRC)) 40ZSTDLIB_LOCAL_SRC = $(notdir $(ZSTDLIB_FULL_SRC)) 41ZSTDLIB_LOCAL_OBJ0 := $(ZSTDLIB_LOCAL_SRC:.c=.o) 42ZSTDLIB_LOCAL_OBJ := $(ZSTDLIB_LOCAL_OBJ0:.S=.o) 43 44ZSTD_CLI_SRC := $(sort $(wildcard *.c)) 45ZSTD_CLI_OBJ := $(ZSTD_CLI_SRC:.c=.o) 46 47ZSTD_ALL_SRC = $(ZSTDLIB_LOCAL_SRC) $(ZSTD_CLI_SRC) 48ZSTD_ALL_OBJ0 := $(ZSTD_ALL_SRC:.c=.o) 49ZSTD_ALL_OBJ := $(ZSTD_ALL_OBJ0:.S=.o) 50 51# Define *.exe as extension for Windows systems 52ifneq (,$(filter Windows%,$(OS))) 53 EXT =.exe 54 RES64_FILE = windres/zstd64.res 55 RES32_FILE = windres/zstd32.res 56ifneq (,$(filter x86_64%,$(shell $(CC) -dumpmachine))) 57 RES_FILE = $(RES64_FILE) 58else 59 RES_FILE = $(RES32_FILE) 60endif 61else 62 EXT = 63endif 64 65VOID = /dev/null 66 67# thread detection 68NO_THREAD_MSG := ==> no threads, building without multithreading support 69HAVE_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) 70HAVE_THREAD := $(shell [ "$(HAVE_PTHREAD)" -eq "1" -o -n "$(filter Windows%,$(OS))" ] && echo 1 || echo 0) 71ifeq ($(HAVE_THREAD), 1) 72 THREAD_MSG := ==> building with threading support 73 THREAD_CPP := -DZSTD_MULTITHREAD 74 THREAD_LD := -pthread 75else 76 THREAD_MSG := $(NO_THREAD_MSG) 77endif 78 79# zlib detection 80NO_ZLIB_MSG := ==> no zlib, building zstd without .gz support 81HAVE_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) 82ifeq ($(HAVE_ZLIB), 1) 83 ZLIB_MSG := ==> building zstd with .gz compression support 84 ZLIBCPP = -DZSTD_GZCOMPRESS -DZSTD_GZDECOMPRESS 85 ZLIBLD = -lz 86else 87 ZLIB_MSG := $(NO_ZLIB_MSG) 88endif 89 90# lzma detection 91NO_LZMA_MSG := ==> no liblzma, building zstd without .xz/.lzma support 92HAVE_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) 93ifeq ($(HAVE_LZMA), 1) 94 LZMA_MSG := ==> building zstd with .xz/.lzma compression support 95 LZMACPP = -DZSTD_LZMACOMPRESS -DZSTD_LZMADECOMPRESS 96 LZMALD = -llzma 97else 98 LZMA_MSG := $(NO_LZMA_MSG) 99endif 100 101# lz4 detection 102NO_LZ4_MSG := ==> no liblz4, building zstd without .lz4 support 103HAVE_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) 104ifeq ($(HAVE_LZ4), 1) 105 LZ4_MSG := ==> building zstd with .lz4 compression support 106 LZ4CPP = -DZSTD_LZ4COMPRESS -DZSTD_LZ4DECOMPRESS 107 LZ4LD = -llz4 108else 109 LZ4_MSG := $(NO_LZ4_MSG) 110endif 111 112# explicit backtrace enable/disable for Linux & Darwin 113ifeq ($(BACKTRACE), 0) 114 DEBUGFLAGS += -DBACKTRACE_ENABLE=0 115endif 116ifeq (,$(filter Windows%, $(OS))) 117ifeq ($(BACKTRACE), 1) 118 DEBUGFLAGS += -DBACKTRACE_ENABLE=1 119 DEBUGFLAGS_LD += -rdynamic 120endif 121endif 122 123SET_CACHE_DIRECTORY = \ 124 +$(MAKE) --no-print-directory $@ \ 125 BUILD_DIR=obj/$(HASH_DIR) \ 126 CPPFLAGS="$(CPPFLAGS)" \ 127 CFLAGS="$(CFLAGS)" \ 128 LDFLAGS="$(LDFLAGS)" \ 129 LDLIBS="$(LDLIBS)" \ 130 ZSTD_ALL_SRC="$(ZSTD_ALL_SRC)" 131 132 133.PHONY: all 134all: zstd 135 136.PHONY: allVariants 137allVariants: zstd zstd-compress zstd-decompress zstd-small zstd-frugal zstd-nolegacy zstd-dictBuilder 138 139.PHONY: zstd # must always be run 140zstd : CPPFLAGS += $(THREAD_CPP) $(ZLIBCPP) $(LZMACPP) $(LZ4CPP) 141zstd : LDFLAGS += $(THREAD_LD) $(DEBUGFLAGS_LD) 142zstd : LDLIBS += $(ZLIBLD) $(LZMALD) $(LZ4LD) 143zstd : CPPFLAGS += -DZSTD_LEGACY_SUPPORT=$(ZSTD_LEGACY_SUPPORT) 144ifneq (,$(filter Windows%,$(OS))) 145zstd : $(RES_FILE) 146endif 147 148ifndef BUILD_DIR 149# generate BUILD_DIR from flags 150 151zstd: 152 $(SET_CACHE_DIRECTORY) 153 154else 155# BUILD_DIR is defined 156 157ZSTD_OBJ := $(addprefix $(BUILD_DIR)/, $(ZSTD_ALL_OBJ)) 158$(BUILD_DIR)/zstd : $(ZSTD_OBJ) 159 @echo "$(THREAD_MSG)" 160 @echo "$(ZLIB_MSG)" 161 @echo "$(LZMA_MSG)" 162 @echo "$(LZ4_MSG)" 163 @echo LINK $@ 164 $(CC) $(FLAGS) $^ $(LDLIBS) -o $@$(EXT) 165 166ifeq ($(HAVE_HASH),1) 167SRCBIN_HASH = $(shell cat $(BUILD_DIR)/zstd$(EXT) 2> $(VOID) | $(HASH) | cut -f 1 -d " ") 168DSTBIN_HASH = $(shell cat zstd$(EXT) 2> $(VOID) | $(HASH) | cut -f 1 -d " ") 169BIN_ISDIFFERENT = $(if $(filter $(SRCBIN_HASH),$(DSTBIN_HASH)),0,1) 170else 171BIN_ISDIFFERENT = 1 172endif 173 174zstd : $(BUILD_DIR)/zstd 175 if [ $(BIN_ISDIFFERENT) -eq 1 ]; then \ 176 cp -f $<$(EXT) $@$(EXT); \ 177 echo zstd build completed; \ 178 else \ 179 echo zstd already built; \ 180 fi 181 182endif # BUILD_DIR 183 184 185.PHONY: zstd-release 186zstd-release: DEBUGFLAGS := -DBACKTRACE_ENABLE=0 187zstd-release: DEBUGFLAGS_LD := 188zstd-release: zstd 189 190zstd32 : CPPFLAGS += $(THREAD_CPP) 191zstd32 : LDFLAGS += $(THREAD_LD) 192zstd32 : CPPFLAGS += -DZSTD_LEGACY_SUPPORT=$(ZSTD_LEGACY_SUPPORT) 193ifneq (,$(filter Windows%,$(OS))) 194zstd32 : $(RES32_FILE) 195endif 196zstd32 : $(ZSTDLIB_FULL_SRC) $(ZSTD_CLI_SRC) 197 $(CC) -m32 $(FLAGS) $^ -o $@$(EXT) 198 199## zstd-nolegacy: same scope as zstd, with just support of legacy formats removed 200zstd-nolegacy : LDFLAGS += $(THREAD_LD) $(ZLIBLD) $(LZMALD) $(LZ4LD) $(DEBUGFLAGS_LD) 201zstd-nolegacy : CPPFLAGS += -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0 202zstd-nolegacy : $(ZSTDLIB_CORE_SRC) $(ZDICT_SRC) $(ZSTD_CLI_OBJ) 203 $(CC) $(FLAGS) $^ -o $@$(EXT) $(LDFLAGS) 204 205.PHONY: zstd-nomt 206zstd-nomt : THREAD_CPP := 207zstd-nomt : THREAD_LD := 208zstd-nomt : THREAD_MSG := - multi-threading disabled 209zstd-nomt : zstd 210 211.PHONY: zstd-nogz 212zstd-nogz : ZLIBCPP := 213zstd-nogz : ZLIBLD := 214zstd-nogz : ZLIB_MSG := - gzip support is disabled 215zstd-nogz : zstd 216 217.PHONY: zstd-noxz 218zstd-noxz : LZMACPP := 219zstd-noxz : LZMALD := 220zstd-noxz : LZMA_MSG := - xz/lzma support is disabled 221zstd-noxz : zstd 222 223## zstd-dll: zstd executable linked to dynamic library libzstd (must have same version) 224.PHONY: zstd-dll 225zstd-dll : LDFLAGS+= -L$(LIBZSTD) 226zstd-dll : LDLIBS += -lzstd 227zstd-dll : ZSTDLIB_LOCAL_SRC = xxhash.c 228zstd-dll : zstd 229 230 231## zstd-pgo: zstd executable optimized with PGO. 232.PHONY: zstd-pgo 233zstd-pgo : 234 $(MAKE) clean 235 $(MAKE) zstd MOREFLAGS=-fprofile-generate 236 ./zstd -b19i1 $(PROFILE_WITH) 237 ./zstd -b16i1 $(PROFILE_WITH) 238 ./zstd -b9i2 $(PROFILE_WITH) 239 ./zstd -b $(PROFILE_WITH) 240 ./zstd -b7i2 $(PROFILE_WITH) 241 ./zstd -b5 $(PROFILE_WITH) 242 $(RM) zstd *.o 243 case $(CC) in *clang*) if ! [ -e default.profdata ]; then llvm-profdata merge -output=default.profdata default*.profraw; fi ;; esac 244 $(MAKE) zstd MOREFLAGS=-fprofile-use 245 246## zstd-small: minimal target, supporting only zstd compression and decompression. no bench. no legacy. no other format. 247zstd-small: CFLAGS = -Os -s 248zstd-frugal zstd-small: $(ZSTDLIB_CORE_SRC) zstdcli.c util.c timefn.c fileio.c 249 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NOTRACE -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0 $^ -o $@$(EXT) 250 251zstd-decompress: $(ZSTDLIB_COMMON_SRC) $(ZSTDLIB_DECOMPRESS_SRC) zstdcli.c util.c timefn.c fileio.c 252 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NOCOMPRESS -DZSTD_NOTRACE -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0 $^ -o $@$(EXT) 253 254zstd-compress: $(ZSTDLIB_COMMON_SRC) $(ZSTDLIB_COMPRESS_SRC) zstdcli.c util.c timefn.c fileio.c 255 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NODECOMPRESS -DZSTD_NOTRACE -UZSTD_LEGACY_SUPPORT -DZSTD_LEGACY_SUPPORT=0 $^ -o $@$(EXT) 256 257## zstd-dictBuilder: executable supporting dictionary creation and compression (only) 258zstd-dictBuilder: $(ZSTDLIB_COMMON_SRC) $(ZSTDLIB_COMPRESS_SRC) $(ZDICT_SRC) zstdcli.c util.c timefn.c fileio.c dibio.c 259 $(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODECOMPRESS -DZSTD_NOTRACE $^ -o $@$(EXT) 260 261zstdmt: zstd 262 ln -sf zstd zstdmt 263 264.PHONY: generate_res 265generate_res: $(RES64_FILE) $(RES32_FILE) 266 267ifneq (,$(filter Windows%,$(OS))) 268RC ?= windres 269# http://stackoverflow.com/questions/708238/how-do-i-add-an-icon-to-a-mingw-gcc-compiled-executable 270$(RES64_FILE): windres/zstd.rc 271 $(RC) -o $@ -I ../lib -I windres -i $< -O coff -F pe-x86-64 272$(RES32_FILE): windres/zstd.rc 273 $(RC) -o $@ -I ../lib -I windres -i $< -O coff -F pe-i386 274endif 275 276.PHONY: clean 277clean: 278 $(RM) core *.o tmp* result* *.gcda dictionary *.zst \ 279 zstd$(EXT) zstd32$(EXT) zstd-dll$(EXT) \ 280 zstd-compress$(EXT) zstd-decompress$(EXT) \ 281 zstd-small$(EXT) zstd-frugal$(EXT) zstd-nolegacy$(EXT) zstd4$(EXT) \ 282 zstd-dictBuilder$(EXT) \ 283 *.gcda default*.profraw default.profdata have_zlib$(EXT) 284 $(RM) -r obj/* 285 @echo Cleaning completed 286 287MD2ROFF = ronn 288MD2ROFF_FLAGS = --roff --warnings --manual="User Commands" --organization="zstd $(ZSTD_VERSION)" 289 290zstd.1: zstd.1.md ../lib/zstd.h 291 cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ 292 293zstdgrep.1: zstdgrep.1.md ../lib/zstd.h 294 cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ 295 296zstdless.1: zstdless.1.md ../lib/zstd.h 297 cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ 298 299.PHONY: man 300man: zstd.1 zstdgrep.1 zstdless.1 301 302.PHONY: clean-man 303clean-man: 304 $(RM) zstd.1 305 $(RM) zstdgrep.1 306 $(RM) zstdless.1 307 308.PHONY: preview-man 309preview-man: clean-man man 310 man ./zstd.1 311 man ./zstdgrep.1 312 man ./zstdless.1 313 314 315# Generate .h dependencies automatically 316 317DEPFLAGS = -MT $@ -MMD -MP -MF 318 319$(BUILD_DIR)/%.o : %.c $(BUILD_DIR)/%.d | $(BUILD_DIR) 320 @echo CC $@ 321 $(COMPILE.c) $(DEPFLAGS) $(BUILD_DIR)/$*.d $(OUTPUT_OPTION) $< 322 323$(BUILD_DIR)/%.o : %.S | $(BUILD_DIR) 324 @echo AS $@ 325 $(COMPILE.c) $(OUTPUT_OPTION) $< 326 327MKDIR ?= mkdir 328$(BUILD_DIR): ; $(MKDIR) -p $@ 329 330DEPFILES := $(ZSTD_OBJ:.o=.d) 331$(DEPFILES): 332 333include $(wildcard $(DEPFILES)) 334 335 336 337#----------------------------------------------------------------------------- 338# make install is validated only for Linux, macOS, BSD, Hurd and Solaris targets 339#----------------------------------------------------------------------------- 340ifneq (,$(filter $(UNAME),Linux Darwin GNU/kFreeBSD GNU OpenBSD FreeBSD NetBSD DragonFly SunOS Haiku AIX)) 341 342HAVE_COLORNEVER = $(shell echo a | egrep --color=never a > /dev/null 2> /dev/null && echo 1 || echo 0) 343EGREP_OPTIONS ?= 344ifeq ($HAVE_COLORNEVER, 1) 345 EGREP_OPTIONS += --color=never 346endif 347EGREP = egrep $(EGREP_OPTIONS) 348AWK = awk 349 350# Print a two column output of targets and their description. To add a target description, put a 351# comment in the Makefile with the format "## <TARGET>: <DESCRIPTION>". For example: 352# 353## list: Print all targets and their descriptions (if provided) 354.PHONY: list 355list: 356 TARGETS=$$($(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null \ 357 | $(AWK) -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' \ 358 | $(EGREP) -v -e '^[^[:alnum:]]' | sort); \ 359 { \ 360 printf "Target Name\tDescription\n"; \ 361 printf "%0.s-" {1..16}; printf "\t"; printf "%0.s-" {1..40}; printf "\n"; \ 362 for target in $$TARGETS; do \ 363 line=$$($(EGREP) "^##[[:space:]]+$$target:" $(lastword $(MAKEFILE_LIST))); \ 364 description=$$(echo $$line | $(AWK) '{i=index($$0,":"); print substr($$0,i+1)}' | xargs); \ 365 printf "$$target\t$$description\n"; \ 366 done \ 367 } | column -t -s $$'\t' 368 369 370DESTDIR ?= 371# directory variables : GNU conventions prefer lowercase 372# see https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html 373# support both lower and uppercase (BSD), use uppercase in script 374prefix ?= /usr/local 375PREFIX ?= $(prefix) 376exec_prefix ?= $(PREFIX) 377bindir ?= $(exec_prefix)/bin 378BINDIR ?= $(bindir) 379datarootdir ?= $(PREFIX)/share 380mandir ?= $(datarootdir)/man 381man1dir ?= $(mandir)/man1 382 383ifneq (,$(filter $(UNAME),OpenBSD FreeBSD NetBSD DragonFly SunOS)) 384 MANDIR ?= $(PREFIX)/man 385 MAN1DIR ?= $(MANDIR)/man1 386else 387 MAN1DIR ?= $(man1dir) 388endif 389 390ifneq (,$(filter $(UNAME),SunOS)) 391 INSTALL ?= ginstall 392else 393 INSTALL ?= install 394endif 395 396INSTALL_PROGRAM ?= $(INSTALL) 397INSTALL_SCRIPT ?= $(INSTALL_PROGRAM) 398INSTALL_DATA ?= $(INSTALL) -m 644 399INSTALL_MAN ?= $(INSTALL_DATA) 400 401.PHONY: install 402install: 403 # generate zstd only if not already present 404 [ -e zstd ] || $(MAKE) zstd-release 405 [ -e $(DESTDIR)$(BINDIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(BINDIR)/ 406 [ -e $(DESTDIR)$(MAN1DIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(MAN1DIR)/ 407 @echo Installing binaries 408 $(INSTALL_PROGRAM) zstd$(EXT) $(DESTDIR)$(BINDIR)/zstd$(EXT) 409 ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/zstdcat$(EXT) 410 ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/unzstd$(EXT) 411 ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/zstdmt$(EXT) 412 $(INSTALL_SCRIPT) zstdless $(DESTDIR)$(BINDIR)/zstdless 413 $(INSTALL_SCRIPT) zstdgrep $(DESTDIR)$(BINDIR)/zstdgrep 414 @echo Installing man pages 415 $(INSTALL_MAN) zstd.1 $(DESTDIR)$(MAN1DIR)/zstd.1 416 ln -sf zstd.1 $(DESTDIR)$(MAN1DIR)/zstdcat.1 417 ln -sf zstd.1 $(DESTDIR)$(MAN1DIR)/unzstd.1 418 $(INSTALL_MAN) zstdgrep.1 $(DESTDIR)$(MAN1DIR)/zstdgrep.1 419 $(INSTALL_MAN) zstdless.1 $(DESTDIR)$(MAN1DIR)/zstdless.1 420 @echo zstd installation completed 421 422.PHONY: uninstall 423uninstall: 424 $(RM) $(DESTDIR)$(BINDIR)/zstdgrep 425 $(RM) $(DESTDIR)$(BINDIR)/zstdless 426 $(RM) $(DESTDIR)$(BINDIR)/zstdcat 427 $(RM) $(DESTDIR)$(BINDIR)/unzstd 428 $(RM) $(DESTDIR)$(BINDIR)/zstdmt 429 $(RM) $(DESTDIR)$(BINDIR)/zstd 430 $(RM) $(DESTDIR)$(MAN1DIR)/zstdless.1 431 $(RM) $(DESTDIR)$(MAN1DIR)/zstdgrep.1 432 $(RM) $(DESTDIR)$(MAN1DIR)/zstdcat.1 433 $(RM) $(DESTDIR)$(MAN1DIR)/unzstd.1 434 $(RM) $(DESTDIR)$(MAN1DIR)/zstd.1 435 @echo zstd programs successfully uninstalled 436 437endif 438