Changed the decoding loop to detect more invalid cases of corruption sooner #3677
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this allows detecting overflow events without a checksum.
to behave more like the regular decoding loop.
removed older decodeSequences
Cyan4973
changed the title
make a mock initialization to please the tool
terrelln
reviewed
Jun 20, 2023
|
I've measured on my devserver and measure a 2.5% regression with our version of clang, and a 4% regression with our version of gcc. I still have to measure on my home server. |
Not sure if you have access to multiple versions of these compilers, |
Unfortunately not. I'm okay landing this, I like the move of reload to decode sequence, it is logical and seems like it should be "good". When we get closer to a release, we could re-measure, and if we still notice a regression, we could attempt to recoup some of the loss. |
terrelln
approved these changes
Jun 23, 2023
anakinxc
pushed a commit
to secretflow/spu
that referenced
this pull request
Mar 27, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [com_github_facebook_zstd](https://togithub.com/facebook/zstd) | http_archive | patch | `v1.5.5` -> `v1.5.6` | --- ### Release Notes <details> <summary>facebook/zstd (com_github_facebook_zstd)</summary> ### [`v1.5.6`](https://togithub.com/facebook/zstd/releases/tag/v1.5.6): Zstandard v1.5.6 - Chrome Edition [Compare Source](https://togithub.com/facebook/zstd/compare/v1.5.5-kernel...v1.5.6) This release highlights the deployment of Google [Chrome 123](https://developer.chrome.com/blog/new-in-chrome-123), introducing `zstd-encoding` for Web traffic, introduced as a preferable option for compression of dynamic contents. With limited web server support for `zstd-encoding` due to its novelty, we are launching an updated Zstandard version to facilitate broader adoption. ##### New stable parameter `ZSTD_c_targetCBlockSize` Using `zstd` compression for large documents over the Internet, data is segmented into smaller blocks of up to 128 KB, for incremental updates. This is crucial for applications like Chrome that process parts of documents as they arrive. However, on slow or congested networks, there can be some brief unresponsiveness in the middle of a block transmission, delaying update. To mitigate such scenarios, `libzstd` introduces the new parameter `ZSTD_c_targetCBlockSize`, enabling the division of blocks into even smaller segments to enhance initial byte delivery speed. Activating this feature incurs a cost, both runtime (equivalent to -2% speed at level 8) and a slight compression efficiency decrease (<0.1%), but offers some interesting latency reduction, notably beneficial in areas with less powerful network infrastructure. ##### Granular binary size selection `libzstd` provides build customization, including options to compile only the compression or decompression modules, minimizing binary size. Enhanced in `v1.5.6` ([source](https://togithub.com/facebook/zstd/tree/dev/lib#modular-build)), it now allows for even finer control by enabling selective inclusion or exclusion of specific components within these modules. This advancement aids applications needing precise binary size management. ##### Miscellaneous Enhancements This release includes various minor enhancements and bug fixes to enhance user experience. Key updates include an expanded list of recognized compressed file suffixes for the `--exclude-compressed` flag, improving efficiency by skipping presumed incompressible content. Furthermore, compatibility has been broadened to include additional chipsets (`sparc64`, `ARM64EC`, `risc-v`) and operating systems (`QNX`, `AIX`, `Solaris`, `HP-UX`). #### Change Log api: Promote `ZSTD_c_targetCBlockSize` to Stable API by [@​felixhandte](https://togithub.com/felixhandte) api: new experimental `ZSTD_d_maxBlockSize` parameter, to reduce streaming decompression memory, by [@​terrelln](https://togithub.com/terrelln) perf: improve performance of param `ZSTD_c_targetCBlockSize`, by [@​Cyan4973](https://togithub.com/Cyan4973) perf: improved compression of arrays of integers at high compression, by [@​Cyan4973](https://togithub.com/Cyan4973) lib: reduce binary size with selective built-time exclusion, by [@​felixhandte](https://togithub.com/felixhandte) lib: improved huffman speed on small data and linux kernel, by [@​terrelln](https://togithub.com/terrelln) lib: accept dictionaries with partial literal tables, by [@​terrelln](https://togithub.com/terrelln) lib: fix CCtx size estimation with external sequence producer, by [@​embg](https://togithub.com/embg) lib: fix corner case decoder behaviors, by [@​Cyan4973](https://togithub.com/Cyan4973) and [@​aimuz](https://togithub.com/aimuz) lib: fix zdict prototype mismatch in static_only mode, by [@​ldv-alt](https://togithub.com/ldv-alt) lib: fix several bugs in magicless-format decoding, by [@​embg](https://togithub.com/embg) cli: add common compressed file types to `--exclude-compressed` by [@​daniellerozenblit](https://togithub.com/daniellerozenblit) (requested by [@​dcog989](https://togithub.com/dcog989)) cli: fix mixing `-c` and `-o` commands with `--rm`, by [@​Cyan4973](https://togithub.com/Cyan4973) cli: fix erroneous exclusion of hidden files with `--output-dir-mirror` by [@​felixhandte](https://togithub.com/felixhandte) cli: improved time accuracy on BSD, by [@​felixhandte](https://togithub.com/felixhandte) cli: better errors on argument parsing, by [@​KapJI](https://togithub.com/KapJI) tests: better compatibility with older versions of `grep`, by [@​Cyan4973](https://togithub.com/Cyan4973) tests: lorem ipsum generator as default content generator, by [@​Cyan4973](https://togithub.com/Cyan4973) build: cmake improvements by [@​terrelln](https://togithub.com/terrelln), [@​sighingnow](https://togithub.com/sighingnow), [@​gjasny](https://togithub.com/gjasny), [@​JohanMabille](https://togithub.com/JohanMabille), [@​Saverio976](https://togithub.com/Saverio976), [@​gruenich](https://togithub.com/gruenich), [@​teo-tsirpanis](https://togithub.com/teo-tsirpanis) build: bazel support, by [@​jondo2010](https://togithub.com/jondo2010) build: fix cross-compiling for AArch64 with lld by [@​jcelerier](https://togithub.com/jcelerier) build: fix Apple platform compatibility, by [@​nidhijaju](https://togithub.com/nidhijaju) build: fix Visual 2012 and lower compatibility, by [@​Cyan4973](https://togithub.com/Cyan4973) build: improve win32 support, by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) build: better C90 compliance for zlibWrapper, by [@​emaste](https://togithub.com/emaste) port: make: fat binaries on macos, by [@​mredig](https://togithub.com/mredig) port: ARM64EC compatibility for Windows, by [@​dunhor](https://togithub.com/dunhor) port: QNX support by [@​klausholstjacobsen](https://togithub.com/klausholstjacobsen) port: MSYS2 and Cygwin makefile installation and test support, by [@​QBos07](https://togithub.com/QBos07) port: risc-v support validation in CI, by [@​Cyan4973](https://togithub.com/Cyan4973) port: sparc64 support validation in CI, by [@​Cyan4973](https://togithub.com/Cyan4973) port: AIX compatibility, by [@​likema](https://togithub.com/likema) port: HP-UX compatibility, by [@​likema](https://togithub.com/likema) doc: Improved specification accuracy, by [@​elasota](https://togithub.com/elasota) bug: Fix and deprecate ZSTD_generateSequences ([#​3981](https://togithub.com/facebook/zstd/issues/3981)), by [@​terrelln](https://togithub.com/terrelln) #### Full change list (auto-generated) - Add win32 to windows-artifacts.yml by [@​Kim-SSi](https://togithub.com/Kim-SSi) in [facebook/zstd#3600 - Fix mmap-dict help output by [@​daniellerozenblit](https://togithub.com/daniellerozenblit) in [facebook/zstd#3601 - \[oss-fuzz] Fix simple_round_trip fuzzer with overlapping decompression by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3612 - Reduce streaming decompression memory by (128KB - blockSizeMax) by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3616 - removed travis & appveyor scripts by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3621 - Add ZSTD_d_maxBlockSize parameter by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3617 - \[doc] add decoder errata paragraph by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3620 - add makefile entry to build fat binary on macos by [@​mredig](https://togithub.com/mredig) in [facebook/zstd#3614 - Disable unused variable warning in msan configurations by [@​danlark1](https://togithub.com/danlark1) in [facebook/zstd#3624 [facebook/zstd#3634 - Allow Build-Time Exclusion of Individual Compression Strategies by [@​felixhandte](https://togithub.com/felixhandte) in [facebook/zstd#3623 - Get zstd working with ARM64EC on Windows by [@​dunhor](https://togithub.com/dunhor) in [facebook/zstd#3636 - minor : update streaming_compression example by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3631 - Fix UBSAN issue (zero addition to NULL) by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3658 - Add options in Makefile to cmake by [@​sighingnow](https://togithub.com/sighingnow) in [facebook/zstd#3657 - fix a minor inefficiency in compress_superblock by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3668 - Fixed a bug in the educational decoder by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3659 - changed LLU suffix into ULL for Visual 2012 and lower by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3664 - fixed decoder behavior when nbSeqs==0 is encoded using 2 bytes by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3669 - detect extraneous bytes in the Sequences section by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3674 - Bitstream produces only zeroes after an overflow event by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3676 - Update FreeBSD CI images to latest supported releases by [@​emaste](https://togithub.com/emaste) in [facebook/zstd#3684 - Clean up a false error message in the LDM debug log by [@​embg](https://togithub.com/embg) in [facebook/zstd#3686 - Hide ASM symbols on Apple platforms by [@​nidhijaju](https://togithub.com/nidhijaju) in [facebook/zstd#3688 - Changed the decoding loop to detect more invalid cases of corruption sooner by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3677 - Fix Intel Xcode builds with assembly by [@​gjasny](https://togithub.com/gjasny) in [facebook/zstd#3665 - Save one byte on the frame epilogue by [@​Coder-256](https://togithub.com/Coder-256) in [facebook/zstd#3700 - Update fileio.c: fix build failure with enabled LTO by [@​LocutusOfBorg](https://togithub.com/LocutusOfBorg) in [facebook/zstd#3695 - fileio_asyncio: handle malloc fails in AIO_ReadPool_create by [@​void0red](https://togithub.com/void0red) in [facebook/zstd#3704 - Fix typographical error in README.md by [@​nikohoffren](https://togithub.com/nikohoffren) in [facebook/zstd#3701 - Fixed typo by [@​alexsifivetw](https://togithub.com/alexsifivetw) in [facebook/zstd#3712 - Improve dual license wording in README by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3718 - Unpoison Workspace Memory Before Custom-Free by [@​felixhandte](https://togithub.com/felixhandte) in [facebook/zstd#3725 - added ZSTD_decompressDCtx() benchmark option to fullbench by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3726 - No longer reject dictionaries with literals maxSymbolValue < 255 by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3731 - fix: ZSTD_BUILD_DECOMPRESSION message by [@​0o001](https://togithub.com/0o001) in [facebook/zstd#3728 - Updated Makefiles for full MSYS2 and Cygwin installation and testing … by [@​QBos07](https://togithub.com/QBos07) in [facebook/zstd#3720 - Work around nullptr-with-nonzero-offset warning by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3738 - Fix & refactor Huffman repeat tables for dictionaries by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3737 - zdictlib: fix prototype mismatch by [@​ldv-alt](https://togithub.com/ldv-alt) in [facebook/zstd#3733 - Fixed zstd cmake shared build on windows by [@​JohanMabille](https://togithub.com/JohanMabille) in [facebook/zstd#3739 - Added qnx in the posix test section of platform.h by [@​klausholstjacobsen](https://togithub.com/klausholstjacobsen) in [facebook/zstd#3745 - added some documentation on ZSTD_estimate\*Size() variants by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3755 - Improve macro guards for ZSTD_assertValidSequence by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3770 - Stop suppressing pointer-overflow UBSAN errors by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3776 - fix x32 tests on Github CI by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3777 - Fix new typos found by codespell by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [facebook/zstd#3771 - Do not test WIN32, instead test \_WIN32 by [@​DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [facebook/zstd#3772 - Fix a very small formatting typo in the lib/README.md file by [@​dloidolt](https://togithub.com/dloidolt) in [facebook/zstd#3763 - Fix pzstd Makefile to allow setting `DESTDIR` and `BINDIR` separately by [@​paulmenzel](https://togithub.com/paulmenzel) in [facebook/zstd#3752 - Remove FlexArray pattern from ZSTDMT by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3786 - solving flexArray issue [#​3785](https://togithub.com/facebook/zstd/issues/3785) in fse by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3789 - Add doc on how to use it with cmake FetchContent by [@​Saverio976](https://togithub.com/Saverio976) in [facebook/zstd#3795 - Correct FSE probability bit consumption in specification by [@​elasota](https://togithub.com/elasota) in [facebook/zstd#3806 - Add Bazel module instructions to README.md by [@​jondo2010](https://togithub.com/jondo2010) in [facebook/zstd#3812 - Clarify that a stream containing too many Huffman weights is invalid by [@​elasota](https://togithub.com/elasota) in [facebook/zstd#3813 - \[cmake] Require CMake version 3.5 or newer by [@​gruenich](https://togithub.com/gruenich) in [facebook/zstd#3807 - Three fixes for the Linux kernel by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3822 - \[huf] Improve fast huffman decoding speed in linux kernel by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3826 - \[huf] Improve fast C & ASM performance on small data by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3827 - update xxhash library to v0.8.2 by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3820 - Modernize macros to use `do { } while (0)` by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3831 - Clarify that the presence of weight value 1 is required, and a lone implied 1 weight is invalid by [@​elasota](https://togithub.com/elasota) in [facebook/zstd#3814 - Move offload API params into ZSTD_CCtx_params by [@​embg](https://togithub.com/embg) in [facebook/zstd#3839 - Update FreeBSD CI: drop 12.4 (nearly EOL) by [@​emaste](https://togithub.com/emaste) in [facebook/zstd#3845 - Make offload API compatible with static CCtx by [@​embg](https://togithub.com/embg) in [facebook/zstd#3854 - zlibWrapper: convert to C89 / ANSI C by [@​emaste](https://togithub.com/emaste) in [facebook/zstd#3846 - Fix a nullptr dereference in ZSTD_createCDict_advanced2() by [@​michoecho](https://togithub.com/michoecho) in [facebook/zstd#3847 - Cirrus-CI: Add FreeBSD 14 by [@​emaste](https://togithub.com/emaste) in [facebook/zstd#3855 - CI: meson: use builtin handling for MSVC by [@​eli-schwartz](https://togithub.com/eli-schwartz) in [facebook/zstd#3858 - cli: better errors on argument parsing by [@​KapJI](https://togithub.com/KapJI) in [facebook/zstd#3850 - Clarify that probability tables must not contain non-zero probabilities for invalid values by [@​elasota](https://togithub.com/elasota) in [facebook/zstd#3817 - \[x-compile] Fix cross-compiling for AArch64 with lld by [@​jcelerier](https://togithub.com/jcelerier) in [facebook/zstd#3760 - playTests.sh does no longer needs grep -E by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3865 - minor: playTests.sh more compatible with older versions of grep by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3877 - disable Intel CET Compatibility tests by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3884 - improve cmake test by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3883 - add sparc64 compilation test by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3886 - add a lorem ipsum generator by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3890 - Update Dependency in Intel CET Test; Re-Enable Test by [@​felixhandte](https://togithub.com/felixhandte) in [facebook/zstd#3893 - Improve compression of Arrays of Integers (High compression mode) by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3895 - \[Zstd] Less verbose log for patch mode. by [@​sandreenko](https://togithub.com/sandreenko) in [facebook/zstd#3899 - fix [`5921623`](https://togithub.com/facebook/zstd/commit/5921623844651008) by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3900 - Fix fuzz issue [`5131069`](https://togithub.com/facebook/zstd/commit/5131069967892480) by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3902 - Advertise Availability of Security Vulnerability Notifications by [@​felixhandte](https://togithub.com/felixhandte) in [facebook/zstd#3909 - updated setup-msys2 to v2.22.0 by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3914 - Lorem Ipsum generator update by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3913 - Reduce scope of variables by [@​gruenich](https://togithub.com/gruenich) in [facebook/zstd#3903 - Improve speed of ZSTD_c_targetCBlockSize by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3915 - More regular block sizes with `targetCBlockSize` by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3917 - removed sprintf usage from zstdcli.c by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3916 - Export a `zstd::libzstd` CMake target if only static or dynamic linkage is specified. by [@​teo-tsirpanis](https://togithub.com/teo-tsirpanis) in [facebook/zstd#3811 - fix version of actions/checkout by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3926 - minor Makefile refactoring by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3753 - lib/decompress: check for reserved bit corruption in zstd by [@​aimuz](https://togithub.com/aimuz) in [facebook/zstd#3840 - Fix state table formatting by [@​elasota](https://togithub.com/elasota) in [facebook/zstd#3816 - Specify offset 0 as invalid and specify required fixup behavior by [@​elasota](https://togithub.com/elasota) in [facebook/zstd#3824 - update -V documentation by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3928 - fix LLU->ULL by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3929 - Fix building xxhash on AIX 5.1 by [@​likema](https://togithub.com/likema) in [facebook/zstd#3860 - Fix building on HP-UX 11.11 PA-RISC by [@​likema](https://togithub.com/likema) in [facebook/zstd#3862 - Fix AsyncIO reading seed queueing by [@​yoniko](https://togithub.com/yoniko) in [facebook/zstd#3940 - Use ZSTD_LEGACY_SUPPORT=5 in "make test" by [@​embg](https://togithub.com/embg) in [facebook/zstd#3943 - Pin sanitizer CI jobs to ubuntu-20.04 by [@​embg](https://togithub.com/embg) in [facebook/zstd#3945 - chore: fix some typos by [@​acceptacross](https://togithub.com/acceptacross) in [facebook/zstd#3949 - new method to deal with offset==0 erroneous edge case by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3937 - add tests inspired from [#​2927](https://togithub.com/facebook/zstd/issues/2927) by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3948 - cmake refactor: move HP-UX specific logic into its own function by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3946 - Fix [#​3719](https://togithub.com/facebook/zstd/issues/3719) : mixing -c, -o and --rm by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3942 - minor: fix incorrect debug level by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3936 - add RISC-V emulation tests to Github CI by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3934 - prevent XXH64 from being autovectorized by XXH512 by default by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3933 - Stop Hardcoding the POSIX Version on BSDs by [@​felixhandte](https://togithub.com/felixhandte) in [facebook/zstd#3952 - Convert the CircleCI workflow to a GitHub Actions workflow by [@​jk0](https://togithub.com/jk0) in [facebook/zstd#3901 - Add common compressed file types to --exclude-compressed by [@​daniellerozenblit](https://togithub.com/daniellerozenblit) in [facebook/zstd#3951 - Export ZSTD_LEGACY_SUPPORT in tests/Makefile by [@​embg](https://togithub.com/embg) in [facebook/zstd#3955 - Exercise ZSTD_findDecompressedSize() in the simple decompression fuzzer by [@​embg](https://togithub.com/embg) in [facebook/zstd#3959 - Update `ZSTD_RowFindBestMatch` comment by [@​yoniko](https://togithub.com/yoniko) in [facebook/zstd#3947 - Add the zeroSeq sample by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3954 - \[cpu] Backport fix for rbx clobbering on Windows with Clang by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3957 - Do not truncate file name in verbose mode by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3956 - updated documentation by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3958 - \[asm]\[aarch64] Mark that BTI and PAC are supported by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3961 - Use `utimensat()` on FreeBSD by [@​felixhandte](https://togithub.com/felixhandte) in [facebook/zstd#3960 - reduce the amount of #include in cover.h by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3962 - Remove Erroneous Exclusion of Hidden Files and Folders in `--output-dir-mirror` by [@​felixhandte](https://togithub.com/felixhandte) in [facebook/zstd#3963 - Promote `ZSTD_c_targetCBlockSize` Parameter to Stable API by [@​felixhandte](https://togithub.com/felixhandte) in [facebook/zstd#3964 - \[cmake] Always create libzstd target by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3965 - Remove incorrect docs regarding ZSTD_findFrameCompressedSize() by [@​embg](https://togithub.com/embg) in [facebook/zstd#3967 - add line number to debug traces by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3966 - bump version number by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3969 - Export zstd's public headers via BUILD_INTERFACE by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3968 - Fix bug with streaming decompression of magicless format by [@​embg](https://togithub.com/embg) in [facebook/zstd#3971 - pzstd: use c++14 without conditions by [@​kanavin](https://togithub.com/kanavin) in [facebook/zstd#3682 - Fix bugs in simple decompression fuzzer by [@​yoniko](https://togithub.com/yoniko) in [facebook/zstd#3978 - Fuzzing and bugfixes for magicless-format decoding by [@​embg](https://togithub.com/embg) in [facebook/zstd#3976 - Fix & fuzz ZSTD_generateSequences by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3981 - Fail on errors when building fuzzers by [@​yoniko](https://togithub.com/yoniko) in [facebook/zstd#3979 - \[cmake] Emit warnings for contradictory build settings by [@​terrelln](https://togithub.com/terrelln) in [facebook/zstd#3975 - Document the process for adding a new fuzzer by [@​embg](https://togithub.com/embg) in [facebook/zstd#3982 - Fix -Werror=pointer-arith in fuzzers by [@​embg](https://togithub.com/embg) in [facebook/zstd#3983 - Doc update by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3977 - v1.5.6 by [@​Cyan4973](https://togithub.com/Cyan4973) in [facebook/zstd#3984 #### New Contributors - [@​Kim-SSi](https://togithub.com/Kim-SSi) made their first contribution in [facebook/zstd#3600 - [@​mredig](https://togithub.com/mredig) made their first contribution in [facebook/zstd#3614 - [@​dunhor](https://togithub.com/dunhor) made their first contribution in [facebook/zstd#3636 - [@​sighingnow](https://togithub.com/sighingnow) made their first contribution in [facebook/zstd#3657 - [@​nidhijaju](https://togithub.com/nidhijaju) made their first contribution in [facebook/zstd#3688 - [@​gjasny](https://togithub.com/gjasny) made their first contribution in [facebook/zstd#3665 - [@​Coder-256](https://togithub.com/Coder-256) made their first contribution in [facebook/zstd#3700 - [@​LocutusOfBorg](https://togithub.com/LocutusOfBorg) made their first contribution in [facebook/zstd#3695 - [@​void0red](https://togithub.com/void0red) made their first contribution in [facebook/zstd#3704 - [@​nikohoffren](https://togithub.com/nikohoffren) made their first contribution in [facebook/zstd#3701 - [@​alexsifivetw](https://togithub.com/alexsifivetw) made their first contribution in [facebook/zstd#3712 - [@​0o001](https://togithub.com/0o001) made their first contribution in [facebook/zstd#3728 - [@​QBos07](https://togithub.com/QBos07) made their first contribution in [facebook/zstd#3720 - [@​JohanMabille](https://togithub.com/JohanMabille) made their first contribution in [facebook/zstd#3739 - [@​klausholstjacobsen](https://togithub.com/klausholstjacobsen) made their first contribution in [facebook/zstd#3745 - [@​Saverio976](https://togithub.com/Saverio976) made their first contribution in [facebook/zstd#3795 - [@​elasota](https://togithub.com/elasota) made their first contribution in [facebook/zstd#3806 - [@​jondo2010](https://togithub.com/jondo2010) made their first contribution in [facebook/zstd#3812 - [@​gruenich](https://togithub.com/gruenich) made their first contribution in [facebook/zstd#3807 - [@​michoecho](https://togithub.com/michoecho) made their first contribution in [facebook/zstd#3847 - [@​KapJI](https://togithub.com/KapJI) made their first contribution in [facebook/zstd#3850 - [@​jcelerier](https://togithub.com/jcelerier) made their first contribution in [facebook/zstd#3760 - [@​sandreenko](https://togithub.com/sandreenko) made their first contribution in [facebook/zstd#3899 - [@​teo-tsirpanis](https://togithub.com/teo-tsirpanis) made their first contribution in [facebook/zstd#3811 - [@​aimuz](https://togithub.com/aimuz) made their first contribution in [facebook/zstd#3840 - [@​acceptacross](https://togithub.com/acceptacross) made their first contribution in [facebook/zstd#3949 - [@​jk0](https://togithub.com/jk0) made their first contribution in [facebook/zstd#3901 **Full Changelog**: facebook/zstd@v1.5.5...v1.5.6 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/secretflow/spu). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main objective of this PR is to detect an additional invalid case of corruption without reliance on the checksum.
For the record, many cases of corruption are possible, of several of them are undetectable, except by the final checksum.
Even for those which are theoretically detectable, such detection must remain practical, i.e. not cost a lot of performance nor increase complexity too much.
This is one of them. Prior attempts to add this one corruption case to the list of early-detected ones were unsuccessful, as they lead to more complex code on top of slower decompression speed. Upon discussion with @ip7z, I decided to have another look at the topic.
The newly proposed change fixes the issue, and imho makes the code better (i.e. more readable) for maintenance. To achieve this, I had to modify the main decoding loop, impacting the scope and interface of
decodeSequencefunction. All decoding loops were impacted, though the changes are more pronounced for thesplitLitBuffervariant .In term of performance, the outcome is mixed.
As expected, modifying the hottest loop in the code is bound to impact performance measurably, even if the generated assembly is modified in a minor way. We also know that this code is incredibly sensitive to Instruction Alignments side-effects, which are essentially random, so we expect fairly large swings in either direction.
To verify this, the decompression speed of this patch was benched on a
i7-9700kworkstation with several different compilers and versions. Here is the detailed outcome, comparing this commit (left) withdevbranch (right) :As expected, performance changes were essentially random, depending on compiler version. One could say they are rather more favorable and more stable for
gcc, and rather defavorable forclang, mostly due to 2 bad versions. But this is just because the starting point of these comparisons (devbranch) was also randomly impacted by instruction alignments, and was a bit more detrimental togccbaseline, and more advantageous toclang.So far, no surprise, nothing conclusive. It's just a pity that such a setup doesn't allow us to detect small changes (~1% range) with confidence due to the much larger random impact of instruction alignment.
To complete the picture, I'm adding tests for the M1 Pro platform. As the cpu architecture is radically different, I was hoping that issues such as random instruction alignments impact would not be present there.
I was too optimistic.
The effect of this change is pretty positive when compiling with default system compiler (
Apple clang version 14.0.3 (clang-1403.0.22.14.1)) :This is a non-negligible +4-5% decompression speed performance across the board, not bad !
Unfortunately, the trend reverses when using
gcc, provided bybrew:Now we are talking a pretty severe 10-12% decompression speed drop compared to
dev!This is a pretty large drop.
Yet, there are a few considerations.
To begin with, the performance of
gccondevbranch is exceptionally stellar. We are talking about a ~+20% performance advantage overclang! This is impressive.Even after the change, were
clanggains +4-5% whilegccloses-10-12%,gccis still in the lead, though by a reduced margin of+2-3%.This makes me wonder where does the exceptional performance of
gccondevbranch comes from.This could be due to one or a combination of effects. Come to mind :
C.gccwas simply "lucky" when generating thedevbinary, and no longer after the change.gccmight have performance heuristics that happen to work well with previous decoding loop, but do no longer get triggered properly after the change introduced by this patch.Given that all 3
gccversions tested have the same behavior, the explanation 2) feels a bit more likely. In which case, it would be interesting to understand why, and find a mitigation which allowsgccto shine again. But this is difficult to investigate. There is no equivalent toperfcounter onmacos. I presume understanding the performance profile of the generated binary implies better proficiency withXcodetooling, andXcodemight be tied toclang.Now, to be fair, on
macosM1 Pro, I would also expectclangto be a more common compiler thatgcc, makingclangresults a bit more important for this platform.To summarize, if we ignore performance results or consider them non-conclusive, I am in favor of this PR, because :
I believe that both of these properties are desirable.