xref: /freebsd/tests/Makefile (revision 653667f9dc9cc0169deeca1a82a60c2e91d5683a) 
1# ################################################################
2# Copyright (c) 2015-present, 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# ################################################################
9# datagen : Synthetic and parametrable data generator, for tests
10# fullbench  : Precisely measure speed for each zstd inner functions
11# fullbench32: Same as fullbench, but forced to compile in 32-bits mode
12# fuzzer  : Test tool, to check zstd integrity on target platform
13# fuzzer32: Same as fuzzer, but forced to compile in 32-bits mode
14# paramgrill : parameter tester for zstd
15# test-zstd-speed.py : script for testing zstd speed difference between commits
16# versionsTest : compatibility test between zstd versions stored on Github (v0.1+)
17# zstreamtest : Fuzzer test tool for zstd streaming API
18# zstreamtest32: Same as zstreamtest, but forced to compile in 32-bits mode
19# ##########################################################################
20
21ZSTDDIR = ../lib
22PRGDIR  = ../programs
23PYTHON ?= python3
24TESTARTEFACT := versionsTest namespaceTest
25
26DEBUGLEVEL ?= 1
27DEBUGFLAGS  = -g -DZSTD_DEBUG=$(DEBUGLEVEL)
28CPPFLAGS   += -I$(ZSTDDIR) -I$(ZSTDDIR)/common -I$(ZSTDDIR)/compress \
29              -I$(ZSTDDIR)/dictBuilder -I$(ZSTDDIR)/deprecated -I$(PRGDIR)
30CFLAGS     ?= -O3
31CFLAGS     += -Wall -Wextra -Wcast-qual -Wcast-align -Wshadow                 \
32              -Wstrict-aliasing=1 -Wswitch-enum -Wdeclaration-after-statement \
33              -Wstrict-prototypes -Wundef -Wformat-security                   \
34              -Wvla -Wformat=2 -Winit-self -Wfloat-equal -Wwrite-strings      \
35              -Wredundant-decls
36CFLAGS     += $(DEBUGFLAGS) $(MOREFLAGS)
37FLAGS       = $(CPPFLAGS) $(CFLAGS) $(LDFLAGS)
38
39
40ZSTDCOMMON_FILES := $(ZSTDDIR)/common/*.c
41ZSTDCOMP_FILES   := $(ZSTDDIR)/compress/*.c
42ZSTDDECOMP_FILES := $(ZSTDDIR)/decompress/*.c
43ZSTD_FILES  := $(ZSTDDECOMP_FILES) $(ZSTDCOMMON_FILES) $(ZSTDCOMP_FILES)
44ZBUFF_FILES := $(ZSTDDIR)/deprecated/*.c
45ZDICT_FILES := $(ZSTDDIR)/dictBuilder/*.c
46
47
48# Define *.exe as extension for Windows systems
49ifneq (,$(filter Windows%,$(OS)))
50EXT =.exe
51MULTITHREAD_CPP = -DZSTD_MULTITHREAD
52MULTITHREAD_LD  =
53else
54EXT =
55MULTITHREAD_CPP = -DZSTD_MULTITHREAD
56MULTITHREAD_LD  = -pthread
57endif
58MULTITHREAD = $(MULTITHREAD_CPP) $(MULTITHREAD_LD)
59
60VOID = /dev/null
61ZSTREAM_TESTTIME ?= -T90s
62FUZZERTEST ?= -T200s
63ZSTDRTTEST = --test-large-data
64DECODECORPUS_TESTTIME ?= -T30
65
66.PHONY: default all all32 allnothread dll clean test test32 test-all namespaceTest versionsTest
67
68default: fullbench
69
70all: fullbench fuzzer zstreamtest paramgrill datagen decodecorpus
71
72all32: fullbench32 fuzzer32 zstreamtest32
73
74allnothread: fullbench fuzzer paramgrill datagen decodecorpus
75
76dll: fuzzer-dll zstreamtest-dll
77
78zstd:
79	$(MAKE) -C $(PRGDIR) $@
80
81zstd32:
82	$(MAKE) -C $(PRGDIR) $@
83
84zstd-nolegacy:
85	$(MAKE) -C $(PRGDIR) $@
86
87gzstd:
88	$(MAKE) -C $(PRGDIR) zstd HAVE_ZLIB=1
89
90fullbench32: CPPFLAGS += -m32
91fullbench fullbench32 : CPPFLAGS += $(MULTITHREAD_CPP)
92fullbench fullbench32 : LDFLAGS += $(MULTITHREAD_LD)
93fullbench fullbench32 : DEBUGFLAGS =   # turn off assert() for speed measurements
94fullbench fullbench32 : $(ZSTD_FILES) $(PRGDIR)/datagen.c fullbench.c
95	$(CC) $(FLAGS) $^ -o $@$(EXT)
96
97fullbench-lib: $(PRGDIR)/datagen.c fullbench.c
98	$(MAKE) -C $(ZSTDDIR) libzstd.a
99	$(CC) $(FLAGS) $^ -o $@$(EXT) $(ZSTDDIR)/libzstd.a
100
101fullbench-dll: $(PRGDIR)/datagen.c fullbench.c
102	$(MAKE) -C $(ZSTDDIR) libzstd
103	$(CC) $(FLAGS) $^ -o $@$(EXT) -DZSTD_DLL_IMPORT=1 $(ZSTDDIR)/dll/libzstd.dll
104
105fuzzer : CPPFLAGS += $(MULTITHREAD_CPP)
106fuzzer : LDFLAGS += $(MULTITHREAD_LD)
107fuzzer32: CFLAGS += -m32
108fuzzer fuzzer32 : $(ZSTD_FILES) $(ZDICT_FILES) $(PRGDIR)/datagen.c fuzzer.c
109	$(CC) $(FLAGS) $^ -o $@$(EXT)
110
111fuzzer-dll : LDFLAGS+= -L$(ZSTDDIR) -lzstd
112fuzzer-dll : $(ZSTDDIR)/common/xxhash.c $(PRGDIR)/datagen.c fuzzer.c
113	$(MAKE) -C $(ZSTDDIR) libzstd
114	$(CC) $(CPPFLAGS) $(CFLAGS) $^ $(LDFLAGS) -o $@$(EXT)
115
116zbufftest : CPPFLAGS += -I$(ZSTDDIR)/deprecated
117zbufftest : CFLAGS += -Wno-deprecated-declarations   # required to silence deprecation warnings
118zbufftest : $(ZSTD_FILES) $(ZBUFF_FILES) $(PRGDIR)/datagen.c zbufftest.c
119	$(CC) $(FLAGS) $^ -o $@$(EXT)
120
121zbufftest32 : CPPFLAGS += -I$(ZSTDDIR)/deprecated
122zbufftest32 : CFLAGS += -Wno-deprecated-declarations -m32
123zbufftest32 : $(ZSTD_FILES) $(ZBUFF_FILES) $(PRGDIR)/datagen.c zbufftest.c
124	$(CC) $(FLAGS) $^ -o $@$(EXT)
125
126zbufftest-dll : CPPFLAGS += -I$(ZSTDDIR)/deprecated
127zbufftest-dll : CFLAGS += -Wno-deprecated-declarations   # required to silence deprecation warnings
128zbufftest-dll : LDFLAGS+= -L$(ZSTDDIR) -lzstd
129zbufftest-dll : $(ZSTDDIR)/common/xxhash.c $(PRGDIR)/datagen.c zbufftest.c
130	$(MAKE) -C $(ZSTDDIR) libzstd
131	$(CC) $(CPPFLAGS) $(CFLAGS) $^ $(LDFLAGS) -o $@$(EXT)
132
133ZSTREAMFILES := $(ZSTD_FILES) $(ZDICT_FILES) $(PRGDIR)/datagen.c zstreamtest.c
134zstreamtest : CPPFLAGS += $(MULTITHREAD_CPP)
135zstreamtest : LDFLAGS += $(MULTITHREAD_LD)
136zstreamtest : $(ZSTREAMFILES)
137	$(CC) $(FLAGS) $^ -o $@$(EXT)
138
139zstreamtest32 : CFLAGS += -m32
140zstreamtest32 : $(ZSTREAMFILES)
141	$(CC) $(FLAGS) $(MULTITHREAD) $^ -o $@$(EXT)
142
143zstreamtest_asan : CFLAGS += -fsanitize=address
144zstreamtest_asan : $(ZSTREAMFILES)
145	$(CC) $(FLAGS) $(MULTITHREAD) $^ -o $@$(EXT)
146
147zstreamtest_tsan : CFLAGS += -fsanitize=thread
148zstreamtest_tsan : $(ZSTREAMFILES)
149	$(CC) $(FLAGS) $(MULTITHREAD) $^ -o $@$(EXT)
150
151zstreamtest-dll : LDFLAGS+= -L$(ZSTDDIR) -lzstd
152zstreamtest-dll : $(ZSTDDIR)/common/xxhash.c $(PRGDIR)/datagen.c zstreamtest.c
153	$(MAKE) -C $(ZSTDDIR) libzstd
154	$(CC) $(CPPFLAGS) $(CFLAGS) $^ $(LDFLAGS) -o $@$(EXT)
155
156paramgrill : DEBUGFLAGS =
157paramgrill : $(ZSTD_FILES) $(PRGDIR)/datagen.c paramgrill.c
158	$(CC)      $(FLAGS) $^ -lm -o $@$(EXT)
159
160datagen : $(PRGDIR)/datagen.c datagencli.c
161	$(CC)      $(FLAGS) $^ -o $@$(EXT)
162
163roundTripCrash : $(ZSTD_FILES) roundTripCrash.c
164	$(CC)      $(FLAGS) $(MULTITHREAD) $^ -o $@$(EXT)
165
166longmatch  : $(ZSTD_FILES) longmatch.c
167	$(CC)      $(FLAGS) $^ -o $@$(EXT)
168
169invalidDictionaries  : $(ZSTD_FILES) invalidDictionaries.c
170	$(CC)      $(FLAGS) $^ -o $@$(EXT)
171
172legacy : CFLAGS+= -DZSTD_LEGACY_SUPPORT=4
173legacy : CPPFLAGS+= -I$(ZSTDDIR)/legacy
174legacy : $(ZSTD_FILES) $(wildcard $(ZSTDDIR)/legacy/*.c) legacy.c
175	$(CC)      $(FLAGS) $^ -o $@$(EXT)
176
177decodecorpus	: $(filter-out $(ZSTDDIR)/compress/zstd_compress.c, $(wildcard $(ZSTD_FILES))) $(ZDICT_FILES) decodecorpus.c
178	$(CC)      $(FLAGS) $^ -o $@$(EXT) -lm
179
180symbols  : symbols.c
181	$(MAKE) -C $(ZSTDDIR) libzstd
182ifneq (,$(filter Windows%,$(OS)))
183	cp $(ZSTDDIR)/dll/libzstd.dll .
184	$(CC) $(FLAGS) $^ -o $@$(EXT) -DZSTD_DLL_IMPORT=1 libzstd.dll
185else
186	$(CC) $(FLAGS) $^ -o $@$(EXT) -Wl,-rpath=$(ZSTDDIR) $(ZSTDDIR)/libzstd.so
187endif
188
189poolTests : poolTests.c $(ZSTDDIR)/common/pool.c $(ZSTDDIR)/common/threading.c $(ZSTDDIR)/common/zstd_common.c $(ZSTDDIR)/common/error_private.c
190	$(CC) $(FLAGS) $(MULTITHREAD) $^ -o $@$(EXT)
191
192namespaceTest:
193	if $(CC) namespaceTest.c ../lib/common/xxhash.c -o $@ ; then echo compilation should fail; exit 1 ; fi
194	$(RM) $@
195
196versionsTest: clean
197	$(PYTHON) test-zstd-versions.py
198
199clean:
200	$(MAKE) -C $(ZSTDDIR) clean
201	@$(RM) -fR $(TESTARTEFACT)
202	@$(RM) -f core *.o tmp* result* *.gcda dictionary *.zst \
203        $(PRGDIR)/zstd$(EXT) $(PRGDIR)/zstd32$(EXT) \
204        fullbench$(EXT) fullbench32$(EXT) \
205        fullbench-lib$(EXT) fullbench-dll$(EXT) \
206        fuzzer$(EXT) fuzzer32$(EXT) zbufftest$(EXT) zbufftest32$(EXT) \
207        fuzzer-dll$(EXT) zstreamtest-dll$(EXT) zbufftest-dll$(EXT)\
208        zstreamtest$(EXT) zstreamtest32$(EXT) \
209        datagen$(EXT) paramgrill$(EXT) roundTripCrash$(EXT) longmatch$(EXT) \
210        symbols$(EXT) invalidDictionaries$(EXT) legacy$(EXT) poolTests$(EXT) \
211        decodecorpus$(EXT)
212	@echo Cleaning completed
213
214
215#----------------------------------------------------------------------------------
216#make valgrindTest is validated only for Linux, OSX, BSD, Hurd and Solaris targets
217#----------------------------------------------------------------------------------
218ifneq (,$(filter $(shell uname),Linux Darwin GNU/kFreeBSD GNU OpenBSD FreeBSD NetBSD DragonFly SunOS))
219HOST_OS = POSIX
220
221valgrindTest: VALGRIND = valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1
222valgrindTest: zstd datagen fuzzer fullbench
223	@echo "\n ---- valgrind tests : memory analyzer ----"
224	$(VALGRIND) ./datagen -g50M > $(VOID)
225	$(VALGRIND) $(PRGDIR)/zstd ; if [ $$? -eq 0 ] ; then echo "zstd without argument should have failed"; false; fi
226	./datagen -g80 | $(VALGRIND) $(PRGDIR)/zstd - -c > $(VOID)
227	./datagen -g16KB | $(VALGRIND) $(PRGDIR)/zstd -vf - -c > $(VOID)
228	./datagen -g2930KB | $(VALGRIND) $(PRGDIR)/zstd -5 -vf - -o tmp
229	$(VALGRIND) $(PRGDIR)/zstd -vdf tmp -c > $(VOID)
230	./datagen -g64MB | $(VALGRIND) $(PRGDIR)/zstd -vf - -c > $(VOID)
231	@rm tmp
232	$(VALGRIND) ./fuzzer -T1mn -t1
233	$(VALGRIND) ./fullbench -i1
234
235endif
236
237
238ifneq (,$(filter MSYS%,$(shell uname)))
239HOST_OS = MSYS
240endif
241
242
243#-----------------------------------------------------------------------------
244# make tests validated only for below targets
245#-----------------------------------------------------------------------------
246ifneq (,$(filter $(HOST_OS),MSYS POSIX))
247
248DIFF:=diff
249ifneq (,$(filter $(shell uname),SunOS))
250DIFF:=gdiff
251endif
252
253zstd-playTests: datagen
254	file $(ZSTD)
255	ZSTD="$(QEMU_SYS) $(ZSTD)" ./playTests.sh $(ZSTDRTTEST)
256
257shortest: ZSTDRTTEST=
258shortest: test-zstd
259
260fuzztest: test-fuzzer test-zstream test-decodecorpus
261
262test: test-zstd test-fullbench test-fuzzer test-zstream test-invalidDictionaries test-legacy test-decodecorpus
263ifeq ($(QEMU_SYS),)
264test: test-pool
265endif
266
267test32: test-zstd32 test-fullbench32 test-fuzzer32 test-zstream32
268
269test-all: test test32 valgrindTest test-decodecorpus-cli
270
271test-zstd: ZSTD = $(PRGDIR)/zstd
272test-zstd: zstd zstd-playTests
273
274test-zstd32: ZSTD = $(PRGDIR)/zstd32
275test-zstd32: zstd32 zstd-playTests
276
277test-zstd-nolegacy: ZSTD = $(PRGDIR)/zstd-nolegacy
278test-zstd-nolegacy: zstd-nolegacy zstd-playTests
279
280test-gzstd: gzstd
281	$(PRGDIR)/zstd -f README.md test-zstd-speed.py
282	gzip -f README.md test-zstd-speed.py
283	cat README.md.zst test-zstd-speed.py.gz >zstd_gz.zst
284	cat README.md.gz test-zstd-speed.py.zst >gz_zstd.gz
285	$(PRGDIR)/zstd -df README.md.gz -o README2.md
286	$(PRGDIR)/zstd -df README.md.gz test-zstd-speed.py.gz
287	$(PRGDIR)/zstd -df zstd_gz.zst gz_zstd.gz
288	$(DIFF) -q zstd_gz gz_zstd
289	echo Hello World ZSTD | $(PRGDIR)/zstd -c - >hello.zst
290	echo Hello World GZIP | gzip -c - >hello.gz
291	echo Hello World TEXT >hello.txt
292	cat hello.zst hello.gz hello.txt >hello_zst_gz_txt.gz
293	$(PRGDIR)/zstd -dcf hello.*
294	$(PRGDIR)/zstd -dcf - <hello_zst_gz_txt.gz
295	$(RM) *.gz *.zst README2.md gz_zstd zstd_gz hello.txt
296
297test-fullbench: fullbench datagen
298	$(QEMU_SYS) ./fullbench -i1
299	$(QEMU_SYS) ./fullbench -i1 -P0
300
301test-fullbench32: fullbench32 datagen
302	$(QEMU_SYS) ./fullbench32 -i1
303	$(QEMU_SYS) ./fullbench32 -i1 -P0
304
305test-fuzzer: fuzzer
306	$(QEMU_SYS) ./fuzzer $(FUZZERTEST) $(FUZZER_FLAGS)
307
308test-fuzzer32: fuzzer32
309	$(QEMU_SYS) ./fuzzer32 $(FUZZERTEST) $(FUZZER_FLAGS)
310
311test-zbuff: zbufftest
312	$(QEMU_SYS) ./zbufftest $(ZSTREAM_TESTTIME)
313
314test-zbuff32: zbufftest32
315	$(QEMU_SYS) ./zbufftest32 $(ZSTREAM_TESTTIME)
316
317test-zstream: zstreamtest
318	$(QEMU_SYS) ./zstreamtest $(ZSTREAM_TESTTIME) $(FUZZER_FLAGS)
319	$(QEMU_SYS) ./zstreamtest --mt -t1 $(ZSTREAM_TESTTIME) $(FUZZER_FLAGS)
320	$(QEMU_SYS) ./zstreamtest --newapi -t1 $(ZSTREAM_TESTTIME) $(FUZZER_FLAGS)
321	$(QEMU_SYS) ./zstreamtest --opaqueapi -t1 $(ZSTREAM_TESTTIME) $(FUZZER_FLAGS)
322
323test-zstream32: zstreamtest32
324	$(QEMU_SYS) ./zstreamtest32 $(ZSTREAM_TESTTIME) $(FUZZER_FLAGS)
325
326test-longmatch: longmatch
327	$(QEMU_SYS) ./longmatch
328
329test-invalidDictionaries: invalidDictionaries
330	$(QEMU_SYS) ./invalidDictionaries
331
332test-symbols: symbols
333	$(QEMU_SYS) ./symbols
334
335test-legacy: legacy
336	$(QEMU_SYS) ./legacy
337
338test-decodecorpus: decodecorpus
339	$(QEMU_SYS) ./decodecorpus -t $(DECODECORPUS_TESTTIME)
340
341test-decodecorpus-cli: decodecorpus
342	@echo "\n ---- decodecorpus basic cli tests ----"
343	@mkdir testdir
344	./decodecorpus -n5 -otestdir -ptestdir
345	@cd testdir && \
346	$(ZSTD) -d z000000.zst -o tmp0 && \
347	$(ZSTD) -d z000001.zst -o tmp1 && \
348	$(ZSTD) -d z000002.zst -o tmp2 && \
349	$(ZSTD) -d z000003.zst -o tmp3 && \
350	$(ZSTD) -d z000004.zst -o tmp4 && \
351	diff z000000 tmp0 && \
352	diff z000001 tmp1 && \
353	diff z000002 tmp2 && \
354	diff z000003 tmp3 && \
355	diff z000004 tmp4 && \
356	rm ./* && \
357	cd ..
358	@echo "\n ---- decodecorpus dictionary cli tests ----"
359	./decodecorpus -n5 -otestdir -ptestdir --use-dict=1MB
360	@cd testdir && \
361	$(ZSTD) -d z000000.zst -D dictionary -o tmp0 && \
362	$(ZSTD) -d z000001.zst -D dictionary -o tmp1 && \
363	$(ZSTD) -d z000002.zst -D dictionary -o tmp2 && \
364	$(ZSTD) -d z000003.zst -D dictionary -o tmp3 && \
365	$(ZSTD) -d z000004.zst -D dictionary -o tmp4 && \
366	diff z000000 tmp0 && \
367	diff z000001 tmp1 && \
368	diff z000002 tmp2 && \
369	diff z000003 tmp3 && \
370	diff z000004 tmp4 && \
371	cd ..
372	@rm -rf testdir
373
374test-pool: poolTests
375	$(QEMU_SYS) ./poolTests
376
377test-lz4: ZSTD = LD_LIBRARY_PATH=/usr/local/lib $(PRGDIR)/zstd
378test-lz4: ZSTD_LZ4 = LD_LIBRARY_PATH=/usr/local/lib ./lz4
379test-lz4: ZSTD_UNLZ4 = LD_LIBRARY_PATH=/usr/local/lib ./unlz4
380test-lz4: zstd decodecorpus
381	ln -s $(PRGDIR)/zstd lz4
382	ln -s $(PRGDIR)/zstd unlz4
383
384	./decodecorpus -ptmp
385	# lz4 -> zstd
386	lz4 < tmp | \
387	$(ZSTD) -d | \
388	cmp - tmp
389	lz4 < tmp | \
390	$(ZSTD_UNLZ4) | \
391	cmp - tmp
392	# zstd -> lz4
393	$(ZSTD) --format=lz4 < tmp | \
394	lz4 -d | \
395	cmp - tmp
396	$(ZSTD_LZ4) < tmp | \
397	lz4 -d | \
398	cmp - tmp
399	# zstd -> zstd
400	$(ZSTD) --format=lz4 < tmp | \
401	$(ZSTD) -d | \
402	cmp - tmp
403	# zstd -> zstd
404	$(ZSTD) < tmp | \
405	$(ZSTD) -d | \
406	cmp - tmp
407
408	rm tmp lz4 unlz4
409
410endif
411