aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvan Hauser <vh@thc.org>2024-04-13 11:50:49 +0200
committerGitHub <noreply@github.com>2024-04-13 11:50:49 +0200
commit1d17210d9fb0eb37ba866a3697643a9e4f37acd5 (patch)
tree2471cccc76e4396de369f3bfe4b8f4bb00ef6403
parent775861ea94d00672c9e868db329073afd699b994 (diff)
parent1582aa9da2d7593e5b577aa3fc963ea7eb2ccbb3 (diff)
downloadafl++-1d17210d9fb0eb37ba866a3697643a9e4f37acd5.tar.gz
Merge pull request #2052 from AFLplusplus/devv4.20c
4.20 release pre-PR
-rw-r--r--.github/workflows/ci.yml1
-rw-r--r--.gitignore5
-rw-r--r--CITATION.cff2
-rw-r--r--GNUmakefile77
-rw-r--r--GNUmakefile.llvm2
-rw-r--r--README.md4
-rw-r--r--TODO.md4
-rwxr-xr-xafl-cmin2
-rwxr-xr-xafl-persistent-config25
-rwxr-xr-xafl-whatsup42
-rw-r--r--benchmark/COMPARISON.md22
-rw-r--r--benchmark/benchmark-results.jsonl4
-rwxr-xr-xbenchmark/benchmark.py2
-rw-r--r--custom_mutators/aflpp/aflpp.c1
-rw-r--r--custom_mutators/aflpp/standalone/aflpp-standalone.c7
-rw-r--r--docs/Changelog.md39
-rw-r--r--docs/INSTALL.md126
-rw-r--r--docs/env_variables.md3
-rw-r--r--docs/fuzzing_in_depth.md2
-rw-r--r--docs/third_party_tools.md4
-rw-r--r--docs/tutorials.md3
-rwxr-xr-xfrida_mode/update_frida_version.sh2
-rw-r--r--include/afl-fuzz.h19
-rw-r--r--include/afl-mutations.h5
-rw-r--r--include/afl-persistent-replay.h131
-rw-r--r--include/afl-record-compat.h67
-rw-r--r--include/cmplog.h24
-rw-r--r--include/config.h7
-rw-r--r--include/envs.h44
-rw-r--r--include/t1ha.h738
-rw-r--r--include/t1ha0_ia32aes_b.h183
-rw-r--r--include/t1ha_bits.h1423
-rw-r--r--include/t1ha_selfcheck.h77
-rw-r--r--include/types.h8
-rw-r--r--include/xxhash.h4668
-rw-r--r--instrumentation/README.persistent_mode.md32
-rw-r--r--instrumentation/SanitizerCoverageLTO.so.cc785
-rw-r--r--instrumentation/afl-compiler-rt.o.c561
-rw-r--r--instrumentation/afl-gcc-cmptrs-pass.so.cc15
-rw-r--r--instrumentation/afl-llvm-dict2file.so.cc2
-rw-r--r--instrumentation/afl-llvm-pass.so.cc10
-rw-r--r--instrumentation/cmplog-instructions-pass.cc9
-rw-r--r--instrumentation/cmplog-routines-pass.cc12
-rw-r--r--instrumentation/cmplog-switches-pass.cc12
-rw-r--r--instrumentation/compare-transform-pass.so.cc27
-rw-r--r--instrumentation/injection-pass.cc17
-rw-r--r--instrumentation/split-compares-pass.so.cc37
-rw-r--r--instrumentation/split-switches-pass.so.cc17
-rw-r--r--qemu_mode/QEMUAFL_VERSION2
-rwxr-xr-xqemu_mode/build_qemu_support.sh2
m---------qemu_mode/qemuafl0
-rw-r--r--src/afl-cc.c27
-rw-r--r--src/afl-common.c46
-rw-r--r--src/afl-forkserver.c500
-rw-r--r--src/afl-fuzz-bitmap.c41
-rw-r--r--src/afl-fuzz-extras.c7
-rw-r--r--src/afl-fuzz-init.c43
-rw-r--r--src/afl-fuzz-redqueen.c64
-rw-r--r--src/afl-fuzz-run.c43
-rw-r--r--src/afl-fuzz-state.c6
-rw-r--r--src/afl-fuzz-stats.c180
-rw-r--r--src/afl-fuzz.c83
-rw-r--r--src/afl-performance.c14
-rw-r--r--src/afl-tmin.c34
-rw-r--r--src/hashmap.c149
-rwxr-xr-xtest/test-llvm.sh2
-rwxr-xr-xtest/test-qemu-mode.sh4
-rwxr-xr-xunicorn_mode/build_unicorn_support.sh6
-rw-r--r--unicorn_mode/helper_scripts/unicorn_dumper_gdb.py10
-rw-r--r--unicorn_mode/helper_scripts/unicorn_dumper_pwndbg.py4
-rw-r--r--unicorn_mode/helper_scripts/unicorn_loader.py41
-rw-r--r--utils/afl_network_proxy/GNUmakefile1
-rw-r--r--utils/bench/Makefile8
-rw-r--r--utils/bench/README.md2
-rw-r--r--utils/bench/hash.c53
-rw-r--r--utils/persistent_mode/Makefile2
-rw-r--r--utils/replay_record/Makefile8
-rw-r--r--utils/replay_record/README.md10
-rw-r--r--utils/replay_record/persistent_demo_replay.c148
79 files changed, 8324 insertions, 2525 deletions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index ed382fbb..dd0d13e9 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -5,6 +5,7 @@ on:
branches:
- stable
- dev
+ - 420
pull_request:
branches:
- dev # No need for stable-pull-request, as that equals dev-push
diff --git a/.gitignore b/.gitignore
index f76a86fc..8e191e29 100644
--- a/.gitignore
+++ b/.gitignore
@@ -99,10 +99,15 @@ unicorn_mode/samples/*/\.test-*
utils/afl_network_proxy/afl-network-client
utils/afl_network_proxy/afl-network-server
utils/afl_proxy/afl-proxy
+utils/bench/hash
utils/optimin/build
utils/optimin/optimin
utils/persistent_mode/persistent_demo
utils/persistent_mode/persistent_demo_new
+utils/persistent_mode/persistent_demo_new_compat
utils/persistent_mode/test-instr
+utils/replay_record/persistent_demo_replay
+utils/replay_record/persistent_demo_replay_compat
+utils/replay_record/persistent_demo_replay_argparse
utils/plot_ui/afl-plot-ui
vuln_prog
diff --git a/CITATION.cff b/CITATION.cff
index 37a4a174..5ae7211d 100644
--- a/CITATION.cff
+++ b/CITATION.cff
@@ -27,5 +27,5 @@ keywords:
- qemu
- llvm
- unicorn-emulator
- - securiy
+ - security
license: AGPL-3.0-or-later
diff --git a/GNUmakefile b/GNUmakefile
index 283c57c2..dee9bbb3 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -52,7 +52,7 @@ endif
ifdef ASAN_BUILD
$(info Compiling ASAN version of binaries)
override CFLAGS += $(ASAN_CFLAGS)
- LDFLAGS += $(ASAN_LDFLAGS)
+ override LDFLAGS += $(ASAN_LDFLAGS)
endif
ifdef UBSAN_BUILD
$(info Compiling UBSAN version of binaries)
@@ -84,38 +84,44 @@ else
endif
endif
-#ifeq "$(shell echo 'int main() {return 0; }' | $(CC) -fno-move-loop-invariants -fdisable-tree-cunrolli -x c - -o .test 2>/dev/null && echo 1 || echo 0 ; rm -f .test )" "1"
-# SPECIAL_PERFORMANCE += -fno-move-loop-invariants -fdisable-tree-cunrolli
-#endif
-
-#ifeq "$(shell echo 'int main() {return 0; }' | $(CC) $(CFLAGS) -Werror -x c - -march=native -o .test 2>/dev/null && echo 1 || echo 0 ; rm -f .test )" "1"
-# ifndef SOURCE_DATE_EPOCH
-# HAVE_MARCHNATIVE = 1
-# CFLAGS_OPT += -march=native
-# endif
-#endif
+ifdef PERFORMANCE
+ SPECIAL_PERFORMANCE := -D_AFL_SPECIAL_PERFORMANCE
+ ifeq "$(SYS)" "Linux"
+ ifeq "$(shell grep avx2 /proc/cpuinfo)" ""
+ else
+ SPECIAL_PERFORMANCE += -mavx2 -D_HAVE_AVX2
+ endif
+ endif
+ ifeq "$(shell echo 'int main() {return 0; }' | $(CC) $(CFLAGS) -Werror -x c - -march=native -o .test 2>/dev/null && echo 1 || echo 0 ; rm -f .test )" "1"
+ HAVE_MARCHNATIVE = 1
+ SPECIAL_PERFORMANCE += -march=native
+ endif
+ $(info SPECIAL_PERFORMANCE=$(SPECIAL_PERFORMANCE))
+else
+ SPECIAL_PERFORMANCE :=
+endif
ifneq "$(SYS)" "Darwin"
- #ifeq "$(HAVE_MARCHNATIVE)" "1"
- # SPECIAL_PERFORMANCE += -march=native
- #endif
+ #ifeq "$(HAVE_MARCHNATIVE)" "1"
+ # SPECIAL_PERFORMANCE += -march=native
+ #endif
#ifndef DEBUG
- # CFLAGS_OPT += -D_FORTIFY_SOURCE=1
+ # override CFLAGS_OPT += -D_FORTIFY_SOURCE=1
#endif
else
# On some odd MacOS system configurations, the Xcode sdk path is not set correctly
SDK_LD = -L$(shell xcrun --show-sdk-path)/usr/lib
- LDFLAGS += $(SDK_LD)
+ override LDFLAGS += $(SDK_LD)
endif
COMPILER_TYPE=$(shell $(CC) --version|grep "Free Software Foundation")
ifneq "$(COMPILER_TYPE)" ""
#$(info gcc is being used)
- CFLAGS_OPT += -Wno-error=format-truncation -Wno-format-truncation
+ override CFLAGS_OPT += -Wno-error=format-truncation -Wno-format-truncation
endif
ifeq "$(SYS)" "SunOS"
- LDFLAGS = -lkstat -lrt -lsocket -lnsl
+ override LDFLAGS = -lkstat -lrt -lsocket -lnsl
endif
ifdef STATIC
@@ -125,8 +131,8 @@ ifdef STATIC
PYFLAGS=
PYTHON_INCLUDE = /
- CFLAGS_OPT += -static
- LDFLAGS += -lm -lpthread -lz -lutil
+ override CFLAGS_OPT += -static
+ override LDFLAGS += -lm -lpthread -lz -lutil
endif
ifdef PROFILING
@@ -389,6 +395,7 @@ help:
@echo
@echo Known build environment options:
@echo "=========================================="
+ @echo "PERFORMANCE - compile with performance options that make the binary not transferable to other systems. Recommended!"
@echo STATIC - compile AFL++ static
@echo "CODE_COVERAGE - compile the target for code coverage (see docs/instrumentation/README.llvm.md)"
@echo ASAN_BUILD - compiles AFL++ with memory sanitizer for debug purposes
@@ -453,31 +460,31 @@ afl-as: src/afl-as.c include/afl-as.h $(COMM_HDR) | test_x86
@ln -sf afl-as as
src/afl-performance.o : $(COMM_HDR) src/afl-performance.c include/hash.h
- $(CC) $(CFLAGS) $(CFLAGS_OPT) -Iinclude -c src/afl-performance.c -o src/afl-performance.o
+ $(CC) $(CFLAGS) $(CFLAGS_OPT) $(SPECIAL_PERFORMANCE) -Iinclude -c src/afl-performance.c -o src/afl-performance.o
src/afl-common.o : $(COMM_HDR) src/afl-common.c include/common.h
- $(CC) $(CFLAGS) $(CFLAGS_FLTO) -c src/afl-common.c -o src/afl-common.o
+ $(CC) $(CFLAGS) $(CFLAGS_FLTO) $(SPECIAL_PERFORMANCE) -c src/afl-common.c -o src/afl-common.o
src/afl-forkserver.o : $(COMM_HDR) src/afl-forkserver.c include/forkserver.h
- $(CC) $(CFLAGS) $(CFLAGS_FLTO) -c src/afl-forkserver.c -o src/afl-forkserver.o
+ $(CC) $(CFLAGS) $(CFLAGS_FLTO) $(SPECIAL_PERFORMANCE) -c src/afl-forkserver.c -o src/afl-forkserver.o
src/afl-sharedmem.o : $(COMM_HDR) src/afl-sharedmem.c include/sharedmem.h
- $(CC) $(CFLAGS) $(CFLAGS_FLTO) -c src/afl-sharedmem.c -o src/afl-sharedmem.o
+ $(CC) $(CFLAGS) $(CFLAGS_FLTO) $(SPECIAL_PERFORMANCE) -c src/afl-sharedmem.c -o src/afl-sharedmem.o
-afl-fuzz: $(COMM_HDR) include/afl-fuzz.h $(AFL_FUZZ_FILES) src/afl-common.o src/afl-sharedmem.o src/afl-forkserver.o src/afl-performance.o | test_x86
- $(CC) $(CFLAGS) $(COMPILE_STATIC) $(CFLAGS_FLTO) $(AFL_FUZZ_FILES) src/afl-common.o src/afl-sharedmem.o src/afl-forkserver.o src/afl-performance.o -o $@ $(PYFLAGS) $(LDFLAGS) -lm
+afl-fuzz: $(COMM_HDR) include/afl-fuzz.h $(AFL_FUZZ_FILES) src/afl-common.o src/afl-sharedmem.o src/afl-forkserver.o src/afl-performance.o src/hashmap.c | test_x86
+ $(CC) $(CFLAGS) $(COMPILE_STATIC) $(CFLAGS_FLTO) $(SPECIAL_PERFORMANCE) -Wno-shift-count-overflow $(AFL_FUZZ_FILES) src/afl-common.o src/afl-sharedmem.o src/afl-forkserver.o src/afl-performance.o src/hashmap.c -o $@ $(PYFLAGS) $(LDFLAGS) -lm
afl-showmap: src/afl-showmap.c src/afl-common.o src/afl-sharedmem.o src/afl-forkserver.o src/afl-performance.o $(COMM_HDR) | test_x86
- $(CC) $(CFLAGS) $(COMPILE_STATIC) $(CFLAGS_FLTO) src/$@.c src/afl-fuzz-mutators.c src/afl-fuzz-python.c src/afl-common.o src/afl-sharedmem.o src/afl-forkserver.o src/afl-performance.o -o $@ $(PYFLAGS) $(LDFLAGS)
+ $(CC) $(CFLAGS) $(COMPILE_STATIC) $(CFLAGS_FLTO) $(SPECIAL_PERFORMANCE) src/$@.c src/afl-fuzz-mutators.c src/afl-fuzz-python.c src/afl-common.o src/afl-sharedmem.o src/afl-forkserver.o src/afl-performance.o -o $@ $(PYFLAGS) $(LDFLAGS)
afl-tmin: src/afl-tmin.c src/afl-common.o src/afl-sharedmem.o src/afl-forkserver.o src/afl-performance.o $(COMM_HDR) | test_x86
- $(CC) $(CFLAGS) $(COMPILE_STATIC) $(CFLAGS_FLTO) src/$@.c src/afl-common.o src/afl-sharedmem.o src/afl-forkserver.o src/afl-performance.o -o $@ $(LDFLAGS)
+ $(CC) $(CFLAGS) $(COMPILE_STATIC) $(CFLAGS_FLTO) $(SPECIAL_PERFORMANCE) src/$@.c src/afl-common.o src/afl-sharedmem.o src/afl-forkserver.o src/afl-performance.o -o $@ $(LDFLAGS)
afl-analyze: src/afl-analyze.c src/afl-common.o src/afl-sharedmem.o src/afl-performance.o src/afl-forkserver.o $(COMM_HDR) | test_x86
- $(CC) $(CFLAGS) $(COMPILE_STATIC) $(CFLAGS_FLTO) src/$@.c src/afl-common.o src/afl-sharedmem.o src/afl-performance.o src/afl-forkserver.o -o $@ $(LDFLAGS)
+ $(CC) $(CFLAGS) $(COMPILE_STATIC) $(CFLAGS_FLTO) $(SPECIAL_PERFORMANCE) src/$@.c src/afl-common.o src/afl-sharedmem.o src/afl-performance.o src/afl-forkserver.o -o $@ $(LDFLAGS)
afl-gotcpu: src/afl-gotcpu.c src/afl-common.o $(COMM_HDR) | test_x86
- $(CC) $(CFLAGS) $(COMPILE_STATIC) $(CFLAGS_FLTO) src/$@.c src/afl-common.o -o $@ $(LDFLAGS)
+ $(CC) $(CFLAGS) $(COMPILE_STATIC) $(CFLAGS_FLTO) $(SPECIAL_PERFORMANCE) src/$@.c src/afl-common.o -o $@ $(LDFLAGS)
.PHONY: document
document: afl-fuzz-document
@@ -494,17 +501,17 @@ unit_maybe_alloc: test/unittests/unit_maybe_alloc.o
./test/unittests/unit_maybe_alloc
test/unittests/unit_hash.o : $(COMM_HDR) include/alloc-inl.h test/unittests/unit_hash.c $(AFL_FUZZ_FILES) src/afl-performance.o
- @$(CC) $(CFLAGS) $(ASAN_CFLAGS) -c test/unittests/unit_hash.c -o test/unittests/unit_hash.o
+ @$(CC) $(CFLAGS) $(ASAN_CFLAGS) $(SPECIAL_PERFORMANCE) -c test/unittests/unit_hash.c -o test/unittests/unit_hash.o
unit_hash: test/unittests/unit_hash.o src/afl-performance.o
- @$(CC) $(CFLAGS) -Wl,--wrap=exit -Wl,--wrap=printf $^ -o test/unittests/unit_hash $(LDFLAGS) $(ASAN_LDFLAGS) -lcmocka
+ @$(CC) $(CFLAGS) $(SPECIAL_PERFORMANCE) -Wl,--wrap=exit -Wl,--wrap=printf $^ -o test/unittests/unit_hash $(LDFLAGS) $(ASAN_LDFLAGS) -lcmocka
./test/unittests/unit_hash
test/unittests/unit_rand.o : $(COMM_HDR) include/alloc-inl.h test/unittests/unit_rand.c $(AFL_FUZZ_FILES) src/afl-performance.o
- @$(CC) $(CFLAGS) $(ASAN_CFLAGS) -c test/unittests/unit_rand.c -o test/unittests/unit_rand.o
+ @$(CC) $(CFLAGS) $(ASAN_CFLAGS) $(SPECIAL_PERFORMANCE) -c test/unittests/unit_rand.c -o test/unittests/unit_rand.o
unit_rand: test/unittests/unit_rand.o src/afl-common.o src/afl-performance.o
- @$(CC) $(CFLAGS) $(ASAN_CFLAGS) -Wl,--wrap=exit -Wl,--wrap=printf $^ -o test/unittests/unit_rand $(LDFLAGS) $(ASAN_LDFLAGS) -lcmocka
+ @$(CC) $(CFLAGS) $(ASAN_CFLAGS) $(SPECIAL_PERFORMANCE) -Wl,--wrap=exit -Wl,--wrap=printf $^ -o test/unittests/unit_rand $(LDFLAGS) $(ASAN_LDFLAGS) -lcmocka
./test/unittests/unit_rand
test/unittests/unit_list.o : $(COMM_HDR) include/list.h test/unittests/unit_list.c $(AFL_FUZZ_FILES)
@@ -752,7 +759,7 @@ endif
@test -e SanitizerCoveragePCGUARD.so && echo "[+] LLVM mode successfully built" || echo "[-] LLVM mode could not be built, please install at least llvm-13 and clang-13 or newer, see docs/INSTALL.md"
@test -e SanitizerCoverageLTO.so && echo "[+] LLVM LTO mode successfully built" || echo "[-] LLVM LTO mode could not be built, it is optional, if you want it, please install LLVM 11-14. More information at instrumentation/README.lto.md on how to build it"
ifneq "$(SYS)" "Darwin"
- test -e afl-gcc-pass.so && echo "[+] gcc_mode successfully built" || echo "[-] gcc_mode could not be built, it is optional, install gcc-VERSION-plugin-dev to enable this"
+ @test -e afl-gcc-pass.so && echo "[+] gcc_mode successfully built" || echo "[-] gcc_mode could not be built, it is optional, install gcc-VERSION-plugin-dev to enable this"
endif
ifeq "$(SYS)" "Linux"
ifndef NO_NYX
diff --git a/GNUmakefile.llvm b/GNUmakefile.llvm
index ec8fefe4..98ae461c 100644
--- a/GNUmakefile.llvm
+++ b/GNUmakefile.llvm
@@ -44,7 +44,7 @@ endif
LLVMVER = $(shell $(LLVM_CONFIG) --version 2>/dev/null | sed 's/git//' | sed 's/svn//' )
LLVM_MAJOR = $(shell $(LLVM_CONFIG) --version 2>/dev/null | sed 's/\..*//' )
-LLVM_MINOR = $(shell $(LLVM_CONFIG) --version 2>/dev/null | sed 's/.*\.//' | sed 's/git//' | sed 's/svn//' | sed 's/ .*//' )
+LLVM_MINOR = $(shell $(LLVM_CONFIG) --version 2>/dev/null | sed 's/.*\.//' | sed 's/git//' | sed 's/svn//' | sed 's/ .*//' | sed 's/rc.*//' )
LLVM_UNSUPPORTED = $(shell $(LLVM_CONFIG) --version 2>/dev/null | grep -E -q '^[0-2]\.|^3.[0-8]\.' && echo 1 || echo 0 )
LLVM_TOO_NEW = $(shell $(LLVM_CONFIG) --version 2>/dev/null | grep -E -q '^1[8-9]|^2[0-9]' && echo 1 || echo 0 )
LLVM_TOO_OLD = $(shell $(LLVM_CONFIG) --version 2>/dev/null | grep -E -q '^[1-9]\.|^1[012]\.' && echo 1 || echo 0 )
diff --git a/README.md b/README.md
index f713e971..2583407e 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@
<img align="right" src="https://raw.githubusercontent.com/AFLplusplus/Website/main/static/aflpp_bg.svg" alt="AFL++ logo" width="250" heigh="250">
-Release version: [4.10c](https://github.com/AFLplusplus/AFLplusplus/releases)
+Release version: [4.20c](https://github.com/AFLplusplus/AFLplusplus/releases)
-GitHub version: 4.10c
+GitHub version: 4.20c
Repository:
[https://github.com/AFLplusplus/AFLplusplus](https://github.com/AFLplusplus/AFLplusplus)
diff --git a/TODO.md b/TODO.md
index f2e3963f..d47372b8 100644
--- a/TODO.md
+++ b/TODO.md
@@ -2,17 +2,15 @@
## Must
- - UI revamp
- hardened_usercopy=0 page_alloc.shuffle=0
- add value_profile but only enable after 15 minutes without finds
- - cmplog max len, cmplog max items envs?
+ - cmplog max items env?
- adapt MOpt to new mutation engine
- Update afl->pending_not_fuzzed for MOpt
- cmplog rtn sanity check on fixed length? currently we ignore the length
- afl-showmap -f support
- afl-fuzz multicore wrapper script
- when trimming then perform crash detection
- - problem: either -L0 and/or -p mmopt results in zero new coverage
## Should
diff --git a/afl-cmin b/afl-cmin
index 4aaf3953..a1d5401f 100755
--- a/afl-cmin
+++ b/afl-cmin
@@ -108,7 +108,7 @@ function usage() {
"\n" \
"Execution control settings:\n" \
" -T tasks - how many parallel tasks to run (default: 1, all=nproc)\n" \
-" -f file - location read by the fuzzed program (stdin)\n" \
+" -f file - location read by the fuzzed program (default: stdin)\n" \
" -m megs - memory limit for child process ("mem_limit" MB)\n" \
" -t msec - run time limit for child process (default: 5000)\n" \
" -O - use binary-only instrumentation (FRIDA mode)\n" \
diff --git a/afl-persistent-config b/afl-persistent-config
index 26be9d9f..dede032f 100755
--- a/afl-persistent-config
+++ b/afl-persistent-config
@@ -124,17 +124,26 @@ kernel.sched_latency_ns=250000000
EOF
}
- grep -E -q '^GRUB_CMDLINE_LINUX_DEFAULT=' /etc/default/grub 2>/dev/null || echo Error: /etc/default/grub with GRUB_CMDLINE_LINUX_DEFAULT is not present, cannot set boot options
- grep -E -q '^GRUB_CMDLINE_LINUX_DEFAULT=' /etc/default/grub 2>/dev/null && {
- grep -E '^GRUB_CMDLINE_LINUX_DEFAULT=' /etc/default/grub | grep -E -q 'noibrs pcid nopti' || {
+ grub_try_disable_mitigation () {
+ KEY="$1"
+ if ! grep -E "^$KEY=" /etc/default/grub | grep -E -q 'noibrs pcid nopti'; then
echo "Configuring performance boot options"
- LINE=`grep -E '^GRUB_CMDLINE_LINUX_DEFAULT=' /etc/default/grub | sed 's/^GRUB_CMDLINE_LINUX_DEFAULT=//' | tr -d '"'`
- OPTIONS="$LINE ibpb=off ibrs=off kpti=off l1tf=off mds=off mitigations=off no_stf_barrier noibpb noibrs pcid nopti nospec_store_bypass_disable nospectre_v1 nospectre_v2 pcid=on pti=off spec_store_bypass_disable=off spectre_v2=off stf_barrier=off srbds=off noexec=off noexec32=off tsx=on tsx=on tsx_async_abort=off mitigations=off audit=0 hardened_usercopy=off ssbd=force-off"
- echo Setting boot options in /etc/default/grub to GRUB_CMDLINE_LINUX_DEFAULT=\"$OPTIONS\"
- sed -i "s|^GRUB_CMDLINE_LINUX_DEFAULT=.*|GRUB_CMDLINE_LINUX_DEFAULT=\"$OPTIONS\"|" /etc/default/grub
- }
+ LINE=`grep -E "^$KEY=" /etc/default/grub | sed "s/^$KEY=//" | tr -d '"'`
+ OPTIONS="$LINE ibpb=off ibrs=off kpti=off l1tf=off spec_rstack_overflow=off mds=off no_stf_barrier noibpb noibrs pcid nopti nospec_store_bypass_disable nospectre_v1 nospectre_v2 pcid=on pti=off spec_store_bypass_disable=off spectre_v2=off stf_barrier=off srbds=off noexec=off noexec32=off tsx=on tsx=on tsx_async_abort=off mitigations=off audit=0 hardened_usercopy=off ssbd=force-off"
+ echo Setting boot options in /etc/default/grub to $KEY=\"$OPTIONS\"
+ sed -i "s|^$KEY=.*|$KEY=\"$OPTIONS\"|" /etc/default/grub
+ fi
}
+
+ if grep -E -q '^GRUB_CMDLINE_LINUX=' /etc/default/grub || grep -E -q '^GRUB_CMDLINE_LINUX_DEFAULT=' /etc/default/grub; then
+ grub_try_disable_mitigation "GRUB_CMDLINE_LINUX_DEFAULT"
+ # We also overwrite GRUB_CMDLINE_LINUX because some distributions already overwrite GRUB_CMDLINE_LINUX_DEFAULT
+ grub_try_disable_mitigation "GRUB_CMDLINE_LINUX"
+ else
+ echo "Error: /etc/default/grub with GRUB_CMDLINE_LINUX is not present, cannot set boot options"
+ fi
+
echo
echo "Reboot and enjoy your fuzzing"
exit 0
diff --git a/afl-whatsup b/afl-whatsup
index aa081e41..55ef2473 100755
--- a/afl-whatsup
+++ b/afl-whatsup
@@ -114,6 +114,7 @@ fi
CUR_TIME=`date +%s`
TMP=`mktemp -t .afl-whatsup-XXXXXXXX` || TMP=`mktemp -p /data/local/tmp .afl-whatsup-XXXXXXXX` || TMP=`mktemp -p /data/local/tmp .afl-whatsup-XXXXXXXX` || exit 1
+trap "rm -f $TMP" 1 2 3 13 15
ALIVE_CNT=0
DEAD_CNT=0
@@ -122,6 +123,7 @@ START_CNT=0
TOTAL_TIME=0
TOTAL_EXECS=0
TOTAL_EPS=0
+TOTAL_EPLM=0
TOTAL_CRASHES=0
TOTAL_HANGS=0
TOTAL_PFAV=0
@@ -181,6 +183,8 @@ for j in `find . -maxdepth 2 -iname fuzzer_setup | sort`; do
if [ -f "$i" ]; then
+ IS_STARTING=
+ IS_DEAD=
sed 's/^command_line.*$/_skip:1/;s/[ ]*:[ ]*/="/;s/$/"/' "$i" >"$TMP"
. "$TMP"
DIRECTORY=$DIR
@@ -211,9 +215,6 @@ for j in `find . -maxdepth 2 -iname fuzzer_setup | sort`; do
if ! kill -0 "$fuzzer_pid" 2>/dev/null; then
- IS_STARTING=
- IS_DEAD=
-
if [ -e "$i" ] && [ -e "$j" ] && [ -n "$FUSER" ]; then
if [ "$i" -ot "$j" ]; then
@@ -272,11 +273,15 @@ for j in `find . -maxdepth 2 -iname fuzzer_setup | sort`; do
ALIVE_CNT=$((ALIVE_CNT + 1))
EXEC_SEC=0
+ EXEC_MIN=0
test -z "$RUN_UNIX" -o "$RUN_UNIX" = 0 || EXEC_SEC=$((execs_done / RUN_UNIX))
PATH_PERC=$((cur_item * 100 / corpus_count))
+
+ test "$IS_DEAD" = 1 || EXEC_MIN=$(echo $execs_ps_last_min|sed 's/\..*//')
TOTAL_TIME=$((TOTAL_TIME + RUN_UNIX))
TOTAL_EPS=$((TOTAL_EPS + EXEC_SEC))
+ TOTAL_EPLM=$((TOTAL_EPLM + EXEC_MIN))
TOTAL_EXECS=$((TOTAL_EXECS + execs_done))
TOTAL_CRASHES=$((TOTAL_CRASHES + saved_crashes))
TOTAL_HANGS=$((TOTAL_HANGS + saved_hangs))
@@ -398,41 +403,44 @@ if [ -z "$SUMMARY_ONLY" -o -z "$MINIMAL_ONLY" ]; then
echo
fi
-echo " Fuzzers alive : $ALIVE_CNT"
+echo " Fuzzers alive : $ALIVE_CNT"
if [ ! "$START_CNT" = "0" ]; then
- echo " Starting up : $START_CNT ($TXT)"
+ echo " Starting up : $START_CNT ($TXT)"
fi
if [ ! "$DEAD_CNT" = "0" ]; then
- echo " Dead or remote : $DEAD_CNT ($TXT)"
+ echo " Dead or remote : $DEAD_CNT ($TXT)"
fi
-echo " Total run time : $FMT_TIME"
+echo " Total run time : $FMT_TIME"
if [ -z "$MINIMAL_ONLY" ]; then
- echo " Total execs : $FMT_EXECS"
- echo " Cumulative speed : $TOTAL_EPS execs/sec"
+ echo " Total execs : $FMT_EXECS"
+ echo " Cumulative speed : $TOTAL_EPS execs/sec"
+ if [ "$ALIVE_CNT" -gt "0" ]; then
+ echo " Total average speed : $((TOTAL_EPS / ALIVE_CNT)) execs/sec"
+ fi
fi
if [ "$ALIVE_CNT" -gt "0" ]; then
- echo " Average speed : $((TOTAL_EPS / ALIVE_CNT)) execs/sec"
+ echo "Current average speed : $TOTAL_EPLM execs/sec"
fi
if [ -z "$MINIMAL_ONLY" ]; then
- echo " Pending items : $TOTAL_PFAV faves, $TOTAL_PENDING total"
+ echo " Pending items : $TOTAL_PFAV faves, $TOTAL_PENDING total"
fi
if [ "$ALIVE_CNT" -gt "1" -o -n "$MINIMAL_ONLY" ]; then
if [ "$ALIVE_CNT" -gt "0" ]; then
- echo " Pending per fuzzer : $((TOTAL_PFAV/ALIVE_CNT)) faves, $((TOTAL_PENDING/ALIVE_CNT)) total (on average)"
+ echo " Pending per fuzzer : $((TOTAL_PFAV/ALIVE_CNT)) faves, $((TOTAL_PENDING/ALIVE_CNT)) total (on average)"
fi
fi
-echo " Coverage reached : ${TOTAL_COVERAGE}%"
-echo " Crashes saved : $TOTAL_CRASHES"
+echo " Coverage reached : ${TOTAL_COVERAGE}%"
+echo " Crashes saved : $TOTAL_CRASHES"
if [ -z "$MINIMAL_ONLY" ]; then
- echo " Hangs saved : $TOTAL_HANGS"
- echo "Cycles without finds : $TOTAL_WCOP"
+ echo " Hangs saved : $TOTAL_HANGS"
+ echo " Cycles without finds : $TOTAL_WCOP"
fi
-echo " Time without finds : $TOTAL_LAST_FIND"
+echo " Time without finds : $TOTAL_LAST_FIND"
echo
exit 0
diff --git a/benchmark/COMPARISON.md b/benchmark/COMPARISON.md
index 49c107a2..e16ef213 100644
--- a/benchmark/COMPARISON.md
+++ b/benchmark/COMPARISON.md
@@ -1,9 +1,13 @@
-CPU | MHz | threads | singlecore | multicore | afl-*-config |
-====================================================|=======|=========|============|===========|==============|
-Raspberry Pi 5 | 2400 | 4 | 25786 | 101114 | both |
-AMD EPYC 7282 16-Core Processor | 3194 | 32 | 87199 | 769001 | both |
-AMD Ryzen 5 PRO 4650G with Radeon Graphics | 3700 | 12 | 95356 | 704840 | both |
-Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz | 4995 | 16 | 120064 | 1168943 | both |
-12th Gen Intel(R) Core(TM) i7-1270P | 4761 | 16 | 149778 | 641219 | both |
-AMD Ryzen 9 5950X 16-Core Processor | 4792 | 32 | 161690 | 2339763 | both |
-Apple Mac Studio M2 Ultra 2023, Linux VM guest | 3500 | 16 | 163570 | 1157465 | both |
+|CPU | MHz | threads | singlecore | multicore | afl-*-config |
+|----------------------------------------------------|-------|---------|------------|-----------|--------------|
+|Raspberry Pi 5 | 2400 | 4 | 25786 | 101114 | both |
+|AMD EPYC 7282 16-Core Processor | 3194 | 32 | 87199 | 769001 | both |
+|AMD Ryzen 5 PRO 4650G with Radeon Graphics | 3700 | 12 | 95356 | 704840 | both |
+|Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz | 4995 | 16 | 120064 | 1168943 | both |
+|12th Gen Intel(R) Core(TM) i7-1270P | 4761 | 16 | 149778 | 641219 | both |
+|AMD Ryzen 9 5950X 16-Core Processor | 4792 | 32 | 161690 | 2339763 | both |
+|Apple Mac Studio M2 Ultra 2023, Linux VM guest | 3500 | 16 | 163570 | 1157465 | both |
+|AMD Ryzen 9 6900HS with Radeon Graphics | 4676 | 16 | 62860 | 614404 | system |
+|AMD Ryzen 9 6900HS with Radeon Graphics | 4745 | 16 | 135501 | 991133 | both |
+|AMD Ryzen 9 7950X3D 16-Core Processor | 5400 | 32 | 71566 | 1566279 | system |
+|AMD Ryzen 9 7950X3D 16-Core Processor | 5478 | 32 | 161960 | 2173959 | both |
diff --git a/benchmark/benchmark-results.jsonl b/benchmark/benchmark-results.jsonl
index ac800d65..91acb6fa 100644
--- a/benchmark/benchmark-results.jsonl
+++ b/benchmark/benchmark-results.jsonl
@@ -418,3 +418,7 @@
{"config": {"afl_persistent_config": true, "afl_system_config": true, "afl_version": "++4.08a", "comment": "", "compiler": "Ubuntu clang version 14.0.0-1ubuntu1.1", "target_arch": "x86_64-pc-linux-gnu"}, "hardware": {"cpu_fastest_core_mhz": 3700.0, "cpu_model": "AMD Ryzen 5 PRO 4650G with Radeon Graphics", "cpu_threads": 12}, "targets": {"test-instr-persist-shmem": {"multicore": {"execs_per_sec": 704840.16, "execs_total": 21163992, "fuzzers_used": 12}, "singlecore": {"execs_per_sec": 95356.14, "execs_total": 2862114, "fuzzers_used": 1}}}}
{"config": {"afl_persistent_config": true, "afl_system_config": true, "afl_version": "++4.09a", "comment": "", "compiler": "Debian clang version 14.0.6", "target_arch": "aarch64-unknown-linux-gnu"}, "hardware": {"cpu_fastest_core_mhz": 2400.0, "cpu_model": "Raspberry Pi 5", "cpu_threads": 4}, "targets": {"test-instr-persist-shmem": {"multicore": {"execs_per_sec": 101114.23, "execs_total": 3036637, "fuzzers_used": 4}, "singlecore": {"execs_per_sec": 25786.11, "execs_total": 774460, "fuzzers_used": 1}}}}
{"config": {"afl_persistent_config": true, "afl_system_config": true, "afl_version": "++4.07a", "comment": "", "compiler": "Debian clang version 17.0.0 (++20230417071830+ae77aceba5ad-1~exp1~20230417071935.630)", "target_arch": "x86_64-pc-linux-gnu"}, "hardware": {"cpu_fastest_core_mhz": 4792.073, "cpu_model": "AMD Ryzen 9 5950X 16-Core Processor", "cpu_threads": 32}, "targets": {"test-instr-persist-shmem": {"multicore": {"execs_per_sec": 2339762.91, "execs_total": 70253164, "fuzzers_used": 32}, "singlecore": {"execs_per_sec": 161690.07, "execs_total": 4851838, "fuzzers_used": 1}}}}
+{"config": {"afl_persistent_config": false, "afl_system_config": true, "afl_version": "++4.10c", "comment": "", "compiler": "clang version 17.0.6", "target_arch": "x86_64-pc-linux-gnu"}, "hardware": {"cpu_fastest_core_mhz": 4675.949, "cpu_model": "AMD Ryzen 9 6900HS with Radeon Graphics", "cpu_threads": 16}, "targets": {"test-instr-persist-shmem": {"multicore": {"execs_per_sec": 614403.91, "execs_total": 18435083, "fuzzers_used": 16}, "singlecore": {"execs_per_sec": 62859.9, "execs_total": 1886111, "fuzzers_used": 1}}}}
+{"config": {"afl_persistent_config": true, "afl_system_config": true, "afl_version": "++4.10c", "comment": "", "compiler": "clang version 17.0.6", "target_arch": "x86_64-pc-linux-gnu"}, "hardware": {"cpu_fastest_core_mhz": 4744.522, "cpu_model": "AMD Ryzen 9 6900HS with Radeon Graphics", "cpu_threads": 16}, "targets": {"test-instr-persist-shmem": {"multicore": {"execs_per_sec": 991132.96, "execs_total": 29737588, "fuzzers_used": 16}, "singlecore": {"execs_per_sec": 135501.07, "execs_total": 4066116, "fuzzers_used": 1}}}}
+{"config": {"afl_persistent_config": false, "afl_system_config": true, "afl_version": "++4.10c", "comment": "", "compiler": "Ubuntu clang version 14.0.6", "target_arch": "x86_64-pc-linux-gnu"}, "hardware": {"cpu_fastest_core_mhz": 5399.822, "cpu_model": "AMD Ryzen 9 7950X3D 16-Core Processor", "cpu_threads": 32}, "targets": {"test-instr-persist-shmem": {"multicore": {"execs_per_sec": 1566279.42, "execs_total": 46994452, "fuzzers_used": 32}, "singlecore": {"execs_per_sec": 71565.56, "execs_total": 2147396, "fuzzers_used": 1}}}}
+{"config": {"afl_persistent_config": true, "afl_system_config": true, "afl_version": "++4.10c", "comment": "", "compiler": "clang version 17.0.6", "target_arch": "x86_64-pc-linux-gnu"}, "hardware": {"cpu_fastest_core_mhz": 5478.258, "cpu_model": "AMD Ryzen 9 7950X3D 16-Core Processor", "cpu_threads": 32}, "targets": {"test-instr-persist-shmem": {"multicore": {"execs_per_sec": 2173959.15, "execs_total": 65229513, "fuzzers_used": 32}, "singlecore": {"execs_per_sec": 161960.29, "execs_total": 4859457, "fuzzers_used": 1}}}}
diff --git a/benchmark/benchmark.py b/benchmark/benchmark.py
index 0685cedd..fffb4a3a 100755
--- a/benchmark/benchmark.py
+++ b/benchmark/benchmark.py
@@ -205,7 +205,7 @@ async def save_benchmark_results() -> None:
single = str(round(results.targets["test-instr-persist-shmem"]["singlecore"].execs_per_sec)).ljust(10)
multi = str(round(results.targets["test-instr-persist-shmem"]["multicore"].execs_per_sec)).ljust(9)
cores = str(args.fuzzers).ljust(7)
- comparisonfile.write(f"{cpu_model} | {cpu_mhz} | {cores} | {single} | {multi} | {aflconfig} |\n")
+ comparisonfile.write(f"|{cpu_model} | {cpu_mhz} | {cores} | {single} | {multi} | {aflconfig} |\n")
print(blue(f" [*] Results have been written to the COMPARISON.md file."))
with open("COMPARISON.md", "r") as comparisonfile:
print(comparisonfile.read())
diff --git a/custom_mutators/aflpp/aflpp.c b/custom_mutators/aflpp/aflpp.c
index e15d0391..0b236f76 100644
--- a/custom_mutators/aflpp/aflpp.c
+++ b/custom_mutators/aflpp/aflpp.c
@@ -1,3 +1,4 @@
+#include "afl-fuzz.h"
#include "afl-mutations.h"
typedef struct my_mutator {
diff --git a/custom_mutators/aflpp/standalone/aflpp-standalone.c b/custom_mutators/aflpp/standalone/aflpp-standalone.c
index 361feaba..3a2cbc2f 100644
--- a/custom_mutators/aflpp/standalone/aflpp-standalone.c
+++ b/custom_mutators/aflpp/standalone/aflpp-standalone.c
@@ -1,9 +1,6 @@
+#include "afl-fuzz.h"
#include "afl-mutations.h"
-s8 interesting_8[] = {INTERESTING_8};
-s16 interesting_16[] = {INTERESTING_8, INTERESTING_16};
-s32 interesting_32[] = {INTERESTING_8, INTERESTING_16, INTERESTING_32};
-
typedef struct my_mutator {
afl_state_t *afl;
@@ -155,7 +152,7 @@ int main(int argc, char *argv[]) {
return -1;
}
- if (verbose) fprintf(stderr, "Mutation output length: %zu\n", outlen);
+ if (verbose) fprintf(stderr, "Mutation output length: %u\n", outlen);
if (fwrite(outbuf, 1, outlen, out) != outlen) {
fprintf(stderr, "Warning: incomplete write.\n");
diff --git a/docs/Changelog.md b/docs/Changelog.md
index 48003f4b..2428d63f 100644
--- a/docs/Changelog.md
+++ b/docs/Changelog.md
@@ -3,6 +3,45 @@
This is the list of all noteworthy changes made in every public
release of the tool. See README.md for the general instruction manual.
+### Version ++4.20c (release)
+ ! A new forkserver communication model is now introduced. afl-fuzz is
+ backward compatible to old compiled targets if they are not built
+ for CMPLOG/Redqueen, but new compiled targets will not work with
+ old afl-fuzz versions!
+ ! Recompile all targets that are instrumented for CMPLOG/Redqueen!
+ - AFL++ now supports up to 4 billion coverage edges, up from 6 million.
+ - New compile option: `make PERFORMANCE=1` - this will enable special
+ CPU dependent optimizations that make everything more performant - but
+ the binaries will likely won't work on different platforms. Also
+ enables a faster hasher if the CPU requirements are met.
+ - The persistent record feature (see config.h) was expanded to also
+ support replay, thanks to @quarta-qti !
+ - afl-fuzz:
+ - the new deterministic fuzzing feature is now activated by default,
+ deactivate with -z. Parameters -d and -D are ignored.
+ - small improvements to CMPLOG/redqueen
+ - workround for a bug with MOpt -L when used with -M - in the future
+ we will either remove or rewrite MOpt.
+ - fix for `-t xxx+` feature
+ - -e extension option now saves the queue items, crashes, etc. with the
+ extension too
+ - fixes for trimmming, correct -V time and reading stats on resume by eqv
+ thanks a lot!
+ - afl-cc:
+ - added collision free caller instrumentation to LTO mode. activate with
+ `AFL_LLVM_LTO_CALLER=1`. You can set a max depth to go through single
+ block functions with `AFL_LLVM_LTO_CALLER_DEPTH` (default 0)
+ - fixes for COMPCOV/LAF and most other modules
+ - fix for GCC_PLUGIN cmplog that broke on std::strings
+ - afl-whatsup:
+ - now also displays current average speed
+ - small bugfixes
+ - Fixes for aflpp custom mutator and standalone tool
+ - Minor edits to afl-persistent-config
+ - Prevent temporary files being left behind on aborted afl-whatsup
+ - More CPU benchmarks added to benchmark/
+
+
### Version ++4.10c (release)
- afl-fuzz:
- default power schedule is now EXPLORE, due a fix in fast schedules
diff --git a/docs/INSTALL.md b/docs/INSTALL.md
index 84bbe3ea..3089aab2 100644
--- a/docs/INSTALL.md
+++ b/docs/INSTALL.md
@@ -21,7 +21,7 @@ If you want to build AFL++ yourself, you have many options. The easiest choice
is to build and install everything:
NOTE: depending on your Debian/Ubuntu/Kali/... release, replace `-14` with
-whatever llvm version is available. We recommend llvm 13, 14, 15 or 16.
+whatever llvm version is available. We recommend llvm 13 or newer.
```shell
sudo apt-get update
@@ -67,19 +67,20 @@ These build targets exist:
* unit: perform unit tests (based on cmocka)
* help: shows these build options
-[Unless you are on Mac OS X](https://developer.apple.com/library/archive/qa/qa1118/_index.html),
+[Unless you are on macOS](https://developer.apple.com/library/archive/qa/qa1118/_index.html),
you can also build statically linked versions of the AFL++ binaries by passing
-the `STATIC=1` argument to make:
+the `PERFORMANCE=1` argument to make:
```shell
-make STATIC=1
+make PERFORMANCE=1
```
These build options exist:
-* STATIC - compile AFL++ static
-* CODE_COVERAGE - compile the target for code coverage (see docs/instrumentation/README.llvm.md)
-* ASAN_BUILD - compiles AFL++ with memory sanitizer for debug purposes
+* PERFORMANCE - compile with performance options that make the binary not transferable to other systems. Recommended (except on macOS)!
+* STATIC - compile AFL++ static (does not work on macOS)
+* CODE_COVERAGE - compile the target for code coverage (see [README.llvm.md](../instrumentation/README.llvm.md))
+* ASAN_BUILD - compiles AFL++ with address sanitizer for debug purposes
* UBSAN_BUILD - compiles AFL++ tools with undefined behaviour sanitizer for debug purposes
* DEBUG - no optimization, -ggdb3, all warnings and -Werror
* LLVM_DEBUG - shows llvm deprecation warnings
@@ -91,101 +92,78 @@ These build options exist:
* NO_NYX - disable building nyx mode dependencies
* NO_CORESIGHT - disable building coresight (arm64 only)
* NO_UNICORN_ARM64 - disable building unicorn on arm64
-* AFL_NO_X86 - if compiling on non-intel/amd platforms
+* AFL_NO_X86 - if compiling on non-Intel/AMD platforms
* LLVM_CONFIG - if your distro doesn't use the standard name for llvm-config (e.g., Debian)
e.g.: `make LLVM_CONFIG=llvm-config-14`
-## MacOS X on x86 and arm64 (M1)
+## macOS on x86_64 and arm64
-MacOS has some gotchas due to the idiosyncrasies of the platform.
+macOS has some gotchas due to the idiosyncrasies of the platform.
-To build AFL, install llvm (and perhaps gcc) from brew and follow the general
-instructions for Linux. If possible, avoid Xcode at all cost.
+macOS supports SYSV shared memory used by AFL++'s instrumentation, but the
+default settings aren't sufficient. Before even building, increase
+them by running the provided script:
+
+```shell
+sudo afl-system-config
+```
+
+See
+[https://www.spy-hill.com/help/apple/SharedMemory.html](https://www.spy-hill.com/help/apple/SharedMemory.html)
+for documentation for the shared memory settings and how to make them permanent.
+
+Next, to build AFL++, install the following packages from brew:
```shell
brew install wget git make cmake llvm gdb coreutils
```
-Be sure to setup `PATH` to point to the correct clang binaries and use the
-freshly installed clang, clang++, llvm-config, gmake and coreutils, e.g.:
+Depending on your macOS system + brew version, brew may be installed in different places.
+You can check with `brew info llvm` to know where, then create a variable for it:
```shell
-# Depending on your MacOS system + brew version it is either
-export PATH="/opt/homebrew/opt/llvm/bin:$PATH"
-# or
-export PATH="/usr/local/opt/llvm/bin:/usr/local/opt/coreutils/libexec/gnubin:$PATH"
-# you can check with "brew info llvm"
+export HOMEBREW_BASE="/opt/homebrew/opt"
+```
-export PATH="/usr/local/bin:$PATH"
+or
+
+```shell
+export HOMEBREW_BASE="/usr/local/opt"
+```
+
+Set `PATH` to point to the brew clang, clang++, llvm-config, gmake and coreutils.
+Also use the brew clang compiler; the Xcode clang compiler must not be used.
+
+```shell
+export PATH="$HOMEBREW_BASE/coreutils/libexec/gnubin:/usr/local/bin:$HOMEBREW_BASE/llvm/bin:$PATH"
export CC=clang
export CXX=clang++
-gmake
-cd frida_mode
-gmake
-cd ..
-sudo gmake install
```
-`afl-gcc` will fail unless you have GCC installed, but that is using outdated
-instrumentation anyway. `afl-clang` might fail too depending on your PATH setup.
-But you don't want neither, you want `afl-clang-fast` anyway :) Note that
-`afl-clang-lto`, `afl-gcc-fast` and `qemu_mode` are not working on MacOS.
+Then build following the general Linux instructions.
-The crash reporting daemon that comes by default with MacOS X will cause
-problems with fuzzing. You need to turn it off:
+If everything worked, you should then have `afl-clang-fast` installed, which you can check with:
+```shell
+which afl-clang-fast
```
-launchctl unload -w /System/Library/LaunchAgents/com.apple.ReportCrash.plist
-sudo launchctl unload -w /System/Library/LaunchDaemons/com.apple.ReportCrash.Root.plist
-```
-The `fork()` semantics on OS X are a bit unusual compared to other unix systems
+Note that `afl-clang-lto`, `afl-gcc-fast` and `qemu_mode` are not working on macOS.
+
+The crash reporting daemon that comes by default with macOS will cause
+problems with fuzzing. You need to turn it off, which you can do with `afl-system-config`.
+
+The `fork()` semantics on macOS are a bit unusual compared to other unix systems
and definitely don't look POSIX-compliant. This means two things:
- Fuzzing will be probably slower than on Linux. In fact, some folks report
considerable performance gains by running the jobs inside a Linux VM on
- MacOS X.
+ macOS.
- Some non-portable, platform-specific code may be incompatible with the AFL++
forkserver. If you run into any problems, set `AFL_NO_FORKSRV=1` in the
environment before starting afl-fuzz.
-User emulation mode of QEMU does not appear to be supported on MacOS X, so
+User emulation mode of QEMU does not appear to be supported on macOS, so
black-box instrumentation mode (`-Q`) will not work. However, FRIDA mode (`-O`)
-works on both x86 and arm64 MacOS boxes.
-
-MacOS X supports SYSV shared memory used by AFL's instrumentation, but the
-default settings aren't usable with AFL++. The default settings on 10.14 seem to
-be:
-
-```bash
-$ ipcs -M
-IPC status from <running system> as of XXX
-shminfo:
- shmmax: 4194304 (max shared memory segment size)
- shmmin: 1 (min shared memory segment size)
- shmmni: 32 (max number of shared memory identifiers)
- shmseg: 8 (max shared memory segments per process)
- shmall: 1024 (max amount of shared memory in pages)
-```
-
-To temporarily change your settings to something minimally usable with AFL++,
-run these commands as root:
-
-```bash
-sysctl kern.sysv.shmmax=8388608
-sysctl kern.sysv.shmall=4096
-```
-
-If you're running more than one instance of AFL, you likely want to make
-`shmall` bigger and increase `shmseg` as well:
-
-```bash
-sysctl kern.sysv.shmmax=8388608
-sysctl kern.sysv.shmseg=48
-sysctl kern.sysv.shmall=98304
-```
-
-See
-[http://www.spy-hill.com/help/apple/SharedMemory.html](http://www.spy-hill.com/help/apple/SharedMemory.html)
-for documentation for these settings and how to make them permanent.
+works on both x86 and arm64 macOS boxes.
diff --git a/docs/env_variables.md b/docs/env_variables.md
index a972b6da..1e4fc7ba 100644
--- a/docs/env_variables.md
+++ b/docs/env_variables.md
@@ -248,6 +248,9 @@ use (which only ever the author of this LTO implementation will use). These are
used if several separated instrumentations are performed which are then later
combined.
+ - `AFL_LLVM_LTO_CALLER` activates collision free CALLER instrumentation
+ - `AFL_LLVM_LTO_CALLER` sets the maximum mumber of single block functions
+ to dig deeper into a real function. Default 0.
- `AFL_LLVM_DOCUMENT_IDS=file` will document to a file which edge ID was given
to which function. This helps to identify functions with variable bytes or
which functions were touched by an input.
diff --git a/docs/fuzzing_in_depth.md b/docs/fuzzing_in_depth.md
index 6a217641..82437807 100644
--- a/docs/fuzzing_in_depth.md
+++ b/docs/fuzzing_in_depth.md
@@ -958,7 +958,7 @@ too long for your overall available fuzz run time.
campaign but not good for short CI runs.
How this can look like can, e.g., be seen at AFL++'s setup in Google's
-[oss-fuzz](https://github.com/google/oss-fuzz/blob/master/infra/base-images/base-builder/compile_afl)
+[previous oss-fuzz version](https://github.com/google/oss-fuzz/blob/3e2c5312417d1a6f9564472f3df1fd27759b289d/infra/base-images/base-builder/compile_afl)
and
[clusterfuzz](https://github.com/google/clusterfuzz/blob/master/src/clusterfuzz/_internal/bot/fuzzers/afl/launcher.py).
diff --git a/docs/third_party_tools.md b/docs/third_party_tools.md
index 02a40ce5..64a37c83 100644
--- a/docs/third_party_tools.md
+++ b/docs/third_party_tools.md
@@ -5,6 +5,10 @@
* [afl-rs](https://github.com/rust-fuzz/afl.rs) - AFL++ for RUST
* [WASM](https://github.com/fgsect/WAFL) - AFL++ for WASM
+## Starting multiple AFL++ instances in parallel with recommended settings:
+* [https://github.com/0xricksanchez/AFL_Runner](https://github.com/0xricksanchez/AFL_Runner)
+* [https://github.com/MegaManSec/AFLplusplus-Parallel-Gen](https://github.com/MegaManSec/AFLplusplus-Parallel-Gen)
+
## Speeding up fuzzing
* [libfiowrapper](https://github.com/marekzmyslowski/libfiowrapper) - if the
diff --git a/docs/tutorials.md b/docs/tutorials.md
index 0a09f6dc..f9378232 100644
--- a/docs/tutorials.md
+++ b/docs/tutorials.md
@@ -21,6 +21,9 @@ training, then we can highly recommend the following:
* [https://github.com/antonio-morales/Fuzzing101](https://github.com/antonio-morales/Fuzzing101)
+A good workflow overview (like our [fuzzing_in_depth.md](fuzzing_in_depth.md)):
+* [https://appsec.guide/docs/fuzzing/c-cpp/aflpp/](https://appsec.guide/docs/fuzzing/c-cpp/aflpp/)
+
Here is a good workflow description (and tutorial) for qemu_mode:
* [https://airbus-seclab.github.io/AFLplusplus-blogpost/](https://airbus-seclab.github.io/AFLplusplus-blogpost/)
diff --git a/frida_mode/update_frida_version.sh b/frida_mode/update_frida_version.sh
index 18243fbb..2fafbf2f 100755
--- a/frida_mode/update_frida_version.sh
+++ b/frida_mode/update_frida_version.sh
@@ -2,7 +2,7 @@
test -n "$1" && { echo This script has no options. It updates the referenced Frida version in GNUmakefile to the most current one. ; exit 1 ; }
OLD=$(grep -E '^GUM_DEVKIT_VERSION=' GNUmakefile 2>/dev/null|awk -F= '{print$2}')
-NEW=$(curl https://github.com/frida/frida/releases/ 2>/dev/null|grep -E 'frida-gum-devkit-[0-9.]*-linux-x86_64'|head -n 1|sed 's/.*frida-gum-devkit-//'|sed 's/-linux.*//')
+NEW=$(curl https://github.com/frida/frida/releases/ 2>/dev/null|grep 'Frida\ [0-9.]*'|head -n 1|sed 's/.*Frida\ //'| sed 's/<\/h2>//')
echo Current set version: $OLD
echo Newest available version: $NEW
diff --git a/include/afl-fuzz.h b/include/afl-fuzz.h
index c24f39e2..c813ae7e 100644
--- a/include/afl-fuzz.h
+++ b/include/afl-fuzz.h
@@ -5,9 +5,9 @@
Originally written by Michal Zalewski
Now maintained by Marc Heuse <mh@mh-sec.de>,
- Heiko Eißfeldt <heiko.eissfeldt@hexco.de>,
- Andrea Fioraldi <andreafioraldi@gmail.com>,
- Dominik Maier <mail@dmnk.co>
+ Dominik Maier <mail@dmnk.co>,
+ Andrea Fioraldi <andreafioraldi@gmail.com>, and
+ Heiko Eissfeldt <heiko.eissfeldt@hexco.de>
Copyright 2016, 2017 Google Inc. All rights reserved.
Copyright 2019-2024 AFLplusplus Project. All rights reserved.
@@ -124,6 +124,10 @@
#define CASE_PREFIX "id_"
#endif /* ^!SIMPLE_FILES */
+#ifdef AFL_PERSISTENT_RECORD
+ #define RECORD_PREFIX "RECORD:"
+#endif
+
#define STAGE_BUF_SIZE (64) /* usable size for stage name buf in afl_state */
// Little helper to access the ptr to afl->##name_buf - for use in afl_realloc.
@@ -644,7 +648,10 @@ typedef struct afl_state {
longest_find_time, /* Longest time taken for a find */
exit_on_time, /* Delay to exit if no new paths */
sync_time, /* Sync time (ms) */
- switch_fuzz_mode; /* auto or fixed fuzz mode */
+ switch_fuzz_mode, /* auto or fixed fuzz mode */
+ calibration_time_us, /* Time spend on calibration */
+ sync_time_us, /* Time spend on sync */
+ trim_time_us; /* Time spend on trimming */
u32 slowest_exec_ms, /* Slowest testcase non hang in ms */
subseq_tmouts; /* Number of timeouts in a row */
@@ -1211,6 +1218,10 @@ void show_stats_normal(afl_state_t *);
void show_stats_pizza(afl_state_t *);
void show_init_stats(afl_state_t *);
+void update_calibration_time(afl_state_t *afl, u64 *time);
+void update_trim_time(afl_state_t *afl, u64 *time);
+void update_sync_time(afl_state_t *afl, u64 *time);
+
/* StatsD */
void statsd_setup_format(afl_state_t *afl);
diff --git a/include/afl-mutations.h b/include/afl-mutations.h
index 75e66484..79cf7c6a 100644
--- a/include/afl-mutations.h
+++ b/include/afl-mutations.h
@@ -30,10 +30,13 @@
#include <stdbool.h>
#include <inttypes.h>
-#include "afl-fuzz.h"
#define MUT_STRATEGY_ARRAY_SIZE 256
+s8 interesting_8[] = {INTERESTING_8};
+s16 interesting_16[] = {INTERESTING_8, INTERESTING_16};
+s32 interesting_32[] = {INTERESTING_8, INTERESTING_16, INTERESTING_32};
+
enum {
/* 00 */ MUT_FLIPBIT,
diff --git a/include/afl-persistent-replay.h b/include/afl-persistent-replay.h
new file mode 100644
index 00000000..9e60ff9c
--- /dev/null
+++ b/include/afl-persistent-replay.h
@@ -0,0 +1,131 @@
+#ifndef _HAVE_PERSISTENT_REPLAY_H
+#define _HAVE_PERSISTENT_REPLAY_H
+
+#include <dirent.h>
+#include <string.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <malloc.h>
+#include <unistd.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+
+#ifndef PATH_MAX
+ #define PATH_MAX 4096
+#endif
+
+static unsigned short int is_replay_record;
+static unsigned int replay_record;
+static unsigned int replay_record_cnt;
+static char replay_record_path[PATH_MAX];
+static char *replay_record_dir;
+static struct dirent **record_list;
+
+#ifdef AFL_PERSISTENT_REPLAY_ARGPARSE
+static char **record_arg = NULL;
+#endif // AFL_PERSISTENT_REPLAY_ARGPARSE
+
+static int select_files(const struct dirent *dirbuf) {
+
+ char fn[PATH_MAX];
+
+ if (dirbuf->d_name[0] == '.') {
+
+ return 0;
+
+ } else {
+
+ snprintf(fn, sizeof(fn), "RECORD:%06u", replay_record);
+ return !!strstr(dirbuf->d_name, fn);
+
+ }
+
+}
+
+static int compare_files(const struct dirent **da, const struct dirent **db) {
+
+ unsigned int c1 = 0, c2 = 0;
+
+ sscanf((*da)->d_name, "RECORD:%*u,cnt:%06u", &c1);
+ sscanf((*db)->d_name, "RECORD:%*u,cnt:%06u", &c2);
+
+ return c1 - c2;
+
+}
+
+__attribute__((destructor)) static void __afl_record_replay_destroy(void) {
+
+ for (int i = 0; i < replay_record_cnt; i++) {
+
+ free(record_list[i]);
+
+ }
+
+ free(record_list);
+
+}
+
+__attribute__((constructor)) static void __afl_record_replay_init(
+#ifdef AFL_PERSISTENT_REPLAY_ARGPARSE
+ int argc, char **argv
+#endif // AFL_PERSISTENT_REPLAY_ARGPARSE
+) {
+
+#ifdef AFL_PERSISTENT_REPLAY_ARGPARSE
+ char **argp;
+#endif // AFL_PERSISTENT_REPLAY_ARGPARSE
+
+ struct stat sb;
+
+ /* caveat: if harness uses @@ and we don't pass it, it will regardless loop
+ * the number of iterations defined for AFL_LOOP (on the same file)*/
+ if (!(is_replay_record = !!getenv("AFL_PERSISTENT_REPLAY"))) {
+
+ // printf("[warning] AFL_PERSISTENT_REPLAY not set.\n");
+ return;
+
+ }
+
+ replay_record = atoi(getenv("AFL_PERSISTENT_REPLAY"));
+ replay_record_dir = getenv("AFL_PERSISTENT_DIR");
+
+ if (!(stat(replay_record_dir, &sb) == 0 && S_ISDIR(sb.st_mode))) {
+
+ fprintf(stderr, "[error] Can't find the requested record directory!\n");
+ is_replay_record = 0;
+ return;
+
+ }
+
+ replay_record_cnt = scandir(replay_record_dir ? replay_record_dir : "./",
+ &record_list, select_files, compare_files);
+
+ if (!replay_record_cnt) {
+
+ fprintf(stderr, "[error] Can't find the requested record!\n");
+ is_replay_record = 0;
+
+ }
+
+#ifdef AFL_PERSISTENT_REPLAY_ARGPARSE
+ argp = argv;
+ while (*argp) {
+
+ if (!strcmp(*argp, "@@")) {
+
+ record_arg = argp;
+ *record_arg = replay_record_path;
+ break;
+
+ }
+
+ ++argp;
+
+ }
+
+#endif // AFL_PERSISTENT_REPLAY_ARGPARSE
+
+}
+
+#endif // _HAVE_PERSISTENT_REPLAY_H
+
diff --git a/include/afl-record-compat.h b/include/afl-record-compat.h
new file mode 100644
index 00000000..3e5d60e3
--- /dev/null
+++ b/include/afl-record-compat.h
@@ -0,0 +1,67 @@
+#ifndef _HAVE_AFL_COMPAT_H
+#define _HAVE_AFL_COMPAT_H
+
+#include <afl-persistent-replay.h>
+
+#define FUZZ_BUF_SIZE 1024000
+
+// extern ssize_t read(int fildes, void *buf, size_t nbyte);
+
+// extern int __afl_persistent_loop(unsigned int max_cnt);
+// extern unsigned char fuzz_buf[];
+
+#ifndef __AFL_HAVE_MANUAL_CONTROL
+ #define __AFL_HAVE_MANUAL_CONTROL
+#endif
+
+#define __AFL_FUZZ_TESTCASE_LEN (read(0, fuzz_buf, FUZZ_BUF_SIZE))
+#define __AFL_FUZZ_TESTCASE_BUF fuzz_buf
+#define __AFL_FUZZ_INIT() void sync(void);
+#define __AFL_INIT() sync()
+#define __AFL_LOOP(x) __afl_persistent_loop(x)
+
+unsigned char fuzz_buf[FUZZ_BUF_SIZE];
+
+int __afl_persistent_loop(unsigned int max_cnt) {
+
+ static unsigned int cycle_cnt = 1;
+ static unsigned short int inited = 0;
+ char tcase[PATH_MAX];
+
+ if (is_replay_record && cycle_cnt) {
+
+ if (!inited) {
+
+ cycle_cnt = replay_record_cnt;
+ inited = 1;
+
+ }
+
+ snprintf(tcase, PATH_MAX, "%s/%s",
+ replay_record_dir ? replay_record_dir : "./",
+ record_list[replay_record_cnt - cycle_cnt]->d_name);
+
+#ifdef AFL_PERSISTENT_REPLAY_ARGPARSE
+ if (record_arg) {
+
+ *record_arg = tcase;
+
+ } else
+
+#endif // AFL_PERSISTENT_REPLAY_ARGPARSE
+ {
+
+ int fd = open(tcase, O_RDONLY);
+ dup2(fd, 0);
+ close(fd);
+
+ }
+
+ }
+
+ return cycle_cnt--;
+
+}
+
+#endif // _HAVE_AFL_COMPAT_H
+
diff --git a/include/cmplog.h b/include/cmplog.h
index 6bfc146b..a6162b59 100644
--- a/include/cmplog.h
+++ b/include/cmplog.h
@@ -38,18 +38,15 @@
#define SHAPE_BYTES(x) (x + 1)
-#define CMP_TYPE_INS 1
-#define CMP_TYPE_RTN 2
+#define CMP_TYPE_INS 0
+#define CMP_TYPE_RTN 1
-struct cmp_header {
+struct cmp_header { // 16 bit = 2 bytes
- unsigned hits : 24;
- unsigned id : 24;
- unsigned shape : 5;
- unsigned type : 2;
- unsigned attribute : 4;
- unsigned overflow : 1;
- unsigned reserved : 4;
+ unsigned hits : 6; // up to 63 entries, we have CMP_MAP_H = 32
+ unsigned shape : 5; // 31+1 bytes max
+ unsigned type : 1; // 2: cmp, rtn
+ unsigned attribute : 4; // 16 for arithmetic comparison types
} __attribute__((packed));
@@ -59,14 +56,17 @@ struct cmp_operands {
u64 v1;
u64 v0_128;
u64 v1_128;
+ u64 unused;
+ u8 unused1;
+ u8 unused2;
} __attribute__((packed));
struct cmpfn_operands {
- u8 v0[31];
+ u8 v0[32];
u8 v0_len;
- u8 v1[31];
+ u8 v1[32];
u8 v1_len;
} __attribute__((packed));
diff --git a/include/config.h b/include/config.h
index 9349828f..3ea059ff 100644
--- a/include/config.h
+++ b/include/config.h
@@ -26,7 +26,7 @@
/* Version string: */
// c = release, a = volatile github dev, e = experimental branch
-#define VERSION "++4.10c"
+#define VERSION "++4.20c"
/******************************************************
* *
@@ -97,6 +97,11 @@
// #define AFL_PERSISTENT_RECORD
+/* Adds support in compiler-rt to replay persistent records in @@-style
+ * harnesses */
+
+// #define AFL_PERSISTENT_REPLAY_ARGPARSE
+
/* console output colors: There are three ways to configure its behavior
* 1. default: colored outputs fixed on: defined USE_COLOR && defined
* ALWAYS_COLORED The env var. AFL_NO_COLOR will have no effect
diff --git a/include/envs.h b/include/envs.h
index 0f645d23..56a4916c 100644
--- a/include/envs.h
+++ b/include/envs.h
@@ -21,7 +21,7 @@ static char *afl_environment_variables[] = {
"AFL_BENCH_UNTIL_CRASH", "AFL_CAL_FAST", "AFL_CC", "AFL_CC_COMPILER",
"AFL_CMIN_ALLOW_ANY", "AFL_CMIN_CRASHES_ONLY", "AFL_CMPLOG_ONLY_NEW",
"AFL_CODE_END", "AFL_CODE_START", "AFL_COMPCOV_BINNAME",
- "AFL_COMPCOV_LEVEL", "AFL_CRASH_EXITCODE",
+ "AFL_CMPLOG_MAX_LEN", "AFL_COMPCOV_LEVEL", "AFL_CRASH_EXITCODE",
"AFL_CRASHING_SEEDS_AS_NEW_CRASH", "AFL_CUSTOM_MUTATOR_LIBRARY",
"AFL_CUSTOM_MUTATOR_ONLY", "AFL_CUSTOM_INFO_PROGRAM",
"AFL_CUSTOM_INFO_PROGRAM_ARGV", "AFL_CUSTOM_INFO_PROGRAM_INPUT",
@@ -64,6 +64,8 @@ static char *afl_environment_variables[] = {
"AFL_REAL_LD", "AFL_LD_PRELOAD", "AFL_LD_VERBOSE", "AFL_LLVM_ALLOWLIST",
"AFL_LLVM_DENYLIST", "AFL_LLVM_BLOCKLIST", "AFL_CMPLOG", "AFL_LLVM_CMPLOG",
"AFL_GCC_CMPLOG", "AFL_LLVM_INSTRIM", "AFL_LLVM_CALLER", "AFL_LLVM_CTX",
+ "AFL_LLVM_LTO_CALLER", "AFL_LLVM_LTO_CTX", "AFL_LLVM_LTO_CALLER_DEPTH",
+ "AFL_LLVM_LTO_CTX_DEPTH", "AFL_LLVM_CALLER_DEPTH", "AFL_LLVM_CTX_DEPTH",
"AFL_LLVM_CTX_K", "AFL_LLVM_DICT2FILE", "AFL_LLVM_DICT2FILE_NO_MAIN",
"AFL_LLVM_DOCUMENT_IDS", "AFL_LLVM_INSTRIM_LOOPHEAD", "AFL_LLVM_INSTRUMENT",
"AFL_LLVM_LTO_AUTODICTIONARY", "AFL_LLVM_AUTODICTIONARY",
@@ -93,26 +95,26 @@ static char *afl_environment_variables[] = {
"AFL_MAX_DET_EXTRAS",
"AFL_NO_X86", // not really an env but we dont want to warn on it
"AFL_NOOPT", "AFL_NYX_AUX_SIZE", "AFL_NYX_DISABLE_SNAPSHOT_MODE",
- "AFL_NYX_LOG", "AFL_NYX_REUSE_SNAPSHOT", "AFL_PASSTHROUGH", "AFL_PATH",
- "AFL_PERFORMANCE_FILE", "AFL_PERSISTENT_RECORD",
- "AFL_POST_PROCESS_KEEP_ORIGINAL", "AFL_PRELOAD", "AFL_TARGET_ENV",
- "AFL_PYTHON_MODULE", "AFL_QEMU_CUSTOM_BIN", "AFL_QEMU_COMPCOV",
- "AFL_QEMU_COMPCOV_DEBUG", "AFL_QEMU_DEBUG_MAPS", "AFL_QEMU_DISABLE_CACHE",
- "AFL_QEMU_DRIVER_NO_HOOK", "AFL_QEMU_FORCE_DFL", "AFL_QEMU_PERSISTENT_ADDR",
- "AFL_QEMU_PERSISTENT_CNT", "AFL_QEMU_PERSISTENT_GPR",
- "AFL_QEMU_PERSISTENT_HOOK", "AFL_QEMU_PERSISTENT_MEM",
- "AFL_QEMU_PERSISTENT_RET", "AFL_QEMU_PERSISTENT_RETADDR_OFFSET",
- "AFL_QEMU_PERSISTENT_EXITS", "AFL_QEMU_INST_RANGES",
- "AFL_QEMU_EXCLUDE_RANGES", "AFL_QEMU_SNAPSHOT", "AFL_QEMU_TRACK_UNSTABLE",
- "AFL_QUIET", "AFL_RANDOM_ALLOC_CANARY", "AFL_REAL_PATH",
- "AFL_SHUFFLE_QUEUE", "AFL_SKIP_BIN_CHECK", "AFL_SKIP_CPUFREQ",
- "AFL_SKIP_CRASHES", "AFL_SKIP_OSSFUZZ", "AFL_STATSD", "AFL_STATSD_HOST",
- "AFL_STATSD_PORT", "AFL_STATSD_TAGS_FLAVOR", "AFL_SYNC_TIME",
- "AFL_TESTCACHE_SIZE", "AFL_TESTCACHE_ENTRIES", "AFL_TMIN_EXACT",
- "AFL_TMPDIR", "AFL_TOKEN_FILE", "AFL_TRACE_PC", "AFL_USE_ASAN",
- "AFL_USE_MSAN", "AFL_USE_TRACE_PC", "AFL_USE_UBSAN", "AFL_USE_TSAN",
- "AFL_USE_CFISAN", "AFL_USE_LSAN", "AFL_WINE_PATH", "AFL_NO_SNAPSHOT",
- "AFL_EXPAND_HAVOC_NOW", "AFL_USE_FASAN", "AFL_USE_QASAN",
+ "AFL_NYX_HANDLE_INVALID_WRITE", "AFL_NYX_LOG", "AFL_NYX_REUSE_SNAPSHOT",
+ "AFL_PASSTHROUGH", "AFL_PATH", "AFL_PERFORMANCE_FILE",
+ "AFL_PERSISTENT_RECORD", "AFL_POST_PROCESS_KEEP_ORIGINAL", "AFL_PRELOAD",
+ "AFL_TARGET_ENV", "AFL_PYTHON_MODULE", "AFL_QEMU_CUSTOM_BIN",
+ "AFL_QEMU_COMPCOV", "AFL_QEMU_COMPCOV_DEBUG", "AFL_QEMU_DEBUG_MAPS",
+ "AFL_QEMU_DISABLE_CACHE", "AFL_QEMU_DRIVER_NO_HOOK", "AFL_QEMU_FORCE_DFL",
+ "AFL_QEMU_PERSISTENT_ADDR", "AFL_QEMU_PERSISTENT_CNT",
+ "AFL_QEMU_PERSISTENT_GPR", "AFL_QEMU_PERSISTENT_HOOK",
+ "AFL_QEMU_PERSISTENT_MEM", "AFL_QEMU_PERSISTENT_RET",
+ "AFL_QEMU_PERSISTENT_RETADDR_OFFSET", "AFL_QEMU_PERSISTENT_EXITS",
+ "AFL_QEMU_INST_RANGES", "AFL_QEMU_EXCLUDE_RANGES", "AFL_QEMU_SNAPSHOT",
+ "AFL_QEMU_TRACK_UNSTABLE", "AFL_QUIET", "AFL_RANDOM_ALLOC_CANARY",
+ "AFL_REAL_PATH", "AFL_SHUFFLE_QUEUE", "AFL_SKIP_BIN_CHECK",
+ "AFL_SKIP_CPUFREQ", "AFL_SKIP_CRASHES", "AFL_SKIP_OSSFUZZ", "AFL_STATSD",
+ "AFL_STATSD_HOST", "AFL_STATSD_PORT", "AFL_STATSD_TAGS_FLAVOR",
+ "AFL_SYNC_TIME", "AFL_TESTCACHE_SIZE", "AFL_TESTCACHE_ENTRIES",
+ "AFL_TMIN_EXACT", "AFL_TMPDIR", "AFL_TOKEN_FILE", "AFL_TRACE_PC",
+ "AFL_USE_ASAN", "AFL_USE_MSAN", "AFL_USE_TRACE_PC", "AFL_USE_UBSAN",
+ "AFL_USE_TSAN", "AFL_USE_CFISAN", "AFL_USE_LSAN", "AFL_WINE_PATH",
+ "AFL_NO_SNAPSHOT", "AFL_EXPAND_HAVOC_NOW", "AFL_USE_FASAN", "AFL_USE_QASAN",
"AFL_PRINT_FILENAMES", "AFL_PIZZA_MODE", NULL
};
diff --git a/include/t1ha.h b/include/t1ha.h
new file mode 100644
index 00000000..1af29395
--- /dev/null
+++ b/include/t1ha.h
@@ -0,0 +1,738 @@
+/*
+ * Copyright (c) 2016-2020 Positive Technologies, https://www.ptsecurity.com,
+ * Fast Positive Hash.
+ *
+ * Portions Copyright (c) 2010-2020 Leonid Yuriev <leo@yuriev.ru>,
+ * The 1Hippeus project (t1h).
+ *
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ *
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ *
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgement in the product documentation would be
+ * appreciated but is not required.
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 3. This notice may not be removed or altered from any source distribution.
+ */
+
+/*
+ * t1ha = { Fast Positive Hash, aka "Позитивный Хэш" }
+ * by [Positive Technologies](https://www.ptsecurity.ru)
+ *
+ * Briefly, it is a 64-bit Hash Function:
+ * 1. Created for 64-bit little-endian platforms, in predominantly for x86_64,
+ * but portable and without penalties it can run on any 64-bit CPU.
+ * 2. In most cases up to 15% faster than City64, xxHash, mum-hash, metro-hash
+ * and all others portable hash-functions (which do not use specific
+ * hardware tricks).
+ * 3. Not suitable for cryptography.
+ *
+ * The Future will (be) Positive. Всё будет хорошо.
+ *
+ * ACKNOWLEDGEMENT:
+ * The t1ha was originally developed by Leonid Yuriev (Леонид Юрьев)
+ * for The 1Hippeus project - zerocopy messaging in the spirit of Sparta!
+ */
+
+#pragma once
+
+/*****************************************************************************
+ *
+ * PLEASE PAY ATTENTION TO THE FOLLOWING NOTES
+ * about macros definitions which controls t1ha behaviour and/or performance.
+ *
+ *
+ * 1) T1HA_SYS_UNALIGNED_ACCESS = Defines the system/platform/CPU/architecture
+ * abilities for unaligned data access.
+ *
+ * By default, when the T1HA_SYS_UNALIGNED_ACCESS not defined,
+ * it will defined on the basis hardcoded knowledge about of capabilities
+ * of most common CPU architectures. But you could override this
+ * default behavior when build t1ha library itself:
+ *
+ * // To disable unaligned access at all.
+ * #define T1HA_SYS_UNALIGNED_ACCESS 0
+ *
+ * // To enable unaligned access, but indicate that it significantly slow.
+ * #define T1HA_SYS_UNALIGNED_ACCESS 1
+ *
+ * // To enable unaligned access, and indicate that it effecient.
+ * #define T1HA_SYS_UNALIGNED_ACCESS 2
+ *
+ *
+ * 2) T1HA_USE_FAST_ONESHOT_READ = Controls the data reads at the end of buffer.
+ *
+ * When defined to non-zero, t1ha will use 'one shot' method for reading
+ * up to 8 bytes at the end of data. In this case just the one 64-bit read
+ * will be performed even when the available less than 8 bytes.
+ *
+ * This is little bit faster that switching by length of data tail.
+ * Unfortunately this will triggering a false-positive alarms from Valgrind,
+ * AddressSanitizer and other similar tool.
+ *
+ * By default, t1ha defines it to 1, but you could override this
+ * default behavior when build t1ha library itself:
+ *
+ * // For little bit faster and small code.
+ * #define T1HA_USE_FAST_ONESHOT_READ 1
+ *
+ * // For calmness if doubt.
+ * #define T1HA_USE_FAST_ONESHOT_READ 0
+ *
+ *
+ * 3) T1HA0_RUNTIME_SELECT = Controls choice fastest function in runtime.
+ *
+ * t1ha library offers the t1ha0() function as the fastest for current CPU.
+ * But actual CPU's features/capabilities and may be significantly different,
+ * especially on x86 platform. Therefore, internally, t1ha0() may require
+ * dynamic dispatching for choice best implementation.
+ *
+ * By default, t1ha enables such runtime choice and (may be) corresponding
+ * indirect calls if it reasonable, but you could override this default
+ * behavior when build t1ha library itself:
+ *
+ * // To enable runtime choice of fastest implementation.
+ * #define T1HA0_RUNTIME_SELECT 1
+ *
+ * // To disable runtime choice of fastest implementation.
+ * #define T1HA0_RUNTIME_SELECT 0
+ *
+ * When T1HA0_RUNTIME_SELECT is nonzero the t1ha0_resolve() function could
+ * be used to get actual t1ha0() implementation address at runtime. This is
+ * useful for two cases:
+ * - calling by local pointer-to-function usually is little
+ * bit faster (less overhead) than via a PLT thru the DSO boundary.
+ * - GNU Indirect functions (see below) don't supported by environment
+ * and calling by t1ha0_funcptr is not available and/or expensive.
+ *
+ * 4) T1HA_USE_INDIRECT_FUNCTIONS = Controls usage of GNU Indirect functions.
+ *
+ * In continue of T1HA0_RUNTIME_SELECT the T1HA_USE_INDIRECT_FUNCTIONS
+ * controls usage of ELF indirect functions feature. In general, when
+ * available, this reduces overhead of indirect function's calls though
+ * a DSO-bundary (https://sourceware.org/glibc/wiki/GNU_IFUNC).
+ *
+ * By default, t1ha engage GNU Indirect functions when it available
+ * and useful, but you could override this default behavior when build
+ * t1ha library itself:
+ *
+ * // To enable use of GNU ELF Indirect functions.
+ * #define T1HA_USE_INDIRECT_FUNCTIONS 1
+ *
+ * // To disable use of GNU ELF Indirect functions. This may be useful
+ * // if the actual toolchain or the system's loader don't support ones.
+ * #define T1HA_USE_INDIRECT_FUNCTIONS 0
+ *
+ * 5) T1HA0_AESNI_AVAILABLE = Controls AES-NI detection and dispatching on x86.
+ *
+ * In continue of T1HA0_RUNTIME_SELECT the T1HA0_AESNI_AVAILABLE controls
+ * detection and usage of AES-NI CPU's feature. On the other hand, this
+ * requires compiling parts of t1ha library with certain properly options,
+ * and could be difficult or inconvenient in some cases.
+ *
+ * By default, t1ha engade AES-NI for t1ha0() on the x86 platform, but
+ * you could override this default behavior when build t1ha library itself:
+ *
+ * // To disable detection and usage of AES-NI instructions for t1ha0().
+ * // This may be useful when you unable to build t1ha library properly
+ * // or known that AES-NI will be unavailable at the deploy.
+ * #define T1HA0_AESNI_AVAILABLE 0
+ *
+ * // To force detection and usage of AES-NI instructions for t1ha0(),
+ * // but I don't known reasons to anybody would need this.
+ * #define T1HA0_AESNI_AVAILABLE 1
+ *
+ * 6) T1HA0_DISABLED, T1HA1_DISABLED, T1HA2_DISABLED = Controls availability of
+ * t1ha functions.
+ *
+ * In some cases could be useful to import/use only few of t1ha functions
+ * or just the one. So, this definitions allows disable corresponding parts
+ * of t1ha library.
+ *
+ * // To disable t1ha0(), t1ha0_32le(), t1ha0_32be() and all AES-NI.
+ * #define T1HA0_DISABLED
+ *
+ * // To disable t1ha1_le() and t1ha1_be().
+ * #define T1HA1_DISABLED
+ *
+ * // To disable t1ha2_atonce(), t1ha2_atonce128() and so on.
+ * #define T1HA2_DISABLED
+ *
+ *****************************************************************************/
+
+#define T1HA_VERSION_MAJOR 2
+#define T1HA_VERSION_MINOR 1
+#define T1HA_VERSION_RELEASE 1
+
+#ifndef __has_attribute
+ #define __has_attribute(x) (0)
+#endif
+
+#ifndef __has_include
+ #define __has_include(x) (0)
+#endif
+
+#ifndef __GNUC_PREREQ
+ #if defined(__GNUC__) && defined(__GNUC_MINOR__)
+ #define __GNUC_PREREQ(maj, min) \
+ ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
+ #else
+ #define __GNUC_PREREQ(maj, min) 0
+ #endif
+#endif /* __GNUC_PREREQ */
+
+#ifndef __CLANG_PREREQ
+ #ifdef __clang__
+ #define __CLANG_PREREQ(maj, min) \
+ ((__clang_major__ << 16) + __clang_minor__ >= ((maj) << 16) + (min))
+ #else
+ #define __CLANG_PREREQ(maj, min) (0)
+ #endif
+#endif /* __CLANG_PREREQ */
+
+#ifndef __LCC_PREREQ
+ #ifdef __LCC__
+ #define __LCC_PREREQ(maj, min) \
+ ((__LCC__ << 16) + __LCC_MINOR__ >= ((maj) << 16) + (min))
+ #else
+ #define __LCC_PREREQ(maj, min) (0)
+ #endif
+#endif /* __LCC_PREREQ */
+
+/*****************************************************************************/
+
+#ifdef _MSC_VER
+ /* Avoid '16' bytes padding added after data member 't1ha_context::total'
+ * and other warnings from std-headers if warning-level > 3. */
+ #pragma warning(push, 3)
+#endif
+
+#if defined(__cplusplus) && __cplusplus >= 201103L
+ #include <climits>
+ #include <cstddef>
+ #include <cstdint>
+#else
+ #include <limits.h>
+ #include <stddef.h>
+ #include <stdint.h>
+#endif
+
+/*****************************************************************************/
+
+#if defined(i386) || defined(__386) || defined(__i386) || defined(__i386__) || \
+ defined(i486) || defined(__i486) || defined(__i486__) || \
+ defined(i586) | defined(__i586) || defined(__i586__) || defined(i686) || \
+ defined(__i686) || defined(__i686__) || defined(_M_IX86) || \
+ defined(_X86_) || defined(__THW_INTEL__) || defined(__I86__) || \
+ defined(__INTEL__) || defined(__x86_64) || defined(__x86_64__) || \
+ defined(__amd64__) || defined(__amd64) || defined(_M_X64) || \
+ defined(_M_AMD64) || defined(__IA32__) || defined(__INTEL__)
+ #ifndef __ia32__
+ /* LY: define neutral __ia32__ for x86 and x86-64 archs */
+ #define __ia32__ 1
+ #endif /* __ia32__ */
+ #if !defined(__amd64__) && (defined(__x86_64) || defined(__x86_64__) || \
+ defined(__amd64) || defined(_M_X64))
+ /* LY: define trusty __amd64__ for all AMD64/x86-64 arch */
+ #define __amd64__ 1
+ #endif /* __amd64__ */
+#endif /* all x86 */
+
+#if !defined(__BYTE_ORDER__) || !defined(__ORDER_LITTLE_ENDIAN__) || \
+ !defined(__ORDER_BIG_ENDIAN__)
+
+/* *INDENT-OFF* */
+/* clang-format off */
+
+#if defined(__GLIBC__) || defined(__GNU_LIBRARY__) || defined(__ANDROID__) || \
+ defined(HAVE_ENDIAN_H) || __has_include(<endian.h>)
+#include <endian.h>
+#elif defined(__APPLE__) || defined(__MACH__) || defined(__OpenBSD__) || \
+ defined(HAVE_MACHINE_ENDIAN_H) || __has_include(<machine/endian.h>)
+#include <machine/endian.h>
+#elif defined(HAVE_SYS_ISA_DEFS_H) || __has_include(<sys/isa_defs.h>)
+#include <sys/isa_defs.h>
+#elif (defined(HAVE_SYS_TYPES_H) && defined(HAVE_SYS_ENDIAN_H)) || \
+ (__has_include(<sys/types.h>) && __has_include(<sys/endian.h>))
+#include <sys/endian.h>
+#include <sys/types.h>
+#elif defined(__bsdi__) || defined(__DragonFly__) || defined(__FreeBSD__) || \
+ defined(__NETBSD__) || defined(__NetBSD__) || \
+ defined(HAVE_SYS_PARAM_H) || __has_include(<sys/param.h>)
+#include <sys/param.h>
+#endif /* OS */
+
+/* *INDENT-ON* */
+/* clang-format on */
+
+ #if defined(__BYTE_ORDER) && defined(__LITTLE_ENDIAN) && defined(__BIG_ENDIAN)
+ #define __ORDER_LITTLE_ENDIAN__ __LITTLE_ENDIAN
+ #define __ORDER_BIG_ENDIAN__ __BIG_ENDIAN
+ #define __BYTE_ORDER__ __BYTE_ORDER
+ #elif defined(_BYTE_ORDER) && defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN)
+ #define __ORDER_LITTLE_ENDIAN__ _LITTLE_ENDIAN
+ #define __ORDER_BIG_ENDIAN__ _BIG_ENDIAN
+ #define __BYTE_ORDER__ _BYTE_ORDER
+ #else
+ #define __ORDER_LITTLE_ENDIAN__ 1234
+ #define __ORDER_BIG_ENDIAN__ 4321
+
+ #if defined(__LITTLE_ENDIAN__) || \
+ (defined(_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN)) || \
+ defined(__ARMEL__) || defined(__THUMBEL__) || \
+ defined(__AARCH64EL__) || defined(__MIPSEL__) || defined(_MIPSEL) || \
+ defined(__MIPSEL) || defined(_M_ARM) || defined(_M_ARM64) || \
+ defined(__e2k__) || defined(__elbrus_4c__) || \
+ defined(__elbrus_8c__) || defined(__bfin__) || defined(__BFIN__) || \
+ defined(__ia64__) || defined(_IA64) || defined(__IA64__) || \
+ defined(__ia64) || defined(_M_IA64) || defined(__itanium__) || \
+ defined(__ia32__) || defined(__CYGWIN__) || defined(_WIN64) || \
+ defined(_WIN32) || defined(__TOS_WIN__) || defined(__WINDOWS__)
+ #define __BYTE_ORDER__ __ORDER_LITTLE_ENDIAN__
+
+ #elif defined(__BIG_ENDIAN__) || \
+ (defined(_BIG_ENDIAN) && !defined(_LITTLE_ENDIAN)) || \
+ defined(__ARMEB__) || defined(__THUMBEB__) || \
+ defined(__AARCH64EB__) || defined(__MIPSEB__) || defined(_MIPSEB) || \
+ defined(__MIPSEB) || defined(__m68k__) || defined(M68000) || \
+ defined(__hppa__) || defined(__hppa) || defined(__HPPA__) || \
+ defined(__sparc__) || defined(__sparc) || defined(__370__) || \
+ defined(__THW_370__) || defined(__s390__) || defined(__s390x__) || \
+ defined(__SYSC_ZARCH__)
+ #define __BYTE_ORDER__ __ORDER_BIG_ENDIAN__
+
+ #else
+ #error __BYTE_ORDER__ should be defined.
+ #endif /* Arch */
+
+ #endif
+#endif /* __BYTE_ORDER__ || __ORDER_LITTLE_ENDIAN__ || __ORDER_BIG_ENDIAN__ */
+
+/*****************************************************************************/
+
+#ifndef __dll_export
+ #if defined(_WIN32) || defined(_WIN64) || defined(__CYGWIN__)
+ #if defined(__GNUC__) || __has_attribute(dllexport)
+ #define __dll_export __attribute__((dllexport))
+ #else
+ #define __dll_export __declspec(dllexport)
+ #endif
+ #elif defined(__GNUC__) || __has_attribute(__visibility__)
+ #define __dll_export __attribute__((__visibility__("default")))
+ #else
+ #define __dll_export
+ #endif
+#endif /* __dll_export */
+
+#ifndef __dll_import
+ #if defined(_WIN32) || defined(_WIN64) || defined(__CYGWIN__)
+ #if defined(__GNUC__) || __has_attribute(dllimport)
+ #define __dll_import __attribute__((dllimport))
+ #else
+ #define __dll_import __declspec(dllimport)
+ #endif
+ #elif defined(__GNUC__) || __has_attribute(__visibility__)
+ #define __dll_import __attribute__((__visibility__("default")))
+ #else
+ #define __dll_import
+ #endif
+#endif /* __dll_import */
+
+#ifndef __force_inline
+ #ifdef _MSC_VER
+ #define __force_inline __forceinline
+ #elif __GNUC_PREREQ(3, 2) || __has_attribute(__always_inline__)
+ #define __force_inline __inline __attribute__((__always_inline__))
+ #else
+ #define __force_inline __inline
+ #endif
+#endif /* __force_inline */
+
+#ifndef T1HA_API
+ #if defined(t1ha_EXPORTS)
+ #define T1HA_API __dll_export
+ #elif defined(t1ha_IMPORTS)
+ #define T1HA_API __dll_import
+ #else
+ #define T1HA_API
+ #endif
+#endif /* T1HA_API */
+
+#if defined(_MSC_VER) && defined(__ia32__)
+ #define T1HA_ALIGN_PREFIX __declspec(align(32)) /* required only for SIMD */
+#else
+ #define T1HA_ALIGN_PREFIX
+#endif /* _MSC_VER */
+
+#if defined(__GNUC__) && defined(__ia32__)
+ #define T1HA_ALIGN_SUFFIX \
+ __attribute__((__aligned__(32))) /* required only for SIMD */
+#else
+ #define T1HA_ALIGN_SUFFIX
+#endif /* GCC x86 */
+
+#ifndef T1HA_USE_INDIRECT_FUNCTIONS
+ /* GNU ELF indirect functions usage control. For more info please see
+ * https://en.wikipedia.org/wiki/Executable_and_Linkable_Format
+ * and https://sourceware.org/glibc/wiki/GNU_IFUNC */
+ #if defined(__ELF__) && defined(__amd64__) && \
+ (__has_attribute(__ifunc__) || \
+ (!defined(__clang__) && defined(__GNUC__) && __GNUC__ >= 4 && \
+ !defined(__SANITIZE_ADDRESS__) && !defined(__SSP_ALL__)))
+ /* Enable gnu_indirect_function by default if :
+ * - ELF AND x86_64
+ * - attribute(__ifunc__) is available OR
+ * GCC >= 4 WITHOUT -fsanitize=address NOR -fstack-protector-all */
+ #define T1HA_USE_INDIRECT_FUNCTIONS 1
+ #else
+ #define T1HA_USE_INDIRECT_FUNCTIONS 0
+ #endif
+#endif /* T1HA_USE_INDIRECT_FUNCTIONS */
+
+#if __GNUC_PREREQ(4, 0)
+ #pragma GCC visibility push(hidden)
+#endif /* __GNUC_PREREQ(4,0) */
+
+#ifdef __cplusplus
+extern "C" {
+
+#endif
+
+typedef union T1HA_ALIGN_PREFIX t1ha_state256 {
+
+ uint8_t bytes[32];
+ uint32_t u32[8];
+ uint64_t u64[4];
+ struct {
+
+ uint64_t a, b, c, d;
+
+ } n;
+
+} t1ha_state256_t T1HA_ALIGN_SUFFIX;
+
+typedef struct t1ha_context {
+
+ t1ha_state256_t state;
+ t1ha_state256_t buffer;
+ size_t partial;
+ uint64_t total;
+
+} t1ha_context_t;
+
+#ifdef _MSC_VER
+ #pragma warning(pop)
+#endif
+
+/******************************************************************************
+ *
+ * Self-testing API.
+ *
+ * Unfortunately, some compilers (exactly only Microsoft Visual C/C++) has
+ * a bugs which leads t1ha-functions to produce wrong results. This API allows
+ * check the correctness of the actual code in runtime.
+ *
+ * All check-functions returns 0 on success, or -1 in case the corresponding
+ * hash-function failed verification. PLEASE, always perform such checking at
+ * initialization of your code, if you using MSVC or other troubleful compilers.
+ */
+
+T1HA_API int t1ha_selfcheck__all_enabled(void);
+
+#ifndef T1HA2_DISABLED
+T1HA_API int t1ha_selfcheck__t1ha2_atonce(void);
+T1HA_API int t1ha_selfcheck__t1ha2_atonce128(void);
+T1HA_API int t1ha_selfcheck__t1ha2_stream(void);
+T1HA_API int t1ha_selfcheck__t1ha2(void);
+#endif /* T1HA2_DISABLED */
+
+#ifndef T1HA1_DISABLED
+T1HA_API int t1ha_selfcheck__t1ha1_le(void);
+T1HA_API int t1ha_selfcheck__t1ha1_be(void);
+T1HA_API int t1ha_selfcheck__t1ha1(void);
+#endif /* T1HA1_DISABLED */
+
+#ifndef T1HA0_DISABLED
+T1HA_API int t1ha_selfcheck__t1ha0_32le(void);
+T1HA_API int t1ha_selfcheck__t1ha0_32be(void);
+T1HA_API int t1ha_selfcheck__t1ha0(void);
+
+ /* Define T1HA0_AESNI_AVAILABLE to 0 for disable AES-NI support. */
+ #ifndef T1HA0_AESNI_AVAILABLE
+ #if defined(__e2k__) || \
+ (defined(__ia32__) && (!defined(_M_IX86) || _MSC_VER > 1800))
+ #define T1HA0_AESNI_AVAILABLE 1
+ #else
+ #define T1HA0_AESNI_AVAILABLE 0
+ #endif
+ #endif /* ifndef T1HA0_AESNI_AVAILABLE */
+
+ #if T1HA0_AESNI_AVAILABLE
+T1HA_API int t1ha_selfcheck__t1ha0_ia32aes_noavx(void);
+T1HA_API int t1ha_selfcheck__t1ha0_ia32aes_avx(void);
+ #ifndef __e2k__
+T1HA_API int t1ha_selfcheck__t1ha0_ia32aes_avx2(void);
+ #endif
+ #endif /* if T1HA0_AESNI_AVAILABLE */
+#endif /* T1HA0_DISABLED */
+
+/******************************************************************************
+ *
+ * t1ha2 = 64 and 128-bit, SLIGHTLY MORE ATTENTION FOR QUALITY AND STRENGTH.
+ *
+ * - The recommended version of "Fast Positive Hash" with good quality
+ * for checksum, hash tables and fingerprinting.
+ * - Portable and extremely efficiency on modern 64-bit CPUs.
+ * Designed for 64-bit little-endian platforms,
+ * in other cases will runs slowly.
+ * - Great quality of hashing and still faster than other non-t1ha hashes.
+ * Provides streaming mode and 128-bit result.
+ *
+ * Note: Due performance reason 64- and 128-bit results are completely
+ * different each other, i.e. 64-bit result is NOT any part of 128-bit.
+ */
+#ifndef T1HA2_DISABLED
+
+/* The at-once variant with 64-bit result */
+T1HA_API uint64_t t1ha2_atonce(const void *data, size_t length, uint64_t seed);
+
+/* The at-once variant with 128-bit result.
+ * Argument `extra_result` is NOT optional and MUST be valid.
+ * The high 64-bit part of 128-bit hash will be always unconditionally
+ * stored to the address given by `extra_result` argument. */
+T1HA_API uint64_t t1ha2_atonce128(uint64_t *__restrict extra_result,
+ const void *__restrict data, size_t length,
+ uint64_t seed);
+
+/* The init/update/final trinity for streaming.
+ * Return 64 or 128-bit result depentently from `extra_result` argument. */
+T1HA_API void t1ha2_init(t1ha_context_t *ctx, uint64_t seed_x, uint64_t seed_y);
+T1HA_API void t1ha2_update(t1ha_context_t *__restrict ctx,
+ const void *__restrict data, size_t length);
+
+/* Argument `extra_result` is optional and MAY be NULL.
+ * - If `extra_result` is NOT NULL then the 128-bit hash will be calculated,
+ * and high 64-bit part of it will be stored to the address given
+ * by `extra_result` argument.
+ * - Otherwise the 64-bit hash will be calculated
+ * and returned from function directly.
+ *
+ * Note: Due performance reason 64- and 128-bit results are completely
+ * different each other, i.e. 64-bit result is NOT any part of 128-bit. */
+T1HA_API uint64_t t1ha2_final(t1ha_context_t *__restrict ctx,
+ uint64_t *__restrict extra_result /* optional */);
+
+#endif /* T1HA2_DISABLED */
+
+/******************************************************************************
+ *
+ * t1ha1 = 64-bit, BASELINE FAST PORTABLE HASH:
+ *
+ * - Runs faster on 64-bit platforms in other cases may runs slowly.
+ * - Portable and stable, returns same 64-bit result
+ * on all architectures and CPUs.
+ * - Unfortunately it fails the "strict avalanche criteria",
+ * see test results at https://github.com/demerphq/smhasher.
+ *
+ * This flaw is insignificant for the t1ha1() purposes and imperceptible
+ * from a practical point of view.
+ * However, nowadays this issue has resolved in the next t1ha2(),
+ * that was initially planned to providing a bit more quality.
+ */
+#ifndef T1HA1_DISABLED
+
+/* The little-endian variant. */
+T1HA_API uint64_t t1ha1_le(const void *data, size_t length, uint64_t seed);
+
+/* The big-endian variant. */
+T1HA_API uint64_t t1ha1_be(const void *data, size_t length, uint64_t seed);
+
+#endif /* T1HA1_DISABLED */
+
+/******************************************************************************
+ *
+ * t1ha0 = 64-bit, JUST ONLY FASTER:
+ *
+ * - Provides fast-as-possible hashing for current CPU, including
+ * 32-bit systems and engaging the available hardware acceleration.
+ * - It is a facade that selects most quick-and-dirty hash
+ * for the current processor. For instance, on IA32 (x86) actual function
+ * will be selected in runtime, depending on current CPU capabilities
+ *
+ * BE CAREFUL!!! THIS IS MEANS:
+ *
+ * 1. The quality of hash is a subject for tradeoffs with performance.
+ * So, the quality and strength of t1ha0() may be lower than t1ha1(),
+ * especially on 32-bit targets, but then much faster.
+ * However, guaranteed that it passes all SMHasher tests.
+ *
+ * 2. No warranty that the hash result will be same for particular
+ * key on another machine or another version of libt1ha.
+ *
+ * Briefly, such hash-results and their derivatives, should be
+ * used only in runtime, but should not be persist or transferred
+ * over a network.
+ *
+ *
+ * When T1HA0_RUNTIME_SELECT is nonzero the t1ha0_resolve() function could
+ * be used to get actual t1ha0() implementation address at runtime. This is
+ * useful for two cases:
+ * - calling by local pointer-to-function usually is little
+ * bit faster (less overhead) than via a PLT thru the DSO boundary.
+ * - GNU Indirect functions (see below) don't supported by environment
+ * and calling by t1ha0_funcptr is not available and/or expensive.
+ */
+
+#ifndef T1HA0_DISABLED
+
+/* The little-endian variant for 32-bit CPU. */
+uint64_t t1ha0_32le(const void *data, size_t length, uint64_t seed);
+/* The big-endian variant for 32-bit CPU. */
+uint64_t t1ha0_32be(const void *data, size_t length, uint64_t seed);
+
+ /* Define T1HA0_AESNI_AVAILABLE to 0 for disable AES-NI support. */
+ #ifndef T1HA0_AESNI_AVAILABLE
+ #if defined(__e2k__) || \
+ (defined(__ia32__) && (!defined(_M_IX86) || _MSC_VER > 1800))
+ #define T1HA0_AESNI_AVAILABLE 1
+ #else
+ #define T1HA0_AESNI_AVAILABLE 0
+ #endif
+ #endif /* T1HA0_AESNI_AVAILABLE */
+
+ /* Define T1HA0_RUNTIME_SELECT to 0 for disable dispatching t1ha0 at runtime.
+ */
+ #ifndef T1HA0_RUNTIME_SELECT
+ #if T1HA0_AESNI_AVAILABLE && !defined(__e2k__)
+ #define T1HA0_RUNTIME_SELECT 1
+ #else
+ #define T1HA0_RUNTIME_SELECT 0
+ #endif
+ #endif /* T1HA0_RUNTIME_SELECT */
+
+ #if !T1HA0_RUNTIME_SELECT && !defined(T1HA0_USE_DEFINE)
+ #if defined(__LCC__)
+ #define T1HA0_USE_DEFINE 1
+ #else
+ #define T1HA0_USE_DEFINE 0
+ #endif
+ #endif /* T1HA0_USE_DEFINE */
+
+ #if T1HA0_AESNI_AVAILABLE
+uint64_t t1ha0_ia32aes_noavx(const void *data, size_t length, uint64_t seed);
+uint64_t t1ha0_ia32aes_avx(const void *data, size_t length, uint64_t seed);
+ #ifndef __e2k__
+uint64_t t1ha0_ia32aes_avx2(const void *data, size_t length, uint64_t seed);
+ #endif
+ #endif /* T1HA0_AESNI_AVAILABLE */
+
+ #if T1HA0_RUNTIME_SELECT
+typedef uint64_t (*t1ha0_function_t)(const void *, size_t, uint64_t);
+T1HA_API t1ha0_function_t t1ha0_resolve(void);
+ #if T1HA_USE_INDIRECT_FUNCTIONS
+T1HA_API uint64_t t1ha0(const void *data, size_t length, uint64_t seed);
+ #else
+/* Otherwise function pointer will be used.
+ * Unfortunately this may cause some overhead calling. */
+T1HA_API extern uint64_t (*t1ha0_funcptr)(const void *data, size_t length,
+ uint64_t seed);
+static __force_inline uint64_t t1ha0(const void *data, size_t length,
+ uint64_t seed) {
+
+ return t1ha0_funcptr(data, length, seed);
+
+}
+
+ #endif /* T1HA_USE_INDIRECT_FUNCTIONS */
+
+ #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+
+ #if T1HA0_USE_DEFINE
+
+ #if (UINTPTR_MAX > 0xffffFFFFul || ULONG_MAX > 0xffffFFFFul) && \
+ (!defined(T1HA1_DISABLED) || !defined(T1HA2_DISABLED))
+ #if defined(T1HA1_DISABLED)
+ #define t1ha0 t1ha2_atonce
+ #else
+ #define t1ha0 t1ha1_be
+ #endif /* T1HA1_DISABLED */
+ #else /* 32/64 */
+ #define t1ha0 t1ha0_32be
+ #endif /* 32/64 */
+
+ #else /* T1HA0_USE_DEFINE */
+
+static __force_inline uint64_t t1ha0(const void *data, size_t length,
+ uint64_t seed) {
+
+ #if (UINTPTR_MAX > 0xffffFFFFul || ULONG_MAX > 0xffffFFFFul) && \
+ (!defined(T1HA1_DISABLED) || !defined(T1HA2_DISABLED))
+ #if defined(T1HA1_DISABLED)
+ return t1ha2_atonce(data, length, seed);
+ #else
+ return t1ha1_be(data, length, seed);
+ #endif /* T1HA1_DISABLED */
+ #else /* 32/64 */
+ return t1ha0_32be(data, length, seed);
+ #endif /* 32/64 */
+
+}
+
+ #endif /* !T1HA0_USE_DEFINE */
+
+ #else /* !T1HA0_RUNTIME_SELECT && __BYTE_ORDER__ != __ORDER_BIG_ENDIAN__ */
+
+ #if T1HA0_USE_DEFINE
+
+ #if (UINTPTR_MAX > 0xffffFFFFul || ULONG_MAX > 0xffffFFFFul) && \
+ (!defined(T1HA1_DISABLED) || !defined(T1HA2_DISABLED))
+ #if defined(T1HA1_DISABLED)
+ #define t1ha0 t1ha2_atonce
+ #else
+ #define t1ha0 t1ha1_le
+ #endif /* T1HA1_DISABLED */
+ #else /* 32/64 */
+ #define t1ha0 t1ha0_32le
+ #endif /* 32/64 */
+
+ #else
+
+static __force_inline uint64_t t1ha0(const void *data, size_t length,
+ uint64_t seed) {
+
+ #if (UINTPTR_MAX > 0xffffFFFFul || ULONG_MAX > 0xffffFFFFul) && \
+ (!defined(T1HA1_DISABLED) || !defined(T1HA2_DISABLED))
+ #if defined(T1HA1_DISABLED)
+ return t1ha2_atonce(data, length, seed);
+ #else
+ return t1ha1_le(data, length, seed);
+ #endif /* T1HA1_DISABLED */
+ #else /* 32/64 */
+ return t1ha0_32le(data, length, seed);
+ #endif /* 32/64 */
+
+}
+
+ #endif /* !T1HA0_USE_DEFINE */
+
+ #endif /* !T1HA0_RUNTIME_SELECT */
+
+#endif /* T1HA0_DISABLED */
+
+#ifdef __cplusplus
+
+}
+
+#endif
+
+#if __GNUC_PREREQ(4, 0)
+ #pragma GCC visibility pop
+#endif /* __GNUC_PREREQ(4,0) */
+
diff --git a/include/t1ha0_ia32aes_b.h b/include/t1ha0_ia32aes_b.h
new file mode 100644
index 00000000..93b16771
--- /dev/null
+++ b/include/t1ha0_ia32aes_b.h
@@ -0,0 +1,183 @@
+/*
+ * Copyright (c) 2016-2020 Positive Technologies, https://www.ptsecurity.com,
+ * Fast Positive Hash.
+ *
+ * Portions Copyright (c) 2010-2020 Leonid Yuriev <leo@yuriev.ru>,
+ * The 1Hippeus project (t1h).
+ *
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ *
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ *
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgement in the product documentation would be
+ * appreciated but is not required.
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 3. This notice may not be removed or altered from any source distribution.
+ */
+
+/*
+ * t1ha = { Fast Positive Hash, aka "Позитивный Хэш" }
+ * by [Positive Technologies](https://www.ptsecurity.ru)
+ *
+ * Briefly, it is a 64-bit Hash Function:
+ * 1. Created for 64-bit little-endian platforms, in predominantly for x86_64,
+ * but portable and without penalties it can run on any 64-bit CPU.
+ * 2. In most cases up to 15% faster than City64, xxHash, mum-hash, metro-hash
+ * and all others portable hash-functions (which do not use specific
+ * hardware tricks).
+ * 3. Not suitable for cryptography.
+ *
+ * The Future will (be) Positive. Всё будет хорошо.
+ *
+ * ACKNOWLEDGEMENT:
+ * The t1ha was originally developed by Leonid Yuriev (Леонид Юрьев)
+ * for The 1Hippeus project - zerocopy messaging in the spirit of Sparta!
+ */
+
+#include "t1ha_bits.h"
+#include "t1ha_selfcheck.h"
+
+#if T1HA0_AESNI_AVAILABLE
+
+uint64_t T1HA_IA32AES_NAME(const void *data, uint32_t len) {
+
+ uint64_t a = 0;
+ uint64_t b = len;
+
+ if (likely(len > 32)) {
+
+ __m128i x = _mm_set_epi64x(a, b);
+ __m128i y = _mm_aesenc_si128(x, _mm_set_epi64x(prime_0, prime_1));
+
+ const __m128i *v = (const __m128i *)data;
+ const __m128i *const detent =
+ (const __m128i *)((const uint8_t *)data + (len & ~15ul));
+ data = detent;
+
+ if (len & 16) {
+
+ x = _mm_add_epi64(x, _mm_loadu_si128(v++));
+ y = _mm_aesenc_si128(x, y);
+
+ }
+
+ len &= 15;
+
+ if (v + 7 < detent) {
+
+ __m128i salt = y;
+ do {
+
+ __m128i t = _mm_aesenc_si128(_mm_loadu_si128(v++), salt);
+ t = _mm_aesdec_si128(t, _mm_loadu_si128(v++));
+ t = _mm_aesdec_si128(t, _mm_loadu_si128(v++));
+ t = _mm_aesdec_si128(t, _mm_loadu_si128(v++));
+
+ t = _mm_aesdec_si128(t, _mm_loadu_si128(v++));
+ t = _mm_aesdec_si128(t, _mm_loadu_si128(v++));
+ t = _mm_aesdec_si128(t, _mm_loadu_si128(v++));
+ t = _mm_aesdec_si128(t, _mm_loadu_si128(v++));
+
+ salt = _mm_add_epi64(salt, _mm_set_epi64x(prime_5, prime_6));
+ t = _mm_aesenc_si128(x, t);
+ x = _mm_add_epi64(y, x);
+ y = t;
+
+ } while (v + 7 < detent);
+
+ }
+
+ while (v < detent) {
+
+ __m128i v0y = _mm_add_epi64(y, _mm_loadu_si128(v++));
+ __m128i v1x = _mm_sub_epi64(x, _mm_loadu_si128(v++));
+ x = _mm_aesdec_si128(x, v0y);
+ y = _mm_aesdec_si128(y, v1x);
+
+ }
+
+ x = _mm_add_epi64(_mm_aesdec_si128(x, _mm_aesenc_si128(y, x)), y);
+ #if defined(__x86_64__) || defined(_M_X64)
+ #if defined(__SSE4_1__) || defined(__AVX__)
+ a = _mm_extract_epi64(x, 0);
+ b = _mm_extract_epi64(x, 1);
+ #else
+ a = _mm_cvtsi128_si64(x);
+ b = _mm_cvtsi128_si64(_mm_unpackhi_epi64(x, x));
+ #endif
+ #else
+ #if defined(__SSE4_1__) || defined(__AVX__)
+ a = (uint32_t)_mm_extract_epi32(x, 0) | (uint64_t)_mm_extract_epi32(x, 1)
+ << 32;
+ b = (uint32_t)_mm_extract_epi32(x, 2) | (uint64_t)_mm_extract_epi32(x, 3)
+ << 32;
+ #else
+ a = (uint32_t)_mm_cvtsi128_si32(x);
+ a |= (uint64_t)_mm_cvtsi128_si32(_mm_shuffle_epi32(x, 1)) << 32;
+ x = _mm_unpackhi_epi64(x, x);
+ b = (uint32_t)_mm_cvtsi128_si32(x);
+ b |= (uint64_t)_mm_cvtsi128_si32(_mm_shuffle_epi32(x, 1)) << 32;
+ #endif
+ #endif
+ #ifdef __AVX__
+ _mm256_zeroupper();
+ #elif !(defined(_X86_64_) || defined(__x86_64__) || defined(_M_X64) || \
+ defined(__e2k__))
+ _mm_empty();
+ #endif
+
+ }
+
+ const uint64_t *v = (const uint64_t *)data;
+ switch (len) {
+
+ default:
+ mixup64(&a, &b, fetch64_le_unaligned(v++), prime_4);
+ /* fall through */
+ case 24:
+ case 23:
+ case 22:
+ case 21:
+ case 20:
+ case 19:
+ case 18:
+ case 17:
+ mixup64(&b, &a, fetch64_le_unaligned(v++), prime_3);
+ /* fall through */
+ case 16:
+ case 15:
+ case 14:
+ case 13:
+ case 12:
+ case 11:
+ case 10:
+ case 9:
+ mixup64(&a, &b, fetch64_le_unaligned(v++), prime_2);
+ /* fall through */
+ case 8:
+ case 7:
+ case 6:
+ case 5:
+ case 4:
+ case 3:
+ case 2:
+ case 1:
+ mixup64(&b, &a, tail64_le_unaligned(v, len), prime_1);
+ /* fall through */
+ case 0:
+ return final64(a, b);
+
+ }
+
+}
+
+#endif /* T1HA0_AESNI_AVAILABLE */
+#undef T1HA_IA32AES_NAME
+
diff --git a/include/t1ha_bits.h b/include/t1ha_bits.h
new file mode 100644
index 00000000..0b9bbda5
--- /dev/null
+++ b/include/t1ha_bits.h
@@ -0,0 +1,1423 @@
+/*
+ * Copyright (c) 2016-2020 Positive Technologies, https://www.ptsecurity.com,
+ * Fast Positive Hash.
+ *
+ * Portions Copyright (c) 2010-2020 Leonid Yuriev <leo@yuriev.ru>,
+ * The 1Hippeus project (t1h).
+ *
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ *
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ *
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgement in the product documentation would be
+ * appreciated but is not required.
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 3. This notice may not be removed or altered from any source distribution.
+ */
+
+/*
+ * t1ha = { Fast Positive Hash, aka "Позитивный Хэш" }
+ * by [Positive Technologies](https://www.ptsecurity.ru)
+ *
+ * Briefly, it is a 64-bit Hash Function:
+ * 1. Created for 64-bit little-endian platforms, in predominantly for x86_64,
+ * but portable and without penalties it can run on any 64-bit CPU.
+ * 2. In most cases up to 15% faster than City64, xxHash, mum-hash, metro-hash
+ * and all others portable hash-functions (which do not use specific
+ * hardware tricks).
+ * 3. Not suitable for cryptography.
+ *
+ * The Future will (be) Positive. Всё будет хорошо.
+ *
+ * ACKNOWLEDGEMENT:
+ * The t1ha was originally developed by Leonid Yuriev (Леонид Юрьев)
+ * for The 1Hippeus project - zerocopy messaging in the spirit of Sparta!
+ */
+
+#pragma once
+
+#if defined(_MSC_VER)
+ #pragma warning(disable : 4201) /* nameless struct/union */
+ #if _MSC_VER > 1800
+ #pragma warning(disable : 4464) /* relative include path contains '..' */
+ #endif /* 1800 */
+#endif /* MSVC */
+#include "t1ha.h"
+
+#ifndef T1HA_USE_FAST_ONESHOT_READ
+ /* Define it to 1 for little bit faster code.
+ * Unfortunately this may triggering a false-positive alarms from Valgrind,
+ * AddressSanitizer and other similar tool.
+ * So, define it to 0 for calmness if doubt. */
+ #define T1HA_USE_FAST_ONESHOT_READ 1
+#endif /* T1HA_USE_FAST_ONESHOT_READ */
+
+/*****************************************************************************/
+
+#include <assert.h> /* for assert() */
+#include <stdbool.h> /* for bool */
+#include <string.h> /* for memcpy() */
+
+#if __BYTE_ORDER__ != __ORDER_LITTLE_ENDIAN__ && \
+ __BYTE_ORDER__ != __ORDER_BIG_ENDIAN__
+ #error Unsupported byte order.
+#endif
+
+#define T1HA_UNALIGNED_ACCESS__UNABLE 0
+#define T1HA_UNALIGNED_ACCESS__SLOW 1
+#define T1HA_UNALIGNED_ACCESS__EFFICIENT 2
+
+#ifndef T1HA_SYS_UNALIGNED_ACCESS
+ #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
+ #define T1HA_SYS_UNALIGNED_ACCESS T1HA_UNALIGNED_ACCESS__EFFICIENT
+ #elif defined(__ia32__)
+ #define T1HA_SYS_UNALIGNED_ACCESS T1HA_UNALIGNED_ACCESS__EFFICIENT
+ #elif defined(__e2k__)
+ #define T1HA_SYS_UNALIGNED_ACCESS T1HA_UNALIGNED_ACCESS__SLOW
+ #elif defined(__ARM_FEATURE_UNALIGNED)
+ #define T1HA_SYS_UNALIGNED_ACCESS T1HA_UNALIGNED_ACCESS__EFFICIENT
+ #else
+ #define T1HA_SYS_UNALIGNED_ACCESS T1HA_UNALIGNED_ACCESS__UNABLE
+ #endif
+#endif /* T1HA_SYS_UNALIGNED_ACCESS */
+
+#define ALIGNMENT_16 2
+#define ALIGNMENT_32 4
+#if UINTPTR_MAX > 0xffffFFFFul || ULONG_MAX > 0xffffFFFFul
+ #define ALIGNMENT_64 8
+#else
+ #define ALIGNMENT_64 4
+#endif
+
+#ifndef PAGESIZE
+ #define PAGESIZE 4096
+#endif /* PAGESIZE */
+
+/***************************************************************************/
+
+#ifndef __has_builtin
+ #define __has_builtin(x) (0)
+#endif
+
+#ifndef __has_warning
+ #define __has_warning(x) (0)
+#endif
+
+#ifndef __has_feature
+ #define __has_feature(x) (0)
+#endif
+
+#ifndef __has_extension
+ #define __has_extension(x) (0)
+#endif
+
+#if __has_feature(address_sanitizer)
+ #define __SANITIZE_ADDRESS__ 1
+#endif
+
+#ifndef __optimize
+ #if defined(__clang__) && !__has_attribute(__optimize__)
+ #define __optimize(ops)
+ #elif defined(__GNUC__) || __has_attribute(__optimize__)
+ #define __optimize(ops) __attribute__((__optimize__(ops)))
+ #else
+ #define __optimize(ops)
+ #endif
+#endif /* __optimize */
+
+#ifndef __cold
+ #if defined(__OPTIMIZE__)
+ #if defined(__e2k__)
+ #define __cold __optimize(1) __attribute__((__cold__))
+ #elif defined(__clang__) && !__has_attribute(__cold__) && \
+ __has_attribute(__section__)
+ /* just put infrequently used functions in separate section */
+ #define __cold \
+ __attribute__((__section__("text.unlikely"))) __optimize("Os")
+ #elif defined(__GNUC__) || __has_attribute(__cold__)
+ #define __cold __attribute__((__cold__)) __optimize("Os")
+ #else
+ #define __cold __optimize("Os")
+ #endif
+ #else
+ #define __cold
+ #endif
+#endif /* __cold */
+
+#if __GNUC_PREREQ(4, 4) || defined(__clang__)
+
+ #if defined(__ia32__) || defined(__e2k__)
+ #include <x86intrin.h>
+ #endif
+
+ #if defined(__ia32__) && !defined(__cpuid_count)
+ #include <cpuid.h>
+ #endif
+
+ #if defined(__e2k__)
+ #include <e2kbuiltin.h>
+ #endif
+
+ #ifndef likely
+ #define likely(cond) __builtin_expect(!!(cond), 1)
+ #endif
+
+ #ifndef unlikely
+ #define unlikely(cond) __builtin_expect(!!(cond), 0)
+ #endif
+
+ #if __GNUC_PREREQ(4, 5) || __has_builtin(__builtin_unreachable)
+ #define unreachable() __builtin_unreachable()
+ #endif
+
+ #define bswap64(v) __builtin_bswap64(v)
+ #define bswap32(v) __builtin_bswap32(v)
+ #if __GNUC_PREREQ(4, 8) || __has_builtin(__builtin_bswap16)
+ #define bswap16(v) __builtin_bswap16(v)
+ #endif
+
+ #if !defined(__maybe_unused) && \
+ (__GNUC_PREREQ(4, 3) || __has_attribute(__unused__))
+ #define __maybe_unused __attribute__((__unused__))
+ #endif
+
+ #if !defined(__always_inline) && \
+ (__GNUC_PREREQ(3, 2) || __has_attribute(__always_inline__))
+ #define __always_inline __inline __attribute__((__always_inline__))
+ #endif
+
+ #if defined(__e2k__)
+
+ #if __iset__ >= 3
+ #define mul_64x64_high(a, b) __builtin_e2k_umulhd(a, b)
+ #endif /* __iset__ >= 3 */
+
+ #if __iset__ >= 5
+static __maybe_unused __always_inline unsigned e2k_add64carry_first(
+ uint64_t base, uint64_t addend, uint64_t *sum) {
+
+ *sum = base + addend;
+ return (unsigned)__builtin_e2k_addcd_c(base, addend, 0);
+
+}
+
+ #define add64carry_first(base, addend, sum) \
+ e2k_add64carry_first(base, addend, sum)
+
+static __maybe_unused __always_inline unsigned e2k_add64carry_next(
+ unsigned carry, uint64_t base, uint64_t addend, uint64_t *sum) {
+
+ *sum = __builtin_e2k_addcd(base, addend, carry);
+ return (unsigned)__builtin_e2k_addcd_c(base, addend, carry);
+
+}
+
+ #define add64carry_next(carry, base, addend, sum) \
+ e2k_add64carry_next(carry, base, addend, sum)
+
+static __maybe_unused __always_inline void e2k_add64carry_last(unsigned carry,
+ uint64_t base,
+ uint64_t addend,
+ uint64_t *sum) {
+
+ *sum = __builtin_e2k_addcd(base, addend, carry);
+
+}
+
+ #define add64carry_last(carry, base, addend, sum) \
+ e2k_add64carry_last(carry, base, addend, sum)
+ #endif /* __iset__ >= 5 */
+
+ #define fetch64_be_aligned(ptr) ((uint64_t)__builtin_e2k_ld_64s_be(ptr))
+ #define fetch32_be_aligned(ptr) ((uint32_t)__builtin_e2k_ld_32u_be(ptr))
+
+ #endif /* __e2k__ Elbrus */
+
+#elif defined(_MSC_VER)
+
+ #if _MSC_FULL_VER < 190024234 && defined(_M_IX86)
+ #pragma message( \
+ "For AES-NI at least \"Microsoft C/C++ Compiler\" version 19.00.24234 (Visual Studio 2015 Update 3) is required.")
+ #endif
+ #if _MSC_FULL_VER < 191526730
+ #pragma message( \
+ "It is recommended to use \"Microsoft C/C++ Compiler\" version 19.15.26730 (Visual Studio 2017 15.8) or newer.")
+ #endif
+ #if _MSC_FULL_VER < 180040629
+ #error At least "Microsoft C/C++ Compiler" version 18.00.40629 (Visual Studio 2013 Update 5) is required.
+ #endif
+
+ #pragma warning(push, 1)
+
+ #include <intrin.h>
+ #include <stdlib.h>
+ #define likely(cond) (cond)
+ #define unlikely(cond) (cond)
+ #define unreachable() __assume(0)
+ #define bswap64(v) _byteswap_uint64(v)
+ #define bswap32(v) _byteswap_ulong(v)
+ #define bswap16(v) _byteswap_ushort(v)
+ #define rot64(v, s) _rotr64(v, s)
+ #define rot32(v, s) _rotr(v, s)
+ #define __always_inline __forceinline
+
+ #if defined(_M_X64) || defined(_M_IA64)
+ #pragma intrinsic(_umul128)
+ #define mul_64x64_128(a, b, ph) _umul128(a, b, ph)
+ #pragma intrinsic(_addcarry_u64)
+ #define add64carry_first(base, addend, sum) \
+ _addcarry_u64(0, base, addend, sum)
+ #define add64carry_next(carry, base, addend, sum) \
+ _addcarry_u64(carry, base, addend, sum)
+ #define add64carry_last(carry, base, addend, sum) \
+ (void)_addcarry_u64(carry, base, addend, sum)
+ #endif
+
+ #if defined(_M_ARM64) || defined(_M_X64) || defined(_M_IA64)
+ #pragma intrinsic(__umulh)
+ #define mul_64x64_high(a, b) __umulh(a, b)
+ #endif
+
+ #if defined(_M_IX86)
+ #pragma intrinsic(__emulu)
+ #define mul_32x32_64(a, b) __emulu(a, b)
+
+ #if _MSC_VER >= 1915 /* LY: workaround for SSA-optimizer bug */
+ #pragma intrinsic(_addcarry_u32)
+ #define add32carry_first(base, addend, sum) \
+ _addcarry_u32(0, base, addend, sum)
+ #define add32carry_next(carry, base, addend, sum) \
+ _addcarry_u32(carry, base, addend, sum)
+ #define add32carry_last(carry, base, addend, sum) \
+ (void)_addcarry_u32(carry, base, addend, sum)
+
+static __forceinline char msvc32_add64carry_first(uint64_t base,
+ uint64_t addend,
+ uint64_t *sum) {
+
+ uint32_t *const sum32 = (uint32_t *)sum;
+ const uint32_t base_32l = (uint32_t)base;
+ const uint32_t base_32h = (uint32_t)(base >> 32);
+ const uint32_t addend_32l = (uint32_t)addend;
+ const uint32_t addend_32h = (uint32_t)(addend >> 32);
+ return add32carry_next(add32carry_first(base_32l, addend_32l, sum32),
+ base_32h, addend_32h, sum32 + 1);
+
+}
+
+ #define add64carry_first(base, addend, sum) \
+ msvc32_add64carry_first(base, addend, sum)
+
+static __forceinline char msvc32_add64carry_next(char carry, uint64_t base,
+ uint64_t addend,
+ uint64_t *sum) {
+
+ uint32_t *const sum32 = (uint32_t *)sum;
+ const uint32_t base_32l = (uint32_t)base;
+ const uint32_t base_32h = (uint32_t)(base >> 32);
+ const uint32_t addend_32l = (uint32_t)addend;
+ const uint32_t addend_32h = (uint32_t)(addend >> 32);
+ return add32carry_next(add32carry_next(carry, base_32l, addend_32l, sum32),
+ base_32h, addend_32h, sum32 + 1);
+
+}
+
+ #define add64carry_next(carry, base, addend, sum) \
+ msvc32_add64carry_next(carry, base, addend, sum)
+
+static __forceinline void msvc32_add64carry_last(char carry, uint64_t base,
+ uint64_t addend,
+ uint64_t *sum) {
+
+ uint32_t *const sum32 = (uint32_t *)sum;
+ const uint32_t base_32l = (uint32_t)base;
+ const uint32_t base_32h = (uint32_t)(base >> 32);
+ const uint32_t addend_32l = (uint32_t)addend;
+ const uint32_t addend_32h = (uint32_t)(addend >> 32);
+ add32carry_last(add32carry_next(carry, base_32l, addend_32l, sum32), base_32h,
+ addend_32h, sum32 + 1);
+
+}
+
+ #define add64carry_last(carry, base, addend, sum) \
+ msvc32_add64carry_last(carry, base, addend, sum)
+ #endif /* _MSC_FULL_VER >= 190024231 */
+
+ #elif defined(_M_ARM)
+ #define mul_32x32_64(a, b) _arm_umull(a, b)
+ #endif
+
+ #pragma warning(pop)
+ #pragma warning(disable : 4514) /* 'xyz': unreferenced inline function \
+ has been removed */
+ #pragma warning(disable : 4710) /* 'xyz': function not inlined */
+ #pragma warning(disable : 4711) /* function 'xyz' selected for \
+ automatic inline expansion */
+ #pragma warning(disable : 4127) /* conditional expression is constant */
+ #pragma warning(disable : 4702) /* unreachable code */
+#endif /* Compiler */
+
+#ifndef likely
+ #define likely(cond) (cond)
+#endif
+#ifndef unlikely
+ #define unlikely(cond) (cond)
+#endif
+#ifndef __maybe_unused
+ #define __maybe_unused
+#endif
+#ifndef __always_inline
+ #define __always_inline __inline
+#endif
+#ifndef unreachable
+ #define unreachable() \
+ do { \
+ \
+ } while (1)
+#endif
+
+#ifndef bswap64
+ #if defined(bswap_64)
+ #define bswap64 bswap_64
+ #elif defined(__bswap_64)
+ #define bswap64 __bswap_64
+ #else
+static __always_inline uint64_t bswap64(uint64_t v) {
+
+ return v << 56 | v >> 56 | ((v << 40) & UINT64_C(0x00ff000000000000)) |
+ ((v << 24) & UINT64_C(0x0000ff0000000000)) |
+ ((v << 8) & UINT64_C(0x000000ff00000000)) |
+ ((v >> 8) & UINT64_C(0x00000000ff000000)) |
+ ((v >> 24) & UINT64_C(0x0000000000ff0000)) |
+ ((v >> 40) & UINT64_C(0x000000000000ff00));
+
+}
+
+ #endif
+#endif /* bswap64 */
+
+#ifndef bswap32
+ #if defined(bswap_32)
+ #define bswap32 bswap_32
+ #elif defined(__bswap_32)
+ #define bswap32 __bswap_32
+ #else
+static __always_inline uint32_t bswap32(uint32_t v) {
+
+ return v << 24 | v >> 24 | ((v << 8) & UINT32_C(0x00ff0000)) |
+ ((v >> 8) & UINT32_C(0x0000ff00));
+
+}
+
+ #endif
+#endif /* bswap32 */
+
+#ifndef bswap16
+ #if defined(bswap_16)
+ #define bswap16 bswap_16
+ #elif defined(__bswap_16)
+ #define bswap16 __bswap_16
+ #else
+static __always_inline uint16_t bswap16(uint16_t v) {
+
+ return v << 8 | v >> 8;
+
+}
+
+ #endif
+#endif /* bswap16 */
+
+#if defined(__ia32__) || \
+ T1HA_SYS_UNALIGNED_ACCESS == T1HA_UNALIGNED_ACCESS__EFFICIENT
+ /* The __builtin_assume_aligned() leads gcc/clang to load values into the
+ * registers, even when it is possible to directly use an operand from memory.
+ * This can lead to a shortage of registers and a significant slowdown.
+ * Therefore avoid unnecessary use of __builtin_assume_aligned() for x86. */
+ #define read_unaligned(ptr, bits) (*(const uint##bits##_t *__restrict)(ptr))
+ #define read_aligned(ptr, bits) (*(const uint##bits##_t *__restrict)(ptr))
+#endif /* __ia32__ */
+
+#ifndef read_unaligned
+ #if defined(__GNUC__) || __has_attribute(__packed__)
+typedef struct {
+
+ uint8_t unaligned_8;
+ uint16_t unaligned_16;
+ uint32_t unaligned_32;
+ uint64_t unaligned_64;
+
+} __attribute__((__packed__)) t1ha_unaligned_proxy;
+
+ #define read_unaligned(ptr, bits) \
+ (((const t1ha_unaligned_proxy *)((const uint8_t *)(ptr)-offsetof( \
+ t1ha_unaligned_proxy, unaligned_##bits))) \
+ ->unaligned_##bits)
+ #elif defined(_MSC_VER)
+ #pragma warning( \
+ disable : 4235) /* nonstandard extension used: '__unaligned' \
+ * keyword not supported on this architecture */
+ #define read_unaligned(ptr, bits) \
+ (*(const __unaligned uint##bits##_t *)(ptr))
+ #else
+ #pragma pack(push, 1)
+typedef struct {
+
+ uint8_t unaligned_8;
+ uint16_t unaligned_16;
+ uint32_t unaligned_32;
+ uint64_t unaligned_64;
+
+} t1ha_unaligned_proxy;
+
+ #pragma pack(pop)
+ #define read_unaligned(ptr, bits) \
+ (((const t1ha_unaligned_proxy *)((const uint8_t *)(ptr)-offsetof( \
+ t1ha_unaligned_proxy, unaligned_##bits))) \
+ ->unaligned_##bits)
+ #endif
+#endif /* read_unaligned */
+
+#ifndef read_aligned
+ #if __GNUC_PREREQ(4, 8) || __has_builtin(__builtin_assume_aligned)
+ #define read_aligned(ptr, bits) \
+ (*(const uint##bits##_t *)__builtin_assume_aligned(ptr, ALIGNMENT_##bits))
+ #elif (__GNUC_PREREQ(3, 3) || __has_attribute(__aligned__)) && \
+ !defined(__clang__)
+ #define read_aligned(ptr, bits) \
+ (*(const uint##bits##_t \
+ __attribute__((__aligned__(ALIGNMENT_##bits))) *)(ptr))
+ #elif __has_attribute(__assume_aligned__)
+
+static __always_inline const uint16_t *__attribute__((
+ __assume_aligned__(ALIGNMENT_16))) cast_aligned_16(const void *ptr) {
+
+ return (const uint16_t *)ptr;
+
+}
+
+static __always_inline const uint32_t *__attribute__((
+ __assume_aligned__(ALIGNMENT_32))) cast_aligned_32(const void *ptr) {
+
+ return (const uint32_t *)ptr;
+
+}
+
+static __always_inline const uint64_t *__attribute__((
+ __assume_aligned__(ALIGNMENT_64))) cast_aligned_64(const void *ptr) {
+
+ return (const uint64_t *)ptr;
+
+}
+
+ #define read_aligned(ptr, bits) (*cast_aligned_##bits(ptr))
+
+ #elif defined(_MSC_VER)
+ #define read_aligned(ptr, bits) \
+ (*(const __declspec(align(ALIGNMENT_##bits)) uint##bits##_t *)(ptr))
+ #else
+ #define read_aligned(ptr, bits) (*(const uint##bits##_t *)(ptr))
+ #endif
+#endif /* read_aligned */
+
+#ifndef prefetch
+ #if (__GNUC_PREREQ(4, 0) || __has_builtin(__builtin_prefetch)) && \
+ !defined(__ia32__)
+ #define prefetch(ptr) __builtin_prefetch(ptr)
+ #elif defined(_M_ARM64) || defined(_M_ARM)
+ #define prefetch(ptr) __prefetch(ptr)
+ #else
+ #define prefetch(ptr) \
+ do { \
+ \
+ (void)(ptr); \
+ \
+ } while (0)
+
+ #endif
+#endif /* prefetch */
+
+#if __has_warning("-Wconstant-logical-operand")
+ #if defined(__clang__)
+ #pragma clang diagnostic ignored "-Wconstant-logical-operand"
+ #elif defined(__GNUC__)
+ #pragma GCC diagnostic ignored "-Wconstant-logical-operand"
+ #else
+ #pragma warning disable "constant-logical-operand"
+ #endif
+#endif /* -Wconstant-logical-operand */
+
+#if __has_warning("-Wtautological-pointer-compare")
+ #if defined(__clang__)
+ #pragma clang diagnostic ignored "-Wtautological-pointer-compare"
+ #elif defined(__GNUC__)
+ #pragma GCC diagnostic ignored "-Wtautological-pointer-compare"
+ #else
+ #pragma warning disable "tautological-pointer-compare"
+ #endif
+#endif /* -Wtautological-pointer-compare */
+
+/***************************************************************************/
+
+#if __GNUC_PREREQ(4, 0)
+ #pragma GCC visibility push(hidden)
+#endif /* __GNUC_PREREQ(4,0) */
+
+/*---------------------------------------------------------- Little Endian */
+
+#ifndef fetch16_le_aligned
+static __maybe_unused __always_inline uint16_t
+fetch16_le_aligned(const void *v) {
+
+ assert(((uintptr_t)v) % ALIGNMENT_16 == 0);
+ #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
+ return read_aligned(v, 16);
+ #else
+ return bswap16(read_aligned(v, 16));
+ #endif
+
+}
+
+#endif /* fetch16_le_aligned */
+
+#ifndef fetch16_le_unaligned
+static __maybe_unused __always_inline uint16_t
+fetch16_le_unaligned(const void *v) {
+
+ #if T1HA_SYS_UNALIGNED_ACCESS == T1HA_UNALIGNED_ACCESS__UNABLE
+ const uint8_t *p = (const uint8_t *)v;
+ return p[0] | (uint16_t)p[1] << 8;
+ #elif __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
+ return read_unaligned(v, 16);
+ #else
+ return bswap16(read_unaligned(v, 16));
+ #endif
+
+}
+
+#endif /* fetch16_le_unaligned */
+
+#ifndef fetch32_le_aligned
+static __maybe_unused __always_inline uint32_t
+fetch32_le_aligned(const void *v) {
+
+ assert(((uintptr_t)v) % ALIGNMENT_32 == 0);
+ #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
+ return read_aligned(v, 32);
+ #else
+ return bswap32(read_aligned(v, 32));
+ #endif
+
+}
+
+#endif /* fetch32_le_aligned */
+
+#ifndef fetch32_le_unaligned
+static __maybe_unused __always_inline uint32_t
+fetch32_le_unaligned(const void *v) {
+
+ #if T1HA_SYS_UNALIGNED_ACCESS == T1HA_UNALIGNED_ACCESS__UNABLE
+ return fetch16_le_unaligned(v) |
+ (uint32_t)fetch16_le_unaligned((const uint8_t *)v + 2) << 16;
+ #elif __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
+ return read_unaligned(v, 32);
+ #else
+ return bswap32(read_unaligned(v, 32));
+ #endif
+
+}
+
+#endif /* fetch32_le_unaligned */
+
+#ifndef fetch64_le_aligned
+static __maybe_unused __always_inline uint64_t
+fetch64_le_aligned(const void *v) {
+
+ assert(((uintptr_t)v) % ALIGNMENT_64 == 0);
+ #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
+ return read_aligned(v, 64);
+ #else
+ return bswap64(read_aligned(v, 64));
+ #endif
+
+}
+
+#endif /* fetch64_le_aligned */
+
+#ifndef fetch64_le_unaligned
+static __maybe_unused __always_inline uint64_t
+fetch64_le_unaligned(const void *v) {
+
+ #if T1HA_SYS_UNALIGNED_ACCESS == T1HA_UNALIGNED_ACCESS__UNABLE
+ return fetch32_le_unaligned(v) |
+ (uint64_t)fetch32_le_unaligned((const uint8_t *)v + 4) << 32;
+ #elif __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
+ return read_unaligned(v, 64);
+ #else
+ return bswap64(read_unaligned(v, 64));
+ #endif
+
+}
+
+#endif /* fetch64_le_unaligned */
+
+static __maybe_unused __always_inline uint64_t tail64_le_aligned(const void *v,
+ size_t tail) {
+
+ const uint8_t *const p = (const uint8_t *)v;
+#if T1HA_USE_FAST_ONESHOT_READ && !defined(__SANITIZE_ADDRESS__)
+ /* We can perform a 'oneshot' read, which is little bit faster. */
+ const unsigned shift = ((8 - tail) & 7) << 3;
+ return fetch64_le_aligned(p) & ((~UINT64_C(0)) >> shift);
+#else
+ uint64_t r = 0;
+ switch (tail & 7) {
+
+ default:
+ unreachable();
+ /* fall through */
+ #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
+ /* For most CPUs this code is better when not needed byte reordering. */
+ case 0:
+ return fetch64_le_aligned(p);
+ case 7:
+ r = (uint64_t)p[6] << 8;
+ /* fall through */
+ case 6:
+ r += p[5];
+ r <<= 8;
+ /* fall through */
+ case 5:
+ r += p[4];
+ r <<= 32;
+ /* fall through */
+ case 4:
+ return r + fetch32_le_aligned(p);
+ case 3:
+ r = (uint64_t)p[2] << 16;
+ /* fall through */
+ case 2:
+ return r + fetch16_le_aligned(p);
+ case 1:
+ return p[0];
+ #else
+ case 0:
+ r = p[7] << 8;
+ /* fall through */
+ case 7:
+ r += p[6];
+ r <<= 8;
+ /* fall through */
+ case 6:
+ r += p[5];
+ r <<= 8;
+ /* fall through */
+ case 5:
+ r += p[4];
+ r <<= 8;
+ /* fall through */
+ case 4:
+ r += p[3];
+ r <<= 8;
+ /* fall through */
+ case 3:
+ r += p[2];
+ r <<= 8;
+ /* fall through */
+ case 2:
+ r += p[1];
+ r <<= 8;
+ /* fall through */
+ case 1:
+ return r + p[0];
+ #endif
+
+ }
+
+#endif /* T1HA_USE_FAST_ONESHOT_READ */
+
+}
+
+#if T1HA_USE_FAST_ONESHOT_READ && \
+ T1HA_SYS_UNALIGNED_ACCESS != T1HA_UNALIGNED_ACCESS__UNABLE && \
+ defined(PAGESIZE) && PAGESIZE > 42 && !defined(__SANITIZE_ADDRESS__)
+ #define can_read_underside(ptr, size) \
+ (((PAGESIZE - (size)) & (uintptr_t)(ptr)) != 0)
+#endif /* T1HA_USE_FAST_ONESHOT_READ */
+
+static __maybe_unused __always_inline uint64_t
+tail64_le_unaligned(const void *v, size_t tail) {
+
+ const uint8_t *p = (const uint8_t *)v;
+#if defined(can_read_underside) && \
+ (UINTPTR_MAX > 0xffffFFFFul || ULONG_MAX > 0xffffFFFFul)
+ /* On some systems (e.g. x86_64) we can perform a 'oneshot' read, which
+ * is little bit faster. Thanks Marcin Żukowski <marcin.zukowski@gmail.com>
+ * for the reminder. */
+ const unsigned offset = (8 - tail) & 7;
+ const unsigned shift = offset << 3;
+ if (likely(can_read_underside(p, 8))) {
+
+ p -= offset;
+ return fetch64_le_unaligned(p) >> shift;
+
+ }
+
+ return fetch64_le_unaligned(p) & ((~UINT64_C(0)) >> shift);
+#else
+ uint64_t r = 0;
+ switch (tail & 7) {
+
+ default:
+ unreachable();
+ /* fall through */
+ #if T1HA_SYS_UNALIGNED_ACCESS == T1HA_UNALIGNED_ACCESS__EFFICIENT && \
+ __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
+ /* For most CPUs this code is better when not needed
+ * copying for alignment or byte reordering. */
+ case 0:
+ return fetch64_le_unaligned(p);
+ case 7:
+ r = (uint64_t)p[6] << 8;
+ /* fall through */
+ case 6:
+ r += p[5];
+ r <<= 8;
+ /* fall through */
+ case 5:
+ r += p[4];
+ r <<= 32;
+ /* fall through */
+ case 4:
+ return r + fetch32_le_unaligned(p);
+ case 3:
+ r = (uint64_t)p[2] << 16;
+ /* fall through */
+ case 2:
+ return r + fetch16_le_unaligned(p);
+ case 1:
+ return p[0];
+ #else
+ /* For most CPUs this code is better than a
+ * copying for alignment and/or byte reordering. */
+ case 0:
+ r = p[7] << 8;
+ /* fall through */
+ case 7:
+ r += p[6];
+ r <<= 8;
+ /* fall through */
+ case 6:
+ r += p[5];
+ r <<= 8;
+ /* fall through */
+ case 5:
+ r += p[4];
+ r <<= 8;
+ /* fall through */
+ case 4:
+ r += p[3];
+ r <<= 8;
+ /* fall through */
+ case 3:
+ r += p[2];
+ r <<= 8;
+ /* fall through */
+ case 2:
+ r += p[1];
+ r <<= 8;
+ /* fall through */
+ case 1:
+ return r + p[0];
+ #endif
+
+ }
+
+#endif /* can_read_underside */
+
+}
+
+/*------------------------------------------------------------- Big Endian */
+
+#ifndef fetch16_be_aligned
+static __maybe_unused __always_inline uint16_t
+fetch16_be_aligned(const void *v) {
+
+ assert(((uintptr_t)v) % ALIGNMENT_16 == 0);
+ #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+ return read_aligned(v, 16);
+ #else
+ return bswap16(read_aligned(v, 16));
+ #endif
+
+}
+
+#endif /* fetch16_be_aligned */
+
+#ifndef fetch16_be_unaligned
+static __maybe_unused __always_inline uint16_t
+fetch16_be_unaligned(const void *v) {
+
+ #if T1HA_SYS_UNALIGNED_ACCESS == T1HA_UNALIGNED_ACCESS__UNABLE
+ const uint8_t *p = (const uint8_t *)v;
+ return (uint16_t)p[0] << 8 | p[1];
+ #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+ return read_unaligned(v, 16);
+ #else
+ return bswap16(read_unaligned(v, 16));
+ #endif
+
+}
+
+#endif /* fetch16_be_unaligned */
+
+#ifndef fetch32_be_aligned
+static __maybe_unused __always_inline uint32_t
+fetch32_be_aligned(const void *v) {
+
+ assert(((uintptr_t)v) % ALIGNMENT_32 == 0);
+ #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+ return read_aligned(v, 32);
+ #else
+ return bswap32(read_aligned(v, 32));
+ #endif
+
+}
+
+#endif /* fetch32_be_aligned */
+
+#ifndef fetch32_be_unaligned
+static __maybe_unused __always_inline uint32_t
+fetch32_be_unaligned(const void *v) {
+
+ #if T1HA_SYS_UNALIGNED_ACCESS == T1HA_UNALIGNED_ACCESS__UNABLE
+ return (uint32_t)fetch16_be_unaligned(v) << 16 |
+ fetch16_be_unaligned((const uint8_t *)v + 2);
+ #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+ return read_unaligned(v, 32);
+ #else
+ return bswap32(read_unaligned(v, 32));
+ #endif
+
+}
+
+#endif /* fetch32_be_unaligned */
+
+#ifndef fetch64_be_aligned
+static __maybe_unused __always_inline uint64_t
+fetch64_be_aligned(const void *v) {
+
+ assert(((uintptr_t)v) % ALIGNMENT_64 == 0);
+ #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+ return read_aligned(v, 64);
+ #else
+ return bswap64(read_aligned(v, 64));
+ #endif
+
+}
+
+#endif /* fetch64_be_aligned */
+
+#ifndef fetch64_be_unaligned
+static __maybe_unused __always_inline uint64_t
+fetch64_be_unaligned(const void *v) {
+
+ #if T1HA_SYS_UNALIGNED_ACCESS == T1HA_UNALIGNED_ACCESS__UNABLE
+ return (uint64_t)fetch32_be_unaligned(v) << 32 |
+ fetch32_be_unaligned((const uint8_t *)v + 4);
+ #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+ return read_unaligned(v, 64);
+ #else
+ return bswap64(read_unaligned(v, 64));
+ #endif
+
+}
+
+#endif /* fetch64_be_unaligned */
+
+static __maybe_unused __always_inline uint64_t tail64_be_aligned(const void *v,
+ size_t tail) {
+
+ const uint8_t *const p = (const uint8_t *)v;
+#if T1HA_USE_FAST_ONESHOT_READ && !defined(__SANITIZE_ADDRESS__)
+ /* We can perform a 'oneshot' read, which is little bit faster. */
+ const unsigned shift = ((8 - tail) & 7) << 3;
+ return fetch64_be_aligned(p) >> shift;
+#else
+ switch (tail & 7) {
+
+ default:
+ unreachable();
+ /* fall through */
+ #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+ /* For most CPUs this code is better when not byte reordering. */
+ case 1:
+ return p[0];
+ case 2:
+ return fetch16_be_aligned(p);
+ case 3:
+ return (uint32_t)fetch16_be_aligned(p) << 8 | p[2];
+ case 4:
+ return fetch32_be_aligned(p);
+ case 5:
+ return (uint64_t)fetch32_be_aligned(p) << 8 | p[4];
+ case 6:
+ return (uint64_t)fetch32_be_aligned(p) << 16 | fetch16_be_aligned(p + 4);
+ case 7:
+ return (uint64_t)fetch32_be_aligned(p) << 24 |
+ (uint32_t)fetch16_be_aligned(p + 4) << 8 | p[6];
+ case 0:
+ return fetch64_be_aligned(p);
+ #else
+ case 1:
+ return p[0];
+ case 2:
+ return p[1] | (uint32_t)p[0] << 8;
+ case 3:
+ return p[2] | (uint32_t)p[1] << 8 | (uint32_t)p[0] << 16;
+ case 4:
+ return p[3] | (uint32_t)p[2] << 8 | (uint32_t)p[1] << 16 |
+ (uint32_t)p[0] << 24;
+ case 5:
+ return p[4] | (uint32_t)p[3] << 8 | (uint32_t)p[2] << 16 |
+ (uint32_t)p[1] << 24 | (uint64_t)p[0] << 32;
+ case 6:
+ return p[5] | (uint32_t)p[4] << 8 | (uint32_t)p[3] << 16 |
+ (uint32_t)p[2] << 24 | (uint64_t)p[1] << 32 | (uint64_t)p[0] << 40;
+ case 7:
+ return p[6] | (uint32_t)p[5] << 8 | (uint32_t)p[4] << 16 |
+ (uint32_t)p[3] << 24 | (uint64_t)p[2] << 32 |
+ (uint64_t)p[1] << 40 | (uint64_t)p[0] << 48;
+ case 0:
+ return p[7] | (uint32_t)p[6] << 8 | (uint32_t)p[5] << 16 |
+ (uint32_t)p[4] << 24 | (uint64_t)p[3] << 32 |
+ (uint64_t)p[2] << 40 | (uint64_t)p[1] << 48 | (uint64_t)p[0] << 56;
+ #endif
+
+ }
+
+#endif /* T1HA_USE_FAST_ONESHOT_READ */
+
+}
+
+static __maybe_unused __always_inline uint64_t
+tail64_be_unaligned(const void *v, size_t tail) {
+
+ const uint8_t *p = (const uint8_t *)v;
+#if defined(can_read_underside) && \
+ (UINTPTR_MAX > 0xffffFFFFul || ULONG_MAX > 0xffffFFFFul)
+ /* On some systems (e.g. x86_64) we can perform a 'oneshot' read, which
+ * is little bit faster. Thanks Marcin Żukowski <marcin.zukowski@gmail.com>
+ * for the reminder. */
+ const unsigned offset = (8 - tail) & 7;
+ const unsigned shift = offset << 3;
+ if (likely(can_read_underside(p, 8))) {
+
+ p -= offset;
+ return fetch64_be_unaligned(p) & ((~UINT64_C(0)) >> shift);
+
+ }
+
+ return fetch64_be_unaligned(p) >> shift;
+#else
+ switch (tail & 7) {
+
+ default:
+ unreachable();
+ /* fall through */
+ #if T1HA_SYS_UNALIGNED_ACCESS == T1HA_UNALIGNED_ACCESS__EFFICIENT && \
+ __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+ /* For most CPUs this code is better when not needed
+ * copying for alignment or byte reordering. */
+ case 1:
+ return p[0];
+ case 2:
+ return fetch16_be_unaligned(p);
+ case 3:
+ return (uint32_t)fetch16_be_unaligned(p) << 8 | p[2];
+ case 4:
+ return fetch32_be(p);
+ case 5:
+ return (uint64_t)fetch32_be_unaligned(p) << 8 | p[4];
+ case 6:
+ return (uint64_t)fetch32_be_unaligned(p) << 16 |
+ fetch16_be_unaligned(p + 4);
+ case 7:
+ return (uint64_t)fetch32_be_unaligned(p) << 24 |
+ (uint32_t)fetch16_be_unaligned(p + 4) << 8 | p[6];
+ case 0:
+ return fetch64_be_unaligned(p);
+ #else
+ /* For most CPUs this code is better than a
+ * copying for alignment and/or byte reordering. */
+ case 1:
+ return p[0];
+ case 2:
+ return p[1] | (uint32_t)p[0] << 8;
+ case 3:
+ return p[2] | (uint32_t)p[1] << 8 | (uint32_t)p[0] << 16;
+ case 4:
+ return p[3] | (uint32_t)p[2] << 8 | (uint32_t)p[1] << 16 |
+ (uint32_t)p[0] << 24;
+ case 5:
+ return p[4] | (uint32_t)p[3] << 8 | (uint32_t)p[2] << 16 |
+ (uint32_t)p[1] << 24 | (uint64_t)p[0] << 32;
+ case 6:
+ return p[5] | (uint32_t)p[4] << 8 | (uint32_t)p[3] << 16 |
+ (uint32_t)p[2] << 24 | (uint64_t)p[1] << 32 | (uint64_t)p[0] << 40;
+ case 7:
+ return p[6] | (uint32_t)p[5] << 8 | (uint32_t)p[4] << 16 |
+ (uint32_t)p[3] << 24 | (uint64_t)p[2] << 32 |
+ (uint64_t)p[1] << 40 | (uint64_t)p[0] << 48;
+ case 0:
+ return p[7] | (uint32_t)p[6] << 8 | (uint32_t)p[5] << 16 |
+ (uint32_t)p[4] << 24 | (uint64_t)p[3] << 32 |
+ (uint64_t)p[2] << 40 | (uint64_t)p[1] << 48 | (uint64_t)p[0] << 56;
+ #endif
+
+ }
+
+#endif /* can_read_underside */
+
+}
+
+/***************************************************************************/
+
+#ifndef rot64
+static __maybe_unused __always_inline uint64_t rot64(uint64_t v, unsigned s) {
+
+ return (v >> s) | (v << (64 - s));
+
+}
+
+#endif /* rot64 */
+
+#ifndef mul_32x32_64
+static __maybe_unused __always_inline uint64_t mul_32x32_64(uint32_t a,
+ uint32_t b) {
+
+ return a * (uint64_t)b;
+
+}
+
+#endif /* mul_32x32_64 */
+
+#ifndef add64carry_first
+static __maybe_unused __always_inline unsigned add64carry_first(uint64_t base,
+ uint64_t addend,
+ uint64_t *sum) {
+
+ #if __has_builtin(__builtin_addcll)
+ unsigned long long carryout;
+ *sum = __builtin_addcll(base, addend, 0, &carryout);
+ return (unsigned)carryout;
+ #else
+ *sum = base + addend;
+ return *sum < addend;
+ #endif /* __has_builtin(__builtin_addcll) */
+
+}
+
+#endif /* add64carry_fist */
+
+#ifndef add64carry_next
+static __maybe_unused __always_inline unsigned add64carry_next(unsigned carry,
+ uint64_t base,
+ uint64_t addend,
+ uint64_t *sum) {
+
+ #if __has_builtin(__builtin_addcll)
+ unsigned long long carryout;
+ *sum = __builtin_addcll(base, addend, carry, &carryout);
+ return (unsigned)carryout;
+ #else
+ *sum = base + addend + carry;
+ return *sum < addend || (carry && *sum == addend);
+ #endif /* __has_builtin(__builtin_addcll) */
+
+}
+
+#endif /* add64carry_next */
+
+#ifndef add64carry_last
+static __maybe_unused __always_inline void add64carry_last(unsigned carry,
+ uint64_t base,
+ uint64_t addend,
+ uint64_t *sum) {
+
+ #if __has_builtin(__builtin_addcll)
+ unsigned long long carryout;
+ *sum = __builtin_addcll(base, addend, carry, &carryout);
+ (void)carryout;
+ #else
+ *sum = base + addend + carry;
+ #endif /* __has_builtin(__builtin_addcll) */
+
+}
+
+#endif /* add64carry_last */
+
+#ifndef mul_64x64_128
+static __maybe_unused __always_inline uint64_t mul_64x64_128(uint64_t a,
+ uint64_t b,
+ uint64_t *h) {
+
+ #if (defined(__SIZEOF_INT128__) || \
+ (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)) && \
+ (!defined(__LCC__) || __LCC__ != 124)
+ __uint128_t r = (__uint128_t)a * (__uint128_t)b;
+ /* modern GCC could nicely optimize this */
+ *h = (uint64_t)(r >> 64);
+ return (uint64_t)r;
+ #elif defined(mul_64x64_high)
+ *h = mul_64x64_high(a, b);
+ return a * b;
+ #else
+ /* performs 64x64 to 128 bit multiplication */
+ const uint64_t ll = mul_32x32_64((uint32_t)a, (uint32_t)b);
+ const uint64_t lh = mul_32x32_64(a >> 32, (uint32_t)b);
+ const uint64_t hl = mul_32x32_64((uint32_t)a, b >> 32);
+ const uint64_t hh = mul_32x32_64(a >> 32, b >> 32);
+
+ /* Few simplification are possible here for 32-bit architectures,
+ * but thus we would lost compatibility with the original 64-bit
+ * version. Think is very bad idea, because then 32-bit t1ha will
+ * still (relatively) very slowly and well yet not compatible. */
+ uint64_t l;
+ add64carry_last(add64carry_first(ll, lh << 32, &l), hh, lh >> 32, h);
+ add64carry_last(add64carry_first(l, hl << 32, &l), *h, hl >> 32, h);
+ return l;
+ #endif
+
+}
+
+#endif /* mul_64x64_128() */
+
+#ifndef mul_64x64_high
+static __maybe_unused __always_inline uint64_t mul_64x64_high(uint64_t a,
+ uint64_t b) {
+
+ uint64_t h;
+ mul_64x64_128(a, b, &h);
+ return h;
+
+}
+
+#endif /* mul_64x64_high */
+
+/***************************************************************************/
+
+/* 'magic' primes */
+static const uint64_t prime_0 = UINT64_C(0xEC99BF0D8372CAAB);
+static const uint64_t prime_1 = UINT64_C(0x82434FE90EDCEF39);
+static const uint64_t prime_2 = UINT64_C(0xD4F06DB99D67BE4B);
+static const uint64_t prime_3 = UINT64_C(0xBD9CACC22C6E9571);
+static const uint64_t prime_4 = UINT64_C(0x9C06FAF4D023E3AB);
+static const uint64_t prime_5 = UINT64_C(0xC060724A8424F345);
+static const uint64_t prime_6 = UINT64_C(0xCB5AF53AE3AAAC31);
+
+/* xor high and low parts of full 128-bit product */
+static __maybe_unused __always_inline uint64_t mux64(uint64_t v,
+ uint64_t prime) {
+
+ uint64_t l, h;
+ l = mul_64x64_128(v, prime, &h);
+ return l ^ h;
+
+}
+
+static __maybe_unused __always_inline uint64_t final64(uint64_t a, uint64_t b) {
+
+ uint64_t x = (a + rot64(b, 41)) * prime_0;
+ uint64_t y = (rot64(a, 23) + b) * prime_6;
+ return mux64(x ^ y, prime_5);
+
+}
+
+static __maybe_unused __always_inline void mixup64(uint64_t *__restrict a,
+ uint64_t *__restrict b,
+ uint64_t v, uint64_t prime) {
+
+ uint64_t h;
+ *a ^= mul_64x64_128(*b + v, prime, &h);
+ *b += h;
+
+}
+
+/***************************************************************************/
+
+typedef union t1ha_uint128 {
+
+#if defined(__SIZEOF_INT128__) || \
+ (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)
+ __uint128_t v;
+#endif
+ struct {
+
+#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
+ uint64_t l, h;
+#else
+ uint64_t h, l;
+#endif
+
+ };
+
+} t1ha_uint128_t;
+
+static __maybe_unused __always_inline t1ha_uint128_t
+not128(const t1ha_uint128_t v) {
+
+ t1ha_uint128_t r;
+#if defined(__SIZEOF_INT128__) || \
+ (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)
+ r.v = ~v.v;
+#else
+ r.l = ~v.l;
+ r.h = ~v.h;
+#endif
+ return r;
+
+}
+
+static __maybe_unused __always_inline t1ha_uint128_t
+left128(const t1ha_uint128_t v, unsigned s) {
+
+ t1ha_uint128_t r;
+ assert(s < 128);
+#if defined(__SIZEOF_INT128__) || \
+ (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)
+ r.v = v.v << s;
+#else
+ r.l = (s < 64) ? v.l << s : 0;
+ r.h = (s < 64) ? (v.h << s) | (s ? v.l >> (64 - s) : 0) : v.l << (s - 64);
+#endif
+ return r;
+
+}
+
+static __maybe_unused __always_inline t1ha_uint128_t
+right128(const t1ha_uint128_t v, unsigned s) {
+
+ t1ha_uint128_t r;
+ assert(s < 128);
+#if defined(__SIZEOF_INT128__) || \
+ (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)
+ r.v = v.v >> s;
+#else
+ r.l = (s < 64) ? (s ? v.h << (64 - s) : 0) | (v.l >> s) : v.h >> (s - 64);
+ r.h = (s < 64) ? v.h >> s : 0;
+#endif
+ return r;
+
+}
+
+static __maybe_unused __always_inline t1ha_uint128_t or128(t1ha_uint128_t x,
+ t1ha_uint128_t y) {
+
+ t1ha_uint128_t r;
+#if defined(__SIZEOF_INT128__) || \
+ (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)
+ r.v = x.v | y.v;
+#else
+ r.l = x.l | y.l;
+ r.h = x.h | y.h;
+#endif
+ return r;
+
+}
+
+static __maybe_unused __always_inline t1ha_uint128_t xor128(t1ha_uint128_t x,
+ t1ha_uint128_t y) {
+
+ t1ha_uint128_t r;
+#if defined(__SIZEOF_INT128__) || \
+ (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)
+ r.v = x.v ^ y.v;
+#else
+ r.l = x.l ^ y.l;
+ r.h = x.h ^ y.h;
+#endif
+ return r;
+
+}
+
+static __maybe_unused __always_inline t1ha_uint128_t rot128(t1ha_uint128_t v,
+ unsigned s) {
+
+ s &= 127;
+#if defined(__SIZEOF_INT128__) || \
+ (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)
+ v.v = (v.v << (128 - s)) | (v.v >> s);
+ return v;
+#else
+ return s ? or128(left128(v, 128 - s), right128(v, s)) : v;
+#endif
+
+}
+
+static __maybe_unused __always_inline t1ha_uint128_t add128(t1ha_uint128_t x,
+ t1ha_uint128_t y) {
+
+ t1ha_uint128_t r;
+#if defined(__SIZEOF_INT128__) || \
+ (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)
+ r.v = x.v + y.v;
+#else
+ add64carry_last(add64carry_first(x.l, y.l, &r.l), x.h, y.h, &r.h);
+#endif
+ return r;
+
+}
+
+static __maybe_unused __always_inline t1ha_uint128_t mul128(t1ha_uint128_t x,
+ t1ha_uint128_t y) {
+
+ t1ha_uint128_t r;
+#if defined(__SIZEOF_INT128__) || \
+ (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)
+ r.v = x.v * y.v;
+#else
+ r.l = mul_64x64_128(x.l, y.l, &r.h);
+ r.h += x.l * y.h + y.l * x.h;
+#endif
+ return r;
+
+}
+
+/***************************************************************************/
+
+#if T1HA0_AESNI_AVAILABLE && defined(__ia32__)
+uint64_t t1ha_ia32cpu_features(void);
+
+static __maybe_unused __always_inline bool t1ha_ia32_AESNI_avail(
+ uint64_t ia32cpu_features) {
+
+ /* check for AES-NI */
+ return (ia32cpu_features & UINT32_C(0x02000000)) != 0;
+
+}
+
+static __maybe_unused __always_inline bool t1ha_ia32_AVX_avail(
+ uint64_t ia32cpu_features) {
+
+ /* check for any AVX */
+ return (ia32cpu_features & UINT32_C(0x1A000000)) == UINT32_C(0x1A000000);
+
+}
+
+static __maybe_unused __always_inline bool t1ha_ia32_AVX2_avail(
+ uint64_t ia32cpu_features) {
+
+ /* check for 'Advanced Vector Extensions 2' */
+ return ((ia32cpu_features >> 32) & 32) != 0;
+
+}
+
+#endif /* T1HA0_AESNI_AVAILABLE && __ia32__ */
+
diff --git a/include/t1ha_selfcheck.h b/include/t1ha_selfcheck.h
new file mode 100644
index 00000000..65343bfe
--- /dev/null
+++ b/include/t1ha_selfcheck.h
@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2016-2020 Positive Technologies, https://www.ptsecurity.com,
+ * Fast Positive Hash.
+ *
+ * Portions Copyright (c) 2010-2020 Leonid Yuriev <leo@yuriev.ru>,
+ * The 1Hippeus project (t1h).
+ *
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ *
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ *
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgement in the product documentation would be
+ * appreciated but is not required.
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 3. This notice may not be removed or altered from any source distribution.
+ */
+
+/*
+ * t1ha = { Fast Positive Hash, aka "Позитивный Хэш" }
+ * by [Positive Technologies](https://www.ptsecurity.ru)
+ *
+ * Briefly, it is a 64-bit Hash Function:
+ * 1. Created for 64-bit little-endian platforms, in predominantly for x86_64,
+ * but portable and without penalties it can run on any 64-bit CPU.
+ * 2. In most cases up to 15% faster than City64, xxHash, mum-hash, metro-hash
+ * and all others portable hash-functions (which do not use specific
+ * hardware tricks).
+ * 3. Not suitable for cryptography.
+ *
+ * The Future will (be) Positive. Всё будет хорошо.
+ *
+ * ACKNOWLEDGEMENT:
+ * The t1ha was originally developed by Leonid Yuriev (Леонид Юрьев)
+ * for The 1Hippeus project - zerocopy messaging in the spirit of Sparta!
+ */
+
+#pragma once
+#if defined(_MSC_VER) && _MSC_VER > 1800
+ #pragma warning(disable : 4464) /* relative include path contains '..' */
+#endif /* MSVC */
+#include "t1ha.h"
+
+/***************************************************************************/
+/* Self-checking */
+
+extern const uint8_t t1ha_test_pattern[64];
+int t1ha_selfcheck(uint64_t (*hash)(const void *, size_t, uint64_t),
+ const uint64_t *reference_values);
+
+#ifndef T1HA2_DISABLED
+extern const uint64_t t1ha_refval_2atonce[81];
+extern const uint64_t t1ha_refval_2atonce128[81];
+extern const uint64_t t1ha_refval_2stream[81];
+extern const uint64_t t1ha_refval_2stream128[81];
+#endif /* T1HA2_DISABLED */
+
+#ifndef T1HA1_DISABLED
+extern const uint64_t t1ha_refval_64le[81];
+extern const uint64_t t1ha_refval_64be[81];
+#endif /* T1HA1_DISABLED */
+
+#ifndef T1HA0_DISABLED
+extern const uint64_t t1ha_refval_32le[81];
+extern const uint64_t t1ha_refval_32be[81];
+ #if T1HA0_AESNI_AVAILABLE
+extern const uint64_t t1ha_refval_ia32aes_a[81];
+extern const uint64_t t1ha_refval_ia32aes_b[81];
+ #endif /* T1HA0_AESNI_AVAILABLE */
+#endif /* T1HA0_DISABLED */
+
diff --git a/include/types.h b/include/types.h
index 22332135..18c5df91 100644
--- a/include/types.h
+++ b/include/types.h
@@ -49,6 +49,14 @@ typedef uint128_t u128;
#define FS_ERROR_OLD_CMPLOG 32
#define FS_ERROR_OLD_CMPLOG_QEMU 64
+/* New Forkserver */
+#define FS_NEW_VERSION_MIN 1
+#define FS_NEW_VERSION_MAX 1
+#define FS_NEW_ERROR 0xeffe0000
+#define FS_NEW_OPT_MAPSIZE 0x00000001 // parameter: 32 bit value
+#define FS_NEW_OPT_SHDMEM_FUZZ 0x00000002 // parameter: none
+#define FS_NEW_OPT_AUTODICT 0x00000800 // autodictionary data
+
/* Reporting options */
#define FS_OPT_ENABLED 0x80000001
#define FS_OPT_MAPSIZE 0x40000000
diff --git a/include/xxhash.h b/include/xxhash.h
index 9a880470..991a8f1e 100644
--- a/include/xxhash.h
+++ b/include/xxhash.h
@@ -1,7 +1,7 @@
/*
* xxHash - Extremely Fast Hash algorithm
* Header File
- * Copyright (C) 2012-2024 Yann Collet
+ * Copyright (C) 2012-2023 Yann Collet
*
* BSD 2-Clause License (https://www.opensource.org/licenses/bsd-license.php)
*
@@ -32,50 +32,226 @@
* - xxHash homepage: https://www.xxhash.com
* - xxHash source repository: https://github.com/Cyan4973/xxHash
*/
+
/*!
* @mainpage xxHash
*
+ * xxHash is an extremely fast non-cryptographic hash algorithm, working at RAM
+ * speed limits.
+ *
+ * It is proposed in four flavors, in three families:
+ * 1. @ref XXH32_family
+ * - Classic 32-bit hash function. Simple, compact, and runs on almost all
+ * 32-bit and 64-bit systems.
+ * 2. @ref XXH64_family
+ * - Classic 64-bit adaptation of XXH32. Just as simple, and runs well on most
+ * 64-bit systems (but _not_ 32-bit systems).
+ * 3. @ref XXH3_family
+ * - Modern 64-bit and 128-bit hash function family which features improved
+ * strength and performance across the board, especially on smaller data.
+ * It benefits greatly from SIMD and 64-bit without requiring it.
+ *
+ * Benchmarks
+ * ---
+ * The reference system uses an Intel i7-9700K CPU, and runs Ubuntu x64 20.04.
+ * The open source benchmark program is compiled with clang v10.0 using -O3
+ * flag.
+ *
+ * | Hash Name | ISA ext | Width | Large Data Speed | Small Data
+ * Velocity | | -------------------- | ------- | ----: | ---------------: |
+ * ------------------: | | XXH3_64bits() | @b AVX2 | 64 | 59.4
+ * GB/s | 133.1 | | MeowHash | AES-NI | 128 | 58.2
+ * GB/s | 52.5 | | XXH3_128bits() | @b AVX2 | 128 | 57.9
+ * GB/s | 118.1 | | CLHash | PCLMUL | 64 | 37.1
+ * GB/s | 58.1 | | XXH3_64bits() | @b SSE2 | 64 | 31.5
+ * GB/s | 133.1 | | XXH3_128bits() | @b SSE2 | 128 | 29.6
+ * GB/s | 118.1 | | RAM sequential read | | N/A | 28.0
+ * GB/s | N/A | | ahash | AES-NI | 64 | 22.5
+ * GB/s | 107.2 | | City64 | | 64 | 22.0
+ * GB/s | 76.6 | | T1ha2 | | 64 | 22.0
+ * GB/s | 99.0 | | City128 | | 128 | 21.7
+ * GB/s | 57.7 | | FarmHash | AES-NI | 64 | 21.3
+ * GB/s | 71.9 | | XXH64() | | 64 | 19.4
+ * GB/s | 71.0 | | SpookyHash | | 64 | 19.3
+ * GB/s | 53.2 | | Mum | | 64 | 18.0
+ * GB/s | 67.0 | | CRC32C | SSE4.2 | 32 | 13.0
+ * GB/s | 57.9 | | XXH32() | | 32 | 9.7
+ * GB/s | 71.9 | | City32 | | 32 | 9.1
+ * GB/s | 66.0 | | Blake3* | @b AVX2 | 256 | 4.4
+ * GB/s | 8.1 | | Murmur3 | | 32 | 3.9
+ * GB/s | 56.1 | | SipHash* | | 64 | 3.0
+ * GB/s | 43.2 | | Blake3* | @b SSE2 | 256 | 2.4
+ * GB/s | 8.1 | | HighwayHash | | 64 | 1.4
+ * GB/s | 6.0 | | FNV64 | | 64 | 1.2
+ * GB/s | 62.7 | | Blake2* | | 256 | 1.1
+ * GB/s | 5.1 | | SHA1* | | 160 | 0.8
+ * GB/s | 5.6 | | MD5* | | 128 | 0.6
+ * GB/s | 7.8 |
+ * @note
+ * - Hashes which require a specific ISA extension are noted. SSE2 is also
+ * noted, even though it is mandatory on x64.
+ * - Hashes with an asterisk are cryptographic. Note that MD5 is
+ * non-cryptographic by modern standards.
+ * - Small data velocity is a rough average of algorithm's efficiency for
+ * small data. For more accurate information, see the wiki.
+ * - More benchmarks and strength tests are found on the wiki:
+ * https://github.com/Cyan4973/xxHash/wiki
+ *
+ * Usage
+ * ------
+ * All xxHash variants use a similar API. Changing the algorithm is a trivial
+ * substitution.
+ *
+ * @pre
+ * For functions which take an input and length parameter, the following
+ * requirements are assumed:
+ * - The range from [`input`, `input + length`) is valid, readable memory.
+ * - The only exception is if the `length` is `0`, `input` may be `NULL`.
+ * - For C++, the objects must have the *TriviallyCopyable* property, as the
+ * functions access bytes directly as if it was an array of `unsigned
+ * char`.
+ *
+ * @anchor single_shot_example
+ * **Single Shot**
+ *
+ * These functions are stateless functions which hash a contiguous block of
+ * memory, immediately returning the result. They are the easiest and usually
+ * the fastest option.
+ *
+ * XXH32(), XXH64(), XXH3_64bits(), XXH3_128bits()
+ *
+ * @code{.c}
+ * #include <string.h>
+ * #include "xxhash.h"
+ *
+ * // Example for a function which hashes a null terminated string with
+ * XXH32(). XXH32_hash_t hash_string(const char* string, XXH32_hash_t seed)
+ * {
+
+ * // NULL pointers are only valid if the length is zero
+ * size_t length = (string == NULL) ? 0 : strlen(string);
+ * return XXH32(string, length, seed);
+ * }
+ * @endcode
+ *
+ *
+ * @anchor streaming_example
+ * **Streaming**
+ *
+ * These groups of functions allow incremental hashing of unknown size, even
+ * more than what would fit in a size_t.
+ *
+ * XXH32_reset(), XXH64_reset(), XXH3_64bits_reset(), XXH3_128bits_reset()
+ *
+ * @code{.c}
+ * #include <stdio.h>
+ * #include <assert.h>
+ * #include "xxhash.h"
+ * // Example for a function which hashes a FILE incrementally with
+ * XXH3_64bits(). XXH64_hash_t hashFile(FILE* f)
+ * {
+
+ * // Allocate a state struct. Do not just use malloc() or new.
+ * XXH3_state_t* state = XXH3_createState();
+ * assert(state != NULL && "Out of memory!");
+ * // Reset the state to start a new hashing session.
+ * XXH3_64bits_reset(state);
+ * char buffer[4096];
+ * size_t count;
+ * // Read the file in chunks
+ * while ((count = fread(buffer, 1, sizeof(buffer), f)) != 0) {
+
+ * // Run update() as many times as necessary to process the data
+ * XXH3_64bits_update(state, buffer, count);
+ * }
+ * // Retrieve the finalized hash. This will not change the state.
+ * XXH64_hash_t result = XXH3_64bits_digest(state);
+ * // Free the state. Do not use free().
+ * XXH3_freeState(state);
+ * return result;
+ * }
+ * @endcode
+ *
+ * Streaming functions generate the xxHash value from an incremental input.
+ * This method is slower than single-call functions, due to state management.
+ * For small inputs, prefer `XXH32()` and `XXH64()`, which are better optimized.
+ *
+ * An XXH state must first be allocated using `XXH*_createState()`.
+ *
+ * Start a new hash by initializing the state with a seed using `XXH*_reset()`.
+ *
+ * Then, feed the hash state by calling `XXH*_update()` as many times as
+ * necessary.
+ *
+ * The function returns an error code, with 0 meaning OK, and any other value
+ * meaning there is an error.
+ *
+ * Finally, a hash value can be produced anytime, by using `XXH*_digest()`.
+ * This function returns the nn-bits hash as an int or long long.
+ *
+ * It's still possible to continue inserting input into the hash state after a
+ * digest, and generate new hash values later on by invoking `XXH*_digest()`.
+ *
+ * When done, release the state using `XXH*_freeState()`.
+ *
+ *
+ * @anchor canonical_representation_example
+ * **Canonical Representation**
+ *
+ * The default return values from XXH functions are unsigned 32, 64 and 128 bit
+ * integers.
+ * This the simplest and fastest format for further post-processing.
+ *
+ * However, this leaves open the question of what is the order on the byte
+ * level, since little and big endian conventions will store the same number
+ * differently.
+ *
+ * The canonical representation settles this issue by mandating big-endian
+ * convention, the same convention as human-readable numbers (large digits
+ * first).
+ *
+ * When writing hash values to storage, sending them over a network, or printing
+ * them, it's highly recommended to use the canonical representation to ensure
+ * portability across a wider range of systems, present and future.
+ *
+ * The following functions allow transformation of hash values to and from
+ * canonical format.
+ *
+ * XXH32_canonicalFromHash(), XXH32_hashFromCanonical(),
+ * XXH64_canonicalFromHash(), XXH64_hashFromCanonical(),
+ * XXH128_canonicalFromHash(), XXH128_hashFromCanonical(),
+ *
+ * @code{.c}
+ * #include <stdio.h>
+ * #include "xxhash.h"
+ *
+ * // Example for a function which prints XXH32_hash_t in human readable
+ * format void printXxh32(XXH32_hash_t hash)
+ * {
+
+ * XXH32_canonical_t cano;
+ * XXH32_canonicalFromHash(&cano, hash);
+ * size_t i;
+ * for(i = 0; i < sizeof(cano.digest); ++i) {
+
+ * printf("%02x", cano.digest[i]);
+ * }
+ * printf("\n");
+ * }
+ *
+ * // Example for a function which converts XXH32_canonical_t to XXH32_hash_t
+ * XXH32_hash_t convertCanonicalToXxh32(XXH32_canonical_t cano)
+ * {
+
+ * XXH32_hash_t hash = XXH32_hashFromCanonical(&cano);
+ * return hash;
+ * }
+ * @endcode
+ *
+ *
* @file xxhash.h
* xxHash prototypes and implementation
*/
-/* TODO: update */
-/* Notice extracted from xxHash homepage:
-
-xxHash is an extremely fast hash algorithm, running at RAM speed limits.
-It also successfully passes all tests from the SMHasher suite.
-
-Comparison (single thread, Windows Seven 32 bits, using SMHasher on a Core 2 Duo
-@3GHz)
-
-Name Speed Q.Score Author
-xxHash 5.4 GB/s 10
-CrapWow 3.2 GB/s 2 Andrew
-MurmurHash 3a 2.7 GB/s 10 Austin Appleby
-SpookyHash 2.0 GB/s 10 Bob Jenkins
-SBox 1.4 GB/s 9 Bret Mulvey
-Lookup3 1.2 GB/s 9 Bob Jenkins
-SuperFastHash 1.2 GB/s 1 Paul Hsieh
-CityHash64 1.05 GB/s 10 Pike & Alakuijala
-FNV 0.55 GB/s 5 Fowler, Noll, Vo
-CRC32 0.43 GB/s 9
-MD5-32 0.33 GB/s 10 Ronald L. Rivest
-SHA1-32 0.28 GB/s 10
-
-Q.Score is a measure of quality of the hash function.
-It depends on successfully passing SMHasher test set.
-10 is a perfect score.
-
-Note: SMHasher's CRC32 implementation is not the fastest one.
-Other speed-oriented implementations can be faster,
-especially in combination with PCLMUL instruction:
-https://fastcompression.blogspot.com/2019/03/presenting-xxh3.html?showComment=1552696407071#c3490092340461170735
-
-A 64-bit version, named XXH64, is available since r35.
-It offers much better speed, but for 64-bit applications only.
-Name Speed on 64 bits Speed on 32 bits
-XXH64 13.8 GB/s 1.9 GB/s
-XXH32 6.8 GB/s 6.0 GB/s
-*/
#if defined(__cplusplus)
extern "C" {
@@ -86,21 +262,82 @@ extern "C" {
* INLINE mode
******************************/
/*!
- * XXH_INLINE_ALL (and XXH_PRIVATE_API)
- * Use these build macros to inline xxhash into the target unit.
- * Inlining improves performance on small inputs, especially when the length is
- * expressed as a compile-time constant:
- *
- * https://fastcompression.blogspot.com/2018/03/xxhash-for-small-keys-impressive-power.html
- *
- * It also keeps xxHash symbols private to the unit, so they are not exported.
- *
- * Usage:
- * #define XXH_INLINE_ALL
- * #include "xxhash.h"
- *
- * Do not compile and link xxhash.o as a separate object, as it is not useful.
+ * @defgroup public Public API
+ * Contains details on the public xxHash functions.
+ * @{
+
*/
+#ifdef XXH_DOXYGEN
+ /*!
+ * @brief Gives access to internal state declaration, required for static
+ * allocation.
+ *
+ * Incompatible with dynamic linking, due to risks of ABI changes.
+ *
+ * Usage:
+ * @code{.c}
+ * #define XXH_STATIC_LINKING_ONLY
+ * #include "xxhash.h"
+ * @endcode
+ */
+ #define XXH_STATIC_LINKING_ONLY
+ /* Do not undef XXH_STATIC_LINKING_ONLY for Doxygen */
+
+ /*!
+ * @brief Gives access to internal definitions.
+ *
+ * Usage:
+ * @code{.c}
+ * #define XXH_STATIC_LINKING_ONLY
+ * #define XXH_IMPLEMENTATION
+ * #include "xxhash.h"
+ * @endcode
+ */
+ #define XXH_IMPLEMENTATION
+ /* Do not undef XXH_IMPLEMENTATION for Doxygen */
+
+ /*!
+ * @brief Exposes the implementation and marks all functions as `inline`.
+ *
+ * Use these build macros to inline xxhash into the target unit.
+ * Inlining improves performance on small inputs, especially when the length
+ * is expressed as a compile-time constant:
+ *
+ * https://fastcompression.blogspot.com/2018/03/xxhash-for-small-keys-impressive-power.html
+ *
+ * It also keeps xxHash symbols private to the unit, so they are not exported.
+ *
+ * Usage:
+ * @code{.c}
+ * #define XXH_INLINE_ALL
+ * #include "xxhash.h"
+ * @endcode
+ * Do not compile and link xxhash.o as a separate object, as it is not useful.
+ */
+ #define XXH_INLINE_ALL
+ #undef XXH_INLINE_ALL
+ /*!
+ * @brief Exposes the implementation without marking functions as inline.
+ */
+ #define XXH_PRIVATE_API
+ #undef XXH_PRIVATE_API
+ /*!
+ * @brief Emulate a namespace by transparently prefixing all symbols.
+ *
+ * If you want to include _and expose_ xxHash functions from within your own
+ * library, but also want to avoid symbol collisions with other libraries
+ * which may also include xxHash, you can use @ref XXH_NAMESPACE to
+ * automatically prefix any public symbol from xxhash library with the value
+ * of @ref XXH_NAMESPACE (therefore, avoid empty or numeric values).
+ *
+ * Note that no change is required within the calling program as long as it
+ * includes `xxhash.h`: Regular symbol names will be automatically translated
+ * by this header.
+ */
+ #define XXH_NAMESPACE /* YOUR NAME HERE */
+ #undef XXH_NAMESPACE
+#endif
+
#if (defined(XXH_INLINE_ALL) || defined(XXH_PRIVATE_API)) && \
!defined(XXH_INLINE_ALL_31684351384)
/* this section should be traversed only once */
@@ -160,6 +397,7 @@ extern "C" {
#undef XXH3_64bits
#undef XXH3_64bits_withSecret
#undef XXH3_64bits_withSeed
+ #undef XXH3_64bits_withSecretandSeed
#undef XXH3_createState
#undef XXH3_freeState
#undef XXH3_copyState
@@ -177,6 +415,7 @@ extern "C" {
#undef XXH3_128bits_reset
#undef XXH3_128bits_reset_withSeed
#undef XXH3_128bits_reset_withSecret
+ #undef XXH3_128bits_reset_withSecretandSeed
#undef XXH3_128bits_update
#undef XXH3_128bits_digest
#undef XXH128_isEqual
@@ -220,13 +459,7 @@ extern "C" {
#ifndef XXHASH_H_5627135585666179
#define XXHASH_H_5627135585666179 1
- /*!
- * @defgroup public Public API
- * Contains details on the public xxHash functions.
- * @{
-
- */
- /* specific declaration modes for Windows */
+ /*! @brief Marks a global symbol. */
#if !defined(XXH_INLINE_ALL) && !defined(XXH_PRIVATE_API)
#if defined(WIN32) && defined(_MSC_VER) && \
(defined(XXH_IMPORT) || defined(XXH_EXPORT))
@@ -240,24 +473,6 @@ extern "C" {
#endif
#endif
- #ifdef XXH_DOXYGEN
- /*!
- * @brief Emulate a namespace by transparently prefixing all symbols.
- *
- * If you want to include _and expose_ xxHash functions from within your own
- * library, but also want to avoid symbol collisions with other libraries
- * which may also include xxHash, you can use XXH_NAMESPACE to automatically
- * prefix any public symbol from xxhash library with the value of
- * XXH_NAMESPACE (therefore, avoid empty or numeric values).
- *
- * Note that no change is required within the calling program as long as it
- * includes `xxhash.h`: Regular symbol names will be automatically
- * translated by this header.
- */
- #define XXH_NAMESPACE /* YOUR NAME HERE */
- #undef XXH_NAMESPACE
- #endif
-
#ifdef XXH_NAMESPACE
#define XXH_CAT(A, B) A##B
#define XXH_NAME2(A, B) XXH_CAT(A, B)
@@ -291,6 +506,8 @@ extern "C" {
#define XXH3_64bits_withSecret \
XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSecret)
#define XXH3_64bits_withSeed XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSeed)
+ #define XXH3_64bits_withSecretandSeed \
+ XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSecretandSeed)
#define XXH3_createState XXH_NAME2(XXH_NAMESPACE, XXH3_createState)
#define XXH3_freeState XXH_NAME2(XXH_NAMESPACE, XXH3_freeState)
#define XXH3_copyState XXH_NAME2(XXH_NAMESPACE, XXH3_copyState)
@@ -299,9 +516,13 @@ extern "C" {
XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSeed)
#define XXH3_64bits_reset_withSecret \
XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSecret)
+ #define XXH3_64bits_reset_withSecretandSeed \
+ XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSecretandSeed)
#define XXH3_64bits_update XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_update)
#define XXH3_64bits_digest XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_digest)
#define XXH3_generateSecret XXH_NAME2(XXH_NAMESPACE, XXH3_generateSecret)
+ #define XXH3_generateSecret_fromSeed \
+ XXH_NAME2(XXH_NAMESPACE, XXH3_generateSecret_fromSeed)
/* XXH3_128bits */
#define XXH128 XXH_NAME2(XXH_NAMESPACE, XXH128)
#define XXH3_128bits XXH_NAME2(XXH_NAMESPACE, XXH3_128bits)
@@ -309,11 +530,15 @@ extern "C" {
XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSeed)
#define XXH3_128bits_withSecret \
XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSecret)
+ #define XXH3_128bits_withSecretandSeed \
+ XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSecretandSeed)
#define XXH3_128bits_reset XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset)
#define XXH3_128bits_reset_withSeed \
XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSeed)
#define XXH3_128bits_reset_withSecret \
XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSecret)
+ #define XXH3_128bits_reset_withSecretandSeed \
+ XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSecretandSeed)
#define XXH3_128bits_update XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_update)
#define XXH3_128bits_digest XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_digest)
#define XXH128_isEqual XXH_NAME2(XXH_NAMESPACE, XXH128_isEqual)
@@ -325,11 +550,40 @@ extern "C" {
#endif
/* *************************************
+ * Compiler specifics
+ ***************************************/
+
+ /* specific declaration modes for Windows */
+ #if !defined(XXH_INLINE_ALL) && !defined(XXH_PRIVATE_API)
+ #if defined(WIN32) && defined(_MSC_VER) && \
+ (defined(XXH_IMPORT) || defined(XXH_EXPORT))
+ #ifdef XXH_EXPORT
+ #define XXH_PUBLIC_API __declspec(dllexport)
+ #elif XXH_IMPORT
+ #define XXH_PUBLIC_API __declspec(dllimport)
+ #endif
+ #else
+ #define XXH_PUBLIC_API /* do nothing */
+ #endif
+ #endif
+
+ #if defined(__GNUC__)
+ #define XXH_CONSTF __attribute__((const))
+ #define XXH_PUREF __attribute__((pure))
+ #define XXH_MALLOCF __attribute__((malloc))
+ #else
+ #define XXH_CONSTF /* disable */
+ #define XXH_PUREF
+ #define XXH_MALLOCF
+ #endif
+
+ /* *************************************
* Version
***************************************/
#define XXH_VERSION_MAJOR 0
#define XXH_VERSION_MINOR 8
- #define XXH_VERSION_RELEASE 1
+ #define XXH_VERSION_RELEASE 2
+ /*! @brief Version number, encoded as two digits each */
#define XXH_VERSION_NUMBER \
(XXH_VERSION_MAJOR * 100 * 100 + XXH_VERSION_MINOR * 100 + \
XXH_VERSION_RELEASE)
@@ -337,18 +591,26 @@ extern "C" {
/*!
* @brief Obtains the xxHash version.
*
- * This is only useful when xxHash is compiled as a shared library, as it is
- * independent of the version defined in the header.
+ * This is mostly useful when xxHash is compiled as a shared library,
+ * since the returned value comes from the library, as opposed to header file.
*
- * @return `XXH_VERSION_NUMBER` as of when the libray was compiled.
+ * @return @ref XXH_VERSION_NUMBER of the invoked library.
*/
-XXH_PUBLIC_API unsigned XXH_versionNumber(void);
+XXH_PUBLIC_API XXH_CONSTF unsigned XXH_versionNumber(void);
/* ****************************
- * Definitions
+ * Common basic types
******************************/
#include <stddef.h> /* size_t */
-typedef enum { XXH_OK = 0, XXH_ERROR } XXH_errorcode;
+/*!
+ * @brief Exit code for the streaming API.
+ */
+typedef enum {
+
+ XXH_OK = 0, /*!< OK */
+ XXH_ERROR /*!< Error */
+
+} XXH_errorcode;
/*-**********************************************************************
* 32-bit hash
@@ -371,30 +633,27 @@ typedef uint32_t XXH32_hash_t;
#include <limits.h>
#if UINT_MAX == 0xFFFFFFFFUL
typedef unsigned int XXH32_hash_t;
- #else
- #if ULONG_MAX == 0xFFFFFFFFUL
+ #elif ULONG_MAX == 0xFFFFFFFFUL
typedef unsigned long XXH32_hash_t;
- #else
- #error "unsupported platform: need a 32-bit type"
- #endif
+ #else
+ #error "unsupported platform: need a 32-bit type"
#endif
#endif
/*!
* @}
*
- * @defgroup xxh32_family XXH32 family
+ * @defgroup XXH32_family XXH32 family
* @ingroup public
* Contains functions used in the classic 32-bit xxHash algorithm.
*
* @note
- * XXH32 is considered rather weak by today's standards.
- * The @ref xxh3_family provides competitive speed for both 32-bit and 64-bit
- * systems, and offers true 64/128 bit hash results. It provides a superior
- * level of dispersion, and greatly reduces the risks of collisions.
+ * XXH32 is useful for older platforms, with no or poor 64-bit performance.
+ * Note that the @ref XXH3_family provides competitive speed for both 32-bit
+ * and 64-bit systems, and offers true 64/128 bit hash results.
*
- * @see @ref xxh64_family, @ref xxh3_family : Other xxHash families
- * @see @ref xxh32_impl for implementation details
+ * @see @ref XXH64_family, @ref XXH3_family : Other xxHash families
+ * @see @ref XXH32_impl for implementation details
* @{
*/
@@ -402,8 +661,6 @@ typedef unsigned long XXH32_hash_t;
/*!
* @brief Calculates the 32-bit hash of @p input using xxHash32.
*
- * Speed on Core 2 Duo @ 3 GHz (single thread, SMHasher benchmark): 5.4 GB/s
- *
* @param input The block of data to be hashed, at least @p length bytes in
* size.
* @param length The length of @p input, in bytes.
@@ -414,92 +671,46 @@ typedef unsigned long XXH32_hash_t;
* readable, contiguous memory. However, if @p length is `0`, @p input may be
* `NULL`. In C++, this also must be *TriviallyCopyable*.
*
- * @return The calculated 32-bit hash value.
- *
- * @see
- * XXH64(), XXH3_64bits_withSeed(), XXH3_128bits_withSeed(), XXH128():
- * Direct equivalents for the other variants of xxHash.
- * @see
- * XXH32_createState(), XXH32_update(), XXH32_digest(): Streaming version.
- */
-XXH_PUBLIC_API XXH32_hash_t XXH32(const void *input, size_t length,
- XXH32_hash_t seed);
-
-/*!
- * Streaming functions generate the xxHash value from an incremental input.
- * This method is slower than single-call functions, due to state management.
- * For small inputs, prefer `XXH32()` and `XXH64()`, which are better optimized.
- *
- * An XXH state must first be allocated using `XXH*_createState()`.
- *
- * Start a new hash by initializing the state with a seed using `XXH*_reset()`.
- *
- * Then, feed the hash state by calling `XXH*_update()` as many times as
- * necessary.
- *
- * The function returns an error code, with 0 meaning OK, and any other value
- * meaning there is an error.
- *
- * Finally, a hash value can be produced anytime, by using `XXH*_digest()`.
- * This function returns the nn-bits hash as an int or long long.
- *
- * It's still possible to continue inserting input into the hash state after a
- * digest, and generate new hash values later on by invoking `XXH*_digest()`.
- *
- * When done, release the state using `XXH*_freeState()`.
- *
- * Example code for incrementally hashing a file:
- * @code{.c}
- * #include <stdio.h>
- * #include <xxhash.h>
- * #define BUFFER_SIZE 256
- *
- * // Note: XXH64 and XXH3 use the same interface.
- * XXH32_hash_t
- * hashFile(FILE* stream)
- * {
-
- * XXH32_state_t* state;
- * unsigned char buf[BUFFER_SIZE];
- * size_t amt;
- * XXH32_hash_t hash;
+ * @return The calculated 32-bit xxHash32 value.
*
- * state = XXH32_createState(); // Create a state
- * assert(state != NULL); // Error check here
- * XXH32_reset(state, 0xbaad5eed); // Reset state with our seed
- * while ((amt = fread(buf, 1, sizeof(buf), stream)) != 0) {
-
- * XXH32_update(state, buf, amt); // Hash the file in chunks
- * }
- * hash = XXH32_digest(state); // Finalize the hash
- * XXH32_freeState(state); // Clean up
- * return hash;
- * }
- * @endcode
+ * @see @ref single_shot_example "Single Shot Example" for an example.
*/
+XXH_PUBLIC_API XXH_PUREF XXH32_hash_t XXH32(const void *input, size_t length,
+ XXH32_hash_t seed);
+ #ifndef XXH_NO_STREAM
/*!
* @typedef struct XXH32_state_s XXH32_state_t
* @brief The opaque state struct for the XXH32 streaming API.
*
* @see XXH32_state_s for details.
+ * @see @ref streaming_example "Streaming Example"
*/
typedef struct XXH32_state_s XXH32_state_t;
/*!
* @brief Allocates an @ref XXH32_state_t.
*
- * Must be freed with XXH32_freeState().
- * @return An allocated XXH32_state_t on success, `NULL` on failure.
+ * @return An allocated pointer of @ref XXH32_state_t on success.
+ * @return `NULL` on failure.
+ *
+ * @note Must be freed with XXH32_freeState().
+ *
+ * @see @ref streaming_example "Streaming Example"
*/
-XXH_PUBLIC_API XXH32_state_t *XXH32_createState(void);
+XXH_PUBLIC_API XXH_MALLOCF XXH32_state_t *XXH32_createState(void);
/*!
* @brief Frees an @ref XXH32_state_t.
*
- * Must be allocated with XXH32_createState().
* @param statePtr A pointer to an @ref XXH32_state_t allocated with @ref
* XXH32_createState().
- * @return XXH_OK.
+ *
+ * @return @ref XXH_OK.
+ *
+ * @note @p statePtr must be allocated with XXH32_createState().
+ *
+ * @see @ref streaming_example "Streaming Example"
+ *
*/
XXH_PUBLIC_API XXH_errorcode XXH32_freeState(XXH32_state_t *statePtr);
/*!
@@ -516,15 +727,19 @@ XXH_PUBLIC_API void XXH32_copyState(XXH32_state_t *dst_state,
/*!
* @brief Resets an @ref XXH32_state_t to begin a new hash.
*
- * This function resets and seeds a state. Call it before @ref XXH32_update().
- *
* @param statePtr The state struct to reset.
* @param seed The 32-bit seed to alter the hash result predictably.
*
* @pre
* @p statePtr must not be `NULL`.
*
- * @return @ref XXH_OK on success, @ref XXH_ERROR on failure.
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note This function resets and seeds a state. Call it before @ref
+ * XXH32_update().
+ *
+ * @see @ref streaming_example "Streaming Example"
*/
XXH_PUBLIC_API XXH_errorcode XXH32_reset(XXH32_state_t *statePtr,
XXH32_hash_t seed);
@@ -532,8 +747,6 @@ XXH_PUBLIC_API XXH_errorcode XXH32_reset(XXH32_state_t *statePtr,
/*!
* @brief Consumes a block of @p input to an @ref XXH32_state_t.
*
- * Call this to incrementally consume blocks of data.
- *
* @param statePtr The state struct to update.
* @param input The block of data to be hashed, at least @p length bytes in
* size.
@@ -546,7 +759,12 @@ XXH_PUBLIC_API XXH_errorcode XXH32_reset(XXH32_state_t *statePtr,
* readable, contiguous memory. However, if @p length is `0`, @p input may be
* `NULL`. In C++, this also must be *TriviallyCopyable*.
*
- * @return @ref XXH_OK on success, @ref XXH_ERROR on failure.
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note Call this to incrementally consume blocks of data.
+ *
+ * @see @ref streaming_example "Streaming Example"
*/
XXH_PUBLIC_API XXH_errorcode XXH32_update(XXH32_state_t *statePtr,
const void *input, size_t length);
@@ -554,41 +772,24 @@ XXH_PUBLIC_API XXH_errorcode XXH32_update(XXH32_state_t *statePtr,
/*!
* @brief Returns the calculated hash value from an @ref XXH32_state_t.
*
- * @note
- * Calling XXH32_digest() will not affect @p statePtr, so you can update,
- * digest, and update again.
- *
* @param statePtr The state struct to calculate the hash from.
*
* @pre
* @p statePtr must not be `NULL`.
*
- * @return The calculated xxHash32 value from that state.
- */
-XXH_PUBLIC_API XXH32_hash_t XXH32_digest(const XXH32_state_t *statePtr);
-
-/******* Canonical representation *******/
-
-/*
- * The default return values from XXH functions are unsigned 32 and 64 bit
- * integers.
- * This the simplest and fastest format for further post-processing.
+ * @return The calculated 32-bit xxHash32 value from that state.
*
- * However, this leaves open the question of what is the order on the byte
- * level, since little and big endian conventions will store the same number
- * differently.
- *
- * The canonical representation settles this issue by mandating big-endian
- * convention, the same convention as human-readable numbers (large digits
- * first).
- *
- * When writing hash values to storage, sending them over a network, or printing
- * them, it's highly recommended to use the canonical representation to ensure
- * portability across a wider range of systems, present and future.
+ * @note
+ * Calling XXH32_digest() will not affect @p statePtr, so you can update,
+ * digest, and update again.
*
- * The following functions allow transformation of hash values to and from
- * canonical format.
+ * @see @ref streaming_example "Streaming Example"
*/
+XXH_PUBLIC_API XXH_PUREF XXH32_hash_t
+XXH32_digest(const XXH32_state_t *statePtr);
+ #endif /* !XXH_NO_STREAM */
+
+/******* Canonical representation *******/
/*!
* @brief Canonical (big endian) representation of @ref XXH32_hash_t.
@@ -602,11 +803,13 @@ typedef struct {
/*!
* @brief Converts an @ref XXH32_hash_t to a big endian @ref XXH32_canonical_t.
*
- * @param dst The @ref XXH32_canonical_t pointer to be stored to.
+ * @param dst The @ref XXH32_canonical_t pointer to be stored to.
* @param hash The @ref XXH32_hash_t to be converted.
*
* @pre
* @p dst must not be `NULL`.
+ *
+ * @see @ref canonical_representation_example "Canonical Representation Example"
*/
XXH_PUBLIC_API void XXH32_canonicalFromHash(XXH32_canonical_t *dst,
XXH32_hash_t hash);
@@ -620,45 +823,75 @@ XXH_PUBLIC_API void XXH32_canonicalFromHash(XXH32_canonical_t *dst,
* @p src must not be `NULL`.
*
* @return The converted hash.
+ *
+ * @see @ref canonical_representation_example "Canonical Representation Example"
*/
-XXH_PUBLIC_API XXH32_hash_t
+XXH_PUBLIC_API XXH_PUREF XXH32_hash_t
XXH32_hashFromCanonical(const XXH32_canonical_t *src);
+ /*! @cond Doxygen ignores this part */
#ifdef __has_attribute
#define XXH_HAS_ATTRIBUTE(x) __has_attribute(x)
#else
#define XXH_HAS_ATTRIBUTE(x) 0
#endif
+ /*! @endcond */
+
+ /*! @cond Doxygen ignores this part */
+ /*
+ * C23 __STDC_VERSION__ number hasn't been specified yet. For now
+ * leave as `201711L` (C17 + 1).
+ * TODO: Update to correct value when its been specified.
+ */
+ #define XXH_C23_VN 201711L
+ /*! @endcond */
+ /*! @cond Doxygen ignores this part */
/* C-language Attributes are added in C23. */
- #if defined(__STDC_VERSION__) && (__STDC_VERSION__ > 201710L) && \
+ #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= XXH_C23_VN) && \
defined(__has_c_attribute)
#define XXH_HAS_C_ATTRIBUTE(x) __has_c_attribute(x)
#else
#define XXH_HAS_C_ATTRIBUTE(x) 0
#endif
+ /*! @endcond */
+ /*! @cond Doxygen ignores this part */
#if defined(__cplusplus) && defined(__has_cpp_attribute)
#define XXH_HAS_CPP_ATTRIBUTE(x) __has_cpp_attribute(x)
#else
#define XXH_HAS_CPP_ATTRIBUTE(x) 0
#endif
+ /*! @endcond */
+ /*! @cond Doxygen ignores this part */
/*
- Define XXH_FALLTHROUGH macro for annotating switch case with the 'fallthrough'
- attribute introduced in CPP17 and C23. CPP17 :
- https://en.cppreference.com/w/cpp/language/attributes/fallthrough C23 :
- https://en.cppreference.com/w/c/language/attributes/fallthrough
- */
- #if XXH_HAS_C_ATTRIBUTE(x)
- #define XXH_FALLTHROUGH [[fallthrough]]
- #elif XXH_HAS_CPP_ATTRIBUTE(x)
+ * Define XXH_FALLTHROUGH macro for annotating switch case with the
+ * 'fallthrough' attribute introduced in CPP17 and C23. CPP17 :
+ * https://en.cppreference.com/w/cpp/language/attributes/fallthrough C23 :
+ * https://en.cppreference.com/w/c/language/attributes/fallthrough
+ */
+ #if XXH_HAS_C_ATTRIBUTE(fallthrough) || XXH_HAS_CPP_ATTRIBUTE(fallthrough)
#define XXH_FALLTHROUGH [[fallthrough]]
#elif XXH_HAS_ATTRIBUTE(__fallthrough__)
- #define XXH_FALLTHROUGH __attribute__((fallthrough))
+ #define XXH_FALLTHROUGH __attribute__((__fallthrough__))
#else
- #define XXH_FALLTHROUGH
+ #define XXH_FALLTHROUGH /* fallthrough */
#endif
+ /*! @endcond */
+
+ /*! @cond Doxygen ignores this part */
+ /*
+ * Define XXH_NOESCAPE for annotated pointers in public API.
+ * https://clang.llvm.org/docs/AttributeReference.html#noescape
+ * As of writing this, only supported by clang.
+ */
+ #if XXH_HAS_ATTRIBUTE(noescape)
+ #define XXH_NOESCAPE __attribute__((noescape))
+ #else
+ #define XXH_NOESCAPE
+ #endif
+/*! @endcond */
/*!
* @}
@@ -697,7 +930,7 @@ typedef unsigned long long XXH64_hash_t;
/*!
* @}
*
- * @defgroup xxh64_family XXH64 family
+ * @defgroup XXH64_family XXH64 family
* @ingroup public
* @{
@@ -705,16 +938,13 @@ typedef unsigned long long XXH64_hash_t;
*
* @note
* XXH3 provides competitive speed for both 32-bit and 64-bit systems,
- * and offers true 64/128 bit hash results. It provides a superior level of
- * dispersion, and greatly reduces the risks of collisions.
+ * and offers true 64/128 bit hash results.
+ * It provides better speed for systems with vector processing capabilities.
*/
/*!
* @brief Calculates the 64-bit hash of @p input using xxHash64.
*
- * This function usually runs faster on 64-bit systems, but slower on 32-bit
- * systems (see benchmark).
- *
* @param input The block of data to be hashed, at least @p length bytes in
* size.
* @param length The length of @p input, in bytes.
@@ -725,51 +955,171 @@ typedef unsigned long long XXH64_hash_t;
* readable, contiguous memory. However, if @p length is `0`, @p input may be
* `NULL`. In C++, this also must be *TriviallyCopyable*.
*
- * @return The calculated 64-bit hash.
+ * @return The calculated 64-bit xxHash64 value.
*
- * @see
- * XXH32(), XXH3_64bits_withSeed(), XXH3_128bits_withSeed(), XXH128():
- * Direct equivalents for the other variants of xxHash.
- * @see
- * XXH64_createState(), XXH64_update(), XXH64_digest(): Streaming version.
+ * @see @ref single_shot_example "Single Shot Example" for an example.
*/
-XXH_PUBLIC_API XXH64_hash_t XXH64(const void *input, size_t length,
- XXH64_hash_t seed);
+XXH_PUBLIC_API XXH_PUREF XXH64_hash_t XXH64(XXH_NOESCAPE const void *input,
+ size_t length, XXH64_hash_t seed);
-/******* Streaming *******/
+ /******* Streaming *******/
+ #ifndef XXH_NO_STREAM
/*!
* @brief The opaque state struct for the XXH64 streaming API.
*
* @see XXH64_state_s for details.
+ * @see @ref streaming_example "Streaming Example"
*/
-typedef struct XXH64_state_s XXH64_state_t; /* incomplete type */
-XXH_PUBLIC_API XXH64_state_t *XXH64_createState(void);
-XXH_PUBLIC_API XXH_errorcode XXH64_freeState(XXH64_state_t *statePtr);
-XXH_PUBLIC_API void XXH64_copyState(XXH64_state_t *dst_state,
- const XXH64_state_t *src_state);
+typedef struct XXH64_state_s XXH64_state_t; /* incomplete type */
-XXH_PUBLIC_API XXH_errorcode XXH64_reset(XXH64_state_t *statePtr,
- XXH64_hash_t seed);
-XXH_PUBLIC_API XXH_errorcode XXH64_update(XXH64_state_t *statePtr,
- const void *input, size_t length);
-XXH_PUBLIC_API XXH64_hash_t XXH64_digest(const XXH64_state_t *statePtr);
+/*!
+ * @brief Allocates an @ref XXH64_state_t.
+ *
+ * @return An allocated pointer of @ref XXH64_state_t on success.
+ * @return `NULL` on failure.
+ *
+ * @note Must be freed with XXH64_freeState().
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
+XXH_PUBLIC_API XXH_MALLOCF XXH64_state_t *XXH64_createState(void);
+
+/*!
+ * @brief Frees an @ref XXH64_state_t.
+ *
+ * @param statePtr A pointer to an @ref XXH64_state_t allocated with @ref
+ * XXH64_createState().
+ *
+ * @return @ref XXH_OK.
+ *
+ * @note @p statePtr must be allocated with XXH64_createState().
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
+XXH_PUBLIC_API XXH_errorcode XXH64_freeState(XXH64_state_t *statePtr);
+
+/*!
+ * @brief Copies one @ref XXH64_state_t to another.
+ *
+ * @param dst_state The state to copy to.
+ * @param src_state The state to copy from.
+ * @pre
+ * @p dst_state and @p src_state must not be `NULL` and must not overlap.
+ */
+XXH_PUBLIC_API void XXH64_copyState(XXH_NOESCAPE XXH64_state_t *dst_state,
+ const XXH64_state_t *src_state);
+/*!
+ * @brief Resets an @ref XXH64_state_t to begin a new hash.
+ *
+ * @param statePtr The state struct to reset.
+ * @param seed The 64-bit seed to alter the hash result predictably.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note This function resets and seeds a state. Call it before @ref
+ * XXH64_update().
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
+XXH_PUBLIC_API XXH_errorcode XXH64_reset(XXH_NOESCAPE XXH64_state_t *statePtr,
+ XXH64_hash_t seed);
+
+/*!
+ * @brief Consumes a block of @p input to an @ref XXH64_state_t.
+ *
+ * @param statePtr The state struct to update.
+ * @param input The block of data to be hashed, at least @p length bytes in
+ * size.
+ * @param length The length of @p input, in bytes.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ * @pre
+ * The memory between @p input and @p input + @p length must be valid,
+ * readable, contiguous memory. However, if @p length is `0`, @p input may be
+ * `NULL`. In C++, this also must be *TriviallyCopyable*.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note Call this to incrementally consume blocks of data.
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
+XXH_PUBLIC_API XXH_errorcode XXH64_update(XXH_NOESCAPE XXH64_state_t *statePtr,
+ XXH_NOESCAPE const void *input,
+ size_t length);
+
+/*!
+ * @brief Returns the calculated hash value from an @ref XXH64_state_t.
+ *
+ * @param statePtr The state struct to calculate the hash from.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return The calculated 64-bit xxHash64 value from that state.
+ *
+ * @note
+ * Calling XXH64_digest() will not affect @p statePtr, so you can update,
+ * digest, and update again.
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
+XXH_PUBLIC_API XXH_PUREF XXH64_hash_t
+XXH64_digest(XXH_NOESCAPE const XXH64_state_t *statePtr);
+ #endif /* !XXH_NO_STREAM */
/******* Canonical representation *******/
+
+/*!
+ * @brief Canonical (big endian) representation of @ref XXH64_hash_t.
+ */
typedef struct {
unsigned char digest[sizeof(XXH64_hash_t)];
} XXH64_canonical_t;
-XXH_PUBLIC_API void XXH64_canonicalFromHash(XXH64_canonical_t *dst,
- XXH64_hash_t hash);
-XXH_PUBLIC_API XXH64_hash_t
-XXH64_hashFromCanonical(const XXH64_canonical_t *src);
+/*!
+ * @brief Converts an @ref XXH64_hash_t to a big endian @ref XXH64_canonical_t.
+ *
+ * @param dst The @ref XXH64_canonical_t pointer to be stored to.
+ * @param hash The @ref XXH64_hash_t to be converted.
+ *
+ * @pre
+ * @p dst must not be `NULL`.
+ *
+ * @see @ref canonical_representation_example "Canonical Representation Example"
+ */
+XXH_PUBLIC_API void XXH64_canonicalFromHash(XXH_NOESCAPE XXH64_canonical_t *dst,
+ XXH64_hash_t hash);
+
+/*!
+ * @brief Converts an @ref XXH64_canonical_t to a native @ref XXH64_hash_t.
+ *
+ * @param src The @ref XXH64_canonical_t to convert.
+ *
+ * @pre
+ * @p src must not be `NULL`.
+ *
+ * @return The converted hash.
+ *
+ * @see @ref canonical_representation_example "Canonical Representation Example"
+ */
+XXH_PUBLIC_API XXH_PUREF XXH64_hash_t
+XXH64_hashFromCanonical(XXH_NOESCAPE const XXH64_canonical_t *src);
+
+ #ifndef XXH_NO_XXH3
/*!
* @}
* ************************************************************************
- * @defgroup xxh3_family XXH3 family
+ * @defgroup XXH3_family XXH3 family
* @ingroup public
* @{
@@ -790,16 +1140,27 @@ XXH64_hashFromCanonical(const XXH64_canonical_t *src);
*
* XXH3's speed benefits greatly from SIMD and 64-bit arithmetic,
* but does not require it.
- * Any 32-bit and 64-bit targets that can run XXH32 smoothly
- * can run XXH3 at competitive speeds, even without vector support.
- * Further details are explained in the implementation.
- *
- * Optimized implementations are provided for AVX512, AVX2, SSE2, NEON, POWER8,
- * ZVector and scalar targets. This can be controlled via the XXH_VECTOR macro.
+ * Most 32-bit and 64-bit targets that can run XXH32 smoothly can run XXH3
+ * at competitive speeds, even without vector support. Further details are
+ * explained in the implementation.
+ *
+ * XXH3 has a fast scalar implementation, but it also includes accelerated SIMD
+ * implementations for many common platforms:
+ * - AVX512
+ * - AVX2
+ * - SSE2
+ * - ARM NEON
+ * - WebAssembly SIMD128
+ * - POWER8 VSX
+ * - s390x ZVector
+ * This can be controlled via the @ref XXH_VECTOR macro, but it automatically
+ * selects the best version according to predefined macros. For the x86 family,
+ * an automatic runtime dispatcher is included separately in @ref
+ * xxh_x86dispatch.c.
*
* XXH3 implementation is portable:
* it has a generic C90 formulation that can be compiled on any platform,
- * all implementations generage exactly the same hash value on all platforms.
+ * all implementations generate exactly the same hash value on all platforms.
* Starting from v0.8.0, it's also labelled "stable", meaning that
* any future version will also generate the same hash value.
*
@@ -811,53 +1172,112 @@ XXH64_hashFromCanonical(const XXH64_canonical_t *src);
*
* The API supports one-shot hashing, streaming mode, and custom secrets.
*/
-
/*-**********************************************************************
* XXH3 64-bit variant
************************************************************************/
-/* XXH3_64bits():
- * default 64-bit variant, using default secret and default seed of 0.
- * It's the fastest variant. */
-XXH_PUBLIC_API XXH64_hash_t XXH3_64bits(const void *data, size_t len);
+/*!
+ * @brief Calculates 64-bit unseeded variant of XXH3 hash of @p input.
+ *
+ * @param input The block of data to be hashed, at least @p length bytes in
+ * size.
+ * @param length The length of @p input, in bytes.
+ *
+ * @pre
+ * The memory between @p input and @p input + @p length must be valid,
+ * readable, contiguous memory. However, if @p length is `0`, @p input may be
+ * `NULL`. In C++, this also must be *TriviallyCopyable*.
+ *
+ * @return The calculated 64-bit XXH3 hash value.
+ *
+ * @note
+ * This is equivalent to @ref XXH3_64bits_withSeed() with a seed of `0`,
+ * however it may have slightly better performance due to constant propagation
+ * of the defaults.
+ *
+ * @see
+ * XXH3_64bits_withSeed(), XXH3_64bits_withSecret(): other seeding variants
+ * @see @ref single_shot_example "Single Shot Example" for an example.
+ */
+XXH_PUBLIC_API XXH_PUREF XXH64_hash_t
+XXH3_64bits(XXH_NOESCAPE const void *input, size_t length);
-/*
- * XXH3_64bits_withSeed():
- * This variant generates a custom secret on the fly
- * based on default secret altered using the `seed` value.
+/*!
+ * @brief Calculates 64-bit seeded variant of XXH3 hash of @p input.
+ *
+ * @param input The block of data to be hashed, at least @p length bytes in
+ * size.
+ * @param length The length of @p input, in bytes.
+ * @param seed The 64-bit seed to alter the hash result predictably.
+ *
+ * @pre
+ * The memory between @p input and @p input + @p length must be valid,
+ * readable, contiguous memory. However, if @p length is `0`, @p input may be
+ * `NULL`. In C++, this also must be *TriviallyCopyable*.
+ *
+ * @return The calculated 64-bit XXH3 hash value.
+ *
+ * @note
+ * seed == 0 produces the same results as @ref XXH3_64bits().
+ *
+ * This variant generates a custom secret on the fly based on default secret
+ * altered using the @p seed value.
+ *
* While this operation is decently fast, note that it's not completely free.
- * Note: seed==0 produces the same results as XXH3_64bits().
+ *
+ * @see @ref single_shot_example "Single Shot Example" for an example.
*/
-XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_withSeed(const void *data, size_t len,
- XXH64_hash_t seed);
+XXH_PUBLIC_API XXH_PUREF XXH64_hash_t XXH3_64bits_withSeed(
+ XXH_NOESCAPE const void *input, size_t length, XXH64_hash_t seed);
- /*!
- * The bare minimum size for a custom secret.
- *
- * @see
- * XXH3_64bits_withSecret(), XXH3_64bits_reset_withSecret(),
- * XXH3_128bits_withSecret(), XXH3_128bits_reset_withSecret().
- */
- #define XXH3_SECRET_SIZE_MIN 136
+ /*!
+ * The bare minimum size for a custom secret.
+ *
+ * @see
+ * XXH3_64bits_withSecret(), XXH3_64bits_reset_withSecret(),
+ * XXH3_128bits_withSecret(), XXH3_128bits_reset_withSecret().
+ */
+ #define XXH3_SECRET_SIZE_MIN 136
-/*
- * XXH3_64bits_withSecret():
+/*!
+ * @brief Calculates 64-bit variant of XXH3 with a custom "secret".
+ *
+ * @param data The block of data to be hashed, at least @p len bytes in
+ * size.
+ * @param len The length of @p data, in bytes.
+ * @param secret The secret data.
+ * @param secretSize The length of @p secret, in bytes.
+ *
+ * @return The calculated 64-bit XXH3 hash value.
+ *
+ * @pre
+ * The memory between @p data and @p data + @p len must be valid,
+ * readable, contiguous memory. However, if @p length is `0`, @p data may be
+ * `NULL`. In C++, this also must be *TriviallyCopyable*.
+ *
* It's possible to provide any blob of bytes as a "secret" to generate the
* hash. This makes it more difficult for an external actor to prepare an
- * intentional collision. The main condition is that secretSize *must* be large
- * enough (>= XXH3_SECRET_SIZE_MIN). However, the quality of produced hash
- * values depends on secret's entropy. Technically, the secret must look like a
- * bunch of random bytes. Avoid "trivial" or structured data such as repeated
- * sequences or a text document. Whenever unsure about the "randomness" of the
- * blob of bytes, consider relabelling it as a "custom seed" instead, and employ
- * "XXH3_generateSecret()" (see below) to generate a high entropy secret derived
- * from the custom seed.
- */
-XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_withSecret(const void *data, size_t len,
- const void *secret,
- size_t secretSize);
-
-/******* Streaming *******/
+ * intentional collision. The main condition is that @p secretSize *must* be
+ * large enough (>= @ref XXH3_SECRET_SIZE_MIN). However, the quality of the
+ * secret impacts the dispersion of the hash algorithm. Therefore, the secret
+ * _must_ look like a bunch of random bytes. Avoid "trivial" or structured data
+ * such as repeated sequences or a text document. Whenever in doubt about the
+ * "randomness" of the blob of bytes, consider employing @ref
+ * XXH3_generateSecret() instead (see below). It will generate a proper high
+ * entropy secret derived from the blob of bytes. Another advantage of using
+ * XXH3_generateSecret() is that it guarantees that all bits within the initial
+ * blob of bytes will impact every bit of the output. This is not necessarily
+ * the case when using the blob of bytes directly because, when hashing _small_
+ * inputs, only a portion of the secret is employed.
+ *
+ * @see @ref single_shot_example "Single Shot Example" for an example.
+ */
+XXH_PUBLIC_API XXH_PUREF XXH64_hash_t
+XXH3_64bits_withSecret(XXH_NOESCAPE const void *data, size_t len,
+ XXH_NOESCAPE const void *secret, size_t secretSize);
+
+ /******* Streaming *******/
+ #ifndef XXH_NO_STREAM
/*
* Streaming requires state maintenance.
* This operation costs memory and CPU.
@@ -866,45 +1286,146 @@ XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_withSecret(const void *data, size_t len,
*/
/*!
- * @brief The state struct for the XXH3 streaming API.
+ * @brief The opaque state struct for the XXH3 streaming API.
*
* @see XXH3_state_s for details.
+ * @see @ref streaming_example "Streaming Example"
*/
-typedef struct XXH3_state_s XXH3_state_t;
-XXH_PUBLIC_API XXH3_state_t *XXH3_createState(void);
-XXH_PUBLIC_API XXH_errorcode XXH3_freeState(XXH3_state_t *statePtr);
-XXH_PUBLIC_API void XXH3_copyState(XXH3_state_t *dst_state,
- const XXH3_state_t *src_state);
+typedef struct XXH3_state_s XXH3_state_t;
+XXH_PUBLIC_API XXH_MALLOCF XXH3_state_t *XXH3_createState(void);
+XXH_PUBLIC_API XXH_errorcode XXH3_freeState(XXH3_state_t *statePtr);
-/*
- * XXH3_64bits_reset():
- * Initialize with default parameters.
- * digest will be equivalent to `XXH3_64bits()`.
+/*!
+ * @brief Copies one @ref XXH3_state_t to another.
+ *
+ * @param dst_state The state to copy to.
+ * @param src_state The state to copy from.
+ * @pre
+ * @p dst_state and @p src_state must not be `NULL` and must not overlap.
*/
-XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset(XXH3_state_t *statePtr);
-/*
- * XXH3_64bits_reset_withSeed():
- * Generate a custom secret from `seed`, and store it into `statePtr`.
- * digest will be equivalent to `XXH3_64bits_withSeed()`.
+XXH_PUBLIC_API void XXH3_copyState(XXH_NOESCAPE XXH3_state_t *dst_state,
+ XXH_NOESCAPE const XXH3_state_t *src_state);
+
+/*!
+ * @brief Resets an @ref XXH3_state_t to begin a new hash.
+ *
+ * @param statePtr The state struct to reset.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note
+ * - This function resets `statePtr` and generate a secret with default
+ * parameters.
+ * - Call this function before @ref XXH3_64bits_update().
+ * - Digest will be equivalent to `XXH3_64bits()`.
+ *
+ * @see @ref streaming_example "Streaming Example"
+ *
*/
-XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset_withSeed(XXH3_state_t *statePtr,
- XXH64_hash_t seed);
-/*
- * XXH3_64bits_reset_withSecret():
- * `secret` is referenced, it _must outlive_ the hash streaming session.
- * Similar to one-shot API, `secretSize` must be >= `XXH3_SECRET_SIZE_MIN`,
+XXH_PUBLIC_API XXH_errorcode
+XXH3_64bits_reset(XXH_NOESCAPE XXH3_state_t *statePtr);
+
+/*!
+ * @brief Resets an @ref XXH3_state_t with 64-bit seed to begin a new hash.
+ *
+ * @param statePtr The state struct to reset.
+ * @param seed The 64-bit seed to alter the hash result predictably.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note
+ * - This function resets `statePtr` and generate a secret from `seed`.
+ * - Call this function before @ref XXH3_64bits_update().
+ * - Digest will be equivalent to `XXH3_64bits_withSeed()`.
+ *
+ * @see @ref streaming_example "Streaming Example"
+ *
+ */
+XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset_withSeed(
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH64_hash_t seed);
+
+/*!
+ * @brief Resets an @ref XXH3_state_t with secret data to begin a new hash.
+ *
+ * @param statePtr The state struct to reset.
+ * @param secret The secret data.
+ * @param secretSize The length of @p secret, in bytes.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note
+ * `secret` is referenced, it _must outlive_ the hash streaming session.
+ *
+ * Similar to one-shot API, `secretSize` must be >= @ref XXH3_SECRET_SIZE_MIN,
* and the quality of produced hash values depends on secret's entropy
* (secret's content should look like a bunch of random bytes).
* When in doubt about the randomness of a candidate `secret`,
* consider employing `XXH3_generateSecret()` instead (see below).
+ *
+ * @see @ref streaming_example "Streaming Example"
*/
XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset_withSecret(
- XXH3_state_t *statePtr, const void *secret, size_t secretSize);
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *secret,
+ size_t secretSize);
-XXH_PUBLIC_API XXH_errorcode XXH3_64bits_update(XXH3_state_t *statePtr,
- const void *input,
- size_t length);
-XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_digest(const XXH3_state_t *statePtr);
+/*!
+ * @brief Consumes a block of @p input to an @ref XXH3_state_t.
+ *
+ * @param statePtr The state struct to update.
+ * @param input The block of data to be hashed, at least @p length bytes in
+ * size.
+ * @param length The length of @p input, in bytes.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ * @pre
+ * The memory between @p input and @p input + @p length must be valid,
+ * readable, contiguous memory. However, if @p length is `0`, @p input may be
+ * `NULL`. In C++, this also must be *TriviallyCopyable*.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note Call this to incrementally consume blocks of data.
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
+XXH_PUBLIC_API XXH_errorcode
+XXH3_64bits_update(XXH_NOESCAPE XXH3_state_t *statePtr,
+ XXH_NOESCAPE const void *input, size_t length);
+
+/*!
+ * @brief Returns the calculated XXH3 64-bit hash value from an @ref
+ * XXH3_state_t.
+ *
+ * @param statePtr The state struct to calculate the hash from.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return The calculated XXH3 64-bit hash value from that state.
+ *
+ * @note
+ * Calling XXH3_64bits_digest() will not affect @p statePtr, so you can
+ * update, digest, and update again.
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
+XXH_PUBLIC_API XXH_PUREF XXH64_hash_t
+XXH3_64bits_digest(XXH_NOESCAPE const XXH3_state_t *statePtr);
+ #endif /* !XXH_NO_STREAM */
/* note : canonical representation of XXH3 is the same as XXH64
* since they both produce XXH64_hash_t values */
@@ -926,15 +1447,82 @@ typedef struct {
} XXH128_hash_t;
-XXH_PUBLIC_API XXH128_hash_t XXH3_128bits(const void *data, size_t len);
-XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_withSeed(const void *data, size_t len,
- XXH64_hash_t seed);
-XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_withSecret(const void *data,
- size_t len,
- const void *secret,
- size_t secretSize);
+/*!
+ * @brief Calculates 128-bit unseeded variant of XXH3 of @p data.
+ *
+ * @param data The block of data to be hashed, at least @p length bytes in size.
+ * @param len The length of @p data, in bytes.
+ *
+ * @return The calculated 128-bit variant of XXH3 value.
+ *
+ * The 128-bit variant of XXH3 has more strength, but it has a bit of overhead
+ * for shorter inputs.
+ *
+ * This is equivalent to @ref XXH3_128bits_withSeed() with a seed of `0`,
+ * however it may have slightly better performance due to constant propagation
+ * of the defaults.
+ *
+ * @see XXH3_128bits_withSeed(), XXH3_128bits_withSecret(): other seeding
+ * variants
+ * @see @ref single_shot_example "Single Shot Example" for an example.
+ */
+XXH_PUBLIC_API XXH_PUREF XXH128_hash_t
+XXH3_128bits(XXH_NOESCAPE const void *data, size_t len);
+/*! @brief Calculates 128-bit seeded variant of XXH3 hash of @p data.
+ *
+ * @param data The block of data to be hashed, at least @p length bytes in size.
+ * @param len The length of @p data, in bytes.
+ * @param seed The 64-bit seed to alter the hash result predictably.
+ *
+ * @return The calculated 128-bit variant of XXH3 value.
+ *
+ * @note
+ * seed == 0 produces the same results as @ref XXH3_64bits().
+ *
+ * This variant generates a custom secret on the fly based on default secret
+ * altered using the @p seed value.
+ *
+ * While this operation is decently fast, note that it's not completely free.
+ *
+ * @see XXH3_128bits(), XXH3_128bits_withSecret(): other seeding variants
+ * @see @ref single_shot_example "Single Shot Example" for an example.
+ */
+XXH_PUBLIC_API XXH_PUREF XXH128_hash_t XXH3_128bits_withSeed(
+ XXH_NOESCAPE const void *data, size_t len, XXH64_hash_t seed);
+/*!
+ * @brief Calculates 128-bit variant of XXH3 with a custom "secret".
+ *
+ * @param data The block of data to be hashed, at least @p len bytes in
+ * size.
+ * @param len The length of @p data, in bytes.
+ * @param secret The secret data.
+ * @param secretSize The length of @p secret, in bytes.
+ *
+ * @return The calculated 128-bit variant of XXH3 value.
+ *
+ * It's possible to provide any blob of bytes as a "secret" to generate the
+ * hash. This makes it more difficult for an external actor to prepare an
+ * intentional collision. The main condition is that @p secretSize *must* be
+ * large enough (>= @ref XXH3_SECRET_SIZE_MIN). However, the quality of the
+ * secret impacts the dispersion of the hash algorithm. Therefore, the secret
+ * _must_ look like a bunch of random bytes. Avoid "trivial" or structured data
+ * such as repeated sequences or a text document. Whenever in doubt about the
+ * "randomness" of the blob of bytes, consider employing @ref
+ * XXH3_generateSecret() instead (see below). It will generate a proper high
+ * entropy secret derived from the blob of bytes. Another advantage of using
+ * XXH3_generateSecret() is that it guarantees that all bits within the initial
+ * blob of bytes will impact every bit of the output. This is not necessarily
+ * the case when using the blob of bytes directly because, when hashing _small_
+ * inputs, only a portion of the secret is employed.
+ *
+ * @see @ref single_shot_example "Single Shot Example" for an example.
+ */
+XXH_PUBLIC_API XXH_PUREF XXH128_hash_t
+XXH3_128bits_withSecret(XXH_NOESCAPE const void *data, size_t len,
+ XXH_NOESCAPE const void *secret, size_t secretSize);
-/******* Streaming *******/
+ /******* Streaming *******/
+ #ifndef XXH_NO_STREAM
/*
* Streaming requires state maintenance.
* This operation costs memory and CPU.
@@ -948,39 +1536,151 @@ XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_withSecret(const void *data,
* counterpart.
*/
-XXH_PUBLIC_API XXH_errorcode XXH3_128bits_reset(XXH3_state_t *statePtr);
-XXH_PUBLIC_API XXH_errorcode XXH3_128bits_reset_withSeed(XXH3_state_t *statePtr,
- XXH64_hash_t seed);
+/*!
+ * @brief Resets an @ref XXH3_state_t to begin a new hash.
+ *
+ * @param statePtr The state struct to reset.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note
+ * - This function resets `statePtr` and generate a secret with default
+ * parameters.
+ * - Call it before @ref XXH3_128bits_update().
+ * - Digest will be equivalent to `XXH3_128bits()`.
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
+XXH_PUBLIC_API XXH_errorcode
+XXH3_128bits_reset(XXH_NOESCAPE XXH3_state_t *statePtr);
+
+/*!
+ * @brief Resets an @ref XXH3_state_t with 64-bit seed to begin a new hash.
+ *
+ * @param statePtr The state struct to reset.
+ * @param seed The 64-bit seed to alter the hash result predictably.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note
+ * - This function resets `statePtr` and generate a secret from `seed`.
+ * - Call it before @ref XXH3_128bits_update().
+ * - Digest will be equivalent to `XXH3_128bits_withSeed()`.
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
+XXH_PUBLIC_API XXH_errorcode XXH3_128bits_reset_withSeed(
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH64_hash_t seed);
+/*!
+ * @brief Resets an @ref XXH3_state_t with secret data to begin a new hash.
+ *
+ * @param statePtr The state struct to reset.
+ * @param secret The secret data.
+ * @param secretSize The length of @p secret, in bytes.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * `secret` is referenced, it _must outlive_ the hash streaming session.
+ * Similar to one-shot API, `secretSize` must be >= @ref XXH3_SECRET_SIZE_MIN,
+ * and the quality of produced hash values depends on secret's entropy
+ * (secret's content should look like a bunch of random bytes).
+ * When in doubt about the randomness of a candidate `secret`,
+ * consider employing `XXH3_generateSecret()` instead (see below).
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
XXH_PUBLIC_API XXH_errorcode XXH3_128bits_reset_withSecret(
- XXH3_state_t *statePtr, const void *secret, size_t secretSize);
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *secret,
+ size_t secretSize);
+
+/*!
+ * @brief Consumes a block of @p input to an @ref XXH3_state_t.
+ *
+ * Call this to incrementally consume blocks of data.
+ *
+ * @param statePtr The state struct to update.
+ * @param input The block of data to be hashed, at least @p length bytes in
+ * size.
+ * @param length The length of @p input, in bytes.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @note
+ * The memory between @p input and @p input + @p length must be valid,
+ * readable, contiguous memory. However, if @p length is `0`, @p input may be
+ * `NULL`. In C++, this also must be *TriviallyCopyable*.
+ *
+ */
+XXH_PUBLIC_API XXH_errorcode
+XXH3_128bits_update(XXH_NOESCAPE XXH3_state_t *statePtr,
+ XXH_NOESCAPE const void *input, size_t length);
-XXH_PUBLIC_API XXH_errorcode XXH3_128bits_update(XXH3_state_t *statePtr,
- const void *input,
- size_t length);
-XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_digest(const XXH3_state_t *statePtr);
+/*!
+ * @brief Returns the calculated XXH3 128-bit hash value from an @ref
+ * XXH3_state_t.
+ *
+ * @param statePtr The state struct to calculate the hash from.
+ *
+ * @pre
+ * @p statePtr must not be `NULL`.
+ *
+ * @return The calculated XXH3 128-bit hash value from that state.
+ *
+ * @note
+ * Calling XXH3_128bits_digest() will not affect @p statePtr, so you can
+ * update, digest, and update again.
+ *
+ */
+XXH_PUBLIC_API XXH_PUREF XXH128_hash_t
+XXH3_128bits_digest(XXH_NOESCAPE const XXH3_state_t *statePtr);
+ #endif /* !XXH_NO_STREAM */
/* Following helper functions make it possible to compare XXH128_hast_t values.
* Since XXH128_hash_t is a structure, this capability is not offered by the
- * language.
- * Note: For better performance, these functions can be inlined using
+ * language. Note: For better performance, these functions can be inlined using
* XXH_INLINE_ALL */
/*!
- * XXH128_isEqual():
- * Return: 1 if `h1` and `h2` are equal, 0 if they are not.
+ * @brief Check equality of two XXH128_hash_t values
+ *
+ * @param h1 The 128-bit hash value.
+ * @param h2 Another 128-bit hash value.
+ *
+ * @return `1` if `h1` and `h2` are equal.
+ * @return `0` if they are not.
*/
-XXH_PUBLIC_API int XXH128_isEqual(XXH128_hash_t h1, XXH128_hash_t h2);
+XXH_PUBLIC_API XXH_PUREF int XXH128_isEqual(XXH128_hash_t h1, XXH128_hash_t h2);
/*!
- * XXH128_cmp():
+ * @brief Compares two @ref XXH128_hash_t
*
* This comparator is compatible with stdlib's `qsort()`/`bsearch()`.
*
- * return: >0 if *h128_1 > *h128_2
- * =0 if *h128_1 == *h128_2
- * <0 if *h128_1 < *h128_2
+ * @param h128_1 Left-hand side value
+ * @param h128_2 Right-hand side value
+ *
+ * @return >0 if @p h128_1 > @p h128_2
+ * @return =0 if @p h128_1 == @p h128_2
+ * @return <0 if @p h128_1 < @p h128_2
*/
-XXH_PUBLIC_API int XXH128_cmp(const void *h128_1, const void *h128_2);
+XXH_PUBLIC_API XXH_PUREF int XXH128_cmp(XXH_NOESCAPE const void *h128_1,
+ XXH_NOESCAPE const void *h128_2);
/******* Canonical representation *******/
typedef struct {
@@ -989,11 +1689,35 @@ typedef struct {
} XXH128_canonical_t;
-XXH_PUBLIC_API void XXH128_canonicalFromHash(XXH128_canonical_t *dst,
- XXH128_hash_t hash);
-XXH_PUBLIC_API XXH128_hash_t
-XXH128_hashFromCanonical(const XXH128_canonical_t *src);
+/*!
+ * @brief Converts an @ref XXH128_hash_t to a big endian @ref
+ * XXH128_canonical_t.
+ *
+ * @param dst The @ref XXH128_canonical_t pointer to be stored to.
+ * @param hash The @ref XXH128_hash_t to be converted.
+ *
+ * @pre
+ * @p dst must not be `NULL`.
+ * @see @ref canonical_representation_example "Canonical Representation Example"
+ */
+XXH_PUBLIC_API void XXH128_canonicalFromHash(
+ XXH_NOESCAPE XXH128_canonical_t *dst, XXH128_hash_t hash);
+
+/*!
+ * @brief Converts an @ref XXH128_canonical_t to a native @ref XXH128_hash_t.
+ *
+ * @param src The @ref XXH128_canonical_t to convert.
+ *
+ * @pre
+ * @p src must not be `NULL`.
+ *
+ * @return The converted hash.
+ * @see @ref canonical_representation_example "Canonical Representation Example"
+ */
+XXH_PUBLIC_API XXH_PUREF XXH128_hash_t
+XXH128_hashFromCanonical(XXH_NOESCAPE const XXH128_canonical_t *src);
+ #endif /* !XXH_NO_XXH3 */
#endif /* XXH_NO_LONG_LONG */
/*!
@@ -1035,15 +1759,11 @@ struct XXH32_state_s {
XXH32_hash_t total_len_32; /*!< Total length hashed, modulo 2^32 */
XXH32_hash_t large_len; /*!< Whether the hash is >= 16 (handles @ref
total_len_32 overflow) */
- XXH32_hash_t v1; /*!< First accumulator lane */
- XXH32_hash_t v2; /*!< Second accumulator lane */
- XXH32_hash_t v3; /*!< Third accumulator lane */
- XXH32_hash_t v4; /*!< Fourth accumulator lane */
+ XXH32_hash_t v[4]; /*!< Accumulator lanes */
XXH32_hash_t mem32[4]; /*!< Internal buffer for partial reads. Treated as
unsigned char[16]. */
XXH32_hash_t memsize; /*!< Amount of data in @ref mem32 */
- XXH32_hash_t reserved; /*!< Reserved field. Do not read or write to it, it may
- be removed. */
+ XXH32_hash_t reserved; /*!< Reserved field. Do not read nor write to it. */
}; /* typedef'd to XXH32_state_t */
@@ -1064,62 +1784,62 @@ struct XXH32_state_s {
struct XXH64_state_s {
XXH64_hash_t total_len; /*!< Total length hashed. This is always 64-bit. */
- XXH64_hash_t v1; /*!< First accumulator lane */
- XXH64_hash_t v2; /*!< Second accumulator lane */
- XXH64_hash_t v3; /*!< Third accumulator lane */
- XXH64_hash_t v4; /*!< Fourth accumulator lane */
+ XXH64_hash_t v[4]; /*!< Accumulator lanes */
XXH64_hash_t mem64[4]; /*!< Internal buffer for partial reads. Treated as
unsigned char[32]. */
XXH32_hash_t memsize; /*!< Amount of data in @ref mem64 */
XXH32_hash_t reserved32; /*!< Reserved field, needed for padding anyways*/
- XXH64_hash_t reserved64; /*!< Reserved field. Do not read or write to it, it
- may be removed. */
+ XXH64_hash_t reserved64; /*!< Reserved field. Do not read or write to it. */
}; /* typedef'd to XXH64_state_t */
- #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) /* >= C11 \
- */
- #include <stdalign.h>
- #define XXH_ALIGN(n) alignas(n)
- #elif defined(__cplusplus) && (__cplusplus >= 201103L) /* >= C++11 */
- /* In C++ alignas() is a keyword */
- #define XXH_ALIGN(n) alignas(n)
- #elif defined(__GNUC__)
- #define XXH_ALIGN(n) __attribute__((aligned(n)))
- #elif defined(_MSC_VER)
- #define XXH_ALIGN(n) __declspec(align(n))
- #else
- #define XXH_ALIGN(n) /* disabled */
- #endif
+ #ifndef XXH_NO_XXH3
- /* Old GCC versions only accept the attribute after the type in structures.
- */
- #if !(defined(__STDC_VERSION__) && \
- (__STDC_VERSION__ >= 201112L)) /* C11+ */ \
- && !(defined(__cplusplus) && (__cplusplus >= 201103L)) /* >= C++11 */ \
- && defined(__GNUC__)
- #define XXH_ALIGN_MEMBER(align, type) type XXH_ALIGN(align)
- #else
- #define XXH_ALIGN_MEMBER(align, type) XXH_ALIGN(align) type
- #endif
+ #if defined(__STDC_VERSION__) && \
+ (__STDC_VERSION__ >= 201112L) /* >= C11 */
+ #include <stdalign.h>
+ #define XXH_ALIGN(n) alignas(n)
+ #elif defined(__cplusplus) && (__cplusplus >= 201103L) /* >= C++11 */
+ /* In C++ alignas() is a keyword */
+ #define XXH_ALIGN(n) alignas(n)
+ #elif defined(__GNUC__)
+ #define XXH_ALIGN(n) __attribute__((aligned(n)))
+ #elif defined(_MSC_VER)
+ #define XXH_ALIGN(n) __declspec(align(n))
+ #else
+ #define XXH_ALIGN(n) /* disabled */
+ #endif
- /*!
- * @brief The size of the internal XXH3 buffer.
- *
- * This is the optimal update size for incremental hashing.
- *
- * @see XXH3_64b_update(), XXH3_128b_update().
- */
- #define XXH3_INTERNALBUFFER_SIZE 256
+ /* Old GCC versions only accept the attribute after the type in
+ * structures. */
+ #if !(defined(__STDC_VERSION__) && \
+ (__STDC_VERSION__ >= 201112L)) /* C11+ */ \
+ && \
+ !(defined(__cplusplus) && (__cplusplus >= 201103L)) /* >= C++11 */ \
+ && defined(__GNUC__)
+ #define XXH_ALIGN_MEMBER(align, type) type XXH_ALIGN(align)
+ #else
+ #define XXH_ALIGN_MEMBER(align, type) XXH_ALIGN(align) type
+ #endif
- /*!
- * @brief Default size of the secret buffer (and @ref XXH3_kSecret).
- *
- * This is the size used in @ref XXH3_kSecret and the seeded functions.
- *
- * Not to be confused with @ref XXH3_SECRET_SIZE_MIN.
- */
- #define XXH3_SECRET_DEFAULT_SIZE 192
+ /*!
+ * @brief The size of the internal XXH3 buffer.
+ *
+ * This is the optimal update size for incremental hashing.
+ *
+ * @see XXH3_64b_update(), XXH3_128b_update().
+ */
+ #define XXH3_INTERNALBUFFER_SIZE 256
+
+ /*!
+ * @internal
+ * @brief Default size of the secret buffer (and @ref XXH3_kSecret).
+ *
+ * This is the size used in @ref XXH3_kSecret and the seeded functions.
+ *
+ * Not to be confused with @ref XXH3_SECRET_SIZE_MIN.
+ */
+ #define XXH3_SECRET_DEFAULT_SIZE 192
/*!
* @internal
@@ -1146,15 +1866,15 @@ struct XXH64_state_s {
struct XXH3_state_s {
XXH_ALIGN_MEMBER(64, XXH64_hash_t acc[8]);
- /*!< The 8 accumulators. Similar to `vN` in @ref XXH32_state_s::v1 and @ref
- * XXH64_state_s */
+ /*!< The 8 accumulators. See @ref XXH32_state_s::v and @ref XXH64_state_s::v
+ */
XXH_ALIGN_MEMBER(64, unsigned char customSecret[XXH3_SECRET_DEFAULT_SIZE]);
/*!< Used to store a custom secret generated from a seed. */
XXH_ALIGN_MEMBER(64, unsigned char buffer[XXH3_INTERNALBUFFER_SIZE]);
/*!< The internal buffer. @see XXH32_state_s::mem32 */
XXH32_hash_t bufferedSize;
/*!< The amount of memory in @ref buffer, @see XXH32_state_s::memsize */
- XXH32_hash_t reserved32;
+ XXH32_hash_t useSeed;
/*!< Reserved field. Needed for padding on 64-bit. */
size_t nbStripesSoFar;
/*!< Number or stripes processed. */
@@ -1176,67 +1896,262 @@ struct XXH3_state_s {
}; /* typedef'd to XXH3_state_t */
- #undef XXH_ALIGN_MEMBER
+ #undef XXH_ALIGN_MEMBER
- /*!
- * @brief Initializes a stack-allocated `XXH3_state_s`.
- *
- * When the @ref XXH3_state_t structure is merely emplaced on stack,
- * it should be initialized with XXH3_INITSTATE() or a memset()
- * in case its first reset uses XXH3_NNbits_reset_withSeed().
- * This init can be omitted if the first reset uses default or _withSecret
- * mode. This operation isn't necessary when the state is created with
- * XXH3_createState(). Note that this doesn't prepare the state for a
- * streaming operation, it's still necessary to use XXH3_NNbits_reset*()
- * afterwards.
- */
- #define XXH3_INITSTATE(XXH3_state_ptr) \
- { (XXH3_state_ptr)->seed = 0; }
+ /*!
+ * @brief Initializes a stack-allocated `XXH3_state_s`.
+ *
+ * When the @ref XXH3_state_t structure is merely emplaced on stack,
+ * it should be initialized with XXH3_INITSTATE() or a memset()
+ * in case its first reset uses XXH3_NNbits_reset_withSeed().
+ * This init can be omitted if the first reset uses default or _withSecret
+ * mode. This operation isn't necessary when the state is created with
+ * XXH3_createState(). Note that this doesn't prepare the state for a
+ * streaming operation, it's still necessary to use XXH3_NNbits_reset*()
+ * afterwards.
+ */
+ #define XXH3_INITSTATE(XXH3_state_ptr) \
+ do { \
+ \
+ XXH3_state_t *tmp_xxh3_state_ptr = (XXH3_state_ptr); \
+ tmp_xxh3_state_ptr->seed = 0; \
+ tmp_xxh3_state_ptr->extSecret = NULL; \
+ \
+ } while (0)
+
+/*!
+ * @brief Calculates the 128-bit hash of @p data using XXH3.
+ *
+ * @param data The block of data to be hashed, at least @p len bytes in size.
+ * @param len The length of @p data, in bytes.
+ * @param seed The 64-bit seed to alter the hash's output predictably.
+ *
+ * @pre
+ * The memory between @p data and @p data + @p len must be valid,
+ * readable, contiguous memory. However, if @p len is `0`, @p data may be
+ * `NULL`. In C++, this also must be *TriviallyCopyable*.
+ *
+ * @return The calculated 128-bit XXH3 value.
+ *
+ * @see @ref single_shot_example "Single Shot Example" for an example.
+ */
+XXH_PUBLIC_API XXH_PUREF XXH128_hash_t XXH128(XXH_NOESCAPE const void *data,
+ size_t len, XXH64_hash_t seed);
/* === Experimental API === */
/* Symbols defined below must be considered tied to a specific library version.
*/
-/*
- * XXH3_generateSecret():
+/*!
+ * @brief Derive a high-entropy secret from any user-defined content, named
+ * customSeed.
+ *
+ * @param secretBuffer A writable buffer for derived high-entropy secret
+ * data.
+ * @param secretSize Size of secretBuffer, in bytes. Must be >=
+ * XXH3_SECRET_DEFAULT_SIZE.
+ * @param customSeed A user-defined content.
+ * @param customSeedSize Size of customSeed, in bytes.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
*
- * Derive a high-entropy secret from any user-defined content, named customSeed.
* The generated secret can be used in combination with `*_withSecret()`
* functions. The `_withSecret()` variants are useful to provide a higher level
* of protection than 64-bit seed, as it becomes much more difficult for an
* external actor to guess how to impact the calculation logic.
*
* The function accepts as input a custom seed of any length and any content,
- * and derives from it a high-entropy secret of length XXH3_SECRET_DEFAULT_SIZE
- * into an already allocated buffer secretBuffer.
- * The generated secret is _always_ XXH_SECRET_DEFAULT_SIZE bytes long.
+ * and derives from it a high-entropy secret of length @p secretSize into an
+ * already allocated buffer @p secretBuffer.
*
* The generated secret can then be used with any `*_withSecret()` variant.
- * Functions `XXH3_128bits_withSecret()`, `XXH3_64bits_withSecret()`,
- * `XXH3_128bits_reset_withSecret()` and `XXH3_64bits_reset_withSecret()`
+ * The functions @ref XXH3_128bits_withSecret(), @ref XXH3_64bits_withSecret(),
+ * @ref XXH3_128bits_reset_withSecret() and @ref XXH3_64bits_reset_withSecret()
* are part of this list. They all accept a `secret` parameter
- * which must be very long for implementation reasons (>= XXH3_SECRET_SIZE_MIN)
- * _and_ feature very high entropy (consist of random-looking bytes).
- * These conditions can be a high bar to meet, so
- * this function can be used to generate a secret of proper quality.
- *
- * customSeed can be anything. It can have any size, even small ones,
- * and its content can be anything, even stupidly "low entropy" source such as a
- * bunch of zeroes. The resulting `secret` will nonetheless provide all expected
+ * which must be large enough for implementation reasons (>= @ref
+ * XXH3_SECRET_SIZE_MIN) _and_ feature very high entropy (consist of
+ * random-looking bytes). These conditions can be a high bar to meet, so @ref
+ * XXH3_generateSecret() can be employed to ensure proper quality.
+ *
+ * @p customSeed can be anything. It can have any size, even small ones,
+ * and its content can be anything, even "poor entropy" sources such as a bunch
+ * of zeroes. The resulting `secret` will nonetheless provide all required
* qualities.
*
- * Supplying NULL as the customSeed copies the default secret into
- * `secretBuffer`. When customSeedSize > 0, supplying NULL as customSeed is
- * undefined behavior.
+ * @pre
+ * - @p secretSize must be >= @ref XXH3_SECRET_SIZE_MIN
+ * - When @p customSeedSize > 0, supplying NULL as customSeed is undefined
+ * behavior.
+ *
+ * Example code:
+ * @code{.c}
+ * #include <stdio.h>
+ * #include <stdlib.h>
+ * #include <string.h>
+ * #define XXH_STATIC_LINKING_ONLY // expose unstable API
+ * #include "xxhash.h"
+ * // Hashes argv[2] using the entropy from argv[1].
+ * int main(int argc, char* argv[])
+ * {
+
+ * char secret[XXH3_SECRET_SIZE_MIN];
+ * if (argv != 3) { return 1; }
+ * XXH3_generateSecret(secret, sizeof(secret), argv[1], strlen(argv[1]));
+ * XXH64_hash_t h = XXH3_64bits_withSecret(
+ * argv[2], strlen(argv[2]),
+ * secret, sizeof(secret)
+ * );
+ * printf("%016llx\n", (unsigned long long) h);
+ * }
+ * @endcode
*/
-XXH_PUBLIC_API void XXH3_generateSecret(void *secretBuffer,
- const void *customSeed,
- size_t customSeedSize);
+XXH_PUBLIC_API XXH_errorcode
+XXH3_generateSecret(XXH_NOESCAPE void *secretBuffer, size_t secretSize,
+ XXH_NOESCAPE const void *customSeed, size_t customSeedSize);
-/* simple short-cut to pre-selected XXH3_128bits variant */
-XXH_PUBLIC_API XXH128_hash_t XXH128(const void *data, size_t len,
- XXH64_hash_t seed);
+/*!
+ * @brief Generate the same secret as the _withSeed() variants.
+ *
+ * @param secretBuffer A writable buffer of @ref XXH3_SECRET_SIZE_MIN bytes
+ * @param seed The 64-bit seed to alter the hash result predictably.
+ *
+ * The generated secret can be used in combination with
+ *`*_withSecret()` and `_withSecretandSeed()` variants.
+ *
+ * Example C++ `std::string` hash class:
+ * @code{.cpp}
+ * #include <string>
+ * #define XXH_STATIC_LINKING_ONLY // expose unstable API
+ * #include "xxhash.h"
+ * // Slow, seeds each time
+ * class HashSlow {
+ * XXH64_hash_t seed;
+ * public:
+ * HashSlow(XXH64_hash_t s) : seed{s} {}
+ * size_t operator()(const std::string& x) const {
+
+ * return size_t{XXH3_64bits_withSeed(x.c_str(), x.length(), seed)};
+ * }
+ * };
+ * // Fast, caches the seeded secret for future uses.
+ * class HashFast {
+
+ * unsigned char secret[XXH3_SECRET_SIZE_MIN];
+ * public:
+ * HashFast(XXH64_hash_t s) {
+
+ * XXH3_generateSecret_fromSeed(secret, seed);
+ * }
+ * size_t operator()(const std::string& x) const {
+
+ * return size_t{
+
+ * XXH3_64bits_withSecret(x.c_str(), x.length(), secret,
+ *sizeof(secret))
+ * };
+ * }
+ * };
+ * @endcode
+ */
+XXH_PUBLIC_API void XXH3_generateSecret_fromSeed(
+ XXH_NOESCAPE void *secretBuffer, XXH64_hash_t seed);
+
+/*!
+ * @brief Calculates 64/128-bit seeded variant of XXH3 hash of @p data.
+ *
+ * @param data The block of data to be hashed, at least @p len bytes in
+ * size.
+ * @param len The length of @p data, in bytes.
+ * @param secret The secret data.
+ * @param secretSize The length of @p secret, in bytes.
+ * @param seed The 64-bit seed to alter the hash result predictably.
+ *
+ * These variants generate hash values using either
+ * @p seed for "short" keys (< @ref XXH3_MIDSIZE_MAX = 240 bytes)
+ * or @p secret for "large" keys (>= @ref XXH3_MIDSIZE_MAX).
+ *
+ * This generally benefits speed, compared to `_withSeed()` or `_withSecret()`.
+ * `_withSeed()` has to generate the secret on the fly for "large" keys.
+ * It's fast, but can be perceptible for "not so large" keys (< 1 KB).
+ * `_withSecret()` has to generate the masks on the fly for "small" keys,
+ * which requires more instructions than _withSeed() variants.
+ * Therefore, _withSecretandSeed variant combines the best of both worlds.
+ *
+ * When @p secret has been generated by XXH3_generateSecret_fromSeed(),
+ * this variant produces *exactly* the same results as `_withSeed()` variant,
+ * hence offering only a pure speed benefit on "large" input,
+ * by skipping the need to regenerate the secret for every large input.
+ *
+ * Another usage scenario is to hash the secret to a 64-bit hash value,
+ * for example with XXH3_64bits(), which then becomes the seed,
+ * and then employ both the seed and the secret in _withSecretandSeed().
+ * On top of speed, an added benefit is that each bit in the secret
+ * has a 50% chance to swap each bit in the output, via its impact to the seed.
+ *
+ * This is not guaranteed when using the secret directly in "small data"
+ * scenarios, because only portions of the secret are employed for small data.
+ */
+XXH_PUBLIC_API XXH_PUREF XXH64_hash_t XXH3_64bits_withSecretandSeed(
+ XXH_NOESCAPE const void *data, size_t len, XXH_NOESCAPE const void *secret,
+ size_t secretSize, XXH64_hash_t seed);
+/*!
+ * @brief Calculates 128-bit seeded variant of XXH3 hash of @p data.
+ *
+ * @param input The block of data to be hashed, at least @p len bytes in
+ * size.
+ * @param length The length of @p data, in bytes.
+ * @param secret The secret data.
+ * @param secretSize The length of @p secret, in bytes.
+ * @param seed64 The 64-bit seed to alter the hash result predictably.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @see XXH3_64bits_withSecretandSeed()
+ */
+XXH_PUBLIC_API XXH_PUREF XXH128_hash_t XXH3_128bits_withSecretandSeed(
+ XXH_NOESCAPE const void *input, size_t length,
+ XXH_NOESCAPE const void *secret, size_t secretSize, XXH64_hash_t seed64);
+ #ifndef XXH_NO_STREAM
+/*!
+ * @brief Resets an @ref XXH3_state_t with secret data to begin a new hash.
+ *
+ * @param statePtr A pointer to an @ref XXH3_state_t allocated with @ref
+ * XXH3_createState().
+ * @param secret The secret data.
+ * @param secretSize The length of @p secret, in bytes.
+ * @param seed64 The 64-bit seed to alter the hash result predictably.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @see XXH3_64bits_withSecretandSeed()
+ */
+XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset_withSecretandSeed(
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *secret,
+ size_t secretSize, XXH64_hash_t seed64);
+/*!
+ * @brief Resets an @ref XXH3_state_t with secret data to begin a new hash.
+ *
+ * @param statePtr A pointer to an @ref XXH3_state_t allocated with @ref
+ * XXH3_createState().
+ * @param secret The secret data.
+ * @param secretSize The length of @p secret, in bytes.
+ * @param seed64 The 64-bit seed to alter the hash result predictably.
+ *
+ * @return @ref XXH_OK on success.
+ * @return @ref XXH_ERROR on failure.
+ *
+ * @see XXH3_64bits_withSecretandSeed()
+ */
+XXH_PUBLIC_API XXH_errorcode XXH3_128bits_reset_withSecretandSeed(
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *secret,
+ size_t secretSize, XXH64_hash_t seed64);
+ #endif /* !XXH_NO_STREAM */
+
+ #endif /* !XXH_NO_XXH3 */
#endif /* XXH_NO_LONG_LONG */
#if defined(XXH_INLINE_ALL) || defined(XXH_PRIVATE_API)
#define XXH_IMPLEMENTATION
@@ -1291,7 +2206,7 @@ XXH_PUBLIC_API XXH128_hash_t XXH128(const void *data, size_t len,
/*!
* @brief Define this to disable 64-bit code.
*
- * Useful if only using the @ref xxh32_family and you have a strict C90
+ * Useful if only using the @ref XXH32_family and you have a strict C90
* compiler.
*/
#define XXH_NO_LONG_LONG
@@ -1315,7 +2230,7 @@ XXH_PUBLIC_API XXH128_hash_t XXH128(const void *data, size_t len,
* Use `memcpy()`. Safe and portable. Note that most modern compilers
* will eliminate the function call and treat it as an unaligned access.
*
- * - `XXH_FORCE_MEMORY_ACCESS=1`: `__attribute__((packed))`
+ * - `XXH_FORCE_MEMORY_ACCESS=1`: `__attribute__((aligned(1)))`
* @par
* Depends on compiler extensions and is therefore not portable.
* This method is safe _if_ your compiler supports it,
@@ -1336,30 +2251,50 @@ XXH_PUBLIC_API XXH128_hash_t XXH128(const void *data, size_t len,
* big-endian systems which lack a native byteswap instruction. However,
* some compilers will emit literal byteshifts even if the target supports
* unaligned access.
- * .
+ *
*
* @warning
* Methods 1 and 2 rely on implementation-defined behavior. Use these with
* care, as what works on one compiler/platform/optimization level may
* cause another to read garbage data or even crash.
*
- * See https://stackoverflow.com/a/32095106/646947 for details.
+ * See
+ * https://fastcompression.blogspot.com/2015/08/accessing-unaligned-memory.html
+ * for details.
*
* Prefer these methods in priority order (0 > 3 > 1 > 2)
*/
#define XXH_FORCE_MEMORY_ACCESS 0
+
/*!
- * @def XXH_ACCEPT_NULL_INPUT_POINTER
- * @brief Whether to add explicit `NULL` checks.
+ * @def XXH_SIZE_OPT
+ * @brief Controls how much xxHash optimizes for size.
+ *
+ * xxHash, when compiled, tends to result in a rather large binary size.
+ * This is mostly due to heavy usage to forced inlining and constant folding
+ * of the
+ * @ref XXH3_family to increase performance.
*
- * If the input pointer is `NULL` and the length is non-zero, xxHash's
- * default behavior is to dereference it, triggering a segfault.
+ * However, some developers prefer size over speed. This option can
+ * significantly reduce the size of the generated code. When using the `-Os`
+ * or `-Oz` options on GCC or Clang, this is defined to 1 by default,
+ * otherwise it is defined to 0.
*
- * When this macro is enabled, xxHash actively checks the input for a null
- * pointer. If it is, the result for null input pointers is the same as a
- * zero-length input.
+ * Most of these size optimizations can be controlled manually.
+ *
+ * This is a number from 0-2.
+ * - `XXH_SIZE_OPT` == 0: Default. xxHash makes no size optimizations.
+ * Speed comes first.
+ * - `XXH_SIZE_OPT` == 1: Default for `-Os` and `-Oz`. xxHash is more
+ * conservative and disables hacks that increase code size. It implies
+ * the options @ref XXH_NO_INLINE_HINTS == 1, @ref XXH_FORCE_ALIGN_CHECK ==
+ * 0, and @ref XXH3_NEON_LANES == 8 if they are not already defined.
+ * - `XXH_SIZE_OPT` == 2: xxHash tries to make itself as small as possible.
+ * Performance may cry. For example, the single shot functions just use
+ * the streaming API.
*/
- #define XXH_ACCEPT_NULL_INPUT_POINTER 0
+ #define XXH_SIZE_OPT 0
+
/*!
* @def XXH_FORCE_ALIGN_CHECK
* @brief If defined to non-zero, adds a special path for aligned inputs
@@ -1381,8 +2316,10 @@ XXH_PUBLIC_API XXH128_hash_t XXH128(const void *data, size_t len,
*
* In these cases, the alignment check can be removed by setting this macro
* to 0. Then the code will always use unaligned memory access. Align check
- * is automatically disabled on x86, x64 & arm64, which are platforms known
- * to offer good unaligned memory accesses performance.
+ * is automatically disabled on x86, x64, ARM64, and some ARM chips which
+ * are platforms known to offer good unaligned memory accesses performance.
+ *
+ * It is also disabled by default when @ref XXH_SIZE_OPT >= 1.
*
* This option does not affect XXH3 (only XXH32 and XXH64).
*/
@@ -1405,24 +2342,39 @@ XXH_PUBLIC_API XXH128_hash_t XXH128(const void *data, size_t len,
* XXH_NO_INLINE_HINTS marks all internal functions as static, giving the
* compiler full control on whether to inline or not.
*
- * When not optimizing (-O0), optimizing for size (-Os, -Oz), or using
- * -fno-inline with GCC or Clang, this will automatically be defined.
+ * When not optimizing (-O0), using `-fno-inline` with GCC or Clang, or if
+ * @ref XXH_SIZE_OPT >= 1, this will automatically be defined.
*/
#define XXH_NO_INLINE_HINTS 0
/*!
- * @def XXH_REROLL
- * @brief Whether to reroll `XXH32_finalize`.
+ * @def XXH3_INLINE_SECRET
+ * @brief Determines whether to inline the XXH3 withSecret code.
+ *
+ * When the secret size is known, the compiler can improve the performance
+ * of XXH3_64bits_withSecret() and XXH3_128bits_withSecret().
+ *
+ * However, if the secret size is not known, it doesn't have any benefit.
+ * This happens when xxHash is compiled into a global symbol. Therefore, if
+ * @ref XXH_INLINE_ALL is *not* defined, this will be defined to 0.
*
- * For performance, `XXH32_finalize` uses an unrolled loop
- * in the form of a switch statement.
+ * Additionally, this defaults to 0 on GCC 12+, which has an issue with
+ * function pointers that are *sometimes* force inline on -Og, and it is
+ * impossible to automatically detect this optimization level.
+ */
+ #define XXH3_INLINE_SECRET 0
+
+ /*!
+ * @def XXH32_ENDJMP
+ * @brief Whether to use a jump for `XXH32_finalize`.
*
- * This is not always desirable, as it generates larger code,
- * and depending on the architecture, may even be slower
+ * For performance, `XXH32_finalize` uses multiple branches in the
+ * finalizer. This is generally preferable for performance, but depending on
+ * exact architecture, a jmp may be preferable.
*
- * This is automatically defined with `-Os`/`-Oz` on GCC and Clang.
+ * This setting is only possibly making a difference for very small inputs.
*/
- #define XXH_REROLL 0
+ #define XXH32_ENDJMP 0
/*!
* @internal
@@ -1434,6 +2386,18 @@ XXH_PUBLIC_API XXH128_hash_t XXH128(const void *data, size_t len,
*/
#define XXH_OLD_NAMES
#undef XXH_OLD_NAMES /* don't actually use, it is ugly. */
+
+ /*!
+ * @def XXH_NO_STREAM
+ * @brief Disables the streaming API.
+ *
+ * When xxHash is not inlined and the streaming functions are not used,
+ * disabling the streaming functions can improve code size significantly,
+ * especially with the @ref XXH3_family which tends to make constant folded
+ * copies of itself.
+ */
+ #define XXH_NO_STREAM
+ #undef XXH_NO_STREAM /* don't actually */
#endif /* XXH_DOXYGEN */
/*!
* @}
@@ -1441,24 +2405,31 @@ XXH_PUBLIC_API XXH128_hash_t XXH128(const void *data, size_t len,
#ifndef XXH_FORCE_MEMORY_ACCESS /* can be defined externally, on command \
line for example */
- /* prefer __packed__ structures (method 1) for gcc on armv7+ and mips */
- #if !defined(__clang__) && \
- ((defined(__INTEL_COMPILER) && !defined(_WIN32)) || \
- (defined(__GNUC__) && \
- ((defined(__ARM_ARCH) && __ARM_ARCH >= 7) || \
- (defined(__mips__) && (__mips <= 5 || __mips_isa_rev < 6) && \
- (!defined(__mips16) || defined(__mips_mips16e2))))))
+ /* prefer __packed__ structures (method 1) for GCC
+ * < ARMv7 with unaligned access (e.g. Raspbian armhf) still uses byte
+ * shifting, so we use memcpy which for some reason does unaligned loads. */
+ #if defined(__GNUC__) && !(defined(__ARM_ARCH) && __ARM_ARCH < 7 && \
+ defined(__ARM_FEATURE_UNALIGNED))
#define XXH_FORCE_MEMORY_ACCESS 1
#endif
#endif
- #ifndef XXH_ACCEPT_NULL_INPUT_POINTER /* can be defined externally */
- #define XXH_ACCEPT_NULL_INPUT_POINTER 0
+ #ifndef XXH_SIZE_OPT
+ /* default to 1 for -Os or -Oz */
+ #if (defined(__GNUC__) || defined(__clang__)) && defined(__OPTIMIZE_SIZE__)
+ #define XXH_SIZE_OPT 1
+ #else
+ #define XXH_SIZE_OPT 0
+ #endif
#endif
#ifndef XXH_FORCE_ALIGN_CHECK /* can be defined externally */
- #if defined(__i386) || defined(__x86_64__) || defined(__aarch64__) || \
- defined(_M_IX86) || defined(_M_X64) || defined(_M_ARM64) /* visual */
+ /* don't check on sizeopt, x86, aarch64, or arm when unaligned access is
+ * available */
+ #if XXH_SIZE_OPT >= 1 || defined(__i386) || defined(__x86_64__) || \
+ defined(__aarch64__) || defined(__ARM_FEATURE_UNALIGNED) || \
+ defined(_M_IX86) || defined(_M_X64) || defined(_M_ARM64) || \
+ defined(_M_ARM) /* visual */
#define XXH_FORCE_ALIGN_CHECK 0
#else
#define XXH_FORCE_ALIGN_CHECK 1
@@ -1466,24 +2437,27 @@ XXH_PUBLIC_API XXH128_hash_t XXH128(const void *data, size_t len,
#endif
#ifndef XXH_NO_INLINE_HINTS
- #if defined(__OPTIMIZE_SIZE__) /* -Os, -Oz */ \
- || defined(__NO_INLINE__) /* -O0, -fno-inline */
+ #if XXH_SIZE_OPT >= 1 || defined(__NO_INLINE__) /* -O0, -fno-inline */
#define XXH_NO_INLINE_HINTS 1
#else
#define XXH_NO_INLINE_HINTS 0
#endif
#endif
- #ifndef XXH_REROLL
- #if defined(__OPTIMIZE_SIZE__) /* -Os, -Oz */ || \
- (defined(__GNUC__) && !defined(__clang__))
- /* The if/then loop is preferable to switch/case on gcc (on x64) */
- #define XXH_REROLL 1
+ #ifndef XXH3_INLINE_SECRET
+ #if (defined(__GNUC__) && !defined(__clang__) && __GNUC__ >= 12) || \
+ !defined(XXH_INLINE_ALL)
+ #define XXH3_INLINE_SECRET 0
#else
- #define XXH_REROLL 0
+ #define XXH3_INLINE_SECRET 1
#endif
#endif
+ #ifndef XXH32_ENDJMP
+ /* generally preferable for performance */
+ #define XXH32_ENDJMP 0
+ #endif
+
/*!
* @defgroup impl Implementation
* @{
@@ -1493,17 +2467,45 @@ XXH_PUBLIC_API XXH128_hash_t XXH128(const void *data, size_t len,
/* *************************************
* Includes & Memory related functions
***************************************/
+ #if defined(XXH_NO_STREAM)
+ /* nothing */
+ #elif defined(XXH_NO_STDLIB)
+
+/* When requesting to disable any mention of stdlib,
+ * the library loses the ability to invoked malloc / free.
+ * In practice, it means that functions like `XXH*_createState()`
+ * will always fail, and return NULL.
+ * This flag is useful in situations where
+ * xxhash.h is integrated into some kernel, embedded or limited environment
+ * without access to dynamic allocation.
+ */
+
+static XXH_CONSTF void *XXH_malloc(size_t s) {
+
+ (void)s;
+ return NULL;
+
+}
+
+static void XXH_free(void *p) {
+
+ (void)p;
+
+}
+
+ #else
+
/*
* Modify the local functions below should you wish to use
* different memory routines for malloc() and free()
*/
- #include <stdlib.h>
+ #include <stdlib.h>
/*!
* @internal
* @brief Modify this function to use a different routine than malloc().
*/
-static void *XXH_malloc(size_t s) {
+static XXH_MALLOCF void *XXH_malloc(size_t s) {
return malloc(s);
@@ -1519,6 +2521,8 @@ static void XXH_free(void *p) {
}
+ #endif /* XXH_NO_STDLIB */
+
#include <string.h>
/*!
@@ -1542,20 +2546,20 @@ static void *XXH_memcpy(void *dest, const void *src, size_t size) {
#endif
#if XXH_NO_INLINE_HINTS /* disable inlining hints */
- #if defined(__GNUC__)
+ #if defined(__GNUC__) || defined(__clang__)
#define XXH_FORCE_INLINE static __attribute__((unused))
#else
#define XXH_FORCE_INLINE static
#endif
#define XXH_NO_INLINE static
/* enable inlining hints */
- #elif defined(_MSC_VER) /* Visual Studio */
- #define XXH_FORCE_INLINE static __forceinline
- #define XXH_NO_INLINE static __declspec(noinline)
- #elif defined(__GNUC__)
+ #elif defined(__GNUC__) || defined(__clang__)
#define XXH_FORCE_INLINE \
static __inline__ __attribute__((always_inline, unused))
#define XXH_NO_INLINE static __attribute__((noinline))
+ #elif defined(_MSC_VER) /* Visual Studio */
+ #define XXH_FORCE_INLINE static __forceinline
+ #define XXH_NO_INLINE static __declspec(noinline)
#elif defined(__cplusplus) || \
(defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)) /* C99 */
#define XXH_FORCE_INLINE static inline
@@ -1565,6 +2569,12 @@ static void *XXH_memcpy(void *dest, const void *src, size_t size) {
#define XXH_NO_INLINE static
#endif
+ #if XXH3_INLINE_SECRET
+ #define XXH3_WITH_SECRET_INLINE XXH_FORCE_INLINE
+ #else
+ #define XXH3_WITH_SECRET_INLINE XXH_NO_INLINE
+ #endif
+
/* *************************************
* Debug
***************************************/
@@ -1588,17 +2598,20 @@ static void *XXH_memcpy(void *dest, const void *src, size_t size) {
#include <assert.h> /* note: can still be disabled with NDEBUG */
#define XXH_ASSERT(c) assert(c)
#else
- #define XXH_ASSERT(c) ((void)0)
+ #if defined(__INTEL_COMPILER)
+ #define XXH_ASSERT(c) XXH_ASSUME((unsigned char)(c))
+ #else
+ #define XXH_ASSERT(c) XXH_ASSUME(c)
+ #endif
#endif
/* note: use after variable declarations */
#ifndef XXH_STATIC_ASSERT
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) /* C11 */
- #include <assert.h>
#define XXH_STATIC_ASSERT_WITH_MESSAGE(c, m) \
do { \
\
- static_assert((c), m); \
+ _Static_assert((c), m); \
\
} while (0)
@@ -1642,12 +2655,20 @@ static void *XXH_memcpy(void *dest, const void *src, size_t size) {
* We also use it to prevent unwanted constant folding for AArch64 in
* XXH3_initCustomSecret_scalar().
*/
- #ifdef __GNUC__
- #define XXH_COMPILER_GUARD(var) __asm__ __volatile__("" : "+r"(var))
+ #if defined(__GNUC__) || defined(__clang__)
+ #define XXH_COMPILER_GUARD(var) __asm__("" : "+r"(var))
#else
#define XXH_COMPILER_GUARD(var) ((void)0)
#endif
+ /* Specifically for NEON vectors which use the "w" constraint, on
+ * Clang. */
+ #if defined(__clang__) && defined(__ARM_ARCH) && !defined(__wasm__)
+ #define XXH_COMPILER_GUARD_CLANG_NEON(var) __asm__("" : "+w"(var))
+ #else
+ #define XXH_COMPILER_GUARD_CLANG_NEON(var) ((void)0)
+ #endif
+
/* *************************************
* Basic Types
***************************************/
@@ -1662,6 +2683,8 @@ typedef unsigned char xxh_u8;
typedef XXH32_hash_t xxh_u32;
#ifdef XXH_OLD_NAMES
+ #warning \
+ "XXH_OLD_NAMES is planned to be removed starting v0.9. If the program depends on it, consider moving away from it by employing newer type names directly"
#define BYTE xxh_u8
#define U8 xxh_u8
#define U32 xxh_u32
@@ -1739,10 +2762,11 @@ static xxh_u32 XXH_read32(const void *memPtr) {
#elif (defined(XXH_FORCE_MEMORY_ACCESS) && (XXH_FORCE_MEMORY_ACCESS == 1))
/*
- * __pack instructions are safer but compiler specific, hence potentially
- * problematic for some compilers.
- *
- * Currently only defined for GCC and ICC.
+ * __attribute__((aligned(1))) is supported by gcc and clang. Originally the
+ * documentation claimed that it only increased the alignment, but actually
+ * it can decrease it on gcc, clang, and icc:
+ * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69502,
+ * https://gcc.godbolt.org/z/xYez1j67Y.
*/
#ifdef XXH_OLD_NAMES
typedef union {
@@ -1754,13 +2778,8 @@ typedef union {
#endif
static xxh_u32 XXH_read32(const void *ptr) {
- typedef union {
-
- xxh_u32 u32;
-
- } __attribute__((packed)) xxh_unalign;
-
- return ((const xxh_unalign *)ptr)->u32;
+ typedef __attribute__((aligned(1))) xxh_u32 xxh_unalign32;
+ return *((const xxh_unalign32 *)ptr);
}
@@ -1768,12 +2787,13 @@ static xxh_u32 XXH_read32(const void *ptr) {
/*
* Portable and safe solution. Generally efficient.
- * see: https://stackoverflow.com/a/32095106/646947
+ * see:
+ * https://fastcompression.blogspot.com/2015/08/accessing-unaligned-memory.html
*/
static xxh_u32 XXH_read32(const void *memPtr) {
xxh_u32 val;
- memcpy(&val, memPtr, sizeof(val));
+ XXH_memcpy(&val, memPtr, sizeof(val));
return val;
}
@@ -1849,6 +2869,50 @@ static int XXH_isLittleEndian(void) {
#define XXH_HAS_BUILTIN(x) 0
#endif
+/*
+ * C23 and future versions have standard "unreachable()".
+ * Once it has been implemented reliably we can add it as an
+ * additional case:
+ *
+ * ```
+ * #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= XXH_C23_VN)
+ * # include <stddef.h>
+ * # ifdef unreachable
+ * # define XXH_UNREACHABLE() unreachable()
+ * # endif
+ * #endif
+ * ```
+ *
+ * Note C++23 also has std::unreachable() which can be detected
+ * as follows:
+ * ```
+ * #if defined(__cpp_lib_unreachable) && (__cpp_lib_unreachable >= 202202L)
+ * # include <utility>
+ * # define XXH_UNREACHABLE() std::unreachable()
+ * #endif
+ * ```
+ * NB: `__cpp_lib_unreachable` is defined in the `<version>` header.
+ * We don't use that as including `<utility>` in `extern "C"` blocks
+ * doesn't work on GCC12
+ */
+
+ #if XXH_HAS_BUILTIN(__builtin_unreachable)
+ #define XXH_UNREACHABLE() __builtin_unreachable()
+
+ #elif defined(_MSC_VER)
+ #define XXH_UNREACHABLE() __assume(0)
+
+ #else
+ #define XXH_UNREACHABLE()
+ #endif
+
+ #if XXH_HAS_BUILTIN(__builtin_assume)
+ #define XXH_ASSUME(c) __builtin_assume(c)
+ #else
+ #define XXH_ASSUME(c) \
+ if (!(c)) { XXH_UNREACHABLE(); }
+ #endif
+
/*!
* @internal
* @def XXH_rotl32(x,r)
@@ -1982,8 +3046,10 @@ XXH_PUBLIC_API unsigned XXH_versionNumber(void) {
*********************************************************************/
/*!
* @}
- * @defgroup xxh32_impl XXH32 implementation
+ * @defgroup XXH32_impl XXH32 implementation
* @ingroup impl
+ *
+ * Details on the XXH32 implementation.
* @{
*/
@@ -2018,7 +3084,8 @@ static xxh_u32 XXH32_round(xxh_u32 acc, xxh_u32 input) {
acc += input * XXH_PRIME32_2;
acc = XXH_rotl32(acc, 13);
acc *= XXH_PRIME32_1;
- #if (defined(__SSE4_1__) || defined(__aarch64__)) && \
+ #if (defined(__SSE4_1__) || defined(__aarch64__) || \
+ defined(__wasm_simd128__)) && \
!defined(XXH_ENABLE_AUTOVECTORIZE)
/*
* UGLY HACK:
@@ -2049,9 +3116,12 @@ static xxh_u32 XXH32_round(xxh_u32 acc, xxh_u32 input) {
* can load data, while v3 can multiply. SSE forces them to operate
* together.
*
- * This is also enabled on AArch64, as Clang autovectorizes it incorrectly
- * and it is pointless writing a NEON implementation that is basically the
- * same speed as scalar for XXH32.
+ * This is also enabled on AArch64, as Clang is *very aggressive* in
+ * vectorizing the loop. NEON is only faster on the A53, and with the newer
+ * cores, it is less than half the speed.
+ *
+ * Additionally, this is used on WASM SIMD128 because it JITs to the same
+ * SIMD instructions and has the same issue.
*/
XXH_COMPILER_GUARD(acc);
#endif
@@ -2066,39 +3136,22 @@ static xxh_u32 XXH32_round(xxh_u32 acc, xxh_u32 input) {
* The final mix ensures that all input bits have a chance to impact any bit in
* the output digest, resulting in an unbiased distribution.
*
- * @param h32 The hash to avalanche.
+ * @param hash The hash to avalanche.
* @return The avalanched hash.
*/
-static xxh_u32 XXH32_avalanche(xxh_u32 h32) {
+static xxh_u32 XXH32_avalanche(xxh_u32 hash) {
- h32 ^= h32 >> 15;
- h32 *= XXH_PRIME32_2;
- h32 ^= h32 >> 13;
- h32 *= XXH_PRIME32_3;
- h32 ^= h32 >> 16;
- return (h32);
+ hash ^= hash >> 15;
+ hash *= XXH_PRIME32_2;
+ hash ^= hash >> 13;
+ hash *= XXH_PRIME32_3;
+ hash ^= hash >> 16;
+ return hash;
}
#define XXH_get32bits(p) XXH_readLE32_align(p, align)
- #define XXH_PROCESS1 \
- do { \
- \
- h32 += (*ptr++) * XXH_PRIME32_5; \
- h32 = XXH_rotl32(h32, 11) * XXH_PRIME32_1; \
- \
- } while (0)
-
- #define XXH_PROCESS4 \
- do { \
- \
- h32 += XXH_get32bits(ptr) * XXH_PRIME32_3; \
- ptr += 4; \
- h32 = XXH_rotl32(h32, 17) * XXH_PRIME32_4; \
- \
- } while (0)
-
/*!
* @internal
* @brief Processes the last 0-15 bytes of @p ptr.
@@ -2107,17 +3160,37 @@ static xxh_u32 XXH32_avalanche(xxh_u32 h32) {
* This final stage will digest them to ensure that all input bytes are present
* in the final mix.
*
- * @param h32 The hash to finalize.
+ * @param hash The hash to finalize.
* @param ptr The pointer to the remaining input.
* @param len The remaining length, modulo 16.
* @param align Whether @p ptr is aligned.
* @return The finalized hash.
+ * @see XXH64_finalize().
*/
-static xxh_u32 XXH32_finalize(xxh_u32 h32, const xxh_u8 *ptr, size_t len,
- XXH_alignment align) {
+static XXH_PUREF xxh_u32 XXH32_finalize(xxh_u32 hash, const xxh_u8 *ptr,
+ size_t len, XXH_alignment align) {
+\
+ #define XXH_PROCESS1 \
+ do { \
+ \
+ hash += (*ptr++) * XXH_PRIME32_5; \
+ hash = XXH_rotl32(hash, 11) * XXH_PRIME32_1; \
+ \
+ } while (0)
+
+ #define XXH_PROCESS4 \
+ do { \
+ \
+ hash += XXH_get32bits(ptr) * XXH_PRIME32_3; \
+ ptr += 4; \
+ hash = XXH_rotl32(hash, 17) * XXH_PRIME32_4; \
+ \
+ } while (0)
- /* Compact rerolled version */
- if (XXH_REROLL) {
+ if (ptr == NULL) XXH_ASSERT(len == 0);
+
+ /* Compact rerolled version; generally faster */
+ if (!XXH32_ENDJMP) {
len &= 15;
while (len >= 4) {
@@ -2134,7 +3207,7 @@ static xxh_u32 XXH32_finalize(xxh_u32 h32, const xxh_u8 *ptr, size_t len,
}
- return XXH32_avalanche(h32);
+ return XXH32_avalanche(hash);
} else {
@@ -2142,62 +3215,62 @@ static xxh_u32 XXH32_finalize(xxh_u32 h32, const xxh_u8 *ptr, size_t len,
case 12:
XXH_PROCESS4;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 8:
XXH_PROCESS4;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 4:
XXH_PROCESS4;
- return XXH32_avalanche(h32);
+ return XXH32_avalanche(hash);
case 13:
XXH_PROCESS4;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 9:
XXH_PROCESS4;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 5:
XXH_PROCESS4;
XXH_PROCESS1;
- return XXH32_avalanche(h32);
+ return XXH32_avalanche(hash);
case 14:
XXH_PROCESS4;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 10:
XXH_PROCESS4;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 6:
XXH_PROCESS4;
XXH_PROCESS1;
XXH_PROCESS1;
- return XXH32_avalanche(h32);
+ return XXH32_avalanche(hash);
case 15:
XXH_PROCESS4;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 11:
XXH_PROCESS4;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 7:
XXH_PROCESS4;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 3:
XXH_PROCESS1;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 2:
XXH_PROCESS1;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 1:
XXH_PROCESS1;
- XXH_FALLTHROUGH;
+ XXH_FALLTHROUGH; /* fallthrough */
case 0:
- return XXH32_avalanche(h32);
+ return XXH32_avalanche(hash);
}
XXH_ASSERT(0);
- return h32; /* reaching this point is deemed impossible */
+ return hash; /* reaching this point is deemed impossible */
}
@@ -2215,29 +3288,21 @@ static xxh_u32 XXH32_finalize(xxh_u32 h32, const xxh_u8 *ptr, size_t len,
* @internal
* @brief The implementation for @ref XXH32().
*
- * @param input, len, seed Directly passed from @ref XXH32().
+ * @param input , len , seed Directly passed from @ref XXH32().
* @param align Whether @p input is aligned.
* @return The calculated hash.
*/
-XXH_FORCE_INLINE xxh_u32 XXH32_endian_align(const xxh_u8 *input, size_t len,
- xxh_u32 seed, XXH_alignment align) {
-
- const xxh_u8 *bEnd = input ? input + len : NULL;
- xxh_u32 h32;
+XXH_FORCE_INLINE XXH_PUREF xxh_u32 XXH32_endian_align(const xxh_u8 *input,
+ size_t len, xxh_u32 seed,
+ XXH_alignment align) {
- #if defined(XXH_ACCEPT_NULL_INPUT_POINTER) && \
- (XXH_ACCEPT_NULL_INPUT_POINTER >= 1)
- if (input == NULL) {
-
- len = 0;
- bEnd = input = (const xxh_u8 *)(size_t)16;
-
- }
+ xxh_u32 h32;
- #endif
+ if (input == NULL) XXH_ASSERT(len == 0);
if (len >= 16) {
+ const xxh_u8 *const bEnd = input + len;
const xxh_u8 *const limit = bEnd - 15;
xxh_u32 v1 = seed + XXH_PRIME32_1 + XXH_PRIME32_2;
xxh_u32 v2 = seed + XXH_PRIME32_2;
@@ -2272,16 +3337,17 @@ XXH_FORCE_INLINE xxh_u32 XXH32_endian_align(const xxh_u8 *input, size_t len,
}
-/*! @ingroup xxh32_family */
+/*! @ingroup XXH32_family */
XXH_PUBLIC_API XXH32_hash_t XXH32(const void *input, size_t len,
XXH32_hash_t seed) {
- #if 0
- /* Simple version, good for code maintenance, but unfortunately slow for small inputs */
- XXH32_state_t state;
- XXH32_reset(&state, seed);
- XXH32_update(&state, (const xxh_u8*)input, len);
- return XXH32_digest(&state);
+ #if !defined(XXH_NO_STREAM) && XXH_SIZE_OPT >= 2
+ /* Simple version, good for code maintenance, but unfortunately slow for small
+ * inputs */
+ XXH32_state_t state;
+ XXH32_reset(&state, seed);
+ XXH32_update(&state, (const xxh_u8 *)input, len);
+ return XXH32_digest(&state);
#else
if (XXH_FORCE_ALIGN_CHECK) {
@@ -2298,17 +3364,16 @@ XXH_PUBLIC_API XXH32_hash_t XXH32(const void *input, size_t len,
}
-/******* Hash streaming *******/
-/*!
- * @ingroup xxh32_family
- */
+ /******* Hash streaming *******/
+ #ifndef XXH_NO_STREAM
+/*! @ingroup XXH32_family */
XXH_PUBLIC_API XXH32_state_t *XXH32_createState(void) {
return (XXH32_state_t *)XXH_malloc(sizeof(XXH32_state_t));
}
-/*! @ingroup xxh32_family */
+/*! @ingroup XXH32_family */
XXH_PUBLIC_API XXH_errorcode XXH32_freeState(XXH32_state_t *statePtr) {
XXH_free(statePtr);
@@ -2316,42 +3381,38 @@ XXH_PUBLIC_API XXH_errorcode XXH32_freeState(XXH32_state_t *statePtr) {
}
-/*! @ingroup xxh32_family */
+/*! @ingroup XXH32_family */
XXH_PUBLIC_API void XXH32_copyState(XXH32_state_t *dstState,
const XXH32_state_t *srcState) {
- memcpy(dstState, srcState, sizeof(*dstState));
+ XXH_memcpy(dstState, srcState, sizeof(*dstState));
}
-/*! @ingroup xxh32_family */
+/*! @ingroup XXH32_family */
XXH_PUBLIC_API XXH_errorcode XXH32_reset(XXH32_state_t *statePtr,
XXH32_hash_t seed) {
- XXH32_state_t state; /* using a local state to memcpy() in order to avoid
- strict-aliasing warnings */
- memset(&state, 0, sizeof(state));
- state.v1 = seed + XXH_PRIME32_1 + XXH_PRIME32_2;
- state.v2 = seed + XXH_PRIME32_2;
- state.v3 = seed + 0;
- state.v4 = seed - XXH_PRIME32_1;
- /* do not write into reserved, planned to be removed in a future version */
- memcpy(statePtr, &state, sizeof(state) - sizeof(state.reserved));
+ XXH_ASSERT(statePtr != NULL);
+ memset(statePtr, 0, sizeof(*statePtr));
+ statePtr->v[0] = seed + XXH_PRIME32_1 + XXH_PRIME32_2;
+ statePtr->v[1] = seed + XXH_PRIME32_2;
+ statePtr->v[2] = seed + 0;
+ statePtr->v[3] = seed - XXH_PRIME32_1;
return XXH_OK;
}
-/*! @ingroup xxh32_family */
+/*! @ingroup XXH32_family */
XXH_PUBLIC_API XXH_errorcode XXH32_update(XXH32_state_t *state,
const void *input, size_t len) {
- if (input == NULL)
- #if defined(XXH_ACCEPT_NULL_INPUT_POINTER) && \
- (XXH_ACCEPT_NULL_INPUT_POINTER >= 1)
+ if (input == NULL) {
+
+ XXH_ASSERT(len == 0);
return XXH_OK;
- #else
- return XXH_ERROR;
- #endif
+
+ }
{
@@ -2375,13 +3436,13 @@ XXH_PUBLIC_API XXH_errorcode XXH32_update(XXH32_state_t *state,
{
const xxh_u32 *p32 = state->mem32;
- state->v1 = XXH32_round(state->v1, XXH_readLE32(p32));
+ state->v[0] = XXH32_round(state->v[0], XXH_readLE32(p32));
p32++;
- state->v2 = XXH32_round(state->v2, XXH_readLE32(p32));
+ state->v[1] = XXH32_round(state->v[1], XXH_readLE32(p32));
p32++;
- state->v3 = XXH32_round(state->v3, XXH_readLE32(p32));
+ state->v[2] = XXH32_round(state->v[2], XXH_readLE32(p32));
p32++;
- state->v4 = XXH32_round(state->v4, XXH_readLE32(p32));
+ state->v[3] = XXH32_round(state->v[3], XXH_readLE32(p32));
}
@@ -2393,29 +3454,20 @@ XXH_PUBLIC_API XXH_errorcode XXH32_update(XXH32_state_t *state,
if (p <= bEnd - 16) {
const xxh_u8 *const limit = bEnd - 16;
- xxh_u32 v1 = state->v1;
- xxh_u32 v2 = state->v2;
- xxh_u32 v3 = state->v3;
- xxh_u32 v4 = state->v4;
do {
- v1 = XXH32_round(v1, XXH_readLE32(p));
+ state->v[0] = XXH32_round(state->v[0], XXH_readLE32(p));
p += 4;
- v2 = XXH32_round(v2, XXH_readLE32(p));
+ state->v[1] = XXH32_round(state->v[1], XXH_readLE32(p));
p += 4;
- v3 = XXH32_round(v3, XXH_readLE32(p));
+ state->v[2] = XXH32_round(state->v[2], XXH_readLE32(p));
p += 4;
- v4 = XXH32_round(v4, XXH_readLE32(p));
+ state->v[3] = XXH32_round(state->v[3], XXH_readLE32(p));
p += 4;
} while (p <= limit);
- state->v1 = v1;
- state->v2 = v2;
- state->v3 = v3;
- state->v4 = v4;
-
}
if (p < bEnd) {
@@ -2431,19 +3483,19 @@ XXH_PUBLIC_API XXH_errorcode XXH32_update(XXH32_state_t *state,
}
-/*! @ingroup xxh32_family */
+/*! @ingroup XXH32_family */
XXH_PUBLIC_API XXH32_hash_t XXH32_digest(const XXH32_state_t *state) {
xxh_u32 h32;
if (state->large_len) {
- h32 = XXH_rotl32(state->v1, 1) + XXH_rotl32(state->v2, 7) +
- XXH_rotl32(state->v3, 12) + XXH_rotl32(state->v4, 18);
+ h32 = XXH_rotl32(state->v[0], 1) + XXH_rotl32(state->v[1], 7) +
+ XXH_rotl32(state->v[2], 12) + XXH_rotl32(state->v[3], 18);
} else {
- h32 = state->v3 /* == seed */ + XXH_PRIME32_5;
+ h32 = state->v[2] /* == seed */ + XXH_PRIME32_5;
}
@@ -2454,32 +3506,21 @@ XXH_PUBLIC_API XXH32_hash_t XXH32_digest(const XXH32_state_t *state) {
}
+ #endif /* !XXH_NO_STREAM */
+
/******* Canonical representation *******/
-/*!
- * @ingroup xxh32_family
- * The default return values from XXH functions are unsigned 32 and 64 bit
- * integers.
- *
- * The canonical representation uses big endian convention, the same convention
- * as human-readable numbers (large digits first).
- *
- * This way, hash values can be written into a file or buffer, remaining
- * comparable across different systems.
- *
- * The following functions allow transformation of hash values to and from their
- * canonical format.
- */
+/*! @ingroup XXH32_family */
XXH_PUBLIC_API void XXH32_canonicalFromHash(XXH32_canonical_t *dst,
XXH32_hash_t hash) {
XXH_STATIC_ASSERT(sizeof(XXH32_canonical_t) == sizeof(XXH32_hash_t));
if (XXH_CPU_LITTLE_ENDIAN) hash = XXH_swap32(hash);
- memcpy(dst, &hash, sizeof(*dst));
+ XXH_memcpy(dst, &hash, sizeof(*dst));
}
-/*! @ingroup xxh32_family */
+/*! @ingroup XXH32_family */
XXH_PUBLIC_API XXH32_hash_t
XXH32_hashFromCanonical(const XXH32_canonical_t *src) {
@@ -2524,10 +3565,11 @@ static xxh_u64 XXH_read64(const void *memPtr) {
#elif (defined(XXH_FORCE_MEMORY_ACCESS) && (XXH_FORCE_MEMORY_ACCESS == 1))
/*
- * __pack instructions are safer, but compiler specific, hence potentially
- * problematic for some compilers.
- *
- * Currently only defined for GCC and ICC.
+ * __attribute__((aligned(1))) is supported by gcc and clang. Originally
+ * the documentation claimed that it only increased the alignment, but
+ * actually it can decrease it on gcc, clang, and icc:
+ * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69502,
+ * https://gcc.godbolt.org/z/xYez1j67Y.
*/
#ifdef XXH_OLD_NAMES
typedef union {
@@ -2540,14 +3582,8 @@ typedef union {
#endif
static xxh_u64 XXH_read64(const void *ptr) {
- typedef union {
-
- xxh_u32 u32;
- xxh_u64 u64;
-
- } __attribute__((packed)) xxh_unalign64;
-
- return ((const xxh_unalign64 *)ptr)->u64;
+ typedef __attribute__((aligned(1))) xxh_u64 xxh_unalign64;
+ return *((const xxh_unalign64 *)ptr);
}
@@ -2555,12 +3591,13 @@ static xxh_u64 XXH_read64(const void *ptr) {
/*
* Portable and safe solution. Generally efficient.
- * see: https://stackoverflow.com/a/32095106/646947
+ * see:
+ * https://fastcompression.blogspot.com/2015/08/accessing-unaligned-memory.html
*/
static xxh_u64 XXH_read64(const void *memPtr) {
xxh_u64 val;
- memcpy(&val, memPtr, sizeof(val));
+ XXH_memcpy(&val, memPtr, sizeof(val));
return val;
}
@@ -2639,8 +3676,10 @@ XXH_FORCE_INLINE xxh_u64 XXH_readLE64_align(const void *ptr,
/******* xxh64 *******/
/*!
* @}
- * @defgroup xxh64_impl XXH64 implementation
+ * @defgroup XXH64_impl XXH64 implementation
* @ingroup impl
+ *
+ * Details on the XXH64 implementation.
* @{
*/
@@ -2674,6 +3713,7 @@ XXH_FORCE_INLINE xxh_u64 XXH_readLE64_align(const void *ptr,
#define PRIME64_5 XXH_PRIME64_5
#endif
+/*! @copydoc XXH32_round */
static xxh_u64 XXH64_round(xxh_u64 acc, xxh_u64 input) {
acc += input * XXH_PRIME64_2;
@@ -2692,51 +3732,68 @@ static xxh_u64 XXH64_mergeRound(xxh_u64 acc, xxh_u64 val) {
}
-static xxh_u64 XXH64_avalanche(xxh_u64 h64) {
+/*! @copydoc XXH32_avalanche */
+static xxh_u64 XXH64_avalanche(xxh_u64 hash) {
- h64 ^= h64 >> 33;
- h64 *= XXH_PRIME64_2;
- h64 ^= h64 >> 29;
- h64 *= XXH_PRIME64_3;
- h64 ^= h64 >> 32;
- return h64;
+ hash ^= hash >> 33;
+ hash *= XXH_PRIME64_2;
+ hash ^= hash >> 29;
+ hash *= XXH_PRIME64_3;
+ hash ^= hash >> 32;
+ return hash;
}
#define XXH_get64bits(p) XXH_readLE64_align(p, align)
-static xxh_u64 XXH64_finalize(xxh_u64 h64, const xxh_u8 *ptr, size_t len,
- XXH_alignment align) {
+/*!
+ * @internal
+ * @brief Processes the last 0-31 bytes of @p ptr.
+ *
+ * There may be up to 31 bytes remaining to consume from the input.
+ * This final stage will digest them to ensure that all input bytes are present
+ * in the final mix.
+ *
+ * @param hash The hash to finalize.
+ * @param ptr The pointer to the remaining input.
+ * @param len The remaining length, modulo 32.
+ * @param align Whether @p ptr is aligned.
+ * @return The finalized hash
+ * @see XXH32_finalize().
+ */
+static XXH_PUREF xxh_u64 XXH64_finalize(xxh_u64 hash, const xxh_u8 *ptr,
+ size_t len, XXH_alignment align) {
+ if (ptr == NULL) XXH_ASSERT(len == 0);
len &= 31;
while (len >= 8) {
xxh_u64 const k1 = XXH64_round(0, XXH_get64bits(ptr));
ptr += 8;
- h64 ^= k1;
- h64 = XXH_rotl64(h64, 27) * XXH_PRIME64_1 + XXH_PRIME64_4;
+ hash ^= k1;
+ hash = XXH_rotl64(hash, 27) * XXH_PRIME64_1 + XXH_PRIME64_4;
len -= 8;
}
if (len >= 4) {
- h64 ^= (xxh_u64)(XXH_get32bits(ptr)) * XXH_PRIME64_1;
+ hash ^= (xxh_u64)(XXH_get32bits(ptr)) * XXH_PRIME64_1;
ptr += 4;
- h64 = XXH_rotl64(h64, 23) * XXH_PRIME64_2 + XXH_PRIME64_3;
+ hash = XXH_rotl64(hash, 23) * XXH_PRIME64_2 + XXH_PRIME64_3;
len -= 4;
}
while (len > 0) {
- h64 ^= (*ptr++) * XXH_PRIME64_5;
- h64 = XXH_rotl64(h64, 11) * XXH_PRIME64_1;
+ hash ^= (*ptr++) * XXH_PRIME64_5;
+ hash = XXH_rotl64(hash, 11) * XXH_PRIME64_1;
--len;
}
- return XXH64_avalanche(h64);
+ return XXH64_avalanche(hash);
}
@@ -2750,26 +3807,25 @@ static xxh_u64 XXH64_finalize(xxh_u64 h64, const xxh_u8 *ptr, size_t len,
#undef XXH_PROCESS8_64
#endif
-XXH_FORCE_INLINE xxh_u64 XXH64_endian_align(const xxh_u8 *input, size_t len,
- xxh_u64 seed, XXH_alignment align) {
-
- const xxh_u8 *bEnd = input ? input + len : NULL;
- xxh_u64 h64;
-
- #if defined(XXH_ACCEPT_NULL_INPUT_POINTER) && \
- (XXH_ACCEPT_NULL_INPUT_POINTER >= 1)
- if (input == NULL) {
-
- len = 0;
- bEnd = input = (const xxh_u8 *)(size_t)32;
-
- }
+/*!
+ * @internal
+ * @brief The implementation for @ref XXH64().
+ *
+ * @param input , len , seed Directly passed from @ref XXH64().
+ * @param align Whether @p input is aligned.
+ * @return The calculated hash.
+ */
+XXH_FORCE_INLINE XXH_PUREF xxh_u64 XXH64_endian_align(const xxh_u8 *input,
+ size_t len, xxh_u64 seed,
+ XXH_alignment align) {
- #endif
+ xxh_u64 h64;
+ if (input == NULL) XXH_ASSERT(len == 0);
if (len >= 32) {
- const xxh_u8 *const limit = bEnd - 32;
+ const xxh_u8 *const bEnd = input + len;
+ const xxh_u8 *const limit = bEnd - 31;
xxh_u64 v1 = seed + XXH_PRIME64_1 + XXH_PRIME64_2;
xxh_u64 v2 = seed + XXH_PRIME64_2;
xxh_u64 v3 = seed + 0;
@@ -2786,7 +3842,7 @@ XXH_FORCE_INLINE xxh_u64 XXH64_endian_align(const xxh_u8 *input, size_t len,
v4 = XXH64_round(v4, XXH_get64bits(input));
input += 8;
- } while (input <= limit);
+ } while (input < limit);
h64 = XXH_rotl64(v1, 1) + XXH_rotl64(v2, 7) + XXH_rotl64(v3, 12) +
XXH_rotl64(v4, 18);
@@ -2807,16 +3863,17 @@ XXH_FORCE_INLINE xxh_u64 XXH64_endian_align(const xxh_u8 *input, size_t len,
}
-/*! @ingroup xxh64_family */
-XXH_PUBLIC_API XXH64_hash_t XXH64(const void *input, size_t len,
+/*! @ingroup XXH64_family */
+XXH_PUBLIC_API XXH64_hash_t XXH64(XXH_NOESCAPE const void *input, size_t len,
XXH64_hash_t seed) {
- #if 0
- /* Simple version, good for code maintenance, but unfortunately slow for small inputs */
- XXH64_state_t state;
- XXH64_reset(&state, seed);
- XXH64_update(&state, (const xxh_u8*)input, len);
- return XXH64_digest(&state);
+ #if !defined(XXH_NO_STREAM) && XXH_SIZE_OPT >= 2
+ /* Simple version, good for code maintenance, but unfortunately slow for small
+ * inputs */
+ XXH64_state_t state;
+ XXH64_reset(&state, seed);
+ XXH64_update(&state, (const xxh_u8 *)input, len);
+ return XXH64_digest(&state);
#else
if (XXH_FORCE_ALIGN_CHECK) {
@@ -2834,16 +3891,16 @@ XXH_PUBLIC_API XXH64_hash_t XXH64(const void *input, size_t len,
}
-/******* Hash Streaming *******/
-
-/*! @ingroup xxh64_family*/
+ /******* Hash Streaming *******/
+ #ifndef XXH_NO_STREAM
+/*! @ingroup XXH64_family*/
XXH_PUBLIC_API XXH64_state_t *XXH64_createState(void) {
return (XXH64_state_t *)XXH_malloc(sizeof(XXH64_state_t));
}
-/*! @ingroup xxh64_family */
+/*! @ingroup XXH64_family */
XXH_PUBLIC_API XXH_errorcode XXH64_freeState(XXH64_state_t *statePtr) {
XXH_free(statePtr);
@@ -2851,42 +3908,39 @@ XXH_PUBLIC_API XXH_errorcode XXH64_freeState(XXH64_state_t *statePtr) {
}
-/*! @ingroup xxh64_family */
-XXH_PUBLIC_API void XXH64_copyState(XXH64_state_t *dstState,
- const XXH64_state_t *srcState) {
+/*! @ingroup XXH64_family */
+XXH_PUBLIC_API void XXH64_copyState(XXH_NOESCAPE XXH64_state_t *dstState,
+ const XXH64_state_t *srcState) {
- memcpy(dstState, srcState, sizeof(*dstState));
+ XXH_memcpy(dstState, srcState, sizeof(*dstState));
}
-/*! @ingroup xxh64_family */
-XXH_PUBLIC_API XXH_errorcode XXH64_reset(XXH64_state_t *statePtr,
- XXH64_hash_t seed) {
+/*! @ingroup XXH64_family */
+XXH_PUBLIC_API XXH_errorcode XXH64_reset(XXH_NOESCAPE XXH64_state_t *statePtr,
+ XXH64_hash_t seed) {
- XXH64_state_t state; /* use a local state to memcpy() in order to avoid
- strict-aliasing warnings */
- memset(&state, 0, sizeof(state));
- state.v1 = seed + XXH_PRIME64_1 + XXH_PRIME64_2;
- state.v2 = seed + XXH_PRIME64_2;
- state.v3 = seed + 0;
- state.v4 = seed - XXH_PRIME64_1;
- /* do not write into reserved64, might be removed in a future version */
- memcpy(statePtr, &state, sizeof(state) - sizeof(state.reserved64));
+ XXH_ASSERT(statePtr != NULL);
+ memset(statePtr, 0, sizeof(*statePtr));
+ statePtr->v[0] = seed + XXH_PRIME64_1 + XXH_PRIME64_2;
+ statePtr->v[1] = seed + XXH_PRIME64_2;
+ statePtr->v[2] = seed + 0;
+ statePtr->v[3] = seed - XXH_PRIME64_1;
return XXH_OK;
}
-/*! @ingroup xxh64_family */
-XXH_PUBLIC_API XXH_errorcode XXH64_update(XXH64_state_t *state,
- const void *input, size_t len) {
+/*! @ingroup XXH64_family */
+XXH_PUBLIC_API XXH_errorcode XXH64_update(XXH_NOESCAPE XXH64_state_t *state,
+ XXH_NOESCAPE const void *input,
+ size_t len) {
- if (input == NULL)
- #if defined(XXH_ACCEPT_NULL_INPUT_POINTER) && \
- (XXH_ACCEPT_NULL_INPUT_POINTER >= 1)
+ if (input == NULL) {
+
+ XXH_ASSERT(len == 0);
return XXH_OK;
- #else
- return XXH_ERROR;
- #endif
+
+ }
{
@@ -2905,10 +3959,10 @@ XXH_PUBLIC_API XXH_errorcode XXH64_update(XXH64_state_t *state,
if (state->memsize) { /* tmp buffer is full */
XXH_memcpy(((xxh_u8 *)state->mem64) + state->memsize, input,
32 - state->memsize);
- state->v1 = XXH64_round(state->v1, XXH_readLE64(state->mem64 + 0));
- state->v2 = XXH64_round(state->v2, XXH_readLE64(state->mem64 + 1));
- state->v3 = XXH64_round(state->v3, XXH_readLE64(state->mem64 + 2));
- state->v4 = XXH64_round(state->v4, XXH_readLE64(state->mem64 + 3));
+ state->v[0] = XXH64_round(state->v[0], XXH_readLE64(state->mem64 + 0));
+ state->v[1] = XXH64_round(state->v[1], XXH_readLE64(state->mem64 + 1));
+ state->v[2] = XXH64_round(state->v[2], XXH_readLE64(state->mem64 + 2));
+ state->v[3] = XXH64_round(state->v[3], XXH_readLE64(state->mem64 + 3));
p += 32 - state->memsize;
state->memsize = 0;
@@ -2917,29 +3971,20 @@ XXH_PUBLIC_API XXH_errorcode XXH64_update(XXH64_state_t *state,
if (p + 32 <= bEnd) {
const xxh_u8 *const limit = bEnd - 32;
- xxh_u64 v1 = state->v1;
- xxh_u64 v2 = state->v2;
- xxh_u64 v3 = state->v3;
- xxh_u64 v4 = state->v4;
do {
- v1 = XXH64_round(v1, XXH_readLE64(p));
+ state->v[0] = XXH64_round(state->v[0], XXH_readLE64(p));
p += 8;
- v2 = XXH64_round(v2, XXH_readLE64(p));
+ state->v[1] = XXH64_round(state->v[1], XXH_readLE64(p));
p += 8;
- v3 = XXH64_round(v3, XXH_readLE64(p));
+ state->v[2] = XXH64_round(state->v[2], XXH_readLE64(p));
p += 8;
- v4 = XXH64_round(v4, XXH_readLE64(p));
+ state->v[3] = XXH64_round(state->v[3], XXH_readLE64(p));
p += 8;
} while (p <= limit);
- state->v1 = v1;
- state->v2 = v2;
- state->v3 = v3;
- state->v4 = v4;
-
}
if (p < bEnd) {
@@ -2955,28 +4000,24 @@ XXH_PUBLIC_API XXH_errorcode XXH64_update(XXH64_state_t *state,
}
-/*! @ingroup xxh64_family */
-XXH_PUBLIC_API XXH64_hash_t XXH64_digest(const XXH64_state_t *state) {
+/*! @ingroup XXH64_family */
+XXH_PUBLIC_API XXH64_hash_t
+XXH64_digest(XXH_NOESCAPE const XXH64_state_t *state) {
xxh_u64 h64;
if (state->total_len >= 32) {
- xxh_u64 const v1 = state->v1;
- xxh_u64 const v2 = state->v2;
- xxh_u64 const v3 = state->v3;
- xxh_u64 const v4 = state->v4;
-
- h64 = XXH_rotl64(v1, 1) + XXH_rotl64(v2, 7) + XXH_rotl64(v3, 12) +
- XXH_rotl64(v4, 18);
- h64 = XXH64_mergeRound(h64, v1);
- h64 = XXH64_mergeRound(h64, v2);
- h64 = XXH64_mergeRound(h64, v3);
- h64 = XXH64_mergeRound(h64, v4);
+ h64 = XXH_rotl64(state->v[0], 1) + XXH_rotl64(state->v[1], 7) +
+ XXH_rotl64(state->v[2], 12) + XXH_rotl64(state->v[3], 18);
+ h64 = XXH64_mergeRound(h64, state->v[0]);
+ h64 = XXH64_mergeRound(h64, state->v[1]);
+ h64 = XXH64_mergeRound(h64, state->v[2]);
+ h64 = XXH64_mergeRound(h64, state->v[3]);
} else {
- h64 = state->v3 /*seed*/ + XXH_PRIME64_5;
+ h64 = state->v[2] /*seed*/ + XXH_PRIME64_5;
}
@@ -2987,21 +4028,23 @@ XXH_PUBLIC_API XXH64_hash_t XXH64_digest(const XXH64_state_t *state) {
}
+ #endif /* !XXH_NO_STREAM */
+
/******* Canonical representation *******/
-/*! @ingroup xxh64_family */
-XXH_PUBLIC_API void XXH64_canonicalFromHash(XXH64_canonical_t *dst,
- XXH64_hash_t hash) {
+/*! @ingroup XXH64_family */
+XXH_PUBLIC_API void XXH64_canonicalFromHash(XXH_NOESCAPE XXH64_canonical_t *dst,
+ XXH64_hash_t hash) {
XXH_STATIC_ASSERT(sizeof(XXH64_canonical_t) == sizeof(XXH64_hash_t));
if (XXH_CPU_LITTLE_ENDIAN) hash = XXH_swap64(hash);
- memcpy(dst, &hash, sizeof(*dst));
+ XXH_memcpy(dst, &hash, sizeof(*dst));
}
-/*! @ingroup xxh64_family */
+/*! @ingroup XXH64_family */
XXH_PUBLIC_API XXH64_hash_t
-XXH64_hashFromCanonical(const XXH64_canonical_t *src) {
+XXH64_hashFromCanonical(XXH_NOESCAPE const XXH64_canonical_t *src) {
return XXH_readBE64(src);
@@ -3015,7 +4058,7 @@ XXH64_hashFromCanonical(const XXH64_canonical_t *src) {
************************************************************************ */
/*!
* @}
- * @defgroup xxh3_impl XXH3 implementation
+ * @defgroup XXH3_impl XXH3 implementation
* @ingroup impl
* @{
@@ -3030,9 +4073,16 @@ XXH64_hashFromCanonical(const XXH64_canonical_t *src) {
#elif defined(__STDC_VERSION__) && \
__STDC_VERSION__ >= 199901L /* >= C99 */
#define XXH_RESTRICT restrict
+ #elif (defined(__GNUC__) && \
+ ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))) || \
+ (defined(__clang__)) || (defined(_MSC_VER) && (_MSC_VER >= 1400)) || \
+ (defined(__INTEL_COMPILER) && (__INTEL_COMPILER >= 1300))
+ /*
+ * There are a LOT more compilers that recognize __restrict but this
+ * covers the major ones.
+ */
+ #define XXH_RESTRICT __restrict
#else
- /* Note: it might be useful to define __restrict or __restrict__ for
- * some C++ compilers */
#define XXH_RESTRICT /* disable */
#endif
@@ -3046,17 +4096,38 @@ XXH64_hashFromCanonical(const XXH64_canonical_t *src) {
#define XXH_unlikely(x) (x)
#endif
- #if defined(__GNUC__)
- #if defined(__AVX2__)
- #include <immintrin.h>
- #elif defined(__SSE2__)
- #include <emmintrin.h>
- #elif defined(__ARM_NEON__) || defined(__ARM_NEON)
+ #ifndef XXH_HAS_INCLUDE
+ #ifdef __has_include
+ /*
+ * Not defined as XXH_HAS_INCLUDE(x) (function-like) because
+ * this causes segfaults in Apple Clang 4.2 (on Mac OS X 10.7 Lion)
+ */
+ #define XXH_HAS_INCLUDE __has_include
+ #else
+ #define XXH_HAS_INCLUDE(x) 0
+ #endif
+ #endif
+
+ #if defined(__GNUC__) || defined(__clang__)
+ #if defined(__ARM_FEATURE_SVE)
+ #include <arm_sve.h>
+ #endif
+ #if defined(__ARM_NEON__) || defined(__ARM_NEON) || \
+ (defined(_M_ARM) && _M_ARM >= 7) || defined(_M_ARM64) || \
+ defined(_M_ARM64EC) || \
+ (defined(__wasm_simd128__) && \
+ XXH_HAS_INCLUDE(<arm_neon.h>)) /* WASM SIMD128 via SIMDe */
#define inline __inline__ /* circumvent a clang bug */
#include <arm_neon.h>
#undef inline
+ #elif defined(__AVX2__)
+ #include <immintrin.h>
+ #elif defined(__SSE2__)
+ #include <emmintrin.h>
#endif
- #elif defined(_MSC_VER)
+ #endif
+
+ #if defined(_MSC_VER)
#include <intrin.h>
#endif
@@ -3161,7 +4232,7 @@ XXH64_hashFromCanonical(const XXH64_canonical_t *src) {
* Note that these are actually implemented as macros.
*
* If this is not defined, it is detected automatically.
- * @ref XXH_X86DISPATCH overrides this.
+ * internal macro XXH_X86DISPATCH overrides this.
*/
enum XXH_VECTOR_TYPE /* fake enum */ {
@@ -3174,8 +4245,13 @@ enum XXH_VECTOR_TYPE /* fake enum */ {
*/
XXH_AVX2 = 2, /*!< AVX2 for Haswell and Bulldozer */
XXH_AVX512 = 3, /*!< AVX512 for Skylake and Icelake */
- XXH_NEON = 4, /*!< NEON for most ARMv7-A and all AArch64 */
+ XXH_NEON = 4, /*!<
+ * NEON for most ARMv7-A, all AArch64, and WASM SIMD128
+ * via the SIMDeverywhere polyfill provided with the
+ * Emscripten SDK.
+ */
XXH_VSX = 5, /*!< VSX and ZVector for POWER8/z13 (64-bit) */
+ XXH_SVE = 6, /*!< SVE for some ARMv8-A and ARMv9-A */
};
@@ -3183,7 +4259,7 @@ enum XXH_VECTOR_TYPE /* fake enum */ {
* @ingroup tuning
* @brief Selects the minimum alignment for XXH3's accumulators.
*
- * When using SIMD, this should match the alignment reqired for said
+ * When using SIMD, this should match the alignment required for said
* vector type, so, for example, 32 for AVX2.
*
* Default: Auto detected.
@@ -3199,23 +4275,30 @@ enum XXH_VECTOR_TYPE /* fake enum */ {
#define XXH_AVX512 3
#define XXH_NEON 4
#define XXH_VSX 5
+ #define XXH_SVE 6
#endif
#ifndef XXH_VECTOR /* can be defined on command line */
- #if defined(__AVX512F__)
+ #if defined(__ARM_FEATURE_SVE)
+ #define XXH_VECTOR XXH_SVE
+ #elif (defined(__ARM_NEON__) || defined(__ARM_NEON) /* gcc */ \
+ || defined(_M_ARM) || defined(_M_ARM64) || \
+ defined(_M_ARM64EC) /* msvc */ \
+ || (defined(__wasm_simd128__) && \
+ XXH_HAS_INCLUDE(<arm_neon.h>)) /* wasm simd128 via SIMDe */ \
+ ) && \
+ (defined(_WIN32) || \
+ defined(__LITTLE_ENDIAN__) /* little endian only */ \
+ || (defined(__BYTE_ORDER__) && \
+ __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__))
+ #define XXH_VECTOR XXH_NEON
+ #elif defined(__AVX512F__)
#define XXH_VECTOR XXH_AVX512
#elif defined(__AVX2__)
#define XXH_VECTOR XXH_AVX2
#elif defined(__SSE2__) || defined(_M_AMD64) || defined(_M_X64) || \
(defined(_M_IX86_FP) && (_M_IX86_FP == 2))
#define XXH_VECTOR XXH_SSE2
- #elif defined(__GNUC__) /* msvc support maybe later */ \
- && (defined(__ARM_NEON__) || defined(__ARM_NEON)) && \
- (defined( \
- __LITTLE_ENDIAN__) /* We only support little endian NEON */ \
- || (defined(__BYTE_ORDER__) && \
- __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__))
- #define XXH_VECTOR XXH_NEON
#elif (defined(__PPC64__) && defined(__POWER8_VECTOR__)) || \
(defined(__s390x__) && defined(__VEC__)) && \
defined(__GNUC__) /* TODO: IBM XL */
@@ -3225,6 +4308,17 @@ enum XXH_VECTOR_TYPE /* fake enum */ {
#endif
#endif
+ /* __ARM_FEATURE_SVE is only supported by GCC & Clang. */
+ #if (XXH_VECTOR == XXH_SVE) && !defined(__ARM_FEATURE_SVE)
+ #ifdef _MSC_VER
+ #pragma warning(once : 4606)
+ #else
+ #warning "__ARM_FEATURE_SVE isn't supported. Use SCALAR instead."
+ #endif
+ #undef XXH_VECTOR
+ #define XXH_VECTOR XXH_SCALAR
+ #endif
+
/*
* Controls the alignment of the accumulator,
* for compatibility with aligned vector loads, which are usually faster.
@@ -3244,16 +4338,26 @@ enum XXH_VECTOR_TYPE /* fake enum */ {
#define XXH_ACC_ALIGN 16
#elif XXH_VECTOR == XXH_AVX512 /* avx512 */
#define XXH_ACC_ALIGN 64
+ #elif XXH_VECTOR == XXH_SVE /* sve */
+ #define XXH_ACC_ALIGN 64
#endif
#endif
#if defined(XXH_X86DISPATCH) || XXH_VECTOR == XXH_SSE2 || \
XXH_VECTOR == XXH_AVX2 || XXH_VECTOR == XXH_AVX512
#define XXH_SEC_ALIGN XXH_ACC_ALIGN
+ #elif XXH_VECTOR == XXH_SVE
+ #define XXH_SEC_ALIGN XXH_ACC_ALIGN
#else
#define XXH_SEC_ALIGN 8
#endif
+ #if defined(__GNUC__) || defined(__clang__)
+ #define XXH_ALIASING __attribute__((may_alias))
+ #else
+ #define XXH_ALIASING /* nothing */
+ #endif
+
/*
* UGLY HACK:
* GCC usually generates the best code with -O3 for xxHash.
@@ -3278,126 +4382,153 @@ enum XXH_VECTOR_TYPE /* fake enum */ {
#if XXH_VECTOR == XXH_AVX2 /* AVX2 */ \
&& defined(__GNUC__) && !defined(__clang__) /* GCC, not Clang */ \
&& defined(__OPTIMIZE__) && \
- !defined(__OPTIMIZE_SIZE__) /* respect -O0 and -Os */
+ XXH_SIZE_OPT <= 0 /* respect -O0 and -Os */
#pragma GCC push_options
#pragma GCC optimize("-O2")
#endif
#if XXH_VECTOR == XXH_NEON
- /*
- * NEON's setup for vmlal_u32 is a little more complicated than it is on
- * SSE2, AVX2, and VSX.
- *
- * While PMULUDQ and VMULEUW both perform a mask, VMLAL.U32 performs an
- * upcast.
- *
- * To do the same operation, the 128-bit 'Q' register needs to be split
- * into two 64-bit 'D' registers, performing this operation::
- *
- * [ a | b ] |
- * '---------. .--------' | | x |
- * | .---------' '--------. |
- * [ a & 0xFFFFFFFF | b & 0xFFFFFFFF ],[ a >> 32 | b >> 32
- * ]
- *
- * Due to significant changes in aarch64, the fastest method for aarch64
- * is completely different than the fastest method for ARMv7-A.
- *
- * ARMv7-A treats D registers as unions overlaying Q registers, so
- * modifying D11 will modify the high half of Q5. This is similar to how
- * modifying AH will only affect bits 8-15 of AX on x86.
- *
- * VZIP takes two registers, and puts even lanes in one register and odd
- * lanes in the other.
+
+/*
+ * UGLY HACK: While AArch64 GCC on Linux does not seem to care, on macOS, GCC
+ * -O3 optimizes out the entire hashLong loop because of the aliasing violation.
+ *
+ * However, GCC is also inefficient at load-store optimization with vld1q/vst1q,
+ * so the only option is to mark it as aliasing.
+ */
+typedef uint64x2_t xxh_aliasing_uint64x2_t XXH_ALIASING;
+
+ /*!
+ * @internal
+ * @brief `vld1q_u64` but faster and alignment-safe.
*
- * On ARMv7-A, this strangely modifies both parameters in place instead
- * of taking the usual 3-operand form.
+ * On AArch64, unaligned access is always safe, but on ARMv7-a, it is
+ * only *conditionally* safe (`vld1` has an alignment bit like
+ * `movdq[ua]` in x86).
*
- * Therefore, if we want to do this, we can simply use a D-form VZIP.32
- * on the lower and upper halves of the Q register to end up with the
- * high and low halves where we want - all in one instruction.
+ * GCC for AArch64 sees `vld1q_u8` as an intrinsic instead of a load, so
+ * it prohibits load-store optimizations. Therefore, a direct
+ * dereference is used.
*
- * vzip.32 d10, d11 @ d10 = { d10[0], d11[0] }; d11 = {
+ * Otherwise, `vld1q_u8` is used with `vreinterpretq_u8_u64` to do a
+ * safe unaligned load.
+ */
+ #if defined(__aarch64__) && defined(__GNUC__) && !defined(__clang__)
+XXH_FORCE_INLINE uint64x2_t
+XXH_vld1q_u64(void const *ptr) /* silence -Wcast-align */
+{
+
+ return *(xxh_aliasing_uint64x2_t const *)ptr;
+
+}
+
+ #else
+XXH_FORCE_INLINE uint64x2_t XXH_vld1q_u64(void const *ptr) {
+
+ return vreinterpretq_u64_u8(vld1q_u8((uint8_t const *)ptr));
+
+}
- * d10[1], d11[1] }
+ #endif
+
+ /*!
+ * @internal
+ * @brief `vmlal_u32` on low and high halves of a vector.
*
- * Unfortunately we need inline assembly for this: Instructions
- * modifying two registers at once is not possible in GCC or Clang's IR,
- * and they have to create a copy.
+ * This is a workaround for AArch64 GCC < 11 which implemented
+ * arm_neon.h with inline assembly and were therefore incapable of
+ * merging the `vget_{low, high}_u32` with `vmlal_u32`.
+ */
+ #if defined(__aarch64__) && defined(__GNUC__) && \
+ !defined(__clang__) && __GNUC__ < 11
+XXH_FORCE_INLINE uint64x2_t XXH_vmlal_low_u32(uint64x2_t acc, uint32x4_t lhs,
+ uint32x4_t rhs) {
+
+ /* Inline assembly is the only way */
+ __asm__("umlal %0.2d, %1.2s, %2.2s" : "+w"(acc) : "w"(lhs), "w"(rhs));
+ return acc;
+
+}
+
+XXH_FORCE_INLINE uint64x2_t XXH_vmlal_high_u32(uint64x2_t acc, uint32x4_t lhs,
+ uint32x4_t rhs) {
+
+ /* This intrinsic works as expected */
+ return vmlal_high_u32(acc, lhs, rhs);
+
+}
+
+ #else
+/* Portable intrinsic versions */
+XXH_FORCE_INLINE uint64x2_t XXH_vmlal_low_u32(uint64x2_t acc, uint32x4_t lhs,
+ uint32x4_t rhs) {
+
+ return vmlal_u32(acc, vget_low_u32(lhs), vget_low_u32(rhs));
+
+}
+
+/*! @copydoc XXH_vmlal_low_u32
+ * Assume the compiler converts this to vmlal_high_u32 on aarch64 */
+XXH_FORCE_INLINE uint64x2_t XXH_vmlal_high_u32(uint64x2_t acc, uint32x4_t lhs,
+ uint32x4_t rhs) {
+
+ return vmlal_u32(acc, vget_high_u32(lhs), vget_high_u32(rhs));
+
+}
+
+ #endif
+
+ /*!
+ * @ingroup tuning
+ * @brief Controls the NEON to scalar ratio for XXH3
*
- * aarch64 requires a different approach.
+ * This can be set to 2, 4, 6, or 8.
*
- * In order to make it easier to write a decent compiler for aarch64,
- * many quirks were removed, such as conditional execution.
+ * ARM Cortex CPUs are _very_ sensitive to how their pipelines are used.
*
- * NEON was also affected by this.
+ * For example, the Cortex-A73 can dispatch 3 micro-ops per cycle, but
+ * only 2 of those can be NEON. If you are only using NEON instructions,
+ * you are only using 2/3 of the CPU bandwidth.
*
- * aarch64 cannot access the high bits of a Q-form register, and writes
- * to a D-form register zero the high bits, similar to how writes to
- * W-form scalar registers (or DWORD registers on x86_64) work.
+ * This is even more noticeable on the more advanced cores like the
+ * Cortex-A76 which can dispatch 8 micro-ops per cycle, but still only 2
+ * NEON micro-ops at once.
*
- * The formerly free vget_high intrinsics now require a vext (with a few
- * exceptions)
+ * Therefore, to make the most out of the pipeline, it is beneficial to
+ * run 6 NEON lanes and 2 scalar lanes, which is chosen by default.
*
- * Additionally, VZIP was replaced by ZIP1 and ZIP2, which are the
- * equivalent of PUNPCKL* and PUNPCKH* in SSE, respectively, in order to
- * only modify one operand.
+ * This does not apply to Apple processors or 32-bit processors, which
+ * run better with full NEON. These will default to 8. Additionally,
+ * size-optimized builds run 8 lanes.
*
- * The equivalent of the VZIP.32 on the lower and upper halves would be
- * this mess:
+ * This change benefits CPUs with large micro-op buffers without
+ * negatively affecting most other CPUs:
*
- * ext v2.4s, v0.4s, v0.4s, #2 // v2 = { v0[2], v0[3], v0[0],
- * v0[1] } zip1 v1.2s, v0.2s, v2.2s // v1 = { v0[0], v2[0] } zip2
- * v0.2s, v0.2s, v1.2s // v0 = { v0[1], v2[1] }
+ * | Chipset | Dispatch type | NEON only | 6:2
+ * hybrid | Diff. |
+ * |:----------------------|:--------------------|----------:|-----------:|------:|
+ * | Snapdragon 730 (A76) | 2 NEON/8 micro-ops | 8.8 GB/s | 10.1
+ * GB/s | ~16% | | Snapdragon 835 (A73) | 2 NEON/3 micro-ops | 5.1
+ * GB/s | 5.3 GB/s | ~5% | | Marvell PXA1928 (A53) | In-order
+ * dual-issue | 1.9 GB/s | 1.9 GB/s | 0% | | Apple M1 | 4 NEON/8
+ * micro-ops | 37.3 GB/s | 36.1 GB/s | ~-3% |
*
- * Instead, we use a literal downcast, vmovn_u64 (XTN), and vshrn_n_u64
- * (SHRN):
+ * It also seems to fix some bad codegen on GCC, making it almost as
+ * fast as clang.
*
- * shrn v1.2s, v0.2d, #32 // v1 = (uint32x2_t)(v0 >> 32);
- * xtn v0.2s, v0.2d // v0 = (uint32x2_t)(v0 & 0xFFFFFFFF);
+ * When using WASM SIMD128, if this is 2 or 6, SIMDe will scalarize 2 of
+ * the lanes meaning it effectively becomes worse 4.
*
- * This is available on ARMv7-A, but is less efficient than a single
- * VZIP.32.
+ * @see XXH3_accumulate_512_neon()
*/
-
- /*!
- * Function-like macro:
- * void XXH_SPLIT_IN_PLACE(uint64x2_t &in, uint32x2_t &outLo, uint32x2_t
- * &outHi)
- * {
-
- * outLo = (uint32x2_t)(in & 0xFFFFFFFF);
- * outHi = (uint32x2_t)(in >> 32);
- * in = UNDEFINED;
- * }
- */
- #if !defined(XXH_NO_VZIP_HACK) /* define to disable */ \
- && defined(__GNUC__) && !defined(__aarch64__) && \
- !defined(__arm64__)
- #define XXH_SPLIT_IN_PLACE(in, outLo, outHi) \
- do { \
- \
- /* Undocumented GCC/Clang operand modifier: %e0 = lower D half, \
- * %f0 = upper D half */ \
- /* https://github.com/gcc-mirror/gcc/blob/38cf91e5/gcc/config/arm/arm.c#L22486 \
- */ \
- /* https://github.com/llvm-mirror/llvm/blob/2c4ca683/lib/Target/ARM/ARMAsmPrinter.cpp#L399 \
- */ \
- __asm__("vzip.32 %e0, %f0" : "+w"(in)); \
- (outLo) = vget_low_u32(vreinterpretq_u32_u64(in)); \
- (outHi) = vget_high_u32(vreinterpretq_u32_u64(in)); \
- \
- } while (0)
-
- #else
- #define XXH_SPLIT_IN_PLACE(in, outLo, outHi) \
- do { \
- \
- (outLo) = vmovn_u64(in); \
- (outHi) = vshrn_n_u64((in), 32); \
- \
- } while (0)
-
+ #ifndef XXH3_NEON_LANES
+ #if (defined(__aarch64__) || defined(__arm64__) || \
+ defined(_M_ARM64) || defined(_M_ARM64EC)) && \
+ !defined(__APPLE__) && XXH_SIZE_OPT <= 0
+ #define XXH3_NEON_LANES 6
+ #else
+ #define XXH3_NEON_LANES XXH_ACC_NB
+ #endif
#endif
#endif /* XXH_VECTOR == XXH_NEON */
@@ -3410,28 +4541,43 @@ enum XXH_VECTOR_TYPE /* fake enum */ {
* inconsistent intrinsics, spotty coverage, and multiple endiannesses.
*/
#if XXH_VECTOR == XXH_VSX
+ /* Annoyingly, these headers _may_ define three macros: `bool`,
+ * `vector`, and `pixel`. This is a problem for obvious reasons.
+ *
+ * These keywords are unnecessary; the spec literally says they are
+ * equivalent to `__bool`, `__vector`, and `__pixel` and may be undef'd
+ * after including the header.
+ *
+ * We use pragma push_macro/pop_macro to keep the namespace clean. */
+ #pragma push_macro("bool")
+ #pragma push_macro("vector")
+ #pragma push_macro("pixel")
+ /* silence potential macro redefined warnings */
+ #undef bool
+ #undef vector
+ #undef pixel
+
#if defined(__s390x__)
#include <s390intrin.h>
#else
- /* gcc's altivec.h can have the unwanted consequence to
- * unconditionally #define bool, vector, and pixel keywords, with bad
- * consequences for programs already using these keywords for other
- * purposes. The paragraph defining these macros is skipped when
- * __APPLE_ALTIVEC__ is defined.
- * __APPLE_ALTIVEC__ is _generally_ defined automatically by the
- * compiler, but it seems that, in some cases, it isn't. Force the
- * build macro to be defined, so that keywords are not altered.
- */
- #if defined(__GNUC__) && !defined(__APPLE_ALTIVEC__)
- #define __APPLE_ALTIVEC__
- #endif
#include <altivec.h>
#endif
+ /* Restore the original macro values, if applicable. */
+ #pragma pop_macro("pixel")
+ #pragma pop_macro("vector")
+ #pragma pop_macro("bool")
+
typedef __vector unsigned long long xxh_u64x2;
typedef __vector unsigned char xxh_u8x16;
typedef __vector unsigned xxh_u32x4;
+/*
+ * UGLY HACK: Similar to aarch64 macOS GCC, s390x GCC has the same aliasing
+ * issue.
+ */
+typedef xxh_u64x2 xxh_aliasing_u64x2 XXH_ALIASING;
+
#ifndef XXH_VSX_BE
#if defined(__BIG_ENDIAN__) || \
(defined(__BYTE_ORDER__) && \
@@ -3472,7 +4618,7 @@ XXH_FORCE_INLINE xxh_u64x2 XXH_vec_revb(xxh_u64x2 val) {
XXH_FORCE_INLINE xxh_u64x2 XXH_vec_loadu(const void *ptr) {
xxh_u64x2 ret;
- memcpy(&ret, ptr, sizeof(xxh_u64x2));
+ XXH_memcpy(&ret, ptr, sizeof(xxh_u64x2));
#if XXH_VSX_BE
ret = XXH_vec_revb(ret);
#endif
@@ -3491,9 +4637,12 @@ XXH_FORCE_INLINE xxh_u64x2 XXH_vec_loadu(const void *ptr) {
/* s390x is always big endian, no issue on this platform */
#define XXH_vec_mulo vec_mulo
#define XXH_vec_mule vec_mule
- #elif defined(__clang__) && XXH_HAS_BUILTIN(__builtin_altivec_vmuleuw)
+ #elif defined(__clang__) && \
+ XXH_HAS_BUILTIN(__builtin_altivec_vmuleuw) && !defined(__ibmxl__)
/* Clang has a better way to control this, we can just use the builtin
* which doesn't swap. */
+ /* The IBM XL Compiler (which defined __clang__) only implements the
+ * vec_* operations */
#define XXH_vec_mulo __builtin_altivec_vmulouw
#define XXH_vec_mule __builtin_altivec_vmuleuw
#else
@@ -3519,14 +4668,33 @@ XXH_FORCE_INLINE xxh_u64x2 XXH_vec_mule(xxh_u32x4 a, xxh_u32x4 b) {
#endif /* XXH_vec_mulo, XXH_vec_mule */
#endif /* XXH_VECTOR == XXH_VSX */
+ #if XXH_VECTOR == XXH_SVE
+ #define ACCRND(acc, offset) \
+ do { \
+ \
+ svuint64_t input_vec = svld1_u64(mask, xinput + offset); \
+ svuint64_t secret_vec = svld1_u64(mask, xsecret + offset); \
+ svuint64_t mixed = sveor_u64_x(mask, secret_vec, input_vec); \
+ svuint64_t swapped = svtbl_u64(input_vec, kSwap); \
+ svuint64_t mixed_lo = svextw_u64_x(mask, mixed); \
+ svuint64_t mixed_hi = svlsr_n_u64_x(mask, mixed, 32); \
+ svuint64_t mul = svmad_u64_x(mask, mixed_lo, mixed_hi, swapped); \
+ acc = svadd_u64_x(mask, acc, mul); \
+ \
+ } while (0)
+
+ #endif /* XXH_VECTOR == XXH_SVE */
+
/* prefetch
* can be disabled, by declaring XXH_NO_PREFETCH build macro */
#if defined(XXH_NO_PREFETCH)
#define XXH_PREFETCH(ptr) (void)(ptr) /* disabled */
#else
- #if defined(_MSC_VER) && \
- (defined(_M_X64) || \
- defined( \
+ #if XXH_SIZE_OPT >= 1
+ #define XXH_PREFETCH(ptr) (void)(ptr)
+ #elif defined(_MSC_VER) && \
+ (defined(_M_X64) || \
+ defined( \
_M_IX86)) /* _mm_prefetch() not defined outside of x86/x64 */
#include <mmintrin.h> /* https://msdn.microsoft.com/fr-fr/library/84szxsww(v=vs.90).aspx */
#define XXH_PREFETCH(ptr) \
@@ -3573,6 +4741,15 @@ static const xxh_u8 XXH3_kSecret[XXH_SECRET_DEFAULT_SIZE] = {
};
+static const xxh_u64 PRIME_MX1 =
+ 0x165667919E3779F9ULL; /*!<
+ 0b0001011001010110011001111001000110011110001101110111100111111001
+ */
+static const xxh_u64 PRIME_MX2 =
+ 0x9FB21C651E98DF25ULL; /*!<
+ 0b1001111110110010000111000110010100011110100110001101111100100101
+ */
+
#ifdef XXH_OLD_NAMES
#define kSecret XXH3_kSecret
#endif
@@ -3601,7 +4778,6 @@ XXH_FORCE_INLINE xxh_u64 XXH_mult32to64(xxh_u64 x, xxh_u64 y) {
}
#elif defined(_MSC_VER) && defined(_M_IX86)
- #include <intrin.h>
#define XXH_mult32to64(x, y) __emulu((unsigned)(x), (unsigned)(y))
#else
/*
@@ -3623,7 +4799,7 @@ XXH_FORCE_INLINE xxh_u64 XXH_mult32to64(xxh_u64 x, xxh_u64 y) {
* Uses `__uint128_t` and `_umul128` if available, otherwise uses a scalar
* version.
*
- * @param lhs, rhs The 64-bit integers to be multiplied
+ * @param lhs , rhs The 64-bit integers to be multiplied
* @return The 128-bit result represented in an @ref XXH128_hash_t.
*/
static XXH128_hash_t XXH_mult64to128(xxh_u64 lhs, xxh_u64 rhs) {
@@ -3643,8 +4819,8 @@ static XXH128_hash_t XXH_mult64to128(xxh_u64 lhs, xxh_u64 rhs) {
* In that case it is best to use the portable one.
* https://github.com/Cyan4973/xxHash/issues/211#issuecomment-515575677
*/
- #if defined(__GNUC__) && !defined(__wasm__) && \
- defined(__SIZEOF_INT128__) || \
+ #if (defined(__GNUC__) || defined(__clang__)) && !defined(__wasm__) && \
+ defined(__SIZEOF_INT128__) || \
(defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 128)
__uint128_t const product = (__uint128_t)lhs * (__uint128_t)rhs;
@@ -3661,7 +4837,7 @@ static XXH128_hash_t XXH_mult64to128(xxh_u64 lhs, xxh_u64 rhs) {
*
* This compiles to single operand MUL on x64.
*/
- #elif defined(_M_X64) || defined(_M_IA64)
+ #elif (defined(_M_X64) || defined(_M_IA64)) && !defined(_M_ARM64EC)
#ifndef _MSC_VER
#pragma intrinsic(_umul128)
@@ -3673,6 +4849,22 @@ static XXH128_hash_t XXH_mult64to128(xxh_u64 lhs, xxh_u64 rhs) {
r128.high64 = product_high;
return r128;
+ /*
+ * MSVC for ARM64's __umulh method.
+ *
+ * This compiles to the same MUL + UMULH as GCC/Clang's __uint128_t
+ * method.
+ */
+ #elif defined(_M_ARM64) || defined(_M_ARM64EC)
+
+ #ifndef _MSC_VER
+ #pragma intrinsic(__umulh)
+ #endif
+ XXH128_hash_t r128;
+ r128.low64 = lhs * rhs;
+ r128.high64 = __umulh(lhs, rhs);
+ return r128;
+
#else
/*
* Portable scalar method. Optimized for 32-bit and 64-bit ALUs.
@@ -3744,7 +4936,7 @@ static XXH128_hash_t XXH_mult64to128(xxh_u64 lhs, xxh_u64 rhs) {
* around by value. This will hopefully inline the multiply, but we don't force
* it.
*
- * @param lhs, rhs The 64-bit integers to multiply
+ * @param lhs , rhs The 64-bit integers to multiply
* @return The low 64 bits of the product XOR'd by the high 64 bits.
* @see XXH_mult64to128()
*/
@@ -3756,7 +4948,7 @@ static xxh_u64 XXH3_mul128_fold64(xxh_u64 lhs, xxh_u64 rhs) {
}
/*! Seems to produce slightly better code on GCC for some reason. */
-XXH_FORCE_INLINE xxh_u64 XXH_xorshift64(xxh_u64 v64, int shift) {
+XXH_FORCE_INLINE XXH_CONSTF xxh_u64 XXH_xorshift64(xxh_u64 v64, int shift) {
XXH_ASSERT(0 <= shift && shift < 64);
return v64 ^ (v64 >> shift);
@@ -3770,7 +4962,7 @@ XXH_FORCE_INLINE xxh_u64 XXH_xorshift64(xxh_u64 v64, int shift) {
static XXH64_hash_t XXH3_avalanche(xxh_u64 h64) {
h64 = XXH_xorshift64(h64, 37);
- h64 *= 0x165667919E3779F9ULL;
+ h64 *= PRIME_MX1;
h64 = XXH_xorshift64(h64, 32);
return h64;
@@ -3785,9 +4977,9 @@ static XXH64_hash_t XXH3_rrmxmx(xxh_u64 h64, xxh_u64 len) {
/* this mix is inspired by Pelle Evensen's rrmxmx */
h64 ^= XXH_rotl64(h64, 49) ^ XXH_rotl64(h64, 24);
- h64 *= 0x9FB21C651E98DF25ULL;
+ h64 *= PRIME_MX2;
h64 ^= (h64 >> 35) + len;
- h64 *= 0x9FB21C651E98DF25ULL;
+ h64 *= PRIME_MX2;
return XXH_xorshift64(h64, 28);
}
@@ -3826,9 +5018,10 @@ static XXH64_hash_t XXH3_rrmxmx(xxh_u64 h64, xxh_u64 len) {
*
* This adds an extra layer of strength for custom secrets.
*/
-XXH_FORCE_INLINE XXH64_hash_t XXH3_len_1to3_64b(const xxh_u8 *input, size_t len,
- const xxh_u8 *secret,
- XXH64_hash_t seed) {
+XXH_FORCE_INLINE XXH_PUREF XXH64_hash_t XXH3_len_1to3_64b(const xxh_u8 *input,
+ size_t len,
+ const xxh_u8 *secret,
+ XXH64_hash_t seed) {
XXH_ASSERT(input != NULL);
XXH_ASSERT(1 <= len && len <= 3);
@@ -3854,9 +5047,10 @@ XXH_FORCE_INLINE XXH64_hash_t XXH3_len_1to3_64b(const xxh_u8 *input, size_t len,
}
-XXH_FORCE_INLINE XXH64_hash_t XXH3_len_4to8_64b(const xxh_u8 *input, size_t len,
- const xxh_u8 *secret,
- XXH64_hash_t seed) {
+XXH_FORCE_INLINE XXH_PUREF XXH64_hash_t XXH3_len_4to8_64b(const xxh_u8 *input,
+ size_t len,
+ const xxh_u8 *secret,
+ XXH64_hash_t seed) {
XXH_ASSERT(input != NULL);
XXH_ASSERT(secret != NULL);
@@ -3876,10 +5070,10 @@ XXH_FORCE_INLINE XXH64_hash_t XXH3_len_4to8_64b(const xxh_u8 *input, size_t len,
}
-XXH_FORCE_INLINE XXH64_hash_t XXH3_len_9to16_64b(const xxh_u8 *input,
- size_t len,
- const xxh_u8 *secret,
- XXH64_hash_t seed) {
+XXH_FORCE_INLINE XXH_PUREF XXH64_hash_t XXH3_len_9to16_64b(const xxh_u8 *input,
+ size_t len,
+ const xxh_u8 *secret,
+ XXH64_hash_t seed) {
XXH_ASSERT(input != NULL);
XXH_ASSERT(secret != NULL);
@@ -3900,10 +5094,10 @@ XXH_FORCE_INLINE XXH64_hash_t XXH3_len_9to16_64b(const xxh_u8 *input,
}
-XXH_FORCE_INLINE XXH64_hash_t XXH3_len_0to16_64b(const xxh_u8 *input,
- size_t len,
- const xxh_u8 *secret,
- XXH64_hash_t seed) {
+XXH_FORCE_INLINE XXH_PUREF XXH64_hash_t XXH3_len_0to16_64b(const xxh_u8 *input,
+ size_t len,
+ const xxh_u8 *secret,
+ XXH64_hash_t seed) {
XXH_ASSERT(len <= 16);
{
@@ -3983,7 +5177,7 @@ XXH_FORCE_INLINE xxh_u64 XXH3_mix16B(const xxh_u8 *XXH_RESTRICT input,
}
/* For mid range keys, XXH3 uses a Mum-hash variant. */
-XXH_FORCE_INLINE XXH64_hash_t XXH3_len_17to128_64b(
+XXH_FORCE_INLINE XXH_PUREF XXH64_hash_t XXH3_len_17to128_64b(
const xxh_u8 *XXH_RESTRICT input, size_t len,
const xxh_u8 *XXH_RESTRICT secret, size_t secretSize, XXH64_hash_t seed) {
@@ -3994,6 +5188,18 @@ XXH_FORCE_INLINE XXH64_hash_t XXH3_len_17to128_64b(
{
xxh_u64 acc = len * XXH_PRIME64_1;
+ #if XXH_SIZE_OPT >= 1
+ /* Smaller and cleaner, but slightly slower. */
+ unsigned int i = (unsigned int)(len - 1) / 32;
+ do {
+
+ acc += XXH3_mix16B(input + 16 * i, secret + 32 * i, seed);
+ acc +=
+ XXH3_mix16B(input + len - 16 * (i + 1), secret + 32 * i + 16, seed);
+
+ } while (i-- != 0);
+
+ #else
if (len > 32) {
if (len > 64) {
@@ -4017,16 +5223,19 @@ XXH_FORCE_INLINE XXH64_hash_t XXH3_len_17to128_64b(
acc += XXH3_mix16B(input + 0, secret + 0, seed);
acc += XXH3_mix16B(input + len - 16, secret + 16, seed);
-
+ #endif
return XXH3_avalanche(acc);
}
}
+ /*!
+ * @brief Maximum size of "short" key in bytes.
+ */
#define XXH3_MIDSIZE_MAX 240
-XXH_NO_INLINE XXH64_hash_t XXH3_len_129to240_64b(
+XXH_NO_INLINE XXH_PUREF XXH64_hash_t XXH3_len_129to240_64b(
const xxh_u8 *XXH_RESTRICT input, size_t len,
const xxh_u8 *XXH_RESTRICT secret, size_t secretSize, XXH64_hash_t seed) {
@@ -4039,17 +5248,23 @@ XXH_NO_INLINE XXH64_hash_t XXH3_len_129to240_64b(
{
- xxh_u64 acc = len * XXH_PRIME64_1;
- int const nbRounds = (int)len / 16;
- int i;
+ xxh_u64 acc = len * XXH_PRIME64_1;
+ xxh_u64 acc_end;
+ unsigned int const nbRounds = (unsigned int)len / 16;
+ unsigned int i;
+ XXH_ASSERT(128 < len && len <= XXH3_MIDSIZE_MAX);
for (i = 0; i < 8; i++) {
acc += XXH3_mix16B(input + (16 * i), secret + (16 * i), seed);
}
- acc = XXH3_avalanche(acc);
+ /* last bytes */
+ acc_end = XXH3_mix16B(
+ input + len - 16,
+ secret + XXH3_SECRET_SIZE_MIN - XXH3_MIDSIZE_LASTOFFSET, seed);
XXH_ASSERT(nbRounds >= 8);
+ acc = XXH3_avalanche(acc);
#if defined(__clang__) /* Clang */ \
&& (defined(__ARM_NEON) || defined(__ARM_NEON__)) /* NEON */ \
&& !defined(XXH_ENABLE_AUTOVECTORIZE) /* Define to disable */
@@ -4077,17 +5292,18 @@ XXH_NO_INLINE XXH64_hash_t XXH3_len_129to240_64b(
#endif
for (i = 8; i < nbRounds; i++) {
- acc +=
+ /*
+ * Prevents clang for unrolling the acc loop and interleaving with this
+ * one.
+ */
+ XXH_COMPILER_GUARD(acc);
+ acc_end +=
XXH3_mix16B(input + (16 * i),
secret + (16 * (i - 8)) + XXH3_MIDSIZE_STARTOFFSET, seed);
}
- /* last bytes */
- acc += XXH3_mix16B(input + len - 16,
- secret + XXH3_SECRET_SIZE_MIN - XXH3_MIDSIZE_LASTOFFSET,
- seed);
- return XXH3_avalanche(acc);
+ return XXH3_avalanche(acc + acc_end);
}
@@ -4105,10 +5321,49 @@ XXH_NO_INLINE XXH64_hash_t XXH3_len_129to240_64b(
#define ACC_NB XXH_ACC_NB
#endif
+ #ifndef XXH_PREFETCH_DIST
+ #ifdef __clang__
+ #define XXH_PREFETCH_DIST 320
+ #else
+ #if (XXH_VECTOR == XXH_AVX512)
+ #define XXH_PREFETCH_DIST 512
+ #else
+ #define XXH_PREFETCH_DIST 384
+ #endif
+ #endif /* __clang__ */
+ #endif /* XXH_PREFETCH_DIST */
+
+ /*
+ * These macros are to generate an XXH3_accumulate() function.
+ * The two arguments select the name suffix and target attribute.
+ *
+ * The name of this symbol is XXH3_accumulate_<name>() and it calls
+ * XXH3_accumulate_512_<name>().
+ *
+ * It may be useful to hand implement this function if the compiler fails
+ * to optimize the inline function.
+ */
+ #define XXH3_ACCUMULATE_TEMPLATE(name) \
+ void XXH3_accumulate_##name( \
+ xxh_u64 *XXH_RESTRICT acc, const xxh_u8 *XXH_RESTRICT input, \
+ const xxh_u8 *XXH_RESTRICT secret, size_t nbStripes) { \
+ \
+ size_t n; \
+ for (n = 0; n < nbStripes; n++) { \
+ \
+ const xxh_u8 *const in = input + n * XXH_STRIPE_LEN; \
+ XXH_PREFETCH(in + XXH_PREFETCH_DIST); \
+ XXH3_accumulate_512_##name(acc, in, \
+ secret + n * XXH_SECRET_CONSUME_RATE); \
+ \
+ } \
+ \
+ }
+
XXH_FORCE_INLINE void XXH_writeLE64(void *dst, xxh_u64 v64) {
if (!XXH_CPU_LITTLE_ENDIAN) v64 = XXH_swap64(v64);
- memcpy(dst, &v64, sizeof(v64));
+ XXH_memcpy(dst, &v64, sizeof(v64));
}
@@ -4176,8 +5431,7 @@ XXH_FORCE_INLINE XXH_TARGET_AVX512 void XXH3_accumulate_512_avx512(
/* data_key = data_vec ^ key_vec; */
__m512i const data_key = _mm512_xor_si512(data_vec, key_vec);
/* data_key_lo = data_key >> 32; */
- __m512i const data_key_lo =
- _mm512_shuffle_epi32(data_key, (_MM_PERM_ENUM)_MM_SHUFFLE(0, 3, 0, 1));
+ __m512i const data_key_lo = _mm512_srli_epi64(data_key, 32);
/* product = (data_key & 0xffffffff) * (data_key_lo & 0xffffffff); */
__m512i const product = _mm512_mul_epu32(data_key, data_key_lo);
/* xacc[0] += swap(data_vec); */
@@ -4191,31 +5445,34 @@ XXH_FORCE_INLINE XXH_TARGET_AVX512 void XXH3_accumulate_512_avx512(
}
-/*
- * XXH3_scrambleAcc: Scrambles the accumulators to improve mixing.
- *
- * Multiplication isn't perfect, as explained by Google in HighwayHash:
- *
- * // Multiplication mixes/scrambles bytes 0-7 of the 64-bit result to
- * // varying degrees. In descending order of goodness, bytes
- * // 3 4 2 5 1 6 0 7 have quality 228 224 164 160 100 96 36 32.
- * // As expected, the upper and lower bytes are much worse.
- *
- * Source:
- * https://github.com/google/highwayhash/blob/0aaf66b/highwayhash/hh_avx2.h#L291
- *
- * Since our algorithm uses a pseudorandom secret to add some variance into the
- * mix, we don't need to (or want to) mix as often or as much as HighwayHash
- * does.
- *
- * This isn't as tight as XXH3_accumulate, but still written in SIMD to avoid
- * extraction.
- *
- * Both XXH3_64bits and XXH3_128bits use this subroutine.
- */
+XXH_FORCE_INLINE XXH_TARGET_AVX512 XXH3_ACCUMULATE_TEMPLATE(avx512)
-XXH_FORCE_INLINE XXH_TARGET_AVX512 void XXH3_scrambleAcc_avx512(
- void *XXH_RESTRICT acc, const void *XXH_RESTRICT secret) {
+ /*
+ * XXH3_scrambleAcc: Scrambles the accumulators to improve mixing.
+ *
+ * Multiplication isn't perfect, as explained by Google in HighwayHash:
+ *
+ * // Multiplication mixes/scrambles bytes 0-7 of the 64-bit result to
+ * // varying degrees. In descending order of goodness, bytes
+ * // 3 4 2 5 1 6 0 7 have quality 228 224 164 160 100 96 36 32.
+ * // As expected, the upper and lower bytes are much worse.
+ *
+ * Source:
+ * https://github.com/google/highwayhash/blob/0aaf66b/highwayhash/hh_avx2.h#L291
+ *
+ * Since our algorithm uses a pseudorandom secret to add some variance into
+ * the mix, we don't need to (or want to) mix as often or as much as
+ * HighwayHash does.
+ *
+ * This isn't as tight as XXH3_accumulate, but still written in SIMD to
+ * avoid extraction.
+ *
+ * Both XXH3_64bits and XXH3_128bits use this subroutine.
+ */
+
+ XXH_FORCE_INLINE XXH_TARGET_AVX512
+ void XXH3_scrambleAcc_avx512(void *XXH_RESTRICT acc,
+ const void *XXH_RESTRICT secret) {
XXH_ASSERT((((size_t)acc) & 63) == 0);
XXH_STATIC_ASSERT(XXH_STRIPE_LEN == sizeof(__m512i));
@@ -4227,14 +5484,13 @@ XXH_FORCE_INLINE XXH_TARGET_AVX512 void XXH3_scrambleAcc_avx512(
/* xacc[0] ^= (xacc[0] >> 47) */
__m512i const acc_vec = *xacc;
__m512i const shifted = _mm512_srli_epi64(acc_vec, 47);
- __m512i const data_vec = _mm512_xor_si512(acc_vec, shifted);
/* xacc[0] ^= secret; */
__m512i const key_vec = _mm512_loadu_si512(secret);
- __m512i const data_key = _mm512_xor_si512(data_vec, key_vec);
+ __m512i const data_key = _mm512_ternarylogic_epi32(
+ key_vec, acc_vec, shifted, 0x96 /* key_vec ^ acc_vec ^ shifted */);
/* xacc[0] *= XXH_PRIME32_1; */
- __m512i const data_key_hi =
- _mm512_shuffle_epi32(data_key, (_MM_PERM_ENUM)_MM_SHUFFLE(0, 3, 0, 1));
+ __m512i const data_key_hi = _mm512_srli_epi64(data_key, 32);
__m512i const prod_lo = _mm512_mul_epu32(data_key, prime32);
__m512i const prod_hi = _mm512_mul_epu32(data_key_hi, prime32);
*xacc = _mm512_add_epi64(prod_lo, _mm512_slli_epi64(prod_hi, 32));
@@ -4253,8 +5509,9 @@ XXH_FORCE_INLINE XXH_TARGET_AVX512 void XXH3_initCustomSecret_avx512(
{
int const nbRounds = XXH_SECRET_DEFAULT_SIZE / sizeof(__m512i);
- __m512i const seed = _mm512_mask_set1_epi64(
- _mm512_set1_epi64((xxh_i64)seed64), 0xAA, (xxh_i64)(0U - seed64));
+ __m512i const seed_pos = _mm512_set1_epi64((xxh_i64)seed64);
+ __m512i const seed =
+ _mm512_mask_sub_epi64(seed_pos, 0xAA, _mm512_set1_epi8(0), seed_pos);
const __m512i *const src = (const __m512i *)((const void *)XXH3_kSecret);
__m512i *const dest = (__m512i *)customSecret;
@@ -4263,18 +5520,7 @@ XXH_FORCE_INLINE XXH_TARGET_AVX512 void XXH3_initCustomSecret_avx512(
XXH_ASSERT(((size_t)dest & 63) == 0);
for (i = 0; i < nbRounds; ++i) {
- /* GCC has a bug, _mm512_stream_load_si512 accepts 'void*', not 'void
- * const*', this will warn "discards 'const' qualifier". */
- union {
-
- const __m512i *cp;
- void *p;
-
- } remote_const_void;
-
- remote_const_void.cp = src + i;
- dest[i] =
- _mm512_add_epi64(_mm512_stream_load_si512(remote_const_void.p), seed);
+ dest[i] = _mm512_add_epi64(_mm512_load_si512(src + i), seed);
}
@@ -4317,8 +5563,7 @@ XXH_FORCE_INLINE XXH_TARGET_AVX2 void XXH3_accumulate_512_avx2(
/* data_key = data_vec ^ key_vec; */
__m256i const data_key = _mm256_xor_si256(data_vec, key_vec);
/* data_key_lo = data_key >> 32; */
- __m256i const data_key_lo =
- _mm256_shuffle_epi32(data_key, _MM_SHUFFLE(0, 3, 0, 1));
+ __m256i const data_key_lo = _mm256_srli_epi64(data_key, 32);
/* product = (data_key & 0xffffffff) * (data_key_lo & 0xffffffff); */
__m256i const product = _mm256_mul_epu32(data_key, data_key_lo);
/* xacc[i] += swap(data_vec); */
@@ -4334,8 +5579,11 @@ XXH_FORCE_INLINE XXH_TARGET_AVX2 void XXH3_accumulate_512_avx2(
}
-XXH_FORCE_INLINE XXH_TARGET_AVX2 void XXH3_scrambleAcc_avx2(
- void *XXH_RESTRICT acc, const void *XXH_RESTRICT secret) {
+XXH_FORCE_INLINE XXH_TARGET_AVX2 XXH3_ACCUMULATE_TEMPLATE(avx2)
+
+ XXH_FORCE_INLINE XXH_TARGET_AVX2
+ void XXH3_scrambleAcc_avx2(void *XXH_RESTRICT acc,
+ const void *XXH_RESTRICT secret) {
XXH_ASSERT((((size_t)acc) & 31) == 0);
{
@@ -4358,8 +5606,7 @@ XXH_FORCE_INLINE XXH_TARGET_AVX2 void XXH3_scrambleAcc_avx2(
__m256i const data_key = _mm256_xor_si256(data_vec, key_vec);
/* xacc[i] *= XXH_PRIME32_1; */
- __m256i const data_key_hi =
- _mm256_shuffle_epi32(data_key, _MM_SHUFFLE(0, 3, 0, 1));
+ __m256i const data_key_hi = _mm256_srli_epi64(data_key, 32);
__m256i const prod_lo = _mm256_mul_epu32(data_key, prime32);
__m256i const prod_hi = _mm256_mul_epu32(data_key_hi, prime32);
xacc[i] = _mm256_add_epi64(prod_lo, _mm256_slli_epi64(prod_hi, 32));
@@ -4399,12 +5646,12 @@ XXH_FORCE_INLINE XXH_TARGET_AVX2 void XXH3_initCustomSecret_avx2(
XXH_ASSERT(((size_t)dest & 31) == 0);
/* GCC -O2 need unroll loop manually */
- dest[0] = _mm256_add_epi64(_mm256_stream_load_si256(src + 0), seed);
- dest[1] = _mm256_add_epi64(_mm256_stream_load_si256(src + 1), seed);
- dest[2] = _mm256_add_epi64(_mm256_stream_load_si256(src + 2), seed);
- dest[3] = _mm256_add_epi64(_mm256_stream_load_si256(src + 3), seed);
- dest[4] = _mm256_add_epi64(_mm256_stream_load_si256(src + 4), seed);
- dest[5] = _mm256_add_epi64(_mm256_stream_load_si256(src + 5), seed);
+ dest[0] = _mm256_add_epi64(_mm256_load_si256(src + 0), seed);
+ dest[1] = _mm256_add_epi64(_mm256_load_si256(src + 1), seed);
+ dest[2] = _mm256_add_epi64(_mm256_load_si256(src + 2), seed);
+ dest[3] = _mm256_add_epi64(_mm256_load_si256(src + 3), seed);
+ dest[4] = _mm256_add_epi64(_mm256_load_si256(src + 4), seed);
+ dest[5] = _mm256_add_epi64(_mm256_load_si256(src + 5), seed);
}
@@ -4462,8 +5709,11 @@ XXH_FORCE_INLINE XXH_TARGET_SSE2 void XXH3_accumulate_512_sse2(
}
-XXH_FORCE_INLINE XXH_TARGET_SSE2 void XXH3_scrambleAcc_sse2(
- void *XXH_RESTRICT acc, const void *XXH_RESTRICT secret) {
+XXH_FORCE_INLINE XXH_TARGET_SSE2 XXH3_ACCUMULATE_TEMPLATE(sse2)
+
+ XXH_FORCE_INLINE XXH_TARGET_SSE2
+ void XXH3_scrambleAcc_sse2(void *XXH_RESTRICT acc,
+ const void *XXH_RESTRICT secret) {
XXH_ASSERT((((size_t)acc) & 15) == 0);
{
@@ -4546,40 +5796,173 @@ XXH_FORCE_INLINE XXH_TARGET_SSE2 void XXH3_initCustomSecret_sse2(
#if (XXH_VECTOR == XXH_NEON)
+/* forward declarations for the scalar routines */
+XXH_FORCE_INLINE void XXH3_scalarRound(void *XXH_RESTRICT acc,
+ void const *XXH_RESTRICT input,
+ void const *XXH_RESTRICT secret,
+ size_t lane);
+
+XXH_FORCE_INLINE void XXH3_scalarScrambleRound(void *XXH_RESTRICT acc,
+ void const *XXH_RESTRICT secret,
+ size_t lane);
+
+/*!
+ * @internal
+ * @brief The bulk processing loop for NEON and WASM SIMD128.
+ *
+ * The NEON code path is actually partially scalar when running on AArch64. This
+ * is to optimize the pipelining and can have up to 15% speedup depending on the
+ * CPU, and it also mitigates some GCC codegen issues.
+ *
+ * @see XXH3_NEON_LANES for configuring this and details about this
+ * optimization.
+ *
+ * NEON's 32-bit to 64-bit long multiply takes a half vector of 32-bit
+ * integers instead of the other platforms which mask full 64-bit vectors,
+ * so the setup is more complicated than just shifting right.
+ *
+ * Additionally, there is an optimization for 4 lanes at once noted below.
+ *
+ * Since, as stated, the most optimal amount of lanes for Cortexes is 6,
+ * there needs to be *three* versions of the accumulate operation used
+ * for the remaining 2 lanes.
+ *
+ * WASM's SIMD128 uses SIMDe's arm_neon.h polyfill because the intrinsics
+ * overlap nearly perfectly.
+ */
+
XXH_FORCE_INLINE void XXH3_accumulate_512_neon(
void *XXH_RESTRICT acc, const void *XXH_RESTRICT input,
const void *XXH_RESTRICT secret) {
XXH_ASSERT((((size_t)acc) & 15) == 0);
- {
-
- uint64x2_t *const xacc = (uint64x2_t *)acc;
+ XXH_STATIC_ASSERT(XXH3_NEON_LANES > 0 && XXH3_NEON_LANES <= XXH_ACC_NB &&
+ XXH3_NEON_LANES % 2 == 0);
+ { /* GCC for darwin arm64 does not like aliasing here */
+ xxh_aliasing_uint64x2_t *const xacc = (xxh_aliasing_uint64x2_t *)acc;
/* We don't use a uint32x4_t pointer because it causes bus errors on ARMv7.
*/
- uint8_t const *const xinput = (const uint8_t *)input;
- uint8_t const *const xsecret = (const uint8_t *)secret;
+ uint8_t const *xinput = (const uint8_t *)input;
+ uint8_t const *xsecret = (const uint8_t *)secret;
size_t i;
- for (i = 0; i < XXH_STRIPE_LEN / sizeof(uint64x2_t); i++) {
+ #ifdef __wasm_simd128__
+ /*
+ * On WASM SIMD128, Clang emits direct address loads when XXH3_kSecret
+ * is constant propagated, which results in it converting it to this
+ * inside the loop:
+ *
+ * a = v128.load(XXH3_kSecret + 0 + $secret_offset, offset = 0)
+ * b = v128.load(XXH3_kSecret + 16 + $secret_offset, offset = 0)
+ * ...
+ *
+ * This requires a full 32-bit address immediate (and therefore a 6 byte
+ * instruction) as well as an add for each offset.
+ *
+ * Putting an asm guard prevents it from folding (at the cost of losing
+ * the alignment hint), and uses the free offset in `v128.load` instead
+ * of adding secret_offset each time which overall reduces code size by
+ * about a kilobyte and improves performance.
+ */
+ XXH_COMPILER_GUARD(xsecret);
+ #endif
+ /* Scalar lanes use the normal scalarRound routine */
+ for (i = XXH3_NEON_LANES; i < XXH_ACC_NB; i++) {
+
+ XXH3_scalarRound(acc, input, secret, i);
+
+ }
+
+ i = 0;
+ /* 4 NEON lanes at a time. */
+ for (; i + 1 < XXH3_NEON_LANES / 2; i += 2) {
/* data_vec = xinput[i]; */
- uint8x16_t data_vec = vld1q_u8(xinput + (i * 16));
+ uint64x2_t data_vec_1 = XXH_vld1q_u64(xinput + (i * 16));
+ uint64x2_t data_vec_2 = XXH_vld1q_u64(xinput + ((i + 1) * 16));
/* key_vec = xsecret[i]; */
- uint8x16_t key_vec = vld1q_u8(xsecret + (i * 16));
- uint64x2_t data_key;
- uint32x2_t data_key_lo, data_key_hi;
- /* xacc[i] += swap(data_vec); */
- uint64x2_t const data64 = vreinterpretq_u64_u8(data_vec);
- uint64x2_t const swapped = vextq_u64(data64, data64, 1);
- xacc[i] = vaddq_u64(xacc[i], swapped);
+ uint64x2_t key_vec_1 = XXH_vld1q_u64(xsecret + (i * 16));
+ uint64x2_t key_vec_2 = XXH_vld1q_u64(xsecret + ((i + 1) * 16));
+ /* data_swap = swap(data_vec) */
+ uint64x2_t data_swap_1 = vextq_u64(data_vec_1, data_vec_1, 1);
+ uint64x2_t data_swap_2 = vextq_u64(data_vec_2, data_vec_2, 1);
+ /* data_key = data_vec ^ key_vec; */
+ uint64x2_t data_key_1 = veorq_u64(data_vec_1, key_vec_1);
+ uint64x2_t data_key_2 = veorq_u64(data_vec_2, key_vec_2);
+
+ /*
+ * If we reinterpret the 64x2 vectors as 32x4 vectors, we can use a
+ * de-interleave operation for 4 lanes in 1 step with `vuzpq_u32` to
+ * get one vector with the low 32 bits of each lane, and one vector
+ * with the high 32 bits of each lane.
+ *
+ * The intrinsic returns a double vector because the original ARMv7-a
+ * instruction modified both arguments in place. AArch64 and SIMD128 emit
+ * two instructions from this intrinsic.
+ *
+ * [ dk11L | dk11H | dk12L | dk12H ] -> [ dk11L | dk12L | dk21L | dk22L ]
+ * [ dk21L | dk21H | dk22L | dk22H ] -> [ dk11H | dk12H | dk21H | dk22H ]
+ */
+ uint32x4x2_t unzipped = vuzpq_u32(vreinterpretq_u32_u64(data_key_1),
+ vreinterpretq_u32_u64(data_key_2));
+ /* data_key_lo = data_key & 0xFFFFFFFF */
+ uint32x4_t data_key_lo = unzipped.val[0];
+ /* data_key_hi = data_key >> 32 */
+ uint32x4_t data_key_hi = unzipped.val[1];
+ /*
+ * Then, we can split the vectors horizontally and multiply which, as for
+ * most widening intrinsics, have a variant that works on both high half
+ * vectors for free on AArch64. A similar instruction is available on
+ * SIMD128.
+ *
+ * sum = data_swap + (u64x2) data_key_lo * (u64x2) data_key_hi
+ */
+ uint64x2_t sum_1 =
+ XXH_vmlal_low_u32(data_swap_1, data_key_lo, data_key_hi);
+ uint64x2_t sum_2 =
+ XXH_vmlal_high_u32(data_swap_2, data_key_lo, data_key_hi);
+ /*
+ * Clang reorders
+ * a += b * c; // umlal swap.2d, dkl.2s, dkh.2s
+ * c += a; // add acc.2d, acc.2d, swap.2d
+ * to
+ * c += a; // add acc.2d, acc.2d, swap.2d
+ * c += b * c; // umlal acc.2d, dkl.2s, dkh.2s
+ *
+ * While it would make sense in theory since the addition is faster,
+ * for reasons likely related to umlal being limited to certain NEON
+ * pipelines, this is worse. A compiler guard fixes this.
+ */
+ XXH_COMPILER_GUARD_CLANG_NEON(sum_1);
+ XXH_COMPILER_GUARD_CLANG_NEON(sum_2);
+ /* xacc[i] = acc_vec + sum; */
+ xacc[i] = vaddq_u64(xacc[i], sum_1);
+ xacc[i + 1] = vaddq_u64(xacc[i + 1], sum_2);
+
+ }
+
+ /* Operate on the remaining NEON lanes 2 at a time. */
+ for (; i < XXH3_NEON_LANES / 2; i++) {
+
+ /* data_vec = xinput[i]; */
+ uint64x2_t data_vec = XXH_vld1q_u64(xinput + (i * 16));
+ /* key_vec = xsecret[i]; */
+ uint64x2_t key_vec = XXH_vld1q_u64(xsecret + (i * 16));
+ /* acc_vec_2 = swap(data_vec) */
+ uint64x2_t data_swap = vextq_u64(data_vec, data_vec, 1);
/* data_key = data_vec ^ key_vec; */
- data_key = vreinterpretq_u64_u8(veorq_u8(data_vec, key_vec));
- /* data_key_lo = (uint32x2_t) (data_key & 0xFFFFFFFF);
- * data_key_hi = (uint32x2_t) (data_key >> 32);
- * data_key = UNDEFINED; */
- XXH_SPLIT_IN_PLACE(data_key, data_key_lo, data_key_hi);
- /* xacc[i] += (uint64x2_t) data_key_lo * (uint64x2_t) data_key_hi; */
- xacc[i] = vmlal_u32(xacc[i], data_key_lo, data_key_hi);
+ uint64x2_t data_key = veorq_u64(data_vec, key_vec);
+ /* For two lanes, just use VMOVN and VSHRN. */
+ /* data_key_lo = data_key & 0xFFFFFFFF; */
+ uint32x2_t data_key_lo = vmovn_u64(data_key);
+ /* data_key_hi = data_key >> 32; */
+ uint32x2_t data_key_hi = vshrn_n_u64(data_key, 32);
+ /* sum = data_swap + (u64x2) data_key_lo * (u64x2) data_key_hi; */
+ uint64x2_t sum = vmlal_u32(data_swap, data_key_lo, data_key_hi);
+ /* Same Clang workaround as before */
+ XXH_COMPILER_GUARD_CLANG_NEON(sum);
+ /* xacc[i] = acc_vec + sum; */
+ xacc[i] = vaddq_u64(xacc[i], sum);
}
@@ -4587,19 +5970,37 @@ XXH_FORCE_INLINE void XXH3_accumulate_512_neon(
}
-XXH_FORCE_INLINE void XXH3_scrambleAcc_neon(void *XXH_RESTRICT acc,
- const void *XXH_RESTRICT secret) {
+XXH_FORCE_INLINE XXH3_ACCUMULATE_TEMPLATE(neon)
+
+ XXH_FORCE_INLINE
+ void XXH3_scrambleAcc_neon(void *XXH_RESTRICT acc,
+ const void *XXH_RESTRICT secret) {
XXH_ASSERT((((size_t)acc) & 15) == 0);
{
- uint64x2_t *xacc = (uint64x2_t *)acc;
- uint8_t const *xsecret = (uint8_t const *)secret;
- uint32x2_t prime = vdup_n_u32(XXH_PRIME32_1);
+ xxh_aliasing_uint64x2_t *xacc = (xxh_aliasing_uint64x2_t *)acc;
+ uint8_t const *xsecret = (uint8_t const *)secret;
size_t i;
- for (i = 0; i < XXH_STRIPE_LEN / sizeof(uint64x2_t); i++) {
+ /* WASM uses operator overloads and doesn't need these. */
+ #ifndef __wasm_simd128__
+ /* { prime32_1, prime32_1 } */
+ uint32x2_t const kPrimeLo = vdup_n_u32(XXH_PRIME32_1);
+ /* { 0, prime32_1, 0, prime32_1 } */
+ uint32x4_t const kPrimeHi =
+ vreinterpretq_u32_u64(vdupq_n_u64((xxh_u64)XXH_PRIME32_1 << 32));
+ #endif
+
+ /* AArch64 uses both scalar and neon at the same time */
+ for (i = XXH3_NEON_LANES; i < XXH_ACC_NB; i++) {
+
+ XXH3_scalarScrambleRound(acc, secret, i);
+
+ }
+
+ for (i = 0; i < XXH3_NEON_LANES / 2; i++) {
/* xacc[i] ^= (xacc[i] >> 47); */
uint64x2_t acc_vec = xacc[i];
@@ -4607,40 +6008,32 @@ XXH_FORCE_INLINE void XXH3_scrambleAcc_neon(void *XXH_RESTRICT acc,
uint64x2_t data_vec = veorq_u64(acc_vec, shifted);
/* xacc[i] ^= xsecret[i]; */
- uint8x16_t key_vec = vld1q_u8(xsecret + (i * 16));
- uint64x2_t data_key = veorq_u64(data_vec, vreinterpretq_u64_u8(key_vec));
-
- /* xacc[i] *= XXH_PRIME32_1 */
- uint32x2_t data_key_lo, data_key_hi;
- /* data_key_lo = (uint32x2_t) (xacc[i] & 0xFFFFFFFF);
- * data_key_hi = (uint32x2_t) (xacc[i] >> 32);
- * xacc[i] = UNDEFINED; */
- XXH_SPLIT_IN_PLACE(data_key, data_key_lo, data_key_hi);
- { /*
- * prod_hi = (data_key >> 32) * XXH_PRIME32_1;
- *
- * Avoid vmul_u32 + vshll_n_u32 since Clang 6 and 7 will
- * incorrectly "optimize" this:
- * tmp = vmul_u32(vmovn_u64(a), vmovn_u64(b));
- * shifted = vshll_n_u32(tmp, 32);
- * to this:
- * tmp = "vmulq_u64"(a, b); // no such thing!
- * shifted = vshlq_n_u64(tmp, 32);
- *
- * However, unlike SSE, Clang lacks a 64-bit multiply routine
- * for NEON, and it scalarizes two 64-bit multiplies instead.
- *
- * vmull_u32 has the same timing as vmul_u32, and it avoids
- * this bug completely.
- * See https://bugs.llvm.org/show_bug.cgi?id=39967
- */
- uint64x2_t prod_hi = vmull_u32(data_key_hi, prime);
- /* xacc[i] = prod_hi << 32; */
- xacc[i] = vshlq_n_u64(prod_hi, 32);
- /* xacc[i] += (prod_hi & 0xFFFFFFFF) * XXH_PRIME32_1; */
- xacc[i] = vmlal_u32(xacc[i], data_key_lo, prime);
-
- }
+ uint64x2_t key_vec = XXH_vld1q_u64(xsecret + (i * 16));
+ uint64x2_t data_key = veorq_u64(data_vec, key_vec);
+ /* xacc[i] *= XXH_PRIME32_1 */
+ #ifdef __wasm_simd128__
+ /* SIMD128 has multiply by u64x2, use it instead of expanding and
+ * scalarizing */
+ xacc[i] = data_key * XXH_PRIME32_1;
+ #else
+ /*
+ * Expanded version with portable NEON intrinsics
+ *
+ * lo(x) * lo(y) + (hi(x) * lo(y) << 32)
+ *
+ * prod_hi = hi(data_key) * lo(prime) << 32
+ *
+ * Since we only need 32 bits of this multiply a trick can be used,
+ * reinterpreting the vector as a uint32x4_t and multiplying by { 0,
+ * prime, 0, prime } to cancel out the unwanted bits and avoid the shift.
+ */
+ uint32x4_t prod_hi = vmulq_u32(vreinterpretq_u32_u64(data_key), kPrimeHi);
+ /* Extract low bits for vmlal_u32 */
+ uint32x2_t data_key_lo = vmovn_u64(data_key);
+ /* xacc[i] = prod_hi + lo(data_key) * XXH_PRIME32_1; */
+ xacc[i] =
+ vmlal_u32(vreinterpretq_u64_u32(prod_hi), data_key_lo, kPrimeLo);
+ #endif
}
@@ -4656,47 +6049,54 @@ XXH_FORCE_INLINE void XXH3_accumulate_512_vsx(void *XXH_RESTRICT acc,
const void *XXH_RESTRICT input,
const void *XXH_RESTRICT secret) {
- xxh_u64x2 *const xacc = (xxh_u64x2 *)acc; /* presumed aligned */
- xxh_u64x2 const *const xinput =
- (xxh_u64x2 const *)input; /* no alignment restriction */
- xxh_u64x2 const *const xsecret =
- (xxh_u64x2 const *)secret; /* no alignment restriction */
+ /* presumed aligned */
+ xxh_aliasing_u64x2 *const xacc = (xxh_aliasing_u64x2 *)acc;
+ xxh_u8 const *const xinput =
+ (xxh_u8 const *)input; /* no alignment restriction */
+ xxh_u8 const *const xsecret =
+ (xxh_u8 const *)secret; /* no alignment restriction */
xxh_u64x2 const v32 = {32, 32};
size_t i;
for (i = 0; i < XXH_STRIPE_LEN / sizeof(xxh_u64x2); i++) {
/* data_vec = xinput[i]; */
- xxh_u64x2 const data_vec = XXH_vec_loadu(xinput + i);
+ xxh_u64x2 const data_vec = XXH_vec_loadu(xinput + 16 * i);
/* key_vec = xsecret[i]; */
- xxh_u64x2 const key_vec = XXH_vec_loadu(xsecret + i);
+ xxh_u64x2 const key_vec = XXH_vec_loadu(xsecret + 16 * i);
xxh_u64x2 const data_key = data_vec ^ key_vec;
/* shuffled = (data_key << 32) | (data_key >> 32); */
xxh_u32x4 const shuffled = (xxh_u32x4)vec_rl(data_key, v32);
/* product = ((xxh_u64x2)data_key & 0xFFFFFFFF) * ((xxh_u64x2)shuffled &
* 0xFFFFFFFF); */
xxh_u64x2 const product = XXH_vec_mulo((xxh_u32x4)data_key, shuffled);
- xacc[i] += product;
+ /* acc_vec = xacc[i]; */
+ xxh_u64x2 acc_vec = xacc[i];
+ acc_vec += product;
/* swap high and low halves */
#ifdef __s390x__
- xacc[i] += vec_permi(data_vec, data_vec, 2);
+ acc_vec += vec_permi(data_vec, data_vec, 2);
#else
- xacc[i] += vec_xxpermdi(data_vec, data_vec, 2);
+ acc_vec += vec_xxpermdi(data_vec, data_vec, 2);
#endif
+ xacc[i] = acc_vec;
}
}
-XXH_FORCE_INLINE void XXH3_scrambleAcc_vsx(void *XXH_RESTRICT acc,
- const void *XXH_RESTRICT secret) {
+XXH_FORCE_INLINE XXH3_ACCUMULATE_TEMPLATE(vsx)
+
+ XXH_FORCE_INLINE
+ void XXH3_scrambleAcc_vsx(void *XXH_RESTRICT acc,
+ const void *XXH_RESTRICT secret) {
XXH_ASSERT((((size_t)acc) & 15) == 0);
{
- xxh_u64x2 *const xacc = (xxh_u64x2 *)acc;
- const xxh_u64x2 *const xsecret = (const xxh_u64x2 *)secret;
+ xxh_aliasing_u64x2 *const xacc = (xxh_aliasing_u64x2 *)acc;
+ const xxh_u8 *const xsecret = (const xxh_u8 *)secret;
/* constants */
xxh_u64x2 const v32 = {32, 32};
xxh_u64x2 const v47 = {47, 47};
@@ -4710,7 +6110,7 @@ XXH_FORCE_INLINE void XXH3_scrambleAcc_vsx(void *XXH_RESTRICT acc,
xxh_u64x2 const data_vec = acc_vec ^ (acc_vec >> v47);
/* xacc[i] ^= xsecret[i]; */
- xxh_u64x2 const key_vec = XXH_vec_loadu(xsecret + i);
+ xxh_u64x2 const key_vec = XXH_vec_loadu(xsecret + 16 * i);
xxh_u64x2 const data_key = data_vec ^ key_vec;
/* xacc[i] *= XXH_PRIME32_1 */
@@ -4729,46 +6129,272 @@ XXH_FORCE_INLINE void XXH3_scrambleAcc_vsx(void *XXH_RESTRICT acc,
#endif
-/* scalar variants - universal */
+ #if (XXH_VECTOR == XXH_SVE)
+
+XXH_FORCE_INLINE void XXH3_accumulate_512_sve(void *XXH_RESTRICT acc,
+ const void *XXH_RESTRICT input,
+ const void *XXH_RESTRICT secret) {
+
+ uint64_t *xacc = (uint64_t *)acc;
+ const uint64_t *xinput = (const uint64_t *)(const void *)input;
+ const uint64_t *xsecret = (const uint64_t *)(const void *)secret;
+ svuint64_t kSwap = sveor_n_u64_z(svptrue_b64(), svindex_u64(0, 1), 1);
+ uint64_t element_count = svcntd();
+ if (element_count >= 8) {
+
+ svbool_t mask = svptrue_pat_b64(SV_VL8);
+ svuint64_t vacc = svld1_u64(mask, xacc);
+ ACCRND(vacc, 0);
+ svst1_u64(mask, xacc, vacc);
+
+ } else if (element_count == 2) { /* sve128 */
+
+ svbool_t mask = svptrue_pat_b64(SV_VL2);
+ svuint64_t acc0 = svld1_u64(mask, xacc + 0);
+ svuint64_t acc1 = svld1_u64(mask, xacc + 2);
+ svuint64_t acc2 = svld1_u64(mask, xacc + 4);
+ svuint64_t acc3 = svld1_u64(mask, xacc + 6);
+ ACCRND(acc0, 0);
+ ACCRND(acc1, 2);
+ ACCRND(acc2, 4);
+ ACCRND(acc3, 6);
+ svst1_u64(mask, xacc + 0, acc0);
+ svst1_u64(mask, xacc + 2, acc1);
+ svst1_u64(mask, xacc + 4, acc2);
+ svst1_u64(mask, xacc + 6, acc3);
+
+ } else {
+
+ svbool_t mask = svptrue_pat_b64(SV_VL4);
+ svuint64_t acc0 = svld1_u64(mask, xacc + 0);
+ svuint64_t acc1 = svld1_u64(mask, xacc + 4);
+ ACCRND(acc0, 0);
+ ACCRND(acc1, 4);
+ svst1_u64(mask, xacc + 0, acc0);
+ svst1_u64(mask, xacc + 4, acc1);
+
+ }
+
+}
+
+XXH_FORCE_INLINE void XXH3_accumulate_sve(xxh_u64 *XXH_RESTRICT acc,
+ const xxh_u8 *XXH_RESTRICT input,
+ const xxh_u8 *XXH_RESTRICT secret,
+ size_t nbStripes) {
+
+ if (nbStripes != 0) {
+
+ uint64_t *xacc = (uint64_t *)acc;
+ const uint64_t *xinput = (const uint64_t *)(const void *)input;
+ const uint64_t *xsecret = (const uint64_t *)(const void *)secret;
+ svuint64_t kSwap = sveor_n_u64_z(svptrue_b64(), svindex_u64(0, 1), 1);
+ uint64_t element_count = svcntd();
+ if (element_count >= 8) {
+
+ svbool_t mask = svptrue_pat_b64(SV_VL8);
+ svuint64_t vacc = svld1_u64(mask, xacc + 0);
+ do {
+
+ /* svprfd(svbool_t, void *, enum svfprop); */
+ svprfd(mask, xinput + 128, SV_PLDL1STRM);
+ ACCRND(vacc, 0);
+ xinput += 8;
+ xsecret += 1;
+ nbStripes--;
+
+ } while (nbStripes != 0);
+
+ svst1_u64(mask, xacc + 0, vacc);
+
+ } else if (element_count == 2) { /* sve128 */
+
+ svbool_t mask = svptrue_pat_b64(SV_VL2);
+ svuint64_t acc0 = svld1_u64(mask, xacc + 0);
+ svuint64_t acc1 = svld1_u64(mask, xacc + 2);
+ svuint64_t acc2 = svld1_u64(mask, xacc + 4);
+ svuint64_t acc3 = svld1_u64(mask, xacc + 6);
+ do {
+
+ svprfd(mask, xinput + 128, SV_PLDL1STRM);
+ ACCRND(acc0, 0);
+ ACCRND(acc1, 2);
+ ACCRND(acc2, 4);
+ ACCRND(acc3, 6);
+ xinput += 8;
+ xsecret += 1;
+ nbStripes--;
+
+ } while (nbStripes != 0);
+
+ svst1_u64(mask, xacc + 0, acc0);
+ svst1_u64(mask, xacc + 2, acc1);
+ svst1_u64(mask, xacc + 4, acc2);
+ svst1_u64(mask, xacc + 6, acc3);
+
+ } else {
+
+ svbool_t mask = svptrue_pat_b64(SV_VL4);
+ svuint64_t acc0 = svld1_u64(mask, xacc + 0);
+ svuint64_t acc1 = svld1_u64(mask, xacc + 4);
+ do {
+
+ svprfd(mask, xinput + 128, SV_PLDL1STRM);
+ ACCRND(acc0, 0);
+ ACCRND(acc1, 4);
+ xinput += 8;
+ xsecret += 1;
+ nbStripes--;
+
+ } while (nbStripes != 0);
+
+ svst1_u64(mask, xacc + 0, acc0);
+ svst1_u64(mask, xacc + 4, acc1);
+
+ }
+
+ }
+
+}
+
+ #endif
+
+ /* scalar variants - universal */
+
+ #if defined(__aarch64__) && (defined(__GNUC__) || defined(__clang__))
+/*
+ * In XXH3_scalarRound(), GCC and Clang have a similar codegen issue, where they
+ * emit an excess mask and a full 64-bit multiply-add (MADD X-form).
+ *
+ * While this might not seem like much, as AArch64 is a 64-bit architecture,
+ * only big Cortex designs have a full 64-bit multiplier.
+ *
+ * On the little cores, the smaller 32-bit multiplier is used, and full 64-bit
+ * multiplies expand to 2-3 multiplies in microcode. This has a major penalty
+ * of up to 4 latency cycles and 2 stall cycles in the multiply pipeline.
+ *
+ * Thankfully, AArch64 still provides the 32-bit long multiply-add (UMADDL)
+ * which does not have this penalty and does the mask automatically.
+ */
+XXH_FORCE_INLINE xxh_u64 XXH_mult32to64_add64(xxh_u64 lhs, xxh_u64 rhs,
+ xxh_u64 acc) {
+
+ xxh_u64 ret;
+ /* note: %x = 64-bit register, %w = 32-bit register */
+ __asm__("umaddl %x0, %w1, %w2, %x3"
+ : "=r"(ret)
+ : "r"(lhs), "r"(rhs), "r"(acc));
+ return ret;
+
+}
+
+ #else
+XXH_FORCE_INLINE xxh_u64 XXH_mult32to64_add64(xxh_u64 lhs, xxh_u64 rhs,
+ xxh_u64 acc) {
+
+ return XXH_mult32to64((xxh_u32)lhs, (xxh_u32)rhs) + acc;
+
+}
+ #endif
+
+/*!
+ * @internal
+ * @brief Scalar round for @ref XXH3_accumulate_512_scalar().
+ *
+ * This is extracted to its own function because the NEON path uses a
+ * combination of NEON and scalar.
+ */
+XXH_FORCE_INLINE void XXH3_scalarRound(void *XXH_RESTRICT acc,
+ void const *XXH_RESTRICT input,
+ void const *XXH_RESTRICT secret,
+ size_t lane) {
+
+ xxh_u64 *xacc = (xxh_u64 *)acc;
+ xxh_u8 const *xinput = (xxh_u8 const *)input;
+ xxh_u8 const *xsecret = (xxh_u8 const *)secret;
+ XXH_ASSERT(lane < XXH_ACC_NB);
+ XXH_ASSERT(((size_t)acc & (XXH_ACC_ALIGN - 1)) == 0);
+ {
+
+ xxh_u64 const data_val = XXH_readLE64(xinput + lane * 8);
+ xxh_u64 const data_key = data_val ^ XXH_readLE64(xsecret + lane * 8);
+ xacc[lane ^ 1] += data_val; /* swap adjacent lanes */
+ xacc[lane] = XXH_mult32to64_add64(data_key /* & 0xFFFFFFFF */,
+ data_key >> 32, xacc[lane]);
+
+ }
+
+}
+
+/*!
+ * @internal
+ * @brief Processes a 64 byte block of data using the scalar path.
+ */
XXH_FORCE_INLINE void XXH3_accumulate_512_scalar(
void *XXH_RESTRICT acc, const void *XXH_RESTRICT input,
const void *XXH_RESTRICT secret) {
- xxh_u64 *const xacc = (xxh_u64 *)acc; /* presumed aligned */
- const xxh_u8 *const xinput =
- (const xxh_u8 *)input; /* no alignment restriction */
- const xxh_u8 *const xsecret =
- (const xxh_u8 *)secret; /* no alignment restriction */
size_t i;
- XXH_ASSERT(((size_t)acc & (XXH_ACC_ALIGN - 1)) == 0);
+ /* ARM GCC refuses to unroll this loop, resulting in a 24% slowdown on
+ * ARMv6. */
+ #if defined(__GNUC__) && !defined(__clang__) && \
+ (defined(__arm__) || defined(__thumb2__)) && \
+ defined(__ARM_FEATURE_UNALIGNED) /* no unaligned access just wastes \
+ bytes */ \
+ && XXH_SIZE_OPT <= 0
+ #pragma GCC unroll 8
+ #endif
for (i = 0; i < XXH_ACC_NB; i++) {
- xxh_u64 const data_val = XXH_readLE64(xinput + 8 * i);
- xxh_u64 const data_key = data_val ^ XXH_readLE64(xsecret + i * 8);
- xacc[i ^ 1] += data_val; /* swap adjacent lanes */
- xacc[i] += XXH_mult32to64(data_key & 0xFFFFFFFF, data_key >> 32);
+ XXH3_scalarRound(acc, input, secret, i);
}
}
-XXH_FORCE_INLINE void XXH3_scrambleAcc_scalar(void *XXH_RESTRICT acc,
- const void *XXH_RESTRICT secret) {
+XXH_FORCE_INLINE XXH3_ACCUMULATE_TEMPLATE(scalar)
+
+ /*!
+ * @internal
+ * @brief Scalar scramble step for @ref XXH3_scrambleAcc_scalar().
+ *
+ * This is extracted to its own function because the NEON path uses a
+ * combination of NEON and scalar.
+ */
+ XXH_FORCE_INLINE
+ void XXH3_scalarScrambleRound(void *XXH_RESTRICT acc,
+ void const *XXH_RESTRICT secret,
+ size_t lane) {
xxh_u64 *const xacc = (xxh_u64 *)acc; /* presumed aligned */
const xxh_u8 *const xsecret =
(const xxh_u8 *)secret; /* no alignment restriction */
- size_t i;
XXH_ASSERT((((size_t)acc) & (XXH_ACC_ALIGN - 1)) == 0);
- for (i = 0; i < XXH_ACC_NB; i++) {
+ XXH_ASSERT(lane < XXH_ACC_NB);
+ {
- xxh_u64 const key64 = XXH_readLE64(xsecret + 8 * i);
- xxh_u64 acc64 = xacc[i];
+ xxh_u64 const key64 = XXH_readLE64(xsecret + lane * 8);
+ xxh_u64 acc64 = xacc[lane];
acc64 = XXH_xorshift64(acc64, 47);
acc64 ^= key64;
acc64 *= XXH_PRIME32_1;
- xacc[i] = acc64;
+ xacc[lane] = acc64;
+
+ }
+
+}
+
+/*!
+ * @internal
+ * @brief Scrambles the accumulators after a large chunk has been read
+ */
+XXH_FORCE_INLINE void XXH3_scrambleAcc_scalar(void *XXH_RESTRICT acc,
+ const void *XXH_RESTRICT secret) {
+
+ size_t i;
+ for (i = 0; i < XXH_ACC_NB; i++) {
+
+ XXH3_scalarScrambleRound(acc, secret, i);
}
@@ -4785,15 +6411,16 @@ XXH_FORCE_INLINE void XXH3_initCustomSecret_scalar(
const xxh_u8 *kSecretPtr = XXH3_kSecret;
XXH_STATIC_ASSERT((XXH_SECRET_DEFAULT_SIZE & 15) == 0);
- #if defined(__clang__) && defined(__aarch64__)
+ #if defined(__GNUC__) && defined(__aarch64__)
/*
* UGLY HACK:
- * Clang generates a bunch of MOV/MOVK pairs for aarch64, and they are
+ * GCC and Clang generate a bunch of MOV/MOVK pairs for aarch64, and they are
* placed sequentially, in order, at the top of the unrolled loop.
*
* While MOVK is great for generating constants (2 cycles for a 64-bit
- * constant compared to 4 cycles for LDR), long MOVK chains stall the
- * integer pipelines:
+ * constant compared to 4 cycles for LDR), it fights for bandwidth with
+ * the arithmetic instructions.
+ *
* I L S
* MOVK
* MOVK
@@ -4802,7 +6429,7 @@ XXH_FORCE_INLINE void XXH3_initCustomSecret_scalar(
* ADD
* SUB STR
* STR
- * By forcing loads from memory (as the asm line causes Clang to assume
+ * By forcing loads from memory (as the asm line causes the compiler to assume
* that XXH3_kSecretPtr has been changed), the pipelines are used more
* efficiently:
* I L S
@@ -4810,18 +6437,15 @@ XXH_FORCE_INLINE void XXH3_initCustomSecret_scalar(
* ADD LDR
* SUB STR
* STR
+ *
+ * See XXH3_NEON_LANES for details on the pipsline.
+ *
* XXH3_64bits_withSeed, len == 256, Snapdragon 835
* without hack: 2654.4 MB/s
* with hack: 3202.9 MB/s
*/
XXH_COMPILER_GUARD(kSecretPtr);
#endif
- /*
- * Note: in debug mode, this overrides the asm optimization
- * and Clang will emit MOVK chains again.
- */
- XXH_ASSERT(kSecretPtr == XXH3_kSecret);
-
{
int const nbRounds = XXH_SECRET_DEFAULT_SIZE / 16;
@@ -4829,7 +6453,7 @@ XXH_FORCE_INLINE void XXH3_initCustomSecret_scalar(
for (i = 0; i < nbRounds; i++) {
/*
- * The asm hack causes Clang to assume that kSecretPtr aliases with
+ * The asm hack causes the compiler to assume that kSecretPtr aliases with
* customSecret, and on aarch64, this prevented LDP from merging two
* loads together for free. Putting the loads together before the stores
* properly generates LDP.
@@ -4845,87 +6469,71 @@ XXH_FORCE_INLINE void XXH3_initCustomSecret_scalar(
}
-typedef void (*XXH3_f_accumulate_512)(void *XXH_RESTRICT, const void *,
- const void *);
+typedef void (*XXH3_f_accumulate)(xxh_u64 *XXH_RESTRICT,
+ const xxh_u8 *XXH_RESTRICT,
+ const xxh_u8 *XXH_RESTRICT, size_t);
typedef void (*XXH3_f_scrambleAcc)(void *XXH_RESTRICT, const void *);
typedef void (*XXH3_f_initCustomSecret)(void *XXH_RESTRICT, xxh_u64);
#if (XXH_VECTOR == XXH_AVX512)
#define XXH3_accumulate_512 XXH3_accumulate_512_avx512
+ #define XXH3_accumulate XXH3_accumulate_avx512
#define XXH3_scrambleAcc XXH3_scrambleAcc_avx512
#define XXH3_initCustomSecret XXH3_initCustomSecret_avx512
#elif (XXH_VECTOR == XXH_AVX2)
#define XXH3_accumulate_512 XXH3_accumulate_512_avx2
+ #define XXH3_accumulate XXH3_accumulate_avx2
#define XXH3_scrambleAcc XXH3_scrambleAcc_avx2
#define XXH3_initCustomSecret XXH3_initCustomSecret_avx2
#elif (XXH_VECTOR == XXH_SSE2)
#define XXH3_accumulate_512 XXH3_accumulate_512_sse2
+ #define XXH3_accumulate XXH3_accumulate_sse2
#define XXH3_scrambleAcc XXH3_scrambleAcc_sse2
#define XXH3_initCustomSecret XXH3_initCustomSecret_sse2
#elif (XXH_VECTOR == XXH_NEON)
#define XXH3_accumulate_512 XXH3_accumulate_512_neon
+ #define XXH3_accumulate XXH3_accumulate_neon
#define XXH3_scrambleAcc XXH3_scrambleAcc_neon
#define XXH3_initCustomSecret XXH3_initCustomSecret_scalar
#elif (XXH_VECTOR == XXH_VSX)
#define XXH3_accumulate_512 XXH3_accumulate_512_vsx
+ #define XXH3_accumulate XXH3_accumulate_vsx
#define XXH3_scrambleAcc XXH3_scrambleAcc_vsx
#define XXH3_initCustomSecret XXH3_initCustomSecret_scalar
+ #elif (XXH_VECTOR == XXH_SVE)
+ #define XXH3_accumulate_512 XXH3_accumulate_512_sve
+ #define XXH3_accumulate XXH3_accumulate_sve
+ #define XXH3_scrambleAcc XXH3_scrambleAcc_scalar
+ #define XXH3_initCustomSecret XXH3_initCustomSecret_scalar
+
#else /* scalar */
#define XXH3_accumulate_512 XXH3_accumulate_512_scalar
+ #define XXH3_accumulate XXH3_accumulate_scalar
#define XXH3_scrambleAcc XXH3_scrambleAcc_scalar
#define XXH3_initCustomSecret XXH3_initCustomSecret_scalar
#endif
- #ifndef XXH_PREFETCH_DIST
- #ifdef __clang__
- #define XXH_PREFETCH_DIST 320
- #else
- #if (XXH_VECTOR == XXH_AVX512)
- #define XXH_PREFETCH_DIST 512
- #else
- #define XXH_PREFETCH_DIST 384
- #endif
- #endif /* __clang__ */
- #endif /* XXH_PREFETCH_DIST */
-
-/*
- * XXH3_accumulate()
- * Loops over XXH3_accumulate_512().
- * Assumption: nbStripes will not overflow the secret size
- */
-XXH_FORCE_INLINE void XXH3_accumulate(xxh_u64 *XXH_RESTRICT acc,
- const xxh_u8 *XXH_RESTRICT input,
- const xxh_u8 *XXH_RESTRICT secret,
- size_t nbStripes,
- XXH3_f_accumulate_512 f_acc512) {
-
- size_t n;
- for (n = 0; n < nbStripes; n++) {
-
- const xxh_u8 *const in = input + n * XXH_STRIPE_LEN;
- XXH_PREFETCH(in + XXH_PREFETCH_DIST);
- f_acc512(acc, in, secret + n * XXH_SECRET_CONSUME_RATE);
-
- }
-
-}
+ #if XXH_SIZE_OPT >= 1 /* don't do SIMD for initialization */
+ #undef XXH3_initCustomSecret
+ #define XXH3_initCustomSecret XXH3_initCustomSecret_scalar
+ #endif
XXH_FORCE_INLINE void XXH3_hashLong_internal_loop(
xxh_u64 *XXH_RESTRICT acc, const xxh_u8 *XXH_RESTRICT input, size_t len,
const xxh_u8 *XXH_RESTRICT secret, size_t secretSize,
- XXH3_f_accumulate_512 f_acc512, XXH3_f_scrambleAcc f_scramble) {
+ XXH3_f_accumulate f_acc, XXH3_f_scrambleAcc f_scramble) {
size_t const nbStripesPerBlock =
(secretSize - XXH_STRIPE_LEN) / XXH_SECRET_CONSUME_RATE;
@@ -4938,8 +6546,7 @@ XXH_FORCE_INLINE void XXH3_hashLong_internal_loop(
for (n = 0; n < nb_blocks; n++) {
- XXH3_accumulate(acc, input + n * block_len, secret, nbStripesPerBlock,
- f_acc512);
+ f_acc(acc, input + n * block_len, secret, nbStripesPerBlock);
f_scramble(acc, secret + secretSize - XXH_STRIPE_LEN);
}
@@ -4951,8 +6558,7 @@ XXH_FORCE_INLINE void XXH3_hashLong_internal_loop(
size_t const nbStripes =
((len - 1) - (block_len * nb_blocks)) / XXH_STRIPE_LEN;
XXH_ASSERT(nbStripes <= (secretSize / XXH_SECRET_CONSUME_RATE));
- XXH3_accumulate(acc, input + nb_blocks * block_len, secret, nbStripes,
- f_acc512);
+ f_acc(acc, input + nb_blocks * block_len, secret, nbStripes);
/* last stripe */
{
@@ -4961,8 +6567,9 @@ XXH_FORCE_INLINE void XXH3_hashLong_internal_loop(
#define XXH_SECRET_LASTACC_START \
7 /* not aligned on 8, last secret is different from acc & scrambler \
*/
- f_acc512(acc, p,
- secret + secretSize - XXH_STRIPE_LEN - XXH_SECRET_LASTACC_START);
+ XXH3_accumulate_512(
+ acc, p,
+ secret + secretSize - XXH_STRIPE_LEN - XXH_SECRET_LASTACC_START);
}
@@ -5019,13 +6626,12 @@ static XXH64_hash_t XXH3_mergeAccs(const xxh_u64 *XXH_RESTRICT acc,
XXH_FORCE_INLINE XXH64_hash_t XXH3_hashLong_64b_internal(
const void *XXH_RESTRICT input, size_t len, const void *XXH_RESTRICT secret,
- size_t secretSize, XXH3_f_accumulate_512 f_acc512,
- XXH3_f_scrambleAcc f_scramble) {
+ size_t secretSize, XXH3_f_accumulate f_acc, XXH3_f_scrambleAcc f_scramble) {
XXH_ALIGN(XXH_ACC_ALIGN) xxh_u64 acc[XXH_ACC_NB] = XXH3_INIT_ACC;
XXH3_hashLong_internal_loop(acc, (const xxh_u8 *)input, len,
- (const xxh_u8 *)secret, secretSize, f_acc512,
+ (const xxh_u8 *)secret, secretSize, f_acc,
f_scramble);
/* converge into final hash */
@@ -5041,26 +6647,30 @@ XXH_FORCE_INLINE XXH64_hash_t XXH3_hashLong_64b_internal(
}
/*
- * It's important for performance that XXH3_hashLong is not inlined.
+ * It's important for performance to transmit secret's size (when it's static)
+ * so that the compiler can properly optimize the vectorized loop.
+ * This makes a big performance difference for "medium" keys (<1 KB) when using
+ * AVX instruction set. When the secret size is unknown, or on GCC 12 where the
+ * mix of NO_INLINE and FORCE_INLINE breaks -Og, this is XXH_NO_INLINE.
*/
-XXH_NO_INLINE XXH64_hash_t XXH3_hashLong_64b_withSecret(
+XXH3_WITH_SECRET_INLINE XXH64_hash_t XXH3_hashLong_64b_withSecret(
const void *XXH_RESTRICT input, size_t len, XXH64_hash_t seed64,
const xxh_u8 *XXH_RESTRICT secret, size_t secretLen) {
(void)seed64;
return XXH3_hashLong_64b_internal(input, len, secret, secretLen,
- XXH3_accumulate_512, XXH3_scrambleAcc);
+ XXH3_accumulate, XXH3_scrambleAcc);
}
/*
- * It's important for performance that XXH3_hashLong is not inlined.
- * Since the function is not inlined, the compiler may not be able to understand
- * that, in some scenarios, its `secret` argument is actually a compile time
- * constant. This variant enforces that the compiler can detect that, and uses
- * this opportunity to streamline the generated code for better performance.
+ * It's preferable for performance that XXH3_hashLong is not inlined,
+ * as it results in a smaller function for small data, easier to the instruction
+ * cache. Note that inside this no_inline function, we do inline the internal
+ * loop, and provide a statically defined secret size to allow optimization of
+ * vector loop.
*/
-XXH_NO_INLINE XXH64_hash_t XXH3_hashLong_64b_default(
+XXH_NO_INLINE XXH_PUREF XXH64_hash_t XXH3_hashLong_64b_default(
const void *XXH_RESTRICT input, size_t len, XXH64_hash_t seed64,
const xxh_u8 *XXH_RESTRICT secret, size_t secretLen) {
@@ -5068,7 +6678,7 @@ XXH_NO_INLINE XXH64_hash_t XXH3_hashLong_64b_default(
(void)secret;
(void)secretLen;
return XXH3_hashLong_64b_internal(input, len, XXH3_kSecret,
- sizeof(XXH3_kSecret), XXH3_accumulate_512,
+ sizeof(XXH3_kSecret), XXH3_accumulate,
XXH3_scrambleAcc);
}
@@ -5085,19 +6695,20 @@ XXH_NO_INLINE XXH64_hash_t XXH3_hashLong_64b_default(
* why (uop cache maybe?), but the difference is large and easily measurable.
*/
XXH_FORCE_INLINE XXH64_hash_t XXH3_hashLong_64b_withSeed_internal(
- const void *input, size_t len, XXH64_hash_t seed,
- XXH3_f_accumulate_512 f_acc512, XXH3_f_scrambleAcc f_scramble,
- XXH3_f_initCustomSecret f_initSec) {
+ const void *input, size_t len, XXH64_hash_t seed, XXH3_f_accumulate f_acc,
+ XXH3_f_scrambleAcc f_scramble, XXH3_f_initCustomSecret f_initSec) {
+ #if XXH_SIZE_OPT <= 0
if (seed == 0)
- return XXH3_hashLong_64b_internal(
- input, len, XXH3_kSecret, sizeof(XXH3_kSecret), f_acc512, f_scramble);
+ return XXH3_hashLong_64b_internal(input, len, XXH3_kSecret,
+ sizeof(XXH3_kSecret), f_acc, f_scramble);
+ #endif
{
XXH_ALIGN(XXH_SEC_ALIGN) xxh_u8 secret[XXH_SECRET_DEFAULT_SIZE];
f_initSec(secret, seed);
- return XXH3_hashLong_64b_internal(input, len, secret, sizeof(secret),
- f_acc512, f_scramble);
+ return XXH3_hashLong_64b_internal(input, len, secret, sizeof(secret), f_acc,
+ f_scramble);
}
@@ -5106,17 +6717,15 @@ XXH_FORCE_INLINE XXH64_hash_t XXH3_hashLong_64b_withSeed_internal(
/*
* It's important for performance that XXH3_hashLong is not inlined.
*/
-XXH_NO_INLINE XXH64_hash_t XXH3_hashLong_64b_withSeed(const void *input,
- size_t len,
- XXH64_hash_t seed,
- const xxh_u8 *secret,
- size_t secretLen) {
+XXH_NO_INLINE XXH64_hash_t XXH3_hashLong_64b_withSeed(
+ const void *XXH_RESTRICT input, size_t len, XXH64_hash_t seed,
+ const xxh_u8 *XXH_RESTRICT secret, size_t secretLen) {
(void)secret;
(void)secretLen;
- return XXH3_hashLong_64b_withSeed_internal(
- input, len, seed, XXH3_accumulate_512, XXH3_scrambleAcc,
- XXH3_initCustomSecret);
+ return XXH3_hashLong_64b_withSeed_internal(input, len, seed, XXH3_accumulate,
+ XXH3_scrambleAcc,
+ XXH3_initCustomSecret);
}
@@ -5152,36 +6761,49 @@ XXH3_64bits_internal(const void *XXH_RESTRICT input, size_t len,
/* === Public entry point === */
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH64_hash_t XXH3_64bits(const void *input, size_t len) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH64_hash_t XXH3_64bits(XXH_NOESCAPE const void *input,
+ size_t length) {
- return XXH3_64bits_internal(input, len, 0, XXH3_kSecret, sizeof(XXH3_kSecret),
- XXH3_hashLong_64b_default);
+ return XXH3_64bits_internal(input, length, 0, XXH3_kSecret,
+ sizeof(XXH3_kSecret), XXH3_hashLong_64b_default);
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_withSecret(const void *input,
- size_t len,
- const void *secret,
- size_t secretSize) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH64_hash_t
+XXH3_64bits_withSecret(XXH_NOESCAPE const void *input, size_t length,
+ XXH_NOESCAPE const void *secret, size_t secretSize) {
- return XXH3_64bits_internal(input, len, 0, secret, secretSize,
+ return XXH3_64bits_internal(input, length, 0, secret, secretSize,
XXH3_hashLong_64b_withSecret);
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_withSeed(const void *input, size_t len,
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_withSeed(XXH_NOESCAPE const void *input,
+ size_t length,
XXH64_hash_t seed) {
- return XXH3_64bits_internal(input, len, seed, XXH3_kSecret,
+ return XXH3_64bits_internal(input, length, seed, XXH3_kSecret,
sizeof(XXH3_kSecret), XXH3_hashLong_64b_withSeed);
}
-/* === XXH3 streaming === */
+XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_withSecretandSeed(
+ XXH_NOESCAPE const void *input, size_t length,
+ XXH_NOESCAPE const void *secret, size_t secretSize, XXH64_hash_t seed) {
+
+ if (length <= XXH3_MIDSIZE_MAX)
+ return XXH3_64bits_internal(input, length, seed, XXH3_kSecret,
+ sizeof(XXH3_kSecret), NULL);
+ return XXH3_hashLong_64b_withSecret(input, length, seed,
+ (const xxh_u8 *)secret, secretSize);
+}
+
+ /* === XXH3 streaming === */
+ #ifndef XXH_NO_STREAM
/*
* Malloc's a pointer that is always aligned to align.
*
@@ -5205,7 +6827,7 @@ XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_withSeed(const void *input, size_t len,
*
* Align must be a power of 2 and 8 <= align <= 128.
*/
-static void *XXH_alignedMalloc(size_t s, size_t align) {
+static XXH_MALLOCF void *XXH_alignedMalloc(size_t s, size_t align) {
XXH_ASSERT(align <= 128 && align >= 8); /* range check */
XXH_ASSERT((align & (align - 1)) == 0); /* power of 2 */
@@ -5257,7 +6879,17 @@ static void XXH_alignedFree(void *p) {
}
-/*! @ingroup xxh3_family */
+/*! @ingroup XXH3_family */
+/*!
+ * @brief Allocate an @ref XXH3_state_t.
+ *
+ * @return An allocated pointer of @ref XXH3_state_t on success.
+ * @return `NULL` on failure.
+ *
+ * @note Must be freed with XXH3_freeState().
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
XXH_PUBLIC_API XXH3_state_t *XXH3_createState(void) {
XXH3_state_t *const state =
@@ -5268,7 +6900,19 @@ XXH_PUBLIC_API XXH3_state_t *XXH3_createState(void) {
}
-/*! @ingroup xxh3_family */
+/*! @ingroup XXH3_family */
+/*!
+ * @brief Frees an @ref XXH3_state_t.
+ *
+ * @param statePtr A pointer to an @ref XXH3_state_t allocated with @ref
+ * XXH3_createState().
+ *
+ * @return @ref XXH_OK.
+ *
+ * @note Must be allocated with XXH3_createState().
+ *
+ * @see @ref streaming_example "Streaming Example"
+ */
XXH_PUBLIC_API XXH_errorcode XXH3_freeState(XXH3_state_t *statePtr) {
XXH_alignedFree(statePtr);
@@ -5276,11 +6920,11 @@ XXH_PUBLIC_API XXH_errorcode XXH3_freeState(XXH3_state_t *statePtr) {
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API void XXH3_copyState(XXH3_state_t *dst_state,
- const XXH3_state_t *src_state) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API void XXH3_copyState(XXH_NOESCAPE XXH3_state_t *dst_state,
+ XXH_NOESCAPE const XXH3_state_t *src_state) {
- memcpy(dst_state, src_state, sizeof(*dst_state));
+ XXH_memcpy(dst_state, src_state, sizeof(*dst_state));
}
@@ -5303,6 +6947,7 @@ static void XXH3_reset_internal(XXH3_state_t *statePtr, XXH64_hash_t seed,
statePtr->acc[6] = XXH_PRIME64_5;
statePtr->acc[7] = XXH_PRIME32_1;
statePtr->seed = seed;
+ statePtr->useSeed = (seed != 0);
statePtr->extSecret = (const unsigned char *)secret;
XXH_ASSERT(secretSize >= XXH3_SECRET_SIZE_MIN);
statePtr->secretLimit = secretSize - XXH_STRIPE_LEN;
@@ -5310,8 +6955,9 @@ static void XXH3_reset_internal(XXH3_state_t *statePtr, XXH64_hash_t seed,
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset(XXH3_state_t *statePtr) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH_errorcode
+XXH3_64bits_reset(XXH_NOESCAPE XXH3_state_t *statePtr) {
if (statePtr == NULL) return XXH_ERROR;
XXH3_reset_internal(statePtr, 0, XXH3_kSecret, XXH_SECRET_DEFAULT_SIZE);
@@ -5319,9 +6965,10 @@ XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset(XXH3_state_t *statePtr) {
}
-/*! @ingroup xxh3_family */
+/*! @ingroup XXH3_family */
XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset_withSecret(
- XXH3_state_t *statePtr, const void *secret, size_t secretSize) {
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *secret,
+ size_t secretSize) {
if (statePtr == NULL) return XXH_ERROR;
XXH3_reset_internal(statePtr, 0, secret, secretSize);
@@ -5331,84 +6978,140 @@ XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset_withSecret(
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset_withSeed(XXH3_state_t *statePtr,
- XXH64_hash_t seed) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset_withSeed(
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH64_hash_t seed) {
if (statePtr == NULL) return XXH_ERROR;
if (seed == 0) return XXH3_64bits_reset(statePtr);
- if (seed != statePtr->seed)
+ if ((seed != statePtr->seed) || (statePtr->extSecret != NULL))
XXH3_initCustomSecret(statePtr->customSecret, seed);
XXH3_reset_internal(statePtr, seed, NULL, XXH_SECRET_DEFAULT_SIZE);
return XXH_OK;
}
-/* Note : when XXH3_consumeStripes() is invoked,
- * there must be a guarantee that at least one more byte must be consumed from
- * input
- * so that the function can blindly consume all stripes using the "normal"
- * secret segment */
-XXH_FORCE_INLINE void XXH3_consumeStripes(
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH_errorcode XXH3_64bits_reset_withSecretandSeed(
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *secret,
+ size_t secretSize, XXH64_hash_t seed64) {
+
+ if (statePtr == NULL) return XXH_ERROR;
+ if (secret == NULL) return XXH_ERROR;
+ if (secretSize < XXH3_SECRET_SIZE_MIN) return XXH_ERROR;
+ XXH3_reset_internal(statePtr, seed64, secret, secretSize);
+ statePtr->useSeed = 1; /* always, even if seed64==0 */
+ return XXH_OK;
+
+}
+
+/*!
+ * @internal
+ * @brief Processes a large input for XXH3_update() and XXH3_digest_long().
+ *
+ * Unlike XXH3_hashLong_internal_loop(), this can process data that overlaps a
+ * block.
+ *
+ * @param acc Pointer to the 8 accumulator lanes
+ * @param nbStripesSoFarPtr In/out pointer to the number of leftover stripes in
+ * the block*
+ * @param nbStripesPerBlock Number of stripes in a block
+ * @param input Input pointer
+ * @param nbStripes Number of stripes to process
+ * @param secret Secret pointer
+ * @param secretLimit Offset of the last block in @p secret
+ * @param f_acc Pointer to an XXH3_accumulate implementation
+ * @param f_scramble Pointer to an XXH3_scrambleAcc implementation
+ * @return Pointer past the end of @p input after processing
+ */
+XXH_FORCE_INLINE const xxh_u8 *XXH3_consumeStripes(
xxh_u64 *XXH_RESTRICT acc, size_t *XXH_RESTRICT nbStripesSoFarPtr,
size_t nbStripesPerBlock, const xxh_u8 *XXH_RESTRICT input,
size_t nbStripes, const xxh_u8 *XXH_RESTRICT secret, size_t secretLimit,
- XXH3_f_accumulate_512 f_acc512, XXH3_f_scrambleAcc f_scramble) {
-
- XXH_ASSERT(nbStripes <=
- nbStripesPerBlock); /* can handle max 1 scramble per invocation */
- XXH_ASSERT(*nbStripesSoFarPtr < nbStripesPerBlock);
- if (nbStripesPerBlock - *nbStripesSoFarPtr <= nbStripes) {
-
- /* need a scrambling operation */
- size_t const nbStripesToEndofBlock = nbStripesPerBlock - *nbStripesSoFarPtr;
- size_t const nbStripesAfterBlock = nbStripes - nbStripesToEndofBlock;
- XXH3_accumulate(acc, input,
- secret + nbStripesSoFarPtr[0] * XXH_SECRET_CONSUME_RATE,
- nbStripesToEndofBlock, f_acc512);
- f_scramble(acc, secret + secretLimit);
- XXH3_accumulate(acc, input + nbStripesToEndofBlock * XXH_STRIPE_LEN, secret,
- nbStripesAfterBlock, f_acc512);
- *nbStripesSoFarPtr = nbStripesAfterBlock;
+ XXH3_f_accumulate f_acc, XXH3_f_scrambleAcc f_scramble) {
- } else {
+ const xxh_u8 *initialSecret =
+ secret + *nbStripesSoFarPtr * XXH_SECRET_CONSUME_RATE;
+ /* Process full blocks */
+ if (nbStripes >= (nbStripesPerBlock - *nbStripesSoFarPtr)) {
+
+ /* Process the initial partial block... */
+ size_t nbStripesThisIter = nbStripesPerBlock - *nbStripesSoFarPtr;
+
+ do {
+
+ /* Accumulate and scramble */
+ f_acc(acc, input, initialSecret, nbStripesThisIter);
+ f_scramble(acc, secret + secretLimit);
+ input += nbStripesThisIter * XXH_STRIPE_LEN;
+ nbStripes -= nbStripesThisIter;
+ /* Then continue the loop with the full block size */
+ nbStripesThisIter = nbStripesPerBlock;
+ initialSecret = secret;
+
+ } while (nbStripes >= nbStripesPerBlock);
+
+ *nbStripesSoFarPtr = 0;
+
+ }
+
+ /* Process a partial block */
+ if (nbStripes > 0) {
- XXH3_accumulate(acc, input,
- secret + nbStripesSoFarPtr[0] * XXH_SECRET_CONSUME_RATE,
- nbStripes, f_acc512);
+ f_acc(acc, input, initialSecret, nbStripes);
+ input += nbStripes * XXH_STRIPE_LEN;
*nbStripesSoFarPtr += nbStripes;
}
+ /* Return end pointer */
+ return input;
+
}
+ #ifndef XXH3_STREAM_USE_STACK
+ #if XXH_SIZE_OPT <= 0 && \
+ !defined( \
+ __clang__) /* clang doesn't need additional stack space */
+ #define XXH3_STREAM_USE_STACK 1
+ #endif
+ #endif
/*
* Both XXH3_64bits_update and XXH3_128bits_update use this routine.
*/
-XXH_FORCE_INLINE XXH_errorcode XXH3_update(XXH3_state_t *state,
- const xxh_u8 *input, size_t len,
- XXH3_f_accumulate_512 f_acc512,
- XXH3_f_scrambleAcc f_scramble) {
+XXH_FORCE_INLINE XXH_errorcode XXH3_update(
+ XXH3_state_t *XXH_RESTRICT const state, const xxh_u8 *XXH_RESTRICT input,
+ size_t len, XXH3_f_accumulate f_acc, XXH3_f_scrambleAcc f_scramble) {
- if (input == NULL)
- #if defined(XXH_ACCEPT_NULL_INPUT_POINTER) && \
- (XXH_ACCEPT_NULL_INPUT_POINTER >= 1)
+ if (input == NULL) {
+
+ XXH_ASSERT(len == 0);
return XXH_OK;
- #else
- return XXH_ERROR;
- #endif
+ }
+
+ XXH_ASSERT(state != NULL);
{
const xxh_u8 *const bEnd = input + len;
const unsigned char *const secret =
(state->extSecret == NULL) ? state->customSecret : state->extSecret;
-
+ #if defined(XXH3_STREAM_USE_STACK) && XXH3_STREAM_USE_STACK >= 1
+ /* For some reason, gcc and MSVC seem to suffer greatly
+ * when operating accumulators directly into state.
+ * Operating into stack space seems to enable proper optimization.
+ * clang, on the other hand, doesn't seem to need this trick */
+ XXH_ALIGN(XXH_ACC_ALIGN) xxh_u64 acc[8];
+ XXH_memcpy(acc, state->acc, sizeof(acc));
+ #else
+ xxh_u64 *XXH_RESTRICT const acc = state->acc;
+ #endif
state->totalLen += len;
XXH_ASSERT(state->bufferedSize <= XXH3_INTERNALBUFFER_SIZE);
- if (state->bufferedSize + len <=
- XXH3_INTERNALBUFFER_SIZE) { /* fill in tmp buffer */
+ /* small input : just fill in tmp buffer */
+ if (len <= XXH3_INTERNALBUFFER_SIZE - state->bufferedSize) {
+
XXH_memcpy(state->buffer + state->bufferedSize, input, len);
state->bufferedSize += (XXH32_hash_t)len;
return XXH_OK;
@@ -5416,9 +7119,8 @@ XXH_FORCE_INLINE XXH_errorcode XXH3_update(XXH3_state_t *state,
}
/* total input is now > XXH3_INTERNALBUFFER_SIZE */
-
- #define XXH3_INTERNALBUFFER_STRIPES \
- (XXH3_INTERNALBUFFER_SIZE / XXH_STRIPE_LEN)
+ #define XXH3_INTERNALBUFFER_STRIPES \
+ (XXH3_INTERNALBUFFER_SIZE / XXH_STRIPE_LEN)
XXH_STATIC_ASSERT(XXH3_INTERNALBUFFER_SIZE % XXH_STRIPE_LEN ==
0); /* clean multiple */
@@ -5431,41 +7133,35 @@ XXH_FORCE_INLINE XXH_errorcode XXH3_update(XXH3_state_t *state,
size_t const loadSize = XXH3_INTERNALBUFFER_SIZE - state->bufferedSize;
XXH_memcpy(state->buffer + state->bufferedSize, input, loadSize);
input += loadSize;
- XXH3_consumeStripes(state->acc, &state->nbStripesSoFar,
- state->nbStripesPerBlock, state->buffer,
- XXH3_INTERNALBUFFER_STRIPES, secret,
- state->secretLimit, f_acc512, f_scramble);
+ XXH3_consumeStripes(acc, &state->nbStripesSoFar, state->nbStripesPerBlock,
+ state->buffer, XXH3_INTERNALBUFFER_STRIPES, secret,
+ state->secretLimit, f_acc, f_scramble);
state->bufferedSize = 0;
}
XXH_ASSERT(input < bEnd);
-
- /* Consume input by a multiple of internal buffer size */
if (bEnd - input > XXH3_INTERNALBUFFER_SIZE) {
- const xxh_u8 *const limit = bEnd - XXH3_INTERNALBUFFER_SIZE;
- do {
-
- XXH3_consumeStripes(state->acc, &state->nbStripesSoFar,
- state->nbStripesPerBlock, input,
- XXH3_INTERNALBUFFER_STRIPES, secret,
- state->secretLimit, f_acc512, f_scramble);
- input += XXH3_INTERNALBUFFER_SIZE;
-
- } while (input < limit);
-
- /* for last partial stripe */
- memcpy(state->buffer + sizeof(state->buffer) - XXH_STRIPE_LEN,
- input - XXH_STRIPE_LEN, XXH_STRIPE_LEN);
+ size_t nbStripes = (size_t)(bEnd - 1 - input) / XXH_STRIPE_LEN;
+ input = XXH3_consumeStripes(
+ acc, &state->nbStripesSoFar, state->nbStripesPerBlock, input,
+ nbStripes, secret, state->secretLimit, f_acc, f_scramble);
+ XXH_memcpy(state->buffer + sizeof(state->buffer) - XXH_STRIPE_LEN,
+ input - XXH_STRIPE_LEN, XXH_STRIPE_LEN);
}
- XXH_ASSERT(input < bEnd);
-
/* Some remaining input (always) : buffer it */
+ XXH_ASSERT(input < bEnd);
+ XXH_ASSERT(bEnd - input <= XXH3_INTERNALBUFFER_SIZE);
+ XXH_ASSERT(state->bufferedSize == 0);
XXH_memcpy(state->buffer, input, (size_t)(bEnd - input));
state->bufferedSize = (XXH32_hash_t)(bEnd - input);
+ #if defined(XXH3_STREAM_USE_STACK) && XXH3_STREAM_USE_STACK >= 1
+ /* save stack accumulators into state */
+ XXH_memcpy(state->acc, acc, sizeof(acc));
+ #endif
}
@@ -5473,11 +7169,12 @@ XXH_FORCE_INLINE XXH_errorcode XXH3_update(XXH3_state_t *state,
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH_errorcode XXH3_64bits_update(XXH3_state_t *state,
- const void *input, size_t len) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH_errorcode
+XXH3_64bits_update(XXH_NOESCAPE XXH3_state_t *state,
+ XXH_NOESCAPE const void *input, size_t len) {
- return XXH3_update(state, (const xxh_u8 *)input, len, XXH3_accumulate_512,
+ return XXH3_update(state, (const xxh_u8 *)input, len, XXH3_accumulate,
XXH3_scrambleAcc);
}
@@ -5486,41 +7183,46 @@ XXH_FORCE_INLINE void XXH3_digest_long(XXH64_hash_t *acc,
const XXH3_state_t *state,
const unsigned char *secret) {
+ xxh_u8 lastStripe[XXH_STRIPE_LEN];
+ const xxh_u8 *lastStripePtr;
+
/*
* Digest on a local copy. This way, the state remains unaltered, and it can
* continue ingesting more input afterwards.
*/
- memcpy(acc, state->acc, sizeof(state->acc));
+ XXH_memcpy(acc, state->acc, sizeof(state->acc));
if (state->bufferedSize >= XXH_STRIPE_LEN) {
+ /* Consume remaining stripes then point to remaining data in buffer */
size_t const nbStripes = (state->bufferedSize - 1) / XXH_STRIPE_LEN;
size_t nbStripesSoFar = state->nbStripesSoFar;
XXH3_consumeStripes(acc, &nbStripesSoFar, state->nbStripesPerBlock,
state->buffer, nbStripes, secret, state->secretLimit,
- XXH3_accumulate_512, XXH3_scrambleAcc);
- /* last stripe */
- XXH3_accumulate_512(acc,
- state->buffer + state->bufferedSize - XXH_STRIPE_LEN,
- secret + state->secretLimit - XXH_SECRET_LASTACC_START);
+ XXH3_accumulate, XXH3_scrambleAcc);
+ lastStripePtr = state->buffer + state->bufferedSize - XXH_STRIPE_LEN;
} else { /* bufferedSize < XXH_STRIPE_LEN */
- xxh_u8 lastStripe[XXH_STRIPE_LEN];
+ /* Copy to temp buffer */
size_t const catchupSize = XXH_STRIPE_LEN - state->bufferedSize;
XXH_ASSERT(state->bufferedSize >
0); /* there is always some input buffered */
- memcpy(lastStripe, state->buffer + sizeof(state->buffer) - catchupSize,
- catchupSize);
- memcpy(lastStripe + catchupSize, state->buffer, state->bufferedSize);
- XXH3_accumulate_512(acc, lastStripe,
- secret + state->secretLimit - XXH_SECRET_LASTACC_START);
+ XXH_memcpy(lastStripe, state->buffer + sizeof(state->buffer) - catchupSize,
+ catchupSize);
+ XXH_memcpy(lastStripe + catchupSize, state->buffer, state->bufferedSize);
+ lastStripePtr = lastStripe;
}
+ /* Last stripe */
+ XXH3_accumulate_512(acc, lastStripePtr,
+ secret + state->secretLimit - XXH_SECRET_LASTACC_START);
+
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_digest(const XXH3_state_t *state) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH64_hash_t
+XXH3_64bits_digest(XXH_NOESCAPE const XXH3_state_t *state) {
const unsigned char *const secret =
(state->extSecret == NULL) ? state->customSecret : state->extSecret;
@@ -5534,7 +7236,7 @@ XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_digest(const XXH3_state_t *state) {
}
/* totalLen <= XXH3_MIDSIZE_MAX: digesting a short input */
- if (state->seed)
+ if (state->useSeed)
return XXH3_64bits_withSeed(state->buffer, (size_t)state->totalLen,
state->seed);
return XXH3_64bits_withSecret(state->buffer, (size_t)(state->totalLen),
@@ -5542,69 +7244,7 @@ XXH_PUBLIC_API XXH64_hash_t XXH3_64bits_digest(const XXH3_state_t *state) {
}
- #define XXH_MIN(x, y) (((x) > (y)) ? (y) : (x))
-
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API void XXH3_generateSecret(void *secretBuffer,
- const void *customSeed,
- size_t customSeedSize) {
-
- XXH_ASSERT(secretBuffer != NULL);
- if (customSeedSize == 0) {
-
- memcpy(secretBuffer, XXH3_kSecret, XXH_SECRET_DEFAULT_SIZE);
- return;
-
- }
-
- XXH_ASSERT(customSeed != NULL);
-
- {
-
- size_t const segmentSize = sizeof(XXH128_hash_t);
- size_t const nbSegments = XXH_SECRET_DEFAULT_SIZE / segmentSize;
- XXH128_canonical_t scrambler;
- XXH64_hash_t seeds[12];
- size_t segnb;
- XXH_ASSERT(nbSegments == 12);
- XXH_ASSERT(segmentSize * nbSegments ==
- XXH_SECRET_DEFAULT_SIZE); /* exact multiple */
- XXH128_canonicalFromHash(&scrambler, XXH128(customSeed, customSeedSize, 0));
-
- /*
- * Copy customSeed to seeds[], truncating or repeating as necessary.
- */
- {
-
- size_t toFill = XXH_MIN(customSeedSize, sizeof(seeds));
- size_t filled = toFill;
- memcpy(seeds, customSeed, toFill);
- while (filled < sizeof(seeds)) {
-
- toFill = XXH_MIN(filled, sizeof(seeds) - filled);
- memcpy((char *)seeds + filled, seeds, toFill);
- filled += toFill;
-
- }
-
- }
-
- /* generate secret */
- memcpy(secretBuffer, &scrambler, sizeof(scrambler));
- for (segnb = 1; segnb < nbSegments; segnb++) {
-
- size_t const segmentStart = segnb * segmentSize;
- XXH128_canonical_t segment;
- XXH128_canonicalFromHash(&segment,
- XXH128(&scrambler, sizeof(scrambler),
- XXH_readLE64(seeds + segnb) + segnb));
- memcpy((char *)secretBuffer + segmentStart, &segment, sizeof(segment));
-
- }
-
- }
-
-}
+ #endif /* !XXH_NO_STREAM */
/* ==========================================
* XXH3 128 bits (a.k.a XXH128)
@@ -5623,10 +7263,8 @@ XXH_PUBLIC_API void XXH3_generateSecret(void *secretBuffer,
* fast for a _128-bit_ hash on 32-bit (it usually clears XXH64).
*/
-XXH_FORCE_INLINE XXH128_hash_t XXH3_len_1to3_128b(const xxh_u8 *input,
- size_t len,
- const xxh_u8 *secret,
- XXH64_hash_t seed) {
+XXH_FORCE_INLINE XXH_PUREF XXH128_hash_t XXH3_len_1to3_128b(
+ const xxh_u8 *input, size_t len, const xxh_u8 *secret, XXH64_hash_t seed) {
/* A doubled version of 1to3_64b with different constants. */
XXH_ASSERT(input != NULL);
@@ -5660,10 +7298,8 @@ XXH_FORCE_INLINE XXH128_hash_t XXH3_len_1to3_128b(const xxh_u8 *input,
}
-XXH_FORCE_INLINE XXH128_hash_t XXH3_len_4to8_128b(const xxh_u8 *input,
- size_t len,
- const xxh_u8 *secret,
- XXH64_hash_t seed) {
+XXH_FORCE_INLINE XXH_PUREF XXH128_hash_t XXH3_len_4to8_128b(
+ const xxh_u8 *input, size_t len, const xxh_u8 *secret, XXH64_hash_t seed) {
XXH_ASSERT(input != NULL);
XXH_ASSERT(secret != NULL);
@@ -5686,7 +7322,7 @@ XXH_FORCE_INLINE XXH128_hash_t XXH3_len_4to8_128b(const xxh_u8 *input,
m128.low64 ^= (m128.high64 >> 3);
m128.low64 = XXH_xorshift64(m128.low64, 35);
- m128.low64 *= 0x9FB21C651E98DF25ULL;
+ m128.low64 *= PRIME_MX2;
m128.low64 = XXH_xorshift64(m128.low64, 28);
m128.high64 = XXH3_avalanche(m128.high64);
return m128;
@@ -5695,10 +7331,8 @@ XXH_FORCE_INLINE XXH128_hash_t XXH3_len_4to8_128b(const xxh_u8 *input,
}
-XXH_FORCE_INLINE XXH128_hash_t XXH3_len_9to16_128b(const xxh_u8 *input,
- size_t len,
- const xxh_u8 *secret,
- XXH64_hash_t seed) {
+XXH_FORCE_INLINE XXH_PUREF XXH128_hash_t XXH3_len_9to16_128b(
+ const xxh_u8 *input, size_t len, const xxh_u8 *secret, XXH64_hash_t seed) {
XXH_ASSERT(input != NULL);
XXH_ASSERT(secret != NULL);
@@ -5788,10 +7422,8 @@ XXH_FORCE_INLINE XXH128_hash_t XXH3_len_9to16_128b(const xxh_u8 *input,
/*
* Assumption: `secret` size is >= XXH3_SECRET_SIZE_MIN
*/
-XXH_FORCE_INLINE XXH128_hash_t XXH3_len_0to16_128b(const xxh_u8 *input,
- size_t len,
- const xxh_u8 *secret,
- XXH64_hash_t seed) {
+XXH_FORCE_INLINE XXH_PUREF XXH128_hash_t XXH3_len_0to16_128b(
+ const xxh_u8 *input, size_t len, const xxh_u8 *secret, XXH64_hash_t seed) {
XXH_ASSERT(len <= 16);
{
@@ -5833,7 +7465,7 @@ XXH_FORCE_INLINE XXH128_hash_t XXH128_mix32B(XXH128_hash_t acc,
}
-XXH_FORCE_INLINE XXH128_hash_t XXH3_len_17to128_128b(
+XXH_FORCE_INLINE XXH_PUREF XXH128_hash_t XXH3_len_17to128_128b(
const xxh_u8 *XXH_RESTRICT input, size_t len,
const xxh_u8 *XXH_RESTRICT secret, size_t secretSize, XXH64_hash_t seed) {
@@ -5846,6 +7478,22 @@ XXH_FORCE_INLINE XXH128_hash_t XXH3_len_17to128_128b(
XXH128_hash_t acc;
acc.low64 = len * XXH_PRIME64_1;
acc.high64 = 0;
+
+ #if XXH_SIZE_OPT >= 1
+ {
+
+ /* Smaller, but slightly slower. */
+ unsigned int i = (unsigned int)(len - 1) / 32;
+ do {
+
+ acc = XXH128_mix32B(acc, input + 16 * i, input + len - 16 * (i + 1),
+ secret + 32 * i, seed);
+
+ } while (i-- != 0);
+
+ }
+
+ #else
if (len > 32) {
if (len > 64) {
@@ -5867,6 +7515,7 @@ XXH_FORCE_INLINE XXH128_hash_t XXH3_len_17to128_128b(
}
acc = XXH128_mix32B(acc, input, input + len - 16, secret, seed);
+ #endif
{
XXH128_hash_t h128;
@@ -5883,7 +7532,7 @@ XXH_FORCE_INLINE XXH128_hash_t XXH3_len_17to128_128b(
}
-XXH_NO_INLINE XXH128_hash_t XXH3_len_129to240_128b(
+XXH_NO_INLINE XXH_PUREF XXH128_hash_t XXH3_len_129to240_128b(
const xxh_u8 *XXH_RESTRICT input, size_t len,
const xxh_u8 *XXH_RESTRICT secret, size_t secretSize, XXH64_hash_t seed) {
@@ -5894,25 +7543,33 @@ XXH_NO_INLINE XXH128_hash_t XXH3_len_129to240_128b(
{
XXH128_hash_t acc;
- int const nbRounds = (int)len / 32;
- int i;
+ unsigned i;
acc.low64 = len * XXH_PRIME64_1;
acc.high64 = 0;
- for (i = 0; i < 4; i++) {
+ /*
+ * We set as `i` as offset + 32. We do this so that unchanged
+ * `len` can be used as upper bound. This reaches a sweet spot
+ * where both x86 and aarch64 get simple agen and good codegen
+ * for the loop.
+ */
+ for (i = 32; i < 160; i += 32) {
- acc = XXH128_mix32B(acc, input + (32 * i), input + (32 * i) + 16,
- secret + (32 * i), seed);
+ acc = XXH128_mix32B(acc, input + i - 32, input + i - 16, secret + i - 32,
+ seed);
}
acc.low64 = XXH3_avalanche(acc.low64);
acc.high64 = XXH3_avalanche(acc.high64);
- XXH_ASSERT(nbRounds >= 4);
- for (i = 4; i < nbRounds; i++) {
+ /*
+ * NB: `i <= len` will duplicate the last 32-bytes if
+ * len % 32 was zero. This is an unfortunate necessity to keep
+ * the hash result stable.
+ */
+ for (i = 160; i <= len; i += 32) {
- acc = XXH128_mix32B(acc, input + (32 * i), input + (32 * i) + 16,
- secret + XXH3_MIDSIZE_STARTOFFSET + (32 * (i - 4)),
- seed);
+ acc = XXH128_mix32B(acc, input + i - 32, input + i - 16,
+ secret + XXH3_MIDSIZE_STARTOFFSET + i - 160, seed);
}
@@ -5920,7 +7577,7 @@ XXH_NO_INLINE XXH128_hash_t XXH3_len_129to240_128b(
acc = XXH128_mix32B(
acc, input + len - 16, input + len - 32,
secret + XXH3_SECRET_SIZE_MIN - XXH3_MIDSIZE_LASTOFFSET - 16,
- 0ULL - seed);
+ (XXH64_hash_t)0 - seed);
{
@@ -5941,12 +7598,12 @@ XXH_NO_INLINE XXH128_hash_t XXH3_len_129to240_128b(
XXH_FORCE_INLINE XXH128_hash_t XXH3_hashLong_128b_internal(
const void *XXH_RESTRICT input, size_t len,
const xxh_u8 *XXH_RESTRICT secret, size_t secretSize,
- XXH3_f_accumulate_512 f_acc512, XXH3_f_scrambleAcc f_scramble) {
+ XXH3_f_accumulate f_acc, XXH3_f_scrambleAcc f_scramble) {
XXH_ALIGN(XXH_ACC_ALIGN) xxh_u64 acc[XXH_ACC_NB] = XXH3_INIT_ACC;
XXH3_hashLong_internal_loop(acc, (const xxh_u8 *)input, len, secret,
- secretSize, f_acc512, f_scramble);
+ secretSize, f_acc, f_scramble);
/* converge into final hash */
XXH_STATIC_ASSERT(sizeof(acc) == 64);
@@ -5966,9 +7623,9 @@ XXH_FORCE_INLINE XXH128_hash_t XXH3_hashLong_128b_internal(
}
/*
- * It's important for performance that XXH3_hashLong is not inlined.
+ * It's important for performance that XXH3_hashLong() is not inlined.
*/
-XXH_NO_INLINE XXH128_hash_t XXH3_hashLong_128b_default(
+XXH_NO_INLINE XXH_PUREF XXH128_hash_t XXH3_hashLong_128b_default(
const void *XXH_RESTRICT input, size_t len, XXH64_hash_t seed64,
const void *XXH_RESTRICT secret, size_t secretLen) {
@@ -5976,39 +7633,43 @@ XXH_NO_INLINE XXH128_hash_t XXH3_hashLong_128b_default(
(void)secret;
(void)secretLen;
return XXH3_hashLong_128b_internal(input, len, XXH3_kSecret,
- sizeof(XXH3_kSecret), XXH3_accumulate_512,
+ sizeof(XXH3_kSecret), XXH3_accumulate,
XXH3_scrambleAcc);
}
/*
- * It's important for performance that XXH3_hashLong is not inlined.
+ * It's important for performance to pass @p secretLen (when it's static)
+ * to the compiler, so that it can properly optimize the vectorized loop.
+ *
+ * When the secret size is unknown, or on GCC 12 where the mix of NO_INLINE and
+ * FORCE_INLINE breaks -Og, this is XXH_NO_INLINE.
*/
-XXH_NO_INLINE XXH128_hash_t XXH3_hashLong_128b_withSecret(
+XXH3_WITH_SECRET_INLINE XXH128_hash_t XXH3_hashLong_128b_withSecret(
const void *XXH_RESTRICT input, size_t len, XXH64_hash_t seed64,
const void *XXH_RESTRICT secret, size_t secretLen) {
(void)seed64;
return XXH3_hashLong_128b_internal(input, len, (const xxh_u8 *)secret,
- secretLen, XXH3_accumulate_512,
+ secretLen, XXH3_accumulate,
XXH3_scrambleAcc);
}
XXH_FORCE_INLINE XXH128_hash_t XXH3_hashLong_128b_withSeed_internal(
const void *XXH_RESTRICT input, size_t len, XXH64_hash_t seed64,
- XXH3_f_accumulate_512 f_acc512, XXH3_f_scrambleAcc f_scramble,
+ XXH3_f_accumulate f_acc, XXH3_f_scrambleAcc f_scramble,
XXH3_f_initCustomSecret f_initSec) {
if (seed64 == 0)
- return XXH3_hashLong_128b_internal(
- input, len, XXH3_kSecret, sizeof(XXH3_kSecret), f_acc512, f_scramble);
+ return XXH3_hashLong_128b_internal(input, len, XXH3_kSecret,
+ sizeof(XXH3_kSecret), f_acc, f_scramble);
{
XXH_ALIGN(XXH_SEC_ALIGN) xxh_u8 secret[XXH_SECRET_DEFAULT_SIZE];
f_initSec(secret, seed64);
return XXH3_hashLong_128b_internal(input, len, (const xxh_u8 *)secret,
- sizeof(secret), f_acc512, f_scramble);
+ sizeof(secret), f_acc, f_scramble);
}
@@ -6023,9 +7684,9 @@ XXH3_hashLong_128b_withSeed(const void *input, size_t len, XXH64_hash_t seed64,
(void)secret;
(void)secretLen;
- return XXH3_hashLong_128b_withSeed_internal(
- input, len, seed64, XXH3_accumulate_512, XXH3_scrambleAcc,
- XXH3_initCustomSecret);
+ return XXH3_hashLong_128b_withSeed_internal(input, len, seed64,
+ XXH3_accumulate, XXH3_scrambleAcc,
+ XXH3_initCustomSecret);
}
@@ -6060,8 +7721,9 @@ XXH3_128bits_internal(const void *input, size_t len, XXH64_hash_t seed64,
/* === Public XXH128 API === */
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH128_hash_t XXH3_128bits(const void *input, size_t len) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH128_hash_t XXH3_128bits(XXH_NOESCAPE const void *input,
+ size_t len) {
return XXH3_128bits_internal(input, len, 0, XXH3_kSecret,
sizeof(XXH3_kSecret),
@@ -6069,21 +7731,19 @@ XXH_PUBLIC_API XXH128_hash_t XXH3_128bits(const void *input, size_t len) {
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_withSecret(const void *input,
- size_t len,
- const void *secret,
- size_t secretSize) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH128_hash_t
+XXH3_128bits_withSecret(XXH_NOESCAPE const void *input, size_t len,
+ XXH_NOESCAPE const void *secret, size_t secretSize) {
return XXH3_128bits_internal(input, len, 0, (const xxh_u8 *)secret,
secretSize, XXH3_hashLong_128b_withSecret);
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_withSeed(const void *input,
- size_t len,
- XXH64_hash_t seed) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_withSeed(
+ XXH_NOESCAPE const void *input, size_t len, XXH64_hash_t seed) {
return XXH3_128bits_internal(input, len, seed, XXH3_kSecret,
sizeof(XXH3_kSecret),
@@ -6091,67 +7751,80 @@ XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_withSeed(const void *input,
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH128_hash_t XXH128(const void *input, size_t len,
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_withSecretandSeed(
+ XXH_NOESCAPE const void *input, size_t len, XXH_NOESCAPE const void *secret,
+ size_t secretSize, XXH64_hash_t seed) {
+
+ if (len <= XXH3_MIDSIZE_MAX)
+ return XXH3_128bits_internal(input, len, seed, XXH3_kSecret,
+ sizeof(XXH3_kSecret), NULL);
+ return XXH3_hashLong_128b_withSecret(input, len, seed, secret, secretSize);
+
+}
+
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH128_hash_t XXH128(XXH_NOESCAPE const void *input, size_t len,
XXH64_hash_t seed) {
return XXH3_128bits_withSeed(input, len, seed);
}
-/* === XXH3 128-bit streaming === */
-
+ /* === XXH3 128-bit streaming === */
+ #ifndef XXH_NO_STREAM
/*
- * All the functions are actually the same as for 64-bit streaming variant.
- * The only difference is the finalization routine.
+ * All initialization and update functions are identical to 64-bit streaming
+ * variant. The only difference is the finalization routine.
*/
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH_errorcode XXH3_128bits_reset(XXH3_state_t *statePtr) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH_errorcode
+XXH3_128bits_reset(XXH_NOESCAPE XXH3_state_t *statePtr) {
- if (statePtr == NULL) return XXH_ERROR;
- XXH3_reset_internal(statePtr, 0, XXH3_kSecret, XXH_SECRET_DEFAULT_SIZE);
- return XXH_OK;
+ return XXH3_64bits_reset(statePtr);
}
-/*! @ingroup xxh3_family */
+/*! @ingroup XXH3_family */
XXH_PUBLIC_API XXH_errorcode XXH3_128bits_reset_withSecret(
- XXH3_state_t *statePtr, const void *secret, size_t secretSize) {
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *secret,
+ size_t secretSize) {
- if (statePtr == NULL) return XXH_ERROR;
- XXH3_reset_internal(statePtr, 0, secret, secretSize);
- if (secret == NULL) return XXH_ERROR;
- if (secretSize < XXH3_SECRET_SIZE_MIN) return XXH_ERROR;
- return XXH_OK;
+ return XXH3_64bits_reset_withSecret(statePtr, secret, secretSize);
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH_errorcode XXH3_128bits_reset_withSeed(XXH3_state_t *statePtr,
- XXH64_hash_t seed) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH_errorcode XXH3_128bits_reset_withSeed(
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH64_hash_t seed) {
- if (statePtr == NULL) return XXH_ERROR;
- if (seed == 0) return XXH3_128bits_reset(statePtr);
- if (seed != statePtr->seed)
- XXH3_initCustomSecret(statePtr->customSecret, seed);
- XXH3_reset_internal(statePtr, seed, NULL, XXH_SECRET_DEFAULT_SIZE);
- return XXH_OK;
+ return XXH3_64bits_reset_withSeed(statePtr, seed);
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH_errorcode XXH3_128bits_update(XXH3_state_t *state,
- const void *input,
- size_t len) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH_errorcode XXH3_128bits_reset_withSecretandSeed(
+ XXH_NOESCAPE XXH3_state_t *statePtr, XXH_NOESCAPE const void *secret,
+ size_t secretSize, XXH64_hash_t seed) {
- return XXH3_update(state, (const xxh_u8 *)input, len, XXH3_accumulate_512,
- XXH3_scrambleAcc);
+ return XXH3_64bits_reset_withSecretandSeed(statePtr, secret, secretSize,
+ seed);
}
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_digest(const XXH3_state_t *state) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH_errorcode
+XXH3_128bits_update(XXH_NOESCAPE XXH3_state_t *state,
+ XXH_NOESCAPE const void *input, size_t len) {
+
+ return XXH3_64bits_update(state, input, len);
+
+}
+
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH128_hash_t
+XXH3_128bits_digest(XXH_NOESCAPE const XXH3_state_t *state) {
const unsigned char *const secret =
(state->extSecret == NULL) ? state->customSecret : state->extSecret;
@@ -6186,12 +7859,13 @@ XXH_PUBLIC_API XXH128_hash_t XXH3_128bits_digest(const XXH3_state_t *state) {
}
- /* 128-bit utility functions */
+ #endif /* !XXH_NO_STREAM */
+ /* 128-bit utility functions */
#include <string.h> /* memcmp, memcpy */
/* return : 1 is equal, 0 if different */
-/*! @ingroup xxh3_family */
+/*! @ingroup XXH3_family */
XXH_PUBLIC_API int XXH128_isEqual(XXH128_hash_t h1, XXH128_hash_t h2) {
/* note : XXH128_hash_t is compact, it has no padding byte */
@@ -6200,11 +7874,12 @@ XXH_PUBLIC_API int XXH128_isEqual(XXH128_hash_t h1, XXH128_hash_t h2) {
}
/* This prototype is compatible with stdlib's qsort().
- * return : >0 if *h128_1 > *h128_2
- * <0 if *h128_1 < *h128_2
- * =0 if *h128_1 == *h128_2 */
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API int XXH128_cmp(const void *h128_1, const void *h128_2) {
+ * @return : >0 if *h128_1 > *h128_2
+ * <0 if *h128_1 < *h128_2
+ * =0 if *h128_1 == *h128_2 */
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API int XXH128_cmp(XXH_NOESCAPE const void *h128_1,
+ XXH_NOESCAPE const void *h128_2) {
XXH128_hash_t const h1 = *(const XXH128_hash_t *)h128_1;
XXH128_hash_t const h2 = *(const XXH128_hash_t *)h128_2;
@@ -6216,9 +7891,9 @@ XXH_PUBLIC_API int XXH128_cmp(const void *h128_1, const void *h128_2) {
}
/*====== Canonical representation ======*/
-/*! @ingroup xxh3_family */
-XXH_PUBLIC_API void XXH128_canonicalFromHash(XXH128_canonical_t *dst,
- XXH128_hash_t hash) {
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API void XXH128_canonicalFromHash(
+ XXH_NOESCAPE XXH128_canonical_t *dst, XXH128_hash_t hash) {
XXH_STATIC_ASSERT(sizeof(XXH128_canonical_t) == sizeof(XXH128_hash_t));
if (XXH_CPU_LITTLE_ENDIAN) {
@@ -6228,14 +7903,15 @@ XXH_PUBLIC_API void XXH128_canonicalFromHash(XXH128_canonical_t *dst,
}
- memcpy(dst, &hash.high64, sizeof(hash.high64));
- memcpy((char *)dst + sizeof(hash.high64), &hash.low64, sizeof(hash.low64));
+ XXH_memcpy(dst, &hash.high64, sizeof(hash.high64));
+ XXH_memcpy((char *)dst + sizeof(hash.high64), &hash.low64,
+ sizeof(hash.low64));
}
-/*! @ingroup xxh3_family */
+/*! @ingroup XXH3_family */
XXH_PUBLIC_API XXH128_hash_t
-XXH128_hashFromCanonical(const XXH128_canonical_t *src) {
+XXH128_hashFromCanonical(XXH_NOESCAPE const XXH128_canonical_t *src) {
XXH128_hash_t h;
h.high64 = XXH_readBE64(src);
@@ -6244,11 +7920,99 @@ XXH128_hashFromCanonical(const XXH128_canonical_t *src) {
}
+ /* ==========================================
+ * Secret generators
+ * ==========================================
+ */
+ #define XXH_MIN(x, y) (((x) > (y)) ? (y) : (x))
+
+XXH_FORCE_INLINE void XXH3_combine16(void *dst, XXH128_hash_t h128) {
+
+ XXH_writeLE64(dst, XXH_readLE64(dst) ^ h128.low64);
+ XXH_writeLE64((char *)dst + 8, XXH_readLE64((char *)dst + 8) ^ h128.high64);
+
+}
+
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API XXH_errorcode XXH3_generateSecret(
+ XXH_NOESCAPE void *secretBuffer, size_t secretSize,
+ XXH_NOESCAPE const void *customSeed, size_t customSeedSize) {
+
+ #if (XXH_DEBUGLEVEL >= 1)
+ XXH_ASSERT(secretBuffer != NULL);
+ XXH_ASSERT(secretSize >= XXH3_SECRET_SIZE_MIN);
+ #else
+ /* production mode, assert() are disabled */
+ if (secretBuffer == NULL) return XXH_ERROR;
+ if (secretSize < XXH3_SECRET_SIZE_MIN) return XXH_ERROR;
+ #endif
+
+ if (customSeedSize == 0) {
+
+ customSeed = XXH3_kSecret;
+ customSeedSize = XXH_SECRET_DEFAULT_SIZE;
+
+ }
+
+ #if (XXH_DEBUGLEVEL >= 1)
+ XXH_ASSERT(customSeed != NULL);
+ #else
+ if (customSeed == NULL) return XXH_ERROR;
+ #endif
+
+ /* Fill secretBuffer with a copy of customSeed - repeat as needed */
+ {
+
+ size_t pos = 0;
+ while (pos < secretSize) {
+
+ size_t const toCopy = XXH_MIN((secretSize - pos), customSeedSize);
+ memcpy((char *)secretBuffer + pos, customSeed, toCopy);
+ pos += toCopy;
+
+ }
+
+ }
+
+ {
+
+ size_t const nbSeg16 = secretSize / 16;
+ size_t n;
+ XXH128_canonical_t scrambler;
+ XXH128_canonicalFromHash(&scrambler, XXH128(customSeed, customSeedSize, 0));
+ for (n = 0; n < nbSeg16; n++) {
+
+ XXH128_hash_t const h128 = XXH128(&scrambler, sizeof(scrambler), n);
+ XXH3_combine16((char *)secretBuffer + n * 16, h128);
+
+ }
+
+ /* last segment */
+ XXH3_combine16((char *)secretBuffer + secretSize - 16,
+ XXH128_hashFromCanonical(&scrambler));
+
+ }
+
+ return XXH_OK;
+
+}
+
+/*! @ingroup XXH3_family */
+XXH_PUBLIC_API void XXH3_generateSecret_fromSeed(
+ XXH_NOESCAPE void *secretBuffer, XXH64_hash_t seed) {
+
+ XXH_ALIGN(XXH_SEC_ALIGN) xxh_u8 secret[XXH_SECRET_DEFAULT_SIZE];
+ XXH3_initCustomSecret(secret, seed);
+ XXH_ASSERT(secretBuffer != NULL);
+ memcpy(secretBuffer, secret, XXH_SECRET_DEFAULT_SIZE);
+
+}
+
/* Pop our optimization override from above */
#if XXH_VECTOR == XXH_AVX2 /* AVX2 */ \
&& defined(__GNUC__) && !defined(__clang__) /* GCC, not Clang */ \
&& defined(__OPTIMIZE__) && \
- !defined(__OPTIMIZE_SIZE__) /* respect -O0 and -Os */
+ XXH_SIZE_OPT <= 0 /* respect -O0 and -Os */
#pragma GCC pop_options
#endif
@@ -6263,7 +8027,7 @@ XXH128_hashFromCanonical(const XXH128_canonical_t *src) {
#if defined(__cplusplus)
-}
+} /* extern "C" */
#endif
diff --git a/instrumentation/README.persistent_mode.md b/instrumentation/README.persistent_mode.md
index 14e59f4a..8e4f6ae4 100644
--- a/instrumentation/README.persistent_mode.md
+++ b/instrumentation/README.persistent_mode.md
@@ -195,4 +195,34 @@ Then as first line after the `__AFL_LOOP` while loop:
int len = __AFL_FUZZ_TESTCASE_LEN;
```
-And that is all! \ No newline at end of file
+And that is all!
+
+## 6) Persistent record, and replay
+
+If your software under test requires keeping a state between persistent loop iterations (i.e., a stateful network stack), you can use the `AFL_PERSISTENT_RECORD` variable as described in the [environment variables documentation](../docs/env_variables.md).
+
+When `AFL_PERSISTENT_RECORD` is enabled, replay functionality is also included in the compiler-rt library. To replay a specific record, assign the record number to the AFL_PERSISTENT_REPLAY environment variable (i.e., `RECORD:XXXXX`` -> `AFL_PERSISTENT_REPLAY=XXXXX`), and run the test binary as you would normally do.
+The directory where the record files live can be specified via the `AFL_PERSISTENT_DIR` environment varilable, otherwise by default it will be considered the current directory (`./`).
+
+If your harness reads the input files from arguments using the special `@@` argument you will need to include support by enabling `AFL_PERSISTENT_ARGPARSE` in `config.h`.
+
+In order to offer transparent support to harnesses using the `@@` command line argument, arguments are parsed by the `__afl_record_replay_init` init function. Since not all systems support passing arguments to initializers, this functionality is disabled by default, it's recommendable to use the `__AFL_FUZZ_TESTCASE_BUF/__AFL_FUZZ_TESTCASE_LEN` shared memory mechanism instead.
+
+## 7) Drop-in persistent loop replay replacement
+
+To use the replay functionality without having to use `afl-cc`, include the [include/record_compat.h](../include/afl-record_compat.h) header file. Together with the [include/afl-persistent-replay.h](../include/afl-persistent-replay.h) header included in it, `afl-record-compat.h` provides a drop-in replacement for the persistent loop mechanism.
+
+```c
+#ifndef __AFL_FUZZ_TESTCASE_LEN
+ // #define AFL_PERSISTENT_REPLAY_ARGPARSE
+ #include "afl-record-compat.h"
+#endif
+
+__AFL_FUZZ_INIT();
+```
+
+A simple example is provided in [persistent_demo_replay.c](../utils/replay_record/persistent_demo_replay.c).
+
+Be aware that the [afl-record-compat.h](../include/afl-record-compat.h) header should only be included in a single compilation unit, or you will end up with clobbered functions and variables.
+
+If you need a cleaner solution, you'll have to move the functions and variables defined in [include/record_compat.h](../include/afl-record-compat.h) and [include/afl-persistent-replay.h](../include/afl-persistent-replay.h) in a C file, and add the relevant declarations to a header file. After including the new header file, the compilation unit resulting from compiling the C file can then be linked with your program. \ No newline at end of file
diff --git a/instrumentation/SanitizerCoverageLTO.so.cc b/instrumentation/SanitizerCoverageLTO.so.cc
index 68423029..4518c1c7 100644
--- a/instrumentation/SanitizerCoverageLTO.so.cc
+++ b/instrumentation/SanitizerCoverageLTO.so.cc
@@ -192,12 +192,15 @@ class ModuleSanitizerCoverageLTO
PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM);
private:
- void instrumentFunction(Function &F, DomTreeCallback DTCallback,
- PostDomTreeCallback PDTCallback);
- void InjectCoverageForIndirectCalls(Function &F,
- ArrayRef<Instruction *> IndirCalls);
- bool InjectCoverage(Function &F, ArrayRef<BasicBlock *> AllBlocks,
- bool IsLeafFunc = true);
+ void instrumentFunction(Function &F, DomTreeCallback DTCallback,
+ PostDomTreeCallback PDTCallback);
+ /* void InjectCoverageForIndirectCalls(Function &F,
+ ArrayRef<Instruction *>
+ IndirCalls);*/
+ bool InjectCoverage(Function &F, ArrayRef<BasicBlock *> AllBlocks,
+ bool IsLeafFunc = true);
+ bool Fake_InjectCoverage(Function &F, ArrayRef<BasicBlock *> AllBlocks,
+ bool IsLeafFunc = true);
GlobalVariable *CreateFunctionLocalArrayInSection(size_t NumElements,
Function &F, Type *Ty,
const char *Section);
@@ -247,6 +250,9 @@ class ModuleSanitizerCoverageLTO
uint32_t afl_global_id = 0;
uint32_t unhandled = 0;
uint32_t select_cnt = 0;
+ uint32_t instrument_ctx = 0;
+ uint32_t instrument_ctx_max_depth = 0;
+ uint32_t extra_ctx_inst = 0;
uint64_t map_addr = 0;
const char *skip_nozero = NULL;
const char *use_threadsafe_counters = nullptr;
@@ -257,11 +263,14 @@ class ModuleSanitizerCoverageLTO
IntegerType *Int32Tyi = NULL;
IntegerType *Int64Tyi = NULL;
ConstantInt *Zero = NULL;
+ ConstantInt *Zero32 = NULL;
ConstantInt *One = NULL;
LLVMContext *Ct = NULL;
Module *Mo = NULL;
+ GlobalVariable *AFLContext = NULL;
GlobalVariable *AFLMapPtr = NULL;
Value *MapPtrFixed = NULL;
+ AllocaInst *CTX_add = NULL;
std::ofstream dFile;
size_t found = 0;
// AFL++ END
@@ -332,7 +341,7 @@ llvmGetPassPluginInfo() {
using OptimizationLevel = typename PassBuilder::OptimizationLevel;
#endif
#if LLVM_VERSION_MAJOR >= 15
- PB.registerFullLinkTimeOptimizationLastEPCallback(
+ PB.registerFullLinkTimeOptimizationEarlyEPCallback(
#else
PB.registerOptimizerLastEPCallback(
#endif
@@ -420,16 +429,51 @@ bool ModuleSanitizerCoverageLTO::instrumentModule(
setvbuf(stdout, NULL, _IONBF, 0);
if (getenv("AFL_DEBUG")) { debug = 1; }
if (getenv("AFL_LLVM_DICT2FILE_NO_MAIN")) { autodictionary_no_main = 1; }
+ if (getenv("AFL_LLVM_CALLER") || getenv("AFL_LLVM_CTX") ||
+ getenv("AFL_LLVM_LTO_CALLER") || getenv("AFL_LLVM_LTO_CTX")) {
+
+ instrument_ctx = 1;
+
+ }
+
+ if (getenv("AFL_LLVM_LTO_CALLER_DEPTH")) {
+
+ instrument_ctx_max_depth = atoi(getenv("AFL_LLVM_LTO_CALLER_DEPTH"));
+
+ } else if (getenv("AFL_LLVM_LTO_CTX_DEPTH")) {
+
+ instrument_ctx_max_depth = atoi(getenv("AFL_LLVM_LTO_CTX_DEPTH"));
+
+ } else if (getenv("AFL_LLVM_CALLER_DEPTH")) {
+
+ instrument_ctx_max_depth = atoi(getenv("AFL_LLVM_CALLER_DEPTH"));
+
+ } else if (getenv("AFL_LLVM_CTX_DEPTH")) {
+
+ instrument_ctx_max_depth = atoi(getenv("AFL_LLVM_CTX_DEPTH"));
+
+ }
if ((isatty(2) && !getenv("AFL_QUIET")) || debug) {
+ char buf[64] = {};
+ if (instrument_ctx) {
+
+ snprintf(buf, sizeof(buf), " (CTX mode, depth %u)\n",
+ instrument_ctx_max_depth);
+
+ }
+
SAYF(cCYA "afl-llvm-lto" VERSION cRST
- " by Marc \"vanHauser\" Heuse <mh@mh-sec.de>\n");
+ "%s by Marc \"vanHauser\" Heuse <mh@mh-sec.de>\n",
+ buf);
- } else
+ } else {
be_quiet = 1;
+ }
+
skip_nozero = getenv("AFL_LLVM_SKIP_NEVERZERO");
use_threadsafe_counters = getenv("AFL_LLVM_THREADSAFE_INST");
@@ -500,7 +544,12 @@ bool ModuleSanitizerCoverageLTO::instrumentModule(
}
+ AFLContext = new GlobalVariable(
+ M, Int32Ty, false, GlobalValue::ExternalLinkage, 0, "__afl_prev_ctx", 0,
+ GlobalVariable::GeneralDynamicTLSModel, 0, false);
+
Zero = ConstantInt::get(Int8Tyi, 0);
+ Zero32 = ConstantInt::get(Int32Tyi, 0);
One = ConstantInt::get(Int8Tyi, 1);
initInstrumentList();
@@ -597,12 +646,12 @@ bool ModuleSanitizerCoverageLTO::instrumentModule(
}
dictionary.push_back(std::string((char *)&val, len));
- found++;
+ ++found;
if (val2) {
dictionary.push_back(std::string((char *)&val2, len));
- found++;
+ ++found;
}
@@ -750,12 +799,12 @@ bool ModuleSanitizerCoverageLTO::instrumentModule(
else
Str2 = TmpStr.str();
- if (debug)
+ /*if (debug)
fprintf(stderr, "F:%s %p(%s)->\"%s\"(%s) %p(%s)->\"%s\"(%s)\n",
FuncName.c_str(), Str1P, Str1P->getName().str().c_str(),
Str1.c_str(), HasStr1 == true ? "true" : "false", Str2P,
Str2P->getName().str().c_str(), Str2.c_str(),
- HasStr2 == true ? "true" : "false");
+ HasStr2 == true ? "true" : "false");*/
// we handle the 2nd parameter first because of llvm memcpy
if (!HasStr2) {
@@ -929,7 +978,7 @@ bool ModuleSanitizerCoverageLTO::instrumentModule(
'\0') {
thestring.append("\0", 1); // add null byte
- optLen++;
+ ++optLen;
}
@@ -1080,7 +1129,7 @@ bool ModuleSanitizerCoverageLTO::instrumentModule(
for (auto token : dictionary) {
memlen += token.length();
- count++;
+ ++count;
}
@@ -1101,7 +1150,7 @@ bool ModuleSanitizerCoverageLTO::instrumentModule(
ptrhld.get()[offset++] = (uint8_t)token.length();
memcpy(ptrhld.get() + offset, token.c_str(), token.length());
offset += token.length();
- count++;
+ ++count;
}
@@ -1148,7 +1197,7 @@ bool ModuleSanitizerCoverageLTO::instrumentModule(
WARNF("No instrumentation targets found.");
else {
- char modeline[100];
+ char modeline[128];
snprintf(modeline, sizeof(modeline), "%s%s%s%s%s%s",
getenv("AFL_HARDEN") ? "hardened" : "non-hardened",
getenv("AFL_USE_ASAN") ? ", ASAN" : "",
@@ -1156,9 +1205,16 @@ bool ModuleSanitizerCoverageLTO::instrumentModule(
getenv("AFL_USE_TSAN") ? ", TSAN" : "",
getenv("AFL_USE_CFISAN") ? ", CFISAN" : "",
getenv("AFL_USE_UBSAN") ? ", UBSAN" : "");
- OKF("Instrumented %u locations (%u selects) without collisions (%llu "
- "collisions have been avoided) (%s mode).",
- inst, select_cnt, calculateCollisions(inst), modeline);
+ char buf[64] = {};
+ if (instrument_ctx) {
+
+ snprintf(buf, sizeof(buf), " with %u extra map entries for CTX",
+ extra_ctx_inst);
+
+ }
+
+ OKF("Instrumented %u locations (%u selects)%s (%s mode).", inst,
+ select_cnt, buf, modeline);
}
@@ -1239,6 +1295,57 @@ static bool shouldInstrumentBlock(const Function &F, const BasicBlock *BB,
}
+/// return the number of calls to this function
+u32 countCallers(Function *F) {
+
+ u32 callers = 0;
+
+ if (!F) { return 0; }
+
+ for (auto *U : F->users()) {
+
+ if (auto *CI = dyn_cast<CallInst>(U)) {
+
+ ++callers;
+ (void)(CI);
+
+ }
+
+ }
+
+ return callers;
+
+}
+
+/// return the calling function of a function - only if there is a single caller
+Function *returnOnlyCaller(Function *F) {
+
+ Function *caller = NULL;
+
+ if (!F) { return NULL; }
+
+ for (auto *U : F->users()) {
+
+ if (auto *CI = dyn_cast<CallInst>(U)) {
+
+ if (caller == NULL) {
+
+ caller = CI->getParent()->getParent();
+
+ } else {
+
+ return NULL;
+
+ }
+
+ }
+
+ }
+
+ return caller;
+
+}
+
void ModuleSanitizerCoverageLTO::instrumentFunction(
Function &F, DomTreeCallback DTCallback, PostDomTreeCallback PDTCallback) {
@@ -1272,6 +1379,37 @@ void ModuleSanitizerCoverageLTO::instrumentFunction(
// AFL++ START
if (!F.size()) return;
+
+ LLVMContext &Context = F.getContext();
+ MDNode *N = MDNode::get(Context, MDString::get(Context, "nosanitize"));
+
+ if (instrument_ctx) {
+
+ // we have to set __afl_ctx 0 for all indirect calls in all functions, even
+ // those not to be instrumented.
+ for (auto &BB : F) {
+
+ for (auto &IN : BB) {
+
+ if (auto *Call = dyn_cast<CallInst>(&IN)) {
+
+ if (Call->isIndirectCall()) {
+
+ IRBuilder<> Builder(IN.getContext());
+ Builder.SetInsertPoint(IN.getParent(), IN.getIterator());
+ StoreInst *StoreCtx = Builder.CreateStore(Zero32, AFLContext);
+ StoreCtx->setMetadata("nosanitize", N);
+
+ }
+
+ }
+
+ }
+
+ }
+
+ }
+
if (!isInInstrumentList(&F, FMNAME)) return;
// AFL++ END
@@ -1285,11 +1423,297 @@ void ModuleSanitizerCoverageLTO::instrumentFunction(
const PostDominatorTree *PDT = PDTCallback(F);
bool IsLeafFunc = true;
uint32_t skip_next = 0;
+ uint32_t call_counter = 0, call_depth = 0;
+ uint32_t inst_save = inst, save_global = afl_global_id;
+ uint32_t inst_in_this_func = 0;
+ Function *caller = NULL;
+ LoadInst *PrevCtxLoad = NULL;
+
+ CTX_add = NULL;
+
+ if (debug) fprintf(stderr, "Function: %s\n", F.getName().str().c_str());
+
+ if (instrument_ctx) {
+
+ caller = &F;
+ call_counter = countCallers(caller);
+ Function *callee = caller;
+
+ if (call_counter == 1 && instrument_ctx_max_depth) {
+
+ ++call_depth;
+
+ while (instrument_ctx_max_depth >= call_depth &&
+ ((caller = returnOnlyCaller(callee)) || 1 == 1) &&
+ (call_counter = countCallers(callee)) == 1) {
+
+ if (debug && caller && callee)
+ fprintf(stderr, "DEBUG: another depth: %s <- %s [%u]\n",
+ callee->getName().str().c_str(),
+ caller->getName().str().c_str(), call_depth);
+ ++call_depth;
+ callee = caller;
+
+ }
+
+ if (!caller && callee) {
+
+ caller = callee;
+ if (debug)
+ fprintf(stderr, "DEBUG: depth found: %s <- %s [count=%u, depth=%u]\n",
+ caller->getName().str().c_str(), F.getName().str().c_str(),
+ call_counter, call_depth);
+
+ }
+
+ }
+
+ if (debug && call_counter < 2) {
+
+ fprintf(stderr, "Function %s only %u (%s)\n", F.getName().str().c_str(),
+ call_counter, caller->getName().str().c_str());
+
+ }
+
+ if (call_counter == 1) {
+
+ call_counter = 0;
+ caller = NULL;
+
+ }
+
+ if (debug) {
+
+ fprintf(stderr, "DEBUG: result: Function=%s callers=%u depth=%u\n",
+ F.getName().str().c_str(), call_counter, call_depth);
+
+ }
+
+ if (call_counter > 1) {
+
+ // Fake instrumentation so we can count how many instrumentations there
+ // will be in this function
+ for (auto &BB : F) {
+
+ for (auto &IN : BB) {
+
+ CallInst *callInst = nullptr;
+
+ if ((callInst = dyn_cast<CallInst>(&IN))) {
+
+ Function *Callee = callInst->getCalledFunction();
+ if (!Callee) continue;
+ if (callInst->getCallingConv() != llvm::CallingConv::C) continue;
+ StringRef FuncName = Callee->getName();
+
+ if (FuncName.compare(StringRef("__afl_coverage_interesting")))
+ continue;
+
+ ++inst;
+
+ }
+
+ SelectInst *selectInst = nullptr;
+
+ if ((selectInst = dyn_cast<SelectInst>(&IN))) {
+
+ Value *condition = selectInst->getCondition();
+ auto t = condition->getType();
+
+ if (t->getTypeID() == llvm::Type::IntegerTyID) {
+
+ inst += 2;
+
+ } else
+
+#if LLVM_VERSION_MAJOR >= 14
+ if (t->getTypeID() == llvm::Type::FixedVectorTyID) {
+
+ FixedVectorType *tt = dyn_cast<FixedVectorType>(t);
+ if (tt) {
+
+ uint32_t elements = tt->getElementCount().getFixedValue();
+ inst += elements * 2;
+
+ }
+
+ } else
+
+#endif
+ {
+
+ continue;
+
+ }
+
+ }
+
+ }
+
+ if (shouldInstrumentBlock(F, &BB, DT, PDT, Options))
+ BlocksToInstrument.push_back(&BB);
+
+ }
+
+ Fake_InjectCoverage(F, BlocksToInstrument, IsLeafFunc);
+
+ if (debug)
+ fprintf(stderr, "DEBUG: CTX: %u instrumentations\n", inst - inst_save);
+
+ // we only instrument functions that have more than one instrumented block
+ if (inst > inst_save + 1) {
+
+ inst_in_this_func = inst - inst_save;
+ bool done = false;
+
+ // in rare occasions there can be multiple entry points per function
+ for (auto &BB : F) {
+
+ if (&BB == &F.getEntryBlock() && done == false) {
+
+ // we insert a CTX value in all our callers:
+ IRBuilder<> Builder(Context);
+ CallInst *CI = NULL;
+ Function *F2 = NULL;
+ uint32_t instrumented_calls = 0;
+
+ for (auto *U : caller->users()) {
+
+ if ((CI = dyn_cast<CallInst>(U))) {
+
+ F2 = CI->getParent()->getParent();
+ if (debug)
+ fprintf(stderr,
+ "DEBUG: CTX call insert %s [%u/%u] -> %s/%s\n",
+ F2->getName().str().c_str(), instrumented_calls + 1,
+ call_counter, caller->getName().str().c_str(),
+ F.getName().str().c_str());
+
+ Builder.SetInsertPoint(CI);
+ StoreInst *StoreCtx = Builder.CreateStore(
+ ConstantInt::get(Type::getInt32Ty(Context),
+ instrumented_calls++),
+ AFLContext);
+ StoreCtx->setMetadata("nosanitize", N);
+
+ }
+
+ }
+
+ if (instrumented_calls != call_counter) {
+
+ fprintf(stderr, "BUG! %s/%s <=> %u vs %u\n",
+ caller->getName().str().c_str(),
+ F.getName().str().c_str(), instrumented_calls,
+ call_counter);
+ exit(-1);
+
+ }
+
+ done = true;
+
+ }
+
+ // in all entrypoints we have to load the CTX value
+ if (&BB == &F.getEntryBlock()) {
+
+ Value *CTX_offset;
+ BasicBlock::iterator IP = BB.getFirstInsertionPt();
+ IRBuilder<> IRB(&(*IP));
+
+ PrevCtxLoad = IRB.CreateLoad(
+#if LLVM_VERSION_MAJOR >= 14
+ IRB.getInt32Ty(),
+#endif
+ AFLContext);
+ PrevCtxLoad->setMetadata("nosanitize", N);
+
+ CTX_offset = IRB.CreateMul(
+ ConstantInt::get(Type::getInt32Ty(Context), inst_in_this_func),
+ PrevCtxLoad, "CTXmul", false, true);
+
+ CTX_add =
+ IRB.CreateAlloca(Type::getInt32Ty(Context), nullptr, "CTX_add");
+ auto nosan = IRB.CreateStore(CTX_offset, CTX_add);
+ nosan->setMetadata("nosanitize", N);
+
+ if (debug)
+ fprintf(
+ stderr, "DEBUG: extra CTX instrumentations for %s: %u * %u\n",
+ F.getName().str().c_str(), inst - inst_save, call_counter);
+
+ }
+
+ for (auto &IN : BB) {
+
+ // check all calls and where callee count == 1 instrument
+ // our current caller_id to __afl_ctx
+ if (auto callInst = dyn_cast<CallInst>(&IN)) {
+
+ Function *Callee = callInst->getCalledFunction();
+ if (countCallers(Callee) == 1) {
+
+ if (debug)
+ fprintf(stderr, "DEBUG: %s call to %s with only one caller\n",
+ F.getName().str().c_str(),
+ Callee->getName().str().c_str());
+
+ IRBuilder<> Builder(IN.getContext());
+ Builder.SetInsertPoint(callInst);
+ StoreInst *StoreCtx =
+ Builder.CreateStore(PrevCtxLoad, AFLContext);
+ StoreCtx->setMetadata("nosanitize", N);
+
+ }
+
+ }
+
+ }
+
+ }
+
+ }
+
+ }
+
+ inst = inst_save;
+
+ /* if (debug)
+ fprintf(stderr, "Next instrumentation (%u-%u=%u %u-%u=%u)\n", inst,
+ inst_save, inst - inst_save, afl_global_id, save_global,
+ afl_global_id - save_global);*/
+
+ }
for (auto &BB : F) {
+ skip_next = 0;
+
+ /*
+ uint32_t j = 0;
+ fprintf(stderr, "BB %p ============================================\n",
+ CTX_add);*/
+
for (auto &IN : BB) {
+ /* j++;
+ uint32_t i = 1;
+ std::string errMsg;
+ raw_string_ostream os(errMsg);
+ IN.print(os);
+ fprintf(stderr, "Next instruction, BB size now %zu: %02u %s\n",
+ BB.size(), j, os.str().c_str()); for (auto &IN2 : BB) {
+
+ std::string errMsg2;
+ raw_string_ostream os2(errMsg2);
+ IN2.print(os2);
+ fprintf(
+ stderr, "%s %02u: %s\n",
+ strcmp(os.str().c_str(), os2.str().c_str()) == 0 ? ">>>" : "
+ ", i++, os2.str().c_str());
+
+ }*/
+
CallInst *callInst = nullptr;
if ((callInst = dyn_cast<CallInst>(&IN))) {
@@ -1313,6 +1737,19 @@ void ModuleSanitizerCoverageLTO::instrumentFunction(
if (FuncName.compare(StringRef("__afl_coverage_interesting"))) continue;
Value *val = ConstantInt::get(Int32Ty, ++afl_global_id);
+ if (CTX_add) {
+
+ IRBuilder<> Builder(Context);
+ LoadInst *CTX_load = Builder.CreateLoad(
+#if LLVM_VERSION_MAJOR >= 14
+ Builder.getInt32Ty(),
+#endif
+ CTX_add);
+ ModuleSanitizerCoverageLTO::SetNoSanitizeMetadata(CTX_load);
+ val = Builder.CreateAdd(val, CTX_load);
+
+ }
+
callInst->setOperand(1, val);
++inst;
@@ -1320,164 +1757,228 @@ void ModuleSanitizerCoverageLTO::instrumentFunction(
SelectInst *selectInst = nullptr;
- /*
- std::string errMsg;
- raw_string_ostream os(errMsg);
- IN.print(os);
- fprintf(stderr, "X(%u): %s\n", skip_next, os.str().c_str());
- */
- if (!skip_next && (selectInst = dyn_cast<SelectInst>(&IN))) {
+ if ((selectInst = dyn_cast<SelectInst>(&IN))) {
- uint32_t vector_cnt = 0;
- Value *condition = selectInst->getCondition();
- Value *result;
- auto t = condition->getType();
- IRBuilder<> IRB(selectInst->getNextNode());
+ if (!skip_next) {
- ++select_cnt;
+ // fprintf(stderr, "Select in\n");
- if (t->getTypeID() == llvm::Type::IntegerTyID) {
+ uint32_t vector_cnt = 0;
+ Value *condition = selectInst->getCondition();
+ Value *result;
+ auto t = condition->getType();
+ IRBuilder<> IRB(selectInst->getNextNode());
- Value *val1 = ConstantInt::get(Int32Ty, ++afl_global_id);
- Value *val2 = ConstantInt::get(Int32Ty, ++afl_global_id);
- result = IRB.CreateSelect(condition, val1, val2);
- skip_next = 1;
- inst += 2;
+ ++select_cnt;
+
+ if (t->getTypeID() == llvm::Type::IntegerTyID) {
- } else
+ Value *val1 = ConstantInt::get(Int32Ty, ++afl_global_id);
+ Value *val2 = ConstantInt::get(Int32Ty, ++afl_global_id);
+ if (CTX_add) {
+ LoadInst *CTX_load = IRB.CreateLoad(
#if LLVM_VERSION_MAJOR >= 14
- if (t->getTypeID() == llvm::Type::FixedVectorTyID) {
+ IRB.getInt32Ty(),
+#endif
+ CTX_add);
+ val1 = IRB.CreateAdd(val1, CTX_load);
+ val2 = IRB.CreateAdd(val2, CTX_load);
- FixedVectorType *tt = dyn_cast<FixedVectorType>(t);
- if (tt) {
+ }
- uint32_t elements = tt->getElementCount().getFixedValue();
- vector_cnt = elements;
- inst += vector_cnt * 2;
- if (elements) {
+ result = IRB.CreateSelect(condition, val1, val2);
+ skip_next = 1;
+ inst += 2;
- FixedVectorType *GuardPtr1 =
- FixedVectorType::get(Int32Ty, elements);
- FixedVectorType *GuardPtr2 =
- FixedVectorType::get(Int32Ty, elements);
- Value *x, *y;
+ } else
- Value *val1 = ConstantInt::get(Int32Ty, ++afl_global_id);
- Value *val2 = ConstantInt::get(Int32Ty, ++afl_global_id);
- x = IRB.CreateInsertElement(GuardPtr1, val1, (uint64_t)0);
- y = IRB.CreateInsertElement(GuardPtr2, val2, (uint64_t)0);
+#if LLVM_VERSION_MAJOR >= 14
+ if (t->getTypeID() == llvm::Type::FixedVectorTyID) {
- for (uint64_t i = 1; i < elements; i++) {
+ FixedVectorType *tt = dyn_cast<FixedVectorType>(t);
+ if (tt) {
- val1 = ConstantInt::get(Int32Ty, ++afl_global_id);
- val2 = ConstantInt::get(Int32Ty, ++afl_global_id);
- x = IRB.CreateInsertElement(GuardPtr1, val1, i);
- y = IRB.CreateInsertElement(GuardPtr2, val2, i);
+ uint32_t elements = tt->getElementCount().getFixedValue();
+ vector_cnt = elements;
+ inst += vector_cnt * 2;
+ if (elements) {
- }
+ FixedVectorType *GuardPtr1 =
+ FixedVectorType::get(Int32Ty, elements);
+ FixedVectorType *GuardPtr2 =
+ FixedVectorType::get(Int32Ty, elements);
+ Value *x, *y;
- result = IRB.CreateSelect(condition, x, y);
- skip_next = 1;
+ Value *val1 = ConstantInt::get(Int32Ty, ++afl_global_id);
+ Value *val2 = ConstantInt::get(Int32Ty, ++afl_global_id);
+ if (CTX_add) {
- }
+ LoadInst *CTX_load = IRB.CreateLoad(
+ #if LLVM_VERSION_MAJOR >= 14
+ IRB.getInt32Ty(),
+ #endif
+ CTX_add);
+ val1 = IRB.CreateAdd(val1, CTX_load);
+ val2 = IRB.CreateAdd(val2, CTX_load);
- }
+ }
- } else
+ x = IRB.CreateInsertElement(GuardPtr1, val1, (uint64_t)0);
+ y = IRB.CreateInsertElement(GuardPtr2, val2, (uint64_t)0);
-#endif
- {
+ for (uint64_t i = 1; i < elements; i++) {
- unhandled++;
- continue;
+ val1 = ConstantInt::get(Int32Ty, ++afl_global_id);
+ val2 = ConstantInt::get(Int32Ty, ++afl_global_id);
+ /*if (CTX_add) { // already loaded I guess
- }
+ LoadInst *CTX_load = IRB.CreateLoad(
+ #if LLVM_VERSION_MAJOR >= 14
+ IRB.getInt32Ty(),
+ #endif
+ CTX_add);
+ val1 = IRB.CreateAdd(val1, CTX_load);
+ val2 = IRB.CreateAdd(val2, CTX_load);
+
+ }*/
- uint32_t vector_cur = 0;
- /* Load SHM pointer */
- LoadInst *MapPtr =
- IRB.CreateLoad(PointerType::get(Int8Ty, 0), AFLMapPtr);
- ModuleSanitizerCoverageLTO::SetNoSanitizeMetadata(MapPtr);
+ x = IRB.CreateInsertElement(GuardPtr1, val1, i);
+ y = IRB.CreateInsertElement(GuardPtr2, val2, i);
- while (1) {
+ }
- /* Get CurLoc */
- Value *MapPtrIdx = nullptr;
+ result = IRB.CreateSelect(condition, x, y);
+ skip_next = 1;
- /* Load counter for CurLoc */
- if (!vector_cnt) {
+ }
- MapPtrIdx = IRB.CreateGEP(Int8Ty, MapPtr, result);
+ }
- } else {
+ } else
+
+#endif
+ {
- auto element = IRB.CreateExtractElement(result, vector_cur++);
- MapPtrIdx = IRB.CreateGEP(Int8Ty, MapPtr, element);
+ ++unhandled;
+ continue;
}
- if (use_threadsafe_counters) {
+ uint32_t vector_cur = 0;
+ /* Load SHM pointer */
+ LoadInst *MapPtr =
+ IRB.CreateLoad(PointerType::get(Int8Ty, 0), AFLMapPtr);
+ ModuleSanitizerCoverageLTO::SetNoSanitizeMetadata(MapPtr);
+
+ while (1) {
+
+ /* Get CurLoc */
+ Value *MapPtrIdx = nullptr;
+
+ /* Load counter for CurLoc */
+ if (!vector_cnt) {
+
+ MapPtrIdx = IRB.CreateGEP(Int8Ty, MapPtr, result);
+
+ } else {
+
+ auto element = IRB.CreateExtractElement(result, vector_cur++);
+ MapPtrIdx = IRB.CreateGEP(Int8Ty, MapPtr, element);
+
+ }
+
+ if (use_threadsafe_counters) {
- IRB.CreateAtomicRMW(llvm::AtomicRMWInst::BinOp::Add, MapPtrIdx, One,
+ IRB.CreateAtomicRMW(llvm::AtomicRMWInst::BinOp::Add, MapPtrIdx,
+ One,
#if LLVM_VERSION_MAJOR >= 13
- llvm::MaybeAlign(1),
+ llvm::MaybeAlign(1),
#endif
- llvm::AtomicOrdering::Monotonic);
+ llvm::AtomicOrdering::Monotonic);
- } else {
+ } else {
- LoadInst *Counter = IRB.CreateLoad(IRB.getInt8Ty(), MapPtrIdx);
- ModuleSanitizerCoverageLTO::SetNoSanitizeMetadata(Counter);
+ LoadInst *Counter = IRB.CreateLoad(IRB.getInt8Ty(), MapPtrIdx);
+ ModuleSanitizerCoverageLTO::SetNoSanitizeMetadata(Counter);
- /* Update bitmap */
+ /* Update bitmap */
- Value *Incr = IRB.CreateAdd(Counter, One);
+ Value *Incr = IRB.CreateAdd(Counter, One);
- if (skip_nozero == NULL) {
+ if (skip_nozero == NULL) {
- auto cf = IRB.CreateICmpEQ(Incr, Zero);
- auto carry = IRB.CreateZExt(cf, Int8Ty);
- Incr = IRB.CreateAdd(Incr, carry);
+ auto cf = IRB.CreateICmpEQ(Incr, Zero);
+ auto carry = IRB.CreateZExt(cf, Int8Ty);
+ Incr = IRB.CreateAdd(Incr, carry);
+
+ }
+
+ auto nosan = IRB.CreateStore(Incr, MapPtrIdx);
+ ModuleSanitizerCoverageLTO::SetNoSanitizeMetadata(nosan);
}
- auto nosan = IRB.CreateStore(Incr, MapPtrIdx);
- ModuleSanitizerCoverageLTO::SetNoSanitizeMetadata(nosan);
+ if (!vector_cnt || vector_cnt == vector_cur) { break; }
}
- if (!vector_cnt || vector_cnt == vector_cur) { break; }
-
- }
+ skip_next = 1;
+ // fprintf(stderr, "Select out\n");
- skip_next = 1;
+ } else {
- } else {
+ // fprintf(stderr, "Select skip\n");
+ skip_next = 0;
- skip_next = 0;
+ }
}
}
- if (shouldInstrumentBlock(F, &BB, DT, PDT, Options))
- BlocksToInstrument.push_back(&BB);
- for (auto &Inst : BB) {
+ if (!instrument_ctx)
+ if (shouldInstrumentBlock(F, &BB, DT, PDT, Options))
+ BlocksToInstrument.push_back(&BB);
- if (Options.IndirectCalls) {
+ /*
+ for (auto &Inst : BB) {
- CallBase *CB = dyn_cast<CallBase>(&Inst);
- if (CB && !CB->getCalledFunction()) IndirCalls.push_back(&Inst);
+ if (Options.IndirectCalls) {
- }
+ CallBase *CB = dyn_cast<CallBase>(&Inst);
+ if (CB && !CB->getCalledFunction()) IndirCalls.push_back(&Inst);
- }
+ }
+
+ }*/
}
InjectCoverage(F, BlocksToInstrument, IsLeafFunc);
- InjectCoverageForIndirectCalls(F, IndirCalls);
+ // InjectCoverageForIndirectCalls(F, IndirCalls);
+
+ /*if (debug)
+ fprintf(stderr, "Done instrumentation (%u-%u=%u %u-%u=%u)\n", inst,
+ inst_save, inst - inst_save, afl_global_id, save_global,
+ afl_global_id - save_global);*/
+
+ if (inst_in_this_func && call_counter > 1) {
+
+ if (inst_in_this_func != afl_global_id - save_global) {
+
+ fprintf(
+ stderr,
+ "BUG! inst_in_this_func %u != afl_global_id %u - save_global %u\n",
+ inst_in_this_func, afl_global_id, save_global);
+ exit(-1);
+
+ }
+
+ extra_ctx_inst += inst_in_this_func * (call_counter - 1);
+ afl_global_id += extra_ctx_inst;
+
+ }
}
@@ -1603,6 +2104,34 @@ bool ModuleSanitizerCoverageLTO::InjectCoverage(
}
+bool ModuleSanitizerCoverageLTO::Fake_InjectCoverage(
+ Function &F, ArrayRef<BasicBlock *> AllBlocks, bool IsLeafFunc) {
+
+ if (AllBlocks.empty()) return false;
+
+ for (size_t i = 0, N = AllBlocks.size(); i < N; i++) {
+
+ if (BlockList.size()) {
+
+ int skip = 0;
+ for (uint32_t k = 0; k < BlockList.size(); k++) {
+
+ if (AllBlocks[i] == BlockList[k]) { skip = 1; }
+
+ }
+
+ if (skip) continue;
+
+ }
+
+ ++inst; // InjectCoverageAtBlock()
+
+ }
+
+ return true;
+
+}
+
// On every indirect call we call a run-time function
// __sanitizer_cov_indir_call* with two parameters:
// - callee address,
@@ -1610,6 +2139,7 @@ bool ModuleSanitizerCoverageLTO::InjectCoverage(
// The cache is used to speed up recording the caller-callee pairs.
// The address of the caller is passed implicitly via caller PC.
// CacheSize is encoded in the name of the run-time function.
+/*
void ModuleSanitizerCoverageLTO::InjectCoverageForIndirectCalls(
Function &F, ArrayRef<Instruction *> IndirCalls) {
@@ -1628,6 +2158,8 @@ void ModuleSanitizerCoverageLTO::InjectCoverageForIndirectCalls(
}
+*/
+
void ModuleSanitizerCoverageLTO::InjectCoverageAtBlock(Function &F,
BasicBlock &BB,
size_t Idx,
@@ -1674,6 +2206,19 @@ void ModuleSanitizerCoverageLTO::InjectCoverageAtBlock(Function &F,
/* Set the ID of the inserted basic block */
ConstantInt *CurLoc = ConstantInt::get(Int32Tyi, afl_global_id);
+ Value *val = CurLoc;
+
+ if (CTX_add) {
+
+ LoadInst *CTX_load = IRB.CreateLoad(
+#if LLVM_VERSION_MAJOR >= 14
+ IRB.getInt32Ty(),
+#endif
+ CTX_add);
+ ModuleSanitizerCoverageLTO::SetNoSanitizeMetadata(CTX_load);
+ val = IRB.CreateAdd(CurLoc, CTX_load);
+
+ }
/* Load SHM pointer */
@@ -1681,13 +2226,13 @@ void ModuleSanitizerCoverageLTO::InjectCoverageAtBlock(Function &F,
if (map_addr) {
- MapPtrIdx = IRB.CreateGEP(Int8Ty, MapPtrFixed, CurLoc);
+ MapPtrIdx = IRB.CreateGEP(Int8Ty, MapPtrFixed, val);
} else {
LoadInst *MapPtr = IRB.CreateLoad(PointerType::get(Int8Ty, 0), AFLMapPtr);
ModuleSanitizerCoverageLTO::SetNoSanitizeMetadata(MapPtr);
- MapPtrIdx = IRB.CreateGEP(Int8Ty, MapPtr, CurLoc);
+ MapPtrIdx = IRB.CreateGEP(Int8Ty, MapPtr, val);
}
@@ -1722,12 +2267,10 @@ void ModuleSanitizerCoverageLTO::InjectCoverageAtBlock(Function &F,
// done :)
- inst++;
+ ++inst;
// AFL++ END
/*
- XXXXXXXXXXXXXXXXXXX
-
auto GuardPtr = IRB.CreateIntToPtr(
IRB.CreateAdd(IRB.CreatePointerCast(FunctionGuardArray, IntptrTy),
ConstantInt::get(IntptrTy, Idx * 4)),
diff --git a/instrumentation/afl-compiler-rt.o.c b/instrumentation/afl-compiler-rt.o.c
index caa3c3a8..e450dc45 100644
--- a/instrumentation/afl-compiler-rt.o.c
+++ b/instrumentation/afl-compiler-rt.o.c
@@ -87,6 +87,10 @@ __attribute__((weak)) void __sanitizer_symbolize_pc(void *, const char *fmt,
#include <sys/mman.h>
#include <fcntl.h>
+#ifdef AFL_PERSISTENT_RECORD
+ #include "afl-persistent-replay.h"
+#endif
+
/* Globals needed by the injected instrumentation. The __afl_area_initial region
is used for instrumentation output before __afl_map_shm() has a chance to
run. It will end up as .comm, so it shouldn't be too wasteful. */
@@ -186,6 +190,8 @@ __thread u32 __afl_prev_ctx;
struct cmp_map *__afl_cmp_map;
struct cmp_map *__afl_cmp_map_backup;
+static u8 __afl_cmplog_max_len = 32; // 16-32
+
/* Child pid? */
static s32 child_pid;
@@ -264,7 +270,7 @@ static void send_forkserver_error(int error) {
u32 status;
if (!error || error > 0xffff) return;
- status = (FS_OPT_ERROR | FS_OPT_SET_ERROR(error));
+ status = (FS_NEW_ERROR | error);
if (write(FORKSRV_FD + 1, (char *)&status, 4) != 4) { return; }
}
@@ -367,32 +373,13 @@ static void __afl_map_shm(void) {
if ((ptr = getenv("AFL_MAP_SIZE")) != NULL) { val = atoi(ptr); }
if (val < __afl_final_loc) {
- if (__afl_final_loc > FS_OPT_MAX_MAPSIZE) {
-
- if (!getenv("AFL_QUIET"))
- fprintf(stderr,
- "Error: AFL++ tools *require* to set AFL_MAP_SIZE to %u "
- "to be able to run this instrumented program!\n",
- __afl_final_loc);
-
- if (id_str) {
-
- send_forkserver_error(FS_ERROR_MAP_SIZE);
- exit(-1);
-
- }
-
- } else {
+ if (__afl_final_loc > MAP_INITIAL_SIZE && !getenv("AFL_QUIET")) {
- if (__afl_final_loc > MAP_INITIAL_SIZE && !getenv("AFL_QUIET")) {
-
- fprintf(stderr,
- "Warning: AFL++ tools might need to set AFL_MAP_SIZE to %u "
- "to be able to run this instrumented program if this "
- "crashes!\n",
- __afl_final_loc);
-
- }
+ fprintf(stderr,
+ "Warning: AFL++ tools might need to set AFL_MAP_SIZE to %u "
+ "to be able to run this instrumented program if this "
+ "crashes!\n",
+ __afl_final_loc);
}
@@ -400,15 +387,6 @@ static void __afl_map_shm(void) {
}
- } else {
-
- if (getenv("AFL_DUMP_MAP_SIZE")) {
-
- printf("%u\n", MAP_SIZE);
- exit(-1);
-
- }
-
}
if (__afl_sharedmem_fuzzing && (!id_str || !getenv(SHM_FUZZ_ENV_VAR) ||
@@ -474,14 +452,13 @@ static void __afl_map_shm(void) {
if (__afl_debug) {
- fprintf(
- stderr,
- "DEBUG: (1) id_str %s, __afl_area_ptr %p, __afl_area_initial %p, "
- "__afl_area_ptr_dummy %p, __afl_map_addr 0x%llx, MAP_SIZE %u, "
- "__afl_final_loc %u, __afl_map_size %u, max_size_forkserver %u/0x%x\n",
- id_str == NULL ? "<null>" : id_str, __afl_area_ptr, __afl_area_initial,
- __afl_area_ptr_dummy, __afl_map_addr, MAP_SIZE, __afl_final_loc,
- __afl_map_size, FS_OPT_MAX_MAPSIZE, FS_OPT_MAX_MAPSIZE);
+ fprintf(stderr,
+ "DEBUG: (1) id_str %s, __afl_area_ptr %p, __afl_area_initial %p, "
+ "__afl_area_ptr_dummy %p, __afl_map_addr 0x%llx, MAP_SIZE %u, "
+ "__afl_final_loc %u, __afl_map_size %u\n",
+ id_str == NULL ? "<null>" : id_str, __afl_area_ptr,
+ __afl_area_initial, __afl_area_ptr_dummy, __afl_map_addr, MAP_SIZE,
+ __afl_final_loc, __afl_map_size);
}
@@ -639,12 +616,10 @@ static void __afl_map_shm(void) {
fprintf(stderr,
"DEBUG: (2) id_str %s, __afl_area_ptr %p, __afl_area_initial %p, "
"__afl_area_ptr_dummy %p, __afl_map_addr 0x%llx, MAP_SIZE "
- "%u, __afl_final_loc %u, __afl_map_size %u, "
- "max_size_forkserver %u/0x%x\n",
+ "%u, __afl_final_loc %u, __afl_map_size %u",
id_str == NULL ? "<null>" : id_str, __afl_area_ptr,
__afl_area_initial, __afl_area_ptr_dummy, __afl_map_addr, MAP_SIZE,
- __afl_final_loc, __afl_map_size, FS_OPT_MAX_MAPSIZE,
- FS_OPT_MAX_MAPSIZE);
+ __afl_final_loc, __afl_map_size);
}
@@ -761,6 +736,19 @@ static void __afl_map_shm(void) {
#endif // __AFL_CODE_COVERAGE
+ if (!__afl_cmp_map && getenv("AFL_CMPLOG_DEBUG")) {
+
+ __afl_cmp_map_backup = __afl_cmp_map = malloc(sizeof(struct cmp_map));
+
+ }
+
+ if (getenv("AFL_CMPLOG_MAX_LEN")) {
+
+ int tmp = atoi(getenv("AFL_CMPLOG_MAX_LEN"));
+ if (tmp >= 16 && tmp <= 32) { __afl_cmplog_max_len = tmp; }
+
+ }
+
}
/* unmap SHM. */
@@ -855,242 +843,6 @@ void write_error_with_location(char *text, char *filename, int linenumber) {
}
-#ifdef __linux__
-static void __afl_start_snapshots(void) {
-
- static u8 tmp[4] = {0, 0, 0, 0};
- u32 status = 0;
- u32 already_read_first = 0;
- u32 was_killed;
-
- u8 child_stopped = 0;
-
- void (*old_sigchld_handler)(int) = signal(SIGCHLD, SIG_DFL);
-
- /* Phone home and tell the parent that we're OK. If parent isn't there,
- assume we're not running in forkserver mode and just execute program. */
-
- status |= (FS_OPT_ENABLED | FS_OPT_SNAPSHOT | FS_OPT_NEWCMPLOG);
- if (__afl_sharedmem_fuzzing) { status |= FS_OPT_SHDMEM_FUZZ; }
- if (__afl_map_size <= FS_OPT_MAX_MAPSIZE)
- status |= (FS_OPT_SET_MAPSIZE(__afl_map_size) | FS_OPT_MAPSIZE);
- if (__afl_dictionary_len && __afl_dictionary) { status |= FS_OPT_AUTODICT; }
- memcpy(tmp, &status, 4);
-
- if (write(FORKSRV_FD + 1, tmp, 4) != 4) { return; }
-
- if (__afl_sharedmem_fuzzing || (__afl_dictionary_len && __afl_dictionary)) {
-
- if (read(FORKSRV_FD, &was_killed, 4) != 4) {
-
- write_error("read to afl-fuzz");
- _exit(1);
-
- }
-
- if (__afl_debug) {
-
- fprintf(stderr, "DEBUG: target forkserver recv: %08x\n", was_killed);
-
- }
-
- if ((was_killed & (FS_OPT_ENABLED | FS_OPT_SHDMEM_FUZZ)) ==
- (FS_OPT_ENABLED | FS_OPT_SHDMEM_FUZZ)) {
-
- __afl_map_shm_fuzz();
-
- }
-
- if ((was_killed & (FS_OPT_ENABLED | FS_OPT_AUTODICT)) ==
- (FS_OPT_ENABLED | FS_OPT_AUTODICT) &&
- __afl_dictionary_len && __afl_dictionary) {
-
- // great lets pass the dictionary through the forkserver FD
- u32 len = __afl_dictionary_len, offset = 0;
- s32 ret;
-
- if (write(FORKSRV_FD + 1, &len, 4) != 4) {
-
- write(2, "Error: could not send dictionary len\n",
- strlen("Error: could not send dictionary len\n"));
- _exit(1);
-
- }
-
- while (len != 0) {
-
- ret = write(FORKSRV_FD + 1, __afl_dictionary + offset, len);
-
- if (ret < 1) {
-
- write(2, "Error: could not send dictionary\n",
- strlen("Error: could not send dictionary\n"));
- _exit(1);
-
- }
-
- len -= ret;
- offset += ret;
-
- }
-
- } else {
-
- // uh this forkserver does not understand extended option passing
- // or does not want the dictionary
- if (!__afl_fuzz_ptr) already_read_first = 1;
-
- }
-
- }
-
- while (1) {
-
- int status;
-
- if (already_read_first) {
-
- already_read_first = 0;
-
- } else {
-
- /* Wait for parent by reading from the pipe. Abort if read fails. */
- if (read(FORKSRV_FD, &was_killed, 4) != 4) {
-
- write_error("reading from afl-fuzz");
- _exit(1);
-
- }
-
- }
-
- #ifdef _AFL_DOCUMENT_MUTATIONS
- if (__afl_fuzz_ptr) {
-
- static uint32_t counter = 0;
- char fn[32];
- sprintf(fn, "%09u:forkserver", counter);
- s32 fd_doc = open(fn, O_WRONLY | O_CREAT | O_TRUNC, DEFAULT_PERMISSION);
- if (fd_doc >= 0) {
-
- if (write(fd_doc, __afl_fuzz_ptr, *__afl_fuzz_len) != *__afl_fuzz_len) {
-
- fprintf(stderr, "write of mutation file failed: %s\n", fn);
- unlink(fn);
-
- }
-
- close(fd_doc);
-
- }
-
- counter++;
-
- }
-
- #endif
-
- /* If we stopped the child in persistent mode, but there was a race
- condition and afl-fuzz already issued SIGKILL, write off the old
- process. */
-
- if (child_stopped && was_killed) {
-
- child_stopped = 0;
- if (waitpid(child_pid, &status, 0) < 0) {
-
- write_error("child_stopped && was_killed");
- _exit(1); // TODO why exit?
-
- }
-
- }
-
- if (!child_stopped) {
-
- /* Once woken up, create a clone of our process. */
-
- child_pid = fork();
- if (child_pid < 0) {
-
- write_error("fork");
- _exit(1);
-
- }
-
- /* In child process: close fds, resume execution. */
-
- if (!child_pid) {
-
- //(void)nice(-20); // does not seem to improve
-
- signal(SIGCHLD, old_sigchld_handler);
- signal(SIGTERM, old_sigterm_handler);
-
- close(FORKSRV_FD);
- close(FORKSRV_FD + 1);
-
- if (!afl_snapshot_take(AFL_SNAPSHOT_MMAP | AFL_SNAPSHOT_FDS |
- AFL_SNAPSHOT_REGS | AFL_SNAPSHOT_EXIT)) {
-
- raise(SIGSTOP);
-
- }
-
- __afl_area_ptr[0] = 1;
- memset(__afl_prev_loc, 0, NGRAM_SIZE_MAX * sizeof(PREV_LOC_T));
-
- return;
-
- }
-
- } else {
-
- /* Special handling for persistent mode: if the child is alive but
- currently stopped, simply restart it with SIGCONT. */
-
- kill(child_pid, SIGCONT);
- child_stopped = 0;
-
- }
-
- /* In parent process: write PID to pipe, then wait for child. */
-
- if (write(FORKSRV_FD + 1, &child_pid, 4) != 4) {
-
- write_error("write to afl-fuzz");
- _exit(1);
-
- }
-
- if (waitpid(child_pid, &status, WUNTRACED) < 0) {
-
- write_error("waitpid");
- _exit(1);
-
- }
-
- /* In persistent mode, the child stops itself with SIGSTOP to indicate
- a successful run. In this case, we want to wake it up without forking
- again. */
-
- if (WIFSTOPPED(status)) child_stopped = 1;
-
- /* Relay wait status to pipe, then loop back. */
-
- if (write(FORKSRV_FD + 1, &status, 4) != 4) {
-
- write_error("writing to afl-fuzz");
- _exit(1);
-
- }
-
- }
-
-}
-
-#endif
-
/* Fork server logic. */
static void __afl_start_forkserver(void) {
@@ -1103,113 +855,92 @@ static void __afl_start_forkserver(void) {
old_sigterm_handler = orig_action.sa_handler;
signal(SIGTERM, at_exit);
-#ifdef __linux__
- if (/*!is_persistent &&*/ !__afl_cmp_map && !getenv("AFL_NO_SNAPSHOT") &&
- afl_snapshot_init() >= 0) {
-
- __afl_start_snapshots();
- return;
-
- }
-
-#endif
-
- u8 tmp[4] = {0, 0, 0, 0};
- u32 status_for_fsrv = 0;
u32 already_read_first = 0;
u32 was_killed;
+ u32 version = 0x41464c00 + FS_NEW_VERSION_MAX;
+ u32 tmp = version ^ 0xffffffff, status2, status = version;
+ u8 *msg = (u8 *)&status;
+ u8 *reply = (u8 *)&status2;
u8 child_stopped = 0;
void (*old_sigchld_handler)(int) = signal(SIGCHLD, SIG_DFL);
- if (__afl_map_size <= FS_OPT_MAX_MAPSIZE) {
+ /* Phone home and tell the parent that we're OK. If parent isn't there,
+ assume we're not running in forkserver mode and just execute program. */
- status_for_fsrv |= (FS_OPT_SET_MAPSIZE(__afl_map_size) | FS_OPT_MAPSIZE);
+ // return because possible non-forkserver usage
+ if (write(FORKSRV_FD + 1, msg, 4) != 4) { return; }
- }
+ if (read(FORKSRV_FD, reply, 4) != 4) { _exit(1); }
+ if (tmp != status2) {
- if (__afl_dictionary_len && __afl_dictionary) {
-
- status_for_fsrv |= FS_OPT_AUTODICT;
+ write_error("wrong forkserver message from AFL++ tool");
+ _exit(1);
}
- if (__afl_sharedmem_fuzzing) { status_for_fsrv |= FS_OPT_SHDMEM_FUZZ; }
- if (status_for_fsrv) {
+ // send the set/requested options to forkserver
+ status = FS_NEW_OPT_MAPSIZE; // we always send the map size
+ if (__afl_sharedmem_fuzzing) { status |= FS_NEW_OPT_SHDMEM_FUZZ; }
+ if (__afl_dictionary_len && __afl_dictionary) {
- status_for_fsrv |= (FS_OPT_ENABLED | FS_OPT_NEWCMPLOG);
+ status |= FS_NEW_OPT_AUTODICT;
}
- memcpy(tmp, &status_for_fsrv, 4);
+ if (write(FORKSRV_FD + 1, msg, 4) != 4) { _exit(1); }
- /* Phone home and tell the parent that we're OK. If parent isn't there,
- assume we're not running in forkserver mode and just execute program. */
+ // Now send the parameters for the set options, increasing by option number
- if (write(FORKSRV_FD + 1, tmp, 4) != 4) { return; }
+ // FS_NEW_OPT_MAPSIZE - we always send the map size
+ status = __afl_map_size;
+ if (write(FORKSRV_FD + 1, msg, 4) != 4) { _exit(1); }
- __afl_connected = 1;
-
- if (__afl_sharedmem_fuzzing || (__afl_dictionary_len && __afl_dictionary)) {
+ // FS_NEW_OPT_SHDMEM_FUZZ - no data
- if (read(FORKSRV_FD, &was_killed, 4) != 4) _exit(1);
-
- if (__afl_debug) {
-
- fprintf(stderr, "DEBUG: target forkserver recv: %08x\n", was_killed);
+ // FS_NEW_OPT_AUTODICT - send autodictionary
+ if (__afl_dictionary_len && __afl_dictionary) {
- }
+ // pass the dictionary through the forkserver FD
+ u32 len = __afl_dictionary_len, offset = 0;
- if ((was_killed & (FS_OPT_ENABLED | FS_OPT_SHDMEM_FUZZ)) ==
- (FS_OPT_ENABLED | FS_OPT_SHDMEM_FUZZ)) {
+ if (write(FORKSRV_FD + 1, &len, 4) != 4) {
- __afl_map_shm_fuzz();
+ write(2, "Error: could not send dictionary len\n",
+ strlen("Error: could not send dictionary len\n"));
+ _exit(1);
}
- if ((was_killed & (FS_OPT_ENABLED | FS_OPT_AUTODICT)) ==
- (FS_OPT_ENABLED | FS_OPT_AUTODICT) &&
- __afl_dictionary_len && __afl_dictionary) {
+ while (len != 0) {
- // great lets pass the dictionary through the forkserver FD
- u32 len = __afl_dictionary_len, offset = 0;
+ s32 ret;
+ ret = write(FORKSRV_FD + 1, __afl_dictionary + offset, len);
- if (write(FORKSRV_FD + 1, &len, 4) != 4) {
+ if (ret < 1) {
- write(2, "Error: could not send dictionary len\n",
- strlen("Error: could not send dictionary len\n"));
+ write_error("could not send dictionary");
_exit(1);
}
- while (len != 0) {
-
- s32 ret;
- ret = write(FORKSRV_FD + 1, __afl_dictionary + offset, len);
-
- if (ret < 1) {
-
- write(2, "Error: could not send dictionary\n",
- strlen("Error: could not send dictionary\n"));
- _exit(1);
-
- }
+ len -= ret;
+ offset += ret;
- len -= ret;
- offset += ret;
+ }
- }
+ }
- } else {
+ // send welcome message as final message
+ status = version;
+ if (write(FORKSRV_FD + 1, msg, 4) != 4) { _exit(1); }
- // uh this forkserver does not understand extended option passing
- // or does not want the dictionary
- if (!__afl_fuzz_ptr) already_read_first = 1;
+ // END forkserver handshake
- }
+ __afl_connected = 1;
- }
+ if (__afl_sharedmem_fuzzing) { __afl_map_shm_fuzz(); }
while (1) {
@@ -1225,7 +956,7 @@ static void __afl_start_forkserver(void) {
if (read(FORKSRV_FD, &was_killed, 4) != 4) {
- // write_error("read from afl-fuzz");
+ write_error("read from AFL++ tool");
_exit(1);
}
@@ -1354,6 +1085,10 @@ int __afl_persistent_loop(unsigned int max_cnt) {
static u8 first_pass = 1;
static u32 cycle_cnt;
+#ifdef AFL_PERSISTENT_RECORD
+ char tcase[PATH_MAX];
+#endif
+
if (first_pass) {
/* Make sure that every iteration of __AFL_LOOP() starts with a clean slate.
@@ -1365,14 +1100,59 @@ int __afl_persistent_loop(unsigned int max_cnt) {
__afl_area_ptr[0] = 1;
memset(__afl_prev_loc, 0, NGRAM_SIZE_MAX * sizeof(PREV_LOC_T));
- cycle_cnt = max_cnt;
first_pass = 0;
__afl_selective_coverage_temp = 1;
+#ifdef AFL_PERSISTENT_RECORD
+ if (unlikely(is_replay_record)) {
+
+ cycle_cnt = replay_record_cnt;
+ goto persistent_record;
+
+ } else
+
+#endif
+ {
+
+ cycle_cnt = max_cnt;
+
+ }
+
return 1;
} else if (--cycle_cnt) {
+#ifdef AFL_PERSISTENT_RECORD
+ if (unlikely(is_replay_record)) {
+
+ persistent_record:
+
+ snprintf(tcase, PATH_MAX, "%s/%s",
+ replay_record_dir ? replay_record_dir : "./",
+ record_list[replay_record_cnt - cycle_cnt]->d_name);
+
+ #ifdef AFL_PERSISTENT_REPLAY_ARGPARSE
+ if (unlikely(record_arg)) {
+
+ *record_arg = tcase;
+
+ } else
+
+ #endif // AFL_PERSISTENT_REPLAY_ARGPARSE
+ {
+
+ int fd = open(tcase, O_RDONLY);
+ dup2(fd, 0);
+ close(fd);
+
+ }
+
+ return 1;
+
+ }
+
+#endif
+
raise(SIGSTOP);
__afl_area_ptr[0] = 1;
@@ -1837,7 +1617,7 @@ void __sanitizer_cov_pcs_init(const uintptr_t *pcs_beg,
}
- if (pc_filter) {
+ if (pc_filter && !mod_info->next) {
char PcDescr[1024];
// This function is a part of the sanitizer run-time.
@@ -1864,7 +1644,8 @@ void __sanitizer_cov_pcs_init(const uintptr_t *pcs_beg,
}
- if (__afl_filter_pcs && strstr(mod_info->name, __afl_filter_pcs_module)) {
+ if (__afl_filter_pcs && !mod_info->next &&
+ strstr(mod_info->name, __afl_filter_pcs_module)) {
u32 result_index;
if (locate_in_pcs(PC, &result_index)) {
@@ -1889,7 +1670,7 @@ void __sanitizer_cov_pcs_init(const uintptr_t *pcs_beg,
}
- mod_info->mapped = 1;
+ if (__afl_pcmap_ptr) { mod_info->mapped = 1; }
if (__afl_debug) {
@@ -2181,7 +1962,8 @@ void __cmplog_ins_hook1(uint8_t arg1, uint8_t arg2, uint8_t attr) {
void __cmplog_ins_hook2(uint16_t arg1, uint16_t arg2, uint8_t attr) {
- if (unlikely(!__afl_cmp_map || arg1 == arg2)) return;
+ if (likely(!__afl_cmp_map)) return;
+ if (unlikely(arg1 == arg2)) return;
uintptr_t k = (uintptr_t)__builtin_return_address(0);
k = (uintptr_t)(default_hash((u8 *)&k, sizeof(uintptr_t)) & (CMP_MAP_W - 1));
@@ -2219,7 +2001,8 @@ void __cmplog_ins_hook4(uint32_t arg1, uint32_t arg2, uint8_t attr) {
// fprintf(stderr, "hook4 arg0=%x arg1=%x attr=%u\n", arg1, arg2, attr);
- if (unlikely(!__afl_cmp_map || arg1 == arg2)) return;
+ if (likely(!__afl_cmp_map)) return;
+ if (unlikely(arg1 == arg2)) return;
uintptr_t k = (uintptr_t)__builtin_return_address(0);
k = (uintptr_t)(default_hash((u8 *)&k, sizeof(uintptr_t)) & (CMP_MAP_W - 1));
@@ -2257,7 +2040,8 @@ void __cmplog_ins_hook8(uint64_t arg1, uint64_t arg2, uint8_t attr) {
// fprintf(stderr, "hook8 arg0=%lx arg1=%lx attr=%u\n", arg1, arg2, attr);
- if (unlikely(!__afl_cmp_map || arg1 == arg2)) return;
+ if (likely(!__afl_cmp_map)) return;
+ if (unlikely(arg1 == arg2)) return;
uintptr_t k = (uintptr_t)__builtin_return_address(0);
k = (uintptr_t)(default_hash((u8 *)&k, sizeof(uintptr_t)) & (CMP_MAP_W - 1));
@@ -2300,7 +2084,8 @@ void __cmplog_ins_hookN(uint128_t arg1, uint128_t arg2, uint8_t attr,
// (u64)(arg1 >> 64), (u64)arg1, (u64)(arg2 >> 64), (u64)arg2, size + 1,
// attr);
- if (unlikely(!__afl_cmp_map || arg1 == arg2)) return;
+ if (likely(!__afl_cmp_map)) return;
+ if (unlikely(arg1 == arg2 || size > __afl_cmplog_max_len)) return;
uintptr_t k = (uintptr_t)__builtin_return_address(0);
k = (uintptr_t)(default_hash((u8 *)&k, sizeof(uintptr_t)) & (CMP_MAP_W - 1));
@@ -2344,6 +2129,7 @@ void __cmplog_ins_hookN(uint128_t arg1, uint128_t arg2, uint8_t attr,
void __cmplog_ins_hook16(uint128_t arg1, uint128_t arg2, uint8_t attr) {
if (likely(!__afl_cmp_map)) return;
+ if (16 > __afl_cmplog_max_len) return;
uintptr_t k = (uintptr_t)__builtin_return_address(0);
k = (uintptr_t)(default_hash((u8 *)&k, sizeof(uintptr_t)) & (CMP_MAP_W - 1));
@@ -2537,13 +2323,25 @@ void __cmplog_rtn_hook_strn(u8 *ptr1, u8 *ptr2, u64 len) {
// fprintf(stderr, "RTN1 %p %p %u\n", ptr1, ptr2, len);
if (likely(!__afl_cmp_map)) return;
- if (unlikely(!len)) return;
- int len0 = MIN(len, 31);
+ if (unlikely(!len || len > __afl_cmplog_max_len)) return;
+
+ int len0 = MIN(len, 32);
+
int len1 = strnlen(ptr1, len0);
- if (len1 < 31) len1 = area_is_valid(ptr1, len1 + 1);
+ if (len1 <= 32) len1 = area_is_valid(ptr1, len1 + 1);
+ if (len1 > __afl_cmplog_max_len) len1 = 0;
+
int len2 = strnlen(ptr2, len0);
- if (len2 < 31) len2 = area_is_valid(ptr2, len2 + 1);
- int l = MAX(len1, len2);
+ if (len2 <= 32) len2 = area_is_valid(ptr2, len2 + 1);
+ if (len2 > __afl_cmplog_max_len) len2 = 0;
+
+ int l;
+ if (!len1)
+ l = len2;
+ else if (!len2)
+ l = len1;
+ else
+ l = MAX(len1, len2);
if (l < 2) return;
uintptr_t k = (uintptr_t)__builtin_return_address(0);
@@ -2587,10 +2385,18 @@ void __cmplog_rtn_hook_str(u8 *ptr1, u8 *ptr2) {
// fprintf(stderr, "RTN1 %p %p\n", ptr1, ptr2);
if (likely(!__afl_cmp_map)) return;
if (unlikely(!ptr1 || !ptr2)) return;
- int len1 = strnlen(ptr1, 30) + 1;
- int len2 = strnlen(ptr2, 30) + 1;
- int l = MAX(len1, len2);
- if (l < 3) return;
+ int len1 = strnlen(ptr1, 31) + 1;
+ int len2 = strnlen(ptr2, 31) + 1;
+ if (len1 > __afl_cmplog_max_len) len1 = 0;
+ if (len2 > __afl_cmplog_max_len) len2 = 0;
+ int l;
+ if (!len1)
+ l = len2;
+ else if (!len2)
+ l = len1;
+ else
+ l = MAX(len1, len2);
+ if (l < 2) return;
uintptr_t k = (uintptr_t)__builtin_return_address(0);
k = (uintptr_t)(default_hash((u8 *)&k, sizeof(uintptr_t)) & (CMP_MAP_W - 1));
@@ -2632,7 +2438,7 @@ void __cmplog_rtn_hook(u8 *ptr1, u8 *ptr2) {
/*
u32 i;
- if (area_is_valid(ptr1, 31) <= 0 || area_is_valid(ptr2, 31) <= 0) return;
+ if (area_is_valid(ptr1, 32) <= 0 || area_is_valid(ptr2, 32) <= 0) return;
fprintf(stderr, "rtn arg0=");
for (i = 0; i < 32; i++)
fprintf(stderr, "%02x", ptr1[i]);
@@ -2645,10 +2451,10 @@ void __cmplog_rtn_hook(u8 *ptr1, u8 *ptr2) {
// fprintf(stderr, "RTN1 %p %p\n", ptr1, ptr2);
if (likely(!__afl_cmp_map)) return;
int l1, l2;
- if ((l1 = area_is_valid(ptr1, 31)) <= 0 ||
- (l2 = area_is_valid(ptr2, 31)) <= 0)
+ if ((l1 = area_is_valid(ptr1, 32)) <= 0 ||
+ (l2 = area_is_valid(ptr2, 32)) <= 0)
return;
- int len = MIN(31, MIN(l1, l2));
+ int len = MIN(__afl_cmplog_max_len, MIN(l1, l2));
// fprintf(stderr, "RTN2 %u\n", len);
uintptr_t k = (uintptr_t)__builtin_return_address(0);
@@ -2697,7 +2503,7 @@ void __cmplog_rtn_hook_n(u8 *ptr1, u8 *ptr2, u64 len) {
#if 0
/*
u32 i;
- if (area_is_valid(ptr1, 31) <= 0 || area_is_valid(ptr2, 31) <= 0) return;
+ if (area_is_valid(ptr1, 32) <= 0 || area_is_valid(ptr2, 32) <= 0) return;
fprintf(stderr, "rtn_n len=%u arg0=", len);
for (i = 0; i < len; i++)
fprintf(stderr, "%02x", ptr1[i]);
@@ -2709,12 +2515,15 @@ void __cmplog_rtn_hook_n(u8 *ptr1, u8 *ptr2, u64 len) {
// fprintf(stderr, "RTN1 %p %p %u\n", ptr1, ptr2, len);
if (likely(!__afl_cmp_map)) return;
- if (unlikely(!len)) return;
- int l = MIN(31, len);
+ if (!len) return;
+ int l = MIN(32, len), l1, l2;
- if ((l = area_is_valid(ptr1, l)) <= 0 || (l = area_is_valid(ptr2, l)) <= 0)
+ if ((l1 = area_is_valid(ptr1, l)) <= 0 || (l2 = area_is_valid(ptr2, l)) <= 0)
return;
+ len = MIN(l1, l2);
+ if (len > __afl_cmplog_max_len) return;
+
// fprintf(stderr, "RTN2 %u\n", l);
uintptr_t k = (uintptr_t)__builtin_return_address(0);
k = (uintptr_t)(default_hash((u8 *)&k, sizeof(uintptr_t)) & (CMP_MAP_W - 1));
diff --git a/instrumentation/afl-gcc-cmptrs-pass.so.cc b/instrumentation/afl-gcc-cmptrs-pass.so.cc
index 929a9d7a..96bd5ba8 100644
--- a/instrumentation/afl-gcc-cmptrs-pass.so.cc
+++ b/instrumentation/afl-gcc-cmptrs-pass.so.cc
@@ -180,19 +180,19 @@ struct afl_cmptrs_pass : afl_base_pass {
c = DECL_CONTEXT(c);
if (c && TREE_CODE(c) != TRANSLATION_UNIT_DECL) return false;
- /* Check that the first nonstatic data member of the record type
+ /* Check that the first nonstatic named data member of the record type
is named _M_dataplus. */
for (c = TYPE_FIELDS(t); c; c = DECL_CHAIN(c))
- if (TREE_CODE(c) == FIELD_DECL) break;
+ if (TREE_CODE(c) == FIELD_DECL && DECL_NAME(c)) break;
if (!c || !integer_zerop(DECL_FIELD_BIT_OFFSET(c)) ||
strcmp(IDENTIFIER_POINTER(DECL_NAME(c)), "_M_dataplus") != 0)
return false;
- /* Check that the second nonstatic data member of the record type
+ /* Check that the second nonstatic named data member of the record type
is named _M_string_length. */
tree f2;
for (f2 = DECL_CHAIN(c); f2; f2 = DECL_CHAIN(f2))
- if (TREE_CODE(f2) == FIELD_DECL) break;
+ if (TREE_CODE(f2) == FIELD_DECL && DECL_NAME(f2)) break;
if (!f2 /* No need to check this field's offset. */
|| strcmp(IDENTIFIER_POINTER(DECL_NAME(f2)), "_M_string_length") != 0)
return false;
@@ -208,9 +208,12 @@ struct afl_cmptrs_pass : afl_base_pass {
strcmp(IDENTIFIER_POINTER(TYPE_IDENTIFIER(c)), "_Alloc_hider") != 0)
return false;
- /* And its first data member is named _M_p. */
+ /* And its first nonstatic named data member should be named _M_p.
+ There may be (unnamed) subobjects from empty base classes. We
+ skip the subobjects, then check the offset of the first data
+ member. */
for (c = TYPE_FIELDS(c); c; c = DECL_CHAIN(c))
- if (TREE_CODE(c) == FIELD_DECL) break;
+ if (TREE_CODE(c) == FIELD_DECL && DECL_NAME(c)) break;
if (!c || !integer_zerop(DECL_FIELD_BIT_OFFSET(c)) ||
strcmp(IDENTIFIER_POINTER(DECL_NAME(c)), "_M_p") != 0)
return false;
diff --git a/instrumentation/afl-llvm-dict2file.so.cc b/instrumentation/afl-llvm-dict2file.so.cc
index ac497b5b..b93f61f0 100644
--- a/instrumentation/afl-llvm-dict2file.so.cc
+++ b/instrumentation/afl-llvm-dict2file.so.cc
@@ -746,7 +746,7 @@ bool AFLdict2filePass::runOnModule(Module &M) {
auto PA = PreservedAnalyses::all();
return PA;
#else
- return true;
+ return false;
#endif
}
diff --git a/instrumentation/afl-llvm-pass.so.cc b/instrumentation/afl-llvm-pass.so.cc
index 62f5023d..75b8532b 100644
--- a/instrumentation/afl-llvm-pass.so.cc
+++ b/instrumentation/afl-llvm-pass.so.cc
@@ -128,7 +128,11 @@ llvmGetPassPluginInfo() {
#if LLVM_VERSION_MAJOR <= 13
using OptimizationLevel = typename PassBuilder::OptimizationLevel;
#endif
+ #if LLVM_VERSION_MAJOR >= 16
+ PB.registerOptimizerEarlyEPCallback(
+ #else
PB.registerOptimizerLastEPCallback(
+ #endif
[](ModulePassManager &MPM, OptimizationLevel OL) {
MPM.addPass(AFLCoverage());
@@ -212,10 +216,6 @@ bool AFLCoverage::runOnModule(Module &M) {
u32 rand_seed;
unsigned int cur_loc = 0;
-#if LLVM_VERSION_MAJOR >= 11 /* use new pass manager */
- auto PA = PreservedAnalyses::all();
-#endif
-
/* Setup random() so we get Actually Random(TM) outputs from AFL_R() */
gettimeofday(&tv, &tz);
rand_seed = tv.tv_sec ^ tv.tv_usec ^ getpid();
@@ -1081,7 +1081,7 @@ bool AFLCoverage::runOnModule(Module &M) {
}
#if LLVM_VERSION_MAJOR >= 11 /* use new pass manager */
- return PA;
+ return PreservedAnalyses();
#else
return true;
#endif
diff --git a/instrumentation/cmplog-instructions-pass.cc b/instrumentation/cmplog-instructions-pass.cc
index dc60221e..fe5c2926 100644
--- a/instrumentation/cmplog-instructions-pass.cc
+++ b/instrumentation/cmplog-instructions-pass.cc
@@ -680,13 +680,16 @@ bool CmpLogInstructions::runOnModule(Module &M) {
printf("Running cmplog-instructions-pass by andreafioraldi@gmail.com\n");
else
be_quiet = 1;
- hookInstrs(M);
+ bool ret = hookInstrs(M);
verifyModule(M);
#if LLVM_MAJOR >= 11 /* use new pass manager */
- return PreservedAnalyses::all();
+ if (ret == false)
+ return PreservedAnalyses::all();
+ else
+ return PreservedAnalyses();
#else
- return true;
+ return ret;
#endif
}
diff --git a/instrumentation/cmplog-routines-pass.cc b/instrumentation/cmplog-routines-pass.cc
index 78317d5d..560bd73b 100644
--- a/instrumentation/cmplog-routines-pass.cc
+++ b/instrumentation/cmplog-routines-pass.cc
@@ -758,16 +758,16 @@ bool CmpLogRoutines::runOnModule(Module &M) {
printf("Running cmplog-routines-pass by andreafioraldi@gmail.com\n");
else
be_quiet = 1;
- hookRtns(M);
-#if LLVM_VERSION_MAJOR >= 11 /* use new pass manager */
- auto PA = PreservedAnalyses::all();
-#endif
+ bool ret = hookRtns(M);
verifyModule(M);
#if LLVM_VERSION_MAJOR >= 11 /* use new pass manager */
- return PA;
+ if (ret == false)
+ return PreservedAnalyses::all();
+ else
+ return PreservedAnalyses();
#else
- return true;
+ return ret;
#endif
}
diff --git a/instrumentation/cmplog-switches-pass.cc b/instrumentation/cmplog-switches-pass.cc
index 3e05c13d..2b87ea8c 100644
--- a/instrumentation/cmplog-switches-pass.cc
+++ b/instrumentation/cmplog-switches-pass.cc
@@ -442,16 +442,16 @@ bool CmplogSwitches::runOnModule(Module &M) {
printf("Running cmplog-switches-pass by andreafioraldi@gmail.com\n");
else
be_quiet = 1;
- hookInstrs(M);
-#if LLVM_VERSION_MAJOR >= 11 /* use new pass manager */
- auto PA = PreservedAnalyses::all();
-#endif
+ bool ret = hookInstrs(M);
verifyModule(M);
#if LLVM_VERSION_MAJOR >= 11 /* use new pass manager */
- return PA;
+ if (ret == false)
+ return PreservedAnalyses::all();
+ else
+ return PreservedAnalyses();
#else
- return true;
+ return ret;
#endif
}
diff --git a/instrumentation/compare-transform-pass.so.cc b/instrumentation/compare-transform-pass.so.cc
index b0d6355a..f8ba9de5 100644
--- a/instrumentation/compare-transform-pass.so.cc
+++ b/instrumentation/compare-transform-pass.so.cc
@@ -89,7 +89,7 @@ class CompareTransform : public ModulePass {
#endif
- return "cmplog transform";
+ return "compcov transform";
}
@@ -123,7 +123,11 @@ llvmGetPassPluginInfo() {
#if LLVM_VERSION_MAJOR <= 13
using OptimizationLevel = typename PassBuilder::OptimizationLevel;
#endif
+ #if LLVM_VERSION_MAJOR >= 16
+ PB.registerOptimizerEarlyEPCallback(
+ #else
PB.registerOptimizerLastEPCallback(
+ #endif
[](ModulePassManager &MPM, OptimizationLevel OL) {
MPM.addPass(CompareTransform());
@@ -746,6 +750,8 @@ bool CompareTransform::runOnModule(Module &M) {
#endif
+ bool ret = false;
+
if ((isatty(2) && getenv("AFL_QUIET") == NULL) || getenv("AFL_DEBUG") != NULL)
printf(
"Running compare-transform-pass by laf.intel@gmail.com, extended by "
@@ -753,11 +759,7 @@ bool CompareTransform::runOnModule(Module &M) {
else
be_quiet = 1;
-#if LLVM_MAJOR >= 11 /* use new pass manager */
- auto PA = PreservedAnalyses::all();
-#endif
-
- transformCmps(M, true, true, true, true, true);
+ if (transformCmps(M, true, true, true, true, true) == true) ret = true;
verifyModule(M);
#if LLVM_MAJOR >= 11 /* use new pass manager */
@@ -767,9 +769,18 @@ bool CompareTransform::runOnModule(Module &M) {
}*/
- return PA;
+ if (ret == true) {
+
+ return PreservedAnalyses();
+
+ } else {
+
+ return PreservedAnalyses::all();
+
+ }
+
#else
- return true;
+ return ret;
#endif
}
diff --git a/instrumentation/injection-pass.cc b/instrumentation/injection-pass.cc
index 2280208b..47ddabd9 100644
--- a/instrumentation/injection-pass.cc
+++ b/instrumentation/injection-pass.cc
@@ -204,6 +204,8 @@ bool InjectionRoutines::hookRtns(Module &M) {
Function *FuncPtr;
#endif
+ bool ret = false;
+
/* iterate over all functions, bbs and instruction and add suitable calls */
for (auto &F : M) {
@@ -281,6 +283,7 @@ bool InjectionRoutines::hookRtns(Module &M) {
IRBuilder<> IRB(callInst->getParent());
IRB.SetInsertPoint(callInst);
+ ret = true;
Value *parameter = callInst->getArgOperand(param);
@@ -299,7 +302,7 @@ bool InjectionRoutines::hookRtns(Module &M) {
}
- return true;
+ return ret;
}
@@ -328,16 +331,16 @@ bool InjectionRoutines::runOnModule(Module &M) {
if (getenv("AFL_LLVM_INJECTIONS_LDAP")) { doLDAP = true; }
if (getenv("AFL_LLVM_INJECTIONS_XSS")) { doXSS = true; }
- hookRtns(M);
-#if LLVM_VERSION_MAJOR >= 11 /* use new pass manager */
- auto PA = PreservedAnalyses::all();
-#endif
+ bool ret = hookRtns(M);
verifyModule(M);
#if LLVM_VERSION_MAJOR >= 11 /* use new pass manager */
- return PA;
+ if (ret == false)
+ return PreservedAnalyses::all();
+ else
+ return PreservedAnalyses();
#else
- return true;
+ return ret;
#endif
}
diff --git a/instrumentation/split-compares-pass.so.cc b/instrumentation/split-compares-pass.so.cc
index 144025fb..421a7c39 100644
--- a/instrumentation/split-compares-pass.so.cc
+++ b/instrumentation/split-compares-pass.so.cc
@@ -189,7 +189,11 @@ llvmGetPassPluginInfo() {
#if LLVM_VERSION_MAJOR <= 13
using OptimizationLevel = typename PassBuilder::OptimizationLevel;
#endif
+ #if LLVM_VERSION_MAJOR >= 16
+ PB.registerOptimizerEarlyEPCallback(
+ #else
PB.registerOptimizerLastEPCallback(
+ #endif
[](ModulePassManager &MPM, OptimizationLevel OL) {
MPM.addPass(SplitComparesTransform());
@@ -935,7 +939,7 @@ size_t SplitComparesTransform::nextPowerOfTwo(size_t in) {
/* splits fcmps into two nested fcmps with sign compare and the rest */
size_t SplitComparesTransform::splitFPCompares(Module &M) {
- size_t count = 0;
+ size_t counts = 0;
LLVMContext &C = M.getContext();
@@ -951,7 +955,7 @@ size_t SplitComparesTransform::splitFPCompares(Module &M) {
} else {
- return count;
+ return counts;
}
@@ -1004,7 +1008,7 @@ size_t SplitComparesTransform::splitFPCompares(Module &M) {
}
- if (!fcomps.size()) { return count; }
+ if (!fcomps.size()) { return counts; }
IntegerType *Int1Ty = IntegerType::getInt1Ty(C);
@@ -1690,11 +1694,11 @@ size_t SplitComparesTransform::splitFPCompares(Module &M) {
#else
ReplaceInstWithInst(FcmpInst->getParent()->getInstList(), ii, PN);
#endif
- ++count;
+ ++counts;
}
- return count;
+ return counts;
}
@@ -1743,10 +1747,6 @@ bool SplitComparesTransform::runOnModule(Module &M) {
}
-#if LLVM_MAJOR >= 11
- auto PA = PreservedAnalyses::all();
-#endif
-
if (enableFPSplit) {
simplifyFPCompares(M);
@@ -1778,15 +1778,7 @@ bool SplitComparesTransform::runOnModule(Module &M) {
auto op0 = CI->getOperand(0);
auto op1 = CI->getOperand(1);
- if (!op0 || !op1) {
-
-#if LLVM_MAJOR >= 11
- return PA;
-#else
- return false;
-#endif
-
- }
+ if (!op0 || !op1) { continue; }
auto iTy1 = dyn_cast<IntegerType>(op0->getType());
if (iTy1 && isa<IntegerType>(op1->getType())) {
@@ -1814,6 +1806,8 @@ bool SplitComparesTransform::runOnModule(Module &M) {
}
+ bool ret = count == 0 ? false : true;
+
bool brokenDebug = false;
if (verifyModule(M, &errs()
#if LLVM_VERSION_MAJOR >= 4 || \
@@ -1852,9 +1846,12 @@ bool SplitComparesTransform::runOnModule(Module &M) {
}*/
- return PA;
+ if (ret == false)
+ return PreservedAnalyses::all();
+ else
+ return PreservedAnalyses();
#else
- return true;
+ return ret;
#endif
}
diff --git a/instrumentation/split-switches-pass.so.cc b/instrumentation/split-switches-pass.so.cc
index e3dfea0d..aa552a42 100644
--- a/instrumentation/split-switches-pass.so.cc
+++ b/instrumentation/split-switches-pass.so.cc
@@ -137,7 +137,11 @@ llvmGetPassPluginInfo() {
#if LLVM_VERSION_MAJOR <= 13
using OptimizationLevel = typename PassBuilder::OptimizationLevel;
#endif
+ #if LLVM_VERSION_MAJOR >= 16
+ PB.registerOptimizerEarlyEPCallback(
+ #else
PB.registerOptimizerLastEPCallback(
+ #endif
[](ModulePassManager &MPM, OptimizationLevel OL) {
MPM.addPass(SplitSwitchesTransform());
@@ -516,11 +520,7 @@ bool SplitSwitchesTransform::runOnModule(Module &M) {
else
be_quiet = 1;
-#if LLVM_VERSION_MAJOR >= 11 /* use new pass manager */
- auto PA = PreservedAnalyses::all();
-#endif
-
- splitSwitches(M);
+ bool ret = splitSwitches(M);
verifyModule(M);
#if LLVM_VERSION_MAJOR >= 11 /* use new pass manager */
@@ -530,9 +530,12 @@ bool SplitSwitchesTransform::runOnModule(Module &M) {
}*/
- return PA;
+ if (ret == false)
+ return PreservedAnalyses::all();
+ else
+ return PreservedAnalyses();
#else
- return true;
+ return ret;
#endif
}
diff --git a/qemu_mode/QEMUAFL_VERSION b/qemu_mode/QEMUAFL_VERSION
index b4e764b7..6f2a5979 100644
--- a/qemu_mode/QEMUAFL_VERSION
+++ b/qemu_mode/QEMUAFL_VERSION
@@ -1 +1 @@
-e63c9af193
+40033af00c
diff --git a/qemu_mode/build_qemu_support.sh b/qemu_mode/build_qemu_support.sh
index 45019cc8..ecc90ef5 100755
--- a/qemu_mode/build_qemu_support.sh
+++ b/qemu_mode/build_qemu_support.sh
@@ -215,8 +215,10 @@ if [ "$STATIC" = "1" ]; then
echo Building STATIC binary
# static PIE causes https://github.com/AFLplusplus/AFLplusplus/issues/892
+ # plugin support requires dynamic linking
QEMU_CONF_FLAGS="$QEMU_CONF_FLAGS \
--static --disable-pie \
+ --disable-plugins \
--extra-cflags=-DAFL_QEMU_STATIC_BUILD=1 \
"
diff --git a/qemu_mode/qemuafl b/qemu_mode/qemuafl
-Subproject e63c9af1937c13163cd1bc8bc276101441cbe70
+Subproject 40033af00c4c5de172ed4fe60c21b9edbd2c189
diff --git a/src/afl-cc.c b/src/afl-cc.c
index e9564277..45fd398b 100644
--- a/src/afl-cc.c
+++ b/src/afl-cc.c
@@ -828,7 +828,8 @@ static void instrument_mode_old_environ(aflcc_state_t *aflcc) {
}
if (getenv("AFL_LLVM_CTX")) aflcc->instrument_opt_mode |= INSTRUMENT_OPT_CTX;
- if (getenv("AFL_LLVM_CALLER"))
+ if (getenv("AFL_LLVM_CALLER") || getenv("AFL_LLVM_LTO_CALLER") ||
+ getenv("AFL_LLVM_LTO_CTX"))
aflcc->instrument_opt_mode |= INSTRUMENT_OPT_CALLER;
if (getenv("AFL_LLVM_NGRAM_SIZE")) {
@@ -1148,12 +1149,16 @@ static void instrument_opt_mode_exclude(aflcc_state_t *aflcc) {
}
- if (aflcc->instrument_opt_mode && aflcc->compiler_mode != LLVM)
+ if (aflcc->instrument_opt_mode && aflcc->compiler_mode != LLVM &&
+ !((aflcc->instrument_opt_mode & INSTRUMENT_OPT_CALLER) &&
+ aflcc->compiler_mode == LTO))
FATAL("CTX, CALLER and NGRAM can only be used in LLVM mode");
if (aflcc->instrument_opt_mode &&
aflcc->instrument_opt_mode != INSTRUMENT_OPT_CODECOV &&
- aflcc->instrument_mode != INSTRUMENT_CLASSIC)
+ aflcc->instrument_mode != INSTRUMENT_CLASSIC &&
+ !(aflcc->instrument_opt_mode & INSTRUMENT_OPT_CALLER &&
+ aflcc->compiler_mode == LTO))
FATAL(
"CALLER, CTX and NGRAM instrumentation options can only be used with "
"the LLVM CLASSIC instrumentation mode.");
@@ -1364,6 +1369,13 @@ void mode_final_checkout(aflcc_state_t *aflcc, int argc, char **argv) {
}
+ if (getenv("AFL_LLVM_DICT2FILE") &&
+ (getenv("AFL_LLVM_LAF_SPLIT_SWITCHES") ||
+ getenv("AFL_LLVM_LAF_SPLIT_COMPARES") ||
+ getenv("AFL_LLVM_LAF_SPLIT_FLOATS") ||
+ getenv("AFL_LLVM_LAF_TRANSFORM_COMPARES")))
+ FATAL("AFL_LLVM_DICT2FILE is incompatible with AFL_LLVM_LAF_*");
+
aflcc->cmplog_mode = getenv("AFL_CMPLOG") || getenv("AFL_LLVM_CMPLOG") ||
getenv("AFL_GCC_CMPLOG");
@@ -2375,7 +2387,11 @@ void add_runtime(aflcc_state_t *aflcc) {
if (aflcc->plusplus_mode && strlen(libdir) && strncmp(libdir, "/usr", 4) &&
strncmp(libdir, "/lib", 4)) {
+#ifdef __APPLE__
+ u8 *libdir_opt = strdup("-Wl,-rpath," LLVM_LIBDIR);
+#else
u8 *libdir_opt = strdup("-Wl,-rpath=" LLVM_LIBDIR);
+#endif
insert_param(aflcc, libdir_opt);
}
@@ -2917,11 +2933,12 @@ static void maybe_usage(aflcc_state_t *aflcc, int argc, char **argv) {
" AFL_LLVM_DOCUMENT_IDS: write all edge IDs and the corresponding "
"functions\n"
" into this file (LTO mode)\n"
+ " AFL_LLVM_LTO_CALLER: activate CALLER/CTX instrumentation\n"
+ " AFL_LLVM_LTO_CALLER_DEPTH: skip how many empty functions\n"
" AFL_LLVM_LTO_DONTWRITEID: don't write the highest ID used to a "
"global var\n"
" AFL_LLVM_LTO_STARTID: from which ID to start counting from for "
- "a "
- "bb\n"
+ "a bb\n"
" AFL_REAL_LD: use this lld linker instead of the compiled in "
"path\n"
" AFL_LLVM_LTO_SKIPINIT: don't inject initialization code "
diff --git a/src/afl-common.c b/src/afl-common.c
index 87003b03..6d915b00 100644
--- a/src/afl-common.c
+++ b/src/afl-common.c
@@ -34,6 +34,7 @@
#endif
#include <string.h>
#include <strings.h>
+#include <time.h>
#include <math.h>
#include <sys/mman.h>
@@ -58,6 +59,27 @@ u8 last_intr = 0;
#define AFL_PATH "/usr/local/lib/afl/"
#endif
+/* - Some BSD (i.e.: FreeBSD) offer the FAST clock source as
+ * equivalent to Linux COARSE clock source. Aliasing COARSE to
+ * FAST on such systems when COARSE is not already defined.
+ * - macOS has no support of CLOCK_MONOTONIC_COARSE clock type.
+ */
+#if defined(OS_DARWIN) || defined(OS_SUNOS) || defined(__APPLE__) || \
+ defined(__sun) || defined(__NetBSD__)
+ #define CLOCK_MONOTONIC_COARSE CLOCK_MONOTONIC
+#elif defined(OS_FREEBSD)
+ #define CLOCK_MONOTONIC_COARSE CLOCK_MONOTONIC_FAST
+#endif
+
+/* Convert seconds to milliseconds. */
+#define SEC_TO_MS(sec) ((sec) * 1000)
+/* Convert seconds to microseconds. */
+#define SEC_TO_US(sec) ((sec) * 1000000)
+/* Convert nanoseconds to milliseconds. */
+#define NS_TO_MS(ns) ((ns) / 1000000)
+/* Convert nanoseconds to microseconds. */
+#define NS_TO_US(ns) ((ns) / 1000)
+
void *afl_memmem(const void *haystack, size_t haystacklen, const void *needle,
size_t needlelen) {
@@ -974,12 +996,16 @@ void read_bitmap(u8 *fname, u8 *map, size_t len) {
inline u64 get_cur_time(void) {
- struct timeval tv;
- struct timezone tz;
+ struct timespec ts;
+ int rc = clock_gettime(CLOCK_MONOTONIC_COARSE, &ts);
+ if (rc == -1) {
- gettimeofday(&tv, &tz);
+ PFATAL("Failed to obtain timestamp (errno = %i: %s)\n", errno,
+ strerror(errno));
- return (tv.tv_sec * 1000ULL) + (tv.tv_usec / 1000);
+ }
+
+ return SEC_TO_MS((uint64_t)ts.tv_sec) + NS_TO_MS((uint64_t)ts.tv_nsec);
}
@@ -987,12 +1013,16 @@ inline u64 get_cur_time(void) {
u64 get_cur_time_us(void) {
- struct timeval tv;
- struct timezone tz;
+ struct timespec ts;
+ int rc = clock_gettime(CLOCK_MONOTONIC_COARSE, &ts);
+ if (rc == -1) {
- gettimeofday(&tv, &tz);
+ PFATAL("Failed to obtain timestamp (errno = %i: %s)\n", errno,
+ strerror(errno));
+
+ }
- return (tv.tv_sec * 1000000ULL) + tv.tv_usec;
+ return SEC_TO_US((uint64_t)ts.tv_sec) + NS_TO_US((uint64_t)ts.tv_nsec);
}
diff --git a/src/afl-forkserver.c b/src/afl-forkserver.c
index 0a77d61c..f28a2a64 100644
--- a/src/afl-forkserver.c
+++ b/src/afl-forkserver.c
@@ -389,7 +389,7 @@ static void afl_fauxsrv_execv(afl_forkserver_t *fsrv, char **argv) {
while (1) {
uint32_t was_killed;
- int status;
+ u32 status;
/* Wait for parent by reading from the pipe. Exit if read fails. */
@@ -524,7 +524,7 @@ void afl_fsrv_start(afl_forkserver_t *fsrv, char **argv,
volatile u8 *stop_soon_p, u8 debug_child_output) {
int st_pipe[2], ctl_pipe[2];
- s32 status;
+ u32 status;
s32 rlen;
char *ignore_autodict = getenv("AFL_NO_AUTODICT");
@@ -724,7 +724,7 @@ void afl_fsrv_start(afl_forkserver_t *fsrv, char **argv,
}
/* autodict in Nyx mode */
- if (!ignore_autodict) {
+ if (!ignore_autodict && fsrv->add_extra_func) {
char *x =
alloc_printf("%s/workdir/dump/afl_autodict.txt", fsrv->out_dir_path);
@@ -1017,69 +1017,106 @@ void afl_fsrv_start(afl_forkserver_t *fsrv, char **argv,
if (rlen == 4) {
- if (status >= 0x41464c00 && status <= 0x41464cff) {
+ /*
+ * The new fork server model works like this:
+ * Client: sends "AFLx" in little endian, with x being the forkserver
+ * protocol version.
+ * Server: replies with XOR of the message or exits with an error if it
+ * is not a supported version.
+ * Client: sends 32 bit of options and then sends all parameters of
+ * the options, one after another, increasing by option number.
+ * Ends with "AFLx".
+ * After the initial protocol version confirmation the server does not
+ * send any data anymore - except a future option requires this.
+ */
- FATAL(
- "Target uses the new forkserver model, you need to switch to a newer "
- "afl-fuzz too!");
+ if ((status & FS_NEW_ERROR) == FS_NEW_ERROR) {
- }
+ report_error_and_exit(status & 0x0000ffff);
- if (!be_quiet) { OKF("All right - fork server is up."); }
+ }
- if (getenv("AFL_DEBUG")) {
+ if (status >= 0x41464c00 && status <= 0x41464cff) {
- ACTF("Extended forkserver functions received (%08x).", status);
+ u32 version = status - 0x41464c00;
- }
+ if (!version) {
- if ((status & FS_OPT_ERROR) == FS_OPT_ERROR)
- report_error_and_exit(FS_OPT_GET_ERROR(status));
+ FATAL(
+ "Fork server version is not assigned, this should not happen. "
+ "Recompile target.");
- if ((status & FS_OPT_ENABLED) == FS_OPT_ENABLED) {
+ } else if (version < FS_NEW_VERSION_MIN || version > FS_NEW_VERSION_MAX) {
- // workaround for recent AFL++ versions
- if ((status & FS_OPT_OLD_AFLPP_WORKAROUND) == FS_OPT_OLD_AFLPP_WORKAROUND)
- status = (status & 0xf0ffffff);
+ FATAL(
+ "Fork server version is not not supported. Recompile the target.");
- if ((status & FS_OPT_NEWCMPLOG) == 0 && fsrv->cmplog_binary) {
+ }
- if (fsrv->qemu_mode || fsrv->frida_mode) {
+ u32 keep = status;
+ status ^= 0xffffffff;
+ if (write(fsrv->fsrv_ctl_fd, &status, 4) != 4) {
- report_error_and_exit(FS_ERROR_OLD_CMPLOG_QEMU);
+ FATAL("Writing to forkserver failed.");
- } else {
+ }
- report_error_and_exit(FS_ERROR_OLD_CMPLOG);
+ if (!be_quiet) {
- }
+ OKF("All right - new fork server model v%u is up.", version);
}
- if ((status & FS_OPT_SNAPSHOT) == FS_OPT_SNAPSHOT) {
+ rlen = read(fsrv->fsrv_st_fd, &status, 4);
- fsrv->snapshot = 1;
- if (!be_quiet) { ACTF("Using SNAPSHOT feature."); }
+ if (getenv("AFL_DEBUG")) {
+
+ ACTF("Forkserver options received: (0x%08x)", status);
}
- if ((status & FS_OPT_SHDMEM_FUZZ) == FS_OPT_SHDMEM_FUZZ) {
+ if ((status & FS_NEW_OPT_MAPSIZE)) {
- if (fsrv->support_shmem_fuzz) {
+ u32 tmp_map_size;
+ rlen = read(fsrv->fsrv_st_fd, &tmp_map_size, 4);
- fsrv->use_shmem_fuzz = 1;
- if (!be_quiet) { ACTF("Using SHARED MEMORY FUZZING feature."); }
+ if (!fsrv->map_size) { fsrv->map_size = MAP_SIZE; }
- if ((status & FS_OPT_AUTODICT) == 0 || ignore_autodict) {
+ fsrv->real_map_size = tmp_map_size;
- u32 send_status = (FS_OPT_ENABLED | FS_OPT_SHDMEM_FUZZ);
- if (write(fsrv->fsrv_ctl_fd, &send_status, 4) != 4) {
+ if (tmp_map_size % 64) {
- FATAL("Writing to forkserver failed.");
+ tmp_map_size = (((tmp_map_size + 63) >> 6) << 6);
- }
+ }
- }
+ if (!be_quiet) { ACTF("Target map size: %u", fsrv->real_map_size); }
+ if (tmp_map_size > fsrv->map_size) {
+
+ FATAL(
+ "Target's coverage map size of %u is larger than the one this "
+ "AFL++ is set with (%u). Either set AFL_MAP_SIZE=%u and "
+ "restart "
+ " afl-fuzz, or change MAP_SIZE_POW2 in config.h and recompile "
+ "afl-fuzz",
+ tmp_map_size, fsrv->map_size, tmp_map_size);
+
+ }
+
+ fsrv->map_size = tmp_map_size;
+
+ } else {
+
+ fsrv->real_map_size = fsrv->map_size = MAP_SIZE;
+
+ }
+
+ if (status & FS_NEW_OPT_SHDMEM_FUZZ) {
+
+ if (fsrv->support_shmem_fuzz) {
+
+ fsrv->use_shmem_fuzz = 1;
+ if (!be_quiet) { ACTF("Using SHARED MEMORY FUZZING feature."); }
} else {
@@ -1091,134 +1128,303 @@ void afl_fsrv_start(afl_forkserver_t *fsrv, char **argv,
}
- if ((status & FS_OPT_MAPSIZE) == FS_OPT_MAPSIZE) {
+ if (status & FS_NEW_OPT_AUTODICT) {
- u32 tmp_map_size = FS_OPT_GET_MAPSIZE(status);
+ // even if we do not need the dictionary we have to read it
- if (!fsrv->map_size) { fsrv->map_size = MAP_SIZE; }
+ u32 dict_size;
+ if (read(fsrv->fsrv_st_fd, &dict_size, 4) != 4) {
- fsrv->real_map_size = tmp_map_size;
+ FATAL("Reading from forkserver failed.");
- if (tmp_map_size % 64) {
+ }
- tmp_map_size = (((tmp_map_size + 63) >> 6) << 6);
+ if (dict_size < 2 || dict_size > 0xffffff) {
+
+ FATAL("Dictionary has an illegal size: %d", dict_size);
}
- if (!be_quiet) { ACTF("Target map size: %u", fsrv->real_map_size); }
- if (tmp_map_size > fsrv->map_size) {
+ u32 offset = 0, count = 0;
+ u8 *dict = ck_alloc(dict_size);
+ if (dict == NULL) {
- FATAL(
- "Target's coverage map size of %u is larger than the one this "
- "AFL++ is set with (%u). Either set AFL_MAP_SIZE=%u and restart "
- " afl-fuzz, or change MAP_SIZE_POW2 in config.h and recompile "
- "afl-fuzz",
- tmp_map_size, fsrv->map_size, tmp_map_size);
+ FATAL("Could not allocate %u bytes of autodictionary memory",
+ dict_size);
}
- fsrv->map_size = tmp_map_size;
+ while (offset < dict_size) {
+
+ rlen = read(fsrv->fsrv_st_fd, dict + offset, dict_size - offset);
+ if (rlen > 0) {
+
+ offset += rlen;
+
+ } else {
+
+ FATAL(
+ "Reading autodictionary fail at position %u with %u bytes "
+ "left.",
+ offset, dict_size - offset);
+
+ }
+
+ }
+
+ offset = 0;
+ while (offset < dict_size && (u8)dict[offset] + offset < dict_size) {
+
+ if (!ignore_autodict && fsrv->add_extra_func) {
+
+ fsrv->add_extra_func(fsrv->afl_ptr, dict + offset + 1,
+ (u8)dict[offset]);
+ count++;
+
+ }
+
+ offset += (1 + dict[offset]);
+
+ }
+
+ if (!be_quiet && count) {
+
+ ACTF("Loaded %u autodictionary entries", count);
+
+ }
+
+ ck_free(dict);
}
- if ((status & FS_OPT_AUTODICT) == FS_OPT_AUTODICT) {
+ u32 status2;
+ rlen = read(fsrv->fsrv_st_fd, &status2, 4);
- if (!ignore_autodict) {
+ if (status2 != keep) {
- if (fsrv->add_extra_func == NULL || fsrv->afl_ptr == NULL) {
+ FATAL("Error in forkserver communication (%08x=>%08x)", keep, status2);
- // this is not afl-fuzz - or it is cmplog - we deny and return
- if (fsrv->use_shmem_fuzz) {
+ }
- status = (FS_OPT_ENABLED | FS_OPT_SHDMEM_FUZZ);
+ } else {
- } else {
+ if (!fsrv->qemu_mode && !fsrv->cs_mode
+#ifdef __linux__
+ && !fsrv->nyx_mode
+#endif
+ ) {
- status = (FS_OPT_ENABLED);
+ WARNF(
+ "Old fork server model is used by the target, this still works "
+ "though.");
- }
+ }
- if (write(fsrv->fsrv_ctl_fd, &status, 4) != 4) {
+ if (!be_quiet) { OKF("All right - old fork server is up."); }
- FATAL("Writing to forkserver failed.");
+ if (getenv("AFL_DEBUG")) {
- }
+ ACTF("Extended forkserver functions received (%08x).", status);
+
+ }
- return;
+ if ((status & FS_OPT_ERROR) == FS_OPT_ERROR)
+ report_error_and_exit(FS_OPT_GET_ERROR(status));
- }
+ if (fsrv->cmplog_binary && !fsrv->qemu_mode) {
+
+ FATAL("Target was compiled with outdated CMPLOG, recompile it!\n");
+
+ }
- if (!be_quiet) { ACTF("Using AUTODICT feature."); }
+ if ((status & FS_OPT_ENABLED) == FS_OPT_ENABLED) {
- if (fsrv->use_shmem_fuzz) {
+ // workaround for recent AFL++ versions
+ if ((status & FS_OPT_OLD_AFLPP_WORKAROUND) ==
+ FS_OPT_OLD_AFLPP_WORKAROUND)
+ status = (status & 0xf0ffffff);
- status = (FS_OPT_ENABLED | FS_OPT_AUTODICT | FS_OPT_SHDMEM_FUZZ);
+ if ((status & FS_OPT_NEWCMPLOG) == 0 && fsrv->cmplog_binary) {
+
+ if (fsrv->qemu_mode || fsrv->frida_mode) {
+
+ report_error_and_exit(FS_ERROR_OLD_CMPLOG_QEMU);
} else {
- status = (FS_OPT_ENABLED | FS_OPT_AUTODICT);
+ report_error_and_exit(FS_ERROR_OLD_CMPLOG);
}
- if (write(fsrv->fsrv_ctl_fd, &status, 4) != 4) {
+ }
- FATAL("Writing to forkserver failed.");
+ if ((status & FS_OPT_SNAPSHOT) == FS_OPT_SNAPSHOT) {
- }
+ fsrv->snapshot = 1;
+ if (!be_quiet) { ACTF("Using SNAPSHOT feature."); }
+
+ }
+
+ if ((status & FS_OPT_SHDMEM_FUZZ) == FS_OPT_SHDMEM_FUZZ) {
- if (read(fsrv->fsrv_st_fd, &status, 4) != 4) {
+ if (fsrv->support_shmem_fuzz) {
- FATAL("Reading from forkserver failed.");
+ fsrv->use_shmem_fuzz = 1;
+ if (!be_quiet) { ACTF("Using SHARED MEMORY FUZZING feature."); }
+
+ if ((status & FS_OPT_AUTODICT) == 0 || ignore_autodict) {
+
+ u32 send_status = (FS_OPT_ENABLED | FS_OPT_SHDMEM_FUZZ);
+ if (write(fsrv->fsrv_ctl_fd, &send_status, 4) != 4) {
+
+ FATAL("Writing to forkserver failed.");
+
+ }
+
+ }
+
+ } else {
+
+ FATAL(
+ "Target requested sharedmem fuzzing, but we failed to enable "
+ "it.");
}
- if (status < 2 || (u32)status > 0xffffff) {
+ }
+
+ if ((status & FS_OPT_MAPSIZE) == FS_OPT_MAPSIZE) {
+
+ u32 tmp_map_size = FS_OPT_GET_MAPSIZE(status);
+
+ if (!fsrv->map_size) { fsrv->map_size = MAP_SIZE; }
+
+ fsrv->real_map_size = tmp_map_size;
+
+ if (tmp_map_size % 64) {
- FATAL("Dictionary has an illegal size: %d", status);
+ tmp_map_size = (((tmp_map_size + 63) >> 6) << 6);
}
- u32 offset = 0, count = 0;
- u32 len = status;
- u8 *dict = ck_alloc(len);
- if (dict == NULL) {
+ if (!be_quiet) { ACTF("Target map size: %u", fsrv->real_map_size); }
+ if (tmp_map_size > fsrv->map_size) {
- FATAL("Could not allocate %u bytes of autodictionary memory", len);
+ FATAL(
+ "Target's coverage map size of %u is larger than the one this "
+ "AFL++ is set with (%u). Either set AFL_MAP_SIZE=%u and "
+ "restart "
+ " afl-fuzz, or change MAP_SIZE_POW2 in config.h and recompile "
+ "afl-fuzz",
+ tmp_map_size, fsrv->map_size, tmp_map_size);
}
- while (len != 0) {
+ fsrv->map_size = tmp_map_size;
- rlen = read(fsrv->fsrv_st_fd, dict + offset, len);
- if (rlen > 0) {
+ }
- len -= rlen;
- offset += rlen;
+ if ((status & FS_OPT_AUTODICT) == FS_OPT_AUTODICT) {
+
+ if (!ignore_autodict) {
+
+ if (fsrv->add_extra_func == NULL || fsrv->afl_ptr == NULL) {
+
+ // this is not afl-fuzz - or it is cmplog - we deny and return
+ if (fsrv->use_shmem_fuzz) {
+
+ status = (FS_OPT_ENABLED | FS_OPT_SHDMEM_FUZZ);
+
+ } else {
+
+ status = (FS_OPT_ENABLED);
+
+ }
+
+ if (write(fsrv->fsrv_ctl_fd, &status, 4) != 4) {
+
+ FATAL("Writing to forkserver failed.");
+
+ }
+
+ return;
+
+ }
+
+ if (!be_quiet) { ACTF("Using AUTODICT feature."); }
+
+ if (fsrv->use_shmem_fuzz) {
+
+ status = (FS_OPT_ENABLED | FS_OPT_AUTODICT | FS_OPT_SHDMEM_FUZZ);
} else {
- FATAL(
- "Reading autodictionary fail at position %u with %u bytes "
- "left.",
- offset, len);
+ status = (FS_OPT_ENABLED | FS_OPT_AUTODICT);
}
- }
+ if (write(fsrv->fsrv_ctl_fd, &status, 4) != 4) {
- offset = 0;
- while (offset < (u32)status &&
- (u8)dict[offset] + offset < (u32)status) {
+ FATAL("Writing to forkserver failed.");
- fsrv->add_extra_func(fsrv->afl_ptr, dict + offset + 1,
- (u8)dict[offset]);
- offset += (1 + dict[offset]);
- count++;
+ }
- }
+ if (read(fsrv->fsrv_st_fd, &status, 4) != 4) {
- if (!be_quiet) { ACTF("Loaded %u autodictionary entries", count); }
- ck_free(dict);
+ FATAL("Reading from forkserver failed.");
+
+ }
+
+ if (status < 2 || (u32)status > 0xffffff) {
+
+ FATAL("Dictionary has an illegal size: %d", status);
+
+ }
+
+ u32 offset = 0, count = 0;
+ u32 len = status;
+ u8 *dict = ck_alloc(len);
+ if (dict == NULL) {
+
+ FATAL("Could not allocate %u bytes of autodictionary memory",
+ len);
+
+ }
+
+ while (len != 0) {
+
+ rlen = read(fsrv->fsrv_st_fd, dict + offset, len);
+ if (rlen > 0) {
+
+ len -= rlen;
+ offset += rlen;
+
+ } else {
+
+ FATAL(
+ "Reading autodictionary fail at position %u with %u bytes "
+ "left.",
+ offset, len);
+
+ }
+
+ }
+
+ offset = 0;
+ while (offset < (u32)status &&
+ (u8)dict[offset] + offset < (u32)status) {
+
+ fsrv->add_extra_func(fsrv->afl_ptr, dict + offset + 1,
+ (u8)dict[offset]);
+ offset += (1 + dict[offset]);
+ count++;
+
+ }
+
+ if (!be_quiet) { ACTF("Loaded %u autodictionary entries", count); }
+ ck_free(dict);
+
+ }
}
@@ -1599,6 +1805,11 @@ afl_fsrv_run_target(afl_forkserver_t *fsrv, u32 timeout,
u32 exec_ms;
u32 write_value = fsrv->last_run_timed_out;
+#ifdef AFL_PERSISTENT_RECORD
+ fsrv_run_result_t retval = FSRV_RUN_OK;
+ char *persistent_out_fmt;
+#endif
+
#ifdef __linux__
if (fsrv->nyx_mode) {
@@ -1628,6 +1839,8 @@ afl_fsrv_run_target(afl_forkserver_t *fsrv, u32 timeout,
case Timeout:
return FSRV_RUN_TMOUT;
case InvalidWriteToPayload:
+ if (!!getenv("AFL_NYX_HANDLE_INVALID_WRITE")) { return FSRV_RUN_CRASH; }
+
/* ??? */
FATAL("FixMe: Nyx InvalidWriteToPayload handler is missing");
break;
@@ -1661,7 +1874,7 @@ afl_fsrv_run_target(afl_forkserver_t *fsrv, u32 timeout,
territory. */
#ifdef __linux__
- if (!fsrv->nyx_mode) {
+ if (likely(!fsrv->nyx_mode)) {
memset(fsrv->trace_bits, 0, fsrv->map_size);
MEM_BARRIER();
@@ -1731,7 +1944,7 @@ afl_fsrv_run_target(afl_forkserver_t *fsrv, u32 timeout,
if (exec_ms > timeout) {
- /* If there was no response from forkserver after timeout seconds,
+ /* If there was no response from forkserver after timeout milliseconds,
we kill the child. The forkserver should inform us afterwards */
s32 tmp_pid = fsrv->child_pid;
@@ -1798,6 +2011,18 @@ afl_fsrv_run_target(afl_forkserver_t *fsrv, u32 timeout,
if (unlikely(fsrv->last_run_timed_out)) {
fsrv->last_kill_signal = fsrv->child_kill_signal;
+
+#ifdef AFL_PERSISTENT_RECORD
+ if (unlikely(fsrv->persistent_record)) {
+
+ retval = FSRV_RUN_TMOUT;
+ persistent_out_fmt = "%s/hangs/RECORD:%06u,cnt:%06u%s%s";
+ goto store_persistent_record;
+
+ }
+
+#endif
+
return FSRV_RUN_TMOUT;
}
@@ -1819,48 +2044,63 @@ afl_fsrv_run_target(afl_forkserver_t *fsrv, u32 timeout,
(fsrv->uses_crash_exitcode &&
WEXITSTATUS(fsrv->child_status) == fsrv->crash_exitcode))) {
+ /* For a proper crash, set last_kill_signal to WTERMSIG, else set it to 0 */
+ fsrv->last_kill_signal =
+ WIFSIGNALED(fsrv->child_status) ? WTERMSIG(fsrv->child_status) : 0;
+
#ifdef AFL_PERSISTENT_RECORD
if (unlikely(fsrv->persistent_record)) {
- char fn[PATH_MAX];
- u32 i, writecnt = 0;
- for (i = 0; i < fsrv->persistent_record; ++i) {
+ retval = FSRV_RUN_CRASH;
+ persistent_out_fmt = "%s/crashes/RECORD:%06u,cnt:%06u%s%s";
+ goto store_persistent_record;
- u32 entry = (i + fsrv->persistent_record_idx) % fsrv->persistent_record;
- u8 *data = fsrv->persistent_record_data[entry];
- u32 len = fsrv->persistent_record_len[entry];
- if (likely(len && data)) {
+ }
- snprintf(fn, sizeof(fn), "%s/RECORD:%06u,cnt:%06u",
- fsrv->persistent_record_dir, fsrv->persistent_record_cnt,
- writecnt++);
- int fd = open(fn, O_CREAT | O_TRUNC | O_WRONLY, 0644);
- if (fd >= 0) {
+#endif
- ck_write(fd, data, len, fn);
- close(fd);
+ return FSRV_RUN_CRASH;
- }
+ }
- }
+ /* success :) */
+ return FSRV_RUN_OK;
- }
+#ifdef AFL_PERSISTENT_RECORD
+store_persistent_record: {
- ++fsrv->persistent_record_cnt;
+ char fn[PATH_MAX];
+ u32 i, writecnt = 0;
+ for (i = 0; i < fsrv->persistent_record; ++i) {
- }
+ u32 entry = (i + fsrv->persistent_record_idx) % fsrv->persistent_record;
+ u8 *data = fsrv->persistent_record_data[entry];
+ u32 len = fsrv->persistent_record_len[entry];
+ if (likely(len && data)) {
-#endif
+ snprintf(fn, sizeof(fn), persistent_out_fmt, fsrv->persistent_record_dir,
+ fsrv->persistent_record_cnt, writecnt++,
+ afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
+ int fd = open(fn, O_CREAT | O_TRUNC | O_WRONLY, 0644);
+ if (fd >= 0) {
- /* For a proper crash, set last_kill_signal to WTERMSIG, else set it to 0 */
- fsrv->last_kill_signal =
- WIFSIGNALED(fsrv->child_status) ? WTERMSIG(fsrv->child_status) : 0;
- return FSRV_RUN_CRASH;
+ ck_write(fd, data, len, fn);
+ close(fd);
+
+ }
+
+ }
}
- /* success :) */
- return FSRV_RUN_OK;
+ ++fsrv->persistent_record_cnt;
+
+ return retval;
+
+}
+
+#endif
}
diff --git a/src/afl-fuzz-bitmap.c b/src/afl-fuzz-bitmap.c
index d056ac9f..d8561dde 100644
--- a/src/afl-fuzz-bitmap.c
+++ b/src/afl-fuzz-bitmap.c
@@ -527,15 +527,19 @@ save_if_interesting(afl_state_t *afl, void *mem, u32 len, u8 fault) {
#ifndef SIMPLE_FILES
- queue_fn =
- alloc_printf("%s/queue/id:%06u,%s", afl->out_dir, afl->queued_items,
- describe_op(afl, new_bits + is_timeout,
- NAME_MAX - strlen("id:000000,")));
+ queue_fn = alloc_printf(
+ "%s/queue/id:%06u,%s%s%s", afl->out_dir, afl->queued_items,
+ describe_op(afl, new_bits + is_timeout,
+ NAME_MAX - strlen("id:000000,")),
+ afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
#else
- queue_fn =
- alloc_printf("%s/queue/id_%06u", afl->out_dir, afl->queued_items);
+ queue_fn = alloc_printf(
+ "%s/queue/id_%06u", afl->out_dir, afl->queued_items,
+ afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
#endif /* ^!SIMPLE_FILES */
fd = open(queue_fn, O_WRONLY | O_CREAT | O_EXCL, DEFAULT_PERMISSION);
@@ -739,14 +743,17 @@ save_if_interesting(afl_state_t *afl, void *mem, u32 len, u8 fault) {
#ifndef SIMPLE_FILES
- snprintf(fn, PATH_MAX, "%s/hangs/id:%06llu,%s", afl->out_dir,
+ snprintf(fn, PATH_MAX, "%s/hangs/id:%06llu,%s%s%s", afl->out_dir,
afl->saved_hangs,
- describe_op(afl, 0, NAME_MAX - strlen("id:000000,")));
+ describe_op(afl, 0, NAME_MAX - strlen("id:000000,")),
+ afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
#else
- snprintf(fn, PATH_MAX, "%s/hangs/id_%06llu", afl->out_dir,
- afl->saved_hangs);
+ snprintf(fn, PATH_MAX, "%s/hangs/id_%06llu%s%s", afl->out_dir,
+ afl->saved_hangs, afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
#endif /* ^!SIMPLE_FILES */
@@ -792,14 +799,18 @@ save_if_interesting(afl_state_t *afl, void *mem, u32 len, u8 fault) {
#ifndef SIMPLE_FILES
- snprintf(fn, PATH_MAX, "%s/crashes/id:%06llu,sig:%02u,%s", afl->out_dir,
- afl->saved_crashes, afl->fsrv.last_kill_signal,
- describe_op(afl, 0, NAME_MAX - strlen("id:000000,sig:00,")));
+ snprintf(fn, PATH_MAX, "%s/crashes/id:%06llu,sig:%02u,%s%s%s",
+ afl->out_dir, afl->saved_crashes, afl->fsrv.last_kill_signal,
+ describe_op(afl, 0, NAME_MAX - strlen("id:000000,sig:00,")),
+ afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
#else
- snprintf(fn, PATH_MAX, "%s/crashes/id_%06llu_%02u", afl->out_dir,
- afl->saved_crashes, afl->fsrv.last_kill_signal);
+ snprintf(fn, PATH_MAX, "%s/crashes/id_%06llu_%02u%s%s", afl->out_dir,
+ afl->saved_crashes, afl->fsrv.last_kill_signal,
+ afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
#endif /* ^!SIMPLE_FILES */
diff --git a/src/afl-fuzz-extras.c b/src/afl-fuzz-extras.c
index 3b1d13f1..c06896ef 100644
--- a/src/afl-fuzz-extras.c
+++ b/src/afl-fuzz-extras.c
@@ -742,8 +742,11 @@ void save_auto(afl_state_t *afl) {
for (i = 0; i < MIN((u32)USE_AUTO_EXTRAS, afl->a_extras_cnt); ++i) {
- u8 *fn =
- alloc_printf("%s/queue/.state/auto_extras/auto_%06u", afl->out_dir, i);
+ u8 *fn = alloc_printf(
+ "%s/queue/.state/auto_extras/auto_%06u%s%s", afl->out_dir, i,
+ afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
+
s32 fd;
fd = open(fn, O_WRONLY | O_CREAT | O_TRUNC, DEFAULT_PERMISSION);
diff --git a/src/afl-fuzz-init.c b/src/afl-fuzz-init.c
index 76291cc4..21a8ba7e 100644
--- a/src/afl-fuzz-init.c
+++ b/src/afl-fuzz-init.c
@@ -1157,18 +1157,22 @@ void perform_dry_run(afl_state_t *afl) {
#ifndef SIMPLE_FILES
- snprintf(crash_fn, PATH_MAX, "%s/crashes/id:%06llu,sig:%02u,%s%s",
- afl->out_dir, afl->saved_crashes, afl->fsrv.last_kill_signal,
- describe_op(afl, 0,
- NAME_MAX - strlen("id:000000,sig:00,") -
- strlen(use_name)),
- use_name);
+ snprintf(
+ crash_fn, PATH_MAX, "%s/crashes/id:%06llu,sig:%02u,%s%s%s%s",
+ afl->out_dir, afl->saved_crashes, afl->fsrv.last_kill_signal,
+ describe_op(
+ afl, 0,
+ NAME_MAX - strlen("id:000000,sig:00,") - strlen(use_name)),
+ use_name, afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
#else
- snprintf(crash_fn, PATH_MAX, "%s/crashes/id_%06llu_%02u",
- afl->out_dir, afl->saved_crashes,
- afl->fsrv.last_kill_signal);
+ snprintf(
+ crash_fn, PATH_MAX, "%s/crashes/id_%06llu_%02u%s%s", afl->out_dir,
+ afl->saved_crashes, afl->fsrv.last_kill_signal,
+ afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
#endif
@@ -1439,7 +1443,9 @@ void pivot_inputs(afl_state_t *afl) {
u32 src_id;
afl->resuming_fuzz = 1;
- nfn = alloc_printf("%s/queue/%s", afl->out_dir, rsl);
+ nfn = alloc_printf(
+ "%s/queue/%s%s%s", afl->out_dir, rsl, afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
/* Since we're at it, let's also get the parent and figure out the
appropriate depth for this entry. */
@@ -1479,12 +1485,17 @@ void pivot_inputs(afl_state_t *afl) {
}
- nfn = alloc_printf("%s/queue/id:%06u,time:0,execs:%llu,orig:%s",
- afl->out_dir, id, afl->fsrv.total_execs, use_name);
+ nfn = alloc_printf(
+ "%s/queue/id:%06u,time:0,execs:%llu,orig:%s%s%s", afl->out_dir, id,
+ afl->fsrv.total_execs, use_name, afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
#else
- nfn = alloc_printf("%s/queue/id_%06u", afl->out_dir, id);
+ nfn = alloc_printf(
+ "%s/queue/id_%06u%s%s", afl->out_dir, id,
+ afl->file_extension ? "." : "",
+ afl->file_extension ? (const char *)afl->file_extension : "");
#endif /* ^!SIMPLE_FILES */
@@ -1921,6 +1932,9 @@ static void handle_existing_out_dir(afl_state_t *afl) {
}
+#ifdef AFL_PERSISTENT_RECORD
+ delete_files(fn, RECORD_PREFIX);
+#endif
if (delete_files(fn, CASE_PREFIX)) { goto dir_cleanup_failed; }
ck_free(fn);
@@ -1953,6 +1967,9 @@ static void handle_existing_out_dir(afl_state_t *afl) {
}
+#ifdef AFL_PERSISTENT_RECORD
+ delete_files(fn, RECORD_PREFIX);
+#endif
if (delete_files(fn, CASE_PREFIX)) { goto dir_cleanup_failed; }
ck_free(fn);
diff --git a/src/afl-fuzz-redqueen.c b/src/afl-fuzz-redqueen.c
index eead7a8b..be41d6c4 100644
--- a/src/afl-fuzz-redqueen.c
+++ b/src/afl-fuzz-redqueen.c
@@ -11,7 +11,7 @@
Andrea Fioraldi <andreafioraldi@gmail.com>
Copyright 2016, 2017 Google Inc. All rights reserved.
- Copyright 2019-2024 AFLplusplus Project. All rights reserved.
+ Copyright 2019-2023 AFLplusplus Project. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -29,6 +29,7 @@
#include "cmplog.h"
// #define _DEBUG
+// #define USE_HASHMAP
// #define CMPLOG_INTROSPECTION
// CMP attribute enum
@@ -87,6 +88,13 @@ static u32 hshape;
static u64 screen_update;
static u64 last_update;
+#ifdef USE_HASHMAP
+// hashmap functions
+void hashmap_reset();
+bool hashmap_search_and_add(uint8_t type, uint64_t key);
+bool hashmap_search_and_add_ptr(uint8_t type, u8 *key);
+#endif
+
static struct range *add_range(struct range *ranges, u32 start, u32 end) {
struct range *r = ck_alloc_nozero(sizeof(struct range));
@@ -795,7 +803,7 @@ static u8 cmp_extend_encoding(afl_state_t *afl, struct cmp_header *h,
u64 *o_buf_64 = (u64 *)&orig_buf[idx];
u32 *o_buf_32 = (u32 *)&orig_buf[idx];
u16 *o_buf_16 = (u16 *)&orig_buf[idx];
- u8 *o_buf_8 = &orig_buf[idx];
+ // u8 *o_buf_8 = &orig_buf[idx];
u32 its_len = MIN(len - idx, taint_len);
@@ -836,6 +844,7 @@ static u8 cmp_extend_encoding(afl_state_t *afl, struct cmp_header *h,
// necessary for preventing heap access overflow
bytes = MIN(bytes, len - idx);
+ if (unlikely(bytes <= 1)) { return 0; }
// reverse atoi()/strnu?toll() is expensive, so we only to it in lvl 3
if (afl->cmplog_enable_transform && (lvl & LVL3)) {
@@ -1266,6 +1275,7 @@ static u8 cmp_extend_encoding(afl_state_t *afl, struct cmp_header *h,
}
+ /*
if (*status != 1) { // u8
// if (its_len >= 1)
@@ -1290,6 +1300,8 @@ static u8 cmp_extend_encoding(afl_state_t *afl, struct cmp_header *h,
}
+ */
+
}
// If 'S' is set for cmplog mode then we try a scale encoding of the value.
@@ -1881,6 +1893,8 @@ static u8 cmp_fuzz(afl_state_t *afl, u32 key, u8 *orig_buf, u8 *buf, u8 *cbuf,
hshape = SHAPE_BYTES(h->shape);
+ if (hshape < 2) { return 0; }
+
if (h->hits > CMP_MAP_H) {
loggeds = CMP_MAP_H;
@@ -1906,8 +1920,6 @@ static u8 cmp_fuzz(afl_state_t *afl, u32 key, u8 *orig_buf, u8 *buf, u8 *cbuf,
#endif
- if (hshape < 2) { return 0; }
-
for (i = 0; i < loggeds; ++i) {
struct cmp_operands *o = &afl->shm.cmp_map->log[key][i];
@@ -1945,6 +1957,19 @@ static u8 cmp_fuzz(afl_state_t *afl, u32 key, u8 *orig_buf, u8 *buf, u8 *cbuf,
}
+#ifdef USE_HASHMAP
+ // TODO: add attribute? not sure
+ if (hshape <= 8 && hashmap_search_and_add(hshape - 1, o->v0) &&
+ hashmap_search_and_add(hshape - 1, orig_o->v0) &&
+ hashmap_search_and_add(hshape - 1, o->v1) &&
+ hashmap_search_and_add(hshape - 1, orig_o->v1)) {
+
+ continue;
+
+ }
+
+#endif
+
#ifdef _DEBUG
fprintf(stderr, "Handling: %llx->%llx vs %llx->%llx attr=%u shape=%u\n",
orig_o->v0, o->v0, orig_o->v1, o->v1, h->attribute, hshape);
@@ -2219,15 +2244,15 @@ static u8 rtn_extend_encoding(afl_state_t *afl, u8 entry,
}
- if (l0 == 0 || l1 == 0 || ol0 == 0 || ol1 == 0 || l0 > 31 || l1 > 31 ||
- ol0 > 31 || ol1 > 31) {
+ if (l0 == 0 || l1 == 0 || ol0 == 0 || ol1 == 0 || l0 > 32 || l1 > 32 ||
+ ol0 > 32 || ol1 > 32) {
l0 = ol0 = hshape;
}
u8 lmax = MAX(l0, ol0);
- u8 save[40];
+ u8 save[80];
u32 saved_idx = idx, pre, from = 0, to = 0, i, j;
u32 its_len = MIN(MIN(lmax, hshape), len - idx);
its_len = MIN(its_len, taint_len);
@@ -2330,7 +2355,7 @@ static u8 rtn_extend_encoding(afl_state_t *afl, u8 entry,
u32 tob64 = 0, fromb64 = 0;
u32 from_0 = 0, from_x = 0, from_X = 0, from_slash = 0, from_up = 0;
u32 to_0 = 0, to_x = 0, to_slash = 0, to_up = 0;
- u8 xor_val[32], arith_val[32], tmp[48];
+ u8 xor_val[64], arith_val[64], tmp[64];
idx = saved_idx;
its_len = saved_its_len;
@@ -2615,12 +2640,13 @@ static u8 rtn_extend_encoding(afl_state_t *afl, u8 entry,
}
- memcpy(buf + idx, tmp, hlen + 1 + off);
+ u32 tmp_l = hlen + 1 + off;
+ memcpy(buf + idx, tmp, tmp_l);
if (unlikely(its_fuzz(afl, buf, len, status))) { return 1; }
- tmp[hlen + 1 + off] = 0;
+ tmp[tmp_l] = 0;
// fprintf(stderr, "RTN ATTEMPT idx=%u len=%u fromhex %u %s %s result
// %u\n", idx, len, fromhex, tmp, repl, *status);
- memcpy(buf + idx, save, hlen + 1 + off);
+ memcpy(buf + idx, save, tmp_l);
}
@@ -2755,6 +2781,18 @@ static u8 rtn_fuzz(afl_state_t *afl, u32 key, u8 *orig_buf, u8 *buf, u8 *cbuf,
fprintf(stderr, "\n");
#endif
+#ifdef USE_HASHMAP
+ if (hshape <= 8 && hashmap_search_and_add_ptr(hshape - 1, o->v0) &&
+ hashmap_search_and_add_ptr(hshape - 1, orig_o->v0) &&
+ hashmap_search_and_add_ptr(hshape - 1, o->v1) &&
+ hashmap_search_and_add_ptr(hshape - 1, orig_o->v1)) {
+
+ continue;
+
+ }
+
+#endif
+
t = taint;
while (t->next) {
@@ -3021,6 +3059,10 @@ u8 input_to_state_stage(afl_state_t *afl, u8 *orig_buf, u8 *buf, u32 len) {
// Start insertion loop
+#ifdef USE_HASHMAP
+ hashmap_reset();
+#endif
+
u64 orig_hit_cnt, new_hit_cnt;
u64 orig_execs = afl->fsrv.total_execs;
orig_hit_cnt = afl->queued_items + afl->saved_crashes;
diff --git a/src/afl-fuzz-run.c b/src/afl-fuzz-run.c
index d764952c..edcddc8e 100644
--- a/src/afl-fuzz-run.c
+++ b/src/afl-fuzz-run.c
@@ -409,6 +409,7 @@ u8 calibrate_case(afl_state_t *afl, struct queue_entry *q, u8 *use_mem,
u32 use_tmout = afl->fsrv.exec_tmout;
u8 *old_sn = afl->stage_name;
+ u64 calibration_start_us = get_cur_time_us();
if (unlikely(afl->shm.cmplog_mode)) { q->exec_cksum = 0; }
/* Be a bit more generous about timeouts when resuming sessions, or when
@@ -504,6 +505,10 @@ u8 calibrate_case(afl_state_t *afl, struct queue_entry *q, u8 *use_mem,
fault = fuzz_run_target(afl, &afl->fsrv, use_tmout);
+ // update the time spend in calibration after each execution, as those may
+ // be slow
+ update_calibration_time(afl, &calibration_start_us);
+
/* afl->stop_soon is set by the handler for Ctrl+C. When it's pressed,
we want to bail out quickly. */
@@ -650,6 +655,7 @@ abort_calibration:
if (!first_run) { show_stats(afl); }
+ update_calibration_time(afl, &calibration_start_us);
return fault;
}
@@ -669,11 +675,16 @@ void sync_fuzzers(afl_state_t *afl) {
afl->stage_max = afl->stage_cur = 0;
afl->cur_depth = 0;
+ u64 sync_start_us = get_cur_time_us();
/* Look at the entries created for every other fuzzer in the sync directory.
*/
while ((sd_ent = readdir(sd))) {
+ // since sync can take substantial amounts of time, update time spend every
+ // iteration
+ update_sync_time(afl, &sync_start_us);
+
u8 qd_synced_path[PATH_MAX], qd_path[PATH_MAX];
u32 min_accept = 0, next_min_accept = 0;
@@ -811,7 +822,7 @@ void sync_fuzzers(afl_state_t *afl) {
/* See what happens. We rely on save_if_interesting() to catch major
errors and save the test case. */
- (void)write_to_testcase(afl, (void **)&mem, st.st_size, 1);
+ u32 new_len = write_to_testcase(afl, (void **)&mem, st.st_size, 1);
fault = fuzz_run_target(afl, &afl->fsrv, afl->fsrv.exec_tmout);
@@ -819,7 +830,7 @@ void sync_fuzzers(afl_state_t *afl) {
afl->syncing_party = sd_ent->d_name;
afl->queued_imported +=
- save_if_interesting(afl, mem, st.st_size, fault);
+ save_if_interesting(afl, mem, new_len, fault);
afl->syncing_party = 0;
munmap(mem, st.st_size);
@@ -861,6 +872,9 @@ void sync_fuzzers(afl_state_t *afl) {
if (afl->foreign_sync_cnt) read_foreign_testcases(afl, 0);
+ // add time in sync one last time
+ update_sync_time(afl, &sync_start_us);
+
afl->last_sync_time = get_cur_time();
afl->last_sync_cycle = afl->queue_cycle;
@@ -872,8 +886,9 @@ void sync_fuzzers(afl_state_t *afl) {
u8 trim_case(afl_state_t *afl, struct queue_entry *q, u8 *in_buf) {
+ u8 needs_write = 0, fault = 0;
u32 orig_len = q->len;
-
+ u64 trim_start_us = get_cur_time_us();
/* Custom mutator trimmer */
if (afl->custom_mutators_count) {
@@ -897,11 +912,15 @@ u8 trim_case(afl_state_t *afl, struct queue_entry *q, u8 *in_buf) {
}
- if (custom_trimmed) return trimmed_case;
+ if (custom_trimmed) {
+
+ fault = trimmed_case;
+ goto abort_trimming;
+
+ }
}
- u8 needs_write = 0, fault = 0;
u32 trim_exec = 0;
u32 remove_len;
u32 len_p2;
@@ -912,7 +931,12 @@ u8 trim_case(afl_state_t *afl, struct queue_entry *q, u8 *in_buf) {
detected, it will still work to some extent, so we don't check for
this. */
- if (unlikely(q->len < 5)) { return 0; }
+ if (unlikely(q->len < 5)) {
+
+ fault = 0;
+ goto abort_trimming;
+
+ }
afl->stage_name = afl->stage_name_buf;
afl->bytes_trim_in += q->len;
@@ -946,6 +970,8 @@ u8 trim_case(afl_state_t *afl, struct queue_entry *q, u8 *in_buf) {
fault = fuzz_run_target(afl, &afl->fsrv, afl->fsrv.exec_tmout);
+ update_trim_time(afl, &trim_start_us);
+
if (afl->stop_soon || fault == FSRV_RUN_ERROR) { goto abort_trimming; }
/* Note that we don't keep track of crashes or hangs here; maybe TODO?
@@ -972,7 +998,6 @@ u8 trim_case(afl_state_t *afl, struct queue_entry *q, u8 *in_buf) {
/* Let's save a clean trace, which will be needed by
update_bitmap_score once we're done with the trimming stuff. */
-
if (!needs_write) {
needs_write = 1;
@@ -987,7 +1012,6 @@ u8 trim_case(afl_state_t *afl, struct queue_entry *q, u8 *in_buf) {
}
/* Since this can be slow, update the screen every now and then. */
-
if (!(trim_exec++ % afl->stats_update_freq)) { show_stats(afl); }
++afl->stage_cur;
@@ -1039,8 +1063,9 @@ u8 trim_case(afl_state_t *afl, struct queue_entry *q, u8 *in_buf) {
}
abort_trimming:
-
afl->bytes_trim_out += q->len;
+ update_trim_time(afl, &trim_start_us);
+
return fault;
}
diff --git a/src/afl-fuzz-state.c b/src/afl-fuzz-state.c
index 4467cae8..c61f00bd 100644
--- a/src/afl-fuzz-state.c
+++ b/src/afl-fuzz-state.c
@@ -28,10 +28,6 @@
#include "afl-fuzz.h"
#include "envs.h"
-s8 interesting_8[] = {INTERESTING_8};
-s16 interesting_16[] = {INTERESTING_8, INTERESTING_16};
-s32 interesting_32[] = {INTERESTING_8, INTERESTING_16, INTERESTING_32};
-
char *power_names[POWER_SCHEDULES_NUM] = {"explore", "mmopt", "exploit",
"fast", "coe", "lin",
"quad", "rare", "seek"};
@@ -102,7 +98,7 @@ void afl_state_init(afl_state_t *afl, uint32_t map_size) {
afl->stats_update_freq = 1;
afl->stats_file_update_freq_msecs = STATS_UPDATE_SEC * 1000;
afl->stats_avg_exec = 0;
- afl->skip_deterministic = 1;
+ afl->skip_deterministic = 0;
afl->sync_time = SYNC_TIME;
afl->cmplog_lvl = 2;
afl->min_length = 1;
diff --git a/src/afl-fuzz-stats.c b/src/afl-fuzz-stats.c
index 76577081..7e1a3b92 100644
--- a/src/afl-fuzz-stats.c
+++ b/src/afl-fuzz-stats.c
@@ -133,6 +133,12 @@ void write_setup_file(afl_state_t *afl, u32 argc, char **argv) {
}
+static bool starts_with(char *key, char *line) {
+
+ return strncmp(key, line, strlen(key)) == 0;
+
+}
+
/* load some of the existing stats file when resuming.*/
void load_stats_file(afl_state_t *afl) {
@@ -175,58 +181,84 @@ void load_stats_file(afl_state_t *afl) {
strcpy(keystring, lstartptr);
lptr++;
char *nptr;
- switch (lineno) {
-
- case 3:
- if (!strcmp(keystring, "run_time "))
- afl->prev_run_time = 1000 * strtoull(lptr, &nptr, 10);
- break;
- case 5:
- if (!strcmp(keystring, "cycles_done "))
- afl->queue_cycle =
- strtoull(lptr, &nptr, 10) ? strtoull(lptr, &nptr, 10) + 1 : 0;
- break;
- case 7:
- if (!strcmp(keystring, "execs_done "))
- afl->fsrv.total_execs = strtoull(lptr, &nptr, 10);
- break;
- case 10:
- if (!strcmp(keystring, "corpus_count ")) {
-
- u32 corpus_count = strtoul(lptr, &nptr, 10);
- if (corpus_count != afl->queued_items) {
-
- WARNF(
- "queue/ has been modified -- things might not work, you're "
- "on your own!");
-
- }
-
- }
-
- break;
- case 12:
- if (!strcmp(keystring, "corpus_found "))
- afl->queued_discovered = strtoul(lptr, &nptr, 10);
- break;
- case 13:
- if (!strcmp(keystring, "corpus_imported "))
- afl->queued_imported = strtoul(lptr, &nptr, 10);
- break;
- case 14:
- if (!strcmp(keystring, "max_depth "))
- afl->max_depth = strtoul(lptr, &nptr, 10);
- break;
- case 21:
- if (!strcmp(keystring, "saved_crashes "))
- afl->saved_crashes = strtoull(lptr, &nptr, 10);
- break;
- case 22:
- if (!strcmp(keystring, "saved_hangs "))
- afl->saved_hangs = strtoull(lptr, &nptr, 10);
- break;
- default:
- break;
+ if (starts_with("run_time", keystring)) {
+
+ afl->prev_run_time = 1000 * strtoull(lptr, &nptr, 10);
+
+ }
+
+ if (starts_with("cycles_done", keystring)) {
+
+ afl->queue_cycle =
+ strtoull(lptr, &nptr, 10) ? strtoull(lptr, &nptr, 10) + 1 : 0;
+
+ }
+
+ if (starts_with("calibration_time", keystring)) {
+
+ afl->calibration_time_us = strtoull(lptr, &nptr, 10) * 1000000;
+
+ }
+
+ if (starts_with("sync_time", keystring)) {
+
+ afl->sync_time_us = strtoull(lptr, &nptr, 10) * 1000000;
+
+ }
+
+ if (starts_with("trim_time", keystring)) {
+
+ afl->trim_time_us = strtoull(lptr, &nptr, 10) * 1000000;
+
+ }
+
+ if (starts_with("execs_done", keystring)) {
+
+ afl->fsrv.total_execs = strtoull(lptr, &nptr, 10);
+
+ }
+
+ if (starts_with("corpus_count", keystring)) {
+
+ u32 corpus_count = strtoul(lptr, &nptr, 10);
+ if (corpus_count != afl->queued_items) {
+
+ WARNF(
+ "queue/ has been modified -- things might not work, you're "
+ "on your own!");
+ sleep(3);
+
+ }
+
+ }
+
+ if (starts_with("corpus_found", keystring)) {
+
+ afl->queued_discovered = strtoul(lptr, &nptr, 10);
+
+ }
+
+ if (starts_with("corpus_imported", keystring)) {
+
+ afl->queued_imported = strtoul(lptr, &nptr, 10);
+
+ }
+
+ if (starts_with("max_depth", keystring)) {
+
+ afl->max_depth = strtoul(lptr, &nptr, 10);
+
+ }
+
+ if (starts_with("saved_crashes", keystring)) {
+
+ afl->saved_crashes = strtoull(lptr, &nptr, 10);
+
+ }
+
+ if (starts_with("saved_hangs", keystring)) {
+
+ afl->saved_hangs = strtoull(lptr, &nptr, 10);
}
@@ -300,6 +332,10 @@ void write_stats_file(afl_state_t *afl, u32 t_bytes, double bitmap_cvg,
"cycles_done : %llu\n"
"cycles_wo_finds : %llu\n"
"time_wo_finds : %llu\n"
+ "fuzz_time : %llu\n"
+ "calibration_time : %llu\n"
+ "sync_time : %llu\n"
+ "trim_time : %llu\n"
"execs_done : %llu\n"
"execs_per_sec : %0.02f\n"
"execs_ps_last_min : %0.02f\n"
@@ -337,7 +373,7 @@ void write_stats_file(afl_state_t *afl, u32 t_bytes, double bitmap_cvg,
"\n"
"target_mode : %s%s%s%s%s%s%s%s%s%s\n"
"command_line : %s\n",
- (afl->start_time - afl->prev_run_time) / 1000, cur_time / 1000,
+ (afl->start_time /*- afl->prev_run_time*/) / 1000, cur_time / 1000,
runtime / 1000, (u32)getpid(),
afl->queue_cycle ? (afl->queue_cycle - 1) : 0, afl->cycles_wo_finds,
afl->longest_find_time > cur_time - afl->last_find_time
@@ -345,7 +381,13 @@ void write_stats_file(afl_state_t *afl, u32 t_bytes, double bitmap_cvg,
: ((afl->start_time == 0 || afl->last_find_time == 0)
? 0
: (cur_time - afl->last_find_time) / 1000),
- afl->fsrv.total_execs, afl->fsrv.total_execs / ((double)(runtime) / 1000),
+ (runtime -
+ (afl->calibration_time_us + afl->sync_time_us + afl->trim_time_us) /
+ 1000) /
+ 1000,
+ afl->calibration_time_us / 1000000, afl->sync_time_us / 1000000,
+ afl->trim_time_us / 1000000, afl->fsrv.total_execs,
+ afl->fsrv.total_execs / ((double)(runtime) / 1000),
afl->last_avg_execs_saved, afl->queued_items, afl->queued_favored,
afl->queued_discovered, afl->queued_imported, afl->queued_variable,
afl->max_depth, afl->current_entry, afl->pending_favored,
@@ -876,6 +918,10 @@ void show_stats_normal(afl_state_t *afl) {
#endif
+ if (banner_pad)
+ for (u32 i = 0; i < banner_pad; ++i)
+ strcat(banner, " ");
+
}
SAYF("\n%s\n", banner);
@@ -1112,7 +1158,7 @@ void show_stats_normal(afl_state_t *afl) {
} else if (likely(afl->skip_deterministic)) {
- strcpy(tmp, "disabled (default, enable with -D)");
+ strcpy(tmp, "disabled (-z switch used)");
} else {
@@ -2435,3 +2481,27 @@ void show_init_stats(afl_state_t *afl) {
}
+void update_calibration_time(afl_state_t *afl, u64 *time) {
+
+ u64 cur = get_cur_time_us();
+ afl->calibration_time_us += cur - *time;
+ *time = cur;
+
+}
+
+void update_trim_time(afl_state_t *afl, u64 *time) {
+
+ u64 cur = get_cur_time_us();
+ afl->trim_time_us += cur - *time;
+ *time = cur;
+
+}
+
+void update_sync_time(afl_state_t *afl, u64 *time) {
+
+ u64 cur = get_cur_time_us();
+ afl->sync_time_us += cur - *time;
+ *time = cur;
+
+}
+
diff --git a/src/afl-fuzz.c b/src/afl-fuzz.c
index 12d67fe7..00d24ab1 100644
--- a/src/afl-fuzz.c
+++ b/src/afl-fuzz.c
@@ -5,8 +5,9 @@
Originally written by Michal Zalewski
Now maintained by Marc Heuse <mh@mh-sec.de>,
- Heiko Eißfeldt <heiko.eissfeldt@hexco.de> and
- Andrea Fioraldi <andreafioraldi@gmail.com>
+ Dominik Meier <mail@dmnk.co>,
+ Andrea Fioraldi <andreafioraldi@gmail.com>, and
+ Heiko Eissfeldt <heiko.eissfeldt@hexco.de>
Copyright 2016, 2017 Google Inc. All rights reserved.
Copyright 2019-2024 AFLplusplus Project. All rights reserved.
@@ -170,7 +171,6 @@ static void usage(u8 *argv0, int more_help) {
" -g minlength - set min length of generated fuzz input (default: 1)\n"
" -G maxlength - set max length of generated fuzz input (default: "
"%lu)\n"
- " -D - enable (a new) effective deterministic fuzzing\n"
" -L minutes - use MOpt(imize) mode and set the time limit for "
"entering the\n"
" pacemaker mode (minutes of no new finds). 0 = "
@@ -200,7 +200,8 @@ static void usage(u8 *argv0, int more_help) {
"Test settings:\n"
" -s seed - use a fixed seed for the RNG\n"
- " -V seconds - fuzz for a specified time then terminate\n"
+ " -V seconds - fuzz for a specified time then terminate (fuzz time "
+ "only!)\n"
" -E execs - fuzz for an approx. no. of total executions then "
"terminate\n"
" Note: not precise and can have several more "
@@ -213,7 +214,8 @@ static void usage(u8 *argv0, int more_help) {
" -F path - sync to a foreign fuzzer queue directory (requires "
"-M, can\n"
" be specified up to %u times)\n"
- // " -d - skip deterministic fuzzing in -M mode\n"
+ " -z - skip the enhanced deterministic fuzzing\n"
+ " (note that the old -d and -D flags are ignored.)\n"
" -T text - text banner to show on the screen\n"
" -I command - execute this command/script when a new crash is "
"found\n"
@@ -401,6 +403,12 @@ static void usage(u8 *argv0, int more_help) {
SAYF("Compiled with _AFL_DOCUMENT_MUTATIONS.\n");
#endif
+#ifdef _AFL_SPECIAL_PERFORMANCE
+ SAYF(
+ "Compiled with special performance options for this specific system, it "
+ "might not work on other platforms!\n");
+#endif
+
SAYF("For additional help please consult %s/README.md :)\n\n", doc_path);
exit(1);
@@ -539,7 +547,7 @@ int main(int argc, char **argv_orig, char **envp) {
// still available: HjJkKqruvwz
while ((opt = getopt(argc, argv,
"+a:Ab:B:c:CdDe:E:f:F:g:G:hi:I:l:L:m:M:nNo:Op:P:QRs:S:t:"
- "T:UV:WXx:YZ")) > 0) {
+ "T:UV:WXx:YzZ")) > 0) {
switch (opt) {
@@ -955,20 +963,17 @@ int main(int argc, char **argv_orig, char **envp) {
break;
- case 'D': /* partial deterministic */
+ case 'd':
+ case 'D': /* old deterministic */
- afl->skip_deterministic = 0;
+ WARNF(
+ "Parameters -d and -D are deprecated, a new enhanced deterministic "
+ "fuzzing is active by default, to disable it use -z");
break;
- case 'd': /* no deterministic */
+ case 'z': /* no deterministic */
- // this is the default and currently a lot of infrastructure enforces
- // it (e.g. clusterfuzz, fuzzbench) based on that this feature
- // originally was bad performance wise. We now have a better
- // implementation, hence if it is activated, we do not want to
- // deactivate it by such setups.
-
- // afl->skip_deterministic = 1;
+ afl->skip_deterministic = 1;
break;
case 'B': /* load bitmap */
@@ -1232,6 +1237,7 @@ int main(int argc, char **argv_orig, char **envp) {
}
+ afl->old_seed_selection = 1;
u64 limit_time_puppet2 = afl->limit_time_puppet * 60 * 1000;
if ((s32)limit_time_puppet2 < afl->limit_time_puppet) {
@@ -2069,6 +2075,17 @@ int main(int argc, char **argv_orig, char **envp) {
}
+ /* Simply code if AFL_TMPDIR is used or not */
+ if (!afl->afl_env.afl_tmpdir) {
+
+ afl->tmp_dir = afl->out_dir;
+
+ } else {
+
+ afl->tmp_dir = afl->afl_env.afl_tmpdir;
+
+ }
+
write_setup_file(afl, argc, argv);
setup_cmdline_file(afl, argv + optind);
@@ -2081,8 +2098,7 @@ int main(int argc, char **argv_orig, char **envp) {
if (!afl->timeout_given) { find_timeout(afl); } // only for resumes!
- if ((afl->tmp_dir = afl->afl_env.afl_tmpdir) != NULL &&
- !afl->in_place_resume) {
+ if (afl->afl_env.afl_tmpdir && !afl->in_place_resume) {
char tmpfile[PATH_MAX];
@@ -2107,10 +2123,6 @@ int main(int argc, char **argv_orig, char **envp) {
}
- } else {
-
- afl->tmp_dir = afl->out_dir;
-
}
/* If we don't have a file name chosen yet, use a safe default. */
@@ -2182,7 +2194,7 @@ int main(int argc, char **argv_orig, char **envp) {
}
- afl->fsrv.persistent_record_dir = alloc_printf("%s/crashes", afl->out_dir);
+ afl->fsrv.persistent_record_dir = alloc_printf("%s", afl->out_dir);
}
@@ -2489,8 +2501,15 @@ int main(int argc, char **argv_orig, char **envp) {
for (entry = 0; entry < afl->queued_items; ++entry)
if (!afl->queue_buf[entry]->disabled)
- if (afl->queue_buf[entry]->exec_us > max_ms)
- max_ms = afl->queue_buf[entry]->exec_us;
+ if ((afl->queue_buf[entry]->exec_us / 1000) > max_ms)
+ max_ms = afl->queue_buf[entry]->exec_us / 1000;
+
+ // Add 20% as a safety margin, capped to exec_tmout given in -t option
+ max_ms *= 1.2;
+ if (max_ms > afl->fsrv.exec_tmout) max_ms = afl->fsrv.exec_tmout;
+
+ // Ensure that there is a sensible timeout even for very fast binaries
+ if (max_ms < 5) max_ms = 5;
afl->fsrv.exec_tmout = max_ms;
afl->timeout_given = 1;
@@ -2526,8 +2545,6 @@ int main(int argc, char **argv_orig, char **envp) {
}
// (void)nice(-20); // does not improve the speed
- // real start time, we reset, so this works correctly with -V
- afl->start_time = get_cur_time();
#ifdef INTROSPECTION
u32 prev_saved_crashes = 0, prev_saved_tmouts = 0;
@@ -2548,6 +2565,9 @@ int main(int argc, char **argv_orig, char **envp) {
OKF("Writing mutation introspection to '%s'", ifn);
#endif
+ // real start time, we reset, so this works correctly with -V
+ afl->start_time = get_cur_time();
+
while (likely(!afl->stop_soon)) {
cull_queue(afl);
@@ -2568,6 +2588,13 @@ int main(int argc, char **argv_orig, char **envp) {
sync_fuzzers(afl);
+ if (!afl->queue_cycle && afl->afl_env.afl_import_first) {
+
+ // real start time, we reset, so this works correctly with -V
+ afl->start_time = get_cur_time();
+
+ }
+
}
++afl->queue_cycle;
@@ -3057,7 +3084,7 @@ stop_fuzzing:
afl_fsrv_deinit(&afl->fsrv);
/* remove tmpfile */
- if (afl->tmp_dir != NULL && !afl->in_place_resume && afl->fsrv.out_file) {
+ if (!afl->in_place_resume && afl->fsrv.out_file) {
(void)unlink(afl->fsrv.out_file);
diff --git a/src/afl-performance.c b/src/afl-performance.c
index 07c1b527..f730ca53 100644
--- a/src/afl-performance.c
+++ b/src/afl-performance.c
@@ -2,9 +2,17 @@
#include "afl-fuzz.h"
#include "types.h"
-#define XXH_INLINE_ALL
-#include "xxhash.h"
-#undef XXH_INLINE_ALL
+#ifdef _HAVE_AVX2
+ #define T1HA0_AESNI_AVAILABLE 1
+ #define T1HA_USE_FAST_ONESHOT_READ 1
+ #define T1HA_USE_INDIRECT_FUNCTIONS 1
+ #define T1HA_IA32AES_NAME XXH3_64bits
+ #include "t1ha0_ia32aes_b.h"
+#else
+ #define XXH_INLINE_ALL
+ #include "xxhash.h"
+ #undef XXH_INLINE_ALL
+#endif
void rand_set_seed(afl_state_t *afl, s64 init_seed) {
diff --git a/src/afl-tmin.c b/src/afl-tmin.c
index 4e5dab41..994174ed 100644
--- a/src/afl-tmin.c
+++ b/src/afl-tmin.c
@@ -82,6 +82,8 @@ static u8 crash_mode, /* Crash-centric mode? */
remove_shm = 1, /* remove shmem on exit? */
debug; /* debug mode */
+static u32 del_len_limit = 1; /* Minimum block deletion length */
+
static volatile u8 stop_soon; /* Ctrl-C pressed? */
static afl_forkserver_t *fsrv;
@@ -480,7 +482,7 @@ next_del_blksize:
}
- if (del_len > 1 && in_len >= 1) {
+ if (del_len > del_len_limit && in_len >= 1) {
del_len /= 2;
goto next_del_blksize;
@@ -796,8 +798,9 @@ static void usage(u8 *argv0) {
"Minimization settings:\n"
" -e - solve for edge coverage only, ignore hit counts\n"
- " -x - treat non-zero exit codes as crashes\n\n"
- " -H - minimize a hang (hang mode)\n"
+ " -l bytes - set minimum block deletion length to speed up minimization\n"
+ " -x - treat non-zero exit codes as crashes\n"
+ " -H - minimize a hang (hang mode)\n\n"
"For additional tips, please consult %s/README.md.\n\n"
@@ -829,8 +832,9 @@ static void usage(u8 *argv0) {
int main(int argc, char **argv_orig, char **envp) {
- s32 opt;
- u8 mem_limit_given = 0, timeout_given = 0, unicorn_mode = 0, use_wine = 0;
+ s32 opt;
+ u8 mem_limit_given = 0, timeout_given = 0, unicorn_mode = 0, use_wine = 0,
+ del_limit_given = 0;
char **use_argv;
char **argv = argv_cpy_dup(argc, argv_orig);
@@ -846,7 +850,7 @@ int main(int argc, char **argv_orig, char **envp) {
SAYF(cCYA "afl-tmin" VERSION cRST " by Michal Zalewski\n");
- while ((opt = getopt(argc, argv, "+i:o:f:m:t:B:xeAOQUWXYHh")) > 0) {
+ while ((opt = getopt(argc, argv, "+i:o:f:m:t:l:B:xeAOQUWXYHh")) > 0) {
switch (opt) {
@@ -1055,6 +1059,24 @@ int main(int argc, char **argv_orig, char **envp) {
read_bitmap(optarg, mask_bitmap, map_size);
break;
+ case 'l':
+ if (del_limit_given) { FATAL("Multiple -l options not supported"); }
+ del_limit_given = 1;
+
+ if (!optarg) { FATAL("Wrong usage of -l"); }
+
+ if (optarg[0] == '-') { FATAL("Dangerously low value of -l"); }
+
+ del_len_limit = atoi(optarg);
+
+ if (del_len_limit < 1 || del_len_limit > TMIN_MAX_FILE) {
+
+ FATAL("Value of -l out of range between 1 and TMIN_MAX_FILE");
+
+ }
+
+ break;
+
case 'h':
usage(argv[0]);
return -1;
diff --git a/src/hashmap.c b/src/hashmap.c
new file mode 100644
index 00000000..a0a9283c
--- /dev/null
+++ b/src/hashmap.c
@@ -0,0 +1,149 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdbool.h>
+#include "types.h"
+#define TABLE_SIZE 10007 // Use a prime number for better distribution
+
+typedef struct HashNode {
+
+ uint64_t key;
+ struct HashNode *next;
+
+} HashNode;
+
+typedef struct HashMap {
+
+ HashNode **table;
+
+} HashMap;
+
+static HashMap *_hashmap;
+
+void hashmap_reset() {
+
+ if (unlikely(!_hashmap)) {
+
+ _hashmap = (HashMap *)malloc(sizeof(HashMap));
+ _hashmap->table = (HashNode **)malloc(sizeof(HashNode *) * TABLE_SIZE);
+ memset((char *)_hashmap->table, 0, sizeof(HashNode *) * TABLE_SIZE);
+
+ } else {
+
+ for (int i = 0; i < TABLE_SIZE; i++) {
+
+ HashNode *node = _hashmap->table[i];
+ while (node) {
+
+ HashNode *temp = node;
+ node = node->next;
+ free(temp);
+
+ }
+
+ }
+
+ memset((char *)_hashmap->table, 0, sizeof(HashNode *) * TABLE_SIZE);
+
+ }
+
+}
+
+static inline unsigned int hash(uint64_t key) {
+
+ return key % TABLE_SIZE;
+
+}
+
+// type must be below 8
+bool hashmap_search_and_add(uint8_t type, uint64_t key) {
+
+ if (unlikely(type >= 8)) return false;
+ uint64_t val = (key & 0xf8ffffffffffffff) + (type << 56);
+ unsigned int index = hash(val);
+ HashNode *node = _hashmap->table[index];
+ while (node) {
+
+ if (node->key == val) return true;
+ node = node->next;
+
+ }
+
+ // not found so add it
+ node = (HashNode *)malloc(sizeof(HashNode));
+ node->key = val;
+ node->next = _hashmap->table[index];
+ _hashmap->table[index] = node;
+
+ return false;
+
+}
+
+// type must be below 8
+bool hashmap_search_and_add_ptr(uint8_t type, u8 *key) {
+
+ if (unlikely(type >= 8)) return false;
+ uint64_t key_t = 0;
+ memcpy(((char *)key_t) + (7 - type), key, type + 1);
+ return hashmap_search_and_add(type, key_t);
+
+}
+
+/* below is not used */
+
+void hashmap_insert(uint64_t key) {
+
+ unsigned int index = hash(key);
+ HashNode *node = (HashNode *)malloc(sizeof(HashNode));
+ node->key = key;
+ node->next = _hashmap->table[index];
+ _hashmap->table[index] = node;
+
+}
+
+bool hashmap_search(uint64_t key) {
+
+ unsigned int index = hash(key);
+ HashNode *node = _hashmap->table[index];
+ while (node) {
+
+ if (node->key == key) return true;
+ node = node->next;
+
+ }
+
+ return false;
+
+}
+
+void delete(uint64_t key) {
+
+ unsigned int index = hash(key);
+ HashNode *prev = NULL, *node = _hashmap->table[index];
+ while (node) {
+
+ if (node->key == key) {
+
+ if (prev)
+ prev->next = node->next;
+ else
+ _hashmap->table[index] = node->next;
+ free(node);
+ return;
+
+ }
+
+ prev = node;
+ node = node->next;
+
+ }
+
+}
+
+void freeHashMap(HashMap *map) {
+
+ free(_hashmap->table);
+ free(map);
+
+}
+
diff --git a/test/test-llvm.sh b/test/test-llvm.sh
index 53bbd7b4..aef7a5e2 100755
--- a/test/test-llvm.sh
+++ b/test/test-llvm.sh
@@ -62,7 +62,7 @@ test -e ../afl-clang-fast -a -e ../split-switches-pass.so && {
$ECHO "$RED[!] llvm_mode threadsafe instrumentation failed"
CODE=1
}
- rm -f test-instr.ts.0 test-instr.ts.1
+ rm -f test-instr.ts.0 test-instr.ts.1 test-instr.ts
} || {
$ECHO "$RED[!] llvm_mode (threadsafe) failed"
CODE=1
diff --git a/test/test-qemu-mode.sh b/test/test-qemu-mode.sh
index 8eb7cb67..2ba81d02 100755
--- a/test/test-qemu-mode.sh
+++ b/test/test-qemu-mode.sh
@@ -63,7 +63,7 @@ test -e ../afl-qemu-trace && {
{
export AFL_PRELOAD=../libcompcov.so
export AFL_COMPCOV_LEVEL=2
- ../afl-fuzz -m ${MEM_LIMIT} -V07 -Q -i in -o out -- ./test-compcov >>errors 2>&1
+ AFL_NO_UI=1 ../afl-fuzz -V07 -Q -i in -o out -- ./test-compcov 2>&1
unset AFL_PRELOAD
unset AFL_COMPCOV_LEVEL
} >>errors 2>&1
@@ -88,7 +88,7 @@ test -e ../afl-qemu-trace && {
test "$SYS" = "i686" -o "$SYS" = "x86_64" -o "$SYS" = "amd64" -o "$SYS" = "i86pc" -o "$SYS" = "aarch64" -o ! "${SYS%%arm*}" && {
$ECHO "$GREY[*] running afl-fuzz for qemu_mode cmplog, this will take approx 10 seconds"
{
- ../afl-fuzz -m none -V07 -Q -c 0 -l 3 -i in -o out -- ./test-compcov >>errors 2>&1
+ ../afl-fuzz -V07 -Q -c 0 -l 3 -i in -o out -- ./test-compcov >>errors 2>&1
} >>errors 2>&1
test -n "$( ls out/default/queue/id:000001* 2>/dev/null )" && {
$ECHO "$GREEN[+] afl-fuzz is working correctly with qemu_mode cmplog"
diff --git a/unicorn_mode/build_unicorn_support.sh b/unicorn_mode/build_unicorn_support.sh
index baca2171..097a2dc9 100755
--- a/unicorn_mode/build_unicorn_support.sh
+++ b/unicorn_mode/build_unicorn_support.sh
@@ -198,10 +198,12 @@ $MAKECMD -j1 || exit 1
echo "[+] Build process successful!"
echo "[*] Installing Unicorn python bindings..."
+XOPT=
+$PYTHONBIN -m pip install --help 2>/dev/null | grep -q break-system-packages && XOPT=--break-system-packages
cd unicorn/bindings/python || exit 1
if [ -z "$VIRTUAL_ENV" ]; then
echo "[*] Info: Installing python unicornafl using --user"
- THREADS=$CORES $PYTHONBIN -m pip install --user --force .|| exit 1
+ THREADS=$CORES $PYTHONBIN -m pip install --user $XOPT --force .|| exit 1
else
echo "[*] Info: Installing python unicornafl to virtualenv: $VIRTUAL_ENV"
THREADS=$CORES $PYTHONBIN -m pip install --force .|| exit 1
@@ -211,7 +213,7 @@ echo "[*] Installing Unicornafl python bindings..."
cd bindings/python || exit 1
if [ -z "$VIRTUAL_ENV" ]; then
echo "[*] Info: Installing python unicornafl using --user"
- THREADS=$CORES $PYTHONBIN -m pip install --user --force .|| exit 1
+ THREADS=$CORES $PYTHONBIN -m pip install --user $XOPT --force .|| exit 1
else
echo "[*] Info: Installing python unicornafl to virtualenv: $VIRTUAL_ENV"
THREADS=$CORES $PYTHONBIN -m pip install --force .|| exit 1
diff --git a/unicorn_mode/helper_scripts/unicorn_dumper_gdb.py b/unicorn_mode/helper_scripts/unicorn_dumper_gdb.py
index 1ac4c9f3..a202ac0e 100644
--- a/unicorn_mode/helper_scripts/unicorn_dumper_gdb.py
+++ b/unicorn_mode/helper_scripts/unicorn_dumper_gdb.py
@@ -89,8 +89,8 @@ def dump_arch_info():
def dump_regs():
reg_state = {}
- for reg in current_arch.all_registers:
- reg_val = get_register(reg)
+ for reg in gef.arch.registers:
+ reg_val = gef.arch.register(reg)
reg_state[reg.strip().strip("$")] = reg_val
return reg_state
@@ -101,7 +101,9 @@ def dump_process_memory(output_dir):
final_segment_list = []
# GEF:
- vmmap = get_process_maps()
+ vmmap = gef.memory.maps
+ memory = GefMemoryManager()
+
if not vmmap:
print("No address mapping information found")
return final_segment_list
@@ -126,7 +128,7 @@ def dump_process_memory(output_dir):
if entry.is_readable() and not "(deleted)" in entry.path:
try:
# Compress and dump the content to a file
- seg_content = read_memory(entry.page_start, entry.size)
+ seg_content = memory.read(entry.page_start, entry.size)
if seg_content == None:
print(
"Segment empty: @0x{0:016x} (size:UNKNOWN) {1}".format(
diff --git a/unicorn_mode/helper_scripts/unicorn_dumper_pwndbg.py b/unicorn_mode/helper_scripts/unicorn_dumper_pwndbg.py
index 7e97f6a7..76eaf54f 100644
--- a/unicorn_mode/helper_scripts/unicorn_dumper_pwndbg.py
+++ b/unicorn_mode/helper_scripts/unicorn_dumper_pwndbg.py
@@ -111,12 +111,14 @@ def dump_regs():
reg_state = {}
for reg in pwndbg.gdblib.regs.all:
reg_val = pwndbg.gdblib.regs[reg]
+ if reg_val is None:
+ continue
# current dumper script looks for register values to be hex strings
# reg_str = "0x{:08x}".format(reg_val)
# if "64" in get_arch():
# reg_str = "0x{:016x}".format(reg_val)
# reg_state[reg.strip().strip('$')] = reg_str
- reg_state[reg.strip().strip("$")] = reg_val
+ reg_state[reg.strip().strip("$")] = int(reg_val)
return reg_state
diff --git a/unicorn_mode/helper_scripts/unicorn_loader.py b/unicorn_mode/helper_scripts/unicorn_loader.py
index c48a7572..a83e7000 100644
--- a/unicorn_mode/helper_scripts/unicorn_loader.py
+++ b/unicorn_mode/helper_scripts/unicorn_loader.py
@@ -21,10 +21,10 @@ import zlib
# Unicorn imports
from unicornafl import *
-from unicornafl.arm_const import *
-from unicornafl.arm64_const import *
-from unicornafl.x86_const import *
-from unicornafl.mips_const import *
+from unicorn.arm_const import *
+from unicorn.arm64_const import *
+from unicorn.x86_const import *
+from unicorn.mips_const import *
# If Capstone libraries are availible (only check once)
try:
@@ -87,9 +87,10 @@ class UnicornSimpleHeap(object):
_uc = None # Unicorn engine instance to interact with
_chunks = [] # List of all known chunks
+ _chunks_freed = [] # List of all freed chunks
_debug_print = False # True to print debug information
- def __init__(self, uc, debug_print=False):
+ def __init__(self, uc, debug_print=False, uaf_check=False):
self._uc = uc
self._debug_print = debug_print
@@ -101,12 +102,23 @@ class UnicornSimpleHeap(object):
# - Allocate at least 1 4k page of memory to make Unicorn happy
# - Add guard pages at the start and end of the region
total_chunk_size = UNICORN_PAGE_SIZE + ALIGN_PAGE_UP(size) + UNICORN_PAGE_SIZE
+
+ if size == 0:
+ return 0
+
# Gross but efficient way to find space for the chunk:
chunk = None
for addr in range(self.HEAP_MIN_ADDR, self.HEAP_MAX_ADDR, UNICORN_PAGE_SIZE):
try:
self._uc.mem_map(addr, total_chunk_size, UC_PROT_READ | UC_PROT_WRITE)
chunk = self.HeapChunk(addr, total_chunk_size, size)
+
+ if self.uaf_check:
+ for chunk_freed in self._chunks_freed:
+ if chunk_freed.is_buffer_in_chunk(chunk.data_addr, 1):
+ self._chunks_freed.remove(chunk_freed)
+ break
+
if self._debug_print:
print(
"Allocating 0x{0:x}-byte chunk @ 0x{1:016x}".format(
@@ -148,6 +160,9 @@ class UnicornSimpleHeap(object):
return new_chunk_addr
def free(self, addr):
+ if addr == 0:
+ return False
+
for chunk in self._chunks:
if chunk.is_buffer_in_chunk(addr, 1):
if self._debug_print:
@@ -157,9 +172,14 @@ class UnicornSimpleHeap(object):
)
)
self._uc.mem_unmap(chunk.actual_addr, chunk.total_size)
+
+ if self.uaf_check:
+ self._chunks_freed.append(chunk)
+
self._chunks.remove(chunk)
return True
- return False
+ # Freed an object that doesn't exist. Maybe 'dobule-free' or 'invalid free' vulnerability here.
+ self._uc.force_crash(UcError(UC_ERR_FETCH_UNMAPPED))
# Implements basic guard-page functionality
def __check_mem_access(self, uc, access, address, size, value, user_data):
@@ -179,6 +199,15 @@ class UnicornSimpleHeap(object):
# Force a memory-based crash
uc.force_crash(UcError(UC_ERR_READ_PROT))
+ if self.uaf_check:
+ for chunk in self._chunks_freed:
+ if address >= chunk.actual_addr and (
+ (address + size) <= (chunk.actual_addr + chunk.total_size)
+ ):
+ if chunk.is_buffer_in_chunk(address, size):
+ print("Use-after-free @ 0x{0:016x}".format(address))
+ uc.force_crash(UcError(UC_ERR_FETCH_UNMAPPED))
+
# ---------------------------
# ---- Loading function
diff --git a/utils/afl_network_proxy/GNUmakefile b/utils/afl_network_proxy/GNUmakefile
index 7c8c22ff..47d9a7d3 100644
--- a/utils/afl_network_proxy/GNUmakefile
+++ b/utils/afl_network_proxy/GNUmakefile
@@ -10,6 +10,7 @@ PROGRAMS = afl-network-client afl-network-server
HASH=\#
CFLAGS += -Wno-pointer-sign
+LDFLAGS += -ldl
ifdef STATIC
CFLAGS += -static
diff --git a/utils/bench/Makefile b/utils/bench/Makefile
new file mode 100644
index 00000000..e7d2f3a1
--- /dev/null
+++ b/utils/bench/Makefile
@@ -0,0 +1,8 @@
+all: hash
+
+hash: hash.c
+ gcc -O3 -mavx2 -march=native -I../../include -o hash hash.c
+
+clean:
+ rm -f hash
+
diff --git a/utils/bench/README.md b/utils/bench/README.md
new file mode 100644
index 00000000..772c117b
--- /dev/null
+++ b/utils/bench/README.md
@@ -0,0 +1,2 @@
+# Internal AFL++ benchmarking
+
diff --git a/utils/bench/hash.c b/utils/bench/hash.c
new file mode 100644
index 00000000..d4be0ab4
--- /dev/null
+++ b/utils/bench/hash.c
@@ -0,0 +1,53 @@
+#include <stdio.h>
+#include <stdint.h>
+#include <time.h>
+
+#define T1HA0_AESNI_AVAILABLE 1
+#define T1HA_USE_FAST_ONESHOT_READ 1
+#define T1HA_USE_INDIRECT_FUNCTIONS 1
+#define T1HA_IA32AES_NAME t1ha0_ia32aes
+#include "t1ha0_ia32aes_b.h"
+
+#define XXH_INLINE_ALL
+#include "xxhash.h"
+#undef XXH_INLINE_ALL
+
+int main() {
+
+ char *data = malloc(4097);
+ struct timespec start, end;
+ long long duration;
+ int i;
+ uint64_t res;
+
+ clock_gettime(CLOCK_MONOTONIC, &start);
+ for (i = 0; i < 100000000; ++i) {
+
+ res = XXH3_64bits(data, 4097);
+ memcpy(data + 16, (char *)&res, 8);
+
+ }
+
+ clock_gettime(CLOCK_MONOTONIC, &end);
+ duration = (end.tv_sec - start.tv_sec) * 1000000000LL +
+ (end.tv_nsec - start.tv_nsec);
+ printf("xxh3 duration: %lld ns\n", duration);
+
+ memset(data, 0, 4097);
+ clock_gettime(CLOCK_MONOTONIC, &start);
+ for (i = 0; i < 100000000; ++i) {
+
+ res = t1ha0_ia32aes(data, 4097);
+ memcpy(data + 16, (char *)&res, 8);
+
+ }
+
+ clock_gettime(CLOCK_MONOTONIC, &end);
+ duration = (end.tv_sec - start.tv_sec) * 1000000000LL +
+ (end.tv_nsec - start.tv_nsec);
+ printf("t1ha0_ia32aes duration: %lld ns\n", duration);
+
+ return 0;
+
+}
+
diff --git a/utils/persistent_mode/Makefile b/utils/persistent_mode/Makefile
index e348c46c..498aa3f8 100644
--- a/utils/persistent_mode/Makefile
+++ b/utils/persistent_mode/Makefile
@@ -7,4 +7,4 @@ document:
AFL_DONT_OPTIMIZE=1 ../../afl-clang-fast -D_AFL_DOCUMENT_MUTATIONS -o test-instr test-instr.c
clean:
- rm -f persistent_demo persistent_demo_new test-instr
+ rm -f persistent_demo persistent_demo_new persistent_demo_new_compat test-instr
diff --git a/utils/replay_record/Makefile b/utils/replay_record/Makefile
new file mode 100644
index 00000000..0d1cba92
--- /dev/null
+++ b/utils/replay_record/Makefile
@@ -0,0 +1,8 @@
+all:
+ test `grep '//[\s\t ]*#define[\s\t ]*AFL_PERSISTENT_RECORD' ../../include/config.h | wc -l` -eq 0 || (echo "AFL_PERSISTENT_RECORD must be enabled in config.h"; exit 1)
+ ../../afl-clang-fast -o persistent_demo_replay persistent_demo_replay.c
+ ${CC} -I ../../include -o persistent_demo_replay_compat persistent_demo_replay.c
+ ${CC} -g -I ../../include -DAFL_PERSISTENT_REPLAY_ARGPARSE -o persistent_demo_replay_argparse persistent_demo_replay.c
+
+clean:
+ rm -f persistent_demo_replay persistent_demo_replay_argparse persistent_demo_replay_compat
diff --git a/utils/replay_record/README.md b/utils/replay_record/README.md
new file mode 100644
index 00000000..6d72ca97
--- /dev/null
+++ b/utils/replay_record/README.md
@@ -0,0 +1,10 @@
+# AFL++ persistent record replay
+
+This persistent record replay demo showcases the `AFL_PERSISTENT_RECORD` replay functionality.
+
+The [Makefile](Makefile) will produce three binaries:
+ + persistent_demo_replay: uses afl-cc and makes use of the replay functionality included in the compiler runtime library
+ + persistent_demo_replay_compat: uses the [afl-record-compat.h](../../include/afl-record-compat.h) compatibility header to compile the same example without `afl-cc`
+ + persistent_demo_replay_argparse: makes use of `afl-record-compat.h`, and the Makefile defines `AFL_PERSISTENT_REPLAY_ARGPARSE` to test the replay functionality but parses the input file via a command-line argument (`@@`-style harness).
+
+For more information see [README.persistent_mode.md](../../instrumentation/README.persistent_mode.md). \ No newline at end of file
diff --git a/utils/replay_record/persistent_demo_replay.c b/utils/replay_record/persistent_demo_replay.c
new file mode 100644
index 00000000..6f6648f1
--- /dev/null
+++ b/utils/replay_record/persistent_demo_replay.c
@@ -0,0 +1,148 @@
+/*
+ american fuzzy lop++ - persistent mode example
+ --------------------------------------------
+
+ Originally written by Michal Zalewski
+
+ Copyright 2015 Google Inc. All rights reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at:
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ This file demonstrates the high-performance "persistent mode" that may be
+ suitable for fuzzing certain fast and well-behaved libraries, provided that
+ they are stateless or that their internal state can be easily reset
+ across runs.
+
+ To make this work, the library and this shim need to be compiled in LLVM
+ mode using afl-clang-fast (other compiler wrappers will *not* work).
+
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <signal.h>
+#include <string.h>
+#include <limits.h>
+
+#ifdef AFL_PERSISTENT_REPLAY_ARGPARSE
+ #include <sys/stat.h>
+ #include <fcntl.h>
+#endif
+
+/* this lets the source compile without afl-clang-fast/lto */
+#ifndef __AFL_FUZZ_TESTCASE_LEN
+ #include "afl-record-compat.h"
+#endif
+
+__AFL_FUZZ_INIT();
+
+/* Main entry point. */
+
+/* To ensure checks are not optimized out it is recommended to disable
+ code optimization for the fuzzer harness main() */
+#pragma clang optimize off
+#pragma GCC optimize("O0")
+
+int main(int argc, char **argv) {
+
+ ssize_t len; /* how much input did we read? */
+ unsigned char *buf; /* test case buffer pointer */
+
+#ifdef AFL_PERSISTENT_REPLAY_ARGPARSE
+ int fd;
+
+ if (argc < 2) { printf("Need an input file!"); }
+#endif
+
+ /* The number passed to __AFL_LOOP() controls the maximum number of
+ iterations before the loop exits and the program is allowed to
+ terminate normally. This limits the impact of accidental memory leaks
+ and similar hiccups. */
+
+ __AFL_INIT();
+
+#ifdef AFL_PERSISTENT_REPLAY_ARGPARSE
+ buf = malloc(1000);
+#else
+ buf = __AFL_FUZZ_TESTCASE_BUF; // this must be assigned before __AFL_LOOP!
+#endif
+
+ while (__AFL_LOOP(UINT_MAX)) { // increase if you have good stability
+
+#ifdef AFL_PERSISTENT_REPLAY_ARGPARSE
+ fd = open(argv[1], O_RDONLY);
+ len = read(fd, buf, 1000);
+ close(fd);
+#else
+ len = __AFL_FUZZ_TESTCASE_LEN; // do not use the macro directly in a call!
+#endif
+
+ // fprintf(stderr, "input: %zd \"%s\"\n", len, buf);
+
+ /* do we have enough data? */
+ if (len < 8) continue;
+
+ if (strcmp((char *)buf, "thisisateststring") == 0) printf("teststring\n");
+
+ if (buf[0] == 'f') {
+
+ printf("one\n");
+ if (buf[1] == 'o') {
+
+ printf("two\n");
+ if (buf[2] == 'o') {
+
+ printf("three\n");
+ if (buf[3] == '!') {
+
+ printf("four\n");
+ if (buf[4] == '!') {
+
+ printf("five\n");
+ if (buf[5] == '!') {
+
+ printf("six\n");
+ abort();
+
+ } else {
+
+ if (buf[5] == 'O') {
+
+ // hang
+ while (1) {
+
+ continue;
+
+ };
+
+ }
+
+ }
+
+ }
+
+ }
+
+ }
+
+ }
+
+ }
+
+ /*** END PLACEHOLDER CODE ***/
+
+ }
+
+ /* Once the loop is exited, terminate normally - AFL will restart the process
+ when this happens, with a clean slate when it comes to allocated memory,
+ leftover file descriptors, etc. */
+
+ return 0;
+
+}
+