lib/zstd/zstd_compress_module.c

0001 // SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
0002 /*
0003  * Copyright (c) Facebook, Inc.
0004  * All rights reserved.
0005  *
0006  * This source code is licensed under both the BSD-style license (found in the
0007  * LICENSE file in the root directory of this source tree) and the GPLv2 (found
0008  * in the COPYING file in the root directory of this source tree).
0009  * You may select, at your option, one of the above-listed licenses.
0010  */
0011
0012 #include <linux/kernel.h>
0013 #include <linux/module.h>
0014 #include <linux/string.h>
0015 #include <linux/zstd.h>
0016
0017 #include "common/zstd_deps.h"
0018 #include "common/zstd_internal.h"
0019
0020 #define ZSTD_FORWARD_IF_ERR(ret)            \
0021     do {                                \
0022         size_t const __ret = (ret); \
0023         if (ZSTD_isError(__ret))    \
0024             return __ret;       \
0025     } while (0)
0026
0027 static size_t zstd_cctx_init(zstd_cctx *cctx, const zstd_parameters *parameters,
0028     unsigned long long pledged_src_size)
0029 {
0030     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_reset(
0031         cctx, ZSTD_reset_session_and_parameters));
0032     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setPledgedSrcSize(
0033         cctx, pledged_src_size));
0034     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setParameter(
0035         cctx, ZSTD_c_windowLog, parameters->cParams.windowLog));
0036     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setParameter(
0037         cctx, ZSTD_c_hashLog, parameters->cParams.hashLog));
0038     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setParameter(
0039         cctx, ZSTD_c_chainLog, parameters->cParams.chainLog));
0040     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setParameter(
0041         cctx, ZSTD_c_searchLog, parameters->cParams.searchLog));
0042     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setParameter(
0043         cctx, ZSTD_c_minMatch, parameters->cParams.minMatch));
0044     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setParameter(
0045         cctx, ZSTD_c_targetLength, parameters->cParams.targetLength));
0046     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setParameter(
0047         cctx, ZSTD_c_strategy, parameters->cParams.strategy));
0048     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setParameter(
0049         cctx, ZSTD_c_contentSizeFlag, parameters->fParams.contentSizeFlag));
0050     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setParameter(
0051         cctx, ZSTD_c_checksumFlag, parameters->fParams.checksumFlag));
0052     ZSTD_FORWARD_IF_ERR(ZSTD_CCtx_setParameter(
0053         cctx, ZSTD_c_dictIDFlag, !parameters->fParams.noDictIDFlag));
0054     return 0;
0055 }
0056
0057 int zstd_min_clevel(void)
0058 {
0059     return ZSTD_minCLevel();
0060 }
0061 EXPORT_SYMBOL(zstd_min_clevel);
0062
0063 int zstd_max_clevel(void)
0064 {
0065     return ZSTD_maxCLevel();
0066 }
0067 EXPORT_SYMBOL(zstd_max_clevel);
0068
0069 size_t zstd_compress_bound(size_t src_size)
0070 {
0071     return ZSTD_compressBound(src_size);
0072 }
0073 EXPORT_SYMBOL(zstd_compress_bound);
0074
0075 zstd_parameters zstd_get_params(int level,
0076     unsigned long long estimated_src_size)
0077 {
0078     return ZSTD_getParams(level, estimated_src_size, 0);
0079 }
0080 EXPORT_SYMBOL(zstd_get_params);
0081
0082 size_t zstd_cctx_workspace_bound(const zstd_compression_parameters *cparams)
0083 {
0084     return ZSTD_estimateCCtxSize_usingCParams(*cparams);
0085 }
0086 EXPORT_SYMBOL(zstd_cctx_workspace_bound);
0087
0088 zstd_cctx *zstd_init_cctx(void *workspace, size_t workspace_size)
0089 {
0090     if (workspace == NULL)
0091         return NULL;
0092     return ZSTD_initStaticCCtx(workspace, workspace_size);
0093 }
0094 EXPORT_SYMBOL(zstd_init_cctx);
0095
0096 size_t zstd_compress_cctx(zstd_cctx *cctx, void *dst, size_t dst_capacity,
0097     const void *src, size_t src_size, const zstd_parameters *parameters)
0098 {
0099     ZSTD_FORWARD_IF_ERR(zstd_cctx_init(cctx, parameters, src_size));
0100     return ZSTD_compress2(cctx, dst, dst_capacity, src, src_size);
0101 }
0102 EXPORT_SYMBOL(zstd_compress_cctx);
0103
0104 size_t zstd_cstream_workspace_bound(const zstd_compression_parameters *cparams)
0105 {
0106     return ZSTD_estimateCStreamSize_usingCParams(*cparams);
0107 }
0108 EXPORT_SYMBOL(zstd_cstream_workspace_bound);
0109
0110 zstd_cstream *zstd_init_cstream(const zstd_parameters *parameters,
0111     unsigned long long pledged_src_size, void *workspace, size_t workspace_size)
0112 {
0113     zstd_cstream *cstream;
0114
0115     if (workspace == NULL)
0116         return NULL;
0117
0118     cstream = ZSTD_initStaticCStream(workspace, workspace_size);
0119     if (cstream == NULL)
0120         return NULL;
0121
0122     /* 0 means unknown in linux zstd API but means 0 in new zstd API */
0123     if (pledged_src_size == 0)
0124         pledged_src_size = ZSTD_CONTENTSIZE_UNKNOWN;
0125
0126     if (ZSTD_isError(zstd_cctx_init(cstream, parameters, pledged_src_size)))
0127         return NULL;
0128
0129     return cstream;
0130 }
0131 EXPORT_SYMBOL(zstd_init_cstream);
0132
0133 size_t zstd_reset_cstream(zstd_cstream *cstream,
0134     unsigned long long pledged_src_size)
0135 {
0136     return ZSTD_resetCStream(cstream, pledged_src_size);
0137 }
0138 EXPORT_SYMBOL(zstd_reset_cstream);
0139
0140 size_t zstd_compress_stream(zstd_cstream *cstream, zstd_out_buffer *output,
0141     zstd_in_buffer *input)
0142 {
0143     return ZSTD_compressStream(cstream, output, input);
0144 }
0145 EXPORT_SYMBOL(zstd_compress_stream);
0146
0147 size_t zstd_flush_stream(zstd_cstream *cstream, zstd_out_buffer *output)
0148 {
0149     return ZSTD_flushStream(cstream, output);
0150 }
0151 EXPORT_SYMBOL(zstd_flush_stream);
0152
0153 size_t zstd_end_stream(zstd_cstream *cstream, zstd_out_buffer *output)
0154 {
0155     return ZSTD_endStream(cstream, output);
0156 }
0157 EXPORT_SYMBOL(zstd_end_stream);
0158
0159 MODULE_LICENSE("Dual BSD/GPL");
0160 MODULE_DESCRIPTION("Zstd Compressor");