zstd_compress_module.c File Reference

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/string.h>
#include <linux/zstd.h>
#include "common/zstd_deps.h"
#include "common/zstd_internal.h"

Macros
#define	ZSTD_FORWARD_IF_ERR(ret)

Functions
int	zstd_min_clevel (void)
	EXPORT_SYMBOL (zstd_min_clevel)
int	zstd_max_clevel (void)
	EXPORT_SYMBOL (zstd_max_clevel)
size_t	zstd_compress_bound (size_t src_size)
	EXPORT_SYMBOL (zstd_compress_bound)
zstd_parameters	zstd_get_params (int level, unsigned long long estimated_src_size)
	EXPORT_SYMBOL (zstd_get_params)
size_t	zstd_cctx_workspace_bound (const zstd_compression_parameters *cparams)
	EXPORT_SYMBOL (zstd_cctx_workspace_bound)
zstd_cctx *	zstd_init_cctx (void *workspace, size_t workspace_size)
	EXPORT_SYMBOL (zstd_init_cctx)
size_t	zstd_compress_cctx (zstd_cctx *cctx, void *dst, size_t dst_capacity, const void *src, size_t src_size, const zstd_parameters *parameters)
	EXPORT_SYMBOL (zstd_compress_cctx)
size_t	zstd_cstream_workspace_bound (const zstd_compression_parameters *cparams)
	EXPORT_SYMBOL (zstd_cstream_workspace_bound)
zstd_cstream *	zstd_init_cstream (const zstd_parameters *parameters, unsigned long long pledged_src_size, void *workspace, size_t workspace_size)
	EXPORT_SYMBOL (zstd_init_cstream)
size_t	zstd_reset_cstream (zstd_cstream *cstream, unsigned long long pledged_src_size)
	EXPORT_SYMBOL (zstd_reset_cstream)
size_t	zstd_compress_stream (zstd_cstream *cstream, zstd_out_buffer *output, zstd_in_buffer *input)
	EXPORT_SYMBOL (zstd_compress_stream)
size_t	zstd_flush_stream (zstd_cstream *cstream, zstd_out_buffer *output)
	EXPORT_SYMBOL (zstd_flush_stream)
size_t	zstd_end_stream (zstd_cstream *cstream, zstd_out_buffer *output)
	EXPORT_SYMBOL (zstd_end_stream)
	MODULE_LICENSE ("Dual BSD/GPL")
	MODULE_DESCRIPTION ("Zstd Compressor")

Macro Definition Documentation

ZSTD_FORWARD_IF_ERR

#define ZSTD_FORWARD_IF_ERR

(

ret

)

Value:

    do {                                \
        size_t const __ret = (ret); \
        if (ZSTD_isError(__ret))    \
            return __ret;       \
    } while (0)

Function Documentation

EXPORT_SYMBOL() [1/13]

EXPORT_SYMBOL

(

zstd_cctx_workspace_bound

)

EXPORT_SYMBOL() [2/13]

EXPORT_SYMBOL

(

zstd_compress_bound

)

EXPORT_SYMBOL() [3/13]

EXPORT_SYMBOL

(

zstd_compress_cctx

)

EXPORT_SYMBOL() [4/13]

EXPORT_SYMBOL

(

zstd_compress_stream

)

EXPORT_SYMBOL() [5/13]

EXPORT_SYMBOL

(

zstd_cstream_workspace_bound

)

EXPORT_SYMBOL() [6/13]

EXPORT_SYMBOL

(

zstd_end_stream

)

EXPORT_SYMBOL() [7/13]

EXPORT_SYMBOL

(

zstd_flush_stream

)

EXPORT_SYMBOL() [8/13]

EXPORT_SYMBOL

(

zstd_get_params

)

EXPORT_SYMBOL() [9/13]

EXPORT_SYMBOL

(

zstd_init_cctx

)

EXPORT_SYMBOL() [10/13]

EXPORT_SYMBOL

(

zstd_init_cstream

)

EXPORT_SYMBOL() [11/13]

EXPORT_SYMBOL

(

zstd_max_clevel

)

EXPORT_SYMBOL() [12/13]

EXPORT_SYMBOL

(

zstd_min_clevel

)

EXPORT_SYMBOL() [13/13]

EXPORT_SYMBOL

(

zstd_reset_cstream

)

MODULE_DESCRIPTION()

MODULE_DESCRIPTION

(

"Zstd Compressor"

)

MODULE_LICENSE()

MODULE_LICENSE

(

"Dual BSD/GPL"

)

zstd_cctx_workspace_bound()

size_t zstd_cctx_workspace_bound

(

const zstd_compression_parameters *

cparams

)

zstd_compress_bound()

size_t zstd_compress_bound

(

size_t

src_size

)

This is a kernel-style API that wraps the upstream zstd API, which cannot be used directly because the symbols aren't exported. It exposes the minimal functionality which is currently required by users of zstd in the kernel. Expose extra functions from lib/zstd/zstd.h as needed. zstd_compress_bound() - maximum compressed size in worst case scenario @src_size: The size of the data to compress.

Return: The maximum compressed size in the worst case scenario.

zstd_compress_cctx()

size_t zstd_compress_cctx	(	zstd_cctx *	cctx,
		void *	dst,
		size_t	dst_capacity,
		const void *	src,
		size_t	src_size,
		const zstd_parameters *	parameters )

zstd_compress_stream()

size_t zstd_compress_stream	(	zstd_cstream *	cstream,
		zstd_out_buffer *	output,
		zstd_in_buffer *	input )

zstd_cstream_workspace_bound()

size_t zstd_cstream_workspace_bound

(

const zstd_compression_parameters *

cparams

)

zstd_end_stream()

size_t zstd_end_stream	(	zstd_cstream *	cstream,
		zstd_out_buffer *	output )

zstd_flush_stream()

size_t zstd_flush_stream	(	zstd_cstream *	cstream,
		zstd_out_buffer *	output )

zstd_get_params()

zstd_parameters zstd_get_params	(	int	level,
		unsigned long long	estimated_src_size )

zstd_init_cctx()

zstd_cctx * zstd_init_cctx	(	void *	workspace,
		size_t	workspace_size )

zstd_init_cstream()

zstd_cstream * zstd_init_cstream	(	const zstd_parameters *	parameters,
		unsigned long long	pledged_src_size,
		void *	workspace,
		size_t	workspace_size )

zstd_max_clevel()

int zstd_max_clevel

(

void

)

zstd_min_clevel()

int zstd_min_clevel

(

void

)

zstd_reset_cstream()

size_t zstd_reset_cstream	(	zstd_cstream *	cstream,
		unsigned long long	pledged_src_size )