Files
Vladislav Dronov 2c0c47121e zstd: Import upstream v1.5.7
JIRA: https://redhat.atlassian.net/browse/RHEL-115836
Upstream Status: merged into the upstream linux.git

commit 65d1f5507ed2c78c64fce40e44e5574a9419eb09
Author: Nick Terrell <terrelln@meta.com>
Date:   Sat Mar 8 12:09:33 2025 -0800

    zstd: Import upstream v1.5.7

    In addition to keeping the kernel's copy of zstd up to date, this update
    was requested by Intel to expose upstream's APIs that allow QAT to accelerate
    the LZ match finding stage of Zstd.

    This patch is imported from the upstream tag v1.5.7-kernel [0], which is signed
    with upstream's signing key EF8FE99528B52FFD [1]. It was imported from upstream
    using this command:

      export ZSTD=/path/to/repo/zstd/
      export LINUX=/path/to/repo/linux/
      cd "$ZSTD/contrib/linux-kernel"
      git checkout v1.5.7-kernel
      make import LINUX="$LINUX"

    This patch has been tested on x86-64, and has been boot tested with
    a zstd compressed kernel & initramfs on i386 and aarch64. I benchmarked
    the patch on x86-64 with gcc-14.2.1 on an Intel i9-9900K by measruing the
    performance of compressed filesystem reads and writes.

    Component,  Level,  Size delta, C. time delta,  D. time delta
    Btrfs    ,      1,      +0.00%,         -6.1%,          +1.4%
    Btrfs    ,      3,      +0.00%,         -9.8%,          +3.0%
    Btrfs    ,      5,      +0.00%,         +1.7%,          +1.4%
    Btrfs    ,      7,      +0.00%,         -1.9%,          +2.7%
    Btrfs    ,      9,      +0.00%,         -3.4%,          +3.7%
    Btrfs    ,     15,      +0.00%,         -0.3%,          +3.6%
    SquashFS ,      1,      +0.00%,           N/A,          +1.9%

    The major changes that impact the kernel use cases for each version are:

    v1.5.7: https://github.com/facebook/zstd/releases/tag/v1.5.7
    * Add zstd_compress_sequences_and_literals() for use by Intel's QAT driver
      to implement Zstd compression acceleration in the kernel.
    * Fix an underflow bug in 32-bit builds that can cause data corruption when
      processing more than 4GB of data with a single `ZSTD_CCtx` object, when an
      input crosses the 4GB boundry. I don't believe this impacts any current kernel
      use cases, because the `ZSTD_CCtx` is typically reconstructed between
      compressions.
    * Levels 1-4 see 5-10% compression speed improvements for inputs smaller than
      128KB.

    v1.5.6: https://github.com/facebook/zstd/releases/tag/v1.5.6
    * Improved compression ratio for the highest compression levels. I don't expect
      these see much use however, due to their slow speeds.

    v1.5.5: https://github.com/facebook/zstd/releases/tag/v1.5.5
    * Fix a rare corruption bug that can trigger on levels 13 and above.
    * Improve compression speed of levels 5-11 on incompressible data.

    v1.5.4: https://github.com/facebook/zstd/releases/tag/v1.5.4
    * Improve copmression speed of levels 5-11 on ARM.
    * Improve dictionary compression speed.

    Signed-off-by: Nick Terrell <terrelln@fb.com>

Signed-off-by: Vladislav Dronov <vdronov@redhat.com>
2026-07-08 19:22:28 +02:00

88 lines
3.4 KiB
C

/* SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause */
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
*
* This source code is licensed under both the BSD-style license (found in the
* LICENSE file in the root directory of this source tree) and the GPLv2 (found
* in the COPYING file in the root directory of this source tree).
* You may select, at your option, one of the above-listed licenses.
*/
#ifndef ZSTD_ERRORS_H_398273423
#define ZSTD_ERRORS_H_398273423
/* ===== ZSTDERRORLIB_API : control library symbols visibility ===== */
#define ZSTDERRORLIB_VISIBLE
#ifndef ZSTDERRORLIB_HIDDEN
# if (__GNUC__ >= 4) && !defined(__MINGW32__)
# define ZSTDERRORLIB_HIDDEN __attribute__ ((visibility ("hidden")))
# else
# define ZSTDERRORLIB_HIDDEN
# endif
#endif
#define ZSTDERRORLIB_API ZSTDERRORLIB_VISIBLE
/*-*********************************************
* Error codes list
*-*********************************************
* Error codes _values_ are pinned down since v1.3.1 only.
* Therefore, don't rely on values if you may link to any version < v1.3.1.
*
* Only values < 100 are considered stable.
*
* note 1 : this API shall be used with static linking only.
* dynamic linking is not yet officially supported.
* note 2 : Prefer relying on the enum than on its value whenever possible
* This is the only supported way to use the error list < v1.3.1
* note 3 : ZSTD_isError() is always correct, whatever the library version.
**********************************************/
typedef enum {
ZSTD_error_no_error = 0,
ZSTD_error_GENERIC = 1,
ZSTD_error_prefix_unknown = 10,
ZSTD_error_version_unsupported = 12,
ZSTD_error_frameParameter_unsupported = 14,
ZSTD_error_frameParameter_windowTooLarge = 16,
ZSTD_error_corruption_detected = 20,
ZSTD_error_checksum_wrong = 22,
ZSTD_error_literals_headerWrong = 24,
ZSTD_error_dictionary_corrupted = 30,
ZSTD_error_dictionary_wrong = 32,
ZSTD_error_dictionaryCreation_failed = 34,
ZSTD_error_parameter_unsupported = 40,
ZSTD_error_parameter_combination_unsupported = 41,
ZSTD_error_parameter_outOfBound = 42,
ZSTD_error_tableLog_tooLarge = 44,
ZSTD_error_maxSymbolValue_tooLarge = 46,
ZSTD_error_maxSymbolValue_tooSmall = 48,
ZSTD_error_cannotProduce_uncompressedBlock = 49,
ZSTD_error_stabilityCondition_notRespected = 50,
ZSTD_error_stage_wrong = 60,
ZSTD_error_init_missing = 62,
ZSTD_error_memory_allocation = 64,
ZSTD_error_workSpace_tooSmall= 66,
ZSTD_error_dstSize_tooSmall = 70,
ZSTD_error_srcSize_wrong = 72,
ZSTD_error_dstBuffer_null = 74,
ZSTD_error_noForwardProgress_destFull = 80,
ZSTD_error_noForwardProgress_inputEmpty = 82,
/* following error codes are __NOT STABLE__, they can be removed or changed in future versions */
ZSTD_error_frameIndex_tooLarge = 100,
ZSTD_error_seekableIO = 102,
ZSTD_error_dstBuffer_wrong = 104,
ZSTD_error_srcBuffer_wrong = 105,
ZSTD_error_sequenceProducer_failed = 106,
ZSTD_error_externalSequences_invalid = 107,
ZSTD_error_maxCode = 120 /* never EVER use this value directly, it can change in future versions! Use ZSTD_isError() instead */
} ZSTD_ErrorCode;
ZSTDERRORLIB_API const char* ZSTD_getErrorString(ZSTD_ErrorCode code); /*< Same as ZSTD_getErrorName, but using a `ZSTD_ErrorCode` enum argument */
#endif /* ZSTD_ERRORS_H_398273423 */