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
12 /* **************************************
13 * Tuning parameters
14 ****************************************/
15 #ifndef BMK_TIMETEST_DEFAULT_S /* default minimum time per test */
16 #define BMK_TIMETEST_DEFAULT_S 3
17 #endif
18
19
20 /* *************************************
21 * Includes
22 ***************************************/
23 #include "platform.h" /* Large Files support */
24 #include "util.h" /* UTIL_getFileSize, UTIL_sleep */
25 #include <stdlib.h> /* malloc, free */
26 #include <string.h> /* memset, strerror */
27 #include <stdio.h> /* fprintf, fopen */
28 #include <errno.h>
29 #include <assert.h> /* assert */
30
31 #include "timefn.h" /* UTIL_time_t */
32 #include "benchfn.h"
33 #include "../lib/common/mem.h"
34 #define ZSTD_STATIC_LINKING_ONLY
35 #include "../lib/zstd.h"
36 #include "datagen.h" /* RDG_genBuffer */
37 #include "../lib/common/xxhash.h"
38 #include "benchzstd.h"
39 #include "../lib/zstd_errors.h"
40
41
42 /* *************************************
43 * Constants
44 ***************************************/
45 #ifndef ZSTD_GIT_COMMIT
46 # define ZSTD_GIT_COMMIT_STRING ""
47 #else
48 # define ZSTD_GIT_COMMIT_STRING ZSTD_EXPAND_AND_QUOTE(ZSTD_GIT_COMMIT)
49 #endif
50
51 #define TIMELOOP_MICROSEC (1*1000000ULL) /* 1 second */
52 #define TIMELOOP_NANOSEC (1*1000000000ULL) /* 1 second */
53 #define ACTIVEPERIOD_MICROSEC (70*TIMELOOP_MICROSEC) /* 70 seconds */
54 #define COOLPERIOD_SEC 10
55
56 #define KB *(1 <<10)
57 #define MB *(1 <<20)
58 #define GB *(1U<<30)
59
60 #define BMK_RUNTEST_DEFAULT_MS 1000
61
62 static const size_t maxMemory = (sizeof(size_t)==4) ?
63 /* 32-bit */ (2 GB - 64 MB) :
64 /* 64-bit */ (size_t)(1ULL << ((sizeof(size_t)*8)-31));
65
66
67 /* *************************************
68 * console display
69 ***************************************/
70 #define DISPLAY(...) { fprintf(stderr, __VA_ARGS__); fflush(NULL); }
71 #define DISPLAYLEVEL(l, ...) if (displayLevel>=l) { DISPLAY(__VA_ARGS__); }
72 /* 0 : no display; 1: errors; 2 : + result + interaction + warnings; 3 : + progression; 4 : + information */
73
74
75 /* *************************************
76 * Exceptions
77 ***************************************/
78 #ifndef DEBUG
79 # define DEBUG 0
80 #endif
81 #define DEBUGOUTPUT(...) { if (DEBUG) DISPLAY(__VA_ARGS__); }
82
83 #define RETURN_ERROR_INT(errorNum, ...) { \
84 DEBUGOUTPUT("%s: %i: \n", __FILE__, __LINE__); \
85 DISPLAYLEVEL(1, "Error %i : ", errorNum); \
86 DISPLAYLEVEL(1, __VA_ARGS__); \
87 DISPLAYLEVEL(1, " \n"); \
88 return errorNum; \
89 }
90
91 #define CHECK_Z(zf) { \
92 size_t const zerr = zf; \
93 if (ZSTD_isError(zerr)) { \
94 DEBUGOUTPUT("%s: %i: \n", __FILE__, __LINE__); \
95 DISPLAY("Error : "); \
96 DISPLAY("%s failed : %s", \
97 #zf, ZSTD_getErrorName(zerr)); \
98 DISPLAY(" \n"); \
99 exit(1); \
100 } \
101 }
102
103 #define RETURN_ERROR(errorNum, retType, ...) { \
104 retType r; \
105 memset(&r, 0, sizeof(retType)); \
106 DEBUGOUTPUT("%s: %i: \n", __FILE__, __LINE__); \
107 DISPLAYLEVEL(1, "Error %i : ", errorNum); \
108 DISPLAYLEVEL(1, __VA_ARGS__); \
109 DISPLAYLEVEL(1, " \n"); \
110 r.tag = errorNum; \
111 return r; \
112 }
113
114
115 /* *************************************
116 * Benchmark Parameters
117 ***************************************/
118
BMK_initAdvancedParams(void)119 BMK_advancedParams_t BMK_initAdvancedParams(void) {
120 BMK_advancedParams_t const res = {
121 BMK_both, /* mode */
122 BMK_TIMETEST_DEFAULT_S, /* nbSeconds */
123 0, /* blockSize */
124 0, /* nbWorkers */
125 0, /* realTime */
126 0, /* additionalParam */
127 0, /* ldmFlag */
128 0, /* ldmMinMatch */
129 0, /* ldmHashLog */
130 0, /* ldmBuckSizeLog */
131 0, /* ldmHashRateLog */
132 ZSTD_lcm_auto, /* literalCompressionMode */
133 0 /* useRowMatchFinder */
134 };
135 return res;
136 }
137
138
139 /* ********************************************************
140 * Bench functions
141 **********************************************************/
142 typedef struct {
143 const void* srcPtr;
144 size_t srcSize;
145 void* cPtr;
146 size_t cRoom;
147 size_t cSize;
148 void* resPtr;
149 size_t resSize;
150 } blockParam_t;
151
152 #undef MIN
153 #undef MAX
154 #define MIN(a,b) ((a) < (b) ? (a) : (b))
155 #define MAX(a,b) ((a) > (b) ? (a) : (b))
156
157 static void
BMK_initCCtx(ZSTD_CCtx * ctx,const void * dictBuffer,size_t dictBufferSize,int cLevel,const ZSTD_compressionParameters * comprParams,const BMK_advancedParams_t * adv)158 BMK_initCCtx(ZSTD_CCtx* ctx,
159 const void* dictBuffer, size_t dictBufferSize,
160 int cLevel,
161 const ZSTD_compressionParameters* comprParams,
162 const BMK_advancedParams_t* adv)
163 {
164 ZSTD_CCtx_reset(ctx, ZSTD_reset_session_and_parameters);
165 if (adv->nbWorkers==1) {
166 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_nbWorkers, 0));
167 } else {
168 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_nbWorkers, adv->nbWorkers));
169 }
170 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_compressionLevel, cLevel));
171 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_useRowMatchFinder, adv->useRowMatchFinder));
172 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_enableLongDistanceMatching, adv->ldmFlag));
173 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_ldmMinMatch, adv->ldmMinMatch));
174 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_ldmHashLog, adv->ldmHashLog));
175 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_ldmBucketSizeLog, adv->ldmBucketSizeLog));
176 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_ldmHashRateLog, adv->ldmHashRateLog));
177 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_windowLog, (int)comprParams->windowLog));
178 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_hashLog, (int)comprParams->hashLog));
179 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_chainLog, (int)comprParams->chainLog));
180 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_searchLog, (int)comprParams->searchLog));
181 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_minMatch, (int)comprParams->minMatch));
182 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_targetLength, (int)comprParams->targetLength));
183 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_literalCompressionMode, (int)adv->literalCompressionMode));
184 CHECK_Z(ZSTD_CCtx_setParameter(ctx, ZSTD_c_strategy, comprParams->strategy));
185 CHECK_Z(ZSTD_CCtx_loadDictionary(ctx, dictBuffer, dictBufferSize));
186 }
187
BMK_initDCtx(ZSTD_DCtx * dctx,const void * dictBuffer,size_t dictBufferSize)188 static void BMK_initDCtx(ZSTD_DCtx* dctx,
189 const void* dictBuffer, size_t dictBufferSize) {
190 CHECK_Z(ZSTD_DCtx_reset(dctx, ZSTD_reset_session_and_parameters));
191 CHECK_Z(ZSTD_DCtx_loadDictionary(dctx, dictBuffer, dictBufferSize));
192 }
193
194
195 typedef struct {
196 ZSTD_CCtx* cctx;
197 const void* dictBuffer;
198 size_t dictBufferSize;
199 int cLevel;
200 const ZSTD_compressionParameters* comprParams;
201 const BMK_advancedParams_t* adv;
202 } BMK_initCCtxArgs;
203
local_initCCtx(void * payload)204 static size_t local_initCCtx(void* payload) {
205 BMK_initCCtxArgs* ag = (BMK_initCCtxArgs*)payload;
206 BMK_initCCtx(ag->cctx, ag->dictBuffer, ag->dictBufferSize, ag->cLevel, ag->comprParams, ag->adv);
207 return 0;
208 }
209
210 typedef struct {
211 ZSTD_DCtx* dctx;
212 const void* dictBuffer;
213 size_t dictBufferSize;
214 } BMK_initDCtxArgs;
215
local_initDCtx(void * payload)216 static size_t local_initDCtx(void* payload) {
217 BMK_initDCtxArgs* ag = (BMK_initDCtxArgs*)payload;
218 BMK_initDCtx(ag->dctx, ag->dictBuffer, ag->dictBufferSize);
219 return 0;
220 }
221
222
223 /* `addArgs` is the context */
local_defaultCompress(const void * srcBuffer,size_t srcSize,void * dstBuffer,size_t dstSize,void * addArgs)224 static size_t local_defaultCompress(
225 const void* srcBuffer, size_t srcSize,
226 void* dstBuffer, size_t dstSize,
227 void* addArgs)
228 {
229 ZSTD_CCtx* const cctx = (ZSTD_CCtx*)addArgs;
230 return ZSTD_compress2(cctx, dstBuffer, dstSize, srcBuffer, srcSize);
231 }
232
233 /* `addArgs` is the context */
local_defaultDecompress(const void * srcBuffer,size_t srcSize,void * dstBuffer,size_t dstCapacity,void * addArgs)234 static size_t local_defaultDecompress(
235 const void* srcBuffer, size_t srcSize,
236 void* dstBuffer, size_t dstCapacity,
237 void* addArgs)
238 {
239 size_t moreToFlush = 1;
240 ZSTD_DCtx* const dctx = (ZSTD_DCtx*)addArgs;
241 ZSTD_inBuffer in;
242 ZSTD_outBuffer out;
243 in.src = srcBuffer; in.size = srcSize; in.pos = 0;
244 out.dst = dstBuffer; out.size = dstCapacity; out.pos = 0;
245 while (moreToFlush) {
246 if(out.pos == out.size) {
247 return (size_t)-ZSTD_error_dstSize_tooSmall;
248 }
249 moreToFlush = ZSTD_decompressStream(dctx, &out, &in);
250 if (ZSTD_isError(moreToFlush)) {
251 return moreToFlush;
252 }
253 }
254 return out.pos;
255
256 }
257
258
259 /* ================================================================= */
260 /* Benchmark Zstandard, mem-to-mem scenarios */
261 /* ================================================================= */
262
BMK_isSuccessful_benchOutcome(BMK_benchOutcome_t outcome)263 int BMK_isSuccessful_benchOutcome(BMK_benchOutcome_t outcome)
264 {
265 return outcome.tag == 0;
266 }
267
BMK_extract_benchResult(BMK_benchOutcome_t outcome)268 BMK_benchResult_t BMK_extract_benchResult(BMK_benchOutcome_t outcome)
269 {
270 assert(outcome.tag == 0);
271 return outcome.internal_never_use_directly;
272 }
273
BMK_benchOutcome_error(void)274 static BMK_benchOutcome_t BMK_benchOutcome_error(void)
275 {
276 BMK_benchOutcome_t b;
277 memset(&b, 0, sizeof(b));
278 b.tag = 1;
279 return b;
280 }
281
BMK_benchOutcome_setValidResult(BMK_benchResult_t result)282 static BMK_benchOutcome_t BMK_benchOutcome_setValidResult(BMK_benchResult_t result)
283 {
284 BMK_benchOutcome_t b;
285 b.tag = 0;
286 b.internal_never_use_directly = result;
287 return b;
288 }
289
290
291 /* benchMem with no allocation */
292 static BMK_benchOutcome_t
BMK_benchMemAdvancedNoAlloc(const void ** srcPtrs,size_t * srcSizes,void ** cPtrs,size_t * cCapacities,size_t * cSizes,void ** resPtrs,size_t * resSizes,void ** resultBufferPtr,void * compressedBuffer,size_t maxCompressedSize,BMK_timedFnState_t * timeStateCompress,BMK_timedFnState_t * timeStateDecompress,const void * srcBuffer,size_t srcSize,const size_t * fileSizes,unsigned nbFiles,const int cLevel,const ZSTD_compressionParameters * comprParams,const void * dictBuffer,size_t dictBufferSize,ZSTD_CCtx * cctx,ZSTD_DCtx * dctx,int displayLevel,const char * displayName,const BMK_advancedParams_t * adv)293 BMK_benchMemAdvancedNoAlloc(
294 const void** srcPtrs, size_t* srcSizes,
295 void** cPtrs, size_t* cCapacities, size_t* cSizes,
296 void** resPtrs, size_t* resSizes,
297 void** resultBufferPtr, void* compressedBuffer,
298 size_t maxCompressedSize,
299 BMK_timedFnState_t* timeStateCompress,
300 BMK_timedFnState_t* timeStateDecompress,
301
302 const void* srcBuffer, size_t srcSize,
303 const size_t* fileSizes, unsigned nbFiles,
304 const int cLevel,
305 const ZSTD_compressionParameters* comprParams,
306 const void* dictBuffer, size_t dictBufferSize,
307 ZSTD_CCtx* cctx, ZSTD_DCtx* dctx,
308 int displayLevel, const char* displayName,
309 const BMK_advancedParams_t* adv)
310 {
311 size_t const blockSize = ((adv->blockSize>=32 && (adv->mode != BMK_decodeOnly)) ? adv->blockSize : srcSize) + (!srcSize); /* avoid div by 0 */
312 BMK_benchResult_t benchResult;
313 size_t const loadedCompressedSize = srcSize;
314 size_t cSize = 0;
315 double ratio = 0.;
316 U32 nbBlocks;
317
318 assert(cctx != NULL); assert(dctx != NULL);
319
320 /* init */
321 memset(&benchResult, 0, sizeof(benchResult));
322 if (strlen(displayName)>17) displayName += strlen(displayName) - 17; /* display last 17 characters */
323 if (adv->mode == BMK_decodeOnly) { /* benchmark only decompression : source must be already compressed */
324 const char* srcPtr = (const char*)srcBuffer;
325 U64 totalDSize64 = 0;
326 U32 fileNb;
327 for (fileNb=0; fileNb<nbFiles; fileNb++) {
328 U64 const fSize64 = ZSTD_findDecompressedSize(srcPtr, fileSizes[fileNb]);
329 if (fSize64==0) RETURN_ERROR(32, BMK_benchOutcome_t, "Impossible to determine original size ");
330 totalDSize64 += fSize64;
331 srcPtr += fileSizes[fileNb];
332 }
333 { size_t const decodedSize = (size_t)totalDSize64;
334 assert((U64)decodedSize == totalDSize64); /* check overflow */
335 free(*resultBufferPtr);
336 *resultBufferPtr = malloc(decodedSize);
337 if (!(*resultBufferPtr)) {
338 RETURN_ERROR(33, BMK_benchOutcome_t, "not enough memory");
339 }
340 if (totalDSize64 > decodedSize) { /* size_t overflow */
341 free(*resultBufferPtr);
342 RETURN_ERROR(32, BMK_benchOutcome_t, "original size is too large");
343 }
344 cSize = srcSize;
345 srcSize = decodedSize;
346 ratio = (double)srcSize / (double)cSize;
347 }
348 }
349
350 /* Init data blocks */
351 { const char* srcPtr = (const char*)srcBuffer;
352 char* cPtr = (char*)compressedBuffer;
353 char* resPtr = (char*)(*resultBufferPtr);
354 U32 fileNb;
355 for (nbBlocks=0, fileNb=0; fileNb<nbFiles; fileNb++) {
356 size_t remaining = fileSizes[fileNb];
357 U32 const nbBlocksforThisFile = (adv->mode == BMK_decodeOnly) ? 1 : (U32)((remaining + (blockSize-1)) / blockSize);
358 U32 const blockEnd = nbBlocks + nbBlocksforThisFile;
359 for ( ; nbBlocks<blockEnd; nbBlocks++) {
360 size_t const thisBlockSize = MIN(remaining, blockSize);
361 srcPtrs[nbBlocks] = srcPtr;
362 srcSizes[nbBlocks] = thisBlockSize;
363 cPtrs[nbBlocks] = cPtr;
364 cCapacities[nbBlocks] = (adv->mode == BMK_decodeOnly) ? thisBlockSize : ZSTD_compressBound(thisBlockSize);
365 resPtrs[nbBlocks] = resPtr;
366 resSizes[nbBlocks] = (adv->mode == BMK_decodeOnly) ? (size_t) ZSTD_findDecompressedSize(srcPtr, thisBlockSize) : thisBlockSize;
367 srcPtr += thisBlockSize;
368 cPtr += cCapacities[nbBlocks];
369 resPtr += thisBlockSize;
370 remaining -= thisBlockSize;
371 if (adv->mode == BMK_decodeOnly) {
372 cSizes[nbBlocks] = thisBlockSize;
373 benchResult.cSize = thisBlockSize;
374 }
375 }
376 }
377 }
378
379 /* warming up `compressedBuffer` */
380 if (adv->mode == BMK_decodeOnly) {
381 memcpy(compressedBuffer, srcBuffer, loadedCompressedSize);
382 } else {
383 RDG_genBuffer(compressedBuffer, maxCompressedSize, 0.10, 0.50, 1);
384 }
385
386 /* Bench */
387 { U64 const crcOrig = (adv->mode == BMK_decodeOnly) ? 0 : XXH64(srcBuffer, srcSize, 0);
388 # define NB_MARKS 4
389 const char* marks[NB_MARKS] = { " |", " /", " =", " \\" };
390 U32 markNb = 0;
391 int compressionCompleted = (adv->mode == BMK_decodeOnly);
392 int decompressionCompleted = (adv->mode == BMK_compressOnly);
393 BMK_benchParams_t cbp, dbp;
394 BMK_initCCtxArgs cctxprep;
395 BMK_initDCtxArgs dctxprep;
396
397 cbp.benchFn = local_defaultCompress; /* ZSTD_compress2 */
398 cbp.benchPayload = cctx;
399 cbp.initFn = local_initCCtx; /* BMK_initCCtx */
400 cbp.initPayload = &cctxprep;
401 cbp.errorFn = ZSTD_isError;
402 cbp.blockCount = nbBlocks;
403 cbp.srcBuffers = srcPtrs;
404 cbp.srcSizes = srcSizes;
405 cbp.dstBuffers = cPtrs;
406 cbp.dstCapacities = cCapacities;
407 cbp.blockResults = cSizes;
408
409 cctxprep.cctx = cctx;
410 cctxprep.dictBuffer = dictBuffer;
411 cctxprep.dictBufferSize = dictBufferSize;
412 cctxprep.cLevel = cLevel;
413 cctxprep.comprParams = comprParams;
414 cctxprep.adv = adv;
415
416 dbp.benchFn = local_defaultDecompress;
417 dbp.benchPayload = dctx;
418 dbp.initFn = local_initDCtx;
419 dbp.initPayload = &dctxprep;
420 dbp.errorFn = ZSTD_isError;
421 dbp.blockCount = nbBlocks;
422 dbp.srcBuffers = (const void* const *) cPtrs;
423 dbp.srcSizes = cSizes;
424 dbp.dstBuffers = resPtrs;
425 dbp.dstCapacities = resSizes;
426 dbp.blockResults = NULL;
427
428 dctxprep.dctx = dctx;
429 dctxprep.dictBuffer = dictBuffer;
430 dctxprep.dictBufferSize = dictBufferSize;
431
432 DISPLAYLEVEL(2, "\r%70s\r", ""); /* blank line */
433 DISPLAYLEVEL(2, "%2s-%-17.17s :%10u ->\r", marks[markNb], displayName, (unsigned)srcSize);
434
435 while (!(compressionCompleted && decompressionCompleted)) {
436 if (!compressionCompleted) {
437 BMK_runOutcome_t const cOutcome = BMK_benchTimedFn( timeStateCompress, cbp);
438
439 if (!BMK_isSuccessful_runOutcome(cOutcome)) {
440 return BMK_benchOutcome_error();
441 }
442
443 { BMK_runTime_t const cResult = BMK_extract_runTime(cOutcome);
444 cSize = cResult.sumOfReturn;
445 ratio = (double)srcSize / cSize;
446 { BMK_benchResult_t newResult;
447 newResult.cSpeed = (U64)((double)srcSize * TIMELOOP_NANOSEC / cResult.nanoSecPerRun);
448 benchResult.cSize = cSize;
449 if (newResult.cSpeed > benchResult.cSpeed)
450 benchResult.cSpeed = newResult.cSpeed;
451 } }
452
453 { int const ratioAccuracy = (ratio < 10.) ? 3 : 2;
454 DISPLAYLEVEL(2, "%2s-%-17.17s :%10u ->%10u (%5.*f),%6.*f MB/s\r",
455 marks[markNb], displayName,
456 (unsigned)srcSize, (unsigned)cSize,
457 ratioAccuracy, ratio,
458 benchResult.cSpeed < (10 MB) ? 2 : 1, (double)benchResult.cSpeed / MB_UNIT);
459 }
460 compressionCompleted = BMK_isCompleted_TimedFn(timeStateCompress);
461 }
462
463 if(!decompressionCompleted) {
464 BMK_runOutcome_t const dOutcome = BMK_benchTimedFn(timeStateDecompress, dbp);
465
466 if(!BMK_isSuccessful_runOutcome(dOutcome)) {
467 return BMK_benchOutcome_error();
468 }
469
470 { BMK_runTime_t const dResult = BMK_extract_runTime(dOutcome);
471 U64 const newDSpeed = (U64)((double)srcSize * TIMELOOP_NANOSEC / dResult.nanoSecPerRun);
472 if (newDSpeed > benchResult.dSpeed)
473 benchResult.dSpeed = newDSpeed;
474 }
475
476 { int const ratioAccuracy = (ratio < 10.) ? 3 : 2;
477 DISPLAYLEVEL(2, "%2s-%-17.17s :%10u ->%10u (%5.*f),%6.*f MB/s ,%6.1f MB/s \r",
478 marks[markNb], displayName,
479 (unsigned)srcSize, (unsigned)cSize,
480 ratioAccuracy, ratio,
481 benchResult.cSpeed < (10 MB) ? 2 : 1, (double)benchResult.cSpeed / MB_UNIT,
482 (double)benchResult.dSpeed / MB_UNIT);
483 }
484 decompressionCompleted = BMK_isCompleted_TimedFn(timeStateDecompress);
485 }
486 markNb = (markNb+1) % NB_MARKS;
487 } /* while (!(compressionCompleted && decompressionCompleted)) */
488
489 /* CRC Checking */
490 { const BYTE* resultBuffer = (const BYTE*)(*resultBufferPtr);
491 U64 const crcCheck = XXH64(resultBuffer, srcSize, 0);
492 if ((adv->mode == BMK_both) && (crcOrig!=crcCheck)) {
493 size_t u;
494 DISPLAY("!!! WARNING !!! %14s : Invalid Checksum : %x != %x \n",
495 displayName, (unsigned)crcOrig, (unsigned)crcCheck);
496 for (u=0; u<srcSize; u++) {
497 if (((const BYTE*)srcBuffer)[u] != resultBuffer[u]) {
498 unsigned segNb, bNb, pos;
499 size_t bacc = 0;
500 DISPLAY("Decoding error at pos %u ", (unsigned)u);
501 for (segNb = 0; segNb < nbBlocks; segNb++) {
502 if (bacc + srcSizes[segNb] > u) break;
503 bacc += srcSizes[segNb];
504 }
505 pos = (U32)(u - bacc);
506 bNb = pos / (128 KB);
507 DISPLAY("(sample %u, block %u, pos %u) \n", segNb, bNb, pos);
508 { size_t const lowest = (u>5) ? 5 : u;
509 size_t n;
510 DISPLAY("origin: ");
511 for (n=lowest; n>0; n--)
512 DISPLAY("%02X ", ((const BYTE*)srcBuffer)[u-n]);
513 DISPLAY(" :%02X: ", ((const BYTE*)srcBuffer)[u]);
514 for (n=1; n<3; n++)
515 DISPLAY("%02X ", ((const BYTE*)srcBuffer)[u+n]);
516 DISPLAY(" \n");
517 DISPLAY("decode: ");
518 for (n=lowest; n>0; n++)
519 DISPLAY("%02X ", resultBuffer[u-n]);
520 DISPLAY(" :%02X: ", resultBuffer[u]);
521 for (n=1; n<3; n++)
522 DISPLAY("%02X ", resultBuffer[u+n]);
523 DISPLAY(" \n");
524 }
525 break;
526 }
527 if (u==srcSize-1) { /* should never happen */
528 DISPLAY("no difference detected\n");
529 }
530 } /* for (u=0; u<srcSize; u++) */
531 } /* if ((adv->mode == BMK_both) && (crcOrig!=crcCheck)) */
532 } /* CRC Checking */
533
534 if (displayLevel == 1) { /* hidden display mode -q, used by python speed benchmark */
535 double const cSpeed = (double)benchResult.cSpeed / MB_UNIT;
536 double const dSpeed = (double)benchResult.dSpeed / MB_UNIT;
537 if (adv->additionalParam) {
538 DISPLAY("-%-3i%11i (%5.3f) %6.2f MB/s %6.1f MB/s %s (param=%d)\n", cLevel, (int)cSize, ratio, cSpeed, dSpeed, displayName, adv->additionalParam);
539 } else {
540 DISPLAY("-%-3i%11i (%5.3f) %6.2f MB/s %6.1f MB/s %s\n", cLevel, (int)cSize, ratio, cSpeed, dSpeed, displayName);
541 }
542 }
543
544 DISPLAYLEVEL(2, "%2i#\n", cLevel);
545 } /* Bench */
546
547 benchResult.cMem = (1ULL << (comprParams->windowLog)) + ZSTD_sizeof_CCtx(cctx);
548 return BMK_benchOutcome_setValidResult(benchResult);
549 }
550
BMK_benchMemAdvanced(const void * srcBuffer,size_t srcSize,void * dstBuffer,size_t dstCapacity,const size_t * fileSizes,unsigned nbFiles,int cLevel,const ZSTD_compressionParameters * comprParams,const void * dictBuffer,size_t dictBufferSize,int displayLevel,const char * displayName,const BMK_advancedParams_t * adv)551 BMK_benchOutcome_t BMK_benchMemAdvanced(const void* srcBuffer, size_t srcSize,
552 void* dstBuffer, size_t dstCapacity,
553 const size_t* fileSizes, unsigned nbFiles,
554 int cLevel, const ZSTD_compressionParameters* comprParams,
555 const void* dictBuffer, size_t dictBufferSize,
556 int displayLevel, const char* displayName, const BMK_advancedParams_t* adv)
557
558 {
559 int const dstParamsError = !dstBuffer ^ !dstCapacity; /* must be both NULL or none */
560
561 size_t const blockSize = ((adv->blockSize>=32 && (adv->mode != BMK_decodeOnly)) ? adv->blockSize : srcSize) + (!srcSize) /* avoid div by 0 */ ;
562 U32 const maxNbBlocks = (U32) ((srcSize + (blockSize-1)) / blockSize) + nbFiles;
563
564 /* these are the blockTable parameters, just split up */
565 const void ** const srcPtrs = (const void**)malloc(maxNbBlocks * sizeof(void*));
566 size_t* const srcSizes = (size_t*)malloc(maxNbBlocks * sizeof(size_t));
567
568
569 void ** const cPtrs = (void**)malloc(maxNbBlocks * sizeof(void*));
570 size_t* const cSizes = (size_t*)malloc(maxNbBlocks * sizeof(size_t));
571 size_t* const cCapacities = (size_t*)malloc(maxNbBlocks * sizeof(size_t));
572
573 void ** const resPtrs = (void**)malloc(maxNbBlocks * sizeof(void*));
574 size_t* const resSizes = (size_t*)malloc(maxNbBlocks * sizeof(size_t));
575
576 BMK_timedFnState_t* timeStateCompress = BMK_createTimedFnState(adv->nbSeconds * 1000, BMK_RUNTEST_DEFAULT_MS);
577 BMK_timedFnState_t* timeStateDecompress = BMK_createTimedFnState(adv->nbSeconds * 1000, BMK_RUNTEST_DEFAULT_MS);
578
579 ZSTD_CCtx* const cctx = ZSTD_createCCtx();
580 ZSTD_DCtx* const dctx = ZSTD_createDCtx();
581
582 const size_t maxCompressedSize = dstCapacity ? dstCapacity : ZSTD_compressBound(srcSize) + (maxNbBlocks * 1024);
583
584 void* const internalDstBuffer = dstBuffer ? NULL : malloc(maxCompressedSize);
585 void* const compressedBuffer = dstBuffer ? dstBuffer : internalDstBuffer;
586
587 BMK_benchOutcome_t outcome = BMK_benchOutcome_error(); /* error by default */
588
589 void* resultBuffer = srcSize ? malloc(srcSize) : NULL;
590
591 int allocationincomplete = !srcPtrs || !srcSizes || !cPtrs ||
592 !cSizes || !cCapacities || !resPtrs || !resSizes ||
593 !timeStateCompress || !timeStateDecompress ||
594 !cctx || !dctx ||
595 !compressedBuffer || !resultBuffer;
596
597
598 if (!allocationincomplete && !dstParamsError) {
599 outcome = BMK_benchMemAdvancedNoAlloc(srcPtrs, srcSizes,
600 cPtrs, cCapacities, cSizes,
601 resPtrs, resSizes,
602 &resultBuffer,
603 compressedBuffer, maxCompressedSize,
604 timeStateCompress, timeStateDecompress,
605 srcBuffer, srcSize,
606 fileSizes, nbFiles,
607 cLevel, comprParams,
608 dictBuffer, dictBufferSize,
609 cctx, dctx,
610 displayLevel, displayName, adv);
611 }
612
613 /* clean up */
614 BMK_freeTimedFnState(timeStateCompress);
615 BMK_freeTimedFnState(timeStateDecompress);
616
617 ZSTD_freeCCtx(cctx);
618 ZSTD_freeDCtx(dctx);
619
620 free(internalDstBuffer);
621 free(resultBuffer);
622
623 free((void*)srcPtrs);
624 free(srcSizes);
625 free(cPtrs);
626 free(cSizes);
627 free(cCapacities);
628 free(resPtrs);
629 free(resSizes);
630
631 if(allocationincomplete) {
632 RETURN_ERROR(31, BMK_benchOutcome_t, "allocation error : not enough memory");
633 }
634
635 if(dstParamsError) {
636 RETURN_ERROR(32, BMK_benchOutcome_t, "Dst parameters not coherent");
637 }
638 return outcome;
639 }
640
BMK_benchMem(const void * srcBuffer,size_t srcSize,const size_t * fileSizes,unsigned nbFiles,int cLevel,const ZSTD_compressionParameters * comprParams,const void * dictBuffer,size_t dictBufferSize,int displayLevel,const char * displayName)641 BMK_benchOutcome_t BMK_benchMem(const void* srcBuffer, size_t srcSize,
642 const size_t* fileSizes, unsigned nbFiles,
643 int cLevel, const ZSTD_compressionParameters* comprParams,
644 const void* dictBuffer, size_t dictBufferSize,
645 int displayLevel, const char* displayName) {
646
647 BMK_advancedParams_t const adv = BMK_initAdvancedParams();
648 return BMK_benchMemAdvanced(srcBuffer, srcSize,
649 NULL, 0,
650 fileSizes, nbFiles,
651 cLevel, comprParams,
652 dictBuffer, dictBufferSize,
653 displayLevel, displayName, &adv);
654 }
655
BMK_benchCLevel(const void * srcBuffer,size_t benchedSize,const size_t * fileSizes,unsigned nbFiles,int cLevel,const ZSTD_compressionParameters * comprParams,const void * dictBuffer,size_t dictBufferSize,int displayLevel,const char * displayName,BMK_advancedParams_t const * const adv)656 static BMK_benchOutcome_t BMK_benchCLevel(const void* srcBuffer, size_t benchedSize,
657 const size_t* fileSizes, unsigned nbFiles,
658 int cLevel, const ZSTD_compressionParameters* comprParams,
659 const void* dictBuffer, size_t dictBufferSize,
660 int displayLevel, const char* displayName,
661 BMK_advancedParams_t const * const adv)
662 {
663 const char* pch = strrchr(displayName, '\\'); /* Windows */
664 if (!pch) pch = strrchr(displayName, '/'); /* Linux */
665 if (pch) displayName = pch+1;
666
667 if (adv->realTime) {
668 DISPLAYLEVEL(2, "Note : switching to real-time priority \n");
669 SET_REALTIME_PRIORITY;
670 }
671
672 if (displayLevel == 1 && !adv->additionalParam) /* --quiet mode */
673 DISPLAY("bench %s %s: input %u bytes, %u seconds, %u KB blocks\n",
674 ZSTD_VERSION_STRING, ZSTD_GIT_COMMIT_STRING,
675 (unsigned)benchedSize, adv->nbSeconds, (unsigned)(adv->blockSize>>10));
676
677 return BMK_benchMemAdvanced(srcBuffer, benchedSize,
678 NULL, 0,
679 fileSizes, nbFiles,
680 cLevel, comprParams,
681 dictBuffer, dictBufferSize,
682 displayLevel, displayName, adv);
683 }
684
BMK_syntheticTest(int cLevel,double compressibility,const ZSTD_compressionParameters * compressionParams,int displayLevel,const BMK_advancedParams_t * adv)685 BMK_benchOutcome_t BMK_syntheticTest(int cLevel, double compressibility,
686 const ZSTD_compressionParameters* compressionParams,
687 int displayLevel, const BMK_advancedParams_t* adv)
688 {
689 char name[20] = {0};
690 size_t const benchedSize = 10000000;
691 void* srcBuffer;
692 BMK_benchOutcome_t res;
693
694 if (cLevel > ZSTD_maxCLevel()) {
695 RETURN_ERROR(15, BMK_benchOutcome_t, "Invalid Compression Level");
696 }
697
698 /* Memory allocation */
699 srcBuffer = malloc(benchedSize);
700 if (!srcBuffer) RETURN_ERROR(21, BMK_benchOutcome_t, "not enough memory");
701
702 /* Fill input buffer */
703 RDG_genBuffer(srcBuffer, benchedSize, compressibility, 0.0, 0);
704
705 /* Bench */
706 snprintf (name, sizeof(name), "Synthetic %2u%%", (unsigned)(compressibility*100));
707 res = BMK_benchCLevel(srcBuffer, benchedSize,
708 &benchedSize /* ? */, 1 /* ? */,
709 cLevel, compressionParams,
710 NULL, 0, /* dictionary */
711 displayLevel, name, adv);
712
713 /* clean up */
714 free(srcBuffer);
715
716 return res;
717 }
718
719
720
BMK_findMaxMem(U64 requiredMem)721 static size_t BMK_findMaxMem(U64 requiredMem)
722 {
723 size_t const step = 64 MB;
724 BYTE* testmem = NULL;
725
726 requiredMem = (((requiredMem >> 26) + 1) << 26);
727 requiredMem += step;
728 if (requiredMem > maxMemory) requiredMem = maxMemory;
729
730 do {
731 testmem = (BYTE*)malloc((size_t)requiredMem);
732 requiredMem -= step;
733 } while (!testmem && requiredMem > 0);
734
735 free(testmem);
736 return (size_t)(requiredMem);
737 }
738
739 /*! BMK_loadFiles() :
740 * Loads `buffer` with content of files listed within `fileNamesTable`.
741 * At most, fills `buffer` entirely. */
BMK_loadFiles(void * buffer,size_t bufferSize,size_t * fileSizes,const char * const * fileNamesTable,unsigned nbFiles,int displayLevel)742 static int BMK_loadFiles(void* buffer, size_t bufferSize,
743 size_t* fileSizes,
744 const char* const * fileNamesTable, unsigned nbFiles,
745 int displayLevel)
746 {
747 size_t pos = 0, totalSize = 0;
748 unsigned n;
749 for (n=0; n<nbFiles; n++) {
750 U64 fileSize = UTIL_getFileSize(fileNamesTable[n]); /* last file may be shortened */
751 if (UTIL_isDirectory(fileNamesTable[n])) {
752 DISPLAYLEVEL(2, "Ignoring %s directory... \n", fileNamesTable[n]);
753 fileSizes[n] = 0;
754 continue;
755 }
756 if (fileSize == UTIL_FILESIZE_UNKNOWN) {
757 DISPLAYLEVEL(2, "Cannot evaluate size of %s, ignoring ... \n", fileNamesTable[n]);
758 fileSizes[n] = 0;
759 continue;
760 }
761 { FILE* const f = fopen(fileNamesTable[n], "rb");
762 if (f==NULL) RETURN_ERROR_INT(10, "impossible to open file %s", fileNamesTable[n]);
763 DISPLAYLEVEL(2, "Loading %s... \r", fileNamesTable[n]);
764 if (fileSize > bufferSize-pos) fileSize = bufferSize-pos, nbFiles=n; /* buffer too small - stop after this file */
765 { size_t const readSize = fread(((char*)buffer)+pos, 1, (size_t)fileSize, f);
766 if (readSize != (size_t)fileSize) RETURN_ERROR_INT(11, "could not read %s", fileNamesTable[n]);
767 pos += readSize;
768 }
769 fileSizes[n] = (size_t)fileSize;
770 totalSize += (size_t)fileSize;
771 fclose(f);
772 } }
773
774 if (totalSize == 0) RETURN_ERROR_INT(12, "no data to bench");
775 return 0;
776 }
777
BMK_benchFilesAdvanced(const char * const * fileNamesTable,unsigned nbFiles,const char * dictFileName,int cLevel,const ZSTD_compressionParameters * compressionParams,int displayLevel,const BMK_advancedParams_t * adv)778 BMK_benchOutcome_t BMK_benchFilesAdvanced(
779 const char* const * fileNamesTable, unsigned nbFiles,
780 const char* dictFileName, int cLevel,
781 const ZSTD_compressionParameters* compressionParams,
782 int displayLevel, const BMK_advancedParams_t* adv)
783 {
784 void* srcBuffer = NULL;
785 size_t benchedSize;
786 void* dictBuffer = NULL;
787 size_t dictBufferSize = 0;
788 size_t* fileSizes = NULL;
789 BMK_benchOutcome_t res;
790 U64 const totalSizeToLoad = UTIL_getTotalFileSize(fileNamesTable, nbFiles);
791
792 if (!nbFiles) {
793 RETURN_ERROR(14, BMK_benchOutcome_t, "No Files to Benchmark");
794 }
795
796 if (cLevel > ZSTD_maxCLevel()) {
797 RETURN_ERROR(15, BMK_benchOutcome_t, "Invalid Compression Level");
798 }
799
800 fileSizes = (size_t*)calloc(nbFiles, sizeof(size_t));
801 if (!fileSizes) RETURN_ERROR(12, BMK_benchOutcome_t, "not enough memory for fileSizes");
802
803 /* Load dictionary */
804 if (dictFileName != NULL) {
805 U64 const dictFileSize = UTIL_getFileSize(dictFileName);
806 if (dictFileSize == UTIL_FILESIZE_UNKNOWN) {
807 DISPLAYLEVEL(1, "error loading %s : %s \n", dictFileName, strerror(errno));
808 free(fileSizes);
809 RETURN_ERROR(9, BMK_benchOutcome_t, "benchmark aborted");
810 }
811 if (dictFileSize > 64 MB) {
812 free(fileSizes);
813 RETURN_ERROR(10, BMK_benchOutcome_t, "dictionary file %s too large", dictFileName);
814 }
815 dictBufferSize = (size_t)dictFileSize;
816 dictBuffer = malloc(dictBufferSize);
817 if (dictBuffer==NULL) {
818 free(fileSizes);
819 RETURN_ERROR(11, BMK_benchOutcome_t, "not enough memory for dictionary (%u bytes)",
820 (unsigned)dictBufferSize);
821 }
822
823 { int const errorCode = BMK_loadFiles(dictBuffer, dictBufferSize,
824 fileSizes, &dictFileName /*?*/,
825 1 /*?*/, displayLevel);
826 if (errorCode) {
827 res = BMK_benchOutcome_error();
828 goto _cleanUp;
829 } }
830 }
831
832 /* Memory allocation & restrictions */
833 benchedSize = BMK_findMaxMem(totalSizeToLoad * 3) / 3;
834 if ((U64)benchedSize > totalSizeToLoad) benchedSize = (size_t)totalSizeToLoad;
835 if (benchedSize < totalSizeToLoad)
836 DISPLAY("Not enough memory; testing %u MB only...\n", (unsigned)(benchedSize >> 20));
837
838 srcBuffer = benchedSize ? malloc(benchedSize) : NULL;
839 if (!srcBuffer) {
840 free(dictBuffer);
841 free(fileSizes);
842 RETURN_ERROR(12, BMK_benchOutcome_t, "not enough memory");
843 }
844
845 /* Load input buffer */
846 { int const errorCode = BMK_loadFiles(srcBuffer, benchedSize,
847 fileSizes, fileNamesTable, nbFiles,
848 displayLevel);
849 if (errorCode) {
850 res = BMK_benchOutcome_error();
851 goto _cleanUp;
852 } }
853
854 /* Bench */
855 { char mfName[20] = {0};
856 snprintf (mfName, sizeof(mfName), " %u files", nbFiles);
857 { const char* const displayName = (nbFiles > 1) ? mfName : fileNamesTable[0];
858 res = BMK_benchCLevel(srcBuffer, benchedSize,
859 fileSizes, nbFiles,
860 cLevel, compressionParams,
861 dictBuffer, dictBufferSize,
862 displayLevel, displayName,
863 adv);
864 } }
865
866 _cleanUp:
867 free(srcBuffer);
868 free(dictBuffer);
869 free(fileSizes);
870 return res;
871 }
872
873
BMK_benchFiles(const char * const * fileNamesTable,unsigned nbFiles,const char * dictFileName,int cLevel,const ZSTD_compressionParameters * compressionParams,int displayLevel)874 BMK_benchOutcome_t BMK_benchFiles(
875 const char* const * fileNamesTable, unsigned nbFiles,
876 const char* dictFileName,
877 int cLevel, const ZSTD_compressionParameters* compressionParams,
878 int displayLevel)
879 {
880 BMK_advancedParams_t const adv = BMK_initAdvancedParams();
881 return BMK_benchFilesAdvanced(fileNamesTable, nbFiles, dictFileName, cLevel, compressionParams, displayLevel, &adv);
882 }
883