1 # ################################################################
2 # Copyright (c) 2015-2020, 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 # You may select, at your option, one of the above-listed licenses.
9 # ################################################################
14 ZWRAPDIR = zlibWrapper
16 FUZZDIR = $(TESTDIR)/fuzz
21 # When cross-compiling from linux to windows, you might
22 # need to specify this as "Windows." Fedora build fails
25 # Note: mingw-w64 build from linux to windows does not
26 # fail on other tested distros (ubuntu, debian) even
27 # without manually specifying the TARGET_SYSTEM.
28 TARGET_SYSTEM ?= $(OS)
30 ifneq (,$(filter Windows%,$(TARGET_SYSTEM)))
36 ## default: Build lib-release and zstd-release
38 default: lib-release zstd-release
41 all: allmost examples manual contrib
44 allmost: allzstd zlibwrapper
46 # skip zwrapper, can't build that on alternate architectures without the proper zlib installed
49 $(MAKE) -C $(PRGDIR) all
50 $(MAKE) -C $(TESTDIR) all
54 $(MAKE) -C $(PRGDIR) zstd32
55 $(MAKE) -C $(TESTDIR) all32
57 .PHONY: lib lib-release libzstd.a
58 lib lib-release lib-all :
59 @$(MAKE) -C $(ZSTDDIR) $@
61 .PHONY: zstd zstd-release
63 @$(MAKE) -C $(PRGDIR) $@
64 cp $(PRGDIR)/zstd$(EXT) .
68 @$(MAKE) -C $(PRGDIR) $@
69 cp $(PRGDIR)/zstd$(EXT) ./zstdmt$(EXT)
73 $(MAKE) -C $(ZWRAPDIR) all
75 ## test: run long-duration tests
78 test: MOREFLAGS += -g -DDEBUGLEVEL=$(DEBUGLEVEL) -Werror
80 MOREFLAGS="$(MOREFLAGS)" $(MAKE) -j -C $(PRGDIR) allVariants
81 $(MAKE) -C $(TESTDIR) $@
82 ZSTD=../../programs/zstd $(MAKE) -C doc/educational_decoder test
84 ## shortest: same as `make check`
87 $(MAKE) -C $(TESTDIR) $@
89 ## check: run basic tests for `zstd` cli
93 .PHONY: automated_benchmarking
94 automated_benchmarking:
95 $(MAKE) -C $(TESTDIR) $@
98 benchmarking: automated_benchmarking
100 ## examples: build all examples in `/examples` directory
103 CPPFLAGS=-I../lib LDFLAGS=-L../lib $(MAKE) -C examples/ all
105 ## manual: generate API documentation in html format
108 $(MAKE) -C contrib/gen_html $@
110 ## man: generate man page
113 $(MAKE) -C programs $@
115 ## contrib: build all supported projects in `/contrib` directory
118 $(MAKE) -C contrib/pzstd all
119 $(MAKE) -C contrib/seekable_format/examples all
120 $(MAKE) -C contrib/largeNbDicts all
121 cd contrib/single_file_libs/ ; ./build_decoder_test.sh
122 cd contrib/single_file_libs/ ; ./build_library_test.sh
126 cd contrib; ./cleanTabs
130 @$(MAKE) -C $(ZSTDDIR) $@ > $(VOID)
131 @$(MAKE) -C $(PRGDIR) $@ > $(VOID)
132 @$(MAKE) -C $(TESTDIR) $@ > $(VOID)
133 @$(MAKE) -C $(ZWRAPDIR) $@ > $(VOID)
134 @$(MAKE) -C examples/ $@ > $(VOID)
135 @$(MAKE) -C contrib/gen_html $@ > $(VOID)
136 @$(MAKE) -C contrib/pzstd $@ > $(VOID)
137 @$(MAKE) -C contrib/seekable_format/examples $@ > $(VOID)
138 @$(MAKE) -C contrib/largeNbDicts $@ > $(VOID)
139 @$(RM) zstd$(EXT) zstdmt$(EXT) tmp*
141 @echo Cleaning completed
143 #------------------------------------------------------------------------------
144 # make install is validated only for Linux, macOS, Hurd and some BSD targets
145 #------------------------------------------------------------------------------
146 ifneq (,$(filter $(shell uname),Linux Darwin GNU/kFreeBSD GNU OpenBSD FreeBSD DragonFly NetBSD MSYS_NT Haiku))
149 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
151 HAVE_COLORNEVER = $(shell echo a | egrep --color=never a > /dev/null 2> /dev/null && echo 1 || echo 0)
153 ifeq ($HAVE_COLORNEVER, 1)
154 EGREP_OPTIONS += --color=never
156 EGREP = egrep $(EGREP_OPTIONS)
158 # Print a two column output of targets and their description. To add a target description, put a
159 # comment in the Makefile with the format "## <TARGET>: <DESCRIPTION>". For example:
161 ## list: Print all targets and their descriptions (if provided)
164 @TARGETS=$$($(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null \
165 | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' \
166 | $(EGREP) -v -e '^[^[:alnum:]]' | sort); \
168 printf "Target Name\tDescription\n"; \
169 printf "%0.s-" {1..16}; printf "\t"; printf "%0.s-" {1..40}; printf "\n"; \
170 for target in $$TARGETS; do \
171 line=$$($(EGREP) "^##[[:space:]]+$$target:" $(lastword $(MAKEFILE_LIST))); \
172 description=$$(echo $$line | awk '{i=index($$0,":"); print substr($$0,i+1)}' | xargs); \
173 printf "$$target\t$$description\n"; \
175 } | column -t -s $$'\t'
177 .PHONY: install armtest usan asan uasan
179 @$(MAKE) -C $(ZSTDDIR) $@
180 @$(MAKE) -C $(PRGDIR) $@
184 @$(MAKE) -C $(ZSTDDIR) $@
185 @$(MAKE) -C $(PRGDIR) $@
187 .PHONY: travis-install
189 $(MAKE) install PREFIX=~/install_test_dir
194 CC=gcc-5 $(MAKE) all MOREFLAGS="-Werror"
199 CC=gcc-6 $(MAKE) all MOREFLAGS="-Werror"
204 CC=gcc-7 $(MAKE) all MOREFLAGS="-Werror"
209 CXX=clang++ CC=clang CFLAGS="-Werror -Wconversion -Wno-sign-conversion -Wdocumentation" $(MAKE) all
216 CC=arm-linux-gnueabi-gcc CFLAGS="-Werror" $(MAKE) allzstd
219 CC=aarch64-linux-gnu-gcc CFLAGS="-Werror" $(MAKE) allzstd
222 CC=powerpc-linux-gnu-gcc CFLAGS="-m32 -Wno-attributes -Werror" $(MAKE) allzstd
225 CC=powerpc-linux-gnu-gcc CFLAGS="-m64 -Werror" $(MAKE) allzstd
228 CC=arm-linux-gnueabi-gcc QEMU_SYS=qemu-arm-static MOREFLAGS="-static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest
232 CC=aarch64-linux-gnu-gcc QEMU_SYS=qemu-aarch64-static MOREFLAGS="-static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest
235 CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc-static MOREFLAGS="-static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest
238 CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc64-static MOREFLAGS="-m64 -static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest
241 cxxtest: CXXFLAGS += -Wall -Wextra -Wundef -Wshadow -Wcast-align -Werror
243 $(MAKE) -C $(PRGDIR) all CC="$(CXX) -Wno-deprecated" CFLAGS="$(CXXFLAGS)" # adding -Wno-deprecated to avoid clang++ warning on dealing with C files directly
247 $(MAKE) all CC=gcc-5 MOREFLAGS="-Werror"
251 $(MAKE) all CC=gcc-6 MOREFLAGS="-Werror"
254 $(MAKE) -C $(TESTDIR) datagen # use native, faster
255 $(MAKE) -C $(TESTDIR) test CC=arm-linux-gnueabi-gcc QEMU_SYS=qemu-arm-static ZSTDRTTEST= MOREFLAGS="-Werror -static" FUZZER_FLAGS=--no-big-tests
258 $(MAKE) -C $(TESTDIR) datagen # use native, faster
259 $(MAKE) -C $(TESTDIR) test CC=aarch64-linux-gnu-gcc QEMU_SYS=qemu-aarch64-static ZSTDRTTEST= MOREFLAGS="-Werror -static" FUZZER_FLAGS=--no-big-tests
262 $(MAKE) -C $(TESTDIR) datagen # use native, faster
263 $(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
266 $(MAKE) -C $(TESTDIR) datagen # use native, faster
267 $(MAKE) -C $(TESTDIR) test CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc64-static ZSTDRTTEST= MOREFLAGS="-m64 -static" FUZZER_FLAGS=--no-big-tests
270 $(MAKE) -C $(PRGDIR) clean zstd CC=arm-linux-gnueabi-gcc QEMU_SYS=qemu-arm-static ZSTDRTTEST= MOREFLAGS="-Werror -static"
271 $(MAKE) -C $(PRGDIR) clean zstd CC=aarch64-linux-gnu-gcc QEMU_SYS=qemu-aarch64-static ZSTDRTTEST= MOREFLAGS="-Werror -static"
272 $(MAKE) -C $(PRGDIR) clean zstd CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc-static ZSTDRTTEST= MOREFLAGS="-Werror -Wno-attributes -static"
273 $(MAKE) -C $(PRGDIR) clean zstd CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc64-static ZSTDRTTEST= MOREFLAGS="-m64 -static"
276 $(MAKE) -C $(FUZZDIR) regressiontest
279 $(MAKE) -C $(FUZZDIR) regressiontest CC=clang CXX=clang++ CFLAGS="-O3 -fsanitize=address,undefined" CXXFLAGS="-O3 -fsanitize=address,undefined"
282 $(MAKE) -C $(FUZZDIR) regressiontest CC=clang CXX=clang++ CFLAGS="-O3 -fsanitize=memory" CXXFLAGS="-O3 -fsanitize=memory"
284 # run UBsan with -fsanitize-recover=signed-integer-overflow
285 # due to a bug in UBsan when doing pointer subtraction
286 # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=63303
289 $(MAKE) test CC=clang MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize-recover=signed-integer-overflow -fsanitize=undefined -Werror"
292 $(MAKE) test CC=clang MOREFLAGS="-g -fsanitize=address -Werror"
295 LDFLAGS=-fuse-ld=gold MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize=address -Werror" $(MAKE) -C $(TESTDIR) $*
298 $(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
301 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 $*
304 $(MAKE) -C $(TESTDIR) test32 CC=clang MOREFLAGS="-g -fsanitize=address"
307 $(MAKE) test CC=clang MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize-recover=signed-integer-overflow -fsanitize=address,undefined -Werror"
310 LDFLAGS=-fuse-ld=gold MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize-recover=signed-integer-overflow -fsanitize=address,undefined -Werror" $(MAKE) -C $(TESTDIR) $*
313 LDFLAGS=-fuse-ld=gold MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize=thread -Werror" $(MAKE) -C $(TESTDIR) $* FUZZER_FLAGS=--no-big-tests
316 sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install $(APT_PACKAGES)
319 sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
320 sudo apt-get update -y -qq
323 APT_PACKAGES="qemu-system-ppc qemu-user-static gcc-powerpc-linux-gnu" $(MAKE) apt-install
326 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
329 APT_PACKAGES="valgrind" $(MAKE) apt-install
332 APT_PACKAGES="libc6-dev-i386 gcc-multilib" $(MAKE) apt-install
334 gcc6install: apt-add-repo
335 APT_PACKAGES="libc6-dev-i386 gcc-multilib gcc-6 gcc-6-multilib" $(MAKE) apt-install
337 gcc7install: apt-add-repo
338 APT_PACKAGES="libc6-dev-i386 gcc-multilib gcc-7 gcc-7-multilib" $(MAKE) apt-install
340 gcc8install: apt-add-repo
341 APT_PACKAGES="libc6-dev-i386 gcc-multilib gcc-8 gcc-8-multilib" $(MAKE) apt-install
343 gpp6install: apt-add-repo
344 APT_PACKAGES="libc6-dev-i386 g++-multilib gcc-6 g++-6 g++-6-multilib" $(MAKE) apt-install
347 APT_PACKAGES="clang-3.8" $(MAKE) apt-install
349 # Ubuntu 14.04 ships a too-old lz4
351 [ -e lz4 ] || git clone https://github.com/lz4/lz4 && sudo $(MAKE) -C lz4 install
356 ifneq (,$(filter MSYS%,$(shell uname)))
358 CMAKE_PARAMS = -G"MSYS Makefiles" -DCMAKE_BUILD_TYPE=Debug -DZSTD_MULTITHREAD_SUPPORT:BOOL=OFF -DZSTD_BUILD_STATIC:BOOL=ON -DZSTD_BUILD_TESTS:BOOL=ON
362 #------------------------------------------------------------------------
363 # target specific tests
364 #------------------------------------------------------------------------
365 ifneq (,$(filter $(HOST_OS),MSYS POSIX))
368 $(RM) -r $(BUILDIR)/cmake/build
369 mkdir $(BUILDIR)/cmake/build
370 cd $(BUILDIR)/cmake/build; cmake -DCMAKE_INSTALL_PREFIX:PATH=~/install_test_dir $(CMAKE_PARAMS) ..
371 $(MAKE) -C $(BUILDIR)/cmake/build -j4;
372 $(MAKE) -C $(BUILDIR)/cmake/build install;
373 $(MAKE) -C $(BUILDIR)/cmake/build uninstall;
374 cd $(BUILDIR)/cmake/build; ctest -V -L Medium
378 CFLAGS="-std=c89 -Werror" $(MAKE) allmost # will fail, due to missing support for `long long`
382 CFLAGS="-std=gnu90 -Werror" $(MAKE) allmost
386 CFLAGS="-std=c99 -Werror" $(MAKE) allmost
390 CFLAGS="-std=gnu99 -Werror" $(MAKE) allmost
394 CFLAGS="-std=c11 -Werror" $(MAKE) allmost
398 CFLAGS="-O3 -mbmi -Werror" $(MAKE) -C $(TESTDIR) test
402 CFLAGS="-O3 -mbmi -mx32 -Werror" $(MAKE) -C $(TESTDIR) test
406 CFLAGS="-O3 -mbmi -m32 -Werror" $(MAKE) -C $(TESTDIR) test
408 # static analyzer test uses clang's scan-build
409 # does not analyze zlibWrapper, due to detected issues in zlib source code
410 staticAnalyze: SCANBUILD ?= scan-build
413 CC=$(CC) CPPFLAGS=-g $(SCANBUILD) --status-bugs -v $(MAKE) allzstd examples contrib