/** * Copyright (c) 2016-present, Yann Collet, Facebook, Inc. * All rights reserved. * * This source code is licensed under the BSD-style license found in the * LICENSE file in the root directory of this source tree. An additional grant * of patent rights can be found in the PATENTS file in the same directory. */ /* ************************************** * Compiler Warnings ****************************************/ #ifdef _MSC_VER # pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */ #endif /*-************************************* * Includes ***************************************/ #include "platform.h" /* Large Files support */ #include "util.h" /* UTIL_getFileSize, UTIL_getTotalFileSize */ #include /* malloc, free */ #include /* memset */ #include /* fprintf, fopen, ftello64 */ #include /* clock_t, clock, CLOCKS_PER_SEC */ #include /* errno */ #include "mem.h" /* read */ #include "error_private.h" #include "dibio.h" /*-************************************* * Constants ***************************************/ #define KB *(1 <<10) #define MB *(1 <<20) #define GB *(1U<<30) #define SAMPLESIZE_MAX (128 KB) #define MEMMULT 11 /* rough estimation : memory cost to analyze 1 byte of sample */ #define COVER_MEMMULT 9 /* rough estimation : memory cost to analyze 1 byte of sample */ static const size_t maxMemory = (sizeof(size_t) == 4) ? (2 GB - 64 MB) : ((size_t)(512 MB) << sizeof(size_t)); #define NOISELENGTH 32 /*-************************************* * Console display ***************************************/ #define DISPLAY(...) fprintf(stderr, __VA_ARGS__) #define DISPLAYLEVEL(l, ...) if (g_displayLevel>=l) { DISPLAY(__VA_ARGS__); } static unsigned g_displayLevel = 0; /* 0 : no display; 1: errors; 2: default; 4: full information */ #define DISPLAYUPDATE(l, ...) if (g_displayLevel>=l) { \ if ((DIB_clockSpan(g_time) > refreshRate) || (g_displayLevel>=4)) \ { g_time = clock(); DISPLAY(__VA_ARGS__); \ if (g_displayLevel>=4) fflush(stdout); } } static const clock_t refreshRate = CLOCKS_PER_SEC * 2 / 10; static clock_t g_time = 0; static clock_t DIB_clockSpan(clock_t nPrevious) { return clock() - nPrevious; } /*-************************************* * Exceptions ***************************************/ #ifndef DEBUG # define DEBUG 0 #endif #define DEBUGOUTPUT(...) if (DEBUG) DISPLAY(__VA_ARGS__); #define EXM_THROW(error, ...) \ { \ DEBUGOUTPUT("Error defined at %s, line %i : \n", __FILE__, __LINE__); \ DISPLAYLEVEL(1, "Error %i : ", error); \ DISPLAYLEVEL(1, __VA_ARGS__); \ DISPLAYLEVEL(1, "\n"); \ exit(error); \ } /* ******************************************************** * Helper functions **********************************************************/ unsigned DiB_isError(size_t errorCode) { return ERR_isError(errorCode); } const char* DiB_getErrorName(size_t errorCode) { return ERR_getErrorName(errorCode); } #define MIN(a,b) ( (a) < (b) ? (a) : (b) ) /* ******************************************************** * File related operations **********************************************************/ /** DiB_loadFiles() : * @return : nb of files effectively loaded into `buffer` */ static unsigned DiB_loadFiles(void* buffer, size_t* bufferSizePtr, size_t* fileSizes, const char** fileNamesTable, unsigned nbFiles) { char* const buff = (char*)buffer; size_t pos = 0; unsigned n; for (n=0; n *bufferSizePtr-pos) break; { FILE* const f = fopen(fileName, "rb"); if (f==NULL) EXM_THROW(10, "zstd: dictBuilder: %s %s ", fileName, strerror(errno)); DISPLAYUPDATE(2, "Loading %s... \r", fileName); { size_t const readSize = fread(buff+pos, 1, fileSize, f); if (readSize != fileSize) EXM_THROW(11, "Pb reading %s", fileName); pos += readSize; } fileSizes[n] = fileSize; fclose(f); } } DISPLAYLEVEL(2, "\r%79s\r", ""); *bufferSizePtr = pos; return n; } #define DiB_rotl32(x,r) ((x << r) | (x >> (32 - r))) static U32 DiB_rand(U32* src) { static const U32 prime1 = 2654435761U; static const U32 prime2 = 2246822519U; U32 rand32 = *src; rand32 *= prime1; rand32 ^= prime2; rand32 = DiB_rotl32(rand32, 13); *src = rand32; return rand32 >> 5; } static void DiB_shuffle(const char** fileNamesTable, unsigned nbFiles) { /* Initialize the pseudorandom number generator */ U32 seed = 0xFD2FB528; unsigned i; for (i = nbFiles - 1; i > 0; --i) { unsigned const j = DiB_rand(&seed) % (i + 1); const char* tmp = fileNamesTable[j]; fileNamesTable[j] = fileNamesTable[i]; fileNamesTable[i] = tmp; } } /*-******************************************************** * Dictionary training functions **********************************************************/ static size_t DiB_findMaxMem(unsigned long long requiredMem) { size_t const step = 8 MB; void* testmem = NULL; requiredMem = (((requiredMem >> 23) + 1) << 23); requiredMem += step; if (requiredMem > maxMemory) requiredMem = maxMemory; while (!testmem) { testmem = malloc((size_t)requiredMem); requiredMem -= step; } free(testmem); return (size_t)requiredMem; } static void DiB_fillNoise(void* buffer, size_t length) { unsigned const prime1 = 2654435761U; unsigned const prime2 = 2246822519U; unsigned acc = prime1; size_t p=0;; for (p=0; p> 21); } } static void DiB_saveDict(const char* dictFileName, const void* buff, size_t buffSize) { FILE* const f = fopen(dictFileName, "wb"); if (f==NULL) EXM_THROW(3, "cannot open %s ", dictFileName); { size_t const n = fwrite(buff, 1, buffSize, f); if (n!=buffSize) EXM_THROW(4, "%s : write error", dictFileName) } { size_t const n = (size_t)fclose(f); if (n!=0) EXM_THROW(5, "%s : flush error", dictFileName) } } static int g_tooLargeSamples = 0; static U64 DiB_getTotalCappedFileSize(const char** fileNamesTable, unsigned nbFiles) { U64 total = 0; unsigned n; for (n=0; n 2*SAMPLESIZE_MAX); } return total; } /*! ZDICT_trainFromBuffer_unsafe() : Strictly Internal use only !! Same as ZDICT_trainFromBuffer_advanced(), but does not control `samplesBuffer`. `samplesBuffer` must be followed by noisy guard band to avoid out-of-buffer reads. @return : size of dictionary stored into `dictBuffer` (<= `dictBufferCapacity`) or an error code. */ size_t ZDICT_trainFromBuffer_unsafe(void* dictBuffer, size_t dictBufferCapacity, const void* samplesBuffer, const size_t* samplesSizes, unsigned nbSamples, ZDICT_params_t parameters); int DiB_trainFromFiles(const char* dictFileName, unsigned maxDictSize, const char** fileNamesTable, unsigned nbFiles, ZDICT_params_t *params, COVER_params_t *coverParams, int optimizeCover) { void* const dictBuffer = malloc(maxDictSize); size_t* const fileSizes = (size_t*)malloc(nbFiles * sizeof(size_t)); unsigned long long const totalSizeToLoad = DiB_getTotalCappedFileSize(fileNamesTable, nbFiles); size_t const memMult = params ? MEMMULT : COVER_MEMMULT; size_t const maxMem = DiB_findMaxMem(totalSizeToLoad * memMult) / memMult; size_t benchedSize = (size_t) MIN ((unsigned long long)maxMem, totalSizeToLoad); void* const srcBuffer = malloc(benchedSize+NOISELENGTH); int result = 0; /* Checks */ if (params) g_displayLevel = params->notificationLevel; else if (coverParams) g_displayLevel = coverParams->notificationLevel; else EXM_THROW(13, "Neither dictionary algorith selected"); /* should not happen */ if ((!fileSizes) || (!srcBuffer) || (!dictBuffer)) EXM_THROW(12, "not enough memory for DiB_trainFiles"); /* should not happen */ if (g_tooLargeSamples) { DISPLAYLEVEL(2, "! Warning : some samples are very large \n"); DISPLAYLEVEL(2, "! Note that dictionary is only useful for small files or beginning of large files. \n"); DISPLAYLEVEL(2, "! As a consequence, only the first %u bytes of each file are loaded \n", SAMPLESIZE_MAX); } if ((nbFiles < 5) || (totalSizeToLoad < 9 * (unsigned long long)maxDictSize)) { DISPLAYLEVEL(2, "! Warning : nb of samples too low for proper processing ! \n"); DISPLAYLEVEL(2, "! Please provide _one file per sample_. \n"); DISPLAYLEVEL(2, "! Do not concatenate samples together into a single file, \n"); DISPLAYLEVEL(2, "! as dictBuilder will be unable to find the beginning of each sample, \n"); DISPLAYLEVEL(2, "! resulting in poor dictionary quality. \n"); } /* init */ if (benchedSize < totalSizeToLoad) DISPLAYLEVEL(1, "Not enough memory; training on %u MB only...\n", (unsigned)(benchedSize >> 20)); /* Load input buffer */ DISPLAYLEVEL(3, "Shuffling input files\n"); DiB_shuffle(fileNamesTable, nbFiles); nbFiles = DiB_loadFiles(srcBuffer, &benchedSize, fileSizes, fileNamesTable, nbFiles); { size_t dictSize; if (params) { DiB_fillNoise((char*)srcBuffer + benchedSize, NOISELENGTH); /* guard band, for end of buffer condition */ dictSize = ZDICT_trainFromBuffer_unsafe(dictBuffer, maxDictSize, srcBuffer, fileSizes, nbFiles, *params); } else if (optimizeCover) { dictSize = COVER_optimizeTrainFromBuffer( dictBuffer, maxDictSize, srcBuffer, fileSizes, nbFiles, coverParams); if (!ZDICT_isError(dictSize)) { DISPLAYLEVEL(2, "k=%u\nd=%u\nsteps=%u\n", coverParams->k, coverParams->d, coverParams->steps); } } else { dictSize = COVER_trainFromBuffer(dictBuffer, maxDictSize, srcBuffer, fileSizes, nbFiles, *coverParams); } if (ZDICT_isError(dictSize)) { DISPLAYLEVEL(1, "dictionary training failed : %s \n", ZDICT_getErrorName(dictSize)); /* should not happen */ result = 1; goto _cleanup; } /* save dict */ DISPLAYLEVEL(2, "Save dictionary of size %u into file %s \n", (U32)dictSize, dictFileName); DiB_saveDict(dictFileName, dictBuffer, dictSize); } /* clean up */ _cleanup: free(srcBuffer); free(dictBuffer); free(fileSizes); return result; }