1# ################################################################ 2# Copyright (c) 2015-2021, 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 11# verbose mode (print commands) on V=1 or VERBOSE=1 12Q = $(if $(filter 1,$(V) $(VERBOSE)),,@) 13 14PRGDIR = programs 15ZSTDDIR = lib 16BUILDIR = build 17ZWRAPDIR = zlibWrapper 18TESTDIR = tests 19FUZZDIR = $(TESTDIR)/fuzz 20 21# Define nul output 22VOID = /dev/null 23 24# When cross-compiling from linux to windows, you might 25# need to specify this as "Windows." Fedora build fails 26# without it. 27# 28# Note: mingw-w64 build from linux to windows does not 29# fail on other tested distros (ubuntu, debian) even 30# without manually specifying the TARGET_SYSTEM. 31TARGET_SYSTEM ?= $(OS) 32 33ifneq (,$(filter Windows%,$(TARGET_SYSTEM))) 34 EXT =.exe 35else 36 EXT = 37endif 38 39## default: Build lib-release and zstd-release 40.PHONY: default 41default: lib-release zstd-release 42 43.PHONY: all 44all: allmost examples manual contrib 45 46.PHONY: allmost 47allmost: allzstd zlibwrapper 48 49# skip zwrapper, can't build that on alternate architectures without the proper zlib installed 50.PHONY: allzstd 51allzstd: lib 52 $(Q)$(MAKE) -C $(PRGDIR) all 53 $(Q)$(MAKE) -C $(TESTDIR) all 54 55.PHONY: all32 56all32: 57 $(MAKE) -C $(PRGDIR) zstd32 58 $(MAKE) -C $(TESTDIR) all32 59 60.PHONY: lib lib-release lib-mt lib-nomt 61lib lib-release lib-mt lib-nomt: 62 $(Q)$(MAKE) -C $(ZSTDDIR) $@ 63 64.PHONY: zstd zstd-release 65zstd zstd-release: 66 $(Q)$(MAKE) -C $(PRGDIR) $@ 67 $(Q)ln -sf $(PRGDIR)/zstd$(EXT) zstd$(EXT) 68 69.PHONY: zstdmt 70zstdmt: 71 $(Q)$(MAKE) -C $(PRGDIR) $@ 72 $(Q)cp $(PRGDIR)/zstd$(EXT) ./zstdmt$(EXT) 73 74.PHONY: zlibwrapper 75zlibwrapper: lib 76 $(MAKE) -C $(ZWRAPDIR) all 77 78## test: run long-duration tests 79.PHONY: test 80DEBUGLEVEL ?= 1 81test: MOREFLAGS += -g -Werror 82test: 83 DEBUGLEVEL=$(DEBUGLEVEL) MOREFLAGS="$(MOREFLAGS)" $(MAKE) -j -C $(PRGDIR) allVariants 84 $(MAKE) -C $(TESTDIR) $@ 85 ZSTD=../../programs/zstd $(MAKE) -C doc/educational_decoder $@ 86 87## shortest: same as `make check` 88.PHONY: shortest 89shortest: 90 $(Q)$(MAKE) -C $(TESTDIR) $@ 91 92## check: run basic tests for `zstd` cli 93.PHONY: check 94check: shortest 95 96.PHONY: automated_benchmarking 97automated_benchmarking: 98 $(MAKE) -C $(TESTDIR) $@ 99 100.PHONY: benchmarking 101benchmarking: automated_benchmarking 102 103## examples: build all examples in `examples/` directory 104.PHONY: examples 105examples: lib 106 $(MAKE) -C examples all 107 108## manual: generate API documentation in html format 109.PHONY: manual 110manual: 111 $(MAKE) -C contrib/gen_html $@ 112 113## man: generate man page 114.PHONY: man 115man: 116 $(MAKE) -C programs $@ 117 118## contrib: build all supported projects in `/contrib` directory 119.PHONY: contrib 120contrib: lib 121 $(MAKE) -C contrib/pzstd all 122 $(MAKE) -C contrib/seekable_format/examples all 123 $(MAKE) -C contrib/seekable_format/tests test 124 $(MAKE) -C contrib/largeNbDicts all 125 cd build/single_file_libs/ ; ./build_decoder_test.sh 126 cd build/single_file_libs/ ; ./build_library_test.sh 127 128.PHONY: cleanTabs 129cleanTabs: 130 cd contrib; ./cleanTabs 131 132.PHONY: clean 133clean: 134 $(Q)$(MAKE) -C $(ZSTDDIR) $@ > $(VOID) 135 $(Q)$(MAKE) -C $(PRGDIR) $@ > $(VOID) 136 $(Q)$(MAKE) -C $(TESTDIR) $@ > $(VOID) 137 $(Q)$(MAKE) -C $(ZWRAPDIR) $@ > $(VOID) 138 $(Q)$(MAKE) -C examples/ $@ > $(VOID) 139 $(Q)$(MAKE) -C contrib/gen_html $@ > $(VOID) 140 $(Q)$(MAKE) -C contrib/pzstd $@ > $(VOID) 141 $(Q)$(MAKE) -C contrib/seekable_format/examples $@ > $(VOID) 142 $(Q)$(MAKE) -C contrib/seekable_format/tests $@ > $(VOID) 143 $(Q)$(MAKE) -C contrib/largeNbDicts $@ > $(VOID) 144 $(Q)$(RM) zstd$(EXT) zstdmt$(EXT) tmp* 145 $(Q)$(RM) -r lz4 146 @echo Cleaning completed 147 148#------------------------------------------------------------------------------ 149# make install is validated only for Linux, macOS, Hurd and some BSD targets 150#------------------------------------------------------------------------------ 151ifneq (,$(filter $(shell uname),Linux Darwin GNU/kFreeBSD GNU OpenBSD FreeBSD DragonFly NetBSD MSYS_NT Haiku)) 152 153HOST_OS = POSIX 154 155HAVE_COLORNEVER = $(shell echo a | egrep --color=never a > /dev/null 2> /dev/null && echo 1 || echo 0) 156EGREP_OPTIONS ?= 157ifeq ($HAVE_COLORNEVER, 1) 158EGREP_OPTIONS += --color=never 159endif 160EGREP = egrep $(EGREP_OPTIONS) 161 162# Print a two column output of targets and their description. To add a target description, put a 163# comment in the Makefile with the format "## <TARGET>: <DESCRIPTION>". For example: 164# 165## list: Print all targets and their descriptions (if provided) 166.PHONY: list 167list: 168 $(Q)TARGETS=$$($(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null \ 169 | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' \ 170 | $(EGREP) -v -e '^[^[:alnum:]]' | sort); \ 171 { \ 172 printf "Target Name\tDescription\n"; \ 173 printf "%0.s-" {1..16}; printf "\t"; printf "%0.s-" {1..40}; printf "\n"; \ 174 for target in $$TARGETS; do \ 175 line=$$($(EGREP) "^##[[:space:]]+$$target:" $(lastword $(MAKEFILE_LIST))); \ 176 description=$$(echo $$line | awk '{i=index($$0,":"); print substr($$0,i+1)}' | xargs); \ 177 printf "$$target\t$$description\n"; \ 178 done \ 179 } | column -t -s $$'\t' 180 181.PHONY: install armtest usan asan uasan msan asan32 182install: 183 $(Q)$(MAKE) -C $(ZSTDDIR) $@ 184 $(Q)$(MAKE) -C $(PRGDIR) $@ 185 186.PHONY: uninstall 187uninstall: 188 $(Q)$(MAKE) -C $(ZSTDDIR) $@ 189 $(Q)$(MAKE) -C $(PRGDIR) $@ 190 191.PHONY: travis-install 192travis-install: 193 $(MAKE) install PREFIX=~/install_test_dir 194 195.PHONY: gcc5build gcc6build gcc7build clangbuild m32build armbuild aarch64build ppcbuild ppc64build 196gcc5build: clean 197 gcc-5 -v 198 CC=gcc-5 $(MAKE) all MOREFLAGS="-Werror" 199 200gcc6build: clean 201 gcc-6 -v 202 CC=gcc-6 $(MAKE) all MOREFLAGS="-Werror" 203 204gcc7build: clean 205 gcc-7 -v 206 CC=gcc-7 $(MAKE) all MOREFLAGS="-Werror" 207 208clangbuild: clean 209 clang -v 210 CXX=clang++ CC=clang CFLAGS="-Werror -Wconversion -Wno-sign-conversion -Wdocumentation" $(MAKE) all 211 212m32build: clean 213 gcc -v 214 $(MAKE) all32 215 216armbuild: clean 217 CC=arm-linux-gnueabi-gcc CFLAGS="-Werror" $(MAKE) allzstd 218 219aarch64build: clean 220 CC=aarch64-linux-gnu-gcc CFLAGS="-Werror" $(MAKE) allzstd 221 222ppcbuild: clean 223 CC=powerpc-linux-gnu-gcc CFLAGS="-m32 -Wno-attributes -Werror" $(MAKE) -j allzstd 224 225ppc64build: clean 226 CC=powerpc-linux-gnu-gcc CFLAGS="-m64 -Werror" $(MAKE) -j allzstd 227 228.PHONY: armfuzz aarch64fuzz ppcfuzz ppc64fuzz 229armfuzz: clean 230 CC=arm-linux-gnueabi-gcc QEMU_SYS=qemu-arm-static MOREFLAGS="-static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest 231 232aarch64fuzz: clean 233 ld -v 234 CC=aarch64-linux-gnu-gcc QEMU_SYS=qemu-aarch64-static MOREFLAGS="-static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest 235 236ppcfuzz: clean 237 CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc-static MOREFLAGS="-static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest 238 239ppc64fuzz: clean 240 CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc64-static MOREFLAGS="-m64 -static" FUZZER_FLAGS=--no-big-tests $(MAKE) -C $(TESTDIR) fuzztest 241 242.PHONY: cxxtest gcc5test gcc6test armtest aarch64test ppctest ppc64test 243cxxtest: CXXFLAGS += -Wall -Wextra -Wundef -Wshadow -Wcast-align -Werror 244cxxtest: clean 245 $(MAKE) -C $(PRGDIR) all CC="$(CXX) -Wno-deprecated" CFLAGS="$(CXXFLAGS)" # adding -Wno-deprecated to avoid clang++ warning on dealing with C files directly 246 247gcc5test: clean 248 gcc-5 -v 249 $(MAKE) all CC=gcc-5 MOREFLAGS="-Werror" 250 251gcc6test: clean 252 gcc-6 -v 253 $(MAKE) all CC=gcc-6 MOREFLAGS="-Werror" 254 255armtest: clean 256 $(MAKE) -C $(TESTDIR) datagen # use native, faster 257 $(MAKE) -C $(TESTDIR) test CC=arm-linux-gnueabi-gcc QEMU_SYS=qemu-arm-static ZSTDRTTEST= MOREFLAGS="-Werror -static" FUZZER_FLAGS=--no-big-tests 258 259aarch64test: 260 $(MAKE) -C $(TESTDIR) datagen # use native, faster 261 $(MAKE) -C $(TESTDIR) test CC=aarch64-linux-gnu-gcc QEMU_SYS=qemu-aarch64-static ZSTDRTTEST= MOREFLAGS="-Werror -static" FUZZER_FLAGS=--no-big-tests 262 263ppctest: clean 264 $(MAKE) -C $(TESTDIR) datagen # use native, faster 265 $(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 267ppc64test: clean 268 $(MAKE) -C $(TESTDIR) datagen # use native, faster 269 $(MAKE) -C $(TESTDIR) test CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc64-static ZSTDRTTEST= MOREFLAGS="-m64 -static" FUZZER_FLAGS=--no-big-tests 270 271.PHONY: arm-ppc-compilation 272arm-ppc-compilation: 273 $(MAKE) -C $(PRGDIR) clean zstd CC=arm-linux-gnueabi-gcc QEMU_SYS=qemu-arm-static ZSTDRTTEST= MOREFLAGS="-Werror -static" 274 $(MAKE) -C $(PRGDIR) clean zstd CC=aarch64-linux-gnu-gcc QEMU_SYS=qemu-aarch64-static ZSTDRTTEST= MOREFLAGS="-Werror -static" 275 $(MAKE) -C $(PRGDIR) clean zstd CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc-static ZSTDRTTEST= MOREFLAGS="-Werror -Wno-attributes -static" 276 $(MAKE) -C $(PRGDIR) clean zstd CC=powerpc-linux-gnu-gcc QEMU_SYS=qemu-ppc64-static ZSTDRTTEST= MOREFLAGS="-m64 -static" 277 278regressiontest: 279 $(MAKE) -C $(FUZZDIR) regressiontest 280 281uasanregressiontest: 282 $(MAKE) -C $(FUZZDIR) regressiontest CC=clang CXX=clang++ CFLAGS="-O3 -fsanitize=address,undefined" CXXFLAGS="-O3 -fsanitize=address,undefined" 283 284msanregressiontest: 285 $(MAKE) -C $(FUZZDIR) regressiontest CC=clang CXX=clang++ CFLAGS="-O3 -fsanitize=memory" CXXFLAGS="-O3 -fsanitize=memory" 286 287# run UBsan with -fsanitize-recover=pointer-overflow 288# this only works with recent compilers such as gcc 8+ 289usan: clean 290 $(MAKE) test CC=clang MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize-recover=pointer-overflow -fsanitize=undefined -Werror" 291 292asan: clean 293 $(MAKE) test CC=clang MOREFLAGS="-g -fsanitize=address -Werror" 294 295asan-%: clean 296 LDFLAGS=-fuse-ld=gold MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize=address -Werror" $(MAKE) -C $(TESTDIR) $* 297 298msan: clean 299 $(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 300 301msan-%: clean 302 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 $* 303 304asan32: clean 305 $(MAKE) -C $(TESTDIR) test32 CC=clang MOREFLAGS="-g -fsanitize=address" 306 307uasan: clean 308 $(MAKE) test CC=clang MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize-recover=pointer-overflow -fsanitize=address,undefined -Werror" 309 310uasan-%: clean 311 LDFLAGS=-fuse-ld=gold MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize-recover=pointer-overflow -fsanitize=address,undefined -Werror" $(MAKE) -C $(TESTDIR) $* 312 313tsan-%: clean 314 LDFLAGS=-fuse-ld=gold MOREFLAGS="-g -fno-sanitize-recover=all -fsanitize=thread -Werror" $(MAKE) -C $(TESTDIR) $* FUZZER_FLAGS=--no-big-tests 315 316.PHONY: apt-install 317apt-install: 318 sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install $(APT_PACKAGES) 319 320.PHONY: apt-add-repo 321apt-add-repo: 322 sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test 323 sudo apt-get update -y -qq 324 325.PHONY: ppcinstall arminstall valgrindinstall libc6install gcc6install gcc7install gcc8install gpp6install clang38install lz4install 326ppcinstall: 327 APT_PACKAGES="qemu-system-ppc qemu-user-static gcc-powerpc-linux-gnu" $(MAKE) apt-install 328 329arminstall: 330 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 331 332valgrindinstall: 333 APT_PACKAGES="valgrind" $(MAKE) apt-install 334 335libc6install: 336 APT_PACKAGES="libc6-dev-i386 gcc-multilib" $(MAKE) apt-install 337 338gcc6install: apt-add-repo 339 APT_PACKAGES="libc6-dev-i386 gcc-multilib gcc-6 gcc-6-multilib" $(MAKE) apt-install 340 341gcc7install: apt-add-repo 342 APT_PACKAGES="libc6-dev-i386 gcc-multilib gcc-7 gcc-7-multilib" $(MAKE) apt-install 343 344gcc8install: apt-add-repo 345 APT_PACKAGES="libc6-dev-i386 gcc-multilib gcc-8 gcc-8-multilib" $(MAKE) apt-install 346 347gpp6install: apt-add-repo 348 APT_PACKAGES="libc6-dev-i386 g++-multilib gcc-6 g++-6 g++-6-multilib" $(MAKE) apt-install 349 350clang38install: 351 APT_PACKAGES="clang-3.8" $(MAKE) apt-install 352 353# Ubuntu 14.04 ships a too-old lz4 354lz4install: 355 [ -e lz4 ] || git clone https://github.com/lz4/lz4 && sudo $(MAKE) -C lz4 install 356 357endif 358 359 360CMAKE_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 361 362ifneq (,$(filter MSYS%,$(shell uname))) 363HOST_OS = MSYS 364CMAKE_PARAMS = -G"MSYS Makefiles" -DCMAKE_BUILD_TYPE=Debug -DZSTD_MULTITHREAD_SUPPORT:BOOL=OFF -DZSTD_BUILD_STATIC:BOOL=ON -DZSTD_BUILD_TESTS:BOOL=ON 365endif 366 367#------------------------------------------------------------------------ 368# target specific tests 369#------------------------------------------------------------------------ 370ifneq (,$(filter $(HOST_OS),MSYS POSIX)) 371.PHONY: cmakebuild c89build gnu90build c99build gnu99build c11build bmix64build bmix32build bmi32build staticAnalyze 372cmakebuild: 373 cmake --version 374 $(RM) -r $(BUILDIR)/cmake/build 375 mkdir $(BUILDIR)/cmake/build 376 cd $(BUILDIR)/cmake/build; cmake -DCMAKE_INSTALL_PREFIX:PATH=~/install_test_dir $(CMAKE_PARAMS) .. 377 $(MAKE) -C $(BUILDIR)/cmake/build -j4; 378 $(MAKE) -C $(BUILDIR)/cmake/build install; 379 $(MAKE) -C $(BUILDIR)/cmake/build uninstall; 380 cd $(BUILDIR)/cmake/build; ctest -V -L Medium 381 382c89build: clean 383 $(CC) -v 384 CFLAGS="-std=c89 -Werror" $(MAKE) allmost # will fail, due to missing support for `long long` 385 386gnu90build: clean 387 $(CC) -v 388 CFLAGS="-std=gnu90 -Werror" $(MAKE) allmost 389 390c99build: clean 391 $(CC) -v 392 CFLAGS="-std=c99 -Werror" $(MAKE) allmost 393 394gnu99build: clean 395 $(CC) -v 396 CFLAGS="-std=gnu99 -Werror" $(MAKE) allmost 397 398c11build: clean 399 $(CC) -v 400 CFLAGS="-std=c11 -Werror" $(MAKE) allmost 401 402bmix64build: clean 403 $(CC) -v 404 CFLAGS="-O3 -mbmi -Werror" $(MAKE) -C $(TESTDIR) test 405 406bmix32build: clean 407 $(CC) -v 408 CFLAGS="-O3 -mbmi -mx32 -Werror" $(MAKE) -C $(TESTDIR) test 409 410bmi32build: clean 411 $(CC) -v 412 CFLAGS="-O3 -mbmi -m32 -Werror" $(MAKE) -C $(TESTDIR) test 413 414# static analyzer test uses clang's scan-build 415# does not analyze zlibWrapper, due to detected issues in zlib source code 416staticAnalyze: SCANBUILD ?= scan-build 417staticAnalyze: 418 $(CC) -v 419 CC=$(CC) CPPFLAGS=-g $(SCANBUILD) --status-bugs -v $(MAKE) allzstd examples contrib 420endif 421