| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357 |
- /*
- frameTest - test tool for lz4frame
- Copyright (C) Yann Collet 2014-2020
- GPL v2 License
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
- You can contact the author at :
- - LZ4 homepage : http://www.lz4.org
- - LZ4 source repository : https://github.com/lz4/lz4
- */
- /*-************************************
- * Compiler specific
- **************************************/
- #ifdef _MSC_VER /* Visual Studio */
- # pragma warning(disable : 26451) /* disable: Arithmetic overflow */
- #endif
- /*-************************************
- * Includes
- **************************************/
- #include "util.h" /* U32 */
- #include <stdlib.h> /* malloc, free */
- #include <stdio.h> /* fprintf */
- #include <string.h> /* strcmp */
- #include <time.h> /* clock_t, clock(), CLOCKS_PER_SEC */
- #include <assert.h>
- #include "lz4frame.h" /* included multiple times to test correctness/safety */
- #include "lz4frame.h"
- #define LZ4F_STATIC_LINKING_ONLY
- #include "lz4frame.h"
- #include "lz4frame.h"
- #define LZ4_STATIC_LINKING_ONLY /* LZ4_DISTANCE_MAX */
- #include "lz4.h" /* LZ4_VERSION_STRING */
- #define XXH_STATIC_LINKING_ONLY
- #include "xxhash.h" /* XXH64 */
- /* unoptimized version; solves endianness & alignment issues */
- static void FUZ_writeLE32 (void* dstVoidPtr, U32 value32)
- {
- BYTE* const dstPtr = (BYTE*)dstVoidPtr;
- dstPtr[0] = (BYTE) value32;
- dstPtr[1] = (BYTE)(value32 >> 8);
- dstPtr[2] = (BYTE)(value32 >> 16);
- dstPtr[3] = (BYTE)(value32 >> 24);
- }
- /*-************************************
- * Constants
- **************************************/
- #define KB *(1U<<10)
- #define MB *(1U<<20)
- #define GB *(1U<<30)
- static const U32 nbTestsDefault = 256 KB;
- #define FUZ_COMPRESSIBILITY_DEFAULT 50
- static const U32 prime1 = 2654435761U;
- static const U32 prime2 = 2246822519U;
- /*-************************************
- * Macros
- **************************************/
- #define DISPLAY(...) fprintf(stderr, __VA_ARGS__)
- #define DISPLAYLEVEL(l, ...) if (displayLevel>=l) { DISPLAY(__VA_ARGS__); }
- #define DISPLAYUPDATE(l, ...) if (displayLevel>=l) { \
- if ((FUZ_GetClockSpan(g_clockTime) > refreshRate) || (displayLevel>=4)) \
- { g_clockTime = clock(); DISPLAY(__VA_ARGS__); \
- if (displayLevel>=4) fflush(stdout); } }
- static const clock_t refreshRate = CLOCKS_PER_SEC / 6;
- static clock_t g_clockTime = 0;
- /*-***************************************
- * Local Parameters
- *****************************************/
- static U32 no_prompt = 0;
- static U32 displayLevel = 2;
- static U32 use_pause = 0;
- /*-*******************************************************
- * Fuzzer functions
- *********************************************************/
- #define MIN(a,b) ( (a) < (b) ? (a) : (b) )
- #define MAX(a,b) ( (a) > (b) ? (a) : (b) )
- typedef struct {
- int nbAllocs;
- } Test_alloc_state;
- static Test_alloc_state g_testAllocState = { 0 };
- static void* dummy_malloc(void* state, size_t s)
- {
- Test_alloc_state* const t = (Test_alloc_state*)state;
- void* const p = malloc(s);
- if (p==NULL) return NULL;
- assert(t != NULL);
- t->nbAllocs += 1;
- DISPLAYLEVEL(6, "Allocating %zu bytes at address %p \n", s, p);
- DISPLAYLEVEL(5, "nb allocated memory segments : %i \n", t->nbAllocs);
- return p;
- }
- static void* dummy_calloc(void* state, size_t s)
- {
- Test_alloc_state* const t = (Test_alloc_state*)state;
- void* const p = calloc(1, s);
- if (p==NULL) return NULL;
- assert(t != NULL);
- t->nbAllocs += 1;
- DISPLAYLEVEL(6, "Allocating and zeroing %zu bytes at address %p \n", s, p);
- DISPLAYLEVEL(5, "nb allocated memory segments : %i \n", t->nbAllocs);
- return p;
- }
- static void dummy_free(void* state, void* p)
- {
- Test_alloc_state* const t = (Test_alloc_state*)state;
- if (p==NULL) {
- DISPLAYLEVEL(5, "free() on NULL \n");
- return;
- }
- DISPLAYLEVEL(6, "freeing memory at address %p \n", p);
- free(p);
- assert(t != NULL);
- t->nbAllocs -= 1;
- DISPLAYLEVEL(5, "nb of allocated memory segments after this free : %i \n", t->nbAllocs);
- assert(t->nbAllocs >= 0);
- }
- static const LZ4F_CustomMem lz4f_cmem_test = {
- dummy_malloc,
- dummy_calloc,
- dummy_free,
- &g_testAllocState
- };
- static clock_t FUZ_GetClockSpan(clock_t clockStart)
- {
- return clock() - clockStart; /* works even if overflow; max span ~ 30 mn */
- }
- #define FUZ_rotl32(x,r) ((x << r) | (x >> (32 - r)))
- unsigned int FUZ_rand(unsigned int* src)
- {
- U32 rand32 = *src;
- rand32 *= prime1;
- rand32 += prime2;
- rand32 = FUZ_rotl32(rand32, 13);
- *src = rand32;
- return rand32 >> 5;
- }
- #define FUZ_RAND15BITS (FUZ_rand(seed) & 0x7FFF)
- #define FUZ_RANDLENGTH ( (FUZ_rand(seed) & 3) ? (FUZ_rand(seed) % 15) : (FUZ_rand(seed) % 510) + 15)
- static void FUZ_fillCompressibleNoiseBuffer(void* buffer, size_t bufferSize, double proba, U32* seed)
- {
- BYTE* BBuffer = (BYTE*)buffer;
- size_t pos = 0;
- U32 P32 = (U32)(32768 * proba);
- /* First Byte */
- BBuffer[pos++] = (BYTE)(FUZ_rand(seed));
- while (pos < bufferSize) {
- /* Select : Literal (noise) or copy (within 64K) */
- if (FUZ_RAND15BITS < P32) {
- /* Copy (within 64K) */
- size_t const lengthRand = FUZ_RANDLENGTH + 4;
- size_t const length = MIN(lengthRand, bufferSize - pos);
- size_t const end = pos + length;
- size_t const offsetRand = FUZ_RAND15BITS + 1;
- size_t const offset = MIN(offsetRand, pos);
- size_t match = pos - offset;
- while (pos < end) BBuffer[pos++] = BBuffer[match++];
- } else {
- /* Literal (noise) */
- size_t const lengthRand = FUZ_RANDLENGTH + 4;
- size_t const length = MIN(lengthRand, bufferSize - pos);
- size_t const end = pos + length;
- while (pos < end) BBuffer[pos++] = (BYTE)(FUZ_rand(seed) >> 5);
- } }
- }
- static unsigned FUZ_highbit(U32 v32)
- {
- unsigned nbBits = 0;
- if (v32==0) return 0;
- while (v32) {v32 >>= 1; nbBits ++;}
- return nbBits;
- }
- /*-*******************************************************
- * Tests
- *********************************************************/
- #define CHECK_V(v,f) v = f; if (LZ4F_isError(v)) { fprintf(stderr, "%s \n", LZ4F_getErrorName(v)); goto _output_error; }
- #define CHECK(f) { LZ4F_errorCode_t const CHECK_V(err_ , f); }
- int basicTests(U32 seed, double compressibility)
- {
- #define COMPRESSIBLE_NOISE_LENGTH (2 MB)
- void* const CNBuffer = malloc(COMPRESSIBLE_NOISE_LENGTH);
- size_t const cBuffSize = LZ4F_compressFrameBound(COMPRESSIBLE_NOISE_LENGTH, NULL);
- void* const compressedBuffer = malloc(cBuffSize);
- void* const decodedBuffer = malloc(COMPRESSIBLE_NOISE_LENGTH);
- U32 randState = seed;
- size_t cSize, testSize;
- LZ4F_decompressionContext_t dCtx = NULL;
- LZ4F_compressionContext_t cctx = NULL;
- U64 crcOrig;
- int basicTests_error = 0;
- LZ4F_preferences_t prefs;
- memset(&prefs, 0, sizeof(prefs));
- if (!CNBuffer || !compressedBuffer || !decodedBuffer) {
- DISPLAY("allocation error, not enough memory to start fuzzer tests \n");
- goto _output_error;
- }
- FUZ_fillCompressibleNoiseBuffer(CNBuffer, COMPRESSIBLE_NOISE_LENGTH, compressibility, &randState);
- crcOrig = XXH64(CNBuffer, COMPRESSIBLE_NOISE_LENGTH, 1);
- /* LZ4F_compressBound() : special case : srcSize == 0 */
- DISPLAYLEVEL(3, "LZ4F_compressBound(0) = ");
- { size_t const cBound = LZ4F_compressBound(0, NULL);
- if (cBound < 64 KB) goto _output_error;
- DISPLAYLEVEL(3, " %u \n", (U32)cBound);
- }
- /* LZ4F_compressBound() : special case : automatic flushing enabled */
- DISPLAYLEVEL(3, "LZ4F_compressBound(1 KB, autoFlush=1) = ");
- { size_t cBound;
- LZ4F_preferences_t autoFlushPrefs;
- memset(&autoFlushPrefs, 0, sizeof(autoFlushPrefs));
- autoFlushPrefs.autoFlush = 1;
- cBound = LZ4F_compressBound(1 KB, &autoFlushPrefs);
- if (cBound > 64 KB) goto _output_error;
- DISPLAYLEVEL(3, " %u \n", (U32)cBound);
- }
- /* LZ4F_compressBound() : special case : automatic flushing disabled */
- DISPLAYLEVEL(3, "LZ4F_compressBound(1 KB, autoFlush=0) = ");
- { size_t const cBound = LZ4F_compressBound(1 KB, &prefs);
- if (cBound < 64 KB) goto _output_error;
- DISPLAYLEVEL(3, " %u \n", (U32)cBound);
- }
- /* Special case : null-content frame */
- testSize = 0;
- DISPLAYLEVEL(3, "LZ4F_compressFrame, compress null content : ");
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(testSize, NULL), CNBuffer, testSize, NULL));
- DISPLAYLEVEL(3, "null content encoded into a %u bytes frame \n", (unsigned)cSize);
- DISPLAYLEVEL(3, "LZ4F_createDecompressionContext \n");
- CHECK ( LZ4F_createDecompressionContext(&dCtx, LZ4F_VERSION) );
- DISPLAYLEVEL(3, "LZ4F_getFrameInfo on null-content frame (#157) \n");
- assert(cSize >= LZ4F_MIN_SIZE_TO_KNOW_HEADER_LENGTH);
- { LZ4F_frameInfo_t frame_info;
- size_t const fhs = LZ4F_headerSize(compressedBuffer, LZ4F_MIN_SIZE_TO_KNOW_HEADER_LENGTH);
- size_t avail_in = fhs;
- CHECK( fhs );
- CHECK( LZ4F_getFrameInfo(dCtx, &frame_info, compressedBuffer, &avail_in) );
- if (avail_in != fhs) goto _output_error; /* must consume all, since header size is supposed to be exact */
- }
- DISPLAYLEVEL(3, "LZ4F_freeDecompressionContext \n");
- CHECK( LZ4F_freeDecompressionContext(dCtx) );
- dCtx = NULL;
- /* test one-pass frame compression */
- testSize = COMPRESSIBLE_NOISE_LENGTH;
- DISPLAYLEVEL(3, "LZ4F_compressFrame, using fast level -3 : ");
- { LZ4F_preferences_t fastCompressPrefs;
- memset(&fastCompressPrefs, 0, sizeof(fastCompressPrefs));
- fastCompressPrefs.compressionLevel = -3;
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(testSize, NULL), CNBuffer, testSize, &fastCompressPrefs));
- DISPLAYLEVEL(3, "Compressed %u bytes into a %u bytes frame \n", (U32)testSize, (U32)cSize);
- }
- DISPLAYLEVEL(3, "LZ4F_compressFrame, using default preferences : ");
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(testSize, NULL), CNBuffer, testSize, NULL));
- DISPLAYLEVEL(3, "Compressed %u bytes into a %u bytes frame \n", (U32)testSize, (U32)cSize);
- DISPLAYLEVEL(3, "Decompression test : \n");
- { size_t decodedBufferSize = COMPRESSIBLE_NOISE_LENGTH;
- size_t compressedBufferSize = cSize;
- CHECK( LZ4F_createDecompressionContext(&dCtx, LZ4F_VERSION) );
- DISPLAYLEVEL(3, "Single Pass decompression : ");
- CHECK( LZ4F_decompress(dCtx, decodedBuffer, &decodedBufferSize, compressedBuffer, &compressedBufferSize, NULL) );
- { U64 const crcDest = XXH64(decodedBuffer, decodedBufferSize, 1);
- if (crcDest != crcOrig) goto _output_error; }
- DISPLAYLEVEL(3, "Regenerated %u bytes \n", (U32)decodedBufferSize);
- DISPLAYLEVEL(3, "Reusing decompression context \n");
- { size_t const missingBytes = 4;
- size_t iSize = compressedBufferSize - missingBytes;
- const BYTE* cBuff = (const BYTE*) compressedBuffer;
- BYTE* const ostart = (BYTE*)decodedBuffer;
- BYTE* op = ostart;
- BYTE* const oend = (BYTE*)decodedBuffer + COMPRESSIBLE_NOISE_LENGTH;
- size_t decResult, oSize = COMPRESSIBLE_NOISE_LENGTH;
- DISPLAYLEVEL(3, "Missing last %u bytes : ", (U32)missingBytes);
- CHECK_V(decResult, LZ4F_decompress(dCtx, op, &oSize, cBuff, &iSize, NULL));
- if (decResult != missingBytes) {
- DISPLAY("%u bytes missing != %u bytes requested \n", (U32)missingBytes, (U32)decResult);
- goto _output_error;
- }
- DISPLAYLEVEL(3, "indeed, requests %u bytes \n", (unsigned)decResult);
- cBuff += iSize;
- iSize = decResult;
- op += oSize;
- oSize = (size_t)(oend-op);
- decResult = LZ4F_decompress(dCtx, op, &oSize, cBuff, &iSize, NULL);
- if (decResult != 0) goto _output_error; /* should finish now */
- op += oSize;
- if (op>oend) { DISPLAY("decompression write overflow \n"); goto _output_error; }
- { U64 const crcDest = XXH64(decodedBuffer, (size_t)(op-ostart), 1);
- if (crcDest != crcOrig) goto _output_error;
- } }
- { size_t oSize = 0;
- size_t iSize = 0;
- LZ4F_frameInfo_t fi;
- const BYTE* ip = (BYTE*)compressedBuffer;
- DISPLAYLEVEL(3, "Start by feeding 0 bytes, to get next input size : ");
- CHECK( LZ4F_decompress(dCtx, NULL, &oSize, ip, &iSize, NULL) );
- //DISPLAYLEVEL(3, " %u \n", (unsigned)errorCode);
- DISPLAYLEVEL(3, " OK \n");
- DISPLAYLEVEL(3, "LZ4F_getFrameInfo on zero-size input : ");
- { size_t nullSize = 0;
- size_t const fiError = LZ4F_getFrameInfo(dCtx, &fi, ip, &nullSize);
- if (LZ4F_getErrorCode(fiError) != LZ4F_ERROR_frameHeader_incomplete) {
- DISPLAYLEVEL(3, "incorrect error : %s != ERROR_frameHeader_incomplete \n",
- LZ4F_getErrorName(fiError));
- goto _output_error;
- }
- DISPLAYLEVEL(3, " correctly failed : %s \n", LZ4F_getErrorName(fiError));
- }
- DISPLAYLEVEL(3, "LZ4F_getFrameInfo on not enough input : ");
- { size_t inputSize = 6;
- size_t const fiError = LZ4F_getFrameInfo(dCtx, &fi, ip, &inputSize);
- if (LZ4F_getErrorCode(fiError) != LZ4F_ERROR_frameHeader_incomplete) {
- DISPLAYLEVEL(3, "incorrect error : %s != ERROR_frameHeader_incomplete \n", LZ4F_getErrorName(fiError));
- goto _output_error;
- }
- DISPLAYLEVEL(3, " correctly failed : %s \n", LZ4F_getErrorName(fiError));
- }
- DISPLAYLEVEL(3, "LZ4F_getFrameInfo on enough input : ");
- iSize = LZ4F_headerSize(ip, LZ4F_MIN_SIZE_TO_KNOW_HEADER_LENGTH);
- CHECK( iSize );
- CHECK( LZ4F_getFrameInfo(dCtx, &fi, ip, &iSize) );
- DISPLAYLEVEL(3, " correctly decoded \n");
- }
- DISPLAYLEVEL(3, "Decode a buggy input : ");
- assert(COMPRESSIBLE_NOISE_LENGTH > 64);
- assert(cSize > 48);
- memcpy(decodedBuffer, (char*)compressedBuffer+16, 32); /* save correct data */
- memcpy((char*)compressedBuffer+16, (const char*)decodedBuffer+32, 32); /* insert noise */
- { size_t dbSize = COMPRESSIBLE_NOISE_LENGTH;
- size_t cbSize = cSize;
- size_t const decompressError = LZ4F_decompress(dCtx, decodedBuffer, &dbSize,
- compressedBuffer, &cbSize,
- NULL);
- if (!LZ4F_isError(decompressError)) goto _output_error;
- DISPLAYLEVEL(3, "error detected : %s \n", LZ4F_getErrorName(decompressError));
- }
- memcpy((char*)compressedBuffer+16, decodedBuffer, 32); /* restore correct data */
- DISPLAYLEVEL(3, "Reset decompression context, since it's left in error state \n");
- LZ4F_resetDecompressionContext(dCtx); /* always successful */
- DISPLAYLEVEL(3, "Byte after byte : ");
- { BYTE* const ostart = (BYTE*)decodedBuffer;
- BYTE* op = ostart;
- BYTE* const oend = (BYTE*)decodedBuffer + COMPRESSIBLE_NOISE_LENGTH;
- const BYTE* ip = (const BYTE*) compressedBuffer;
- const BYTE* const iend = ip + cSize;
- while (ip < iend) {
- size_t oSize = (size_t)(oend-op);
- size_t iSize = 1;
- CHECK( LZ4F_decompress(dCtx, op, &oSize, ip, &iSize, NULL) );
- op += oSize;
- ip += iSize;
- }
- { U64 const crcDest = XXH64(decodedBuffer, COMPRESSIBLE_NOISE_LENGTH, 1);
- if (crcDest != crcOrig) goto _output_error;
- }
- DISPLAYLEVEL(3, "Regenerated %u/%u bytes \n", (unsigned)(op-ostart), (unsigned)COMPRESSIBLE_NOISE_LENGTH);
- }
- }
- DISPLAYLEVEL(3, "Using 64 KB block : ");
- prefs.frameInfo.blockSizeID = LZ4F_max64KB;
- prefs.frameInfo.contentChecksumFlag = LZ4F_contentChecksumEnabled;
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(testSize, &prefs), CNBuffer, testSize, &prefs));
- DISPLAYLEVEL(3, "Compressed %i bytes into a %i bytes frame \n", (int)testSize, (int)cSize);
- DISPLAYLEVEL(3, "without checksum : ");
- prefs.frameInfo.contentChecksumFlag = LZ4F_noContentChecksum;
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(testSize, &prefs), CNBuffer, testSize, &prefs));
- DISPLAYLEVEL(3, "Compressed %i bytes into a %i bytes frame \n", (int)testSize, (int)cSize);
- DISPLAYLEVEL(3, "Using 256 KB block : ");
- prefs.frameInfo.blockSizeID = LZ4F_max256KB;
- prefs.frameInfo.contentChecksumFlag = LZ4F_contentChecksumEnabled;
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(testSize, &prefs), CNBuffer, testSize, &prefs));
- DISPLAYLEVEL(3, "Compressed %i bytes into a %i bytes frame \n", (int)testSize, (int)cSize);
- DISPLAYLEVEL(3, "Decompression test : \n");
- { size_t const decodedBufferSize = COMPRESSIBLE_NOISE_LENGTH;
- unsigned const maxBits = FUZ_highbit((U32)decodedBufferSize);
- BYTE* const ostart = (BYTE*)decodedBuffer;
- BYTE* op = ostart;
- BYTE* const oend = ostart + COMPRESSIBLE_NOISE_LENGTH;
- const BYTE* ip = (const BYTE*)compressedBuffer;
- const BYTE* const iend = (const BYTE*)compressedBuffer + cSize;
- DISPLAYLEVEL(3, "random segment sizes : ");
- while (ip < iend) {
- unsigned const nbBits = FUZ_rand(&randState) % maxBits;
- size_t iSize = (FUZ_rand(&randState) & ((1<<nbBits)-1)) + 1;
- size_t oSize = (size_t)(oend-op);
- if (iSize > (size_t)(iend-ip)) iSize = (size_t)(iend-ip);
- CHECK( LZ4F_decompress(dCtx, op, &oSize, ip, &iSize, NULL) );
- op += oSize;
- ip += iSize;
- }
- { size_t const decodedSize = (size_t)(op - ostart);
- U64 const crcDest = XXH64(decodedBuffer, decodedSize, 1);
- if (crcDest != crcOrig) goto _output_error;
- DISPLAYLEVEL(3, "Regenerated %u bytes \n", (U32)decodedSize);
- }
- CHECK( LZ4F_freeDecompressionContext(dCtx) );
- dCtx = NULL;
- }
- DISPLAYLEVEL(3, "without checksum : ");
- prefs.frameInfo.contentChecksumFlag = LZ4F_noContentChecksum;
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(testSize, &prefs), CNBuffer, testSize, &prefs) );
- DISPLAYLEVEL(3, "Compressed %i bytes into a %i bytes frame \n", (int)testSize, (int)cSize);
- DISPLAYLEVEL(3, "Using 1 MB block : ");
- prefs.frameInfo.blockSizeID = LZ4F_max1MB;
- prefs.frameInfo.contentChecksumFlag = LZ4F_contentChecksumEnabled;
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(testSize, &prefs), CNBuffer, testSize, &prefs) );
- DISPLAYLEVEL(3, "Compressed %i bytes into a %i bytes frame \n", (int)testSize, (int)cSize);
- DISPLAYLEVEL(3, "without frame checksum : ");
- prefs.frameInfo.contentChecksumFlag = LZ4F_noContentChecksum;
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(testSize, &prefs), CNBuffer, testSize, &prefs) );
- DISPLAYLEVEL(3, "Compressed %i bytes into a %i bytes frame \n", (int)testSize, (int)cSize);
- DISPLAYLEVEL(3, "Using 4 MB block : ");
- prefs.frameInfo.blockSizeID = LZ4F_max4MB;
- prefs.frameInfo.contentChecksumFlag = LZ4F_contentChecksumEnabled;
- { size_t const dstCapacity = LZ4F_compressFrameBound(testSize, &prefs);
- DISPLAYLEVEL(4, "dstCapacity = %u ; ", (U32)dstCapacity)
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, dstCapacity, CNBuffer, testSize, &prefs) );
- DISPLAYLEVEL(3, "Compressed %u bytes into a %u bytes frame \n", (U32)testSize, (U32)cSize);
- }
- DISPLAYLEVEL(3, "without frame checksum : ");
- prefs.frameInfo.contentChecksumFlag = LZ4F_noContentChecksum;
- { size_t const dstCapacity = LZ4F_compressFrameBound(testSize, &prefs);
- DISPLAYLEVEL(4, "dstCapacity = %u ; ", (U32)dstCapacity)
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, dstCapacity, CNBuffer, testSize, &prefs) );
- DISPLAYLEVEL(3, "Compressed %u bytes into a %u bytes frame \n", (U32)testSize, (U32)cSize);
- }
- DISPLAYLEVEL(3, "LZ4F_compressFrame with block checksum : ");
- memset(&prefs, 0, sizeof(prefs));
- prefs.frameInfo.blockChecksumFlag = LZ4F_blockChecksumEnabled;
- CHECK_V(cSize, LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(testSize, &prefs), CNBuffer, testSize, &prefs) );
- DISPLAYLEVEL(3, "Compressed %i bytes into a %i bytes frame \n", (int)testSize, (int)cSize);
- DISPLAYLEVEL(3, "Decompress with block checksum : ");
- { size_t iSize = cSize;
- size_t decodedSize = COMPRESSIBLE_NOISE_LENGTH;
- LZ4F_decompressionContext_t dctx;
- CHECK( LZ4F_createDecompressionContext(&dctx, LZ4F_VERSION) );
- CHECK( LZ4F_decompress(dctx, decodedBuffer, &decodedSize, compressedBuffer, &iSize, NULL) );
- if (decodedSize != testSize) goto _output_error;
- if (iSize != cSize) goto _output_error;
- { U64 const crcDest = XXH64(decodedBuffer, decodedSize, 1);
- U64 const crcSrc = XXH64(CNBuffer, testSize, 1);
- if (crcDest != crcSrc) goto _output_error;
- }
- DISPLAYLEVEL(3, "Regenerated %u bytes \n", (U32)decodedSize);
- CHECK( LZ4F_freeDecompressionContext(dctx) );
- }
- /* frame content size tests */
- { size_t cErr;
- BYTE* const ostart = (BYTE*)compressedBuffer;
- BYTE* op = ostart;
- CHECK( LZ4F_createCompressionContext(&cctx, LZ4F_VERSION) );
- DISPLAYLEVEL(3, "compress without frameSize : ");
- memset(&(prefs.frameInfo), 0, sizeof(prefs.frameInfo));
- CHECK_V(cErr, LZ4F_compressBegin(cctx, compressedBuffer, testSize, &prefs));
- op += cErr;
- CHECK_V(cErr, LZ4F_compressUpdate(cctx, op, LZ4F_compressBound(testSize, &prefs), CNBuffer, testSize, NULL));
- op += cErr;
- CHECK( LZ4F_compressEnd(cctx, compressedBuffer, testSize, NULL) );
- DISPLAYLEVEL(3, "Compressed %i bytes into a %i bytes frame \n", (int)testSize, (int)(op-ostart));
- DISPLAYLEVEL(3, "compress with frameSize : ");
- prefs.frameInfo.contentSize = testSize;
- op = ostart;
- CHECK_V(cErr, LZ4F_compressBegin(cctx, compressedBuffer, testSize, &prefs));
- op += cErr;
- CHECK_V(cErr, LZ4F_compressUpdate(cctx, op, LZ4F_compressBound(testSize, &prefs), CNBuffer, testSize, NULL));
- op += cErr;
- CHECK( LZ4F_compressEnd(cctx, compressedBuffer, testSize, NULL) );
- DISPLAYLEVEL(3, "Compressed %i bytes into a %i bytes frame \n", (int)testSize, (int)(op-ostart));
- DISPLAYLEVEL(3, "compress with wrong frameSize : ");
- prefs.frameInfo.contentSize = testSize+1;
- op = ostart;
- CHECK_V(cErr, LZ4F_compressBegin(cctx, compressedBuffer, testSize, &prefs));
- op += cErr;
- CHECK_V(cErr, LZ4F_compressUpdate(cctx, op, LZ4F_compressBound(testSize, &prefs), CNBuffer, testSize, NULL));
- op += cErr;
- cErr = LZ4F_compressEnd(cctx, op, testSize, NULL);
- if (!LZ4F_isError(cErr)) goto _output_error;
- DISPLAYLEVEL(3, "Error correctly detected : %s \n", LZ4F_getErrorName(cErr));
- CHECK( LZ4F_freeCompressionContext(cctx) );
- cctx = NULL;
- }
- /* dictID tests */
- { size_t cErr;
- U32 const dictID = 0x99;
- /* test advanced variant with custom allocator functions */
- cctx = LZ4F_createCompressionContext_advanced(lz4f_cmem_test, LZ4F_VERSION);
- if (cctx==NULL) goto _output_error;
- DISPLAYLEVEL(3, "insert a dictID : ");
- memset(&prefs.frameInfo, 0, sizeof(prefs.frameInfo));
- prefs.frameInfo.dictID = dictID;
- CHECK_V(cErr, LZ4F_compressBegin(cctx, compressedBuffer, testSize, &prefs));
- DISPLAYLEVEL(3, "created frame header of size %i bytes \n", (int)cErr);
- DISPLAYLEVEL(3, "read a dictID : ");
- CHECK( LZ4F_createDecompressionContext(&dCtx, LZ4F_VERSION) );
- memset(&prefs.frameInfo, 0, sizeof(prefs.frameInfo));
- CHECK( LZ4F_getFrameInfo(dCtx, &prefs.frameInfo, compressedBuffer, &cErr) );
- if (prefs.frameInfo.dictID != dictID) goto _output_error;
- DISPLAYLEVEL(3, "%u \n", (U32)prefs.frameInfo.dictID);
- CHECK( LZ4F_freeDecompressionContext(dCtx) ); dCtx = NULL;
- CHECK( LZ4F_freeCompressionContext(cctx) ); cctx = NULL;
- }
- /* Dictionary compression test */
- { size_t const dictSize = 7 KB; /* small enough for LZ4_MEMORY_USAGE == 10 */
- size_t const srcSize = 65 KB; /* must be > 64 KB to avoid short-size optimizations */
- size_t const dstCapacity = LZ4F_compressFrameBound(srcSize, NULL);
- size_t cSizeNoDict, cSizeWithDict;
- LZ4F_CDict* const cdict = LZ4F_createCDict(CNBuffer, dictSize);
- if (cdict == NULL) goto _output_error;
- CHECK( LZ4F_createCompressionContext(&cctx, LZ4F_VERSION) );
- DISPLAYLEVEL(3, "Testing LZ4F_createCDict_advanced : ");
- { LZ4F_CDict* const cda = LZ4F_createCDict_advanced(lz4f_cmem_test, CNBuffer, dictSize);
- if (cda == NULL) goto _output_error;
- LZ4F_freeCDict(cda);
- }
- DISPLAYLEVEL(3, "OK \n");
- DISPLAYLEVEL(3, "LZ4F_compressFrame_usingCDict, with NULL dict : ");
- CHECK_V(cSizeNoDict,
- LZ4F_compressFrame_usingCDict(cctx, compressedBuffer, dstCapacity,
- CNBuffer, srcSize,
- NULL, NULL) );
- DISPLAYLEVEL(3, "%u bytes \n", (unsigned)cSizeNoDict);
- CHECK( LZ4F_freeCompressionContext(cctx) );
- CHECK( LZ4F_createCompressionContext(&cctx, LZ4F_VERSION) );
- DISPLAYLEVEL(3, "LZ4F_compressFrame_usingCDict, with dict : ");
- CHECK_V(cSizeWithDict,
- LZ4F_compressFrame_usingCDict(cctx, compressedBuffer, dstCapacity,
- CNBuffer, srcSize,
- cdict, NULL) );
- DISPLAYLEVEL(3, "compressed %u bytes into %u bytes \n",
- (unsigned)srcSize, (unsigned)cSizeWithDict);
- if (cSizeWithDict > cSizeNoDict) {
- DISPLAYLEVEL(3, "cSizeWithDict (%zu) should have been more compact than cSizeNoDict(%zu) \n", cSizeWithDict, cSizeNoDict);
- goto _output_error; /* must be more efficient */
- }
- crcOrig = XXH64(CNBuffer, srcSize, 0);
- DISPLAYLEVEL(3, "LZ4F_decompress_usingDict : ");
- { LZ4F_dctx* dctx;
- size_t decodedSize = srcSize;
- size_t compressedSize = cSizeWithDict;
- CHECK( LZ4F_createDecompressionContext(&dctx, LZ4F_VERSION) );
- CHECK( LZ4F_decompress_usingDict(dctx,
- decodedBuffer, &decodedSize,
- compressedBuffer, &compressedSize,
- CNBuffer, dictSize,
- NULL) );
- if (compressedSize != cSizeWithDict) goto _output_error;
- if (decodedSize != srcSize) goto _output_error;
- { U64 const crcDest = XXH64(decodedBuffer, decodedSize, 0);
- if (crcDest != crcOrig) goto _output_error; }
- DISPLAYLEVEL(3, "Regenerated %u bytes \n", (U32)decodedSize);
- CHECK( LZ4F_freeDecompressionContext(dctx) );
- }
- DISPLAYLEVEL(3, "LZ4F_compressFrame_usingCDict, with dict, negative level : ");
- { size_t cSizeLevelMax;
- LZ4F_preferences_t cParams;
- memset(&cParams, 0, sizeof(cParams));
- cParams.compressionLevel = -3;
- CHECK_V(cSizeLevelMax,
- LZ4F_compressFrame_usingCDict(cctx, compressedBuffer, dstCapacity,
- CNBuffer, dictSize,
- cdict, &cParams) );
- DISPLAYLEVEL(3, "%u bytes \n", (unsigned)cSizeLevelMax);
- }
- DISPLAYLEVEL(3, "LZ4F_compressFrame_usingCDict, with dict, level max : ");
- { size_t cSizeLevelMax;
- LZ4F_preferences_t cParams;
- memset(&cParams, 0, sizeof(cParams));
- cParams.compressionLevel = LZ4F_compressionLevel_max();
- CHECK_V(cSizeLevelMax,
- LZ4F_compressFrame_usingCDict(cctx, compressedBuffer, dstCapacity,
- CNBuffer, dictSize,
- cdict, &cParams) );
- DISPLAYLEVEL(3, "%u bytes \n", (unsigned)cSizeLevelMax);
- }
- DISPLAYLEVEL(3, "LZ4F_compressFrame_usingCDict, multiple linked blocks : ");
- { size_t cSizeContiguous;
- size_t const inSize = dictSize * 3;
- size_t const outCapacity = LZ4F_compressFrameBound(inSize, NULL);
- LZ4F_preferences_t cParams;
- memset(&cParams, 0, sizeof(cParams));
- cParams.frameInfo.blockMode = LZ4F_blockLinked;
- cParams.frameInfo.blockSizeID = LZ4F_max64KB;
- CHECK_V(cSizeContiguous,
- LZ4F_compressFrame_usingCDict(cctx, compressedBuffer, outCapacity,
- CNBuffer, inSize,
- cdict, &cParams) );
- DISPLAYLEVEL(3, "compressed %u bytes into %u bytes \n",
- (unsigned)inSize, (unsigned)cSizeContiguous);
- DISPLAYLEVEL(3, "LZ4F_decompress_usingDict on multiple linked blocks : ");
- { LZ4F_dctx* dctx;
- size_t decodedSize = COMPRESSIBLE_NOISE_LENGTH;
- size_t compressedSize = cSizeContiguous;
- CHECK( LZ4F_createDecompressionContext(&dctx, LZ4F_VERSION) );
- CHECK( LZ4F_decompress_usingDict(dctx,
- decodedBuffer, &decodedSize,
- compressedBuffer, &compressedSize,
- CNBuffer, dictSize,
- NULL) );
- if (compressedSize != cSizeContiguous) goto _output_error;
- if (decodedSize != inSize) goto _output_error;
- crcOrig = XXH64(CNBuffer, inSize, 0);
- { U64 const crcDest = XXH64(decodedBuffer, decodedSize, 0);
- if (crcDest != crcOrig) goto _output_error; }
- DISPLAYLEVEL(3, "Regenerated %u bytes \n", (U32)decodedSize);
- CHECK( LZ4F_freeDecompressionContext(dctx) );
- }
- }
- DISPLAYLEVEL(3, "LZ4F_compressFrame_usingCDict, multiple independent blocks : ");
- { size_t cSizeIndep;
- size_t const inSize = dictSize * 3;
- size_t const outCapacity = LZ4F_compressFrameBound(inSize, NULL);
- LZ4F_preferences_t cParams;
- memset(&cParams, 0, sizeof(cParams));
- cParams.frameInfo.blockMode = LZ4F_blockIndependent;
- cParams.frameInfo.blockSizeID = LZ4F_max64KB;
- CHECK_V(cSizeIndep,
- LZ4F_compressFrame_usingCDict(cctx, compressedBuffer, outCapacity,
- CNBuffer, inSize,
- cdict, &cParams) );
- DISPLAYLEVEL(3, "compressed %u bytes into %u bytes \n",
- (unsigned)inSize, (unsigned)cSizeIndep);
- DISPLAYLEVEL(3, "LZ4F_decompress_usingDict on multiple independent blocks : ");
- { LZ4F_dctx* dctx;
- size_t decodedSize = COMPRESSIBLE_NOISE_LENGTH;
- size_t compressedSize = cSizeIndep;
- CHECK( LZ4F_createDecompressionContext(&dctx, LZ4F_VERSION) );
- CHECK( LZ4F_decompress_usingDict(dctx,
- decodedBuffer, &decodedSize,
- compressedBuffer, &compressedSize,
- CNBuffer, dictSize,
- NULL) );
- if (compressedSize != cSizeIndep) goto _output_error;
- if (decodedSize != inSize) goto _output_error;
- crcOrig = XXH64(CNBuffer, inSize, 0);
- { U64 const crcDest = XXH64(decodedBuffer, decodedSize, 0);
- if (crcDest != crcOrig) goto _output_error; }
- DISPLAYLEVEL(3, "Regenerated %u bytes \n", (U32)decodedSize);
- CHECK( LZ4F_freeDecompressionContext(dctx) );
- }
- }
- LZ4F_freeCDict(cdict);
- CHECK( LZ4F_freeCompressionContext(cctx) ); cctx = NULL;
- }
- DISPLAYLEVEL(3, "getBlockSize test: \n");
- { size_t result;
- unsigned blockSizeID;
- for (blockSizeID = 4; blockSizeID < 8; ++blockSizeID) {
- result = LZ4F_getBlockSize((LZ4F_blockSizeID_t)blockSizeID);
- CHECK(result);
- DISPLAYLEVEL(3, "Returned block size of %u bytes for blockID %u \n",
- (unsigned)result, blockSizeID);
- }
- /* Test an invalid input that's too large */
- result = LZ4F_getBlockSize((LZ4F_blockSizeID_t)8);
- if(!LZ4F_isError(result) ||
- LZ4F_getErrorCode(result) != LZ4F_ERROR_maxBlockSize_invalid)
- goto _output_error;
- /* Test an invalid input that's too small */
- result = LZ4F_getBlockSize((LZ4F_blockSizeID_t)3);
- if(!LZ4F_isError(result) ||
- LZ4F_getErrorCode(result) != LZ4F_ERROR_maxBlockSize_invalid)
- goto _output_error;
- }
- DISPLAYLEVEL(3, "Skippable frame test : \n");
- { size_t decodedBufferSize = COMPRESSIBLE_NOISE_LENGTH;
- unsigned maxBits = FUZ_highbit((U32)decodedBufferSize);
- BYTE* op = (BYTE*)decodedBuffer;
- BYTE* const oend = (BYTE*)decodedBuffer + COMPRESSIBLE_NOISE_LENGTH;
- BYTE* ip = (BYTE*)compressedBuffer;
- BYTE* iend = (BYTE*)compressedBuffer + cSize + 8;
- CHECK( LZ4F_createDecompressionContext(&dCtx, LZ4F_VERSION) );
- /* generate skippable frame */
- FUZ_writeLE32(ip, LZ4F_MAGIC_SKIPPABLE_START);
- FUZ_writeLE32(ip+4, (U32)cSize);
- DISPLAYLEVEL(3, "random segment sizes : \n");
- while (ip < iend) {
- unsigned nbBits = FUZ_rand(&randState) % maxBits;
- size_t iSize = (FUZ_rand(&randState) & ((1<<nbBits)-1)) + 1;
- size_t oSize = (size_t)(oend-op);
- if (iSize > (size_t)(iend-ip)) iSize = (size_t)(iend-ip);
- CHECK( LZ4F_decompress(dCtx, op, &oSize, ip, &iSize, NULL) );
- op += oSize;
- ip += iSize;
- }
- DISPLAYLEVEL(3, "Skipped %i bytes \n", (int)decodedBufferSize);
- /* generate zero-size skippable frame */
- DISPLAYLEVEL(3, "zero-size skippable frame\n");
- ip = (BYTE*)compressedBuffer;
- op = (BYTE*)decodedBuffer;
- FUZ_writeLE32(ip, LZ4F_MAGIC_SKIPPABLE_START+1);
- FUZ_writeLE32(ip+4, 0);
- iend = ip+8;
- while (ip < iend) {
- unsigned const nbBits = FUZ_rand(&randState) % maxBits;
- size_t iSize = (FUZ_rand(&randState) & ((1<<nbBits)-1)) + 1;
- size_t oSize = (size_t)(oend-op);
- if (iSize > (size_t)(iend-ip)) iSize = (size_t)(iend-ip);
- CHECK( LZ4F_decompress(dCtx, op, &oSize, ip, &iSize, NULL) );
- op += oSize;
- ip += iSize;
- }
- DISPLAYLEVEL(3, "Skipped %i bytes \n", (int)(ip - (BYTE*)compressedBuffer - 8));
- DISPLAYLEVEL(3, "Skippable frame header complete in first call \n");
- ip = (BYTE*)compressedBuffer;
- op = (BYTE*)decodedBuffer;
- FUZ_writeLE32(ip, LZ4F_MAGIC_SKIPPABLE_START+2);
- FUZ_writeLE32(ip+4, 10);
- iend = ip+18;
- while (ip < iend) {
- size_t iSize = 10;
- size_t oSize = 10;
- if (iSize > (size_t)(iend-ip)) iSize = (size_t)(iend-ip);
- CHECK( LZ4F_decompress(dCtx, op, &oSize, ip, &iSize, NULL) );
- op += oSize;
- ip += iSize;
- }
- DISPLAYLEVEL(3, "Skipped %i bytes \n", (int)(ip - (BYTE*)compressedBuffer - 8));
- }
- DISPLAY("Basic tests completed \n");
- _end:
- free(CNBuffer);
- free(compressedBuffer);
- free(decodedBuffer);
- LZ4F_freeDecompressionContext(dCtx); dCtx = NULL;
- LZ4F_freeCompressionContext(cctx); cctx = NULL;
- return basicTests_error;
- _output_error:
- basicTests_error = 1;
- DISPLAY("Error detected ! \n");
- goto _end;
- }
- typedef enum { o_contiguous, o_noncontiguous, o_overwrite } o_scenario_e;
- static void locateBuffDiff(const void* buff1, const void* buff2, size_t size, o_scenario_e o_scenario)
- {
- if (displayLevel >= 2) {
- size_t p=0;
- const BYTE* b1=(const BYTE*)buff1;
- const BYTE* b2=(const BYTE*)buff2;
- DISPLAY("locateBuffDiff: looking for error position \n");
- if (o_scenario != o_contiguous) {
- DISPLAY("mode %i: non-contiguous output (%u bytes), cannot search \n",
- (int)o_scenario, (unsigned)size);
- return;
- }
- while (p < size && b1[p]==b2[p]) p++;
- if (p != size) {
- DISPLAY("Error at pos %i/%i : %02X != %02X \n", (int)p, (int)size, b1[p], b2[p]);
- }
- }
- }
- # define EXIT_MSG(...) { DISPLAY("Error => "); DISPLAY(__VA_ARGS__); \
- DISPLAY(" (seed %u, test nb %u) \n", seed, testNb); exit(1); }
- # undef CHECK
- # define CHECK(cond, ...) { if (cond) { EXIT_MSG(__VA_ARGS__); } }
- size_t test_lz4f_decompression_wBuffers(
- const void* cSrc, size_t cSize,
- void* dst, size_t dstCapacity, o_scenario_e o_scenario,
- const void* srcRef, size_t decompressedSize,
- U64 crcOrig,
- U32* const randState,
- LZ4F_dctx* const dCtx,
- U32 seed, U32 testNb,
- int findErrorPos)
- {
- const BYTE* ip = (const BYTE*)cSrc;
- const BYTE* const iend = ip + cSize;
- BYTE* op = (BYTE*)dst;
- BYTE* const oend = op + dstCapacity;
- unsigned const suggestedBits = FUZ_highbit((U32)cSize);
- unsigned const maxBits = MAX(3, suggestedBits);
- size_t totalOut = 0;
- size_t moreToFlush = 0;
- XXH64_state_t xxh64;
- XXH64_reset(&xxh64, 1);
- assert(ip < iend);
- while (ip < iend) {
- unsigned const nbBitsI = (FUZ_rand(randState) % (maxBits-1)) + 1;
- unsigned const nbBitsO = (FUZ_rand(randState) % (maxBits)) + 1;
- size_t const iSizeCand = (FUZ_rand(randState) & ((1<<nbBitsI)-1)) + 1;
- size_t const iSizeMax = MIN(iSizeCand, (size_t)(iend-ip));
- size_t iSize = iSizeMax;
- size_t const oSizeCand = (FUZ_rand(randState) & ((1<<nbBitsO)-1)) + 2;
- size_t const oSizeMax = MIN(oSizeCand, (size_t)(oend-op));
- int const sentinelTest = (op + oSizeMax < oend);
- size_t oSize = oSizeMax;
- BYTE const mark = (BYTE)(FUZ_rand(randState) & 255);
- LZ4F_decompressOptions_t dOptions;
- memset(&dOptions, 0, sizeof(dOptions));
- dOptions.stableDst = FUZ_rand(randState) & 1;
- if (o_scenario == o_overwrite) dOptions.stableDst = 0; /* overwrite mode */
- dOptions.skipChecksums = FUZ_rand(randState) & 127;
- if (sentinelTest) op[oSizeMax] = mark;
- DISPLAYLEVEL(7, "dstCapacity=%u, presentedInput=%u \n", (unsigned)oSize, (unsigned)iSize);
- /* read data from byte-exact buffer to catch out-of-bound reads */
- { void* const iBuffer = malloc(iSizeMax);
- void* const tmpop = (FUZ_rand(randState) & (oSize == 0)) ? NULL : op;
- const void* const tmpip = (FUZ_rand(randState) & (iSize == 0)) ? NULL : iBuffer;
- assert(iBuffer != NULL);
- memcpy(iBuffer, ip, iSizeMax);
- moreToFlush = LZ4F_decompress(dCtx, tmpop, &oSize, tmpip, &iSize, &dOptions);
- free(iBuffer);
- }
- DISPLAYLEVEL(7, "oSize=%u, readSize=%u \n", (unsigned)oSize, (unsigned)iSize);
- if (sentinelTest) {
- CHECK(op[oSizeMax] != mark, "op[oSizeMax] = %02X != %02X : "
- "Decompression overwrites beyond assigned dst size",
- op[oSizeMax], mark);
- }
- if (LZ4F_getErrorCode(moreToFlush) == LZ4F_ERROR_contentChecksum_invalid) {
- if (findErrorPos) DISPLAYLEVEL(2, "checksum error detected \n");
- if (findErrorPos) locateBuffDiff(srcRef, dst, decompressedSize, o_scenario);
- }
- if (LZ4F_isError(moreToFlush)) return moreToFlush;
- XXH64_update(&xxh64, op, oSize);
- totalOut += oSize;
- op += oSize;
- ip += iSize;
- if (o_scenario == o_noncontiguous) {
- if (op == oend) return LZ4F_ERROR_GENERIC; /* can theoretically happen with bogus data */
- op++; /* create a gap between consecutive output */
- }
- if (o_scenario==o_overwrite) op = (BYTE*)dst; /* overwrite destination */
- if ( (op == oend) /* no more room for output; can happen with bogus input */
- && (iSize == 0)) /* no input consumed */
- break;
- }
- if (moreToFlush != 0) return LZ4F_ERROR_decompressionFailed;
- if (totalOut) { /* otherwise, it's a skippable frame */
- U64 const crcDecoded = XXH64_digest(&xxh64);
- if (crcDecoded != crcOrig) {
- if (findErrorPos) locateBuffDiff(srcRef, dst, decompressedSize, o_scenario);
- return LZ4F_ERROR_contentChecksum_invalid;
- } }
- return 0;
- }
- size_t test_lz4f_decompression(const void* cSrc, size_t cSize,
- const void* srcRef, size_t decompressedSize,
- U64 crcOrig,
- U32* const randState,
- LZ4F_dctx* const dCtx,
- U32 seed, U32 testNb,
- int findErrorPos)
- {
- o_scenario_e const o_scenario = (o_scenario_e)(FUZ_rand(randState) % 3); /* 0 : contiguous; 1 : non-contiguous; 2 : dst overwritten */
- /* tighten dst buffer conditions */
- size_t const dstCapacity = (o_scenario == o_noncontiguous) ?
- (decompressedSize * 2) + 128 :
- decompressedSize;
- size_t result;
- void* const dstBuffer = malloc(dstCapacity);
- assert(dstBuffer != NULL);
- result = test_lz4f_decompression_wBuffers(cSrc, cSize,
- dstBuffer, dstCapacity, o_scenario,
- srcRef, decompressedSize,
- crcOrig,
- randState,
- dCtx,
- seed, testNb, findErrorPos);
- free(dstBuffer);
- return result;
- }
- int fuzzerTests(U32 seed, unsigned nbTests, unsigned startTest, double compressibility, U32 duration_s)
- {
- unsigned testNb = 0;
- size_t const CNBufferLength = 9 MB; /* needs to be > 2x4MB to test large blocks */
- void* CNBuffer = NULL;
- size_t const compressedBufferSize = LZ4F_compressFrameBound(CNBufferLength, NULL) + 4 MB; /* needs some margin */
- void* compressedBuffer = NULL;
- void* decodedBuffer = NULL;
- U32 coreRand = seed;
- LZ4F_decompressionContext_t dCtx = NULL;
- LZ4F_decompressionContext_t dCtxNoise = NULL;
- LZ4F_compressionContext_t cCtx = NULL;
- clock_t const startClock = clock();
- clock_t const clockDuration = duration_s * CLOCKS_PER_SEC;
- /* Create states & buffers */
- { size_t const creationStatus = LZ4F_createDecompressionContext(&dCtx, LZ4F_VERSION);
- CHECK(LZ4F_isError(creationStatus), "Allocation failed (error %i)", (int)creationStatus); }
- { size_t const creationStatus = LZ4F_createDecompressionContext(&dCtxNoise, LZ4F_VERSION);
- CHECK(LZ4F_isError(creationStatus), "Allocation failed (error %i)", (int)creationStatus); }
- { size_t const creationStatus = LZ4F_createCompressionContext(&cCtx, LZ4F_VERSION);
- CHECK(LZ4F_isError(creationStatus), "Allocation failed (error %i)", (int)creationStatus); }
- CNBuffer = malloc(CNBufferLength);
- CHECK(CNBuffer==NULL, "CNBuffer Allocation failed");
- compressedBuffer = malloc(compressedBufferSize);
- CHECK(compressedBuffer==NULL, "compressedBuffer Allocation failed");
- decodedBuffer = calloc(1, CNBufferLength); /* calloc avoids decodedBuffer being considered "garbage" by scan-build */
- CHECK(decodedBuffer==NULL, "decodedBuffer Allocation failed");
- FUZ_fillCompressibleNoiseBuffer(CNBuffer, CNBufferLength, compressibility, &coreRand);
- /* jump to requested testNb */
- for (testNb =0; (testNb < startTest); testNb++) (void)FUZ_rand(&coreRand); /* sync randomizer */
- /* main fuzzer test loop */
- for ( ; (testNb < nbTests) || (clockDuration > FUZ_GetClockSpan(startClock)) ; testNb++) {
- U32 randState = coreRand ^ prime1;
- unsigned const srcBits = (FUZ_rand(&randState) % (FUZ_highbit((U32)(CNBufferLength-1)) - 1)) + 1;
- size_t const srcSize = (FUZ_rand(&randState) & ((1<<srcBits)-1)) + 1;
- size_t const srcStartId = FUZ_rand(&randState) % (CNBufferLength - srcSize);
- const BYTE* const srcStart = (const BYTE*)CNBuffer + srcStartId;
- unsigned const neverFlush = (FUZ_rand(&randState) & 15) == 1;
- U64 const crcOrig = XXH64(srcStart, srcSize, 1);
- LZ4F_preferences_t prefs;
- const LZ4F_preferences_t* prefsPtr = &prefs;
- size_t cSize;
- (void)FUZ_rand(&coreRand); /* update seed */
- memset(&prefs, 0, sizeof(prefs));
- prefs.frameInfo.blockMode = (LZ4F_blockMode_t)(FUZ_rand(&randState) & 1);
- prefs.frameInfo.blockSizeID = (LZ4F_blockSizeID_t)(4 + (FUZ_rand(&randState) & 3));
- prefs.frameInfo.blockChecksumFlag = (LZ4F_blockChecksum_t)(FUZ_rand(&randState) & 1);
- prefs.frameInfo.contentChecksumFlag = (LZ4F_contentChecksum_t)(FUZ_rand(&randState) & 1);
- prefs.frameInfo.contentSize = ((FUZ_rand(&randState) & 0xF) == 1) ? srcSize : 0;
- prefs.autoFlush = neverFlush ? 0 : (FUZ_rand(&randState) & 7) == 2;
- prefs.compressionLevel = -5 + (int)(FUZ_rand(&randState) % 11);
- if ((FUZ_rand(&randState) & 0xF) == 1) prefsPtr = NULL;
- DISPLAYUPDATE(2, "\r%5u ", testNb);
- if ((FUZ_rand(&randState) & 0xFFF) == 0) {
- /* create a skippable frame (rare case) */
- BYTE* op = (BYTE*)compressedBuffer;
- FUZ_writeLE32(op, LZ4F_MAGIC_SKIPPABLE_START + (FUZ_rand(&randState) & 15));
- FUZ_writeLE32(op+4, (U32)srcSize);
- cSize = srcSize+8;
- } else if ((FUZ_rand(&randState) & 0xF) == 2) { /* single pass compression (simple) */
- cSize = LZ4F_compressFrame(compressedBuffer, LZ4F_compressFrameBound(srcSize, prefsPtr), srcStart, srcSize, prefsPtr);
- CHECK(LZ4F_isError(cSize), "LZ4F_compressFrame failed : error %i (%s)", (int)cSize, LZ4F_getErrorName(cSize));
- } else { /* multi-segments compression */
- const BYTE* ip = srcStart;
- const BYTE* const iend = srcStart + srcSize;
- BYTE* op = (BYTE*)compressedBuffer;
- BYTE* const oend = op + (neverFlush ? LZ4F_compressFrameBound(srcSize, prefsPtr) : compressedBufferSize); /* when flushes are possible, can't guarantee a max compressed size */
- unsigned const maxBits = FUZ_highbit((U32)srcSize);
- LZ4F_compressOptions_t cOptions;
- memset(&cOptions, 0, sizeof(cOptions));
- { size_t const fhSize = LZ4F_compressBegin(cCtx, op, (size_t)(oend-op), prefsPtr);
- CHECK(LZ4F_isError(fhSize), "Compression header failed (error %i)",
- (int)fhSize);
- op += fhSize;
- }
- while (ip < iend) {
- unsigned const nbBitsSeg = FUZ_rand(&randState) % maxBits;
- size_t const sampleMax = (FUZ_rand(&randState) & ((1<<nbBitsSeg)-1)) + 1;
- size_t iSize = MIN(sampleMax, (size_t)(iend-ip));
- size_t const oSize = LZ4F_compressBound(iSize, prefsPtr);
- cOptions.stableSrc = ((FUZ_rand(&randState) & 3) == 1);
- DISPLAYLEVEL(6, "Sending %u bytes to compress (stableSrc:%u) \n",
- (unsigned)iSize, cOptions.stableSrc);
- #if 1
- /* insert uncompressed segment */
- if ( (iSize>0)
- && !neverFlush /* do not mess with compressBound when neverFlush is set */
- && prefsPtr != NULL /* prefs are set */
- && prefs.frameInfo.blockMode == LZ4F_blockIndependent /* uncompressedUpdate is only valid with blockMode==independent */
- && (FUZ_rand(&randState) & 15) == 1 ) {
- size_t const uSize = FUZ_rand(&randState) % iSize;
- size_t const flushedSize = LZ4F_uncompressedUpdate(cCtx, op, (size_t)(oend-op), ip, uSize, &cOptions);
- CHECK(LZ4F_isError(flushedSize), "Insert uncompressed data failed (error %i : %s)",
- (int)flushedSize, LZ4F_getErrorName(flushedSize));
- op += flushedSize;
- ip += uSize;
- iSize -= uSize;
- }
- #endif
- { size_t const flushedSize = LZ4F_compressUpdate(cCtx, op, oSize, ip, iSize, &cOptions);
- CHECK(LZ4F_isError(flushedSize), "Compression failed (error %i : %s)",
- (int)flushedSize, LZ4F_getErrorName(flushedSize));
- op += flushedSize;
- ip += iSize;
- }
- { unsigned const forceFlush = neverFlush ? 0 : ((FUZ_rand(&randState) & 3) == 1);
- if (forceFlush) {
- size_t const flushSize = LZ4F_flush(cCtx, op, (size_t)(oend-op), &cOptions);
- DISPLAYLEVEL(6,"flushing %u bytes \n", (unsigned)flushSize);
- CHECK(LZ4F_isError(flushSize), "Compression failed (error %i)", (int)flushSize);
- op += flushSize;
- if ((FUZ_rand(&randState) % 1024) == 3) {
- /* add an empty block (requires uncompressed flag) */
- op[0] = op[1] = op[2] = 0;
- op[3] = 0x80; /* 0x80000000U in little-endian format */
- op += 4;
- if ((prefsPtr!= NULL) && prefsPtr->frameInfo.blockChecksumFlag) {
- /* add block checksum (even for empty blocks) */
- FUZ_writeLE32(op, XXH32(op, 0, 0));
- op += 4;
- } } } }
- } /* while (ip<iend) */
- CHECK(op>=oend, "LZ4F_compressFrameBound overflow");
- { size_t const dstEndSafeSize = LZ4F_compressBound(0, prefsPtr);
- int const tooSmallDstEnd = ((FUZ_rand(&randState) & 31) == 3);
- size_t const dstEndTooSmallSize = (FUZ_rand(&randState) % dstEndSafeSize) + 1;
- size_t const dstEndSize = tooSmallDstEnd ? dstEndTooSmallSize : dstEndSafeSize;
- BYTE const canaryByte = (BYTE)(FUZ_rand(&randState) & 255);
- size_t flushedSize;
- DISPLAYLEVEL(7,"canaryByte at pos %u / %u \n",
- (unsigned)((size_t)(op - (BYTE*)compressedBuffer) + dstEndSize),
- (unsigned)compressedBufferSize);
- assert(op + dstEndSize < (BYTE*)compressedBuffer + compressedBufferSize);
- op[dstEndSize] = canaryByte;
- flushedSize = LZ4F_compressEnd(cCtx, op, dstEndSize, &cOptions);
- CHECK(op[dstEndSize] != canaryByte, "LZ4F_compressEnd writes beyond dstCapacity !");
- if (LZ4F_isError(flushedSize)) {
- if (tooSmallDstEnd) /* failure is allowed */ continue;
- CHECK(!tooSmallDstEnd, "Compression completion failed (error %i : %s)",
- (int)flushedSize, LZ4F_getErrorName(flushedSize));
- }
- op += flushedSize;
- }
- cSize = (size_t)(op - (BYTE*)compressedBuffer);
- DISPLAYLEVEL(5, "\nCompressed %u bytes into %u \n", (U32)srcSize, (U32)cSize);
- }
- /* multi-segments decompression */
- DISPLAYLEVEL(6, "normal decompression \n");
- { size_t result = test_lz4f_decompression(compressedBuffer, cSize, srcStart, srcSize, crcOrig, &randState, dCtx, seed, testNb, 1 /*findError*/ );
- CHECK (LZ4F_isError(result), "multi-segment decompression failed (error %i => %s)",
- (int)result, LZ4F_getErrorName(result));
- }
- #if 1
- /* insert noise into src */
- { U32 const maxNbBits = FUZ_highbit((U32)cSize);
- size_t pos = 0;
- for (;;) {
- /* keep some original src */
- { U32 const nbBits = FUZ_rand(&randState) % maxNbBits;
- size_t const mask = (1<<nbBits) - 1;
- size_t const skipLength = FUZ_rand(&randState) & mask;
- pos += skipLength;
- }
- if (pos >= cSize) break;
- /* add noise */
- { U32 const nbBitsCodes = FUZ_rand(&randState) % maxNbBits;
- U32 const nbBits = nbBitsCodes ? nbBitsCodes-1 : 0;
- size_t const mask = (1<<nbBits) - 1;
- size_t const rNoiseLength = (FUZ_rand(&randState) & mask) + 1;
- size_t const noiseLength = MIN(rNoiseLength, cSize-pos);
- size_t const noiseStart = FUZ_rand(&randState) % (CNBufferLength - noiseLength);
- memcpy((BYTE*)compressedBuffer + pos, (const char*)CNBuffer + noiseStart, noiseLength);
- pos += noiseLength;
- } } }
- /* test decompression on noisy src */
- DISPLAYLEVEL(6, "noisy decompression \n");
- test_lz4f_decompression(compressedBuffer, cSize, srcStart, srcSize, crcOrig, &randState, dCtxNoise, seed, testNb, 0 /*don't search error Pos*/ );
- /* note : we don't analyze result here : it probably failed, which is expected.
- * The sole purpose is to catch potential out-of-bound reads and writes. */
- LZ4F_resetDecompressionContext(dCtxNoise); /* context must be reset after an error */
- #endif
- } /* for ( ; (testNb < nbTests) ; ) */
- DISPLAYLEVEL(2, "\rAll tests completed \n");
- LZ4F_freeDecompressionContext(dCtx);
- LZ4F_freeDecompressionContext(dCtxNoise);
- LZ4F_freeCompressionContext(cCtx);
- free(CNBuffer);
- free(compressedBuffer);
- free(decodedBuffer);
- if (use_pause) {
- DISPLAY("press enter to finish \n");
- (void)getchar();
- }
- return 0;
- }
- int FUZ_usage(const char* programName)
- {
- DISPLAY( "Usage :\n");
- DISPLAY( " %s [args]\n", programName);
- DISPLAY( "\n");
- DISPLAY( "Arguments :\n");
- DISPLAY( " -i# : Nb of tests (default:%u) \n", nbTestsDefault);
- DISPLAY( " -T# : Duration of tests, in seconds (default: use Nb of tests) \n");
- DISPLAY( " -s# : Select seed (default:prompt user)\n");
- DISPLAY( " -t# : Select starting test number (default:0)\n");
- DISPLAY( " -P# : Select compressibility in %% (default:%i%%)\n", FUZ_COMPRESSIBILITY_DEFAULT);
- DISPLAY( " -v : verbose\n");
- DISPLAY( " -h : display help and exit\n");
- return 0;
- }
- int main(int argc, const char** argv)
- {
- U32 seed=0;
- int seedset=0;
- int argNb;
- unsigned nbTests = nbTestsDefault;
- unsigned testNb = 0;
- int proba = FUZ_COMPRESSIBILITY_DEFAULT;
- int result=0;
- U32 duration=0;
- const char* const programName = argv[0];
- /* Check command line */
- for (argNb=1; argNb<argc; argNb++) {
- const char* argument = argv[argNb];
- if(!argument) continue; /* Protection if argument empty */
- /* Decode command (note : aggregated short commands are allowed) */
- if (argument[0]=='-') {
- if (!strcmp(argument, "--no-prompt")) {
- no_prompt=1;
- seedset=1;
- displayLevel=1;
- continue;
- }
- argument++;
- while (*argument!=0) {
- switch(*argument)
- {
- case 'h':
- return FUZ_usage(programName);
- case 'v':
- argument++;
- displayLevel++;
- break;
- case 'q':
- argument++;
- displayLevel--;
- break;
- case 'p': /* pause at the end */
- argument++;
- use_pause = 1;
- break;
- case 'i':
- argument++;
- nbTests=0; duration=0;
- while ((*argument>='0') && (*argument<='9')) {
- nbTests *= 10;
- nbTests += (unsigned)(*argument - '0');
- argument++;
- }
- break;
- case 'T':
- argument++;
- nbTests = 0; duration = 0;
- for (;;) {
- switch(*argument)
- {
- case 'm': duration *= 60; argument++; continue;
- case 's':
- case 'n': argument++; continue;
- case '0':
- case '1':
- case '2':
- case '3':
- case '4':
- case '5':
- case '6':
- case '7':
- case '8':
- case '9': duration *= 10; duration += (U32)(*argument++ - '0'); continue;
- }
- break;
- }
- break;
- case 's':
- argument++;
- seed=0;
- seedset=1;
- while ((*argument>='0') && (*argument<='9')) {
- seed *= 10;
- seed += (U32)(*argument - '0');
- argument++;
- }
- break;
- case 't':
- argument++;
- testNb=0;
- while ((*argument>='0') && (*argument<='9')) {
- testNb *= 10;
- testNb += (unsigned)(*argument - '0');
- argument++;
- }
- break;
- case 'P': /* compressibility % */
- argument++;
- proba=0;
- while ((*argument>='0') && (*argument<='9')) {
- proba *= 10;
- proba += *argument - '0';
- argument++;
- }
- if (proba<0) proba=0;
- if (proba>100) proba=100;
- break;
- default:
- ;
- return FUZ_usage(programName);
- }
- }
- }
- }
- /* Get Seed */
- DISPLAY("Starting lz4frame tester (%i-bits, %s)\n", (int)(sizeof(size_t)*8), LZ4_VERSION_STRING);
- if (!seedset) {
- time_t const t = time(NULL);
- U32 const h = XXH32(&t, sizeof(t), 1);
- seed = h % 10000;
- }
- DISPLAY("Seed = %u\n", seed);
- if (proba!=FUZ_COMPRESSIBILITY_DEFAULT) DISPLAY("Compressibility : %i%%\n", proba);
- nbTests += (nbTests==0); /* avoid zero */
- if (testNb==0) result = basicTests(seed, ((double)proba) / 100);
- if (result) return 1;
- return fuzzerTests(seed, nbTests, testNb, ((double)proba) / 100, duration);
- }
|