1 # ################################################################
2 # Copyright (c) 2015-present, Yann Collet, Facebook, Inc.
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 # ################################################################
13 ZWRAPDIR = zlibWrapper
15 FUZZDIR = $(TESTDIR)/fuzz
20 ifneq (,$(filter Windows%,$(OS)))
26 ## default: Build lib-release and zstd-release
28 default: lib-release zstd-release
31 all: allmost examples manual contrib
34 allmost: allzstd zlibwrapper
36 # skip zwrapper, can't build that on alternate architectures without the proper zlib installed
39 $(MAKE) -C $(PRGDIR) all
40 $(MAKE) -C $(TESTDIR) all
44 $(MAKE) -C $(PRGDIR) zstd32
45 $(MAKE) -C $(TESTDIR) all32
47 .PHONY: lib lib-release libzstd.a
49 @$(MAKE) -C $(ZSTDDIR) $@
51 .PHONY: zstd zstd-release
53 @$(MAKE) -C $(PRGDIR) $@
54 cp $(PRGDIR)/zstd$(EXT) .
58 @$(MAKE) -C $(PRGDIR) $@
59 cp $(PRGDIR)/zstd$(EXT) ./zstdmt$(EXT)
63 $(MAKE) -C $(ZWRAPDIR) all
65 ## test: run long-duration tests
68 test: MOREFLAGS += -g -DDEBUGLEVEL=$(DEBUGLEVEL) -Werror
70 MOREFLAGS="$(MOREFLAGS)" $(MAKE) -j -C $(PRGDIR) allVariants
71 $(MAKE) -C $(TESTDIR) $@
73 ## shortest: same as `make check`
76 $(MAKE) -C $(TESTDIR) $@
78 ## check: run basic tests for `zstd` cli
82 ## examples: build all examples in `/examples` directory
85 CPPFLAGS=-I../lib LDFLAGS=-L../lib $(MAKE) -C examples/ all
87 ## manual: generate API documentation in html format
90 $(MAKE) -C contrib/gen_html $@
92 ## man: generate man page
95 $(MAKE) -C programs $@
97 ## contrib: build all supported projects in `/contrib` directory
100 $(MAKE) -C contrib/pzstd all
101 $(MAKE) -C contrib/seekable_format/examples all
102 $(MAKE) -C contrib/adaptive-compression all
103 $(MAKE) -C contrib/largeNbDicts all
107 cd contrib; ./cleanTabs
111 @$(MAKE) -C $(ZSTDDIR) $@ > $(VOID)
112 @$(MAKE) -C $(PRGDIR) $@ > $(VOID)
113 @$(MAKE) -C $(TESTDIR) $@ > $(VOID)
114 @$(MAKE) -C $(ZWRAPDIR) $@ > $(VOID)
115 @$(MAKE) -C examples/ $@ > $(VOID)
116 @$(MAKE) -C contrib/gen_html $@ > $(VOID)
117 @$(MAKE) -C contrib/pzstd $@ > $(VOID)
118 @$(MAKE) -C contrib/seekable_format/examples $@ > $(VOID)
119 @$(MAKE) -C contrib/adaptive-compression $@ > $(VOID)
120 @$(MAKE) -C contrib/largeNbDicts $@ > $(VOID)
121 @$(RM) zstd$(EXT) zstdmt$(EXT) tmp*
123 @echo Cleaning completed
125 #------------------------------------------------------------------------------
126 # make install is validated only for Linux, macOS, Hurd and some BSD targets
127 #------------------------------------------------------------------------------
128 ifneq (,$(filter $(shell uname),Linux Darwin GNU/kFreeBSD GNU OpenBSD FreeBSD DragonFly NetBSD MSYS_NT Haiku))
131 CMAKE_PARAMS = -DZSTD_BUILD_CONTRIB:BOOL=ON -DZSTD_BUILD_STATIC:BOOL=ON -DZSTD_BUILD_TESTS:BOOL=ON -DZSTD_ZLIB_SUPPORT:BOOL=ON -DZSTD_LZMA_SUPPORT:BOOL=ON -DCMAKE_BUILD_TYPE=Release
133 HAVE_COLORNEVER = $(shell echo a | egrep --color=never a > /dev/null 2> /dev/null && echo 1 || echo 0)
135 ifeq ($HAVE_COLORNEVER, 1)
136 EGREP_OPTIONS += --color=never
138 EGREP = egrep $(EGREP_OPTIONS)
140 # Print a two column output of targets and their description. To add a target description, put a
141 # comment in the Makefile with the format "## <TARGET>: <DESCRIPTION>". For example:
143 ## list: Print all targets and their descriptions (if provided)
146 @TARGETS=$$($(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null \
147 | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' \
148 | $(EGREP) -v -e '^[^[:alnum:]]' | sort); \
150 printf "Target Name\tDescription\n"; \
151 printf "%0.s-" {1..16}; printf "\t"; printf "%0.s-" {1..40}; printf "\n"; \
152 for target in $$TARGETS; do \
153 line=$$($(EGREP) "^##[[:space:]]+$$target:" $(lastword $(MAKEFILE_LIST))); \
154 description=$$(echo $$line | awk '{i=index($$0,":"); print substr($$0,i+1)}' | xargs); \
155 printf "$$target\t$$description\n"; \
157 } | column -t -s $$'\t'
159 .PHONY: install armtest usan asan uasan
161 @$(MAKE) -C $(ZSTDDIR) $@
162 @$(MAKE) -C $(PRGDIR) $@
166 @$(MAKE) -C $(ZSTDDIR) $@
167 @$(MAKE) -C $(PRGDIR) $@
169 .PHONY: travis-install
171 $(MAKE) install PREFIX=~/install_test_dir
176 CC=gcc-5 $(MAKE) all MOREFLAGS="-Werror"
181 CC=gcc-6 $(MAKE) all MOREFLAGS="-Werror"
186 CC=gcc-7 $(MAKE) all MOREFLAGS="-Werror"
191 CXX=clang++ CC=clang CFLAGS="-Werror -Wconversion -Wno-sign-conversion -Wdocumentation" $(MAKE) all
198 CC=arm-linux-gnueabi-gcc CFLAGS="-Werror" $(MAKE) allzstd
201 CC=aarch64-linux-gnu-gcc CFLAGS="-Werror" $(MAKE) allzstd
204 CC=powerpc-linux-gnu-gcc CFLAGS="-m32 -Wno-attributes -Werror" $(MAKE) allzstd
207 CC=powerpc-linux-gnu-gcc CFLAGS="-m64 -Werror" $(MAKE) allzstd
210 CC=arm-linux-gnueabi-gcc QEMU_SYS=qemu-arm-static MOREFLAGS="-static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest
214 CC=aarch64-linux-gnu-gcc QEMU_SYS=qemu-aarch64-static MOREFLAGS="-static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest
217 CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc-static MOREFLAGS="-static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest
220 CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc64-static MOREFLAGS="-m64 -static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest
223 cxxtest: CXXFLAGS += -Wall -Wextra -Wundef -Wshadow -Wcast-align -Werror
225 $(MAKE) -C $(PRGDIR) all CC="$(CXX) -Wno-deprecated" CFLAGS="$(CXXFLAGS)" # adding -Wno-deprecated to avoid clang++ warning on dealing with C files directly
229 $(MAKE) all CC=gcc-5 MOREFLAGS="-Werror"
233 $(MAKE) all CC=gcc-6 MOREFLAGS="-Werror"
236 $(MAKE) -C $(TESTDIR) datagen # use native, faster
237 $(MAKE) -C $(TESTDIR) test CC=arm-linux-gnueabi-gcc QEMU_SYS=qemu-arm-static ZSTDRTTEST= MOREFLAGS="-Werror -static" FUZZER_FLAGS=--no-big-tests
240 $(MAKE) -C $(TESTDIR) datagen # use native, faster
241 $(MAKE) -C $(TESTDIR) test CC=aarch64-linux-gnu-gcc QEMU_SYS=qemu-aarch64-static ZSTDRTTEST= MOREFLAGS="-Werror -static" FUZZER_FLAGS=--no-big-tests
244 $(MAKE) -C $(TESTDIR) datagen # use native, faster
245 $(MAKE) -C $(TESTDIR) test CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc-static ZSTDRTTEST= MOREFLAGS="-Werror -Wno-attributes -static" FUZZER_FLAGS=--no-big-tests
248 $(MAKE) -C $(TESTDIR) datagen # use native, faster
249 $(MAKE) -C $(TESTDIR) test CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc64-static ZSTDRTTEST= MOREFLAGS="-m64 -static" FUZZER_FLAGS=--no-big-tests
252 $(MAKE) -C $(PRGDIR) clean zstd CC=arm-linux-gnueabi-gcc QEMU_SYS=qemu-arm-static ZSTDRTTEST= MOREFLAGS="-Werror -static"
253 $(MAKE) -C $(PRGDIR) clean zstd CC=aarch64-linux-gnu-gcc QEMU_SYS=qemu-aarch64-static ZSTDRTTEST= MOREFLAGS="-Werror -static"
254 $(MAKE) -C $(PRGDIR) clean zstd CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc-static ZSTDRTTEST= MOREFLAGS="-Werror -Wno-attributes -static"
255 $(MAKE) -C $(PRGDIR) clean zstd CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc64-static ZSTDRTTEST= MOREFLAGS="-m64 -static"
258 $(MAKE) -C $(FUZZDIR) regressiontest
261 $(MAKE) -C $(FUZZDIR) regressiontest CC=clang CXX=clang++ CFLAGS="-O3 -fsanitize=address,undefined" CXXFLAGS="-O3 -fsanitize=address,undefined"
264 $(MAKE) -C $(FUZZDIR) regressiontest CC=clang CXX=clang++ CFLAGS="-O3 -fsanitize=memory" CXXFLAGS="-O3 -fsanitize=memory"
266 # run UBsan with -fsanitize-recover=signed-integer-overflow
267 # due to a bug in UBsan when doing pointer subtraction
268 # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=63303
271 $(MAKE) test CC=clang MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize-recover=signed-integer-overflow -fsanitize=undefined -Werror"
274 $(MAKE) test CC=clang MOREFLAGS="-g -fsanitize=address -Werror"
277 LDFLAGS=-fuse-ld=gold MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize=address -Werror" $(MAKE) -C $(TESTDIR) $*
280 $(MAKE) test CC=clang MOREFLAGS="-g -fsanitize=memory -fno-omit-frame-pointer -Werror" HAVE_LZMA=0 # datagen.c fails this test for no obvious reason
283 LDFLAGS=-fuse-ld=gold MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize=memory -fno-omit-frame-pointer -Werror" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) HAVE_LZMA=0 $*
286 $(MAKE) -C $(TESTDIR) test32 CC=clang MOREFLAGS="-g -fsanitize=address"
289 $(MAKE) test CC=clang MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize-recover=signed-integer-overflow -fsanitize=address,undefined -Werror"
292 LDFLAGS=-fuse-ld=gold MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize-recover=signed-integer-overflow -fsanitize=address,undefined -Werror" $(MAKE) -C $(TESTDIR) $*
295 LDFLAGS=-fuse-ld=gold MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize=thread -Werror" $(MAKE) -C $(TESTDIR) $* FUZZER_FLAGS=--no-big-tests
298 sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install $(APT_PACKAGES)
301 sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
302 sudo apt-get update -y -qq
305 APT_PACKAGES="qemu-system-ppc qemu-user-static gcc-powerpc-linux-gnu" $(MAKE) apt-install
308 APT_PACKAGES="qemu-system-arm qemu-user-static gcc-arm-linux-gnueabi libc6-dev-armel-cross gcc-aarch64-linux-gnu libc6-dev-arm64-cross" $(MAKE) apt-install
311 APT_PACKAGES="valgrind" $(MAKE) apt-install
314 APT_PACKAGES="libc6-dev-i386 gcc-multilib" $(MAKE) apt-install
316 gcc6install: apt-add-repo
317 APT_PACKAGES="libc6-dev-i386 gcc-multilib gcc-6 gcc-6-multilib" $(MAKE) apt-install
319 gcc7install: apt-add-repo
320 APT_PACKAGES="libc6-dev-i386 gcc-multilib gcc-7 gcc-7-multilib" $(MAKE) apt-install
322 gcc8install: apt-add-repo
323 APT_PACKAGES="libc6-dev-i386 gcc-multilib gcc-8 gcc-8-multilib" $(MAKE) apt-install
325 gpp6install: apt-add-repo
326 APT_PACKAGES="libc6-dev-i386 g++-multilib gcc-6 g++-6 g++-6-multilib" $(MAKE) apt-install
329 APT_PACKAGES="clang-3.8" $(MAKE) apt-install
331 # Ubuntu 14.04 ships a too-old lz4
333 [ -e lz4 ] || git clone https://github.com/lz4/lz4 && sudo $(MAKE) -C lz4 install
338 ifneq (,$(filter MSYS%,$(shell uname)))
340 CMAKE_PARAMS = -G"MSYS Makefiles" -DZSTD_MULTITHREAD_SUPPORT:BOOL=OFF -DZSTD_BUILD_STATIC:BOOL=ON -DZSTD_BUILD_TESTS:BOOL=ON
344 #------------------------------------------------------------------------
345 # target specific tests
346 #------------------------------------------------------------------------
347 ifneq (,$(filter $(HOST_OS),MSYS POSIX))
350 $(RM) -r $(BUILDIR)/cmake/build
351 mkdir $(BUILDIR)/cmake/build
352 cd $(BUILDIR)/cmake/build ; cmake -DCMAKE_INSTALL_PREFIX:PATH=~/install_test_dir $(CMAKE_PARAMS) .. ; $(MAKE) install ; $(MAKE) uninstall
356 CFLAGS="-std=c90 -Werror" $(MAKE) allmost # will fail, due to missing support for `long long`
360 CFLAGS="-std=gnu90 -Werror" $(MAKE) allmost
364 CFLAGS="-std=c99 -Werror" $(MAKE) allmost
368 CFLAGS="-std=gnu99 -Werror" $(MAKE) allmost
372 CFLAGS="-std=c11 -Werror" $(MAKE) allmost
376 CFLAGS="-O3 -mbmi -Werror" $(MAKE) -C $(TESTDIR) test
380 CFLAGS="-O3 -mbmi -mx32 -Werror" $(MAKE) -C $(TESTDIR) test
384 CFLAGS="-O3 -mbmi -m32 -Werror" $(MAKE) -C $(TESTDIR) test
386 # static analyzer test uses clang's scan-build
387 # does not analyze zlibWrapper, due to detected issues in zlib source code
388 staticAnalyze: SCANBUILD ?= scan-build
391 CC=$(CC) CPPFLAGS=-g $(SCANBUILD) --status-bugs -v $(MAKE) allzstd examples contrib