1/*
2 * Copyright (c) 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.
20 *        These APIs used to be exposed with ZSTDLIB_API,
21 *        because it used to be the only way to invoke MT compression.
22 *        Now, you must use ZSTD_compress2 and ZSTD_compressStream2() instead.
23 *
24 *        This API requires ZSTD_MULTITHREAD to be defined during compilation,
25 *        otherwise ZSTDMT_createCCtx*() will fail.
26 */
27
28/* ===   Dependencies   === */
29#include "../common/zstd_deps.h"   /* size_t */
30#define ZSTD_STATIC_LINKING_ONLY   /* ZSTD_parameters */
31#include "../zstd.h"            /* ZSTD_inBuffer, ZSTD_outBuffer, ZSTDLIB_API */
32
33
34/* ===   Constants   === */
35#ifndef ZSTDMT_NBWORKERS_MAX /* a different value can be selected at compile time */
36#  define ZSTDMT_NBWORKERS_MAX ((sizeof(void*)==4) /*32-bit*/ ? 64 : 256)
37#endif
38#ifndef ZSTDMT_JOBSIZE_MIN   /* a different value can be selected at compile time */
39#  define ZSTDMT_JOBSIZE_MIN (512 KB)
40#endif
41#define ZSTDMT_JOBLOG_MAX   (MEM_32bits() ? 29 : 30)
42#define ZSTDMT_JOBSIZE_MAX  (MEM_32bits() ? (512 MB) : (1024 MB))
43
44
45/* ========================================================
46 * ===  Private interface, for use by ZSTD_compress.c   ===
47 * ===  Not exposed in libzstd. Never invoke directly   ===
48 * ======================================================== */
49
50/* ===   Memory management   === */
51typedef struct ZSTDMT_CCtx_s ZSTDMT_CCtx;
52/* Requires ZSTD_MULTITHREAD to be defined during compilation, otherwise it will return NULL. */
53ZSTDMT_CCtx* ZSTDMT_createCCtx_advanced(unsigned nbWorkers,
54                                        ZSTD_customMem cMem,
55					ZSTD_threadPool *pool);
56size_t ZSTDMT_freeCCtx(ZSTDMT_CCtx* mtctx);
57
58size_t ZSTDMT_sizeof_CCtx(ZSTDMT_CCtx* mtctx);
59
60/* ===   Streaming functions   === */
61
62size_t ZSTDMT_nextInputSizeHint(const ZSTDMT_CCtx* mtctx);
63
64/*! ZSTDMT_initCStream_internal() :
65 *  Private use only. Init streaming operation.
66 *  expects params to be valid.
67 *  must receive dict, or cdict, or none, but not both.
68 *  mtctx can be freshly constructed or reused from a prior compression.
69 *  If mtctx is reused, memory allocations from the prior compression may not be freed,
70 *  even if they are not needed for the current compression.
71 *  @return : 0, or an error code */
72size_t ZSTDMT_initCStream_internal(ZSTDMT_CCtx* mtctx,
73                    const void* dict, size_t dictSize, ZSTD_dictContentType_e dictContentType,
74                    const ZSTD_CDict* cdict,
75                    ZSTD_CCtx_params params, unsigned long long pledgedSrcSize);
76
77/*! ZSTDMT_compressStream_generic() :
78 *  Combines ZSTDMT_compressStream() with optional ZSTDMT_flushStream() or ZSTDMT_endStream()
79 *  depending on flush directive.
80 * @return : minimum amount of data still to be flushed
81 *           0 if fully flushed
82 *           or an error code
83 *  note : needs to be init using any ZSTD_initCStream*() variant */
84size_t ZSTDMT_compressStream_generic(ZSTDMT_CCtx* mtctx,
85                                     ZSTD_outBuffer* output,
86                                     ZSTD_inBuffer* input,
87                                     ZSTD_EndDirective endOp);
88
89 /*! ZSTDMT_toFlushNow()
90  *  Tell how many bytes are ready to be flushed immediately.
91  *  Probe the oldest active job (not yet entirely flushed) and check its output buffer.
92  *  If return 0, it means there is no active job,
93  *  or, it means oldest job is still active, but everything produced has been flushed so far,
94  *  therefore flushing is limited by speed of oldest job. */
95size_t ZSTDMT_toFlushNow(ZSTDMT_CCtx* mtctx);
96
97/*! ZSTDMT_updateCParams_whileCompressing() :
98 *  Updates only a selected set of compression parameters, to remain compatible with current frame.
99 *  New parameters will be applied to next compression job. */
100void ZSTDMT_updateCParams_whileCompressing(ZSTDMT_CCtx* mtctx, const ZSTD_CCtx_params* cctxParams);
101
102/*! ZSTDMT_getFrameProgression():
103 *  tells how much data has been consumed (input) and produced (output) for current frame.
104 *  able to count progression inside worker threads.
105 */
106ZSTD_frameProgression ZSTDMT_getFrameProgression(ZSTDMT_CCtx* mtctx);
107
108
109#if defined (__cplusplus)
110}
111#endif
112
113#endif   /* ZSTDMT_COMPRESS_H */
114