blob: 12a526087db4ee6b8e922d4af8872ecd2d573fd9 [file] [log] [blame]
Scott Bakere7144bc2019-10-01 14:16:47 -07001/*
2 * Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
3 * All rights reserved.
4 *
5 * This source code is licensed under both the BSD-style license (found in the
6 * LICENSE file in the root directory of this source tree) and the GPLv2 (found
7 * in the COPYING file in the root directory of this source tree).
8 * You may select, at your option, one of the above-listed licenses.
9 */
10
11 #ifndef ZSTDMT_COMPRESS_H
12 #define ZSTDMT_COMPRESS_H
13
14 #if defined (__cplusplus)
15 extern "C" {
16 #endif
17
18
19/* Note : This is an internal API.
Scott Bakerf579f132019-10-24 14:31:41 -070020 * These APIs used to be exposed with ZSTDLIB_API,
Scott Bakere7144bc2019-10-01 14:16:47 -070021 * because it used to be the only way to invoke MT compression.
Scott Bakerf579f132019-10-24 14:31:41 -070022 * Now, it's recommended to use ZSTD_compress2 and ZSTD_compressStream2()
23 * instead.
24 *
25 * If you depend on these APIs and can't switch, then define
26 * ZSTD_LEGACY_MULTITHREADED_API when making the dynamic library.
27 * However, we may completely remove these functions in a future
28 * release, so please switch soon.
29 *
30 * This API requires ZSTD_MULTITHREAD to be defined during compilation,
31 * otherwise ZSTDMT_createCCtx*() will fail.
32 */
33
34#ifdef ZSTD_LEGACY_MULTITHREADED_API
35# define ZSTDMT_API ZSTDLIB_API
36#else
37# define ZSTDMT_API
38#endif
Scott Bakere7144bc2019-10-01 14:16:47 -070039
40/* === Dependencies === */
41#include <stddef.h> /* size_t */
42#define ZSTD_STATIC_LINKING_ONLY /* ZSTD_parameters */
43#include "zstd.h" /* ZSTD_inBuffer, ZSTD_outBuffer, ZSTDLIB_API */
44
45
Scott Bakerf579f132019-10-24 14:31:41 -070046/* === Constants === */
47#ifndef ZSTDMT_NBWORKERS_MAX
48# define ZSTDMT_NBWORKERS_MAX 200
49#endif
50#ifndef ZSTDMT_JOBSIZE_MIN
51# define ZSTDMT_JOBSIZE_MIN (1 MB)
52#endif
53#define ZSTDMT_JOBLOG_MAX (MEM_32bits() ? 29 : 30)
54#define ZSTDMT_JOBSIZE_MAX (MEM_32bits() ? (512 MB) : (1024 MB))
55
56
Scott Bakere7144bc2019-10-01 14:16:47 -070057/* === Memory management === */
58typedef struct ZSTDMT_CCtx_s ZSTDMT_CCtx;
Scott Bakerf579f132019-10-24 14:31:41 -070059/* Requires ZSTD_MULTITHREAD to be defined during compilation, otherwise it will return NULL. */
60ZSTDMT_API ZSTDMT_CCtx* ZSTDMT_createCCtx(unsigned nbWorkers);
61/* Requires ZSTD_MULTITHREAD to be defined during compilation, otherwise it will return NULL. */
62ZSTDMT_API ZSTDMT_CCtx* ZSTDMT_createCCtx_advanced(unsigned nbWorkers,
Scott Bakere7144bc2019-10-01 14:16:47 -070063 ZSTD_customMem cMem);
Scott Bakerf579f132019-10-24 14:31:41 -070064ZSTDMT_API size_t ZSTDMT_freeCCtx(ZSTDMT_CCtx* mtctx);
Scott Bakere7144bc2019-10-01 14:16:47 -070065
Scott Bakerf579f132019-10-24 14:31:41 -070066ZSTDMT_API size_t ZSTDMT_sizeof_CCtx(ZSTDMT_CCtx* mtctx);
Scott Bakere7144bc2019-10-01 14:16:47 -070067
68
69/* === Simple one-pass compression function === */
70
Scott Bakerf579f132019-10-24 14:31:41 -070071ZSTDMT_API size_t ZSTDMT_compressCCtx(ZSTDMT_CCtx* mtctx,
Scott Bakere7144bc2019-10-01 14:16:47 -070072 void* dst, size_t dstCapacity,
73 const void* src, size_t srcSize,
74 int compressionLevel);
75
76
77
78/* === Streaming functions === */
79
Scott Bakerf579f132019-10-24 14:31:41 -070080ZSTDMT_API size_t ZSTDMT_initCStream(ZSTDMT_CCtx* mtctx, int compressionLevel);
81ZSTDMT_API size_t ZSTDMT_resetCStream(ZSTDMT_CCtx* mtctx, unsigned long long pledgedSrcSize); /**< if srcSize is not known at reset time, use ZSTD_CONTENTSIZE_UNKNOWN. Note: for compatibility with older programs, 0 means the same as ZSTD_CONTENTSIZE_UNKNOWN, but it will change in the future to mean "empty" */
Scott Bakere7144bc2019-10-01 14:16:47 -070082
Scott Bakerf579f132019-10-24 14:31:41 -070083ZSTDMT_API size_t ZSTDMT_nextInputSizeHint(const ZSTDMT_CCtx* mtctx);
84ZSTDMT_API size_t ZSTDMT_compressStream(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output, ZSTD_inBuffer* input);
Scott Bakere7144bc2019-10-01 14:16:47 -070085
Scott Bakerf579f132019-10-24 14:31:41 -070086ZSTDMT_API size_t ZSTDMT_flushStream(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output); /**< @return : 0 == all flushed; >0 : still some data to be flushed; or an error code (ZSTD_isError()) */
87ZSTDMT_API size_t ZSTDMT_endStream(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output); /**< @return : 0 == all flushed; >0 : still some data to be flushed; or an error code (ZSTD_isError()) */
Scott Bakere7144bc2019-10-01 14:16:47 -070088
89
90/* === Advanced functions and parameters === */
91
Scott Bakerf579f132019-10-24 14:31:41 -070092ZSTDMT_API size_t ZSTDMT_compress_advanced(ZSTDMT_CCtx* mtctx,
93 void* dst, size_t dstCapacity,
94 const void* src, size_t srcSize,
95 const ZSTD_CDict* cdict,
96 ZSTD_parameters params,
97 int overlapLog);
Scott Bakere7144bc2019-10-01 14:16:47 -070098
Scott Bakerf579f132019-10-24 14:31:41 -070099ZSTDMT_API size_t ZSTDMT_initCStream_advanced(ZSTDMT_CCtx* mtctx,
Scott Bakere7144bc2019-10-01 14:16:47 -0700100 const void* dict, size_t dictSize, /* dict can be released after init, a local copy is preserved within zcs */
101 ZSTD_parameters params,
102 unsigned long long pledgedSrcSize); /* pledgedSrcSize is optional and can be zero == unknown */
103
Scott Bakerf579f132019-10-24 14:31:41 -0700104ZSTDMT_API size_t ZSTDMT_initCStream_usingCDict(ZSTDMT_CCtx* mtctx,
Scott Bakere7144bc2019-10-01 14:16:47 -0700105 const ZSTD_CDict* cdict,
106 ZSTD_frameParameters fparams,
107 unsigned long long pledgedSrcSize); /* note : zero means empty */
108
109/* ZSTDMT_parameter :
110 * List of parameters that can be set using ZSTDMT_setMTCtxParameter() */
111typedef enum {
Scott Bakerf579f132019-10-24 14:31:41 -0700112 ZSTDMT_p_jobSize, /* Each job is compressed in parallel. By default, this value is dynamically determined depending on compression parameters. Can be set explicitly here. */
113 ZSTDMT_p_overlapLog, /* Each job may reload a part of previous job to enhance compression ratio; 0 == no overlap, 6(default) == use 1/8th of window, >=9 == use full window. This is a "sticky" parameter : its value will be re-used on next compression job */
114 ZSTDMT_p_rsyncable /* Enables rsyncable mode. */
Scott Bakere7144bc2019-10-01 14:16:47 -0700115} ZSTDMT_parameter;
116
117/* ZSTDMT_setMTCtxParameter() :
118 * allow setting individual parameters, one at a time, among a list of enums defined in ZSTDMT_parameter.
119 * The function must be called typically after ZSTD_createCCtx() but __before ZSTDMT_init*() !__
120 * Parameters not explicitly reset by ZSTDMT_init*() remain the same in consecutive compression sessions.
121 * @return : 0, or an error code (which can be tested using ZSTD_isError()) */
Scott Bakerf579f132019-10-24 14:31:41 -0700122ZSTDMT_API size_t ZSTDMT_setMTCtxParameter(ZSTDMT_CCtx* mtctx, ZSTDMT_parameter parameter, int value);
123
124/* ZSTDMT_getMTCtxParameter() :
125 * Query the ZSTDMT_CCtx for a parameter value.
126 * @return : 0, or an error code (which can be tested using ZSTD_isError()) */
127ZSTDMT_API size_t ZSTDMT_getMTCtxParameter(ZSTDMT_CCtx* mtctx, ZSTDMT_parameter parameter, int* value);
Scott Bakere7144bc2019-10-01 14:16:47 -0700128
129
130/*! ZSTDMT_compressStream_generic() :
131 * Combines ZSTDMT_compressStream() with optional ZSTDMT_flushStream() or ZSTDMT_endStream()
132 * depending on flush directive.
133 * @return : minimum amount of data still to be flushed
134 * 0 if fully flushed
135 * or an error code
136 * note : needs to be init using any ZSTD_initCStream*() variant */
Scott Bakerf579f132019-10-24 14:31:41 -0700137ZSTDMT_API size_t ZSTDMT_compressStream_generic(ZSTDMT_CCtx* mtctx,
Scott Bakere7144bc2019-10-01 14:16:47 -0700138 ZSTD_outBuffer* output,
139 ZSTD_inBuffer* input,
140 ZSTD_EndDirective endOp);
141
142
143/* ========================================================
144 * === Private interface, for use by ZSTD_compress.c ===
145 * === Not exposed in libzstd. Never invoke directly ===
146 * ======================================================== */
147
Scott Bakerf579f132019-10-24 14:31:41 -0700148 /*! ZSTDMT_toFlushNow()
149 * Tell how many bytes are ready to be flushed immediately.
150 * Probe the oldest active job (not yet entirely flushed) and check its output buffer.
151 * If return 0, it means there is no active job,
152 * or, it means oldest job is still active, but everything produced has been flushed so far,
153 * therefore flushing is limited by speed of oldest job. */
154size_t ZSTDMT_toFlushNow(ZSTDMT_CCtx* mtctx);
Scott Bakere7144bc2019-10-01 14:16:47 -0700155
Scott Bakerf579f132019-10-24 14:31:41 -0700156/*! ZSTDMT_CCtxParam_setMTCtxParameter()
157 * like ZSTDMT_setMTCtxParameter(), but into a ZSTD_CCtx_Params */
158size_t ZSTDMT_CCtxParam_setMTCtxParameter(ZSTD_CCtx_params* params, ZSTDMT_parameter parameter, int value);
159
160/*! ZSTDMT_CCtxParam_setNbWorkers()
161 * Set nbWorkers, and clamp it.
162 * Also reset jobSize and overlapLog */
Scott Bakere7144bc2019-10-01 14:16:47 -0700163size_t ZSTDMT_CCtxParam_setNbWorkers(ZSTD_CCtx_params* params, unsigned nbWorkers);
164
165/*! ZSTDMT_updateCParams_whileCompressing() :
166 * Updates only a selected set of compression parameters, to remain compatible with current frame.
167 * New parameters will be applied to next compression job. */
168void ZSTDMT_updateCParams_whileCompressing(ZSTDMT_CCtx* mtctx, const ZSTD_CCtx_params* cctxParams);
169
Scott Bakerf579f132019-10-24 14:31:41 -0700170/*! ZSTDMT_getFrameProgression():
171 * tells how much data has been consumed (input) and produced (output) for current frame.
172 * able to count progression inside worker threads.
Scott Bakere7144bc2019-10-01 14:16:47 -0700173 */
174ZSTD_frameProgression ZSTDMT_getFrameProgression(ZSTDMT_CCtx* mtctx);
175
176
177/*! ZSTDMT_initCStream_internal() :
178 * Private use only. Init streaming operation.
179 * expects params to be valid.
180 * must receive dict, or cdict, or none, but not both.
181 * @return : 0, or an error code */
182size_t ZSTDMT_initCStream_internal(ZSTDMT_CCtx* zcs,
183 const void* dict, size_t dictSize, ZSTD_dictContentType_e dictContentType,
184 const ZSTD_CDict* cdict,
185 ZSTD_CCtx_params params, unsigned long long pledgedSrcSize);
186
187
188#if defined (__cplusplus)
189}
190#endif
191
192#endif /* ZSTDMT_COMPRESS_H */