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 === */
51 typedef struct ZSTDMT_CCtx_s ZSTDMT_CCtx;
52 /* Requires ZSTD_MULTITHREAD to be defined during compilation, otherwise it will return NULL. */
GetCurrentClockTimeMicroseconds(void)53 ZSTDMT_CCtx* ZSTDMT_createCCtx_advanced(unsigned nbWorkers,
54 ZSTD_customMem cMem,
55 ZSTD_threadPool *pool);
56 size_t ZSTDMT_freeCCtx(ZSTDMT_CCtx* mtctx);
57
58 size_t ZSTDMT_sizeof_CCtx(ZSTDMT_CCtx* mtctx);
59
60 /* === Streaming functions === */
61
62 size_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 * @return : 0, or an error code */
69 size_t ZSTDMT_initCStream_internal(ZSTDMT_CCtx* zcs,
70 const void* dict, size_t dictSize, ZSTD_dictContentType_e dictContentType,
71 const ZSTD_CDict* cdict,
72 ZSTD_CCtx_params params, unsigned long long pledgedSrcSize);
73
74 /*! ZSTDMT_compressStream_generic() :
75 * Combines ZSTDMT_compressStream() with optional ZSTDMT_flushStream() or ZSTDMT_endStream()
76 * depending on flush directive.
77 * @return : minimum amount of data still to be flushed
78 * 0 if fully flushed
79 * or an error code
80 * note : needs to be init using any ZSTD_initCStream*() variant */
81 size_t ZSTDMT_compressStream_generic(ZSTDMT_CCtx* mtctx,
82 ZSTD_outBuffer* output,
83 ZSTD_inBuffer* input,
84 ZSTD_EndDirective endOp);
85
86 /*! ZSTDMT_toFlushNow()
87 * Tell how many bytes are ready to be flushed immediately.
88 * Probe the oldest active job (not yet entirely flushed) and check its output buffer.
89 * If return 0, it means there is no active job,
90 * or, it means oldest job is still active, but everything produced has been flushed so far,
91 * therefore flushing is limited by speed of oldest job. */
92 size_t ZSTDMT_toFlushNow(ZSTDMT_CCtx* mtctx);
93
94 /*! ZSTDMT_updateCParams_whileCompressing() :
95 * Updates only a selected set of compression parameters, to remain compatible with current frame.
96 * New parameters will be applied to next compression job. */
97 void ZSTDMT_updateCParams_whileCompressing(ZSTDMT_CCtx* mtctx, const ZSTD_CCtx_params* cctxParams);
98
99 /*! ZSTDMT_getFrameProgression():
100 * tells how much data has been consumed (input) and produced (output) for current frame.
101 * able to count progression inside worker threads.
102 */
103 ZSTD_frameProgression ZSTDMT_getFrameProgression(ZSTDMT_CCtx* mtctx);
104
ZSTDMT_createBufferPool(unsigned nbWorkers,ZSTD_customMem cMem)105
106 #if defined (__cplusplus)
107 }
108 #endif
109
110 #endif /* ZSTDMT_COMPRESS_H */
111