/* paramgrill.c - parameter tester for zstd_hc Copyright (C) Yann Collet 2015 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 : - zstd source repository : https://github.com/Cyan4973/zstd - ztsd public forum : https://groups.google.com/forum/#!forum/lz4c */ /************************************** * Compiler Options **************************************/ /* Disable some Visual warning messages */ #define _CRT_SECURE_NO_WARNINGS #define _CRT_SECURE_NO_DEPRECATE /* VS2005 */ /* Unix Large Files support (>4GB) */ #if (defined(__sun__) && (!defined(__LP64__))) /* Sun Solaris 32-bits requires specific definitions */ # define _LARGEFILE_SOURCE # define _FILE_OFFSET_BITS 64 #elif ! defined(__LP64__) /* No point defining Large file for 64 bit */ # define _LARGEFILE64_SOURCE #endif /* S_ISREG & gettimeofday() are not supported by MSVC */ #if defined(_MSC_VER) || defined(_WIN32) # define BMK_LEGACY_TIMER 1 #endif /************************************** * Includes **************************************/ #include /* malloc */ #include /* fprintf, fopen, ftello64 */ #include /* stat64 */ #include /* stat64 */ #include /* strcmp */ /* Use ftime() if gettimeofday() is not available on your target */ #if defined(BMK_LEGACY_TIMER) # include /* timeb, ftime */ #else # include /* gettimeofday */ #endif #include "mem.h" #include "zstdhc_static.h" #include "zstd.h" #include "datagen.h" #include "xxhash.h" /************************************** * Compiler Options **************************************/ /* S_ISREG & gettimeofday() are not supported by MSVC */ #if !defined(S_ISREG) # define S_ISREG(x) (((x) & S_IFMT) == S_IFREG) #endif /************************************** * Constants **************************************/ #define PROGRAM_DESCRIPTION "ZSTD_HC parameters tester" #ifndef ZSTD_VERSION # define ZSTD_VERSION "" #endif #define AUTHOR "Yann Collet" #define WELCOME_MESSAGE "*** %s %s %i-bits, by %s (%s) ***\n", PROGRAM_DESCRIPTION, ZSTD_VERSION, (int)(sizeof(void*)*8), AUTHOR, __DATE__ #define KB *(1<<10) #define MB *(1<<20) #define NBLOOPS 2 #define TIMELOOP 2000 #define KNUTH 2654435761U #define MAX_MEM (1984 MB) #define DEFAULT_CHUNKSIZE (4<<20) #define COMPRESSIBILITY_DEFAULT 0.50 static const size_t sampleSize = 10000000; static const int g_grillDuration = 50000000; /* about 13 hours */ static const int g_maxParamTime = 15000; /* 15 sec */ static const int g_maxVariationTime = 60000; /* 60 sec */ static const int g_maxNbVariations = 64; /************************************** * Macros **************************************/ #define DISPLAY(...) fprintf(stderr, __VA_ARGS__) /************************************** * Benchmark Parameters **************************************/ static U32 nbIterations = NBLOOPS; static double g_compressibility = COMPRESSIBILITY_DEFAULT; static U32 g_blockSize = 0; static U32 g_rand = 1; static U32 g_singleRun = 0; static U32 g_target = 0; static U32 g_noSeed = 0; static ZSTD_HC_parameters g_params = { 0, 0, 0, 0 }; void BMK_SetNbIterations(int nbLoops) { nbIterations = nbLoops; DISPLAY("- %u iterations -\n", nbIterations); } /********************************************************* * Private functions *********************************************************/ static unsigned BMK_highbit(U32 val) { # if defined(_MSC_VER) /* Visual */ unsigned long r; _BitScanReverse(&r, val); return (unsigned)r; # elif defined(__GNUC__) && (__GNUC__ >= 3) /* GCC Intrinsic */ return 31 - __builtin_clz(val); # else /* Software version */ static const int DeBruijnClz[32] = { 0, 9, 1, 10, 13, 21, 2, 29, 11, 14, 16, 18, 22, 25, 3, 30, 8, 12, 20, 28, 15, 17, 24, 7, 19, 27, 23, 6, 26, 5, 4, 31 }; U32 v = val; int r; v |= v >> 1; v |= v >> 2; v |= v >> 4; v |= v >> 8; v |= v >> 16; r = DeBruijnClz[(U32)(v * 0x07C4ACDDU) >> 27]; return r; # endif } #if defined(BMK_LEGACY_TIMER) static int BMK_GetMilliStart(void) { /* Based on Legacy ftime() * Rolls over every ~ 12.1 days (0x100000/24/60/60) * Use GetMilliSpan to correct for rollover */ struct timeb tb; int nCount; ftime( &tb ); nCount = (int) (tb.millitm + (tb.time & 0xfffff) * 1000); return nCount; } #else static int BMK_GetMilliStart(void) { /* Based on newer gettimeofday() * Use GetMilliSpan to correct for rollover */ struct timeval tv; int nCount; gettimeofday(&tv, NULL); nCount = (int) (tv.tv_usec/1000 + (tv.tv_sec & 0xfffff) * 1000); return nCount; } #endif static int BMK_GetMilliSpan( int nTimeStart ) { int nSpan = BMK_GetMilliStart() - nTimeStart; if ( nSpan < 0 ) nSpan += 0x100000 * 1000; return nSpan; } static size_t BMK_findMaxMem(U64 requiredMem) { size_t step = 64 MB; BYTE* testmem=NULL; requiredMem = (((requiredMem >> 26) + 1) << 26); if (requiredMem > MAX_MEM) requiredMem = MAX_MEM; requiredMem += 2*step; while (!testmem) { requiredMem -= step; testmem = (BYTE*) malloc ((size_t)requiredMem); } free (testmem); return (size_t) (requiredMem - step); } static U64 BMK_GetFileSize(char* infilename) { int r; #if defined(_MSC_VER) struct _stat64 statbuf; r = _stat64(infilename, &statbuf); #else struct stat statbuf; r = stat(infilename, &statbuf); #endif if (r || !S_ISREG(statbuf.st_mode)) return 0; /* No good... */ return (U64)statbuf.st_size; } # define FUZ_rotl32(x,r) ((x << r) | (x >> (32 - r))) U32 FUZ_rand(U32* src) { const U32 prime1 = 2654435761U; const U32 prime2 = 2246822519U; U32 rand32 = *src; rand32 *= prime1; rand32 += prime2; rand32 = FUZ_rotl32(rand32, 13); *src = rand32; return rand32 >> 5; } /********************************************************* * Bench functions *********************************************************/ typedef struct { size_t cSize; U32 cSpeed; U32 dSpeed; } BMK_result_t; typedef struct { const char* srcPtr; size_t srcSize; char* cPtr; size_t cRoom; size_t cSize; char* resPtr; size_t resSize; } blockParam_t; #define MIN(a,b) ( (a) < (b) ? (a) : (b) ) static size_t BMK_benchParam(BMK_result_t* resultPtr, const void* srcBuffer, size_t srcSize, ZSTD_HC_CCtx* ctx, const ZSTD_HC_parameters params) { const size_t blockSize = g_blockSize ? g_blockSize : srcSize; const U32 nbBlocks = (U32) ((srcSize + (blockSize-1)) / blockSize); blockParam_t* const blockTable = (blockParam_t*) malloc(nbBlocks * sizeof(blockParam_t)); const size_t maxCompressedSize = (size_t)nbBlocks * ZSTD_compressBound(blockSize); void* const compressedBuffer = malloc(maxCompressedSize); void* const resultBuffer = malloc(srcSize); U32 Wlog = params.windowLog; U32 Clog = params.chainLog; U32 Hlog = params.hashLog; U32 Slog = params.searchLog; U64 crcOrig; /* Memory allocation & restrictions */ if (!compressedBuffer || !resultBuffer || !blockTable) { DISPLAY("\nError: not enough memory!\n"); free(compressedBuffer); free(resultBuffer); free(blockTable); return 12; } /* Calculating input Checksum */ crcOrig = XXH64(srcBuffer, srcSize, 0); /* Init blockTable data */ { U32 i; size_t remaining = srcSize; const char* srcPtr = (const char*)srcBuffer; char* cPtr = (char*)compressedBuffer; char* resPtr = (char*)resultBuffer; for (i=0; i g_maxParamTime) break; /* Compression */ DISPLAY("%1u-W%02uC%02uH%02uS%02u : %9u ->\r", loopNb, Wlog, Clog, Hlog, Slog, (U32)srcSize); memset(compressedBuffer, 0xE5, maxCompressedSize); nbLoops = 0; milliTime = BMK_GetMilliStart(); while (BMK_GetMilliStart() == milliTime); milliTime = BMK_GetMilliStart(); while (BMK_GetMilliSpan(milliTime) < TIMELOOP) { for (blockNb=0; blockNb", loopNb, Wlog, Clog, Hlog, Slog, (U32)srcSize); DISPLAY(" %9u (%4.3f),%7.1f MB/s\r", (U32)cSize, ratio, (double)srcSize / fastestC / 1000.); resultPtr->cSize = cSize; resultPtr->cSpeed = (U32)((double)srcSize / fastestC); #if 1 /* Decompression */ memset(resultBuffer, 0xD6, srcSize); nbLoops = 0; milliTime = BMK_GetMilliStart(); while (BMK_GetMilliStart() == milliTime); milliTime = BMK_GetMilliStart(); for ( ; BMK_GetMilliSpan(milliTime) < TIMELOOP; nbLoops++) { for (blockNb=0; blockNb ", loopNb, Wlog, Clog, Hlog, Slog, (U32)srcSize); DISPLAY("%9u (%4.3f),%7.1f MB/s, ", (U32)cSize, ratio, (double)srcSize / fastestC / 1000.); DISPLAY("%7.1f MB/s\r", (double)srcSize / fastestD / 1000.); resultPtr->dSpeed = (U32)((double)srcSize / fastestD); /* CRC Checking */ crcCheck = XXH64(resultBuffer, srcSize, 0); if (crcOrig!=crcCheck) { unsigned u; unsigned eBlockSize = (unsigned)(MIN(65536*2, blockSize)); DISPLAY("\n!!! WARNING !!! Invalid Checksum : %x != %x\n", (unsigned)crcOrig, (unsigned)crcCheck); for (u=0; u g_cSpeedTarget[cLevel]) && ((winners[cLevel].result.cSize==0) || (winners[cLevel].result.cSize > testResult.cSize)) ) { better = 1; winners[cLevel].result = testResult; winners[cLevel].params = params; BMK_printWinner(stdout, cLevel, testResult, params, srcSize); } } return better; } #define MAX(a,b) ( (a) > (b) ? (a) : (b) ) static BYTE g_alreadyTested[ZSTD_HC_WINDOWLOG_MAX+1-ZSTD_HC_WINDOWLOG_MIN] [ZSTD_HC_CHAINLOG_MAX+1-ZSTD_HC_CHAINLOG_MIN] [ZSTD_HC_HASHLOG_MAX+1-ZSTD_HC_HASHLOG_MIN] [ZSTD_HC_SEARCHLOG_MAX+1-ZSTD_HC_SEARCHLOG_MIN] = {}; /* init to zero */ #define NB_TESTS_PLAYED(p) \ g_alreadyTested[p.windowLog-ZSTD_HC_WINDOWLOG_MIN] \ [p.chainLog-ZSTD_HC_CHAINLOG_MIN] \ [p.hashLog-ZSTD_HC_HASHLOG_MIN] \ [p.searchLog-ZSTD_HC_SEARCHLOG_MIN] static void playAround(FILE* f, winnerInfo_t* winners, ZSTD_HC_parameters params, const void* srcBuffer, size_t srcSize, ZSTD_HC_CCtx* ctx) { const U32 srcLog = BMK_highbit((U32)( (g_blockSize ? g_blockSize : srcSize) -1))+1; int nbVariations = 0; const int startTime = BMK_GetMilliStart(); while (BMK_GetMilliSpan(startTime) < g_maxVariationTime) { ZSTD_HC_parameters p = params; U32 nbChanges = (FUZ_rand(&g_rand) & 3) + 1; if (nbVariations++ > g_maxNbVariations) break; for (; nbChanges; nbChanges--) { const U32 changeID = FUZ_rand(&g_rand) & 7; switch(changeID) { case 0: p.chainLog++; break; case 1: p.chainLog--; break; case 2: p.hashLog++; break; case 3: p.hashLog--; break; case 4: p.searchLog++; break; case 5: p.searchLog--; break; case 6: p.windowLog++; break; case 7: p.windowLog--; break; } } /* validate new conf */ if (p.windowLog > srcLog) continue; if (p.windowLog > ZSTD_HC_WINDOWLOG_MAX) continue; if (p.windowLog < MAX(ZSTD_HC_WINDOWLOG_MIN, p.chainLog)) continue; if (p.chainLog > p.windowLog) continue; if (p.chainLog < ZSTD_HC_CHAINLOG_MIN) continue; if (p.hashLog > ZSTD_HC_HASHLOG_MAX) continue; if (p.hashLog < ZSTD_HC_HASHLOG_MIN) continue; if (p.searchLog > p.chainLog) continue; if (p.searchLog < ZSTD_HC_SEARCHLOG_MIN) continue; /* exclude faster if already played params */ if (FUZ_rand(&g_rand) & ((1 << NB_TESTS_PLAYED(p))-1)) continue; /* test */ NB_TESTS_PLAYED(p)++; if (!BMK_seed(winners, p, srcBuffer, srcSize, ctx)) continue; /* improvement found => search more */ BMK_printWinners(f, winners, srcSize); playAround(f, winners, p, srcBuffer, srcSize, ctx); } } static void BMK_selectRandomStart( FILE* f, winnerInfo_t* winners, const void* srcBuffer, size_t srcSize, ZSTD_HC_CCtx* ctx) { U32 id = FUZ_rand(&g_rand) % (ZSTD_HC_MAX_CLEVEL+1); if ((id==0) || (winners[id].params.windowLog==0)) { /* totally random entry */ ZSTD_HC_parameters p; p.chainLog = FUZ_rand(&g_rand) % (ZSTD_HC_CHAINLOG_MAX+1 - ZSTD_HC_CHAINLOG_MIN) + ZSTD_HC_CHAINLOG_MIN; p.hashLog = FUZ_rand(&g_rand) % (ZSTD_HC_HASHLOG_MAX+1 - ZSTD_HC_HASHLOG_MIN) + ZSTD_HC_HASHLOG_MIN; p.searchLog = FUZ_rand(&g_rand) % (ZSTD_HC_SEARCHLOG_MAX+1 - ZSTD_HC_SEARCHLOG_MIN) + ZSTD_HC_SEARCHLOG_MIN; p.windowLog = FUZ_rand(&g_rand) % (ZSTD_HC_WINDOWLOG_MAX+1 - ZSTD_HC_WINDOWLOG_MIN) + ZSTD_HC_WINDOWLOG_MIN; playAround(f, winners, p, srcBuffer, srcSize, ctx); } else playAround(f, winners, winners[id].params, srcBuffer, srcSize, ctx); } static const ZSTD_HC_parameters* seedParams = ZSTD_HC_defaultParameters; static void BMK_benchMem(void* srcBuffer, size_t srcSize) { ZSTD_HC_CCtx* ctx = ZSTD_HC_createCCtx(); ZSTD_HC_parameters params; winnerInfo_t winners[ZSTD_HC_MAX_CLEVEL+1]; BMK_result_t testResult; int i; const char* rfName = "grillResults.txt"; FILE* f; const U32 srcLog = BMK_highbit((U32)( (g_blockSize ? g_blockSize : srcSize) -1))+1; if (g_singleRun) { BMK_benchParam(&testResult, srcBuffer, srcSize, ctx, g_params); DISPLAY("\n"); return; } /* init */ memset(winners, 0, sizeof(winners)); f = fopen(rfName, "w"); if (f==NULL) { DISPLAY("error opening %s \n", rfName); exit(1); } if (g_target) g_cSpeedTarget[9] = g_target * 1000; else { /* baseline config for level 9 */ params.windowLog = MIN(srcLog, 19); params.chainLog = MIN(params.windowLog, 19); params.hashLog = 19; params.searchLog = MIN(params.chainLog, 9); BMK_benchParam(&testResult, srcBuffer, srcSize, ctx, params); g_cSpeedTarget[9] = (testResult.cSpeed * 15) >> 4; } /* establish speed objectives (relative to level9) */ g_cSpeedTarget[1] = g_cSpeedTarget[9] << 4; g_cSpeedTarget[0] = (g_cSpeedTarget[1] * 181) >> 7; /* sqrt2 */ for (i=2; i> 8; /* populate initial solution */ { const int maxSeeds = g_noSeed ? 1 : ZSTD_HC_MAX_CLEVEL; //BMK_seed(winners, params, srcBuffer, srcSize, ctx); for (i=1; i<=maxSeeds; i++) { params = seedParams[i]; params.windowLog = MIN(srcLog, params.windowLog); params.chainLog = MIN(params.windowLog, params.chainLog); params.searchLog = MIN(params.chainLog, params.searchLog); BMK_seed(winners, params, srcBuffer, srcSize, ctx); } } BMK_printWinners(f, winners, srcSize); /* start tests */ { const int milliStart = BMK_GetMilliStart(); int mLength; do { BMK_selectRandomStart(f, winners, srcBuffer, srcSize, ctx); mLength = BMK_GetMilliSpan(milliStart); } while (mLength < g_grillDuration); } /* end summary */ BMK_printWinners(f, winners, srcSize); DISPLAY("grillParams operations completed \n"); /* clean up*/ fclose(f); ZSTD_HC_freeCCtx(ctx); } static int benchSample(void) { char* origBuff; size_t benchedSize = sampleSize; const char* name = "Sample 10MiB"; /* Allocation */ origBuff = (char*) malloc((size_t)benchedSize); if(!origBuff) { DISPLAY("\nError: not enough memory!\n"); return 12; } /* Fill buffer */ RDG_genBuffer(origBuff, benchedSize, g_compressibility, 0.0, 0); /* bench */ DISPLAY("\r%79s\r", ""); DISPLAY("using %s %i%%: \n", name, (int)(g_compressibility*100)); BMK_benchMem(origBuff, benchedSize); free(origBuff); return 0; } int benchFiles(char** fileNamesTable, int nbFiles) { int fileIdx=0; /* Loop for each file */ while (fileIdx inFileSize) benchedSize = (size_t)inFileSize; if (benchedSize < inFileSize) { DISPLAY("Not enough memory for '%s' full size; testing %i MB only...\n", inFileName, (int)(benchedSize>>20)); } /* Alloc */ origBuff = (char*) malloc((size_t)benchedSize); if(!origBuff) { DISPLAY("\nError: not enough memory!\n"); fclose(inFile); return 12; } /* Fill input buffer */ DISPLAY("Loading %s... \r", inFileName); readSize = fread(origBuff, 1, benchedSize, inFile); fclose(inFile); if(readSize != benchedSize) { DISPLAY("\nError: problem reading file '%s' !! \n", inFileName); free(origBuff); return 13; } /* bench */ DISPLAY("\r%79s\r", ""); DISPLAY("using %s : \n", inFileName); BMK_benchMem(origBuff, benchedSize); } return 0; } int usage(char* exename) { DISPLAY( "Usage :\n"); DISPLAY( " %s [arg] file\n", exename); DISPLAY( "Arguments :\n"); DISPLAY( " -H/-h : Help (this text + advanced options)\n"); return 0; } int usage_advanced(void) { DISPLAY( "\nAdvanced options :\n"); DISPLAY( " -i# : iteration loops [1-9](default : %i)\n", NBLOOPS); DISPLAY( " -P# : sample compressibility (default : %.1f%%)\n", COMPRESSIBILITY_DEFAULT * 100); return 0; } int badusage(char* exename) { DISPLAY("Wrong parameters\n"); usage(exename); return 1; } int main(int argc, char** argv) { int i, filenamesStart=0, result; char* exename=argv[0]; char* input_filename=0; U32 main_pause = 0; /* Welcome message */ DISPLAY(WELCOME_MESSAGE); if (argc<1) { badusage(exename); return 1; } for(i=1; i='0') && (argument[0] <='9')) { int iters = argument[0] - '0'; BMK_SetNbIterations(iters); argument++; } break; /* Sample compressibility (when no file provided) */ case 'P': argument++; { U32 proba32 = 0; while ((argument[0]>= '0') && (argument[0]<= '9')) { proba32 *= 10; proba32 += argument[0] - '0'; argument++; } g_compressibility = (double)proba32 / 100.; } break; /* Run Single conf */ case 'S': { if (argument[ 1]!='w') return badusage(exename); if (argument[ 4]!='c') return badusage(exename); if (argument[ 7]!='h') return badusage(exename); if (argument[10]!='s') return badusage(exename); g_singleRun = 1; g_params.windowLog = (argument[ 2] - '0') * 10 + (argument[ 3] - '0'); g_params.chainLog = (argument[ 5] - '0') * 10 + (argument[ 6] - '0'); g_params.hashLog = (argument[ 8] - '0') * 10 + (argument[ 9] - '0'); g_params.searchLog = (argument[11] - '0') * 10 + (argument[12] - '0'); argument += 13; break; } /* target level9 objective, in MB/s */ case 'T': argument++; g_target = 0; while ((*argument >= '0') && (*argument <= '9')) { g_target *= 10; g_target += *argument - '0'; argument++; } break; /* cut input into blocks */ case 'B': { g_blockSize = 0; argument++; while ((*argument >='0') && (*argument <='9')) g_blockSize *= 10, g_blockSize += *argument++ - '0'; if (*argument=='K') g_blockSize<<=10, argument++; /* allows using KB notation */ if (*argument=='M') g_blockSize<<=20, argument++; if (*argument=='B') argument++; } break; /* Unknown command */ default : return badusage(exename); } } continue; } /* first provided filename is input */ if (!input_filename) { input_filename=argument; filenamesStart=i; continue; } } if (filenamesStart==0) result = benchSample(); else result = benchFiles(argv+filenamesStart, argc-filenamesStart); if (main_pause) { int unused; printf("press enter...\n"); unused = getchar(); (void)unused; } return result; }