10c16b537SWarner Losh# ################################################################
20c16b537SWarner Losh# Copyright (c) 2015-2020, Yann Collet, Facebook, Inc.
30c16b537SWarner Losh# All rights reserved.
40c16b537SWarner Losh#
50c16b537SWarner Losh# This source code is licensed under both the BSD-style license (found in the
60c16b537SWarner Losh# LICENSE file in the root directory of this source tree) and the GPLv2 (found
70c16b537SWarner Losh# in the COPYING file in the root directory of this source tree).
80c16b537SWarner Losh# You may select, at your option, one of the above-listed licenses.
90c16b537SWarner Losh# ##########################################################################
100c16b537SWarner Losh# zstd : Command Line Utility, supporting gzip-like arguments
110c16b537SWarner Losh# zstd32 : Same as zstd, but forced to compile in 32-bits mode
120c16b537SWarner Losh# zstd_nolegacy : zstd without support of decompression of legacy versions
130c16b537SWarner Losh# zstd-small : minimal zstd without dictionary builder and benchmark
140c16b537SWarner Losh# zstd-compress : compressor-only version of zstd
150c16b537SWarner Losh# zstd-decompress : decompressor-only version of zstd
160c16b537SWarner Losh# ##########################################################################
170c16b537SWarner Losh
180c16b537SWarner Losh.PHONY: default
190c16b537SWarner Loshdefault: zstd-release
200c16b537SWarner Losh
210c16b537SWarner Losh# silent mode by default; verbose can be triggered by V=1 or VERBOSE=1
220c16b537SWarner Losh$(V)$(VERBOSE).SILENT:
230c16b537SWarner Losh
240c16b537SWarner Losh
250c16b537SWarner LoshZSTDDIR := ../lib
260c16b537SWarner Losh
270c16b537SWarner Losh# Version numbers
280c16b537SWarner LoshLIBVER_SRC := $(ZSTDDIR)/zstd.h
290c16b537SWarner LoshLIBVER_MAJOR_SCRIPT:=`sed -n '/define ZSTD_VERSION_MAJOR/s/.*[[:blank:]]\([0-9][0-9]*\).*/\1/p' < $(LIBVER_SRC)`
300c16b537SWarner LoshLIBVER_MINOR_SCRIPT:=`sed -n '/define ZSTD_VERSION_MINOR/s/.*[[:blank:]]\([0-9][0-9]*\).*/\1/p' < $(LIBVER_SRC)`
310c16b537SWarner LoshLIBVER_PATCH_SCRIPT:=`sed -n '/define ZSTD_VERSION_RELEASE/s/.*[[:blank:]]\([0-9][0-9]*\).*/\1/p' < $(LIBVER_SRC)`
32*0f743729SConrad MeyerLIBVER_SCRIPT:= $(LIBVER_MAJOR_SCRIPT).$(LIBVER_MINOR_SCRIPT).$(LIBVER_PATCH_SCRIPT)
33*0f743729SConrad MeyerLIBVER_MAJOR := $(shell echo $(LIBVER_MAJOR_SCRIPT))
34*0f743729SConrad MeyerLIBVER_MINOR := $(shell echo $(LIBVER_MINOR_SCRIPT))
350c16b537SWarner LoshLIBVER_PATCH := $(shell echo $(LIBVER_PATCH_SCRIPT))
360c16b537SWarner LoshLIBVER  := $(shell echo $(LIBVER_SCRIPT))
370c16b537SWarner Losh
380c16b537SWarner LoshZSTD_VERSION = $(LIBVER)
390c16b537SWarner Losh
400c16b537SWarner LoshHAVE_COLORNEVER = $(shell echo a | grep --color=never a > /dev/null 2> /dev/null && echo 1 || echo 0)
410c16b537SWarner LoshGREP_OPTIONS ?=
42052d3c12SConrad Meyerifeq ($HAVE_COLORNEVER, 1)
43*0f743729SConrad Meyer  GREP_OPTIONS += --color=never
44*0f743729SConrad Meyerendif
45*0f743729SConrad MeyerGREP = grep $(GREP_OPTIONS)
460c16b537SWarner Losh
470c16b537SWarner Loshifeq ($(shell $(CC) -v 2>&1 | $(GREP) -c "gcc version "), 1)
480c16b537SWarner Losh  ALIGN_LOOP = -falign-loops=32
490c16b537SWarner Loshelse
500c16b537SWarner Losh  ALIGN_LOOP =
51*0f743729SConrad Meyerendif
520c16b537SWarner Losh
530c16b537SWarner LoshDEBUGLEVEL ?= 0
540c16b537SWarner LoshCPPFLAGS += -DXXH_NAMESPACE=ZSTD_ -DDEBUGLEVEL=$(DEBUGLEVEL)
550c16b537SWarner Loshifeq ($(OS),Windows_NT)   # MinGW assumed
560c16b537SWarner Losh  CPPFLAGS += -D__USE_MINGW_ANSI_STDIO   # compatibility with %zu formatting
570c16b537SWarner Loshendif
580c16b537SWarner LoshCFLAGS   ?= -O3
590c16b537SWarner LoshDEBUGFLAGS+=-Wall -Wextra -Wcast-qual -Wcast-align -Wshadow \
600c16b537SWarner Losh            -Wstrict-aliasing=1 -Wswitch-enum -Wdeclaration-after-statement \
610c16b537SWarner Losh            -Wstrict-prototypes -Wundef -Wpointer-arith \
620c16b537SWarner Losh            -Wvla -Wformat=2 -Winit-self -Wfloat-equal -Wwrite-strings \
63*0f743729SConrad Meyer            -Wredundant-decls -Wmissing-prototypes -Wc++-compat
640c16b537SWarner LoshCFLAGS   += $(DEBUGFLAGS) $(MOREFLAGS)
650c16b537SWarner LoshFLAGS     = $(CPPFLAGS) $(CFLAGS) $(LDFLAGS)
660c16b537SWarner Losh
67*0f743729SConrad MeyerZSTDLIB_COMMON := $(ZSTDDIR)/common
680c16b537SWarner LoshZSTDLIB_COMPRESS := $(ZSTDDIR)/compress
690c16b537SWarner LoshZSTDLIB_DECOMPRESS := $(ZSTDDIR)/decompress
700c16b537SWarner LoshZDICT_DIR := $(ZSTDDIR)/dictBuilder
710c16b537SWarner LoshZSTDLEGACY_DIR := $(ZSTDDIR)/legacy
720c16b537SWarner Losh
73052d3c12SConrad Meyervpath %.c $(ZSTDLIB_COMMON) $(ZSTDLIB_COMPRESS) $(ZSTDLIB_DECOMPRESS) $(ZDICT_DIR) $(ZSTDLEGACY_DIR)
740c16b537SWarner Losh
750c16b537SWarner LoshZSTDLIB_COMMON_C := $(wildcard $(ZSTDLIB_COMMON)/*.c)
760c16b537SWarner LoshZSTDLIB_COMPRESS_C := $(wildcard $(ZSTDLIB_COMPRESS)/*.c)
770c16b537SWarner LoshZSTDLIB_DECOMPRESS_C := $(wildcard $(ZSTDLIB_DECOMPRESS)/*.c)
780c16b537SWarner LoshZSTDLIB_CORE_SRC := $(ZSTDLIB_DECOMPRESS_C) $(ZSTDLIB_COMMON_C) $(ZSTDLIB_COMPRESS_C)
790c16b537SWarner LoshZDICT_SRC := $(wildcard $(ZDICT_DIR)/*.c)
800c16b537SWarner Losh
810c16b537SWarner LoshZSTD_LEGACY_SUPPORT ?= 5
820c16b537SWarner LoshZSTDLEGACY_SRC :=
830c16b537SWarner Loshifneq ($(ZSTD_LEGACY_SUPPORT), 0)
840c16b537SWarner Loshifeq ($(shell test $(ZSTD_LEGACY_SUPPORT) -lt 8; echo $$?), 0)
850c16b537SWarner Losh  ZSTDLEGACY_SRC += $(shell ls $(ZSTDLEGACY_DIR)/*.c | $(GREP) 'v0[$(ZSTD_LEGACY_SUPPORT)-7]')
860c16b537SWarner Loshendif
870c16b537SWarner Loshendif
880c16b537SWarner Losh
890c16b537SWarner Losh# Sort files in alphabetical order for reproducible builds
900c16b537SWarner LoshZSTDLIB_FULL_SRC = $(sort $(ZSTDLIB_CORE_SRC) $(ZSTDLEGACY_SRC) $(ZDICT_SRC))
910c16b537SWarner LoshZSTDLIB_LOCAL_SRC := $(notdir $(ZSTDLIB_FULL_SRC))
920c16b537SWarner LoshZSTDLIB_LOCAL_OBJ := $(ZSTDLIB_LOCAL_SRC:.c=.o)
930c16b537SWarner Losh
940c16b537SWarner LoshZSTD_CLI_SRC := $(wildcard *.c)
950c16b537SWarner LoshZSTD_CLI_OBJ := $(ZSTD_CLI_SRC:.c=.o)
960c16b537SWarner Losh
970c16b537SWarner LoshZSTD_ALL_SRC := $(ZSTDLIB_LOCAL_SRC) $(ZSTD_CLI_SRC)
980c16b537SWarner LoshZSTD_ALL_OBJ := $(ZSTD_ALL_SRC:.c=.o)
990c16b537SWarner Losh
1000c16b537SWarner LoshUNAME := $(shell uname)
1010c16b537SWarner Loshifeq ($(UNAME), Darwin)
1020c16b537SWarner Losh  HASH ?= md5
1030c16b537SWarner Loshelse ifeq ($(UNAME), FreeBSD)
1040c16b537SWarner Losh  HASH ?= gmd5sum
1050c16b537SWarner Loshelse ifeq ($(UNAME), OpenBSD)
1060c16b537SWarner Losh  HASH ?= md5
1070c16b537SWarner Loshendif
1080c16b537SWarner LoshHASH ?= md5sum
1090c16b537SWarner LoshHAVE_HASH :=$(shell echo 1 | $(HASH) > /dev/null && echo 1 || echo 0)
1100c16b537SWarner Losh
1110c16b537SWarner Loshifndef BUILD_DIR
1120c16b537SWarner LoshHASH_DIR = conf_$(shell echo $(CC) $(CPPFLAGS) $(CFLAGS) $(LDFLAGS) $(ZSTD_FILES) | $(HASH) | cut -f 1 -d " ")
1130c16b537SWarner Loshifeq ($(HAVE_HASH),0)
1140c16b537SWarner Losh  $(info warning : could not find HASH ($(HASH)), needed to differentiate builds using different flags)
1150c16b537SWarner Losh  BUILD_DIR := obj/generic_noconf
1160c16b537SWarner Loshendif
1170c16b537SWarner Loshendif # BUILD_DIR
1180c16b537SWarner Losh
1190c16b537SWarner Losh# Define *.exe as extension for Windows systems
1200c16b537SWarner Loshifneq (,$(filter Windows%,$(OS)))
1210c16b537SWarner Losh  EXT =.exe
1220c16b537SWarner Losh  RES64_FILE = windres/zstd64.res
1230c16b537SWarner Losh  RES32_FILE = windres/zstd32.res
1240c16b537SWarner Loshifneq (,$(filter x86_64%,$(shell $(CC) -dumpmachine)))
1250c16b537SWarner Losh    RES_FILE = $(RES64_FILE)
1260c16b537SWarner Loshelse
1270c16b537SWarner Losh    RES_FILE = $(RES32_FILE)
1280c16b537SWarner Loshendif
1290c16b537SWarner Loshelse
1300c16b537SWarner Losh  EXT =
1310c16b537SWarner Loshendif
1320c16b537SWarner Losh
1330c16b537SWarner LoshVOID = /dev/null
1340c16b537SWarner Losh
1350c16b537SWarner Losh# Make 4.3 doesn't support '\#' anymore (https://lwn.net/Articles/810071/)
1360c16b537SWarner LoshNUM_SYMBOL := \#
137*0f743729SConrad Meyer
138*0f743729SConrad Meyer# thread detection
139*0f743729SConrad MeyerNO_THREAD_MSG := ==> no threads, building without multithreading support
140*0f743729SConrad MeyerHAVE_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)
141*0f743729SConrad MeyerHAVE_THREAD := $(shell [ "$(HAVE_PTHREAD)" -eq "1" -o -n "$(filter Windows%,$(OS))" ] && echo 1 || echo 0)
142*0f743729SConrad Meyerifeq ($(HAVE_THREAD), 1)
143*0f743729SConrad Meyer  THREAD_MSG := ==> building with threading support
144*0f743729SConrad Meyer  THREAD_CPP := -DZSTD_MULTITHREAD
145*0f743729SConrad Meyer  THREAD_LD := -pthread
146*0f743729SConrad Meyerelse
147*0f743729SConrad Meyer  THREAD_MSG := $(NO_THREAD_MSG)
148*0f743729SConrad Meyerendif
1490c16b537SWarner Losh
1500c16b537SWarner Losh# zlib detection
1510c16b537SWarner LoshNO_ZLIB_MSG := ==> no zlib, building zstd without .gz support
1520c16b537SWarner LoshHAVE_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)
1530c16b537SWarner Loshifeq ($(HAVE_ZLIB), 1)
1540c16b537SWarner Losh  ZLIB_MSG := ==> building zstd with .gz compression support
1550c16b537SWarner Losh  ZLIBCPP = -DZSTD_GZCOMPRESS -DZSTD_GZDECOMPRESS
1560c16b537SWarner Losh  ZLIBLD = -lz
1570c16b537SWarner Loshelse
1580c16b537SWarner Losh  ZLIB_MSG := $(NO_ZLIB_MSG)
1590c16b537SWarner Loshendif
1600c16b537SWarner Losh
161*0f743729SConrad Meyer# lzma detection
1620c16b537SWarner LoshNO_LZMA_MSG := ==> no liblzma, building zstd without .xz/.lzma support
1630c16b537SWarner LoshHAVE_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)
1640c16b537SWarner Loshifeq ($(HAVE_LZMA), 1)
1650c16b537SWarner Losh  LZMA_MSG := ==> building zstd with .xz/.lzma compression support
1660c16b537SWarner Losh  LZMACPP = -DZSTD_LZMACOMPRESS -DZSTD_LZMADECOMPRESS
1670c16b537SWarner Losh  LZMALD = -llzma
1680c16b537SWarner Loshelse
1690c16b537SWarner Losh  LZMA_MSG := $(NO_LZMA_MSG)
1700c16b537SWarner Loshendif
1710c16b537SWarner Losh
1720c16b537SWarner Losh# lz4 detection
1730c16b537SWarner LoshNO_LZ4_MSG := ==> no liblz4, building zstd without .lz4 support
174*0f743729SConrad MeyerHAVE_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)
175*0f743729SConrad Meyerifeq ($(HAVE_LZ4), 1)
1760c16b537SWarner Losh  LZ4_MSG := ==> building zstd with .lz4 compression support
1770c16b537SWarner Losh  LZ4CPP = -DZSTD_LZ4COMPRESS -DZSTD_LZ4DECOMPRESS
17819fcbaf1SConrad Meyer  LZ4LD = -llz4
17919fcbaf1SConrad Meyerelse
1800c16b537SWarner Losh  LZ4_MSG := $(NO_LZ4_MSG)
1810c16b537SWarner Loshendif
1820c16b537SWarner Losh
1830c16b537SWarner Losh# explicit backtrace enable/disable for Linux & Darwin
1840c16b537SWarner Loshifeq ($(BACKTRACE), 0)
1850c16b537SWarner Losh  DEBUGFLAGS += -DBACKTRACE_ENABLE=0
1860c16b537SWarner Loshendif
1870c16b537SWarner Loshifeq (,$(filter Windows%, $(OS)))
1880c16b537SWarner Loshifeq ($(BACKTRACE), 1)
1890c16b537SWarner Losh  DEBUGFLAGS += -DBACKTRACE_ENABLE=1
1900c16b537SWarner Losh  DEBUGFLAGS_LD += -rdynamic
1910c16b537SWarner Loshendif
1920c16b537SWarner Loshendif
1930c16b537SWarner Losh
1940c16b537SWarner LoshSET_CACHE_DIRECTORY = \
1950c16b537SWarner Losh	$(MAKE) --no-print-directory $@ \
1960c16b537SWarner Losh    BUILD_DIR=obj/$(HASH_DIR) \
1970c16b537SWarner Losh    CPPFLAGS="$(CPPFLAGS)" \
1980c16b537SWarner Losh    CFLAGS="$(CFLAGS)" \
1990c16b537SWarner Losh    LDFLAGS="$(LDFLAGS)"
2000c16b537SWarner Losh
2010c16b537SWarner Losh
2020c16b537SWarner Losh.PHONY: all
2030c16b537SWarner Loshall: zstd
2040c16b537SWarner Losh
2050c16b537SWarner Losh.PHONY: allVariants
2060c16b537SWarner LoshallVariants: zstd zstd-compress zstd-decompress zstd-small zstd-nolegacy zstd-dictBuilder
2070c16b537SWarner Losh
2080c16b537SWarner Losh.PHONY: zstd  # must always be run
2090c16b537SWarner Loshzstd : CPPFLAGS += $(THREAD_CPP) $(ZLIBCPP) $(LZMACPP) $(LZ4CPP)
2100c16b537SWarner Loshzstd : LDFLAGS += $(THREAD_LD) $(ZLIBLD) $(LZMALD) $(LZ4LD) $(DEBUGFLAGS_LD)
2110c16b537SWarner Loshzstd : CPPFLAGS += -DZSTD_LEGACY_SUPPORT=$(ZSTD_LEGACY_SUPPORT)
2120c16b537SWarner Loshifneq (,$(filter Windows%,$(OS)))
2130c16b537SWarner Loshzstd : $(RES_FILE)
2140c16b537SWarner Loshendif
2150c16b537SWarner Losh
2160c16b537SWarner Loshifndef BUILD_DIR
2170c16b537SWarner Losh# generate BUILD_DIR from flags
2180c16b537SWarner Losh
2190c16b537SWarner Loshzstd:
2200c16b537SWarner Losh	$(SET_CACHE_DIRECTORY)
2210c16b537SWarner Losh
2220c16b537SWarner Loshelse
2230c16b537SWarner Losh# BUILD_DIR is defined
2240c16b537SWarner Losh
2250c16b537SWarner LoshZSTD_OBJ := $(addprefix $(BUILD_DIR)/, $(ZSTD_ALL_OBJ))
2260c16b537SWarner Losh$(BUILD_DIR)/zstd : $(ZSTD_OBJ)
2270c16b537SWarner Losh	@echo "$(THREAD_MSG)"
2280c16b537SWarner Losh	@echo "$(ZLIB_MSG)"
2290c16b537SWarner Losh	@echo "$(LZMA_MSG)"
2300c16b537SWarner Losh	@echo "$(LZ4_MSG)"
2310c16b537SWarner Losh	@echo LINK $@
2320c16b537SWarner Losh	$(CC) $(FLAGS) $^ -o $@$(EXT) $(LDFLAGS)
2330c16b537SWarner Losh
2340c16b537SWarner Loshifeq ($(HAVE_HASH),1)
2350c16b537SWarner LoshSRCBIN_HASH = $(shell cat $(BUILD_DIR)/zstd 2> $(VOID) | $(HASH) | cut -f 1 -d " ")
2360c16b537SWarner LoshDSTBIN_HASH = $(shell cat zstd 2> $(VOID) | $(HASH) | cut -f 1 -d " ")
2370c16b537SWarner LoshBIN_ISDIFFERENT = $(if $(filter $(SRCBIN_HASH),$(DSTBIN_HASH)),0,1)
2380c16b537SWarner Loshelse
2390c16b537SWarner LoshBIN_ISDIFFERENT = 1
2400c16b537SWarner Loshendif
2410c16b537SWarner Losh
2420c16b537SWarner Loshzstd : $(BUILD_DIR)/zstd
2430c16b537SWarner Losh	if [ $(BIN_ISDIFFERENT) -eq 1 ]; then \
2440c16b537SWarner Losh		cp -f $< $@; \
2450c16b537SWarner Losh		echo zstd build completed; \
2460c16b537SWarner Losh	else \
2470c16b537SWarner Losh		echo zstd already built; \
2480c16b537SWarner Losh	fi
249052d3c12SConrad Meyer
250052d3c12SConrad Meyerendif  # BUILD_DIR
2510c16b537SWarner Losh
252*0f743729SConrad Meyer
253*0f743729SConrad Meyer.PHONY: zstd-release
254*0f743729SConrad Meyerzstd-release: DEBUGFLAGS := -DBACKTRACE_ENABLE=0
255*0f743729SConrad Meyerzstd-release: DEBUGFLAGS_LD :=
256*0f743729SConrad Meyerzstd-release: zstd
257*0f743729SConrad Meyer
2580c16b537SWarner Loshzstd32 : CPPFLAGS += $(THREAD_CPP)
259*0f743729SConrad Meyerzstd32 : LDFLAGS  += $(THREAD_LD)
2600c16b537SWarner Loshzstd32 : CPPFLAGS += -DZSTD_LEGACY_SUPPORT=$(ZSTD_LEGACY_SUPPORT)
2610c16b537SWarner Loshifneq (,$(filter Windows%,$(OS)))
2620c16b537SWarner Loshzstd32 : $(RES32_FILE)
2630c16b537SWarner Loshendif
264*0f743729SConrad Meyerzstd32 : $(ZSTDLIB_FULL_SRC) $(ZSTD_CLI_SRC)
265*0f743729SConrad Meyer	$(CC) -m32 $(FLAGS) $^ -o $@$(EXT)
2660c16b537SWarner Losh
2670c16b537SWarner Losh## zstd-nolegacy: same scope as zstd, with just support of legacy formats removed
2680c16b537SWarner Loshzstd-nolegacy : LDFLAGS += $(THREAD_LD) $(ZLIBLD) $(LZMALD) $(LZ4LD) $(DEBUGFLAGS_LD)
2690c16b537SWarner Loshzstd-nolegacy : $(ZSTDLIB_CORE_SRC) $(ZDICT_SRC) $(ZSTD_CLI_OBJ)
270*0f743729SConrad Meyer	$(CC) $(FLAGS) $^ -o $@$(EXT) $(LDFLAGS)
271*0f743729SConrad Meyer
2720c16b537SWarner Loshzstd-nomt : THREAD_CPP :=
2730c16b537SWarner Loshzstd-nomt : THREAD_LD  :=
274*0f743729SConrad Meyerzstd-nomt : THREAD_MSG := - multi-threading disabled
2750c16b537SWarner Loshzstd-nomt : zstd
276*0f743729SConrad Meyer
2770c16b537SWarner Loshzstd-nogz : ZLIBCPP :=
278*0f743729SConrad Meyerzstd-nogz : ZLIBLD  :=
279*0f743729SConrad Meyerzstd-nogz : ZLIB_MSG := - gzip support is disabled
280*0f743729SConrad Meyerzstd-nogz : zstd
281*0f743729SConrad Meyer
282*0f743729SConrad Meyerzstd-noxz : LZMACPP :=
283*0f743729SConrad Meyerzstd-noxz : LZMALD  :=
2840c16b537SWarner Loshzstd-noxz : LZMA_MSG := - xz/lzma support is disabled
2850c16b537SWarner Loshzstd-noxz : zstd
286*0f743729SConrad Meyer
287*0f743729SConrad Meyer## zstd-dll: zstd executable linked to dynamic library libzstd (must already exist)
288*0f743729SConrad Meyer# note : the following target doesn't link
289*0f743729SConrad Meyer#        because zstd uses non-public symbols from libzstd
290*0f743729SConrad Meyer#        such as XXH64 (for benchmark),
291*0f743729SConrad Meyer#        ZDICT_trainFromBuffer_unsafe_legacy (for dictionary builder)
292*0f743729SConrad Meyer#        and ZSTD_cycleLog (likely for --patch-from).
293*0f743729SConrad Meyer#        It's unclear at this stage if this is a scenario that must be supported
294*0f743729SConrad Meyer.PHONY: zstd-dll
295*0f743729SConrad Meyerzstd-dll : LDFLAGS+= -L$(ZSTDDIR) -lzstd
296*0f743729SConrad Meyerzstd-dll : ZSTDLIB_FULL_SRC =
297*0f743729SConrad Meyerzstd-dll : $(ZSTD_CLI_OBJ)
298*0f743729SConrad Meyer	$(CC) $(FLAGS) $^ -o $@$(EXT) $(LDFLAGS)
2990c16b537SWarner Losh
3000c16b537SWarner Losh
3010c16b537SWarner Losh## zstd-pgo: zstd executable optimized with PGO.
3020c16b537SWarner Loshzstd-pgo :
3030c16b537SWarner Losh	$(MAKE) clean
3040c16b537SWarner Losh	$(MAKE) zstd MOREFLAGS=-fprofile-generate
3050c16b537SWarner Losh	./zstd -b19i1 $(PROFILE_WITH)
3060c16b537SWarner Losh	./zstd -b16i1 $(PROFILE_WITH)
3070c16b537SWarner Losh	./zstd -b9i2 $(PROFILE_WITH)
3080c16b537SWarner Losh	./zstd -b $(PROFILE_WITH)
3090c16b537SWarner Losh	./zstd -b7i2 $(PROFILE_WITH)
3100c16b537SWarner Losh	./zstd -b5 $(PROFILE_WITH)
3110c16b537SWarner Losh	$(RM) zstd *.o
3120c16b537SWarner Losh	case $(CC) in *clang*) if ! [ -e default.profdata ]; then llvm-profdata merge -output=default.profdata default*.profraw; fi ;; esac
3130c16b537SWarner Losh	$(MAKE) zstd MOREFLAGS=-fprofile-use
314052d3c12SConrad Meyer
315052d3c12SConrad Meyer## zstd-small: minimal target, supporting only zstd compression and decompression. no bench. no legacy. no other format.
3160c16b537SWarner Loshzstd-small: CFLAGS = -Os -s
317052d3c12SConrad Meyerzstd-frugal zstd-small: $(ZSTDLIB_CORE_SRC) zstdcli.c util.c timefn.c fileio.c
3180c16b537SWarner Losh	$(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT $^ -o $@$(EXT)
3190c16b537SWarner Losh
3200c16b537SWarner Loshzstd-decompress: $(ZSTDLIB_COMMON_C) $(ZSTDLIB_DECOMPRESS_C) zstdcli.c util.c timefn.c fileio.c
3210c16b537SWarner Losh	$(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NOCOMPRESS $^ -o $@$(EXT)
3220c16b537SWarner Losh
3230c16b537SWarner Loshzstd-compress: $(ZSTDLIB_COMMON_C) $(ZSTDLIB_COMPRESS_C) zstdcli.c util.c timefn.c fileio.c
3240c16b537SWarner Losh	$(CC) $(FLAGS) -DZSTD_NOBENCH -DZSTD_NODICT -DZSTD_NODECOMPRESS $^ -o $@$(EXT)
3250c16b537SWarner Losh
3260c16b537SWarner Losh## zstd-dictBuilder: executable supporting dictionary creation and compression (only)
3270c16b537SWarner Loshzstd-dictBuilder: CPPFLAGS += -DZSTD_NOBENCH -DZSTD_NODECOMPRESS
3280c16b537SWarner Loshzstd-dictBuilder: $(ZSTDLIB_COMMON_C) $(ZSTDLIB_COMPRESS_C) $(ZDICT_SRC) zstdcli.c util.c timefn.c fileio.c dibio.c
3290c16b537SWarner Losh	$(CC) $(FLAGS) $^ -o $@$(EXT)
3300c16b537SWarner Losh
3310c16b537SWarner Loshzstdmt: zstd
3320c16b537SWarner Losh	ln -sf zstd zstdmt
3330c16b537SWarner Losh
334052d3c12SConrad Meyer.PHONY: generate_res
3350c16b537SWarner Loshgenerate_res: $(RES64_FILE) $(RES32_FILE)
3360c16b537SWarner Losh
3370c16b537SWarner Loshifneq (,$(filter Windows%,$(OS)))
3380c16b537SWarner LoshRC ?= windres
3390c16b537SWarner Losh# http://stackoverflow.com/questions/708238/how-do-i-add-an-icon-to-a-mingw-gcc-compiled-executable
3400c16b537SWarner Losh$(RES64_FILE): windres/zstd.rc
3410c16b537SWarner Losh	$(RC) -o $@ -I ../lib -I windres -i $< -O coff -F pe-x86-64
342052d3c12SConrad Meyer$(RES32_FILE): windres/zstd.rc
343052d3c12SConrad Meyer	$(RC) -o $@ -I ../lib -I windres -i $< -O coff -F pe-i386
344052d3c12SConrad Meyerendif
345*0f743729SConrad Meyer
346*0f743729SConrad Meyer.PHONY: clean
3470c16b537SWarner Loshclean:
3480c16b537SWarner Losh	$(RM) core *.o tmp* result* *.gcda dictionary *.zst \
3490c16b537SWarner Losh        zstd$(EXT) zstd32$(EXT) zstd-compress$(EXT) zstd-decompress$(EXT) \
3500c16b537SWarner Losh        zstd-small$(EXT) zstd-frugal$(EXT) zstd-nolegacy$(EXT) zstd4$(EXT) \
3510c16b537SWarner Losh        zstd-dictBuilder$(EXT) *.gcda default*.profraw default.profdata have_zlib$(EXT)
3520c16b537SWarner Losh	$(RM) -r obj/*
3530c16b537SWarner Losh	@echo Cleaning completed
3540c16b537SWarner Losh
3550c16b537SWarner LoshMD2ROFF = ronn
356*0f743729SConrad MeyerMD2ROFF_FLAGS = --roff --warnings --manual="User Commands" --organization="zstd $(ZSTD_VERSION)"
357*0f743729SConrad Meyer
358052d3c12SConrad Meyerzstd.1: zstd.1.md ../lib/zstd.h
359052d3c12SConrad Meyer	cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@
360052d3c12SConrad Meyer
3610c16b537SWarner Loshzstdgrep.1: zstdgrep.1.md ../lib/zstd.h
3620c16b537SWarner Losh	cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@
3630c16b537SWarner Losh
364zstdless.1: zstdless.1.md ../lib/zstd.h
365	cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@
366
367.PHONY: man
368man: zstd.1 zstdgrep.1 zstdless.1
369
370.PHONY: clean-man
371clean-man:
372	$(RM) zstd.1
373	$(RM) zstdgrep.1
374	$(RM) zstdless.1
375
376.PHONY: preview-man
377preview-man: clean-man man
378	man ./zstd.1
379	man ./zstdgrep.1
380	man ./zstdless.1
381
382
383# Generate .h dependencies automatically
384
385DEPFLAGS = -MT $@ -MMD -MP -MF
386
387$(BUILD_DIR)/%.o : %.c $(BUILD_DIR)/%.d | $(BUILD_DIR)
388	@echo CC $@
389	$(COMPILE.c) $(DEPFLAGS) $(BUILD_DIR)/$*.d $(OUTPUT_OPTION) $<
390
391MKDIR ?= mkdir
392$(BUILD_DIR): ; $(MKDIR) -p $@
393
394DEPFILES := $(ZSTD_OBJ:.o=.d)
395$(DEPFILES):
396
397include $(wildcard $(DEPFILES))
398
399
400
401#-----------------------------------------------------------------------------
402# make install is validated only for Linux, macOS, BSD, Hurd and Solaris targets
403#-----------------------------------------------------------------------------
404ifneq (,$(filter $(UNAME),Linux Darwin GNU/kFreeBSD GNU OpenBSD FreeBSD NetBSD DragonFly SunOS Haiku))
405
406HAVE_COLORNEVER = $(shell echo a | egrep --color=never a > /dev/null 2> /dev/null && echo 1 || echo 0)
407EGREP_OPTIONS ?=
408ifeq ($HAVE_COLORNEVER, 1)
409  EGREP_OPTIONS += --color=never
410endif
411EGREP = egrep $(EGREP_OPTIONS)
412AWK = awk
413
414# Print a two column output of targets and their description. To add a target description, put a
415# comment in the Makefile with the format "## <TARGET>: <DESCRIPTION>".  For example:
416#
417## list: Print all targets and their descriptions (if provided)
418.PHONY: list
419list:
420	TARGETS=$$($(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null \
421		| $(AWK) -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' \
422		| $(EGREP) -v  -e '^[^[:alnum:]]' | sort); \
423	{ \
424	    printf "Target Name\tDescription\n"; \
425	    printf "%0.s-" {1..16}; printf "\t"; printf "%0.s-" {1..40}; printf "\n"; \
426	    for target in $$TARGETS; do \
427	        line=$$($(EGREP) "^##[[:space:]]+$$target:" $(lastword $(MAKEFILE_LIST))); \
428	        description=$$(echo $$line | $(AWK) '{i=index($$0,":"); print substr($$0,i+1)}' | xargs); \
429	        printf "$$target\t$$description\n"; \
430	    done \
431	} | column -t -s $$'\t'
432
433
434DESTDIR     ?=
435# directory variables : GNU conventions prefer lowercase
436# see https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html
437# support both lower and uppercase (BSD), use uppercase in script
438prefix      ?= /usr/local
439PREFIX      ?= $(prefix)
440exec_prefix ?= $(PREFIX)
441bindir      ?= $(exec_prefix)/bin
442BINDIR      ?= $(bindir)
443datarootdir ?= $(PREFIX)/share
444mandir      ?= $(datarootdir)/man
445man1dir     ?= $(mandir)/man1
446
447ifneq (,$(filter $(UNAME),OpenBSD FreeBSD NetBSD DragonFly SunOS))
448  MANDIR  ?= $(PREFIX)/man
449  MAN1DIR ?= $(MANDIR)/man1
450else
451  MAN1DIR ?= $(man1dir)
452endif
453
454ifneq (,$(filter $(UNAME),SunOS))
455  INSTALL ?= ginstall
456else
457  INSTALL ?= install
458endif
459
460INSTALL_PROGRAM ?= $(INSTALL)
461INSTALL_SCRIPT  ?= $(INSTALL_PROGRAM)
462INSTALL_DATA    ?= $(INSTALL) -m 644
463INSTALL_MAN     ?= $(INSTALL_DATA)
464
465.PHONY: install
466install:
467	# generate zstd only if not already present
468	[ -e zstd ] || $(MAKE) zstd-release
469	[ -e $(DESTDIR)$(BINDIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(BINDIR)/
470	[ -e $(DESTDIR)$(MAN1DIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(MAN1DIR)/
471	@echo Installing binaries
472	$(INSTALL_PROGRAM) zstd$(EXT) $(DESTDIR)$(BINDIR)/zstd$(EXT)
473	ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/zstdcat$(EXT)
474	ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/unzstd$(EXT)
475	ln -sf zstd$(EXT) $(DESTDIR)$(BINDIR)/zstdmt$(EXT)
476	$(INSTALL_SCRIPT) zstdless $(DESTDIR)$(BINDIR)/zstdless
477	$(INSTALL_SCRIPT) zstdgrep $(DESTDIR)$(BINDIR)/zstdgrep
478	@echo Installing man pages
479	$(INSTALL_MAN) zstd.1 $(DESTDIR)$(MAN1DIR)/zstd.1
480	ln -sf zstd.1 $(DESTDIR)$(MAN1DIR)/zstdcat.1
481	ln -sf zstd.1 $(DESTDIR)$(MAN1DIR)/unzstd.1
482	$(INSTALL_MAN) zstdgrep.1 $(DESTDIR)$(MAN1DIR)/zstdgrep.1
483	$(INSTALL_MAN) zstdless.1 $(DESTDIR)$(MAN1DIR)/zstdless.1
484	@echo zstd installation completed
485
486.PHONY: uninstall
487uninstall:
488	$(RM) $(DESTDIR)$(BINDIR)/zstdgrep
489	$(RM) $(DESTDIR)$(BINDIR)/zstdless
490	$(RM) $(DESTDIR)$(BINDIR)/zstdcat
491	$(RM) $(DESTDIR)$(BINDIR)/unzstd
492	$(RM) $(DESTDIR)$(BINDIR)/zstdmt
493	$(RM) $(DESTDIR)$(BINDIR)/zstd
494	$(RM) $(DESTDIR)$(MAN1DIR)/zstdless.1
495	$(RM) $(DESTDIR)$(MAN1DIR)/zstdgrep.1
496	$(RM) $(DESTDIR)$(MAN1DIR)/zstdcat.1
497	$(RM) $(DESTDIR)$(MAN1DIR)/unzstd.1
498	$(RM) $(DESTDIR)$(MAN1DIR)/zstd.1
499	@echo zstd programs successfully uninstalled
500
501endif
502