doc/educational_decoder/Makefile

# ################################################################
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
#
# This source code is licensed under both the BSD-style license (found in the
# LICENSE file in the root directory of this source tree) and the GPLv2 (found
# in the COPYING file in the root directory of this source tree).
# You may select, at your option, one of the above-listed licenses.
# ################################################################

ZSTD ?= zstd   # note: requires zstd installation on local system

UNAME?= $(shell sh -c 'MSYSTEM="MSYS" uname') 
ifeq ($(UNAME), SunOS)
DIFF ?= gdiff
else
DIFF ?= diff
endif

HARNESS_FILES=*.c

MULTITHREAD_LDFLAGS = -pthread
DEBUGFLAGS= -g -DZSTD_DEBUG=1
CPPFLAGS += -I$(ZSTDDIR) -I$(ZSTDDIR)/common -I$(ZSTDDIR)/compress \
            -I$(ZSTDDIR)/dictBuilder -I$(ZSTDDIR)/deprecated -I$(PRGDIR)
CFLAGS   ?= -O2
CFLAGS   += -Wall -Wextra -Wcast-qual -Wcast-align -Wshadow                 \
            -Wstrict-aliasing=1 -Wswitch-enum                               \
            -Wredundant-decls -Wstrict-prototypes -Wundef                   \
            -Wvla -Wformat=2 -Winit-self -Wfloat-equal -Wwrite-strings      \
            -std=c99
CFLAGS   += $(DEBUGFLAGS)
CFLAGS   += $(MOREFLAGS)
FLAGS     = $(CPPFLAGS) $(CFLAGS) $(LDFLAGS) $(MULTITHREAD_LDFLAGS)

harness: $(HARNESS_FILES)
	$(CC) $(FLAGS) $^ -o $@

clean:
	@$(RM) harness *.o
	@$(RM) -rf harness.dSYM  # MacOS specific

test: harness
	#
	# Testing single-file decompression with educational decoder
	#
	@$(ZSTD) -f README.md -o tmp.zst
	@./harness tmp.zst tmp
	@$(DIFF) -s tmp README.md
	@$(RM) tmp*
	#
	# Testing dictionary decompression with education decoder
	#
	# note : files are presented multiple for training, to reach minimum threshold
	@$(ZSTD) --train harness.c zstd_decompress.c zstd_decompress.h README.md \
                  harness.c zstd_decompress.c zstd_decompress.h README.md \
                  harness.c zstd_decompress.c zstd_decompress.h README.md \
                  -o dictionary
	@$(ZSTD) -f README.md -D dictionary -o tmp.zst
	@./harness tmp.zst tmp dictionary
	@$(DIFF) -s tmp README.md
	@$(RM) tmp* dictionary
fix education decoder test when `zstd` in not installed on local system by allowing `ZSTD` variable to hold a custom location for the binary 2019-09-10 09:36:02 -07:00			`# ################################################################`
Coalesce Almost All Copyright Notices to Standard Phrasing ``` for f in $(find . \( -path ./.git -o -path ./tests/fuzz/corpora -o -path ./tests/regression/data-cache -o -path ./tests/regression/cache \) -prune -o -type f); do sed -i '/Copyright .* \(Yann Collet\)\\|\(Meta Platforms\)/ s/Copyright ./Copyright (c) Meta Platforms, Inc. and affiliates./' $f; done git checkout HEAD -- build/VS2010/libzstd-dll/libzstd-dll.rc build/VS2010/zstd/zstd.rc tests/test-license.py contrib/linux-kernel/test/include/linux/xxhash.h examples/streaming_compression_thread_pool.c lib/legacy/zstd_v0.c lib/legacy/zstd_v0*.h nano ./programs/windres/zstd.rc nano ./build/VS2010/zstd/zstd.rc nano ./build/VS2010/libzstd-dll/libzstd-dll.rc ``` 2022-12-20 12:49:47 -05:00			`# Copyright (c) Meta Platforms, Inc. and affiliates.`
fix education decoder test when `zstd` in not installed on local system by allowing `ZSTD` variable to hold a custom location for the binary 2019-09-10 09:36:02 -07:00			`# All rights reserved.`
			`#`
			`# This source code is licensed under both the BSD-style license (found in the`
			`# LICENSE file in the root directory of this source tree) and the GPLv2 (found`
			`# in the COPYING file in the root directory of this source tree).`
Fix copyright and license lines * All copyright lines now have -2020 instead of -present * All copyright lines include "Facebook, Inc" * All licenses are now standardized The copyright in `threading.{h,c}` is not changed because it comes from zstdmt. The copyright and license of `divsufsort.{h,c}` is not changed. 2020-03-26 15:19:05 -07:00			`# You may select, at your option, one of the above-listed licenses.`
fix education decoder test when `zstd` in not installed on local system by allowing `ZSTD` variable to hold a custom location for the binary 2019-09-10 09:36:02 -07:00			`# ################################################################`

minor: DIFF determination use gdiff on SunOS 2019-10-17 14:03:20 -07:00			`ZSTD ?= zstd # note: requires zstd installation on local system`

