lib: zstd: Upgrade to latest upstream zstd version 1.4.10
Upgrade to the latest upstream zstd version 1.4.10.
This patch is 100% generated from upstream zstd commit 20821a46f412 [0].
This patch is very large because it is transitioning from the custom
kernel zstd to using upstream directly. The new zstd follows upstreams
file structure which is different. Future update patches will be much
smaller because they will only contain the changes from one upstream
zstd release.
As an aid for review I've created a commit [1] that shows the diff
between upstream zstd as-is (which doesn't compile), and the zstd
code imported in this patch. The verion of zstd in this patch is
generated from upstream with changes applied by automation to replace
upstreams libc dependencies, remove unnecessary portability macros,
replace `/**` comments with `/*` comments, and use the kernel's xxhash
instead of bundling it.
The benefits of this patch are as follows:
1. Using upstream directly with automated script to generate kernel
code. This allows us to update the kernel every upstream release, so
the kernel gets the latest bug fixes and performance improvements,
and doesn't get 3 years out of date again. The automation and the
translated code are tested every upstream commit to ensure it
continues to work.
2. Upgrades from a custom zstd based on 1.3.1 to 1.4.10, getting 3 years
of performance improvements and bug fixes. On x86_64 I've measured
15% faster BtrFS and SquashFS decompression+read speeds, 35% faster
kernel decompression, and 30% faster ZRAM decompression+read speeds.
3. Zstd-1.4.10 supports negative compression levels, which allow zstd to
match or subsume lzo's performance.
4. Maintains the same kernel-specific wrapper API, so no callers have to
be modified with zstd version updates.
One concern that was brought up was stack usage. Upstream zstd had
already removed most of its heavy stack usage functions, but I just
removed the last functions that allocate arrays on the stack. I've
measured the high water mark for both compression and decompression
before and after this patch. Decompression is approximately neutral,
using about 1.2KB of stack space. Compression levels up to 3 regressed
from 1.4KB -> 1.6KB, and higher compression levels regressed from 1.5KB
-> 2KB. We've added unit tests upstream to prevent further regression.
I believe that this is a reasonable increase, and if it does end up
causing problems, this commit can be cleanly reverted, because it only
touches zstd.
I chose the bulk update instead of replaying upstream commits because
there have been ~3500 upstream commits since the 1.3.1 release, zstd
wasn't ready to be used in the kernel as-is before a month ago, and not
all upstream zstd commits build. The bulk update preserves bisectablity
because bugs can be bisected to the zstd version update. At that point
the update can be reverted, and we can work with upstream to find and
fix the bug.
Note that upstream zstd release 1.4.10 doesn't exist yet. I have cut a
staging branch at 20821a46f412 [0] and will apply any changes requested
to the staging branch. Once we're ready to merge this update I will cut
a zstd release at the commit we merge, so we have a known zstd release
in the kernel.
The implementation of the kernel API is contained in
zstd_compress_module.c and zstd_decompress_module.c.
[0] https://github.com/facebook/zstd/commit/20821a46f4122f9abd7c7b245d28162dde8129c9
[1] https://github.com/terrelln/linux/commit/e0fa481d0e3df26918da0a13749740a1f6777574
Signed-off-by: Nick Terrell <terrelln@fb.com>
Tested By: Paul Jones <paul@pauljones.id.au>
Tested-by: Oleksandr Natalenko <oleksandr@natalenko.name>
Tested-by: Sedat Dilek <sedat.dilek@gmail.com> # LLVM/Clang v13.0.0 on x86-64
Tested-by: Jean-Denis Girard <jd.girard@sysnux.pf>
2020-09-12 07:37:08 +08:00
|
|
|
/*
|
|
|
|
* Copyright (c) Yann Collet, Facebook, Inc.
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* This source code is licensed under both the BSD-style license (found in the
|
|
|
|
* LICENSE file in the root directory of this source tree) and the GPLv2 (found
|
|
|
|
* in the COPYING file in the root directory of this source tree).
|
|
|
|
* You may select, at your option, one of the above-listed licenses.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef ZSTD_LDM_H
|
|
|
|
#define ZSTD_LDM_H
|
|
|
|
|
|
|
|
|
|
|
|
#include "zstd_compress_internal.h" /* ldmParams_t, U32 */
|
|
|
|
#include <linux/zstd.h> /* ZSTD_CCtx, size_t */
|
|
|
|
|
|
|
|
/*-*************************************
|
|
|
|
* Long distance matching
|
|
|
|
***************************************/
|
|
|
|
|
|
|
|
#define ZSTD_LDM_DEFAULT_WINDOW_LOG ZSTD_WINDOWLOG_LIMIT_DEFAULT
|
|
|
|
|
|
|
|
void ZSTD_ldm_fillHashTable(
|
|
|
|
ldmState_t* state, const BYTE* ip,
|
|
|
|
const BYTE* iend, ldmParams_t const* params);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* ZSTD_ldm_generateSequences():
|
|
|
|
*
|
|
|
|
* Generates the sequences using the long distance match finder.
|
|
|
|
* Generates long range matching sequences in `sequences`, which parse a prefix
|
|
|
|
* of the source. `sequences` must be large enough to store every sequence,
|
|
|
|
* which can be checked with `ZSTD_ldm_getMaxNbSeq()`.
|
|
|
|
* @returns 0 or an error code.
|
|
|
|
*
|
|
|
|
* NOTE: The user must have called ZSTD_window_update() for all of the input
|
|
|
|
* they have, even if they pass it to ZSTD_ldm_generateSequences() in chunks.
|
|
|
|
* NOTE: This function returns an error if it runs out of space to store
|
|
|
|
* sequences.
|
|
|
|
*/
|
|
|
|
size_t ZSTD_ldm_generateSequences(
|
|
|
|
ldmState_t* ldms, rawSeqStore_t* sequences,
|
|
|
|
ldmParams_t const* params, void const* src, size_t srcSize);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* ZSTD_ldm_blockCompress():
|
|
|
|
*
|
|
|
|
* Compresses a block using the predefined sequences, along with a secondary
|
|
|
|
* block compressor. The literals section of every sequence is passed to the
|
|
|
|
* secondary block compressor, and those sequences are interspersed with the
|
|
|
|
* predefined sequences. Returns the length of the last literals.
|
|
|
|
* Updates `rawSeqStore.pos` to indicate how many sequences have been consumed.
|
|
|
|
* `rawSeqStore.seq` may also be updated to split the last sequence between two
|
|
|
|
* blocks.
|
|
|
|
* @return The length of the last literals.
|
|
|
|
*
|
|
|
|
* NOTE: The source must be at most the maximum block size, but the predefined
|
|
|
|
* sequences can be any size, and may be longer than the block. In the case that
|
|
|
|
* they are longer than the block, the last sequences may need to be split into
|
|
|
|
* two. We handle that case correctly, and update `rawSeqStore` appropriately.
|
|
|
|
* NOTE: This function does not return any errors.
|
|
|
|
*/
|
|
|
|
size_t ZSTD_ldm_blockCompress(rawSeqStore_t* rawSeqStore,
|
|
|
|
ZSTD_matchState_t* ms, seqStore_t* seqStore, U32 rep[ZSTD_REP_NUM],
|
2022-10-18 04:32:37 +08:00
|
|
|
ZSTD_paramSwitch_e useRowMatchFinder,
|
lib: zstd: Upgrade to latest upstream zstd version 1.4.10
Upgrade to the latest upstream zstd version 1.4.10.
This patch is 100% generated from upstream zstd commit 20821a46f412 [0].
This patch is very large because it is transitioning from the custom
kernel zstd to using upstream directly. The new zstd follows upstreams
file structure which is different. Future update patches will be much
smaller because they will only contain the changes from one upstream
zstd release.
As an aid for review I've created a commit [1] that shows the diff
between upstream zstd as-is (which doesn't compile), and the zstd
code imported in this patch. The verion of zstd in this patch is
generated from upstream with changes applied by automation to replace
upstreams libc dependencies, remove unnecessary portability macros,
replace `/**` comments with `/*` comments, and use the kernel's xxhash
instead of bundling it.
The benefits of this patch are as follows:
1. Using upstream directly with automated script to generate kernel
code. This allows us to update the kernel every upstream release, so
the kernel gets the latest bug fixes and performance improvements,
and doesn't get 3 years out of date again. The automation and the
translated code are tested every upstream commit to ensure it
continues to work.
2. Upgrades from a custom zstd based on 1.3.1 to 1.4.10, getting 3 years
of performance improvements and bug fixes. On x86_64 I've measured
15% faster BtrFS and SquashFS decompression+read speeds, 35% faster
kernel decompression, and 30% faster ZRAM decompression+read speeds.
3. Zstd-1.4.10 supports negative compression levels, which allow zstd to
match or subsume lzo's performance.
4. Maintains the same kernel-specific wrapper API, so no callers have to
be modified with zstd version updates.
One concern that was brought up was stack usage. Upstream zstd had
already removed most of its heavy stack usage functions, but I just
removed the last functions that allocate arrays on the stack. I've
measured the high water mark for both compression and decompression
before and after this patch. Decompression is approximately neutral,
using about 1.2KB of stack space. Compression levels up to 3 regressed
from 1.4KB -> 1.6KB, and higher compression levels regressed from 1.5KB
-> 2KB. We've added unit tests upstream to prevent further regression.
I believe that this is a reasonable increase, and if it does end up
causing problems, this commit can be cleanly reverted, because it only
touches zstd.
I chose the bulk update instead of replaying upstream commits because
there have been ~3500 upstream commits since the 1.3.1 release, zstd
wasn't ready to be used in the kernel as-is before a month ago, and not
all upstream zstd commits build. The bulk update preserves bisectablity
because bugs can be bisected to the zstd version update. At that point
the update can be reverted, and we can work with upstream to find and
fix the bug.
Note that upstream zstd release 1.4.10 doesn't exist yet. I have cut a
staging branch at 20821a46f412 [0] and will apply any changes requested
to the staging branch. Once we're ready to merge this update I will cut
a zstd release at the commit we merge, so we have a known zstd release
in the kernel.
The implementation of the kernel API is contained in
zstd_compress_module.c and zstd_decompress_module.c.
[0] https://github.com/facebook/zstd/commit/20821a46f4122f9abd7c7b245d28162dde8129c9
[1] https://github.com/terrelln/linux/commit/e0fa481d0e3df26918da0a13749740a1f6777574
Signed-off-by: Nick Terrell <terrelln@fb.com>
Tested By: Paul Jones <paul@pauljones.id.au>
Tested-by: Oleksandr Natalenko <oleksandr@natalenko.name>
Tested-by: Sedat Dilek <sedat.dilek@gmail.com> # LLVM/Clang v13.0.0 on x86-64
Tested-by: Jean-Denis Girard <jd.girard@sysnux.pf>
2020-09-12 07:37:08 +08:00
|
|
|
void const* src, size_t srcSize);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* ZSTD_ldm_skipSequences():
|
|
|
|
*
|
|
|
|
* Skip past `srcSize` bytes worth of sequences in `rawSeqStore`.
|
|
|
|
* Avoids emitting matches less than `minMatch` bytes.
|
|
|
|
* Must be called for data that is not passed to ZSTD_ldm_blockCompress().
|
|
|
|
*/
|
|
|
|
void ZSTD_ldm_skipSequences(rawSeqStore_t* rawSeqStore, size_t srcSize,
|
|
|
|
U32 const minMatch);
|
|
|
|
|
|
|
|
/* ZSTD_ldm_skipRawSeqStoreBytes():
|
|
|
|
* Moves forward in rawSeqStore by nbBytes, updating fields 'pos' and 'posInSequence'.
|
|
|
|
* Not to be used in conjunction with ZSTD_ldm_skipSequences().
|
|
|
|
* Must be called for data with is not passed to ZSTD_ldm_blockCompress().
|
|
|
|
*/
|
|
|
|
void ZSTD_ldm_skipRawSeqStoreBytes(rawSeqStore_t* rawSeqStore, size_t nbBytes);
|
|
|
|
|
|
|
|
/* ZSTD_ldm_getTableSize() :
|
|
|
|
* Estimate the space needed for long distance matching tables or 0 if LDM is
|
|
|
|
* disabled.
|
|
|
|
*/
|
|
|
|
size_t ZSTD_ldm_getTableSize(ldmParams_t params);
|
|
|
|
|
|
|
|
/* ZSTD_ldm_getSeqSpace() :
|
|
|
|
* Return an upper bound on the number of sequences that can be produced by
|
|
|
|
* the long distance matcher, or 0 if LDM is disabled.
|
|
|
|
*/
|
|
|
|
size_t ZSTD_ldm_getMaxNbSeq(ldmParams_t params, size_t maxChunkSize);
|
|
|
|
|
|
|
|
/* ZSTD_ldm_adjustParameters() :
|
|
|
|
* If the params->hashRateLog is not set, set it to its default value based on
|
|
|
|
* windowLog and params->hashLog.
|
|
|
|
*
|
|
|
|
* Ensures that params->bucketSizeLog is <= params->hashLog (setting it to
|
|
|
|
* params->hashLog if it is not).
|
|
|
|
*
|
|
|
|
* Ensures that the minMatchLength >= targetLength during optimal parsing.
|
|
|
|
*/
|
|
|
|
void ZSTD_ldm_adjustParameters(ldmParams_t* params,
|
|
|
|
ZSTD_compressionParameters const* cParams);
|
|
|
|
|
|
|
|
|
|
|
|
#endif /* ZSTD_FAST_H */
|