1 /*
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
12 /* ====== Tuning parameters ====== */
13 #define ZSTDMT_NBTHREADS_MAX 200
14 #define ZSTDMT_OVERLAPLOG_DEFAULT 6
15
16
17 /* ====== Compiler specifics ====== */
18 #if defined(_MSC_VER)
19 # pragma warning(disable : 4204) /* disable: C4204: non-constant aggregate initializer */
20 #endif
21
22
23 /* ====== Dependencies ====== */
24 #include <string.h> /* memcpy, memset */
25 #include "pool.h" /* threadpool */
26 #include "threading.h" /* mutex */
27 #include "zstd_compress_internal.h" /* MIN, ERROR, ZSTD_*, ZSTD_highbit32 */
28 #include "zstdmt_compress.h"
29
30
31 /* ====== Debug ====== */
32 #if defined(ZSTD_DEBUG) && (ZSTD_DEBUG>=2)
33
34 # include <stdio.h>
35 # include <unistd.h>
36 # include <sys/times.h>
37 # define DEBUGLOGRAW(l, ...) if (l<=ZSTD_DEBUG) { fprintf(stderr, __VA_ARGS__); }
38
39 # define DEBUG_PRINTHEX(l,p,n) { \
40 unsigned debug_u; \
41 for (debug_u=0; debug_u<(n); debug_u++) \
42 DEBUGLOGRAW(l, "%02X ", ((const unsigned char*)(p))[debug_u]); \
43 DEBUGLOGRAW(l, " \n"); \
44 }
45
GetCurrentClockTimeMicroseconds(void)46 static unsigned long long GetCurrentClockTimeMicroseconds(void)
47 {
48 static clock_t _ticksPerSecond = 0;
49 if (_ticksPerSecond <= 0) _ticksPerSecond = sysconf(_SC_CLK_TCK);
50
51 { struct tms junk; clock_t newTicks = (clock_t) times(&junk);
52 return ((((unsigned long long)newTicks)*(1000000))/_ticksPerSecond); }
53 }
54
55 #define MUTEX_WAIT_TIME_DLEVEL 6
56 #define ZSTD_PTHREAD_MUTEX_LOCK(mutex) { \
57 if (ZSTD_DEBUG >= MUTEX_WAIT_TIME_DLEVEL) { \
58 unsigned long long const beforeTime = GetCurrentClockTimeMicroseconds(); \
59 ZSTD_pthread_mutex_lock(mutex); \
60 { unsigned long long const afterTime = GetCurrentClockTimeMicroseconds(); \
61 unsigned long long const elapsedTime = (afterTime-beforeTime); \
62 if (elapsedTime > 1000) { /* or whatever threshold you like; I'm using 1 millisecond here */ \
63 DEBUGLOG(MUTEX_WAIT_TIME_DLEVEL, "Thread took %llu microseconds to acquire mutex %s \n", \
64 elapsedTime, #mutex); \
65 } } \
66 } else { \
67 ZSTD_pthread_mutex_lock(mutex); \
68 } \
69 }
70
71 #else
72
73 # define ZSTD_PTHREAD_MUTEX_LOCK(m) ZSTD_pthread_mutex_lock(m)
74 # define DEBUG_PRINTHEX(l,p,n) {}
75
76 #endif
77
78
79 /* ===== Buffer Pool ===== */
80 /* a single Buffer Pool can be invoked from multiple threads in parallel */
81
82 typedef struct buffer_s {
83 void* start;
84 size_t size;
85 } buffer_t;
86
87 static const buffer_t g_nullBuffer = { NULL, 0 };
88
89 typedef struct ZSTDMT_bufferPool_s {
90 ZSTD_pthread_mutex_t poolMutex;
91 size_t bufferSize;
92 unsigned totalBuffers;
93 unsigned nbBuffers;
94 ZSTD_customMem cMem;
95 buffer_t bTable[1]; /* variable size */
96 } ZSTDMT_bufferPool;
97
ZSTDMT_createBufferPool(unsigned nbThreads,ZSTD_customMem cMem)98 static ZSTDMT_bufferPool* ZSTDMT_createBufferPool(unsigned nbThreads, ZSTD_customMem cMem)
99 {
100 unsigned const maxNbBuffers = 2*nbThreads + 3;
101 ZSTDMT_bufferPool* const bufPool = (ZSTDMT_bufferPool*)ZSTD_calloc(
102 sizeof(ZSTDMT_bufferPool) + (maxNbBuffers-1) * sizeof(buffer_t), cMem);
103 if (bufPool==NULL) return NULL;
104 if (ZSTD_pthread_mutex_init(&bufPool->poolMutex, NULL)) {
105 ZSTD_free(bufPool, cMem);
106 return NULL;
107 }
108 bufPool->bufferSize = 64 KB;
109 bufPool->totalBuffers = maxNbBuffers;
110 bufPool->nbBuffers = 0;
111 bufPool->cMem = cMem;
112 return bufPool;
113 }
114
ZSTDMT_freeBufferPool(ZSTDMT_bufferPool * bufPool)115 static void ZSTDMT_freeBufferPool(ZSTDMT_bufferPool* bufPool)
116 {
117 unsigned u;
118 DEBUGLOG(3, "ZSTDMT_freeBufferPool (address:%08X)", (U32)(size_t)bufPool);
119 if (!bufPool) return; /* compatibility with free on NULL */
120 for (u=0; u<bufPool->totalBuffers; u++) {
121 DEBUGLOG(4, "free buffer %2u (address:%08X)", u, (U32)(size_t)bufPool->bTable[u].start);
122 ZSTD_free(bufPool->bTable[u].start, bufPool->cMem);
123 }
124 ZSTD_pthread_mutex_destroy(&bufPool->poolMutex);
125 ZSTD_free(bufPool, bufPool->cMem);
126 }
127
128 /* only works at initialization, not during compression */
ZSTDMT_sizeof_bufferPool(ZSTDMT_bufferPool * bufPool)129 static size_t ZSTDMT_sizeof_bufferPool(ZSTDMT_bufferPool* bufPool)
130 {
131 size_t const poolSize = sizeof(*bufPool)
132 + (bufPool->totalBuffers - 1) * sizeof(buffer_t);
133 unsigned u;
134 size_t totalBufferSize = 0;
135 ZSTD_pthread_mutex_lock(&bufPool->poolMutex);
136 for (u=0; u<bufPool->totalBuffers; u++)
137 totalBufferSize += bufPool->bTable[u].size;
138 ZSTD_pthread_mutex_unlock(&bufPool->poolMutex);
139
140 return poolSize + totalBufferSize;
141 }
142
ZSTDMT_setBufferSize(ZSTDMT_bufferPool * const bufPool,size_t const bSize)143 static void ZSTDMT_setBufferSize(ZSTDMT_bufferPool* const bufPool, size_t const bSize)
144 {
145 ZSTD_pthread_mutex_lock(&bufPool->poolMutex);
146 DEBUGLOG(4, "ZSTDMT_setBufferSize: bSize = %u", (U32)bSize);
147 bufPool->bufferSize = bSize;
148 ZSTD_pthread_mutex_unlock(&bufPool->poolMutex);
149 }
150
151 /** ZSTDMT_getBuffer() :
152 * assumption : bufPool must be valid */
ZSTDMT_getBuffer(ZSTDMT_bufferPool * bufPool)153 static buffer_t ZSTDMT_getBuffer(ZSTDMT_bufferPool* bufPool)
154 {
155 size_t const bSize = bufPool->bufferSize;
156 DEBUGLOG(5, "ZSTDMT_getBuffer: bSize = %u", (U32)bufPool->bufferSize);
157 ZSTD_pthread_mutex_lock(&bufPool->poolMutex);
158 if (bufPool->nbBuffers) { /* try to use an existing buffer */
159 buffer_t const buf = bufPool->bTable[--(bufPool->nbBuffers)];
160 size_t const availBufferSize = buf.size;
161 bufPool->bTable[bufPool->nbBuffers] = g_nullBuffer;
162 if ((availBufferSize >= bSize) & ((availBufferSize>>3) <= bSize)) {
163 /* large enough, but not too much */
164 DEBUGLOG(5, "ZSTDMT_getBuffer: provide buffer %u of size %u",
165 bufPool->nbBuffers, (U32)buf.size);
166 ZSTD_pthread_mutex_unlock(&bufPool->poolMutex);
167 return buf;
168 }
169 /* size conditions not respected : scratch this buffer, create new one */
170 DEBUGLOG(5, "ZSTDMT_getBuffer: existing buffer does not meet size conditions => freeing");
171 ZSTD_free(buf.start, bufPool->cMem);
172 }
173 ZSTD_pthread_mutex_unlock(&bufPool->poolMutex);
174 /* create new buffer */
175 DEBUGLOG(5, "ZSTDMT_getBuffer: create a new buffer");
176 { buffer_t buffer;
177 void* const start = ZSTD_malloc(bSize, bufPool->cMem);
178 buffer.start = start; /* note : start can be NULL if malloc fails ! */
179 buffer.size = (start==NULL) ? 0 : bSize;
180 DEBUGLOG(5, "ZSTDMT_getBuffer: created buffer of size %u", (U32)bSize);
181 return buffer;
182 }
183 }
184
185 /* store buffer for later re-use, up to pool capacity */
ZSTDMT_releaseBuffer(ZSTDMT_bufferPool * bufPool,buffer_t buf)186 static void ZSTDMT_releaseBuffer(ZSTDMT_bufferPool* bufPool, buffer_t buf)
187 {
188 if (buf.start == NULL) return; /* compatible with release on NULL */
189 DEBUGLOG(5, "ZSTDMT_releaseBuffer");
190 ZSTD_pthread_mutex_lock(&bufPool->poolMutex);
191 if (bufPool->nbBuffers < bufPool->totalBuffers) {
192 bufPool->bTable[bufPool->nbBuffers++] = buf; /* stored for later use */
193 DEBUGLOG(5, "ZSTDMT_releaseBuffer: stored buffer of size %u in slot %u",
194 (U32)buf.size, (U32)(bufPool->nbBuffers-1));
195 ZSTD_pthread_mutex_unlock(&bufPool->poolMutex);
196 return;
197 }
198 ZSTD_pthread_mutex_unlock(&bufPool->poolMutex);
199 /* Reached bufferPool capacity (should not happen) */
200 DEBUGLOG(5, "ZSTDMT_releaseBuffer: pool capacity reached => freeing ");
201 ZSTD_free(buf.start, bufPool->cMem);
202 }
203
204 /* Sets parameters relevant to the compression job, initializing others to
205 * default values. Notably, nbThreads should probably be zero. */
ZSTDMT_makeJobCCtxParams(ZSTD_CCtx_params const params)206 static ZSTD_CCtx_params ZSTDMT_makeJobCCtxParams(ZSTD_CCtx_params const params)
207 {
208 ZSTD_CCtx_params jobParams;
209 memset(&jobParams, 0, sizeof(jobParams));
210
211 jobParams.cParams = params.cParams;
212 jobParams.fParams = params.fParams;
213 jobParams.compressionLevel = params.compressionLevel;
214
215 jobParams.ldmParams = params.ldmParams;
216 return jobParams;
217 }
218
219 /* ===== CCtx Pool ===== */
220 /* a single CCtx Pool can be invoked from multiple threads in parallel */
221
222 typedef struct {
223 ZSTD_pthread_mutex_t poolMutex;
224 unsigned totalCCtx;
225 unsigned availCCtx;
226 ZSTD_customMem cMem;
227 ZSTD_CCtx* cctx[1]; /* variable size */
228 } ZSTDMT_CCtxPool;
229
230 /* note : all CCtx borrowed from the pool should be released back to the pool _before_ freeing the pool */
ZSTDMT_freeCCtxPool(ZSTDMT_CCtxPool * pool)231 static void ZSTDMT_freeCCtxPool(ZSTDMT_CCtxPool* pool)
232 {
233 unsigned u;
234 for (u=0; u<pool->totalCCtx; u++)
235 ZSTD_freeCCtx(pool->cctx[u]); /* note : compatible with free on NULL */
236 ZSTD_pthread_mutex_destroy(&pool->poolMutex);
237 ZSTD_free(pool, pool->cMem);
238 }
239
240 /* ZSTDMT_createCCtxPool() :
241 * implies nbThreads >= 1 , checked by caller ZSTDMT_createCCtx() */
ZSTDMT_createCCtxPool(unsigned nbThreads,ZSTD_customMem cMem)242 static ZSTDMT_CCtxPool* ZSTDMT_createCCtxPool(unsigned nbThreads,
243 ZSTD_customMem cMem)
244 {
245 ZSTDMT_CCtxPool* const cctxPool = (ZSTDMT_CCtxPool*) ZSTD_calloc(
246 sizeof(ZSTDMT_CCtxPool) + (nbThreads-1)*sizeof(ZSTD_CCtx*), cMem);
247 if (!cctxPool) return NULL;
248 if (ZSTD_pthread_mutex_init(&cctxPool->poolMutex, NULL)) {
249 ZSTD_free(cctxPool, cMem);
250 return NULL;
251 }
252 cctxPool->cMem = cMem;
253 cctxPool->totalCCtx = nbThreads;
254 cctxPool->availCCtx = 1; /* at least one cctx for single-thread mode */
255 cctxPool->cctx[0] = ZSTD_createCCtx_advanced(cMem);
256 if (!cctxPool->cctx[0]) { ZSTDMT_freeCCtxPool(cctxPool); return NULL; }
257 DEBUGLOG(3, "cctxPool created, with %u threads", nbThreads);
258 return cctxPool;
259 }
260
261 /* only works during initialization phase, not during compression */
ZSTDMT_sizeof_CCtxPool(ZSTDMT_CCtxPool * cctxPool)262 static size_t ZSTDMT_sizeof_CCtxPool(ZSTDMT_CCtxPool* cctxPool)
263 {
264 ZSTD_pthread_mutex_lock(&cctxPool->poolMutex);
265 { unsigned const nbThreads = cctxPool->totalCCtx;
266 size_t const poolSize = sizeof(*cctxPool)
267 + (nbThreads-1)*sizeof(ZSTD_CCtx*);
268 unsigned u;
269 size_t totalCCtxSize = 0;
270 for (u=0; u<nbThreads; u++) {
271 totalCCtxSize += ZSTD_sizeof_CCtx(cctxPool->cctx[u]);
272 }
273 ZSTD_pthread_mutex_unlock(&cctxPool->poolMutex);
274 return poolSize + totalCCtxSize;
275 }
276 }
277
ZSTDMT_getCCtx(ZSTDMT_CCtxPool * cctxPool)278 static ZSTD_CCtx* ZSTDMT_getCCtx(ZSTDMT_CCtxPool* cctxPool)
279 {
280 DEBUGLOG(5, "ZSTDMT_getCCtx");
281 ZSTD_pthread_mutex_lock(&cctxPool->poolMutex);
282 if (cctxPool->availCCtx) {
283 cctxPool->availCCtx--;
284 { ZSTD_CCtx* const cctx = cctxPool->cctx[cctxPool->availCCtx];
285 ZSTD_pthread_mutex_unlock(&cctxPool->poolMutex);
286 return cctx;
287 } }
288 ZSTD_pthread_mutex_unlock(&cctxPool->poolMutex);
289 DEBUGLOG(5, "create one more CCtx");
290 return ZSTD_createCCtx_advanced(cctxPool->cMem); /* note : can be NULL, when creation fails ! */
291 }
292
ZSTDMT_releaseCCtx(ZSTDMT_CCtxPool * pool,ZSTD_CCtx * cctx)293 static void ZSTDMT_releaseCCtx(ZSTDMT_CCtxPool* pool, ZSTD_CCtx* cctx)
294 {
295 if (cctx==NULL) return; /* compatibility with release on NULL */
296 ZSTD_pthread_mutex_lock(&pool->poolMutex);
297 if (pool->availCCtx < pool->totalCCtx)
298 pool->cctx[pool->availCCtx++] = cctx;
299 else {
300 /* pool overflow : should not happen, since totalCCtx==nbThreads */
301 DEBUGLOG(5, "CCtx pool overflow : free cctx");
302 ZSTD_freeCCtx(cctx);
303 }
304 ZSTD_pthread_mutex_unlock(&pool->poolMutex);
305 }
306
307
308 /* ===== Thread worker ===== */
309
310 typedef struct {
311 buffer_t src;
312 const void* srcStart;
313 size_t prefixSize;
314 size_t srcSize;
315 buffer_t dstBuff;
316 size_t cSize;
317 size_t dstFlushed;
318 unsigned firstChunk;
319 unsigned lastChunk;
320 unsigned jobCompleted;
321 unsigned jobScanned;
322 ZSTD_pthread_mutex_t* jobCompleted_mutex;
323 ZSTD_pthread_cond_t* jobCompleted_cond;
324 ZSTD_CCtx_params params;
325 const ZSTD_CDict* cdict;
326 ZSTDMT_CCtxPool* cctxPool;
327 ZSTDMT_bufferPool* bufPool;
328 unsigned long long fullFrameSize;
329 } ZSTDMT_jobDescription;
330
331 /* ZSTDMT_compressChunk() : POOL_function type */
ZSTDMT_compressChunk(void * jobDescription)332 void ZSTDMT_compressChunk(void* jobDescription)
333 {
334 ZSTDMT_jobDescription* const job = (ZSTDMT_jobDescription*)jobDescription;
335 ZSTD_CCtx* const cctx = ZSTDMT_getCCtx(job->cctxPool);
336 const void* const src = (const char*)job->srcStart + job->prefixSize;
337 buffer_t dstBuff = job->dstBuff;
338 DEBUGLOG(5, "ZSTDMT_compressChunk: job (first:%u) (last:%u) : prefixSize %u, srcSize %u ",
339 job->firstChunk, job->lastChunk, (U32)job->prefixSize, (U32)job->srcSize);
340
341 if (cctx==NULL) {
342 job->cSize = ERROR(memory_allocation);
343 goto _endJob;
344 }
345
346 if (dstBuff.start == NULL) {
347 dstBuff = ZSTDMT_getBuffer(job->bufPool);
348 if (dstBuff.start==NULL) {
349 job->cSize = ERROR(memory_allocation);
350 goto _endJob;
351 }
352 job->dstBuff = dstBuff;
353 DEBUGLOG(5, "ZSTDMT_compressChunk: received dstBuff of size %u", (U32)dstBuff.size);
354 }
355
356 if (job->cdict) {
357 size_t const initError = ZSTD_compressBegin_advanced_internal(cctx, NULL, 0, ZSTD_dm_auto, job->cdict, job->params, job->fullFrameSize);
358 DEBUGLOG(4, "ZSTDMT_compressChunk: init using CDict (windowLog=%u)", job->params.cParams.windowLog);
359 assert(job->firstChunk); /* only allowed for first job */
360 if (ZSTD_isError(initError)) { job->cSize = initError; goto _endJob; }
361 } else { /* srcStart points at reloaded section */
362 U64 const pledgedSrcSize = job->firstChunk ? job->fullFrameSize : ZSTD_CONTENTSIZE_UNKNOWN;
363 ZSTD_CCtx_params jobParams = job->params; /* do not modify job->params ! copy it, modify the copy */
364 size_t const forceWindowError = ZSTD_CCtxParam_setParameter(&jobParams, ZSTD_p_forceMaxWindow, !job->firstChunk);
365 if (ZSTD_isError(forceWindowError)) {
366 DEBUGLOG(5, "ZSTD_CCtxParam_setParameter error : %s ", ZSTD_getErrorName(forceWindowError));
367 job->cSize = forceWindowError;
368 goto _endJob;
369 }
370 DEBUGLOG(5, "ZSTDMT_compressChunk: invoking ZSTD_compressBegin_advanced_internal with windowLog = %u ", jobParams.cParams.windowLog);
371 { size_t const initError = ZSTD_compressBegin_advanced_internal(cctx,
372 job->srcStart, job->prefixSize, ZSTD_dm_rawContent, /* load dictionary in "content-only" mode (no header analysis) */
373 NULL,
374 jobParams, pledgedSrcSize);
375 if (ZSTD_isError(initError)) {
376 DEBUGLOG(5, "ZSTD_compressBegin_advanced_internal error : %s ", ZSTD_getErrorName(initError));
377 job->cSize = initError;
378 goto _endJob;
379 } }
380 }
381 if (!job->firstChunk) { /* flush and overwrite frame header when it's not first job */
382 size_t const hSize = ZSTD_compressContinue(cctx, dstBuff.start, dstBuff.size, src, 0);
383 if (ZSTD_isError(hSize)) { job->cSize = hSize; /* save error code */ goto _endJob; }
384 ZSTD_invalidateRepCodes(cctx);
385 }
386
387 DEBUGLOG(5, "Compressing into dstBuff of size %u", (U32)dstBuff.size);
388 DEBUG_PRINTHEX(6, job->srcStart, 12);
389 job->cSize = (job->lastChunk) ?
390 ZSTD_compressEnd (cctx, dstBuff.start, dstBuff.size, src, job->srcSize) :
391 ZSTD_compressContinue(cctx, dstBuff.start, dstBuff.size, src, job->srcSize);
392 DEBUGLOG(5, "compressed %u bytes into %u bytes (first:%u) (last:%u) ",
393 (unsigned)job->srcSize, (unsigned)job->cSize, job->firstChunk, job->lastChunk);
394 DEBUGLOG(5, "dstBuff.size : %u ; => %s ", (U32)dstBuff.size, ZSTD_getErrorName(job->cSize));
395
396 _endJob:
397 ZSTDMT_releaseCCtx(job->cctxPool, cctx);
398 ZSTDMT_releaseBuffer(job->bufPool, job->src);
399 job->src = g_nullBuffer; job->srcStart = NULL;
400 ZSTD_PTHREAD_MUTEX_LOCK(job->jobCompleted_mutex);
401 job->jobCompleted = 1;
402 job->jobScanned = 0;
403 ZSTD_pthread_cond_signal(job->jobCompleted_cond);
404 ZSTD_pthread_mutex_unlock(job->jobCompleted_mutex);
405 }
406
407
408 /* ------------------------------------------ */
409 /* ===== Multi-threaded compression ===== */
410 /* ------------------------------------------ */
411
412 typedef struct {
413 buffer_t buffer;
414 size_t filled;
415 } inBuff_t;
416
417 struct ZSTDMT_CCtx_s {
418 POOL_ctx* factory;
419 ZSTDMT_jobDescription* jobs;
420 ZSTDMT_bufferPool* bufPool;
421 ZSTDMT_CCtxPool* cctxPool;
422 ZSTD_pthread_mutex_t jobCompleted_mutex;
423 ZSTD_pthread_cond_t jobCompleted_cond;
424 ZSTD_CCtx_params params;
425 size_t targetSectionSize;
426 size_t inBuffSize;
427 size_t dictSize;
428 size_t targetDictSize;
429 inBuff_t inBuff;
430 XXH64_state_t xxhState;
431 unsigned singleThreaded;
432 unsigned jobIDMask;
433 unsigned doneJobID;
434 unsigned nextJobID;
435 unsigned frameEnded;
436 unsigned allJobsCompleted;
437 unsigned long long frameContentSize;
438 ZSTD_customMem cMem;
439 ZSTD_CDict* cdictLocal;
440 const ZSTD_CDict* cdict;
441 };
442
ZSTDMT_allocJobsTable(U32 * nbJobsPtr,ZSTD_customMem cMem)443 static ZSTDMT_jobDescription* ZSTDMT_allocJobsTable(U32* nbJobsPtr, ZSTD_customMem cMem)
444 {
445 U32 const nbJobsLog2 = ZSTD_highbit32(*nbJobsPtr) + 1;
446 U32 const nbJobs = 1 << nbJobsLog2;
447 *nbJobsPtr = nbJobs;
448 return (ZSTDMT_jobDescription*) ZSTD_calloc(
449 nbJobs * sizeof(ZSTDMT_jobDescription), cMem);
450 }
451
452 /* ZSTDMT_CCtxParam_setNbThreads():
453 * Internal use only */
ZSTDMT_CCtxParam_setNbThreads(ZSTD_CCtx_params * params,unsigned nbThreads)454 size_t ZSTDMT_CCtxParam_setNbThreads(ZSTD_CCtx_params* params, unsigned nbThreads)
455 {
456 if (nbThreads > ZSTDMT_NBTHREADS_MAX) nbThreads = ZSTDMT_NBTHREADS_MAX;
457 if (nbThreads < 1) nbThreads = 1;
458 params->nbThreads = nbThreads;
459 params->overlapSizeLog = ZSTDMT_OVERLAPLOG_DEFAULT;
460 params->jobSize = 0;
461 return nbThreads;
462 }
463
464 /* ZSTDMT_getNbThreads():
465 * @return nb threads currently active in mtctx.
466 * mtctx must be valid */
ZSTDMT_getNbThreads(const ZSTDMT_CCtx * mtctx)467 size_t ZSTDMT_getNbThreads(const ZSTDMT_CCtx* mtctx)
468 {
469 assert(mtctx != NULL);
470 return mtctx->params.nbThreads;
471 }
472
ZSTDMT_createCCtx_advanced(unsigned nbThreads,ZSTD_customMem cMem)473 ZSTDMT_CCtx* ZSTDMT_createCCtx_advanced(unsigned nbThreads, ZSTD_customMem cMem)
474 {
475 ZSTDMT_CCtx* mtctx;
476 U32 nbJobs = nbThreads + 2;
477 DEBUGLOG(3, "ZSTDMT_createCCtx_advanced (nbThreads = %u)", nbThreads);
478
479 if (nbThreads < 1) return NULL;
480 nbThreads = MIN(nbThreads , ZSTDMT_NBTHREADS_MAX);
481 if ((cMem.customAlloc!=NULL) ^ (cMem.customFree!=NULL))
482 /* invalid custom allocator */
483 return NULL;
484
485 mtctx = (ZSTDMT_CCtx*) ZSTD_calloc(sizeof(ZSTDMT_CCtx), cMem);
486 if (!mtctx) return NULL;
487 ZSTDMT_CCtxParam_setNbThreads(&mtctx->params, nbThreads);
488 mtctx->cMem = cMem;
489 mtctx->allJobsCompleted = 1;
490 mtctx->factory = POOL_create_advanced(nbThreads, 0, cMem);
491 mtctx->jobs = ZSTDMT_allocJobsTable(&nbJobs, cMem);
492 mtctx->jobIDMask = nbJobs - 1;
493 mtctx->bufPool = ZSTDMT_createBufferPool(nbThreads, cMem);
494 mtctx->cctxPool = ZSTDMT_createCCtxPool(nbThreads, cMem);
495 if (!mtctx->factory | !mtctx->jobs | !mtctx->bufPool | !mtctx->cctxPool) {
496 ZSTDMT_freeCCtx(mtctx);
497 return NULL;
498 }
499 if (ZSTD_pthread_mutex_init(&mtctx->jobCompleted_mutex, NULL)) {
500 ZSTDMT_freeCCtx(mtctx);
501 return NULL;
502 }
503 if (ZSTD_pthread_cond_init(&mtctx->jobCompleted_cond, NULL)) {
504 ZSTDMT_freeCCtx(mtctx);
505 return NULL;
506 }
507 DEBUGLOG(3, "mt_cctx created, for %u threads", nbThreads);
508 return mtctx;
509 }
510
ZSTDMT_createCCtx(unsigned nbThreads)511 ZSTDMT_CCtx* ZSTDMT_createCCtx(unsigned nbThreads)
512 {
513 return ZSTDMT_createCCtx_advanced(nbThreads, ZSTD_defaultCMem);
514 }
515
516 /* ZSTDMT_releaseAllJobResources() :
517 * note : ensure all workers are killed first ! */
ZSTDMT_releaseAllJobResources(ZSTDMT_CCtx * mtctx)518 static void ZSTDMT_releaseAllJobResources(ZSTDMT_CCtx* mtctx)
519 {
520 unsigned jobID;
521 DEBUGLOG(3, "ZSTDMT_releaseAllJobResources");
522 for (jobID=0; jobID <= mtctx->jobIDMask; jobID++) {
523 DEBUGLOG(4, "job%02u: release dst address %08X", jobID, (U32)(size_t)mtctx->jobs[jobID].dstBuff.start);
524 ZSTDMT_releaseBuffer(mtctx->bufPool, mtctx->jobs[jobID].dstBuff);
525 mtctx->jobs[jobID].dstBuff = g_nullBuffer;
526 DEBUGLOG(4, "job%02u: release src address %08X", jobID, (U32)(size_t)mtctx->jobs[jobID].src.start);
527 ZSTDMT_releaseBuffer(mtctx->bufPool, mtctx->jobs[jobID].src);
528 mtctx->jobs[jobID].src = g_nullBuffer;
529 }
530 memset(mtctx->jobs, 0, (mtctx->jobIDMask+1)*sizeof(ZSTDMT_jobDescription));
531 DEBUGLOG(4, "input: release address %08X", (U32)(size_t)mtctx->inBuff.buffer.start);
532 ZSTDMT_releaseBuffer(mtctx->bufPool, mtctx->inBuff.buffer);
533 mtctx->inBuff.buffer = g_nullBuffer;
534 mtctx->allJobsCompleted = 1;
535 }
536
ZSTDMT_waitForAllJobsCompleted(ZSTDMT_CCtx * zcs)537 static void ZSTDMT_waitForAllJobsCompleted(ZSTDMT_CCtx* zcs)
538 {
539 DEBUGLOG(4, "ZSTDMT_waitForAllJobsCompleted");
540 while (zcs->doneJobID < zcs->nextJobID) {
541 unsigned const jobID = zcs->doneJobID & zcs->jobIDMask;
542 ZSTD_PTHREAD_MUTEX_LOCK(&zcs->jobCompleted_mutex);
543 while (zcs->jobs[jobID].jobCompleted==0) {
544 DEBUGLOG(5, "waiting for jobCompleted signal from chunk %u", zcs->doneJobID); /* we want to block when waiting for data to flush */
545 ZSTD_pthread_cond_wait(&zcs->jobCompleted_cond, &zcs->jobCompleted_mutex);
546 }
547 ZSTD_pthread_mutex_unlock(&zcs->jobCompleted_mutex);
548 zcs->doneJobID++;
549 }
550 }
551
ZSTDMT_freeCCtx(ZSTDMT_CCtx * mtctx)552 size_t ZSTDMT_freeCCtx(ZSTDMT_CCtx* mtctx)
553 {
554 if (mtctx==NULL) return 0; /* compatible with free on NULL */
555 POOL_free(mtctx->factory); /* stop and free worker threads */
556 ZSTDMT_releaseAllJobResources(mtctx); /* release job resources into pools first */
557 ZSTD_free(mtctx->jobs, mtctx->cMem);
558 ZSTDMT_freeBufferPool(mtctx->bufPool);
559 ZSTDMT_freeCCtxPool(mtctx->cctxPool);
560 ZSTD_freeCDict(mtctx->cdictLocal);
561 ZSTD_pthread_mutex_destroy(&mtctx->jobCompleted_mutex);
562 ZSTD_pthread_cond_destroy(&mtctx->jobCompleted_cond);
563 ZSTD_free(mtctx, mtctx->cMem);
564 return 0;
565 }
566
ZSTDMT_sizeof_CCtx(ZSTDMT_CCtx * mtctx)567 size_t ZSTDMT_sizeof_CCtx(ZSTDMT_CCtx* mtctx)
568 {
569 if (mtctx == NULL) return 0; /* supports sizeof NULL */
570 return sizeof(*mtctx)
571 + POOL_sizeof(mtctx->factory)
572 + ZSTDMT_sizeof_bufferPool(mtctx->bufPool)
573 + (mtctx->jobIDMask+1) * sizeof(ZSTDMT_jobDescription)
574 + ZSTDMT_sizeof_CCtxPool(mtctx->cctxPool)
575 + ZSTD_sizeof_CDict(mtctx->cdictLocal);
576 }
577
578 /* Internal only */
ZSTDMT_CCtxParam_setMTCtxParameter(ZSTD_CCtx_params * params,ZSTDMT_parameter parameter,unsigned value)579 size_t ZSTDMT_CCtxParam_setMTCtxParameter(ZSTD_CCtx_params* params,
580 ZSTDMT_parameter parameter, unsigned value) {
581 DEBUGLOG(4, "ZSTDMT_CCtxParam_setMTCtxParameter");
582 switch(parameter)
583 {
584 case ZSTDMT_p_jobSize :
585 DEBUGLOG(4, "ZSTDMT_CCtxParam_setMTCtxParameter : set jobSize to %u", value);
586 if ( (value > 0) /* value==0 => automatic job size */
587 & (value < ZSTDMT_JOBSIZE_MIN) )
588 value = ZSTDMT_JOBSIZE_MIN;
589 params->jobSize = value;
590 return value;
591 case ZSTDMT_p_overlapSectionLog :
592 if (value > 9) value = 9;
593 DEBUGLOG(4, "ZSTDMT_p_overlapSectionLog : %u", value);
594 params->overlapSizeLog = (value >= 9) ? 9 : value;
595 return value;
596 default :
597 return ERROR(parameter_unsupported);
598 }
599 }
600
ZSTDMT_setMTCtxParameter(ZSTDMT_CCtx * mtctx,ZSTDMT_parameter parameter,unsigned value)601 size_t ZSTDMT_setMTCtxParameter(ZSTDMT_CCtx* mtctx, ZSTDMT_parameter parameter, unsigned value)
602 {
603 DEBUGLOG(4, "ZSTDMT_setMTCtxParameter");
604 switch(parameter)
605 {
606 case ZSTDMT_p_jobSize :
607 return ZSTDMT_CCtxParam_setMTCtxParameter(&mtctx->params, parameter, value);
608 case ZSTDMT_p_overlapSectionLog :
609 return ZSTDMT_CCtxParam_setMTCtxParameter(&mtctx->params, parameter, value);
610 default :
611 return ERROR(parameter_unsupported);
612 }
613 }
614
615 /* ------------------------------------------ */
616 /* ===== Multi-threaded compression ===== */
617 /* ------------------------------------------ */
618
computeNbChunks(size_t srcSize,unsigned windowLog,unsigned nbThreads)619 static unsigned computeNbChunks(size_t srcSize, unsigned windowLog, unsigned nbThreads) {
620 size_t const chunkSizeTarget = (size_t)1 << (windowLog + 2);
621 size_t const chunkMaxSize = chunkSizeTarget << 2;
622 size_t const passSizeMax = chunkMaxSize * nbThreads;
623 unsigned const multiplier = (unsigned)(srcSize / passSizeMax) + 1;
624 unsigned const nbChunksLarge = multiplier * nbThreads;
625 unsigned const nbChunksMax = (unsigned)(srcSize / chunkSizeTarget) + 1;
626 unsigned const nbChunksSmall = MIN(nbChunksMax, nbThreads);
627 return (multiplier>1) ? nbChunksLarge : nbChunksSmall;
628 }
629
ZSTDMT_compress_advanced_internal(ZSTDMT_CCtx * mtctx,void * dst,size_t dstCapacity,const void * src,size_t srcSize,const ZSTD_CDict * cdict,ZSTD_CCtx_params const params)630 static size_t ZSTDMT_compress_advanced_internal(
631 ZSTDMT_CCtx* mtctx,
632 void* dst, size_t dstCapacity,
633 const void* src, size_t srcSize,
634 const ZSTD_CDict* cdict,
635 ZSTD_CCtx_params const params)
636 {
637 ZSTD_CCtx_params const jobParams = ZSTDMT_makeJobCCtxParams(params);
638 unsigned const overlapRLog = (params.overlapSizeLog>9) ? 0 : 9-params.overlapSizeLog;
639 size_t const overlapSize = (overlapRLog>=9) ? 0 : (size_t)1 << (params.cParams.windowLog - overlapRLog);
640 unsigned nbChunks = computeNbChunks(srcSize, params.cParams.windowLog, params.nbThreads);
641 size_t const proposedChunkSize = (srcSize + (nbChunks-1)) / nbChunks;
642 size_t const avgChunkSize = (((proposedChunkSize-1) & 0x1FFFF) < 0x7FFF) ? proposedChunkSize + 0xFFFF : proposedChunkSize; /* avoid too small last block */
643 const char* const srcStart = (const char*)src;
644 size_t remainingSrcSize = srcSize;
645 unsigned const compressWithinDst = (dstCapacity >= ZSTD_compressBound(srcSize)) ? nbChunks : (unsigned)(dstCapacity / ZSTD_compressBound(avgChunkSize)); /* presumes avgChunkSize >= 256 KB, which should be the case */
646 size_t frameStartPos = 0, dstBufferPos = 0;
647 XXH64_state_t xxh64;
648 assert(jobParams.nbThreads == 0);
649 assert(mtctx->cctxPool->totalCCtx == params.nbThreads);
650
651 DEBUGLOG(4, "ZSTDMT_compress_advanced_internal: nbChunks=%2u (rawSize=%u bytes; fixedSize=%u) ",
652 nbChunks, (U32)proposedChunkSize, (U32)avgChunkSize);
653 if (nbChunks==1) { /* fallback to single-thread mode */
654 ZSTD_CCtx* const cctx = mtctx->cctxPool->cctx[0];
655 if (cdict) return ZSTD_compress_usingCDict_advanced(cctx, dst, dstCapacity, src, srcSize, cdict, jobParams.fParams);
656 return ZSTD_compress_advanced_internal(cctx, dst, dstCapacity, src, srcSize, NULL, 0, jobParams);
657 }
658 assert(avgChunkSize >= 256 KB); /* condition for ZSTD_compressBound(A) + ZSTD_compressBound(B) <= ZSTD_compressBound(A+B), which is required for compressWithinDst */
659 ZSTDMT_setBufferSize(mtctx->bufPool, ZSTD_compressBound(avgChunkSize) );
660 XXH64_reset(&xxh64, 0);
661
662 if (nbChunks > mtctx->jobIDMask+1) { /* enlarge job table */
663 U32 nbJobs = nbChunks;
664 ZSTD_free(mtctx->jobs, mtctx->cMem);
665 mtctx->jobIDMask = 0;
666 mtctx->jobs = ZSTDMT_allocJobsTable(&nbJobs, mtctx->cMem);
667 if (mtctx->jobs==NULL) return ERROR(memory_allocation);
668 mtctx->jobIDMask = nbJobs - 1;
669 }
670
671 { unsigned u;
672 for (u=0; u<nbChunks; u++) {
673 size_t const chunkSize = MIN(remainingSrcSize, avgChunkSize);
674 size_t const dstBufferCapacity = ZSTD_compressBound(chunkSize);
675 buffer_t const dstAsBuffer = { (char*)dst + dstBufferPos, dstBufferCapacity };
676 buffer_t const dstBuffer = u < compressWithinDst ? dstAsBuffer : g_nullBuffer;
677 size_t dictSize = u ? overlapSize : 0;
678
679 mtctx->jobs[u].src = g_nullBuffer;
680 mtctx->jobs[u].srcStart = srcStart + frameStartPos - dictSize;
681 mtctx->jobs[u].prefixSize = dictSize;
682 mtctx->jobs[u].srcSize = chunkSize;
683 mtctx->jobs[u].cdict = (u==0) ? cdict : NULL;
684 mtctx->jobs[u].fullFrameSize = srcSize;
685 mtctx->jobs[u].params = jobParams;
686 /* do not calculate checksum within sections, but write it in header for first section */
687 if (u!=0) mtctx->jobs[u].params.fParams.checksumFlag = 0;
688 mtctx->jobs[u].dstBuff = dstBuffer;
689 mtctx->jobs[u].cctxPool = mtctx->cctxPool;
690 mtctx->jobs[u].bufPool = mtctx->bufPool;
691 mtctx->jobs[u].firstChunk = (u==0);
692 mtctx->jobs[u].lastChunk = (u==nbChunks-1);
693 mtctx->jobs[u].jobCompleted = 0;
694 mtctx->jobs[u].jobCompleted_mutex = &mtctx->jobCompleted_mutex;
695 mtctx->jobs[u].jobCompleted_cond = &mtctx->jobCompleted_cond;
696
697 if (params.fParams.checksumFlag) {
698 XXH64_update(&xxh64, srcStart + frameStartPos, chunkSize);
699 }
700
701 DEBUGLOG(5, "ZSTDMT_compress_advanced_internal: posting job %u (%u bytes)", u, (U32)chunkSize);
702 DEBUG_PRINTHEX(6, mtctx->jobs[u].srcStart, 12);
703 POOL_add(mtctx->factory, ZSTDMT_compressChunk, &mtctx->jobs[u]);
704
705 frameStartPos += chunkSize;
706 dstBufferPos += dstBufferCapacity;
707 remainingSrcSize -= chunkSize;
708 } }
709
710 /* collect result */
711 { size_t error = 0, dstPos = 0;
712 unsigned chunkID;
713 for (chunkID=0; chunkID<nbChunks; chunkID++) {
714 DEBUGLOG(5, "waiting for chunk %u ", chunkID);
715 ZSTD_PTHREAD_MUTEX_LOCK(&mtctx->jobCompleted_mutex);
716 while (mtctx->jobs[chunkID].jobCompleted==0) {
717 DEBUGLOG(5, "waiting for jobCompleted signal from chunk %u", chunkID);
718 ZSTD_pthread_cond_wait(&mtctx->jobCompleted_cond, &mtctx->jobCompleted_mutex);
719 }
720 ZSTD_pthread_mutex_unlock(&mtctx->jobCompleted_mutex);
721 DEBUGLOG(5, "ready to write chunk %u ", chunkID);
722
723 mtctx->jobs[chunkID].srcStart = NULL;
724 { size_t const cSize = mtctx->jobs[chunkID].cSize;
725 if (ZSTD_isError(cSize)) error = cSize;
726 if ((!error) && (dstPos + cSize > dstCapacity)) error = ERROR(dstSize_tooSmall);
727 if (chunkID) { /* note : chunk 0 is written directly at dst, which is correct position */
728 if (!error)
729 memmove((char*)dst + dstPos, mtctx->jobs[chunkID].dstBuff.start, cSize); /* may overlap when chunk compressed within dst */
730 if (chunkID >= compressWithinDst) { /* chunk compressed into its own buffer, which must be released */
731 DEBUGLOG(5, "releasing buffer %u>=%u", chunkID, compressWithinDst);
732 ZSTDMT_releaseBuffer(mtctx->bufPool, mtctx->jobs[chunkID].dstBuff);
733 } }
734 mtctx->jobs[chunkID].dstBuff = g_nullBuffer;
735 dstPos += cSize ;
736 }
737 } /* for (chunkID=0; chunkID<nbChunks; chunkID++) */
738
739 DEBUGLOG(4, "checksumFlag : %u ", params.fParams.checksumFlag);
740 if (params.fParams.checksumFlag) {
741 U32 const checksum = (U32)XXH64_digest(&xxh64);
742 if (dstPos + 4 > dstCapacity) {
743 error = ERROR(dstSize_tooSmall);
744 } else {
745 DEBUGLOG(4, "writing checksum : %08X \n", checksum);
746 MEM_writeLE32((char*)dst + dstPos, checksum);
747 dstPos += 4;
748 } }
749
750 if (!error) DEBUGLOG(4, "compressed size : %u ", (U32)dstPos);
751 return error ? error : dstPos;
752 }
753 }
754
ZSTDMT_compress_advanced(ZSTDMT_CCtx * mtctx,void * dst,size_t dstCapacity,const void * src,size_t srcSize,const ZSTD_CDict * cdict,ZSTD_parameters const params,unsigned overlapLog)755 size_t ZSTDMT_compress_advanced(ZSTDMT_CCtx* mtctx,
756 void* dst, size_t dstCapacity,
757 const void* src, size_t srcSize,
758 const ZSTD_CDict* cdict,
759 ZSTD_parameters const params,
760 unsigned overlapLog)
761 {
762 ZSTD_CCtx_params cctxParams = mtctx->params;
763 cctxParams.cParams = params.cParams;
764 cctxParams.fParams = params.fParams;
765 cctxParams.overlapSizeLog = overlapLog;
766 return ZSTDMT_compress_advanced_internal(mtctx,
767 dst, dstCapacity,
768 src, srcSize,
769 cdict, cctxParams);
770 }
771
772
ZSTDMT_compressCCtx(ZSTDMT_CCtx * mtctx,void * dst,size_t dstCapacity,const void * src,size_t srcSize,int compressionLevel)773 size_t ZSTDMT_compressCCtx(ZSTDMT_CCtx* mtctx,
774 void* dst, size_t dstCapacity,
775 const void* src, size_t srcSize,
776 int compressionLevel)
777 {
778 U32 const overlapLog = (compressionLevel >= ZSTD_maxCLevel()) ? 9 : ZSTDMT_OVERLAPLOG_DEFAULT;
779 ZSTD_parameters params = ZSTD_getParams(compressionLevel, srcSize, 0);
780 params.fParams.contentSizeFlag = 1;
781 return ZSTDMT_compress_advanced(mtctx, dst, dstCapacity, src, srcSize, NULL, params, overlapLog);
782 }
783
784
785 /* ====================================== */
786 /* ======= Streaming API ======= */
787 /* ====================================== */
788
ZSTDMT_initCStream_internal(ZSTDMT_CCtx * zcs,const void * dict,size_t dictSize,ZSTD_dictMode_e dictMode,const ZSTD_CDict * cdict,ZSTD_CCtx_params params,unsigned long long pledgedSrcSize)789 size_t ZSTDMT_initCStream_internal(
790 ZSTDMT_CCtx* zcs,
791 const void* dict, size_t dictSize, ZSTD_dictMode_e dictMode,
792 const ZSTD_CDict* cdict, ZSTD_CCtx_params params,
793 unsigned long long pledgedSrcSize)
794 {
795 DEBUGLOG(4, "ZSTDMT_initCStream_internal (pledgedSrcSize=%u)", (U32)pledgedSrcSize);
796 /* params are supposed to be fully validated at this point */
797 assert(!ZSTD_isError(ZSTD_checkCParams(params.cParams)));
798 assert(!((dict) && (cdict))); /* either dict or cdict, not both */
799 assert(zcs->cctxPool->totalCCtx == params.nbThreads);
800 zcs->singleThreaded = (params.nbThreads==1) | (pledgedSrcSize <= ZSTDMT_JOBSIZE_MIN); /* do not trigger multi-threading when srcSize is too small */
801
802 if (zcs->singleThreaded) {
803 ZSTD_CCtx_params const singleThreadParams = ZSTDMT_makeJobCCtxParams(params);
804 DEBUGLOG(4, "single thread mode");
805 assert(singleThreadParams.nbThreads == 0);
806 return ZSTD_initCStream_internal(zcs->cctxPool->cctx[0],
807 dict, dictSize, cdict,
808 singleThreadParams, pledgedSrcSize);
809 }
810 DEBUGLOG(4, "multi-threading mode (%u threads)", params.nbThreads);
811
812 if (zcs->allJobsCompleted == 0) { /* previous compression not correctly finished */
813 ZSTDMT_waitForAllJobsCompleted(zcs);
814 ZSTDMT_releaseAllJobResources(zcs);
815 zcs->allJobsCompleted = 1;
816 }
817
818 zcs->params = params;
819 zcs->frameContentSize = pledgedSrcSize;
820 if (dict) {
821 ZSTD_freeCDict(zcs->cdictLocal);
822 zcs->cdictLocal = ZSTD_createCDict_advanced(dict, dictSize,
823 ZSTD_dlm_byCopy, dictMode, /* note : a loadPrefix becomes an internal CDict */
824 params.cParams, zcs->cMem);
825 zcs->cdict = zcs->cdictLocal;
826 if (zcs->cdictLocal == NULL) return ERROR(memory_allocation);
827 } else {
828 ZSTD_freeCDict(zcs->cdictLocal);
829 zcs->cdictLocal = NULL;
830 zcs->cdict = cdict;
831 }
832
833 assert(params.overlapSizeLog <= 9);
834 zcs->targetDictSize = (params.overlapSizeLog==0) ? 0 : (size_t)1 << (params.cParams.windowLog - (9 - params.overlapSizeLog));
835 DEBUGLOG(4, "overlapLog=%u => %u KB", params.overlapSizeLog, (U32)(zcs->targetDictSize>>10));
836 zcs->targetSectionSize = params.jobSize ? params.jobSize : (size_t)1 << (params.cParams.windowLog + 2);
837 if (zcs->targetSectionSize < ZSTDMT_JOBSIZE_MIN) zcs->targetSectionSize = ZSTDMT_JOBSIZE_MIN;
838 if (zcs->targetSectionSize < zcs->targetDictSize) zcs->targetSectionSize = zcs->targetDictSize; /* job size must be >= overlap size */
839 DEBUGLOG(4, "Job Size : %u KB (note : set to %u)", (U32)(zcs->targetSectionSize>>10), params.jobSize);
840 zcs->inBuffSize = zcs->targetDictSize + zcs->targetSectionSize;
841 DEBUGLOG(4, "inBuff Size : %u KB", (U32)(zcs->inBuffSize>>10));
842 ZSTDMT_setBufferSize(zcs->bufPool, MAX(zcs->inBuffSize, ZSTD_compressBound(zcs->targetSectionSize)) );
843 zcs->inBuff.buffer = g_nullBuffer;
844 zcs->dictSize = 0;
845 zcs->doneJobID = 0;
846 zcs->nextJobID = 0;
847 zcs->frameEnded = 0;
848 zcs->allJobsCompleted = 0;
849 if (params.fParams.checksumFlag) XXH64_reset(&zcs->xxhState, 0);
850 return 0;
851 }
852
ZSTDMT_initCStream_advanced(ZSTDMT_CCtx * mtctx,const void * dict,size_t dictSize,ZSTD_parameters params,unsigned long long pledgedSrcSize)853 size_t ZSTDMT_initCStream_advanced(ZSTDMT_CCtx* mtctx,
854 const void* dict, size_t dictSize,
855 ZSTD_parameters params,
856 unsigned long long pledgedSrcSize)
857 {
858 ZSTD_CCtx_params cctxParams = mtctx->params;
859 DEBUGLOG(5, "ZSTDMT_initCStream_advanced (pledgedSrcSize=%u)", (U32)pledgedSrcSize);
860 cctxParams.cParams = params.cParams;
861 cctxParams.fParams = params.fParams;
862 return ZSTDMT_initCStream_internal(mtctx, dict, dictSize, ZSTD_dm_auto, NULL,
863 cctxParams, pledgedSrcSize);
864 }
865
ZSTDMT_initCStream_usingCDict(ZSTDMT_CCtx * mtctx,const ZSTD_CDict * cdict,ZSTD_frameParameters fParams,unsigned long long pledgedSrcSize)866 size_t ZSTDMT_initCStream_usingCDict(ZSTDMT_CCtx* mtctx,
867 const ZSTD_CDict* cdict,
868 ZSTD_frameParameters fParams,
869 unsigned long long pledgedSrcSize)
870 {
871 ZSTD_CCtx_params cctxParams = mtctx->params;
872 cctxParams.cParams = ZSTD_getCParamsFromCDict(cdict);
873 cctxParams.fParams = fParams;
874 if (cdict==NULL) return ERROR(dictionary_wrong); /* method incompatible with NULL cdict */
875 return ZSTDMT_initCStream_internal(mtctx, NULL, 0 /*dictSize*/, ZSTD_dm_auto, cdict,
876 cctxParams, pledgedSrcSize);
877 }
878
879
880 /* ZSTDMT_resetCStream() :
881 * pledgedSrcSize can be zero == unknown (for the time being)
882 * prefer using ZSTD_CONTENTSIZE_UNKNOWN,
883 * as `0` might mean "empty" in the future */
ZSTDMT_resetCStream(ZSTDMT_CCtx * zcs,unsigned long long pledgedSrcSize)884 size_t ZSTDMT_resetCStream(ZSTDMT_CCtx* zcs, unsigned long long pledgedSrcSize)
885 {
886 if (!pledgedSrcSize) pledgedSrcSize = ZSTD_CONTENTSIZE_UNKNOWN;
887 if (zcs->params.nbThreads==1)
888 return ZSTD_resetCStream(zcs->cctxPool->cctx[0], pledgedSrcSize);
889 return ZSTDMT_initCStream_internal(zcs, NULL, 0, ZSTD_dm_auto, 0, zcs->params,
890 pledgedSrcSize);
891 }
892
ZSTDMT_initCStream(ZSTDMT_CCtx * zcs,int compressionLevel)893 size_t ZSTDMT_initCStream(ZSTDMT_CCtx* zcs, int compressionLevel) {
894 ZSTD_parameters const params = ZSTD_getParams(compressionLevel, 0, 0);
895 ZSTD_CCtx_params cctxParams = zcs->params;
896 cctxParams.cParams = params.cParams;
897 cctxParams.fParams = params.fParams;
898 return ZSTDMT_initCStream_internal(zcs, NULL, 0, ZSTD_dm_auto, NULL, cctxParams, ZSTD_CONTENTSIZE_UNKNOWN);
899 }
900
901
ZSTDMT_createCompressionJob(ZSTDMT_CCtx * zcs,size_t srcSize,unsigned endFrame)902 static size_t ZSTDMT_createCompressionJob(ZSTDMT_CCtx* zcs, size_t srcSize, unsigned endFrame)
903 {
904 unsigned const jobID = zcs->nextJobID & zcs->jobIDMask;
905
906 DEBUGLOG(5, "ZSTDMT_createCompressionJob: preparing job %u to compress %u bytes with %u preload ",
907 zcs->nextJobID, (U32)srcSize, (U32)zcs->dictSize);
908 zcs->jobs[jobID].src = zcs->inBuff.buffer;
909 zcs->jobs[jobID].srcStart = zcs->inBuff.buffer.start;
910 zcs->jobs[jobID].srcSize = srcSize;
911 zcs->jobs[jobID].prefixSize = zcs->dictSize;
912 assert(zcs->inBuff.filled >= srcSize + zcs->dictSize);
913 zcs->jobs[jobID].params = zcs->params;
914 /* do not calculate checksum within sections, but write it in header for first section */
915 if (zcs->nextJobID) zcs->jobs[jobID].params.fParams.checksumFlag = 0;
916 zcs->jobs[jobID].cdict = zcs->nextJobID==0 ? zcs->cdict : NULL;
917 zcs->jobs[jobID].fullFrameSize = zcs->frameContentSize;
918 zcs->jobs[jobID].dstBuff = g_nullBuffer;
919 zcs->jobs[jobID].cctxPool = zcs->cctxPool;
920 zcs->jobs[jobID].bufPool = zcs->bufPool;
921 zcs->jobs[jobID].firstChunk = (zcs->nextJobID==0);
922 zcs->jobs[jobID].lastChunk = endFrame;
923 zcs->jobs[jobID].jobCompleted = 0;
924 zcs->jobs[jobID].dstFlushed = 0;
925 zcs->jobs[jobID].jobCompleted_mutex = &zcs->jobCompleted_mutex;
926 zcs->jobs[jobID].jobCompleted_cond = &zcs->jobCompleted_cond;
927
928 if (zcs->params.fParams.checksumFlag)
929 XXH64_update(&zcs->xxhState, (const char*)zcs->inBuff.buffer.start + zcs->dictSize, srcSize);
930
931 /* get a new buffer for next input */
932 if (!endFrame) {
933 size_t const newDictSize = MIN(srcSize + zcs->dictSize, zcs->targetDictSize);
934 zcs->inBuff.buffer = ZSTDMT_getBuffer(zcs->bufPool);
935 if (zcs->inBuff.buffer.start == NULL) { /* not enough memory to allocate next input buffer */
936 zcs->jobs[jobID].jobCompleted = 1;
937 zcs->nextJobID++;
938 ZSTDMT_waitForAllJobsCompleted(zcs);
939 ZSTDMT_releaseAllJobResources(zcs);
940 return ERROR(memory_allocation);
941 }
942 zcs->inBuff.filled -= srcSize + zcs->dictSize - newDictSize;
943 memmove(zcs->inBuff.buffer.start,
944 (const char*)zcs->jobs[jobID].srcStart + zcs->dictSize + srcSize - newDictSize,
945 zcs->inBuff.filled);
946 zcs->dictSize = newDictSize;
947 } else { /* if (endFrame==1) */
948 zcs->inBuff.buffer = g_nullBuffer;
949 zcs->inBuff.filled = 0;
950 zcs->dictSize = 0;
951 zcs->frameEnded = 1;
952 if (zcs->nextJobID == 0) {
953 /* single chunk exception : checksum is calculated directly within worker thread */
954 zcs->params.fParams.checksumFlag = 0;
955 } }
956
957 DEBUGLOG(5, "ZSTDMT_createCompressionJob: posting job %u : %u bytes (end:%u) (note : doneJob = %u=>%u)",
958 zcs->nextJobID,
959 (U32)zcs->jobs[jobID].srcSize,
960 zcs->jobs[jobID].lastChunk,
961 zcs->doneJobID,
962 zcs->doneJobID & zcs->jobIDMask);
963 POOL_add(zcs->factory, ZSTDMT_compressChunk, &zcs->jobs[jobID]); /* this call is blocking when thread worker pool is exhausted */
964 zcs->nextJobID++;
965 return 0;
966 }
967
968
969 /* ZSTDMT_flushNextJob() :
970 * output : will be updated with amount of data flushed .
971 * blockToFlush : if >0, the function will block and wait if there is no data available to flush .
972 * @return : amount of data remaining within internal buffer, 1 if unknown but > 0, 0 if no more, or an error code */
ZSTDMT_flushNextJob(ZSTDMT_CCtx * zcs,ZSTD_outBuffer * output,unsigned blockToFlush)973 static size_t ZSTDMT_flushNextJob(ZSTDMT_CCtx* zcs, ZSTD_outBuffer* output, unsigned blockToFlush)
974 {
975 unsigned const wJobID = zcs->doneJobID & zcs->jobIDMask;
976 DEBUGLOG(5, "ZSTDMT_flushNextJob");
977 if (zcs->doneJobID == zcs->nextJobID) return 0; /* all flushed ! */
978 ZSTD_PTHREAD_MUTEX_LOCK(&zcs->jobCompleted_mutex);
979 while (zcs->jobs[wJobID].jobCompleted==0) {
980 DEBUGLOG(5, "waiting for jobCompleted signal from job %u", zcs->doneJobID);
981 if (!blockToFlush) { ZSTD_pthread_mutex_unlock(&zcs->jobCompleted_mutex); return 0; } /* nothing ready to be flushed => skip */
982 ZSTD_pthread_cond_wait(&zcs->jobCompleted_cond, &zcs->jobCompleted_mutex); /* block when nothing available to flush */
983 }
984 ZSTD_pthread_mutex_unlock(&zcs->jobCompleted_mutex);
985 /* compression job completed : output can be flushed */
986 { ZSTDMT_jobDescription job = zcs->jobs[wJobID];
987 if (!job.jobScanned) {
988 if (ZSTD_isError(job.cSize)) {
989 DEBUGLOG(5, "job %u : compression error detected : %s",
990 zcs->doneJobID, ZSTD_getErrorName(job.cSize));
991 ZSTDMT_waitForAllJobsCompleted(zcs);
992 ZSTDMT_releaseAllJobResources(zcs);
993 return job.cSize;
994 }
995 DEBUGLOG(5, "zcs->params.fParams.checksumFlag : %u ", zcs->params.fParams.checksumFlag);
996 if (zcs->params.fParams.checksumFlag) {
997 if (zcs->frameEnded && (zcs->doneJobID+1 == zcs->nextJobID)) { /* write checksum at end of last section */
998 U32 const checksum = (U32)XXH64_digest(&zcs->xxhState);
999 DEBUGLOG(5, "writing checksum : %08X \n", checksum);
1000 MEM_writeLE32((char*)job.dstBuff.start + job.cSize, checksum);
1001 job.cSize += 4;
1002 zcs->jobs[wJobID].cSize += 4;
1003 } }
1004 zcs->jobs[wJobID].jobScanned = 1;
1005 }
1006 { size_t const toWrite = MIN(job.cSize - job.dstFlushed, output->size - output->pos);
1007 DEBUGLOG(5, "Flushing %u bytes from job %u ", (U32)toWrite, zcs->doneJobID);
1008 memcpy((char*)output->dst + output->pos, (const char*)job.dstBuff.start + job.dstFlushed, toWrite);
1009 output->pos += toWrite;
1010 job.dstFlushed += toWrite;
1011 }
1012 if (job.dstFlushed == job.cSize) { /* output buffer fully flushed => move to next one */
1013 ZSTDMT_releaseBuffer(zcs->bufPool, job.dstBuff);
1014 zcs->jobs[wJobID].dstBuff = g_nullBuffer;
1015 zcs->jobs[wJobID].jobCompleted = 0;
1016 zcs->doneJobID++;
1017 } else {
1018 zcs->jobs[wJobID].dstFlushed = job.dstFlushed;
1019 }
1020 /* return value : how many bytes left in buffer ; fake it to 1 if unknown but >0 */
1021 if (job.cSize > job.dstFlushed) return (job.cSize - job.dstFlushed);
1022 if (zcs->doneJobID < zcs->nextJobID) return 1; /* still some buffer to flush */
1023 zcs->allJobsCompleted = zcs->frameEnded; /* frame completed and entirely flushed */
1024 return 0; /* everything flushed */
1025 } }
1026
1027
1028 /** ZSTDMT_compressStream_generic() :
1029 * internal use only - exposed to be invoked from zstd_compress.c
1030 * assumption : output and input are valid (pos <= size)
1031 * @return : minimum amount of data remaining to flush, 0 if none */
ZSTDMT_compressStream_generic(ZSTDMT_CCtx * mtctx,ZSTD_outBuffer * output,ZSTD_inBuffer * input,ZSTD_EndDirective endOp)1032 size_t ZSTDMT_compressStream_generic(ZSTDMT_CCtx* mtctx,
1033 ZSTD_outBuffer* output,
1034 ZSTD_inBuffer* input,
1035 ZSTD_EndDirective endOp)
1036 {
1037 size_t const newJobThreshold = mtctx->dictSize + mtctx->targetSectionSize;
1038 unsigned forwardInputProgress = 0;
1039 DEBUGLOG(5, "ZSTDMT_compressStream_generic ");
1040 assert(output->pos <= output->size);
1041 assert(input->pos <= input->size);
1042
1043 if (mtctx->singleThreaded) { /* delegate to single-thread (synchronous) */
1044 return ZSTD_compressStream_generic(mtctx->cctxPool->cctx[0], output, input, endOp);
1045 }
1046
1047 if ((mtctx->frameEnded) && (endOp==ZSTD_e_continue)) {
1048 /* current frame being ended. Only flush/end are allowed */
1049 return ERROR(stage_wrong);
1050 }
1051
1052 /* single-pass shortcut (note : synchronous-mode) */
1053 if ( (mtctx->nextJobID == 0) /* just started */
1054 && (mtctx->inBuff.filled == 0) /* nothing buffered */
1055 && (endOp == ZSTD_e_end) /* end order */
1056 && (output->size - output->pos >= ZSTD_compressBound(input->size - input->pos)) ) { /* enough room */
1057 size_t const cSize = ZSTDMT_compress_advanced_internal(mtctx,
1058 (char*)output->dst + output->pos, output->size - output->pos,
1059 (const char*)input->src + input->pos, input->size - input->pos,
1060 mtctx->cdict, mtctx->params);
1061 if (ZSTD_isError(cSize)) return cSize;
1062 input->pos = input->size;
1063 output->pos += cSize;
1064 ZSTDMT_releaseBuffer(mtctx->bufPool, mtctx->inBuff.buffer); /* was allocated in initStream */
1065 mtctx->allJobsCompleted = 1;
1066 mtctx->frameEnded = 1;
1067 return 0;
1068 }
1069
1070 /* fill input buffer */
1071 if (input->size > input->pos) { /* support NULL input */
1072 if (mtctx->inBuff.buffer.start == NULL) {
1073 mtctx->inBuff.buffer = ZSTDMT_getBuffer(mtctx->bufPool); /* note : may fail, in which case, no forward input progress */
1074 mtctx->inBuff.filled = 0;
1075 }
1076 if (mtctx->inBuff.buffer.start) {
1077 size_t const toLoad = MIN(input->size - input->pos, mtctx->inBuffSize - mtctx->inBuff.filled);
1078 DEBUGLOG(5, "inBuff:%08X; inBuffSize=%u; ToCopy=%u", (U32)(size_t)mtctx->inBuff.buffer.start, (U32)mtctx->inBuffSize, (U32)toLoad);
1079 memcpy((char*)mtctx->inBuff.buffer.start + mtctx->inBuff.filled, (const char*)input->src + input->pos, toLoad);
1080 input->pos += toLoad;
1081 mtctx->inBuff.filled += toLoad;
1082 forwardInputProgress = toLoad>0;
1083 } }
1084
1085 if ( (mtctx->inBuff.filled >= newJobThreshold) /* filled enough : let's compress */
1086 && (mtctx->nextJobID <= mtctx->doneJobID + mtctx->jobIDMask) ) { /* avoid overwriting job round buffer */
1087 CHECK_F( ZSTDMT_createCompressionJob(mtctx, mtctx->targetSectionSize, 0 /* endFrame */) );
1088 }
1089
1090 /* check for potential compressed data ready to be flushed */
1091 CHECK_F( ZSTDMT_flushNextJob(mtctx, output, !forwardInputProgress /* blockToFlush */) ); /* block if there was no forward input progress */
1092
1093 if (input->pos < input->size) /* input not consumed : do not flush yet */
1094 endOp = ZSTD_e_continue;
1095
1096 switch(endOp)
1097 {
1098 case ZSTD_e_flush:
1099 return ZSTDMT_flushStream(mtctx, output);
1100 case ZSTD_e_end:
1101 return ZSTDMT_endStream(mtctx, output);
1102 case ZSTD_e_continue:
1103 return 1;
1104 default:
1105 return ERROR(GENERIC); /* invalid endDirective */
1106 }
1107 }
1108
1109
ZSTDMT_compressStream(ZSTDMT_CCtx * zcs,ZSTD_outBuffer * output,ZSTD_inBuffer * input)1110 size_t ZSTDMT_compressStream(ZSTDMT_CCtx* zcs, ZSTD_outBuffer* output, ZSTD_inBuffer* input)
1111 {
1112 CHECK_F( ZSTDMT_compressStream_generic(zcs, output, input, ZSTD_e_continue) );
1113
1114 /* recommended next input size : fill current input buffer */
1115 return zcs->inBuffSize - zcs->inBuff.filled; /* note : could be zero when input buffer is fully filled and no more availability to create new job */
1116 }
1117
1118
ZSTDMT_flushStream_internal(ZSTDMT_CCtx * mtctx,ZSTD_outBuffer * output,unsigned endFrame)1119 static size_t ZSTDMT_flushStream_internal(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output, unsigned endFrame)
1120 {
1121 size_t const srcSize = mtctx->inBuff.filled - mtctx->dictSize;
1122 DEBUGLOG(5, "ZSTDMT_flushStream_internal");
1123
1124 if ( ((srcSize > 0) || (endFrame && !mtctx->frameEnded))
1125 && (mtctx->nextJobID <= mtctx->doneJobID + mtctx->jobIDMask) ) {
1126 DEBUGLOG(5, "ZSTDMT_flushStream_internal : create a new job");
1127 CHECK_F( ZSTDMT_createCompressionJob(mtctx, srcSize, endFrame) );
1128 }
1129
1130 /* check if there is any data available to flush */
1131 return ZSTDMT_flushNextJob(mtctx, output, 1 /* blockToFlush */);
1132 }
1133
1134
ZSTDMT_flushStream(ZSTDMT_CCtx * mtctx,ZSTD_outBuffer * output)1135 size_t ZSTDMT_flushStream(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output)
1136 {
1137 DEBUGLOG(5, "ZSTDMT_flushStream");
1138 if (mtctx->singleThreaded)
1139 return ZSTD_flushStream(mtctx->cctxPool->cctx[0], output);
1140 return ZSTDMT_flushStream_internal(mtctx, output, 0 /* endFrame */);
1141 }
1142
ZSTDMT_endStream(ZSTDMT_CCtx * mtctx,ZSTD_outBuffer * output)1143 size_t ZSTDMT_endStream(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output)
1144 {
1145 DEBUGLOG(4, "ZSTDMT_endStream");
1146 if (mtctx->singleThreaded)
1147 return ZSTD_endStream(mtctx->cctxPool->cctx[0], output);
1148 return ZSTDMT_flushStream_internal(mtctx, output, 1 /* endFrame */);
1149 }
1150