Fix $filter and Msys/Cygwin - switched the patter and input of $filter into the right places - added pattern wildcard to MSYS_NT & CYGWIN_NT as they change with windows versions - correctly identify MSYS2, even in an env like MINGW64 2024-06-05 18:21:34 +02:00			`UNAME?= $(shell sh -c 'MSYSTEM="MSYS" uname')`
minor: DIFF determination use gdiff on SunOS 2019-10-17 14:03:20 -07:00			`ifeq ($(UNAME), SunOS)`
			`DIFF ?= gdiff`
			`else`
fix education decoder test when `zstd` in not installed on local system by allowing `ZSTD` variable to hold a custom location for the binary 2019-09-10 09:36:02 -07:00			`DIFF ?= diff`
minor: DIFF determination use gdiff on SunOS 2019-10-17 14:03:20 -07:00			`endif`

add makefile 2017-08-11 14:35:13 -07:00			`HARNESS_FILES=*.c`

			`MULTITHREAD_LDFLAGS = -pthread`
			`DEBUGFLAGS= -g -DZSTD_DEBUG=1`
			`CPPFLAGS += -I$(ZSTDDIR) -I$(ZSTDDIR)/common -I$(ZSTDDIR)/compress \`
			`-I$(ZSTDDIR)/dictBuilder -I$(ZSTDDIR)/deprecated -I$(PRGDIR)`
fix education decoder test when `zstd` in not installed on local system by allowing `ZSTD` variable to hold a custom location for the binary 2019-09-10 09:36:02 -07:00			`CFLAGS ?= -O2`
add makefile 2017-08-11 14:35:13 -07:00			`CFLAGS += -Wall -Wextra -Wcast-qual -Wcast-align -Wshadow \`
fix minor compilation condition harness.c is not designed to pass -Wdeclaration-after-statement 2019-09-06 16:51:16 -07:00			`-Wstrict-aliasing=1 -Wswitch-enum \`
			`-Wredundant-decls -Wstrict-prototypes -Wundef \`
add makefile 2017-08-11 14:35:13 -07:00			`-Wvla -Wformat=2 -Winit-self -Wfloat-equal -Wwrite-strings \`
fix minor compilation condition harness.c is not designed to pass -Wdeclaration-after-statement 2019-09-06 16:51:16 -07:00			`-std=c99`
add makefile 2017-08-11 14:35:13 -07:00			`CFLAGS += $(DEBUGFLAGS)`
			`CFLAGS += $(MOREFLAGS)`
			`FLAGS = $(CPPFLAGS) $(CFLAGS) $(LDFLAGS) $(MULTITHREAD_LDFLAGS)`

			`harness: $(HARNESS_FILES)`
			`$(CC) $(FLAGS) $^ -o $@`

			`clean:`
added ability to remove error messages and dictionary support (#1975) for the benefit of smaller binary. 2020-01-27 11:39:29 -08:00			`@$(RM) harness *.o`
minor: DIFF determination use gdiff on SunOS 2019-10-17 14:03:20 -07:00			`@$(RM) -rf harness.dSYM # MacOS specific`
remove debug symbols when cleaning, added a simple test 2017-08-11 14:42:15 -07:00
			`test: harness`
fix education decoder test when `zstd` in not installed on local system by allowing `ZSTD` variable to hold a custom location for the binary 2019-09-10 09:36:02 -07:00			`#`
			`# Testing single-file decompression with educational decoder`
			`#`
force compression during tests to erase potentially remaining artifacts from previous runs 2019-10-17 13:01:18 -07:00			`@$(ZSTD) -f README.md -o tmp.zst`
remove debug symbols when cleaning, added a simple test 2017-08-11 14:42:15 -07:00			`@./harness tmp.zst tmp`
fix education decoder test when `zstd` in not installed on local system by allowing `ZSTD` variable to hold a custom location for the binary 2019-09-10 09:36:02 -07:00			`@$(DIFF) -s tmp README.md`
force compression during tests to erase potentially remaining artifacts from previous runs 2019-10-17 13:01:18 -07:00			`@$(RM) tmp*`
fix education decoder test when `zstd` in not installed on local system by allowing `ZSTD` variable to hold a custom location for the binary 2019-09-10 09:36:02 -07:00			`#`
			`# Testing dictionary decompression with education decoder`
			`#`
			`# note : files are presented multiple for training, to reach minimum threshold`
			`@$(ZSTD) --train harness.c zstd_decompress.c zstd_decompress.h README.md \`
fix eductional decoder fix #1774 also : - fix minor compilation warnings - make sure the `test` is run during CI tests 2019-09-06 14:30:13 -07:00			`harness.c zstd_decompress.c zstd_decompress.h README.md \`
minor: DIFF determination use gdiff on SunOS 2019-10-17 14:03:20 -07:00			`harness.c zstd_decompress.c zstd_decompress.h README.md \`
			`-o dictionary`
force compression during tests to erase potentially remaining artifacts from previous runs 2019-10-17 13:01:18 -07:00			`@$(ZSTD) -f README.md -D dictionary -o tmp.zst`
exposed dictionary functions/types 2017-08-11 17:53:37 -07:00			`@./harness tmp.zst tmp dictionary`
fix education decoder test when `zstd` in not installed on local system by allowing `ZSTD` variable to hold a custom location for the binary 2019-09-10 09:36:02 -07:00			`@$(DIFF) -s tmp README.md`
force compression during tests to erase potentially remaining artifacts from previous runs 2019-10-17 13:01:18 -07:00			`@$(RM) tmp* dictionary`