1
0
mirror of https://github.com/facebook/zstd.git synced 2025-07-29 11:21:22 +03:00

[linux] Expose ZSTD_compressSequencesAndLiterals() in the kernel

Make the function ZSTD_compressSequencesAndLiterals() available in kernel
space. This will be used by Intel QAT driver.

Additionally, (1) expose the function ZSTD_CCtx_setParameter(), which is
required to set parameters before calling ZSTD_compressSequencesAndLiterals(),
(2) update the build process to include `compress/zstd_preSplit.o` and
(3) replace `asm/unaligned.h` with `linux/unaligned.h`.

Signed-off-by: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
This commit is contained in:
Giovanni Cabiddu
2025-01-21 18:52:46 +00:00
parent ab54285129
commit 92be4be810
6 changed files with 64 additions and 4 deletions

View File

@ -26,6 +26,7 @@ zstd_compress-y := \
compress/zstd_lazy.o \ compress/zstd_lazy.o \
compress/zstd_ldm.o \ compress/zstd_ldm.o \
compress/zstd_opt.o \ compress/zstd_opt.o \
compress/zstd_preSplit.o \
zstd_decompress-y := \ zstd_decompress-y := \
zstd_decompress_module.o \ zstd_decompress_module.o \

View File

@ -136,9 +136,20 @@ typedef ZSTD_parameters zstd_parameters;
zstd_parameters zstd_get_params(int level, zstd_parameters zstd_get_params(int level,
unsigned long long estimated_src_size); unsigned long long estimated_src_size);
/* ====== Single-pass Compression ====== */
typedef ZSTD_CCtx zstd_cctx; typedef ZSTD_CCtx zstd_cctx;
typedef ZSTD_cParameter zstd_cparameter;
/**
* zstd_cctx_set_param() - sets a compression parameter
* @cctx: The context. Must have been initialized with zstd_init_cctx().
* @param: The parameter to set.
* @value: The value to set the parameter to.
*
* Return: Zero or an error, which can be checked using zstd_is_error().
*/
size_t zstd_cctx_set_param(zstd_cctx *cctx, zstd_cparameter param, int value);
/* ====== Single-pass Compression ====== */
/** /**
* zstd_cctx_workspace_bound() - max memory needed to initialize a zstd_cctx * zstd_cctx_workspace_bound() - max memory needed to initialize a zstd_cctx
@ -480,4 +491,35 @@ typedef ZSTD_FrameHeader zstd_frame_header;
size_t zstd_get_frame_header(zstd_frame_header *params, const void *src, size_t zstd_get_frame_header(zstd_frame_header *params, const void *src,
size_t src_size); size_t src_size);
/**
* struct zstd_sequence - a sequence of literals or a match
*
* @offset: The offset of the match
* @litLength: The literal length of the sequence
* @matchLength: The match length of the sequence
* @rep: Represents which repeat offset is used
*/
typedef ZSTD_Sequence zstd_sequence;
/**
* zstd_compress_sequences_and_literals() - compress an array of zstd_sequence and literals
*
* @cctx: The zstd compression context.
* @dst: The buffer to compress the data into.
* @dst_capacity: The size of the destination buffer.
* @in_seqs: The array of zstd_sequence to compress.
* @in_seqs_size: The number of sequences in in_seqs.
* @literals: The literals associated to the sequences to be compressed.
* @lit_size: The size of the literals in the literals buffer.
* @lit_capacity: The size of the literals buffer.
* @decompressed_size: The size of the input data
*
* Return: The compressed size or an error, which can be checked using
* zstd_is_error().
*/
size_t zstd_compress_sequences_and_literals(zstd_cctx *cctx, void* dst, size_t dst_capacity,
const zstd_sequence *in_seqs, size_t in_seqs_size,
const void* literals, size_t lit_size, size_t lit_capacity,
size_t decompressed_size);
#endif /* LINUX_ZSTD_H */ #endif /* LINUX_ZSTD_H */

View File

@ -15,7 +15,7 @@
/*-**************************************** /*-****************************************
* Dependencies * Dependencies
******************************************/ ******************************************/
#include <asm/unaligned.h> /* get_unaligned, put_unaligned* */ #include <linux/unaligned.h> /* get_unaligned, put_unaligned* */
#include <linux/compiler.h> /* inline */ #include <linux/compiler.h> /* inline */
#include <linux/swab.h> /* swab32, swab64 */ #include <linux/swab.h> /* swab32, swab64 */
#include <linux/types.h> /* size_t, ptrdiff_t */ #include <linux/types.h> /* size_t, ptrdiff_t */

View File

@ -296,7 +296,7 @@ XXH_API void xxh64_copy_state(struct xxh64_state *dst, const struct xxh64_state
* - xxHash source repository: https://github.com/Cyan4973/xxHash * - xxHash source repository: https://github.com/Cyan4973/xxHash
*/ */
#include <asm/unaligned.h> #include <linux/unaligned.h>
#include <linux/errno.h> #include <linux/errno.h>
#include <linux/kernel.h> #include <linux/kernel.h>
#include <linux/module.h> #include <linux/module.h>

View File

@ -80,6 +80,12 @@ zstd_parameters zstd_get_params(int level,
} }
EXPORT_SYMBOL(zstd_get_params); EXPORT_SYMBOL(zstd_get_params);
size_t zstd_cctx_set_param(zstd_cctx *cctx, ZSTD_cParameter param, int value)
{
return ZSTD_CCtx_setParameter(cctx, param, value);
}
EXPORT_SYMBOL(zstd_cctx_set_param);
size_t zstd_cctx_workspace_bound(const zstd_compression_parameters *cparams) size_t zstd_cctx_workspace_bound(const zstd_compression_parameters *cparams)
{ {
return ZSTD_estimateCCtxSize_usingCParams(*cparams); return ZSTD_estimateCCtxSize_usingCParams(*cparams);
@ -216,5 +222,16 @@ void zstd_register_sequence_producer(
} }
EXPORT_SYMBOL(zstd_register_sequence_producer); EXPORT_SYMBOL(zstd_register_sequence_producer);
size_t zstd_compress_sequences_and_literals(zstd_cctx *cctx, void* dst, size_t dst_capacity,
const zstd_sequence *in_seqs, size_t in_seqs_size,
const void* literals, size_t lit_size, size_t lit_capacity,
size_t decompressed_size)
{
return ZSTD_compressSequencesAndLiterals(cctx, dst, dst_capacity, in_seqs,
in_seqs_size, literals, lit_size,
lit_capacity, decompressed_size);
}
EXPORT_SYMBOL(zstd_compress_sequences_and_literals);
MODULE_LICENSE("Dual BSD/GPL"); MODULE_LICENSE("Dual BSD/GPL");
MODULE_DESCRIPTION("Zstd Compressor"); MODULE_DESCRIPTION("Zstd Compressor");