blob: 12e6bcb3a3389345f813b6c11161a031cb60c205 [file] [log] [blame]
William Kurkianea869482019-04-09 15:16:11 -04001/*
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.
Abhilash S.L3b494632019-07-16 15:51:09 +053020 * These APIs used to be exposed with ZSTDLIB_API,
William Kurkianea869482019-04-09 15:16:11 -040021 * because it used to be the only way to invoke MT compression.
Abhilash S.L3b494632019-07-16 15:51:09 +053022 * 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
William Kurkianea869482019-04-09 15:16:11 -040039
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
Abhilash S.L3b494632019-07-16 15:51:09 +053046/* === 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_JOBSIZE_MAX (MEM_32bits() ? (512 MB) : (1024 MB))
54
55
William Kurkianea869482019-04-09 15:16:11 -040056/* === Memory management === */
57typedef struct ZSTDMT_CCtx_s ZSTDMT_CCtx;
Abhilash S.L3b494632019-07-16 15:51:09 +053058/* Requires ZSTD_MULTITHREAD to be defined during compilation, otherwise it will return NULL. */
59ZSTDMT_API ZSTDMT_CCtx* ZSTDMT_createCCtx(unsigned nbWorkers);
60/* Requires ZSTD_MULTITHREAD to be defined during compilation, otherwise it will return NULL. */
61ZSTDMT_API ZSTDMT_CCtx* ZSTDMT_createCCtx_advanced(unsigned nbWorkers,
William Kurkianea869482019-04-09 15:16:11 -040062 ZSTD_customMem cMem);
Abhilash S.L3b494632019-07-16 15:51:09 +053063ZSTDMT_API size_t ZSTDMT_freeCCtx(ZSTDMT_CCtx* mtctx);
William Kurkianea869482019-04-09 15:16:11 -040064
Abhilash S.L3b494632019-07-16 15:51:09 +053065ZSTDMT_API size_t ZSTDMT_sizeof_CCtx(ZSTDMT_CCtx* mtctx);
William Kurkianea869482019-04-09 15:16:11 -040066
67
68/* === Simple one-pass compression function === */
69
Abhilash S.L3b494632019-07-16 15:51:09 +053070ZSTDMT_API size_t ZSTDMT_compressCCtx(ZSTDMT_CCtx* mtctx,
William Kurkianea869482019-04-09 15:16:11 -040071 void* dst, size_t dstCapacity,
72 const void* src, size_t srcSize,
73 int compressionLevel);
74
75
76
77/* === Streaming functions === */
78
Abhilash S.L3b494632019-07-16 15:51:09 +053079ZSTDMT_API size_t ZSTDMT_initCStream(ZSTDMT_CCtx* mtctx, int compressionLevel);
80ZSTDMT_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" */
William Kurkianea869482019-04-09 15:16:11 -040081
Abhilash S.L3b494632019-07-16 15:51:09 +053082ZSTDMT_API size_t ZSTDMT_nextInputSizeHint(const ZSTDMT_CCtx* mtctx);
83ZSTDMT_API size_t ZSTDMT_compressStream(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output, ZSTD_inBuffer* input);
William Kurkianea869482019-04-09 15:16:11 -040084
Abhilash S.L3b494632019-07-16 15:51:09 +053085ZSTDMT_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()) */
86ZSTDMT_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()) */
William Kurkianea869482019-04-09 15:16:11 -040087
88
89/* === Advanced functions and parameters === */
90
Abhilash S.L3b494632019-07-16 15:51:09 +053091ZSTDMT_API size_t ZSTDMT_compress_advanced(ZSTDMT_CCtx* mtctx,
92 void* dst, size_t dstCapacity,
93 const void* src, size_t srcSize,
94 const ZSTD_CDict* cdict,
95 ZSTD_parameters params,
96 int overlapLog);
William Kurkianea869482019-04-09 15:16:11 -040097
Abhilash S.L3b494632019-07-16 15:51:09 +053098ZSTDMT_API size_t ZSTDMT_initCStream_advanced(ZSTDMT_CCtx* mtctx,
William Kurkianea869482019-04-09 15:16:11 -040099 const void* dict, size_t dictSize, /* dict can be released after init, a local copy is preserved within zcs */
100 ZSTD_parameters params,
101 unsigned long long pledgedSrcSize); /* pledgedSrcSize is optional and can be zero == unknown */
102
Abhilash S.L3b494632019-07-16 15:51:09 +0530103ZSTDMT_API size_t ZSTDMT_initCStream_usingCDict(ZSTDMT_CCtx* mtctx,
William Kurkianea869482019-04-09 15:16:11 -0400104 const ZSTD_CDict* cdict,
105 ZSTD_frameParameters fparams,
106 unsigned long long pledgedSrcSize); /* note : zero means empty */
107
108/* ZSTDMT_parameter :
109 * List of parameters that can be set using ZSTDMT_setMTCtxParameter() */
110typedef enum {
Abhilash S.L3b494632019-07-16 15:51:09 +0530111 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. */
112 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 */
113 ZSTDMT_p_rsyncable /* Enables rsyncable mode. */
William Kurkianea869482019-04-09 15:16:11 -0400114} ZSTDMT_parameter;
115
116/* ZSTDMT_setMTCtxParameter() :
117 * allow setting individual parameters, one at a time, among a list of enums defined in ZSTDMT_parameter.
118 * The function must be called typically after ZSTD_createCCtx() but __before ZSTDMT_init*() !__
119 * Parameters not explicitly reset by ZSTDMT_init*() remain the same in consecutive compression sessions.
120 * @return : 0, or an error code (which can be tested using ZSTD_isError()) */
Abhilash S.L3b494632019-07-16 15:51:09 +0530121ZSTDMT_API size_t ZSTDMT_setMTCtxParameter(ZSTDMT_CCtx* mtctx, ZSTDMT_parameter parameter, int value);
122
123/* ZSTDMT_getMTCtxParameter() :
124 * Query the ZSTDMT_CCtx for a parameter value.
125 * @return : 0, or an error code (which can be tested using ZSTD_isError()) */
126ZSTDMT_API size_t ZSTDMT_getMTCtxParameter(ZSTDMT_CCtx* mtctx, ZSTDMT_parameter parameter, int* value);
William Kurkianea869482019-04-09 15:16:11 -0400127
128
129/*! ZSTDMT_compressStream_generic() :
130 * Combines ZSTDMT_compressStream() with optional ZSTDMT_flushStream() or ZSTDMT_endStream()
131 * depending on flush directive.
132 * @return : minimum amount of data still to be flushed
133 * 0 if fully flushed
134 * or an error code
135 * note : needs to be init using any ZSTD_initCStream*() variant */
Abhilash S.L3b494632019-07-16 15:51:09 +0530136ZSTDMT_API size_t ZSTDMT_compressStream_generic(ZSTDMT_CCtx* mtctx,
William Kurkianea869482019-04-09 15:16:11 -0400137 ZSTD_outBuffer* output,
138 ZSTD_inBuffer* input,
139 ZSTD_EndDirective endOp);
140
141
142/* ========================================================
143 * === Private interface, for use by ZSTD_compress.c ===
144 * === Not exposed in libzstd. Never invoke directly ===
145 * ======================================================== */
146
Abhilash S.L3b494632019-07-16 15:51:09 +0530147 /*! ZSTDMT_toFlushNow()
148 * Tell how many bytes are ready to be flushed immediately.
149 * Probe the oldest active job (not yet entirely flushed) and check its output buffer.
150 * If return 0, it means there is no active job,
151 * or, it means oldest job is still active, but everything produced has been flushed so far,
152 * therefore flushing is limited by speed of oldest job. */
153size_t ZSTDMT_toFlushNow(ZSTDMT_CCtx* mtctx);
William Kurkianea869482019-04-09 15:16:11 -0400154
Abhilash S.L3b494632019-07-16 15:51:09 +0530155/*! ZSTDMT_CCtxParam_setMTCtxParameter()
156 * like ZSTDMT_setMTCtxParameter(), but into a ZSTD_CCtx_Params */
157size_t ZSTDMT_CCtxParam_setMTCtxParameter(ZSTD_CCtx_params* params, ZSTDMT_parameter parameter, int value);
158
159/*! ZSTDMT_CCtxParam_setNbWorkers()
160 * Set nbWorkers, and clamp it.
161 * Also reset jobSize and overlapLog */
William Kurkianea869482019-04-09 15:16:11 -0400162size_t ZSTDMT_CCtxParam_setNbWorkers(ZSTD_CCtx_params* params, unsigned nbWorkers);
163
164/*! ZSTDMT_updateCParams_whileCompressing() :
165 * Updates only a selected set of compression parameters, to remain compatible with current frame.
166 * New parameters will be applied to next compression job. */
167void ZSTDMT_updateCParams_whileCompressing(ZSTDMT_CCtx* mtctx, const ZSTD_CCtx_params* cctxParams);
168
Abhilash S.L3b494632019-07-16 15:51:09 +0530169/*! ZSTDMT_getFrameProgression():
170 * tells how much data has been consumed (input) and produced (output) for current frame.
171 * able to count progression inside worker threads.
William Kurkianea869482019-04-09 15:16:11 -0400172 */
173ZSTD_frameProgression ZSTDMT_getFrameProgression(ZSTDMT_CCtx* mtctx);
174
175
176/*! ZSTDMT_initCStream_internal() :
177 * Private use only. Init streaming operation.
178 * expects params to be valid.
179 * must receive dict, or cdict, or none, but not both.
180 * @return : 0, or an error code */
181size_t ZSTDMT_initCStream_internal(ZSTDMT_CCtx* zcs,
182 const void* dict, size_t dictSize, ZSTD_dictContentType_e dictContentType,
183 const ZSTD_CDict* cdict,
184 ZSTD_CCtx_params params, unsigned long long pledgedSrcSize);
185
186
187#if defined (__cplusplus)
188}
189#endif
190
191#endif /* ZSTDMT_COMPRESS_H */