linux_zstd.h

Go to the documentation of this file.

/* 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 https://github.com/facebook/zstd) and
 * the GPLv2 (found in the COPYING file in the root directory of
 * https://github.com/facebook/zstd). You may select, at your option, one of the
 * above-listed licenses.
 */
 
#ifndef LINUX_ZSTD_H
#define LINUX_ZSTD_H
 
/* ======   Dependency   ====== */
#include <linux/types.h>
#include <linux/zstd_errors.h>
#include <linux/zstd_lib.h>
 
/* ======   Helper Functions   ====== */
size_t zstd_compress_bound(size_t src_size);
 
unsigned int zstd_is_error(size_t code);
 
typedef ZSTD_ErrorCode zstd_error_code;
 
zstd_error_code zstd_get_error_code(size_t code);
 
const char *zstd_get_error_name(size_t code);
 
int zstd_min_clevel(void);
 
int zstd_max_clevel(void);
 
/* ======   Parameter Selection   ====== */
 
typedef ZSTD_strategy zstd_strategy;
 
typedef ZSTD_compressionParameters zstd_compression_parameters;
 
typedef ZSTD_frameParameters zstd_frame_parameters;
 
typedef ZSTD_parameters zstd_parameters;
 
zstd_parameters zstd_get_params(int level,
    unsigned long long estimated_src_size);
 
/* ======   Single-pass Compression   ====== */
 
typedef ZSTD_CCtx zstd_cctx;
 
size_t zstd_cctx_workspace_bound(const zstd_compression_parameters *parameters);
 
zstd_cctx *zstd_init_cctx(void *workspace, size_t workspace_size);
 
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);
 
/* ======   Single-pass Decompression   ====== */
 
typedef ZSTD_DCtx zstd_dctx;
 
size_t zstd_dctx_workspace_bound(void);
 
zstd_dctx *zstd_init_dctx(void *workspace, size_t workspace_size);
 
size_t zstd_decompress_dctx(zstd_dctx *dctx, void *dst, size_t dst_capacity,
    const void *src, size_t src_size);
 
/* ======   Streaming Buffers   ====== */
 
typedef ZSTD_inBuffer zstd_in_buffer;
 
typedef ZSTD_outBuffer zstd_out_buffer;
 
/* ======   Streaming Compression   ====== */
 
typedef ZSTD_CStream zstd_cstream;
 
size_t zstd_cstream_workspace_bound(const zstd_compression_parameters *cparams);
 
zstd_cstream *zstd_init_cstream(const zstd_parameters *parameters,
    unsigned long long pledged_src_size, void *workspace, size_t workspace_size);
 
size_t zstd_reset_cstream(zstd_cstream *cstream,
    unsigned long long pledged_src_size);
 
size_t zstd_compress_stream(zstd_cstream *cstream, zstd_out_buffer *output,
    zstd_in_buffer *input);
 
size_t zstd_flush_stream(zstd_cstream *cstream, zstd_out_buffer *output);
 
size_t zstd_end_stream(zstd_cstream *cstream, zstd_out_buffer *output);
 
/* ======   Streaming Decompression   ====== */
 
typedef ZSTD_DStream zstd_dstream;
 
size_t zstd_dstream_workspace_bound(size_t max_window_size);
 
zstd_dstream *zstd_init_dstream(size_t max_window_size, void *workspace,
    size_t workspace_size);
 
size_t zstd_reset_dstream(zstd_dstream *dstream);
 
size_t zstd_decompress_stream(zstd_dstream *dstream, zstd_out_buffer *output,
    zstd_in_buffer *input);
 
/* ======   Frame Inspection Functions ====== */
 
size_t zstd_find_frame_compressed_size(const void *src, size_t src_size);
 
typedef ZSTD_frameHeader zstd_frame_header;
 
size_t zstd_get_frame_header(zstd_frame_header *params, const void *src,
    size_t src_size);
 
#endif  /* LINUX_ZSTD_H */