blob: 14b73923311d1bf64753de28024cbed7d19031bd [file] [log] [blame]
Yann Collet4ded9e52016-08-30 10:04:33 -07001/**
2 * Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
3 * All rights reserved.
4 *
5 * This source code is licensed under the BSD-style license found in the
6 * LICENSE file in the root directory of this source tree. An additional grant
7 * of patent rights can be found in the PATENTS file in the same directory.
8 */
Yann Collet91a97962015-11-26 09:59:49 +01009
Yann Collet91a97962015-11-26 09:59:49 +010010
Yann Collet27caf2a2016-04-01 15:48:48 +020011/*-************************************
Yann Collet91a97962015-11-26 09:59:49 +010012* Compiler specific
13**************************************/
14#ifdef _MSC_VER /* Visual Studio */
Przemyslaw Skibinski97a258d2016-12-21 14:00:41 +010015# define _CRT_SECURE_NO_WARNINGS /* fgets */
Przemyslaw Skibinski2f6ccee2016-12-21 13:23:34 +010016# pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */
Yann Collet91a97962015-11-26 09:59:49 +010017# pragma warning(disable : 4146) /* disable: C4146: minus unsigned expression */
18#endif
19
Yann Collet91a97962015-11-26 09:59:49 +010020
Yann Collet27caf2a2016-04-01 15:48:48 +020021/*-************************************
Yann Collet91a97962015-11-26 09:59:49 +010022* Includes
23**************************************/
inikepe75909e2016-05-25 11:31:16 +020024#include <stdlib.h> /* free */
25#include <stdio.h> /* fgets, sscanf */
Yann Collet5153a082016-09-01 18:11:12 -070026#include <time.h> /* clock_t, clock() */
inikepe75909e2016-05-25 11:31:16 +020027#include <string.h> /* strcmp */
Przemyslaw Skibinski2f6ccee2016-12-21 13:23:34 +010028#include "mem.h"
Yann Colletd3b7f8d2016-06-04 19:47:02 +020029#define ZSTD_STATIC_LINKING_ONLY /* ZSTD_maxCLevel */
30#include "zstd.h" /* ZSTD_compressBound */
Yann Collete795c8a2016-12-13 16:39:36 +010031#define ZBUFF_STATIC_LINKING_ONLY /* ZBUFF_createCCtx_advanced */
32#include "zbuff.h" /* ZBUFF_isError */
inikepe75909e2016-05-25 11:31:16 +020033#include "datagen.h" /* RDG_genBuffer */
Yann Collet6c903a82016-05-28 13:34:07 +020034#define XXH_STATIC_LINKING_ONLY
Yann Collet5347aee2016-06-04 19:12:48 +020035#include "xxhash.h" /* XXH64_* */
Yann Collet91a97962015-11-26 09:59:49 +010036
37
Yann Collet27caf2a2016-04-01 15:48:48 +020038/*-************************************
39* Constants
Yann Collet91a97962015-11-26 09:59:49 +010040**************************************/
Yann Collet91a97962015-11-26 09:59:49 +010041#define KB *(1U<<10)
42#define MB *(1U<<20)
43#define GB *(1U<<30)
44
Yann Collet5f2ec632015-11-26 10:32:17 +010045static const U32 nbTestsDefault = 10000;
Yann Collet91a97962015-11-26 09:59:49 +010046#define COMPRESSIBLE_NOISE_LENGTH (10 MB)
47#define FUZ_COMPRESSIBILITY_DEFAULT 50
48static const U32 prime1 = 2654435761U;
49static const U32 prime2 = 2246822519U;
50
51
52
Yann Collet27caf2a2016-04-01 15:48:48 +020053/*-************************************
Yann Collet91a97962015-11-26 09:59:49 +010054* Display Macros
55**************************************/
56#define DISPLAY(...) fprintf(stderr, __VA_ARGS__)
57#define DISPLAYLEVEL(l, ...) if (g_displayLevel>=l) { DISPLAY(__VA_ARGS__); }
58static U32 g_displayLevel = 2;
59
60#define DISPLAYUPDATE(l, ...) if (g_displayLevel>=l) { \
Yann Collet5153a082016-09-01 18:11:12 -070061 if ((FUZ_GetClockSpan(g_displayClock) > g_refreshRate) || (g_displayLevel>=4)) \
62 { g_displayClock = clock(); DISPLAY(__VA_ARGS__); \
Yann Collet91a97962015-11-26 09:59:49 +010063 if (g_displayLevel>=4) fflush(stdout); } }
Yann Collet5153a082016-09-01 18:11:12 -070064static const clock_t g_refreshRate = CLOCKS_PER_SEC * 15 / 100;
65static clock_t g_displayClock = 0;
Yann Collet7447ee92015-11-26 10:52:30 +010066
Yann Collet5153a082016-09-01 18:11:12 -070067static clock_t g_clockTime = 0;
Yann Collet91a97962015-11-26 09:59:49 +010068
69
Yann Collet27caf2a2016-04-01 15:48:48 +020070/*-*******************************************************
Yann Collet91a97962015-11-26 09:59:49 +010071* Fuzzer functions
72*********************************************************/
73#define MAX(a,b) ((a)>(b)?(a):(b))
74
Yann Collet5153a082016-09-01 18:11:12 -070075static clock_t FUZ_GetClockSpan(clock_t clockStart)
Yann Collet91a97962015-11-26 09:59:49 +010076{
Yann Collet5153a082016-09-01 18:11:12 -070077 return clock() - clockStart; /* works even when overflow. Max span ~ 30 mn */
Yann Collet91a97962015-11-26 09:59:49 +010078}
79
Yann Collet38461082016-04-04 02:47:20 +020080/*! FUZ_rand() :
81 @return : a 27 bits random value, from a 32-bits `seed`.
82 `seed` is also modified */
Yann Collet91a97962015-11-26 09:59:49 +010083# define FUZ_rotl32(x,r) ((x << r) | (x >> (32 - r)))
Yann Collet38461082016-04-04 02:47:20 +020084unsigned int FUZ_rand(unsigned int* seedPtr)
Yann Collet91a97962015-11-26 09:59:49 +010085{
Yann Collet38461082016-04-04 02:47:20 +020086 U32 rand32 = *seedPtr;
Yann Collet91a97962015-11-26 09:59:49 +010087 rand32 *= prime1;
88 rand32 += prime2;
89 rand32 = FUZ_rotl32(rand32, 13);
Yann Collet38461082016-04-04 02:47:20 +020090 *seedPtr = rand32;
Yann Collet91a97962015-11-26 09:59:49 +010091 return rand32 >> 5;
92}
93
94
95/*
96static unsigned FUZ_highbit32(U32 v32)
97{
98 unsigned nbBits = 0;
99 if (v32==0) return 0;
100 for ( ; v32 ; v32>>=1) nbBits++;
101 return nbBits;
102}
103*/
104
inikep7cab86f2016-06-02 18:24:07 +0200105static void* ZBUFF_allocFunction(void* opaque, size_t size)
inikepa1653fb2016-05-24 15:35:48 +0200106{
107 void* address = malloc(size);
inikepff2d1892016-06-02 22:15:09 +0200108 (void)opaque;
inikepff9114a2016-06-02 16:52:36 +0200109 /* DISPLAYLEVEL(4, "alloc %p, %d opaque=%p \n", address, (int)size, opaque); */
inikepa1653fb2016-05-24 15:35:48 +0200110 return address;
111}
112
inikep7cab86f2016-06-02 18:24:07 +0200113static void ZBUFF_freeFunction(void* opaque, void* address)
inikepa1653fb2016-05-24 15:35:48 +0200114{
inikep28669512016-06-02 13:04:18 +0200115 (void)opaque;
inikepff9114a2016-06-02 16:52:36 +0200116 /* if (address) DISPLAYLEVEL(4, "free %p opaque=%p \n", address, opaque); */
inikepa1653fb2016-05-24 15:35:48 +0200117 free(address);
118}
119
120static int basicUnitTests(U32 seed, double compressibility, ZSTD_customMem customMem)
Yann Collet91a97962015-11-26 09:59:49 +0100121{
122 int testResult = 0;
Yann Collet91a97962015-11-26 09:59:49 +0100123 size_t CNBufferSize = COMPRESSIBLE_NOISE_LENGTH;
Yann Collet15354142016-04-04 04:22:53 +0200124 void* CNBuffer = malloc(CNBufferSize);
inikepf772bf52016-05-31 12:43:46 +0200125 size_t const skippableFrameSize = 11;
126 size_t const compressedBufferSize = (8 + skippableFrameSize) + ZSTD_compressBound(COMPRESSIBLE_NOISE_LENGTH);
Yann Collet15354142016-04-04 04:22:53 +0200127 void* compressedBuffer = malloc(compressedBufferSize);
128 size_t const decodedBufferSize = CNBufferSize;
129 void* decodedBuffer = malloc(decodedBufferSize);
inikep5c277172016-06-01 09:16:11 +0200130 size_t cSize, readSize, readSkipSize, genSize;
Yann Collet91a97962015-11-26 09:59:49 +0100131 U32 testNb=0;
inikepa1653fb2016-05-24 15:35:48 +0200132 ZBUFF_CCtx* zc = ZBUFF_createCCtx_advanced(customMem);
133 ZBUFF_DCtx* zd = ZBUFF_createDCtx_advanced(customMem);
Yann Collet91a97962015-11-26 09:59:49 +0100134
135 /* Create compressible test buffer */
Yann Collet27caf2a2016-04-01 15:48:48 +0200136 if (!CNBuffer || !compressedBuffer || !decodedBuffer || !zc || !zd) {
Yann Collet91a97962015-11-26 09:59:49 +0100137 DISPLAY("Not enough memory, aborting\n");
138 goto _output_error;
139 }
Yann Colletbde926f2016-05-18 17:18:48 +0200140 RDG_genBuffer(CNBuffer, CNBufferSize, compressibility, 0., seed);
Yann Collet91a97962015-11-26 09:59:49 +0100141
inikepf772bf52016-05-31 12:43:46 +0200142 /* generate skippable frame */
143 MEM_writeLE32(compressedBuffer, ZSTD_MAGIC_SKIPPABLE_START);
inikep5bee32e2016-05-31 13:36:14 +0200144 MEM_writeLE32(((char*)compressedBuffer)+4, (U32)skippableFrameSize);
inikepf772bf52016-05-31 12:43:46 +0200145 cSize = skippableFrameSize + 8;
Yann Collet673f0d72016-06-06 00:26:38 +0200146
Yann Collet91a97962015-11-26 09:59:49 +0100147 /* Basic compression test */
148 DISPLAYLEVEL(4, "test%3i : compress %u bytes : ", testNb++, COMPRESSIBLE_NOISE_LENGTH);
Yann Collet1c8e1942016-01-26 16:31:22 +0100149 ZBUFF_compressInitDictionary(zc, CNBuffer, 128 KB, 1);
Yann Collet91a97962015-11-26 09:59:49 +0100150 readSize = CNBufferSize;
151 genSize = compressedBufferSize;
inikep5c277172016-06-01 09:16:11 +0200152 { size_t const r = ZBUFF_compressContinue(zc, ((char*)compressedBuffer)+cSize, &genSize, CNBuffer, &readSize);
Yann Collet202844e2016-06-01 00:44:36 +0200153 if (ZBUFF_isError(r)) goto _output_error; }
Yann Collet91a97962015-11-26 09:59:49 +0100154 if (readSize != CNBufferSize) goto _output_error; /* entire input should be consumed */
inikepf772bf52016-05-31 12:43:46 +0200155 cSize += genSize;
Yann Collet91a97962015-11-26 09:59:49 +0100156 genSize = compressedBufferSize - cSize;
Yann Collet202844e2016-06-01 00:44:36 +0200157 { size_t const r = ZBUFF_compressEnd(zc, ((char*)compressedBuffer)+cSize, &genSize);
Yann Collet9a021c12016-08-26 09:05:06 +0200158 if (r != 0) goto _output_error; } /* error, or some data not flushed */
Yann Collet91a97962015-11-26 09:59:49 +0100159 cSize += genSize;
160 DISPLAYLEVEL(4, "OK (%u bytes : %.2f%%)\n", (U32)cSize, (double)cSize/COMPRESSIBLE_NOISE_LENGTH*100);
161
Yann Collet673f0d72016-06-06 00:26:38 +0200162 /* skippable frame test */
163 DISPLAYLEVEL(4, "test%3i : decompress skippable frame : ", testNb++);
Yann Collet7b51a292016-01-26 15:58:49 +0100164 ZBUFF_decompressInitDictionary(zd, CNBuffer, 128 KB);
inikep43aa9fe2016-05-31 19:36:51 +0200165 readSkipSize = cSize;
Yann Collet91a97962015-11-26 09:59:49 +0100166 genSize = CNBufferSize;
inikep5c277172016-06-01 09:16:11 +0200167 { size_t const r = ZBUFF_decompressContinue(zd, decodedBuffer, &genSize, compressedBuffer, &readSkipSize);
168 if (r != 0) goto _output_error; }
169 if (genSize != 0) goto _output_error; /* skippable frame len is 0 */
Yann Collet673f0d72016-06-06 00:26:38 +0200170 DISPLAYLEVEL(4, "OK \n");
171
172 /* Basic decompression test */
173 DISPLAYLEVEL(4, "test%3i : decompress %u bytes : ", testNb++, COMPRESSIBLE_NOISE_LENGTH);
inikep43aa9fe2016-05-31 19:36:51 +0200174 ZBUFF_decompressInitDictionary(zd, CNBuffer, 128 KB);
175 readSize = cSize - readSkipSize;
176 genSize = CNBufferSize;
inikep5c277172016-06-01 09:16:11 +0200177 { size_t const r = ZBUFF_decompressContinue(zd, decodedBuffer, &genSize, ((char*)compressedBuffer)+readSkipSize, &readSize);
Yann Collet202844e2016-06-01 00:44:36 +0200178 if (r != 0) goto _output_error; } /* should reach end of frame == 0; otherwise, some data left, or an error */
Yann Collet91a97962015-11-26 09:59:49 +0100179 if (genSize != CNBufferSize) goto _output_error; /* should regenerate the same amount */
inikep43aa9fe2016-05-31 19:36:51 +0200180 if (readSize+readSkipSize != cSize) goto _output_error; /* should have read the entire frame */
Yann Collet91a97962015-11-26 09:59:49 +0100181 DISPLAYLEVEL(4, "OK \n");
182
183 /* check regenerated data is byte exact */
Yann Collet673f0d72016-06-06 00:26:38 +0200184 DISPLAYLEVEL(4, "test%3i : check decompressed result : ", testNb++);
Yann Collet27caf2a2016-04-01 15:48:48 +0200185 { size_t i;
Yann Collet27caf2a2016-04-01 15:48:48 +0200186 for (i=0; i<CNBufferSize; i++) {
Yann Collet91a97962015-11-26 09:59:49 +0100187 if (((BYTE*)decodedBuffer)[i] != ((BYTE*)CNBuffer)[i]) goto _output_error;;
Yann Collet673f0d72016-06-06 00:26:38 +0200188 } }
189 DISPLAYLEVEL(4, "OK \n");
Yann Collet91a97962015-11-26 09:59:49 +0100190
Yann Colletbd39d542016-05-10 14:14:19 +0200191 /* Byte-by-byte decompression test */
Yann Colletb12b3692016-05-10 15:30:43 +0200192 DISPLAYLEVEL(4, "test%3i : decompress byte-by-byte : ", testNb++);
inikep43aa9fe2016-05-31 19:36:51 +0200193 { size_t r, pIn=0, pOut=0;
Yann Collet83c3f442016-06-01 17:44:53 +0200194 do
inikep43aa9fe2016-05-31 19:36:51 +0200195 { ZBUFF_decompressInitDictionary(zd, CNBuffer, 128 KB);
196 r = 1;
197 while (r) {
198 size_t inS = 1;
199 size_t outS = 1;
200 r = ZBUFF_decompressContinue(zd, ((BYTE*)decodedBuffer)+pOut, &outS, ((BYTE*)compressedBuffer)+pIn, &inS);
201 pIn += inS;
202 pOut += outS;
203 }
204 readSize = pIn;
205 genSize = pOut;
206 } while (genSize==0);
Yann Colletbd39d542016-05-10 14:14:19 +0200207 }
208 if (genSize != CNBufferSize) goto _output_error; /* should regenerate the same amount */
209 if (readSize != cSize) goto _output_error; /* should have read the entire frame */
210 DISPLAYLEVEL(4, "OK \n");
211
212 /* check regenerated data is byte exact */
Yann Collet673f0d72016-06-06 00:26:38 +0200213 DISPLAYLEVEL(4, "test%3i : check decompressed result : ", testNb++);
Yann Colletbd39d542016-05-10 14:14:19 +0200214 { size_t i;
Yann Colletbd39d542016-05-10 14:14:19 +0200215 for (i=0; i<CNBufferSize; i++) {
216 if (((BYTE*)decodedBuffer)[i] != ((BYTE*)CNBuffer)[i]) goto _output_error;;
Yann Collet673f0d72016-06-06 00:26:38 +0200217 } }
218 DISPLAYLEVEL(4, "OK \n");
Yann Colletbd39d542016-05-10 14:14:19 +0200219
Yann Collet91a97962015-11-26 09:59:49 +0100220_end:
221 ZBUFF_freeCCtx(zc);
222 ZBUFF_freeDCtx(zd);
223 free(CNBuffer);
224 free(compressedBuffer);
225 free(decodedBuffer);
226 return testResult;
227
228_output_error:
229 testResult = 1;
230 DISPLAY("Error detected in Unit tests ! \n");
231 goto _end;
232}
233
234
235static size_t findDiff(const void* buf1, const void* buf2, size_t max)
236{
237 const BYTE* b1 = (const BYTE*)buf1;
238 const BYTE* b2 = (const BYTE*)buf2;
Yann Colletbde926f2016-05-18 17:18:48 +0200239 size_t u;
240 for (u=0; u<max; u++) {
241 if (b1[u] != b2[u]) break;
Yann Collet91a97962015-11-26 09:59:49 +0100242 }
Yann Colletbde926f2016-05-18 17:18:48 +0200243 return u;
Yann Collet91a97962015-11-26 09:59:49 +0100244}
245
Yann Collet38461082016-04-04 02:47:20 +0200246static size_t FUZ_rLogLength(U32* seed, U32 logLength)
247{
248 size_t const lengthMask = ((size_t)1 << logLength) - 1;
249 return (lengthMask+1) + (FUZ_rand(seed) & lengthMask);
250}
251
252static size_t FUZ_randomLength(U32* seed, U32 maxLog)
253{
254 U32 const logLength = FUZ_rand(seed) % maxLog;
255 return FUZ_rLogLength(seed, logLength);
256}
257
inikep957823f2016-05-25 15:30:55 +0200258#define MIN(a,b) ( (a) < (b) ? (a) : (b) )
259
Yann Colletbde926f2016-05-18 17:18:48 +0200260#define CHECK(cond, ...) if (cond) { DISPLAY("Error => "); DISPLAY(__VA_ARGS__); \
261 DISPLAY(" (seed %u, test nb %u) \n", seed, testNb); goto _output_error; }
262
Yann Collet27caf2a2016-04-01 15:48:48 +0200263static int fuzzerTests(U32 seed, U32 nbTests, unsigned startTest, double compressibility)
Yann Collet91a97962015-11-26 09:59:49 +0100264{
Yann Colletefb18302016-04-01 18:54:13 +0200265 static const U32 maxSrcLog = 24;
266 static const U32 maxSampleLog = 19;
Yann Collet91a97962015-11-26 09:59:49 +0100267 BYTE* cNoiseBuffer[5];
Yann Collete795c8a2016-12-13 16:39:36 +0100268 size_t const srcBufferSize = (size_t)1<<maxSrcLog;
Yann Collet91a97962015-11-26 09:59:49 +0100269 BYTE* copyBuffer;
Yann Collete795c8a2016-12-13 16:39:36 +0100270 size_t const copyBufferSize= srcBufferSize + (1<<maxSampleLog);
Yann Collet91a97962015-11-26 09:59:49 +0100271 BYTE* cBuffer;
Yann Collete795c8a2016-12-13 16:39:36 +0100272 size_t const cBufferSize = ZSTD_compressBound(srcBufferSize);
Yann Collet91a97962015-11-26 09:59:49 +0100273 BYTE* dstBuffer;
274 size_t dstBufferSize = srcBufferSize;
275 U32 result = 0;
276 U32 testNb = 0;
Yann Colletefb18302016-04-01 18:54:13 +0200277 U32 coreSeed = seed;
Yann Collet91a97962015-11-26 09:59:49 +0100278 ZBUFF_CCtx* zc;
279 ZBUFF_DCtx* zd;
Yann Collet5153a082016-09-01 18:11:12 -0700280 clock_t startClock = clock();
Yann Collet91a97962015-11-26 09:59:49 +0100281
Yann Colletefb18302016-04-01 18:54:13 +0200282 /* allocations */
Yann Collet91a97962015-11-26 09:59:49 +0100283 zc = ZBUFF_createCCtx();
284 zd = ZBUFF_createDCtx();
285 cNoiseBuffer[0] = (BYTE*)malloc (srcBufferSize);
286 cNoiseBuffer[1] = (BYTE*)malloc (srcBufferSize);
287 cNoiseBuffer[2] = (BYTE*)malloc (srcBufferSize);
288 cNoiseBuffer[3] = (BYTE*)malloc (srcBufferSize);
289 cNoiseBuffer[4] = (BYTE*)malloc (srcBufferSize);
290 copyBuffer= (BYTE*)malloc (copyBufferSize);
291 dstBuffer = (BYTE*)malloc (dstBufferSize);
292 cBuffer = (BYTE*)malloc (cBufferSize);
293 CHECK (!cNoiseBuffer[0] || !cNoiseBuffer[1] || !cNoiseBuffer[2] || !cNoiseBuffer[3] || !cNoiseBuffer[4] ||
294 !copyBuffer || !dstBuffer || !cBuffer || !zc || !zd,
295 "Not enough memory, fuzzer tests cancelled");
296
297 /* Create initial samples */
298 RDG_genBuffer(cNoiseBuffer[0], srcBufferSize, 0.00, 0., coreSeed); /* pure noise */
299 RDG_genBuffer(cNoiseBuffer[1], srcBufferSize, 0.05, 0., coreSeed); /* barely compressible */
300 RDG_genBuffer(cNoiseBuffer[2], srcBufferSize, compressibility, 0., coreSeed);
301 RDG_genBuffer(cNoiseBuffer[3], srcBufferSize, 0.95, 0., coreSeed); /* highly compressible */
302 RDG_genBuffer(cNoiseBuffer[4], srcBufferSize, 1.00, 0., coreSeed); /* sparse content */
Yann Collet541cf192016-04-04 01:49:30 +0200303 memset(copyBuffer, 0x65, copyBufferSize); /* make copyBuffer considered initialized */
Yann Collet91a97962015-11-26 09:59:49 +0100304
305 /* catch up testNb */
306 for (testNb=1; testNb < startTest; testNb++)
307 FUZ_rand(&coreSeed);
308
309 /* test loop */
Yann Collet5153a082016-09-01 18:11:12 -0700310 for ( ; (testNb <= nbTests) || (FUZ_GetClockSpan(startClock) < g_clockTime) ; testNb++ ) {
Yann Colletefb18302016-04-01 18:54:13 +0200311 U32 lseed;
Yann Collet541cf192016-04-04 01:49:30 +0200312 const BYTE* srcBuffer;
Yann Collet3a061a42015-12-12 11:17:42 +0100313 const BYTE* dict;
Yann Collet38461082016-04-04 02:47:20 +0200314 size_t maxTestSize, dictSize;
315 size_t cSize, totalTestSize, totalCSize, totalGenSize;
Yann Collet91a97962015-11-26 09:59:49 +0100316 size_t errorCode;
Yann Collet38461082016-04-04 02:47:20 +0200317 U32 n, nbChunks;
Yann Collet6c903a82016-05-28 13:34:07 +0200318 XXH64_state_t xxhState;
Yann Colletefb18302016-04-01 18:54:13 +0200319 U64 crcOrig;
Yann Collet91a97962015-11-26 09:59:49 +0100320
321 /* init */
Yann Collet26415d32015-11-26 12:43:28 +0100322 DISPLAYUPDATE(2, "\r%6u", testNb);
323 if (nbTests >= testNb) DISPLAYUPDATE(2, "/%6u ", nbTests);
Yann Collet91a97962015-11-26 09:59:49 +0100324 FUZ_rand(&coreSeed);
325 lseed = coreSeed ^ prime1;
Yann Collet15bc9432016-04-04 01:22:26 +0200326
Yann Collet83c3f442016-06-01 17:44:53 +0200327 /* states full reset (unsynchronized) */
328 /* some issues only happen when reusing states in a specific sequence of parameters */
Yann Collet15bc9432016-04-04 01:22:26 +0200329 if ((FUZ_rand(&lseed) & 0xFF) == 131) { ZBUFF_freeCCtx(zc); zc = ZBUFF_createCCtx(); }
330 if ((FUZ_rand(&lseed) & 0xFF) == 132) { ZBUFF_freeDCtx(zd); zd = ZBUFF_createDCtx(); }
331
Yann Collet9bf70162016-04-04 02:53:27 +0200332 /* srcBuffer selection [0-4] */
Yann Collet541cf192016-04-04 01:49:30 +0200333 { U32 buffNb = FUZ_rand(&lseed) & 0x7F;
Yann Collet38461082016-04-04 02:47:20 +0200334 if (buffNb & 7) buffNb=2; /* most common : compressible (P) */
Yann Collet541cf192016-04-04 01:49:30 +0200335 else {
336 buffNb >>= 3;
337 if (buffNb & 7) {
Yann Collet38461082016-04-04 02:47:20 +0200338 const U32 tnb[2] = { 1, 3 }; /* barely/highly compressible */
Yann Collet541cf192016-04-04 01:49:30 +0200339 buffNb = tnb[buffNb >> 3];
340 } else {
Yann Collet38461082016-04-04 02:47:20 +0200341 const U32 tnb[2] = { 0, 4 }; /* not compressible / sparse */
Yann Collet541cf192016-04-04 01:49:30 +0200342 buffNb = tnb[buffNb >> 3];
343 } }
344 srcBuffer = cNoiseBuffer[buffNb];
345 }
Yann Collet91a97962015-11-26 09:59:49 +0100346
Yann Collet9bf70162016-04-04 02:53:27 +0200347 /* compression init */
348 { U32 const testLog = FUZ_rand(&lseed) % maxSrcLog;
Yann Collet38461082016-04-04 02:47:20 +0200349 U32 const cLevel = (FUZ_rand(&lseed) % (ZSTD_maxCLevel() - (testLog/3))) + 1;
Yann Collet9bf70162016-04-04 02:53:27 +0200350 maxTestSize = FUZ_rLogLength(&lseed, testLog);
Yann Collet83c3f442016-06-01 17:44:53 +0200351 dictSize = (FUZ_rand(&lseed)==1) ? FUZ_randomLength(&lseed, maxSampleLog) : 0;
Yann Collet9bf70162016-04-04 02:53:27 +0200352 /* random dictionary selection */
Yann Collet83c3f442016-06-01 17:44:53 +0200353 { size_t const dictStart = FUZ_rand(&lseed) % (srcBufferSize - dictSize);
354 dict = srcBuffer + dictStart;
Yann Collet9bf70162016-04-04 02:53:27 +0200355 }
Yann Collet6c6e1752016-06-27 15:28:45 +0200356 { ZSTD_parameters params = ZSTD_getParams(cLevel, 0, dictSize);
357 params.fParams.checksumFlag = FUZ_rand(&lseed) & 1;
358 params.fParams.noDictIDFlag = FUZ_rand(&lseed) & 1;
Yann Collet83c3f442016-06-01 17:44:53 +0200359 { size_t const initError = ZBUFF_compressInit_advanced(zc, dict, dictSize, params, 0);
360 CHECK (ZBUFF_isError(initError),"init error : %s", ZBUFF_getErrorName(initError));
361 } } }
Yann Collet38461082016-04-04 02:47:20 +0200362
363 /* multi-segments compression test */
Yann Collet6c903a82016-05-28 13:34:07 +0200364 XXH64_reset(&xxhState, 0);
Yann Collet38461082016-04-04 02:47:20 +0200365 nbChunks = (FUZ_rand(&lseed) & 127) + 2;
366 for (n=0, cSize=0, totalTestSize=0 ; (n<nbChunks) && (totalTestSize < maxTestSize) ; n++) {
367 /* compress random chunk into random size dst buffer */
368 { size_t readChunkSize = FUZ_randomLength(&lseed, maxSampleLog);
Yann Collet15354142016-04-04 04:22:53 +0200369 size_t const randomDstSize = FUZ_randomLength(&lseed, maxSampleLog);
370 size_t dstBuffSize = MIN(cBufferSize - cSize, randomDstSize);
Yann Collet38461082016-04-04 02:47:20 +0200371 size_t const srcStart = FUZ_rand(&lseed) % (srcBufferSize - readChunkSize);
Yann Collet3a061a42015-12-12 11:17:42 +0100372
Yann Collet9bf70162016-04-04 02:53:27 +0200373 size_t const compressionError = ZBUFF_compressContinue(zc, cBuffer+cSize, &dstBuffSize, srcBuffer+srcStart, &readChunkSize);
374 CHECK (ZBUFF_isError(compressionError), "compression error : %s", ZBUFF_getErrorName(compressionError));
Yann Collet31d18062015-11-27 14:07:36 +0100375
Yann Collet6c903a82016-05-28 13:34:07 +0200376 XXH64_update(&xxhState, srcBuffer+srcStart, readChunkSize);
Yann Collet38461082016-04-04 02:47:20 +0200377 memcpy(copyBuffer+totalTestSize, srcBuffer+srcStart, readChunkSize);
Yann Collet541cf192016-04-04 01:49:30 +0200378 cSize += dstBuffSize;
379 totalTestSize += readChunkSize;
380 }
Yann Collet6bcdeac2015-11-26 11:43:00 +0100381
Yann Colletefb18302016-04-01 18:54:13 +0200382 /* random flush operation, to mess around */
Yann Collet27caf2a2016-04-01 15:48:48 +0200383 if ((FUZ_rand(&lseed) & 15) == 0) {
Yann Collet15354142016-04-04 04:22:53 +0200384 size_t const randomDstSize = FUZ_randomLength(&lseed, maxSampleLog);
385 size_t dstBuffSize = MIN(cBufferSize - cSize, randomDstSize);
Yann Collet38461082016-04-04 02:47:20 +0200386 size_t const flushError = ZBUFF_compressFlush(zc, cBuffer+cSize, &dstBuffSize);
387 CHECK (ZBUFF_isError(flushError), "flush error : %s", ZBUFF_getErrorName(flushError));
Yann Collet541cf192016-04-04 01:49:30 +0200388 cSize += dstBuffSize;
389 } }
Yann Collet38461082016-04-04 02:47:20 +0200390
391 /* final frame epilogue */
Yann Collet446d4422016-06-21 14:14:02 +0200392 { size_t remainingToFlush = (size_t)(-1);
Yann Collet25659712016-06-21 12:17:26 +0200393 while (remainingToFlush) {
394 size_t const randomDstSize = FUZ_randomLength(&lseed, maxSampleLog);
395 size_t dstBuffSize = MIN(cBufferSize - cSize, randomDstSize);
Yann Collet446d4422016-06-21 14:14:02 +0200396 U32 const enoughDstSize = dstBuffSize >= remainingToFlush;
Yann Collet25659712016-06-21 12:17:26 +0200397 remainingToFlush = ZBUFF_compressEnd(zc, cBuffer+cSize, &dstBuffSize);
398 CHECK (ZBUFF_isError(remainingToFlush), "flush error : %s", ZBUFF_getErrorName(remainingToFlush));
Yann Collet60ba31c2016-07-28 19:55:09 +0200399 CHECK (enoughDstSize && remainingToFlush, "ZBUFF_compressEnd() not fully flushed (%u remaining), but enough space available", (U32)remainingToFlush);
Yann Collet25659712016-06-21 12:17:26 +0200400 cSize += dstBuffSize;
Yann Colletf15c1cb2016-06-21 13:11:48 +0200401 } }
Yann Collet6c903a82016-05-28 13:34:07 +0200402 crcOrig = XXH64_digest(&xxhState);
Yann Collet91a97962015-11-26 09:59:49 +0100403
404 /* multi - fragments decompression test */
Yann Collet7b51a292016-01-26 15:58:49 +0100405 ZBUFF_decompressInitDictionary(zd, dict, dictSize);
Yann Collet60ba31c2016-07-28 19:55:09 +0200406 errorCode = 1;
407 for (totalCSize = 0, totalGenSize = 0 ; errorCode ; ) {
Yann Collet38461082016-04-04 02:47:20 +0200408 size_t readCSrcSize = FUZ_randomLength(&lseed, maxSampleLog);
Yann Collet15354142016-04-04 04:22:53 +0200409 size_t const randomDstSize = FUZ_randomLength(&lseed, maxSampleLog);
410 size_t dstBuffSize = MIN(dstBufferSize - totalGenSize, randomDstSize);
Yann Collet60ba31c2016-07-28 19:55:09 +0200411 errorCode = ZBUFF_decompressContinue(zd, dstBuffer+totalGenSize, &dstBuffSize, cBuffer+totalCSize, &readCSrcSize);
412 CHECK (ZBUFF_isError(errorCode), "decompression error : %s", ZBUFF_getErrorName(errorCode));
Yann Collet38461082016-04-04 02:47:20 +0200413 totalGenSize += dstBuffSize;
414 totalCSize += readCSrcSize;
Yann Collet5f2ec632015-11-26 10:32:17 +0100415 }
Yann Collet91a97962015-11-26 09:59:49 +0100416 CHECK (errorCode != 0, "frame not fully decoded");
Yann Collet5f2ec632015-11-26 10:32:17 +0100417 CHECK (totalGenSize != totalTestSize, "decompressed data : wrong size")
418 CHECK (totalCSize != cSize, "compressed data should be fully read")
Yann Colletefb18302016-04-01 18:54:13 +0200419 { U64 const crcDest = XXH64(dstBuffer, totalTestSize, 0);
420 if (crcDest!=crcOrig) findDiff(copyBuffer, dstBuffer, totalTestSize);
421 CHECK (crcDest!=crcOrig, "decompressed data corrupted"); }
Yann Collet91a97962015-11-26 09:59:49 +0100422
Yann Colletefb18302016-04-01 18:54:13 +0200423 /*===== noisy/erroneous src decompression test =====*/
424
Yann Collet26415d32015-11-26 12:43:28 +0100425 /* add some noise */
Yann Colletefb18302016-04-01 18:54:13 +0200426 { U32 const nbNoiseChunks = (FUZ_rand(&lseed) & 7) + 2;
427 U32 nn; for (nn=0; nn<nbNoiseChunks; nn++) {
Yann Collet15354142016-04-04 04:22:53 +0200428 size_t const randomNoiseSize = FUZ_randomLength(&lseed, maxSampleLog);
429 size_t const noiseSize = MIN((cSize/3) , randomNoiseSize);
Yann Colletefb18302016-04-01 18:54:13 +0200430 size_t const noiseStart = FUZ_rand(&lseed) % (srcBufferSize - noiseSize);
431 size_t const cStart = FUZ_rand(&lseed) % (cSize - noiseSize);
432 memcpy(cBuffer+cStart, srcBuffer+noiseStart, noiseSize);
433 } }
Yann Collet26415d32015-11-26 12:43:28 +0100434
435 /* try decompression on noisy data */
436 ZBUFF_decompressInit(zd);
437 totalCSize = 0;
438 totalGenSize = 0;
Yann Collet27caf2a2016-04-01 15:48:48 +0200439 while ( (totalCSize < cSize) && (totalGenSize < dstBufferSize) ) {
Yann Collet38461082016-04-04 02:47:20 +0200440 size_t readCSrcSize = FUZ_randomLength(&lseed, maxSampleLog);
Yann Collet15354142016-04-04 04:22:53 +0200441 size_t const randomDstSize = FUZ_randomLength(&lseed, maxSampleLog);
442 size_t dstBuffSize = MIN(dstBufferSize - totalGenSize, randomDstSize);
Yann Collet38461082016-04-04 02:47:20 +0200443 size_t const decompressError = ZBUFF_decompressContinue(zd, dstBuffer+totalGenSize, &dstBuffSize, cBuffer+totalCSize, &readCSrcSize);
444 if (ZBUFF_isError(decompressError)) break; /* error correctly detected */
445 totalGenSize += dstBuffSize;
446 totalCSize += readCSrcSize;
Yann Collet27caf2a2016-04-01 15:48:48 +0200447 } }
Yann Collet7447ee92015-11-26 10:52:30 +0100448 DISPLAY("\r%u fuzzer tests completed \n", testNb);
Yann Collet91a97962015-11-26 09:59:49 +0100449
450_cleanup:
451 ZBUFF_freeCCtx(zc);
452 ZBUFF_freeDCtx(zd);
453 free(cNoiseBuffer[0]);
454 free(cNoiseBuffer[1]);
455 free(cNoiseBuffer[2]);
456 free(cNoiseBuffer[3]);
457 free(cNoiseBuffer[4]);
458 free(copyBuffer);
459 free(cBuffer);
460 free(dstBuffer);
461 return result;
462
463_output_error:
464 result = 1;
465 goto _cleanup;
466}
467
468
Yann Collet27caf2a2016-04-01 15:48:48 +0200469/*-*******************************************************
Yann Collet91a97962015-11-26 09:59:49 +0100470* Command line
471*********************************************************/
Yann Colletfd265ca2016-04-04 02:48:55 +0200472int FUZ_usage(const char* programName)
Yann Collet91a97962015-11-26 09:59:49 +0100473{
474 DISPLAY( "Usage :\n");
475 DISPLAY( " %s [args]\n", programName);
476 DISPLAY( "\n");
477 DISPLAY( "Arguments :\n");
478 DISPLAY( " -i# : Nb of tests (default:%u) \n", nbTestsDefault);
479 DISPLAY( " -s# : Select seed (default:prompt user)\n");
480 DISPLAY( " -t# : Select starting test number (default:0)\n");
481 DISPLAY( " -P# : Select compressibility in %% (default:%i%%)\n", FUZ_COMPRESSIBILITY_DEFAULT);
482 DISPLAY( " -v : verbose\n");
483 DISPLAY( " -p : pause at the end\n");
484 DISPLAY( " -h : display help and exit\n");
485 return 0;
486}
487
488
Yann Colletfd265ca2016-04-04 02:48:55 +0200489int main(int argc, const char** argv)
Yann Collet91a97962015-11-26 09:59:49 +0100490{
491 U32 seed=0;
492 int seedset=0;
493 int argNb;
494 int nbTests = nbTestsDefault;
495 int testNb = 0;
496 int proba = FUZ_COMPRESSIBILITY_DEFAULT;
497 int result=0;
498 U32 mainPause = 0;
Yann Colletfd265ca2016-04-04 02:48:55 +0200499 const char* programName = argv[0];
inikep7cab86f2016-06-02 18:24:07 +0200500 ZSTD_customMem customMem = { ZBUFF_allocFunction, ZBUFF_freeFunction, NULL };
inikep36fac002016-06-03 13:23:04 +0200501 ZSTD_customMem customNULL = { NULL, NULL, NULL };
Yann Collet91a97962015-11-26 09:59:49 +0100502
503 /* Check command line */
Yann Collet27caf2a2016-04-01 15:48:48 +0200504 for(argNb=1; argNb<argc; argNb++) {
Yann Colletfd265ca2016-04-04 02:48:55 +0200505 const char* argument = argv[argNb];
Yann Collet91a97962015-11-26 09:59:49 +0100506 if(!argument) continue; /* Protection if argument empty */
507
Yann Collet15354142016-04-04 04:22:53 +0200508 /* Parsing commands. Aggregated commands are allowed */
Yann Collet27caf2a2016-04-01 15:48:48 +0200509 if (argument[0]=='-') {
Yann Collet91a97962015-11-26 09:59:49 +0100510 argument++;
511
Yann Collet27caf2a2016-04-01 15:48:48 +0200512 while (*argument!=0) {
Yann Collet91a97962015-11-26 09:59:49 +0100513 switch(*argument)
514 {
515 case 'h':
516 return FUZ_usage(programName);
517 case 'v':
518 argument++;
519 g_displayLevel=4;
520 break;
521 case 'q':
522 argument++;
523 g_displayLevel--;
524 break;
525 case 'p': /* pause at the end */
526 argument++;
527 mainPause = 1;
528 break;
529
530 case 'i':
531 argument++;
Yann Collet5153a082016-09-01 18:11:12 -0700532 nbTests=0; g_clockTime=0;
Yann Collet27caf2a2016-04-01 15:48:48 +0200533 while ((*argument>='0') && (*argument<='9')) {
Yann Collet91a97962015-11-26 09:59:49 +0100534 nbTests *= 10;
535 nbTests += *argument - '0';
536 argument++;
537 }
538 break;
539
Yann Collet7447ee92015-11-26 10:52:30 +0100540 case 'T':
541 argument++;
Yann Collet5153a082016-09-01 18:11:12 -0700542 nbTests=0; g_clockTime=0;
Yann Collet27caf2a2016-04-01 15:48:48 +0200543 while ((*argument>='0') && (*argument<='9')) {
Yann Collet5153a082016-09-01 18:11:12 -0700544 g_clockTime *= 10;
545 g_clockTime += *argument - '0';
Yann Collet7447ee92015-11-26 10:52:30 +0100546 argument++;
547 }
Yann Collet5153a082016-09-01 18:11:12 -0700548 if (*argument=='m') g_clockTime *=60, argument++;
Yann Collet7447ee92015-11-26 10:52:30 +0100549 if (*argument=='n') argument++;
Yann Collet5153a082016-09-01 18:11:12 -0700550 g_clockTime *= CLOCKS_PER_SEC;
Yann Collet7447ee92015-11-26 10:52:30 +0100551 break;
552
Yann Collet91a97962015-11-26 09:59:49 +0100553 case 's':
554 argument++;
555 seed=0;
556 seedset=1;
Yann Collet27caf2a2016-04-01 15:48:48 +0200557 while ((*argument>='0') && (*argument<='9')) {
Yann Collet91a97962015-11-26 09:59:49 +0100558 seed *= 10;
559 seed += *argument - '0';
560 argument++;
561 }
562 break;
563
564 case 't':
565 argument++;
566 testNb=0;
Yann Collet27caf2a2016-04-01 15:48:48 +0200567 while ((*argument>='0') && (*argument<='9')) {
Yann Collet91a97962015-11-26 09:59:49 +0100568 testNb *= 10;
569 testNb += *argument - '0';
570 argument++;
571 }
572 break;
573
574 case 'P': /* compressibility % */
575 argument++;
576 proba=0;
Yann Collet27caf2a2016-04-01 15:48:48 +0200577 while ((*argument>='0') && (*argument<='9')) {
Yann Collet91a97962015-11-26 09:59:49 +0100578 proba *= 10;
579 proba += *argument - '0';
580 argument++;
581 }
582 if (proba<0) proba=0;
583 if (proba>100) proba=100;
584 break;
585
586 default:
587 return FUZ_usage(programName);
588 }
Yann Colletefb18302016-04-01 18:54:13 +0200589 } } } /* for(argNb=1; argNb<argc; argNb++) */
Yann Collet91a97962015-11-26 09:59:49 +0100590
591 /* Get Seed */
Yann Collet45f84ab2016-05-20 12:34:40 +0200592 DISPLAY("Starting zstd_buffered tester (%i-bits, %s)\n", (int)(sizeof(size_t)*8), ZSTD_VERSION_STRING);
Yann Collet91a97962015-11-26 09:59:49 +0100593
Yann Collet5153a082016-09-01 18:11:12 -0700594 if (!seedset) {
595 time_t const t = time(NULL);
596 U32 const h = XXH32(&t, sizeof(t), 1);
597 seed = h % 10000;
598 }
Yann Collet91a97962015-11-26 09:59:49 +0100599 DISPLAY("Seed = %u\n", seed);
600 if (proba!=FUZ_COMPRESSIBILITY_DEFAULT) DISPLAY("Compressibility : %i%%\n", proba);
601
602 if (nbTests<=0) nbTests=1;
603
inikepa1653fb2016-05-24 15:35:48 +0200604 if (testNb==0) {
inikep36fac002016-06-03 13:23:04 +0200605 result = basicUnitTests(0, ((double)proba) / 100, customNULL); /* constant seed for predictability */
Yann Collet202844e2016-06-01 00:44:36 +0200606 if (!result) {
607 DISPLAYLEVEL(4, "Unit tests using customMem :\n")
inikepa1653fb2016-05-24 15:35:48 +0200608 result = basicUnitTests(0, ((double)proba) / 100, customMem); /* use custom memory allocation functions */
Yann Collet202844e2016-06-01 00:44:36 +0200609 } }
inikepa1653fb2016-05-24 15:35:48 +0200610
Yann Collet91a97962015-11-26 09:59:49 +0100611 if (!result)
612 result = fuzzerTests(seed, nbTests, testNb, ((double)proba) / 100);
Yann Collet27caf2a2016-04-01 15:48:48 +0200613
614 if (mainPause) {
Yann Collet91a97962015-11-26 09:59:49 +0100615 int unused;
616 DISPLAY("Press Enter \n");
617 unused = getchar();
618 (void)unused;
619 }
620 return result;
621}