0001
0002
0003
0004
0005
0006
0007
0008
0009
0010
0011
0012
0013
0014
0015
0016
0017
0018
0019
0020
0021 #ifndef ZSTD_HEAPMODE
0022 # define ZSTD_HEAPMODE 1
0023 #endif
0024
0025
0026
0027
0028
0029
0030
0031
0032
0033
0034
0035
0036 #ifndef ZSTD_MAXWINDOWSIZE_DEFAULT
0037 # define ZSTD_MAXWINDOWSIZE_DEFAULT (((U32)1 << ZSTD_WINDOWLOG_LIMIT_DEFAULT) + 1)
0038 #endif
0039
0040
0041
0042
0043
0044
0045
0046
0047 #ifndef ZSTD_NO_FORWARD_PROGRESS_MAX
0048 # define ZSTD_NO_FORWARD_PROGRESS_MAX 16
0049 #endif
0050
0051
0052
0053
0054
0055 #include "../common/zstd_deps.h" /* ZSTD_memcpy, ZSTD_memmove, ZSTD_memset */
0056 #include "../common/cpu.h" /* bmi2 */
0057 #include "../common/mem.h" /* low level memory routines */
0058 #define FSE_STATIC_LINKING_ONLY
0059 #include "../common/fse.h"
0060 #define HUF_STATIC_LINKING_ONLY
0061 #include "../common/huf.h"
0062 #include <linux/xxhash.h> /* xxh64_reset, xxh64_update, xxh64_digest, XXH64 */
0063 #include "../common/zstd_internal.h" /* blockProperties_t */
0064 #include "zstd_decompress_internal.h" /* ZSTD_DCtx */
0065 #include "zstd_ddict.h" /* ZSTD_DDictDictContent */
0066 #include "zstd_decompress_block.h" /* ZSTD_decompressBlock_internal */
0067
0068
0069
0070
0071
0072
0073
0074
0075 #define DDICT_HASHSET_MAX_LOAD_FACTOR_COUNT_MULT 4
0076 #define DDICT_HASHSET_MAX_LOAD_FACTOR_SIZE_MULT 3
0077
0078
0079
0080
0081
0082 #define DDICT_HASHSET_TABLE_BASE_SIZE 64
0083 #define DDICT_HASHSET_RESIZE_FACTOR 2
0084
0085
0086
0087
0088 static size_t ZSTD_DDictHashSet_getIndex(const ZSTD_DDictHashSet* hashSet, U32 dictID) {
0089 const U64 hash = xxh64(&dictID, sizeof(U32), 0);
0090
0091 return hash & (hashSet->ddictPtrTableSize - 1);
0092 }
0093
0094
0095
0096
0097
0098 static size_t ZSTD_DDictHashSet_emplaceDDict(ZSTD_DDictHashSet* hashSet, const ZSTD_DDict* ddict) {
0099 const U32 dictID = ZSTD_getDictID_fromDDict(ddict);
0100 size_t idx = ZSTD_DDictHashSet_getIndex(hashSet, dictID);
0101 const size_t idxRangeMask = hashSet->ddictPtrTableSize - 1;
0102 RETURN_ERROR_IF(hashSet->ddictPtrCount == hashSet->ddictPtrTableSize, GENERIC, "Hash set is full!");
0103 DEBUGLOG(4, "Hashed index: for dictID: %u is %zu", dictID, idx);
0104 while (hashSet->ddictPtrTable[idx] != NULL) {
0105
0106 if (ZSTD_getDictID_fromDDict(hashSet->ddictPtrTable[idx]) == dictID) {
0107 DEBUGLOG(4, "DictID already exists, replacing rather than adding");
0108 hashSet->ddictPtrTable[idx] = ddict;
0109 return 0;
0110 }
0111 idx &= idxRangeMask;
0112 idx++;
0113 }
0114 DEBUGLOG(4, "Final idx after probing for dictID %u is: %zu", dictID, idx);
0115 hashSet->ddictPtrTable[idx] = ddict;
0116 hashSet->ddictPtrCount++;
0117 return 0;
0118 }
0119
0120
0121
0122
0123
0124 static size_t ZSTD_DDictHashSet_expand(ZSTD_DDictHashSet* hashSet, ZSTD_customMem customMem) {
0125 size_t newTableSize = hashSet->ddictPtrTableSize * DDICT_HASHSET_RESIZE_FACTOR;
0126 const ZSTD_DDict** newTable = (const ZSTD_DDict**)ZSTD_customCalloc(sizeof(ZSTD_DDict*) * newTableSize, customMem);
0127 const ZSTD_DDict** oldTable = hashSet->ddictPtrTable;
0128 size_t oldTableSize = hashSet->ddictPtrTableSize;
0129 size_t i;
0130
0131 DEBUGLOG(4, "Expanding DDict hash table! Old size: %zu new size: %zu", oldTableSize, newTableSize);
0132 RETURN_ERROR_IF(!newTable, memory_allocation, "Expanded hashset allocation failed!");
0133 hashSet->ddictPtrTable = newTable;
0134 hashSet->ddictPtrTableSize = newTableSize;
0135 hashSet->ddictPtrCount = 0;
0136 for (i = 0; i < oldTableSize; ++i) {
0137 if (oldTable[i] != NULL) {
0138 FORWARD_IF_ERROR(ZSTD_DDictHashSet_emplaceDDict(hashSet, oldTable[i]), "");
0139 }
0140 }
0141 ZSTD_customFree((void*)oldTable, customMem);
0142 DEBUGLOG(4, "Finished re-hash");
0143 return 0;
0144 }
0145
0146
0147
0148
0149 static const ZSTD_DDict* ZSTD_DDictHashSet_getDDict(ZSTD_DDictHashSet* hashSet, U32 dictID) {
0150 size_t idx = ZSTD_DDictHashSet_getIndex(hashSet, dictID);
0151 const size_t idxRangeMask = hashSet->ddictPtrTableSize - 1;
0152 DEBUGLOG(4, "Hashed index: for dictID: %u is %zu", dictID, idx);
0153 for (;;) {
0154 size_t currDictID = ZSTD_getDictID_fromDDict(hashSet->ddictPtrTable[idx]);
0155 if (currDictID == dictID || currDictID == 0) {
0156
0157 break;
0158 } else {
0159 idx &= idxRangeMask;
0160 idx++;
0161 }
0162 }
0163 DEBUGLOG(4, "Final idx after probing for dictID %u is: %zu", dictID, idx);
0164 return hashSet->ddictPtrTable[idx];
0165 }
0166
0167
0168
0169
0170
0171 static ZSTD_DDictHashSet* ZSTD_createDDictHashSet(ZSTD_customMem customMem) {
0172 ZSTD_DDictHashSet* ret = (ZSTD_DDictHashSet*)ZSTD_customMalloc(sizeof(ZSTD_DDictHashSet), customMem);
0173 DEBUGLOG(4, "Allocating new hash set");
0174 if (!ret)
0175 return NULL;
0176 ret->ddictPtrTable = (const ZSTD_DDict**)ZSTD_customCalloc(DDICT_HASHSET_TABLE_BASE_SIZE * sizeof(ZSTD_DDict*), customMem);
0177 if (!ret->ddictPtrTable) {
0178 ZSTD_customFree(ret, customMem);
0179 return NULL;
0180 }
0181 ret->ddictPtrTableSize = DDICT_HASHSET_TABLE_BASE_SIZE;
0182 ret->ddictPtrCount = 0;
0183 return ret;
0184 }
0185
0186
0187
0188
0189 static void ZSTD_freeDDictHashSet(ZSTD_DDictHashSet* hashSet, ZSTD_customMem customMem) {
0190 DEBUGLOG(4, "Freeing ddict hash set");
0191 if (hashSet && hashSet->ddictPtrTable) {
0192 ZSTD_customFree((void*)hashSet->ddictPtrTable, customMem);
0193 }
0194 if (hashSet) {
0195 ZSTD_customFree(hashSet, customMem);
0196 }
0197 }
0198
0199
0200
0201
0202 static size_t ZSTD_DDictHashSet_addDDict(ZSTD_DDictHashSet* hashSet, const ZSTD_DDict* ddict, ZSTD_customMem customMem) {
0203 DEBUGLOG(4, "Adding dict ID: %u to hashset with - Count: %zu Tablesize: %zu", ZSTD_getDictID_fromDDict(ddict), hashSet->ddictPtrCount, hashSet->ddictPtrTableSize);
0204 if (hashSet->ddictPtrCount * DDICT_HASHSET_MAX_LOAD_FACTOR_COUNT_MULT / hashSet->ddictPtrTableSize * DDICT_HASHSET_MAX_LOAD_FACTOR_SIZE_MULT != 0) {
0205 FORWARD_IF_ERROR(ZSTD_DDictHashSet_expand(hashSet, customMem), "");
0206 }
0207 FORWARD_IF_ERROR(ZSTD_DDictHashSet_emplaceDDict(hashSet, ddict), "");
0208 return 0;
0209 }
0210
0211
0212
0213
0214 size_t ZSTD_sizeof_DCtx (const ZSTD_DCtx* dctx)
0215 {
0216 if (dctx==NULL) return 0;
0217 return sizeof(*dctx)
0218 + ZSTD_sizeof_DDict(dctx->ddictLocal)
0219 + dctx->inBuffSize + dctx->outBuffSize;
0220 }
0221
0222 size_t ZSTD_estimateDCtxSize(void) { return sizeof(ZSTD_DCtx); }
0223
0224
0225 static size_t ZSTD_startingInputLength(ZSTD_format_e format)
0226 {
0227 size_t const startingInputLength = ZSTD_FRAMEHEADERSIZE_PREFIX(format);
0228
0229 assert( (format == ZSTD_f_zstd1) || (format == ZSTD_f_zstd1_magicless) );
0230 return startingInputLength;
0231 }
0232
0233 static void ZSTD_DCtx_resetParameters(ZSTD_DCtx* dctx)
0234 {
0235 assert(dctx->streamStage == zdss_init);
0236 dctx->format = ZSTD_f_zstd1;
0237 dctx->maxWindowSize = ZSTD_MAXWINDOWSIZE_DEFAULT;
0238 dctx->outBufferMode = ZSTD_bm_buffered;
0239 dctx->forceIgnoreChecksum = ZSTD_d_validateChecksum;
0240 dctx->refMultipleDDicts = ZSTD_rmd_refSingleDDict;
0241 }
0242
0243 static void ZSTD_initDCtx_internal(ZSTD_DCtx* dctx)
0244 {
0245 dctx->staticSize = 0;
0246 dctx->ddict = NULL;
0247 dctx->ddictLocal = NULL;
0248 dctx->dictEnd = NULL;
0249 dctx->ddictIsCold = 0;
0250 dctx->dictUses = ZSTD_dont_use;
0251 dctx->inBuff = NULL;
0252 dctx->inBuffSize = 0;
0253 dctx->outBuffSize = 0;
0254 dctx->streamStage = zdss_init;
0255 dctx->legacyContext = NULL;
0256 dctx->previousLegacyVersion = 0;
0257 dctx->noForwardProgress = 0;
0258 dctx->oversizedDuration = 0;
0259 dctx->bmi2 = ZSTD_cpuid_bmi2(ZSTD_cpuid());
0260 dctx->ddictSet = NULL;
0261 ZSTD_DCtx_resetParameters(dctx);
0262 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
0263 dctx->dictContentEndForFuzzing = NULL;
0264 #endif
0265 }
0266
0267 ZSTD_DCtx* ZSTD_initStaticDCtx(void *workspace, size_t workspaceSize)
0268 {
0269 ZSTD_DCtx* const dctx = (ZSTD_DCtx*) workspace;
0270
0271 if ((size_t)workspace & 7) return NULL;
0272 if (workspaceSize < sizeof(ZSTD_DCtx)) return NULL;
0273
0274 ZSTD_initDCtx_internal(dctx);
0275 dctx->staticSize = workspaceSize;
0276 dctx->inBuff = (char*)(dctx+1);
0277 return dctx;
0278 }
0279
0280 ZSTD_DCtx* ZSTD_createDCtx_advanced(ZSTD_customMem customMem)
0281 {
0282 if ((!customMem.customAlloc) ^ (!customMem.customFree)) return NULL;
0283
0284 { ZSTD_DCtx* const dctx = (ZSTD_DCtx*)ZSTD_customMalloc(sizeof(*dctx), customMem);
0285 if (!dctx) return NULL;
0286 dctx->customMem = customMem;
0287 ZSTD_initDCtx_internal(dctx);
0288 return dctx;
0289 }
0290 }
0291
0292 ZSTD_DCtx* ZSTD_createDCtx(void)
0293 {
0294 DEBUGLOG(3, "ZSTD_createDCtx");
0295 return ZSTD_createDCtx_advanced(ZSTD_defaultCMem);
0296 }
0297
0298 static void ZSTD_clearDict(ZSTD_DCtx* dctx)
0299 {
0300 ZSTD_freeDDict(dctx->ddictLocal);
0301 dctx->ddictLocal = NULL;
0302 dctx->ddict = NULL;
0303 dctx->dictUses = ZSTD_dont_use;
0304 }
0305
0306 size_t ZSTD_freeDCtx(ZSTD_DCtx* dctx)
0307 {
0308 if (dctx==NULL) return 0;
0309 RETURN_ERROR_IF(dctx->staticSize, memory_allocation, "not compatible with static DCtx");
0310 { ZSTD_customMem const cMem = dctx->customMem;
0311 ZSTD_clearDict(dctx);
0312 ZSTD_customFree(dctx->inBuff, cMem);
0313 dctx->inBuff = NULL;
0314 if (dctx->ddictSet) {
0315 ZSTD_freeDDictHashSet(dctx->ddictSet, cMem);
0316 dctx->ddictSet = NULL;
0317 }
0318 ZSTD_customFree(dctx, cMem);
0319 return 0;
0320 }
0321 }
0322
0323
0324 void ZSTD_copyDCtx(ZSTD_DCtx* dstDCtx, const ZSTD_DCtx* srcDCtx)
0325 {
0326 size_t const toCopy = (size_t)((char*)(&dstDCtx->inBuff) - (char*)dstDCtx);
0327 ZSTD_memcpy(dstDCtx, srcDCtx, toCopy);
0328 }
0329
0330
0331
0332
0333
0334
0335
0336
0337
0338 static void ZSTD_DCtx_selectFrameDDict(ZSTD_DCtx* dctx) {
0339 assert(dctx->refMultipleDDicts && dctx->ddictSet);
0340 DEBUGLOG(4, "Adjusting DDict based on requested dict ID from frame");
0341 if (dctx->ddict) {
0342 const ZSTD_DDict* frameDDict = ZSTD_DDictHashSet_getDDict(dctx->ddictSet, dctx->fParams.dictID);
0343 if (frameDDict) {
0344 DEBUGLOG(4, "DDict found!");
0345 ZSTD_clearDict(dctx);
0346 dctx->dictID = dctx->fParams.dictID;
0347 dctx->ddict = frameDDict;
0348 dctx->dictUses = ZSTD_use_indefinitely;
0349 }
0350 }
0351 }
0352
0353
0354
0355
0356
0357
0358
0359
0360
0361
0362
0363 unsigned ZSTD_isFrame(const void* buffer, size_t size)
0364 {
0365 if (size < ZSTD_FRAMEIDSIZE) return 0;
0366 { U32 const magic = MEM_readLE32(buffer);
0367 if (magic == ZSTD_MAGICNUMBER) return 1;
0368 if ((magic & ZSTD_MAGIC_SKIPPABLE_MASK) == ZSTD_MAGIC_SKIPPABLE_START) return 1;
0369 }
0370 return 0;
0371 }
0372
0373
0374
0375
0376
0377
0378 static size_t ZSTD_frameHeaderSize_internal(const void* src, size_t srcSize, ZSTD_format_e format)
0379 {
0380 size_t const minInputSize = ZSTD_startingInputLength(format);
0381 RETURN_ERROR_IF(srcSize < minInputSize, srcSize_wrong, "");
0382
0383 { BYTE const fhd = ((const BYTE*)src)[minInputSize-1];
0384 U32 const dictID= fhd & 3;
0385 U32 const singleSegment = (fhd >> 5) & 1;
0386 U32 const fcsId = fhd >> 6;
0387 return minInputSize + !singleSegment
0388 + ZSTD_did_fieldSize[dictID] + ZSTD_fcs_fieldSize[fcsId]
0389 + (singleSegment && !fcsId);
0390 }
0391 }
0392
0393
0394
0395
0396
0397 size_t ZSTD_frameHeaderSize(const void* src, size_t srcSize)
0398 {
0399 return ZSTD_frameHeaderSize_internal(src, srcSize, ZSTD_f_zstd1);
0400 }
0401
0402
0403
0404
0405
0406
0407
0408
0409 size_t ZSTD_getFrameHeader_advanced(ZSTD_frameHeader* zfhPtr, const void* src, size_t srcSize, ZSTD_format_e format)
0410 {
0411 const BYTE* ip = (const BYTE*)src;
0412 size_t const minInputSize = ZSTD_startingInputLength(format);
0413
0414 ZSTD_memset(zfhPtr, 0, sizeof(*zfhPtr));
0415 if (srcSize < minInputSize) return minInputSize;
0416 RETURN_ERROR_IF(src==NULL, GENERIC, "invalid parameter");
0417
0418 if ( (format != ZSTD_f_zstd1_magicless)
0419 && (MEM_readLE32(src) != ZSTD_MAGICNUMBER) ) {
0420 if ((MEM_readLE32(src) & ZSTD_MAGIC_SKIPPABLE_MASK) == ZSTD_MAGIC_SKIPPABLE_START) {
0421
0422 if (srcSize < ZSTD_SKIPPABLEHEADERSIZE)
0423 return ZSTD_SKIPPABLEHEADERSIZE;
0424 ZSTD_memset(zfhPtr, 0, sizeof(*zfhPtr));
0425 zfhPtr->frameContentSize = MEM_readLE32((const char *)src + ZSTD_FRAMEIDSIZE);
0426 zfhPtr->frameType = ZSTD_skippableFrame;
0427 return 0;
0428 }
0429 RETURN_ERROR(prefix_unknown, "");
0430 }
0431
0432
0433 { size_t const fhsize = ZSTD_frameHeaderSize_internal(src, srcSize, format);
0434 if (srcSize < fhsize) return fhsize;
0435 zfhPtr->headerSize = (U32)fhsize;
0436 }
0437
0438 { BYTE const fhdByte = ip[minInputSize-1];
0439 size_t pos = minInputSize;
0440 U32 const dictIDSizeCode = fhdByte&3;
0441 U32 const checksumFlag = (fhdByte>>2)&1;
0442 U32 const singleSegment = (fhdByte>>5)&1;
0443 U32 const fcsID = fhdByte>>6;
0444 U64 windowSize = 0;
0445 U32 dictID = 0;
0446 U64 frameContentSize = ZSTD_CONTENTSIZE_UNKNOWN;
0447 RETURN_ERROR_IF((fhdByte & 0x08) != 0, frameParameter_unsupported,
0448 "reserved bits, must be zero");
0449
0450 if (!singleSegment) {
0451 BYTE const wlByte = ip[pos++];
0452 U32 const windowLog = (wlByte >> 3) + ZSTD_WINDOWLOG_ABSOLUTEMIN;
0453 RETURN_ERROR_IF(windowLog > ZSTD_WINDOWLOG_MAX, frameParameter_windowTooLarge, "");
0454 windowSize = (1ULL << windowLog);
0455 windowSize += (windowSize >> 3) * (wlByte&7);
0456 }
0457 switch(dictIDSizeCode)
0458 {
0459 default:
0460 assert(0);
0461 ZSTD_FALLTHROUGH;
0462 case 0 : break;
0463 case 1 : dictID = ip[pos]; pos++; break;
0464 case 2 : dictID = MEM_readLE16(ip+pos); pos+=2; break;
0465 case 3 : dictID = MEM_readLE32(ip+pos); pos+=4; break;
0466 }
0467 switch(fcsID)
0468 {
0469 default:
0470 assert(0);
0471 ZSTD_FALLTHROUGH;
0472 case 0 : if (singleSegment) frameContentSize = ip[pos]; break;
0473 case 1 : frameContentSize = MEM_readLE16(ip+pos)+256; break;
0474 case 2 : frameContentSize = MEM_readLE32(ip+pos); break;
0475 case 3 : frameContentSize = MEM_readLE64(ip+pos); break;
0476 }
0477 if (singleSegment) windowSize = frameContentSize;
0478
0479 zfhPtr->frameType = ZSTD_frame;
0480 zfhPtr->frameContentSize = frameContentSize;
0481 zfhPtr->windowSize = windowSize;
0482 zfhPtr->blockSizeMax = (unsigned) MIN(windowSize, ZSTD_BLOCKSIZE_MAX);
0483 zfhPtr->dictID = dictID;
0484 zfhPtr->checksumFlag = checksumFlag;
0485 }
0486 return 0;
0487 }
0488
0489
0490
0491
0492
0493
0494
0495 size_t ZSTD_getFrameHeader(ZSTD_frameHeader* zfhPtr, const void* src, size_t srcSize)
0496 {
0497 return ZSTD_getFrameHeader_advanced(zfhPtr, src, srcSize, ZSTD_f_zstd1);
0498 }
0499
0500
0501
0502
0503
0504
0505
0506 unsigned long long ZSTD_getFrameContentSize(const void *src, size_t srcSize)
0507 {
0508 { ZSTD_frameHeader zfh;
0509 if (ZSTD_getFrameHeader(&zfh, src, srcSize) != 0)
0510 return ZSTD_CONTENTSIZE_ERROR;
0511 if (zfh.frameType == ZSTD_skippableFrame) {
0512 return 0;
0513 } else {
0514 return zfh.frameContentSize;
0515 } }
0516 }
0517
0518 static size_t readSkippableFrameSize(void const* src, size_t srcSize)
0519 {
0520 size_t const skippableHeaderSize = ZSTD_SKIPPABLEHEADERSIZE;
0521 U32 sizeU32;
0522
0523 RETURN_ERROR_IF(srcSize < ZSTD_SKIPPABLEHEADERSIZE, srcSize_wrong, "");
0524
0525 sizeU32 = MEM_readLE32((BYTE const*)src + ZSTD_FRAMEIDSIZE);
0526 RETURN_ERROR_IF((U32)(sizeU32 + ZSTD_SKIPPABLEHEADERSIZE) < sizeU32,
0527 frameParameter_unsupported, "");
0528 {
0529 size_t const skippableSize = skippableHeaderSize + sizeU32;
0530 RETURN_ERROR_IF(skippableSize > srcSize, srcSize_wrong, "");
0531 return skippableSize;
0532 }
0533 }
0534
0535
0536
0537
0538
0539
0540 unsigned long long ZSTD_findDecompressedSize(const void* src, size_t srcSize)
0541 {
0542 unsigned long long totalDstSize = 0;
0543
0544 while (srcSize >= ZSTD_startingInputLength(ZSTD_f_zstd1)) {
0545 U32 const magicNumber = MEM_readLE32(src);
0546
0547 if ((magicNumber & ZSTD_MAGIC_SKIPPABLE_MASK) == ZSTD_MAGIC_SKIPPABLE_START) {
0548 size_t const skippableSize = readSkippableFrameSize(src, srcSize);
0549 if (ZSTD_isError(skippableSize)) {
0550 return ZSTD_CONTENTSIZE_ERROR;
0551 }
0552 assert(skippableSize <= srcSize);
0553
0554 src = (const BYTE *)src + skippableSize;
0555 srcSize -= skippableSize;
0556 continue;
0557 }
0558
0559 { unsigned long long const ret = ZSTD_getFrameContentSize(src, srcSize);
0560 if (ret >= ZSTD_CONTENTSIZE_ERROR) return ret;
0561
0562
0563 if (totalDstSize + ret < totalDstSize) return ZSTD_CONTENTSIZE_ERROR;
0564 totalDstSize += ret;
0565 }
0566 { size_t const frameSrcSize = ZSTD_findFrameCompressedSize(src, srcSize);
0567 if (ZSTD_isError(frameSrcSize)) {
0568 return ZSTD_CONTENTSIZE_ERROR;
0569 }
0570
0571 src = (const BYTE *)src + frameSrcSize;
0572 srcSize -= frameSrcSize;
0573 }
0574 }
0575
0576 if (srcSize) return ZSTD_CONTENTSIZE_ERROR;
0577
0578 return totalDstSize;
0579 }
0580
0581
0582
0583
0584
0585
0586
0587
0588
0589 unsigned long long ZSTD_getDecompressedSize(const void* src, size_t srcSize)
0590 {
0591 unsigned long long const ret = ZSTD_getFrameContentSize(src, srcSize);
0592 ZSTD_STATIC_ASSERT(ZSTD_CONTENTSIZE_ERROR < ZSTD_CONTENTSIZE_UNKNOWN);
0593 return (ret >= ZSTD_CONTENTSIZE_ERROR) ? 0 : ret;
0594 }
0595
0596
0597
0598
0599
0600
0601 static size_t ZSTD_decodeFrameHeader(ZSTD_DCtx* dctx, const void* src, size_t headerSize)
0602 {
0603 size_t const result = ZSTD_getFrameHeader_advanced(&(dctx->fParams), src, headerSize, dctx->format);
0604 if (ZSTD_isError(result)) return result;
0605 RETURN_ERROR_IF(result>0, srcSize_wrong, "headerSize too small");
0606
0607
0608 if (dctx->refMultipleDDicts == ZSTD_rmd_refMultipleDDicts && dctx->ddictSet) {
0609 ZSTD_DCtx_selectFrameDDict(dctx);
0610 }
0611
0612 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
0613
0614
0615
0616 RETURN_ERROR_IF(dctx->fParams.dictID && (dctx->dictID != dctx->fParams.dictID),
0617 dictionary_wrong, "");
0618 #endif
0619 dctx->validateChecksum = (dctx->fParams.checksumFlag && !dctx->forceIgnoreChecksum) ? 1 : 0;
0620 if (dctx->validateChecksum) xxh64_reset(&dctx->xxhState, 0);
0621 dctx->processedCSize += headerSize;
0622 return 0;
0623 }
0624
0625 static ZSTD_frameSizeInfo ZSTD_errorFrameSizeInfo(size_t ret)
0626 {
0627 ZSTD_frameSizeInfo frameSizeInfo;
0628 frameSizeInfo.compressedSize = ret;
0629 frameSizeInfo.decompressedBound = ZSTD_CONTENTSIZE_ERROR;
0630 return frameSizeInfo;
0631 }
0632
0633 static ZSTD_frameSizeInfo ZSTD_findFrameSizeInfo(const void* src, size_t srcSize)
0634 {
0635 ZSTD_frameSizeInfo frameSizeInfo;
0636 ZSTD_memset(&frameSizeInfo, 0, sizeof(ZSTD_frameSizeInfo));
0637
0638
0639 if ((srcSize >= ZSTD_SKIPPABLEHEADERSIZE)
0640 && (MEM_readLE32(src) & ZSTD_MAGIC_SKIPPABLE_MASK) == ZSTD_MAGIC_SKIPPABLE_START) {
0641 frameSizeInfo.compressedSize = readSkippableFrameSize(src, srcSize);
0642 assert(ZSTD_isError(frameSizeInfo.compressedSize) ||
0643 frameSizeInfo.compressedSize <= srcSize);
0644 return frameSizeInfo;
0645 } else {
0646 const BYTE* ip = (const BYTE*)src;
0647 const BYTE* const ipstart = ip;
0648 size_t remainingSize = srcSize;
0649 size_t nbBlocks = 0;
0650 ZSTD_frameHeader zfh;
0651
0652
0653 { size_t const ret = ZSTD_getFrameHeader(&zfh, src, srcSize);
0654 if (ZSTD_isError(ret))
0655 return ZSTD_errorFrameSizeInfo(ret);
0656 if (ret > 0)
0657 return ZSTD_errorFrameSizeInfo(ERROR(srcSize_wrong));
0658 }
0659
0660 ip += zfh.headerSize;
0661 remainingSize -= zfh.headerSize;
0662
0663
0664 while (1) {
0665 blockProperties_t blockProperties;
0666 size_t const cBlockSize = ZSTD_getcBlockSize(ip, remainingSize, &blockProperties);
0667 if (ZSTD_isError(cBlockSize))
0668 return ZSTD_errorFrameSizeInfo(cBlockSize);
0669
0670 if (ZSTD_blockHeaderSize + cBlockSize > remainingSize)
0671 return ZSTD_errorFrameSizeInfo(ERROR(srcSize_wrong));
0672
0673 ip += ZSTD_blockHeaderSize + cBlockSize;
0674 remainingSize -= ZSTD_blockHeaderSize + cBlockSize;
0675 nbBlocks++;
0676
0677 if (blockProperties.lastBlock) break;
0678 }
0679
0680
0681 if (zfh.checksumFlag) {
0682 if (remainingSize < 4)
0683 return ZSTD_errorFrameSizeInfo(ERROR(srcSize_wrong));
0684 ip += 4;
0685 }
0686
0687 frameSizeInfo.compressedSize = (size_t)(ip - ipstart);
0688 frameSizeInfo.decompressedBound = (zfh.frameContentSize != ZSTD_CONTENTSIZE_UNKNOWN)
0689 ? zfh.frameContentSize
0690 : nbBlocks * zfh.blockSizeMax;
0691 return frameSizeInfo;
0692 }
0693 }
0694
0695
0696
0697
0698
0699
0700 size_t ZSTD_findFrameCompressedSize(const void *src, size_t srcSize)
0701 {
0702 ZSTD_frameSizeInfo const frameSizeInfo = ZSTD_findFrameSizeInfo(src, srcSize);
0703 return frameSizeInfo.compressedSize;
0704 }
0705
0706
0707
0708
0709
0710
0711
0712 unsigned long long ZSTD_decompressBound(const void* src, size_t srcSize)
0713 {
0714 unsigned long long bound = 0;
0715
0716 while (srcSize > 0) {
0717 ZSTD_frameSizeInfo const frameSizeInfo = ZSTD_findFrameSizeInfo(src, srcSize);
0718 size_t const compressedSize = frameSizeInfo.compressedSize;
0719 unsigned long long const decompressedBound = frameSizeInfo.decompressedBound;
0720 if (ZSTD_isError(compressedSize) || decompressedBound == ZSTD_CONTENTSIZE_ERROR)
0721 return ZSTD_CONTENTSIZE_ERROR;
0722 assert(srcSize >= compressedSize);
0723 src = (const BYTE*)src + compressedSize;
0724 srcSize -= compressedSize;
0725 bound += decompressedBound;
0726 }
0727 return bound;
0728 }
0729
0730
0731
0732
0733
0734
0735
0736
0737 size_t ZSTD_insertBlock(ZSTD_DCtx* dctx, const void* blockStart, size_t blockSize)
0738 {
0739 DEBUGLOG(5, "ZSTD_insertBlock: %u bytes", (unsigned)blockSize);
0740 ZSTD_checkContinuity(dctx, blockStart, blockSize);
0741 dctx->previousDstEnd = (const char*)blockStart + blockSize;
0742 return blockSize;
0743 }
0744
0745
0746 static size_t ZSTD_copyRawBlock(void* dst, size_t dstCapacity,
0747 const void* src, size_t srcSize)
0748 {
0749 DEBUGLOG(5, "ZSTD_copyRawBlock");
0750 RETURN_ERROR_IF(srcSize > dstCapacity, dstSize_tooSmall, "");
0751 if (dst == NULL) {
0752 if (srcSize == 0) return 0;
0753 RETURN_ERROR(dstBuffer_null, "");
0754 }
0755 ZSTD_memcpy(dst, src, srcSize);
0756 return srcSize;
0757 }
0758
0759 static size_t ZSTD_setRleBlock(void* dst, size_t dstCapacity,
0760 BYTE b,
0761 size_t regenSize)
0762 {
0763 RETURN_ERROR_IF(regenSize > dstCapacity, dstSize_tooSmall, "");
0764 if (dst == NULL) {
0765 if (regenSize == 0) return 0;
0766 RETURN_ERROR(dstBuffer_null, "");
0767 }
0768 ZSTD_memset(dst, b, regenSize);
0769 return regenSize;
0770 }
0771
0772 static void ZSTD_DCtx_trace_end(ZSTD_DCtx const* dctx, U64 uncompressedSize, U64 compressedSize, unsigned streaming)
0773 {
0774 (void)dctx;
0775 (void)uncompressedSize;
0776 (void)compressedSize;
0777 (void)streaming;
0778 }
0779
0780
0781
0782
0783
0784
0785 static size_t ZSTD_decompressFrame(ZSTD_DCtx* dctx,
0786 void* dst, size_t dstCapacity,
0787 const void** srcPtr, size_t *srcSizePtr)
0788 {
0789 const BYTE* const istart = (const BYTE*)(*srcPtr);
0790 const BYTE* ip = istart;
0791 BYTE* const ostart = (BYTE*)dst;
0792 BYTE* const oend = dstCapacity != 0 ? ostart + dstCapacity : ostart;
0793 BYTE* op = ostart;
0794 size_t remainingSrcSize = *srcSizePtr;
0795
0796 DEBUGLOG(4, "ZSTD_decompressFrame (srcSize:%i)", (int)*srcSizePtr);
0797
0798
0799 RETURN_ERROR_IF(
0800 remainingSrcSize < ZSTD_FRAMEHEADERSIZE_MIN(dctx->format)+ZSTD_blockHeaderSize,
0801 srcSize_wrong, "");
0802
0803
0804 { size_t const frameHeaderSize = ZSTD_frameHeaderSize_internal(
0805 ip, ZSTD_FRAMEHEADERSIZE_PREFIX(dctx->format), dctx->format);
0806 if (ZSTD_isError(frameHeaderSize)) return frameHeaderSize;
0807 RETURN_ERROR_IF(remainingSrcSize < frameHeaderSize+ZSTD_blockHeaderSize,
0808 srcSize_wrong, "");
0809 FORWARD_IF_ERROR( ZSTD_decodeFrameHeader(dctx, ip, frameHeaderSize) , "");
0810 ip += frameHeaderSize; remainingSrcSize -= frameHeaderSize;
0811 }
0812
0813
0814 while (1) {
0815 size_t decodedSize;
0816 blockProperties_t blockProperties;
0817 size_t const cBlockSize = ZSTD_getcBlockSize(ip, remainingSrcSize, &blockProperties);
0818 if (ZSTD_isError(cBlockSize)) return cBlockSize;
0819
0820 ip += ZSTD_blockHeaderSize;
0821 remainingSrcSize -= ZSTD_blockHeaderSize;
0822 RETURN_ERROR_IF(cBlockSize > remainingSrcSize, srcSize_wrong, "");
0823
0824 switch(blockProperties.blockType)
0825 {
0826 case bt_compressed:
0827 decodedSize = ZSTD_decompressBlock_internal(dctx, op, (size_t)(oend-op), ip, cBlockSize, 1);
0828 break;
0829 case bt_raw :
0830 decodedSize = ZSTD_copyRawBlock(op, (size_t)(oend-op), ip, cBlockSize);
0831 break;
0832 case bt_rle :
0833 decodedSize = ZSTD_setRleBlock(op, (size_t)(oend-op), *ip, blockProperties.origSize);
0834 break;
0835 case bt_reserved :
0836 default:
0837 RETURN_ERROR(corruption_detected, "invalid block type");
0838 }
0839
0840 if (ZSTD_isError(decodedSize)) return decodedSize;
0841 if (dctx->validateChecksum)
0842 xxh64_update(&dctx->xxhState, op, decodedSize);
0843 if (decodedSize != 0)
0844 op += decodedSize;
0845 assert(ip != NULL);
0846 ip += cBlockSize;
0847 remainingSrcSize -= cBlockSize;
0848 if (blockProperties.lastBlock) break;
0849 }
0850
0851 if (dctx->fParams.frameContentSize != ZSTD_CONTENTSIZE_UNKNOWN) {
0852 RETURN_ERROR_IF((U64)(op-ostart) != dctx->fParams.frameContentSize,
0853 corruption_detected, "");
0854 }
0855 if (dctx->fParams.checksumFlag) {
0856 RETURN_ERROR_IF(remainingSrcSize<4, checksum_wrong, "");
0857 if (!dctx->forceIgnoreChecksum) {
0858 U32 const checkCalc = (U32)xxh64_digest(&dctx->xxhState);
0859 U32 checkRead;
0860 checkRead = MEM_readLE32(ip);
0861 RETURN_ERROR_IF(checkRead != checkCalc, checksum_wrong, "");
0862 }
0863 ip += 4;
0864 remainingSrcSize -= 4;
0865 }
0866 ZSTD_DCtx_trace_end(dctx, (U64)(op-ostart), (U64)(ip-istart), 0);
0867
0868 *srcPtr = ip;
0869 *srcSizePtr = remainingSrcSize;
0870 return (size_t)(op-ostart);
0871 }
0872
0873 static size_t ZSTD_decompressMultiFrame(ZSTD_DCtx* dctx,
0874 void* dst, size_t dstCapacity,
0875 const void* src, size_t srcSize,
0876 const void* dict, size_t dictSize,
0877 const ZSTD_DDict* ddict)
0878 {
0879 void* const dststart = dst;
0880 int moreThan1Frame = 0;
0881
0882 DEBUGLOG(5, "ZSTD_decompressMultiFrame");
0883 assert(dict==NULL || ddict==NULL);
0884
0885 if (ddict) {
0886 dict = ZSTD_DDict_dictContent(ddict);
0887 dictSize = ZSTD_DDict_dictSize(ddict);
0888 }
0889
0890 while (srcSize >= ZSTD_startingInputLength(dctx->format)) {
0891
0892
0893 { U32 const magicNumber = MEM_readLE32(src);
0894 DEBUGLOG(4, "reading magic number %08X (expecting %08X)",
0895 (unsigned)magicNumber, ZSTD_MAGICNUMBER);
0896 if ((magicNumber & ZSTD_MAGIC_SKIPPABLE_MASK) == ZSTD_MAGIC_SKIPPABLE_START) {
0897 size_t const skippableSize = readSkippableFrameSize(src, srcSize);
0898 FORWARD_IF_ERROR(skippableSize, "readSkippableFrameSize failed");
0899 assert(skippableSize <= srcSize);
0900
0901 src = (const BYTE *)src + skippableSize;
0902 srcSize -= skippableSize;
0903 continue;
0904 } }
0905
0906 if (ddict) {
0907
0908 FORWARD_IF_ERROR(ZSTD_decompressBegin_usingDDict(dctx, ddict), "");
0909 } else {
0910
0911
0912 FORWARD_IF_ERROR(ZSTD_decompressBegin_usingDict(dctx, dict, dictSize), "");
0913 }
0914 ZSTD_checkContinuity(dctx, dst, dstCapacity);
0915
0916 { const size_t res = ZSTD_decompressFrame(dctx, dst, dstCapacity,
0917 &src, &srcSize);
0918 RETURN_ERROR_IF(
0919 (ZSTD_getErrorCode(res) == ZSTD_error_prefix_unknown)
0920 && (moreThan1Frame==1),
0921 srcSize_wrong,
0922 "At least one frame successfully completed, "
0923 "but following bytes are garbage: "
0924 "it's more likely to be a srcSize error, "
0925 "specifying more input bytes than size of frame(s). "
0926 "Note: one could be unlucky, it might be a corruption error instead, "
0927 "happening right at the place where we expect zstd magic bytes. "
0928 "But this is _much_ less likely than a srcSize field error.");
0929 if (ZSTD_isError(res)) return res;
0930 assert(res <= dstCapacity);
0931 if (res != 0)
0932 dst = (BYTE*)dst + res;
0933 dstCapacity -= res;
0934 }
0935 moreThan1Frame = 1;
0936 }
0937
0938 RETURN_ERROR_IF(srcSize, srcSize_wrong, "input not entirely consumed");
0939
0940 return (size_t)((BYTE*)dst - (BYTE*)dststart);
0941 }
0942
0943 size_t ZSTD_decompress_usingDict(ZSTD_DCtx* dctx,
0944 void* dst, size_t dstCapacity,
0945 const void* src, size_t srcSize,
0946 const void* dict, size_t dictSize)
0947 {
0948 return ZSTD_decompressMultiFrame(dctx, dst, dstCapacity, src, srcSize, dict, dictSize, NULL);
0949 }
0950
0951
0952 static ZSTD_DDict const* ZSTD_getDDict(ZSTD_DCtx* dctx)
0953 {
0954 switch (dctx->dictUses) {
0955 default:
0956 assert(0 );
0957 ZSTD_FALLTHROUGH;
0958 case ZSTD_dont_use:
0959 ZSTD_clearDict(dctx);
0960 return NULL;
0961 case ZSTD_use_indefinitely:
0962 return dctx->ddict;
0963 case ZSTD_use_once:
0964 dctx->dictUses = ZSTD_dont_use;
0965 return dctx->ddict;
0966 }
0967 }
0968
0969 size_t ZSTD_decompressDCtx(ZSTD_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize)
0970 {
0971 return ZSTD_decompress_usingDDict(dctx, dst, dstCapacity, src, srcSize, ZSTD_getDDict(dctx));
0972 }
0973
0974
0975 size_t ZSTD_decompress(void* dst, size_t dstCapacity, const void* src, size_t srcSize)
0976 {
0977 #if defined(ZSTD_HEAPMODE) && (ZSTD_HEAPMODE>=1)
0978 size_t regenSize;
0979 ZSTD_DCtx* const dctx = ZSTD_createDCtx();
0980 RETURN_ERROR_IF(dctx==NULL, memory_allocation, "NULL pointer!");
0981 regenSize = ZSTD_decompressDCtx(dctx, dst, dstCapacity, src, srcSize);
0982 ZSTD_freeDCtx(dctx);
0983 return regenSize;
0984 #else
0985 ZSTD_DCtx dctx;
0986 ZSTD_initDCtx_internal(&dctx);
0987 return ZSTD_decompressDCtx(&dctx, dst, dstCapacity, src, srcSize);
0988 #endif
0989 }
0990
0991
0992
0993
0994
0995
0996 size_t ZSTD_nextSrcSizeToDecompress(ZSTD_DCtx* dctx) { return dctx->expected; }
0997
0998
0999
1000
1001
1002
1003
1004
1005
1006
1007
1008 static size_t ZSTD_nextSrcSizeToDecompressWithInputSize(ZSTD_DCtx* dctx, size_t inputSize) {
1009 if (!(dctx->stage == ZSTDds_decompressBlock || dctx->stage == ZSTDds_decompressLastBlock))
1010 return dctx->expected;
1011 if (dctx->bType != bt_raw)
1012 return dctx->expected;
1013 return MIN(MAX(inputSize, 1), dctx->expected);
1014 }
1015
1016 ZSTD_nextInputType_e ZSTD_nextInputType(ZSTD_DCtx* dctx) {
1017 switch(dctx->stage)
1018 {
1019 default:
1020 assert(0);
1021 ZSTD_FALLTHROUGH;
1022 case ZSTDds_getFrameHeaderSize:
1023 ZSTD_FALLTHROUGH;
1024 case ZSTDds_decodeFrameHeader:
1025 return ZSTDnit_frameHeader;
1026 case ZSTDds_decodeBlockHeader:
1027 return ZSTDnit_blockHeader;
1028 case ZSTDds_decompressBlock:
1029 return ZSTDnit_block;
1030 case ZSTDds_decompressLastBlock:
1031 return ZSTDnit_lastBlock;
1032 case ZSTDds_checkChecksum:
1033 return ZSTDnit_checksum;
1034 case ZSTDds_decodeSkippableHeader:
1035 ZSTD_FALLTHROUGH;
1036 case ZSTDds_skipFrame:
1037 return ZSTDnit_skippableFrame;
1038 }
1039 }
1040
1041 static int ZSTD_isSkipFrame(ZSTD_DCtx* dctx) { return dctx->stage == ZSTDds_skipFrame; }
1042
1043
1044
1045
1046
1047 size_t ZSTD_decompressContinue(ZSTD_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize)
1048 {
1049 DEBUGLOG(5, "ZSTD_decompressContinue (srcSize:%u)", (unsigned)srcSize);
1050
1051 RETURN_ERROR_IF(srcSize != ZSTD_nextSrcSizeToDecompressWithInputSize(dctx, srcSize), srcSize_wrong, "not allowed");
1052 ZSTD_checkContinuity(dctx, dst, dstCapacity);
1053
1054 dctx->processedCSize += srcSize;
1055
1056 switch (dctx->stage)
1057 {
1058 case ZSTDds_getFrameHeaderSize :
1059 assert(src != NULL);
1060 if (dctx->format == ZSTD_f_zstd1) {
1061 assert(srcSize >= ZSTD_FRAMEIDSIZE);
1062 if ((MEM_readLE32(src) & ZSTD_MAGIC_SKIPPABLE_MASK) == ZSTD_MAGIC_SKIPPABLE_START) {
1063 ZSTD_memcpy(dctx->headerBuffer, src, srcSize);
1064 dctx->expected = ZSTD_SKIPPABLEHEADERSIZE - srcSize;
1065 dctx->stage = ZSTDds_decodeSkippableHeader;
1066 return 0;
1067 } }
1068 dctx->headerSize = ZSTD_frameHeaderSize_internal(src, srcSize, dctx->format);
1069 if (ZSTD_isError(dctx->headerSize)) return dctx->headerSize;
1070 ZSTD_memcpy(dctx->headerBuffer, src, srcSize);
1071 dctx->expected = dctx->headerSize - srcSize;
1072 dctx->stage = ZSTDds_decodeFrameHeader;
1073 return 0;
1074
1075 case ZSTDds_decodeFrameHeader:
1076 assert(src != NULL);
1077 ZSTD_memcpy(dctx->headerBuffer + (dctx->headerSize - srcSize), src, srcSize);
1078 FORWARD_IF_ERROR(ZSTD_decodeFrameHeader(dctx, dctx->headerBuffer, dctx->headerSize), "");
1079 dctx->expected = ZSTD_blockHeaderSize;
1080 dctx->stage = ZSTDds_decodeBlockHeader;
1081 return 0;
1082
1083 case ZSTDds_decodeBlockHeader:
1084 { blockProperties_t bp;
1085 size_t const cBlockSize = ZSTD_getcBlockSize(src, ZSTD_blockHeaderSize, &bp);
1086 if (ZSTD_isError(cBlockSize)) return cBlockSize;
1087 RETURN_ERROR_IF(cBlockSize > dctx->fParams.blockSizeMax, corruption_detected, "Block Size Exceeds Maximum");
1088 dctx->expected = cBlockSize;
1089 dctx->bType = bp.blockType;
1090 dctx->rleSize = bp.origSize;
1091 if (cBlockSize) {
1092 dctx->stage = bp.lastBlock ? ZSTDds_decompressLastBlock : ZSTDds_decompressBlock;
1093 return 0;
1094 }
1095
1096 if (bp.lastBlock) {
1097 if (dctx->fParams.checksumFlag) {
1098 dctx->expected = 4;
1099 dctx->stage = ZSTDds_checkChecksum;
1100 } else {
1101 dctx->expected = 0;
1102 dctx->stage = ZSTDds_getFrameHeaderSize;
1103 }
1104 } else {
1105 dctx->expected = ZSTD_blockHeaderSize;
1106 dctx->stage = ZSTDds_decodeBlockHeader;
1107 }
1108 return 0;
1109 }
1110
1111 case ZSTDds_decompressLastBlock:
1112 case ZSTDds_decompressBlock:
1113 DEBUGLOG(5, "ZSTD_decompressContinue: case ZSTDds_decompressBlock");
1114 { size_t rSize;
1115 switch(dctx->bType)
1116 {
1117 case bt_compressed:
1118 DEBUGLOG(5, "ZSTD_decompressContinue: case bt_compressed");
1119 rSize = ZSTD_decompressBlock_internal(dctx, dst, dstCapacity, src, srcSize, 1);
1120 dctx->expected = 0;
1121 break;
1122 case bt_raw :
1123 assert(srcSize <= dctx->expected);
1124 rSize = ZSTD_copyRawBlock(dst, dstCapacity, src, srcSize);
1125 FORWARD_IF_ERROR(rSize, "ZSTD_copyRawBlock failed");
1126 assert(rSize == srcSize);
1127 dctx->expected -= rSize;
1128 break;
1129 case bt_rle :
1130 rSize = ZSTD_setRleBlock(dst, dstCapacity, *(const BYTE*)src, dctx->rleSize);
1131 dctx->expected = 0;
1132 break;
1133 case bt_reserved :
1134 default:
1135 RETURN_ERROR(corruption_detected, "invalid block type");
1136 }
1137 FORWARD_IF_ERROR(rSize, "");
1138 RETURN_ERROR_IF(rSize > dctx->fParams.blockSizeMax, corruption_detected, "Decompressed Block Size Exceeds Maximum");
1139 DEBUGLOG(5, "ZSTD_decompressContinue: decoded size from block : %u", (unsigned)rSize);
1140 dctx->decodedSize += rSize;
1141 if (dctx->validateChecksum) xxh64_update(&dctx->xxhState, dst, rSize);
1142 dctx->previousDstEnd = (char*)dst + rSize;
1143
1144
1145 if (dctx->expected > 0) {
1146 return rSize;
1147 }
1148
1149 if (dctx->stage == ZSTDds_decompressLastBlock) {
1150 DEBUGLOG(4, "ZSTD_decompressContinue: decoded size from frame : %u", (unsigned)dctx->decodedSize);
1151 RETURN_ERROR_IF(
1152 dctx->fParams.frameContentSize != ZSTD_CONTENTSIZE_UNKNOWN
1153 && dctx->decodedSize != dctx->fParams.frameContentSize,
1154 corruption_detected, "");
1155 if (dctx->fParams.checksumFlag) {
1156 dctx->expected = 4;
1157 dctx->stage = ZSTDds_checkChecksum;
1158 } else {
1159 ZSTD_DCtx_trace_end(dctx, dctx->decodedSize, dctx->processedCSize, 1);
1160 dctx->expected = 0;
1161 dctx->stage = ZSTDds_getFrameHeaderSize;
1162 }
1163 } else {
1164 dctx->stage = ZSTDds_decodeBlockHeader;
1165 dctx->expected = ZSTD_blockHeaderSize;
1166 }
1167 return rSize;
1168 }
1169
1170 case ZSTDds_checkChecksum:
1171 assert(srcSize == 4);
1172 {
1173 if (dctx->validateChecksum) {
1174 U32 const h32 = (U32)xxh64_digest(&dctx->xxhState);
1175 U32 const check32 = MEM_readLE32(src);
1176 DEBUGLOG(4, "ZSTD_decompressContinue: checksum : calculated %08X :: %08X read", (unsigned)h32, (unsigned)check32);
1177 RETURN_ERROR_IF(check32 != h32, checksum_wrong, "");
1178 }
1179 ZSTD_DCtx_trace_end(dctx, dctx->decodedSize, dctx->processedCSize, 1);
1180 dctx->expected = 0;
1181 dctx->stage = ZSTDds_getFrameHeaderSize;
1182 return 0;
1183 }
1184
1185 case ZSTDds_decodeSkippableHeader:
1186 assert(src != NULL);
1187 assert(srcSize <= ZSTD_SKIPPABLEHEADERSIZE);
1188 ZSTD_memcpy(dctx->headerBuffer + (ZSTD_SKIPPABLEHEADERSIZE - srcSize), src, srcSize);
1189 dctx->expected = MEM_readLE32(dctx->headerBuffer + ZSTD_FRAMEIDSIZE);
1190 dctx->stage = ZSTDds_skipFrame;
1191 return 0;
1192
1193 case ZSTDds_skipFrame:
1194 dctx->expected = 0;
1195 dctx->stage = ZSTDds_getFrameHeaderSize;
1196 return 0;
1197
1198 default:
1199 assert(0);
1200 RETURN_ERROR(GENERIC, "impossible to reach");
1201 }
1202 }
1203
1204
1205 static size_t ZSTD_refDictContent(ZSTD_DCtx* dctx, const void* dict, size_t dictSize)
1206 {
1207 dctx->dictEnd = dctx->previousDstEnd;
1208 dctx->virtualStart = (const char*)dict - ((const char*)(dctx->previousDstEnd) - (const char*)(dctx->prefixStart));
1209 dctx->prefixStart = dict;
1210 dctx->previousDstEnd = (const char*)dict + dictSize;
1211 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
1212 dctx->dictContentBeginForFuzzing = dctx->prefixStart;
1213 dctx->dictContentEndForFuzzing = dctx->previousDstEnd;
1214 #endif
1215 return 0;
1216 }
1217
1218
1219
1220
1221 size_t
1222 ZSTD_loadDEntropy(ZSTD_entropyDTables_t* entropy,
1223 const void* const dict, size_t const dictSize)
1224 {
1225 const BYTE* dictPtr = (const BYTE*)dict;
1226 const BYTE* const dictEnd = dictPtr + dictSize;
1227
1228 RETURN_ERROR_IF(dictSize <= 8, dictionary_corrupted, "dict is too small");
1229 assert(MEM_readLE32(dict) == ZSTD_MAGIC_DICTIONARY);
1230 dictPtr += 8;
1231
1232 ZSTD_STATIC_ASSERT(offsetof(ZSTD_entropyDTables_t, OFTable) == offsetof(ZSTD_entropyDTables_t, LLTable) + sizeof(entropy->LLTable));
1233 ZSTD_STATIC_ASSERT(offsetof(ZSTD_entropyDTables_t, MLTable) == offsetof(ZSTD_entropyDTables_t, OFTable) + sizeof(entropy->OFTable));
1234 ZSTD_STATIC_ASSERT(sizeof(entropy->LLTable) + sizeof(entropy->OFTable) + sizeof(entropy->MLTable) >= HUF_DECOMPRESS_WORKSPACE_SIZE);
1235 { void* const workspace = &entropy->LLTable;
1236 size_t const workspaceSize = sizeof(entropy->LLTable) + sizeof(entropy->OFTable) + sizeof(entropy->MLTable);
1237 #ifdef HUF_FORCE_DECOMPRESS_X1
1238
1239 size_t const hSize = HUF_readDTableX1_wksp(entropy->hufTable,
1240 dictPtr, dictEnd - dictPtr,
1241 workspace, workspaceSize);
1242 #else
1243 size_t const hSize = HUF_readDTableX2_wksp(entropy->hufTable,
1244 dictPtr, (size_t)(dictEnd - dictPtr),
1245 workspace, workspaceSize);
1246 #endif
1247 RETURN_ERROR_IF(HUF_isError(hSize), dictionary_corrupted, "");
1248 dictPtr += hSize;
1249 }
1250
1251 { short offcodeNCount[MaxOff+1];
1252 unsigned offcodeMaxValue = MaxOff, offcodeLog;
1253 size_t const offcodeHeaderSize = FSE_readNCount(offcodeNCount, &offcodeMaxValue, &offcodeLog, dictPtr, (size_t)(dictEnd-dictPtr));
1254 RETURN_ERROR_IF(FSE_isError(offcodeHeaderSize), dictionary_corrupted, "");
1255 RETURN_ERROR_IF(offcodeMaxValue > MaxOff, dictionary_corrupted, "");
1256 RETURN_ERROR_IF(offcodeLog > OffFSELog, dictionary_corrupted, "");
1257 ZSTD_buildFSETable( entropy->OFTable,
1258 offcodeNCount, offcodeMaxValue,
1259 OF_base, OF_bits,
1260 offcodeLog,
1261 entropy->workspace, sizeof(entropy->workspace),
1262 0);
1263 dictPtr += offcodeHeaderSize;
1264 }
1265
1266 { short matchlengthNCount[MaxML+1];
1267 unsigned matchlengthMaxValue = MaxML, matchlengthLog;
1268 size_t const matchlengthHeaderSize = FSE_readNCount(matchlengthNCount, &matchlengthMaxValue, &matchlengthLog, dictPtr, (size_t)(dictEnd-dictPtr));
1269 RETURN_ERROR_IF(FSE_isError(matchlengthHeaderSize), dictionary_corrupted, "");
1270 RETURN_ERROR_IF(matchlengthMaxValue > MaxML, dictionary_corrupted, "");
1271 RETURN_ERROR_IF(matchlengthLog > MLFSELog, dictionary_corrupted, "");
1272 ZSTD_buildFSETable( entropy->MLTable,
1273 matchlengthNCount, matchlengthMaxValue,
1274 ML_base, ML_bits,
1275 matchlengthLog,
1276 entropy->workspace, sizeof(entropy->workspace),
1277 0);
1278 dictPtr += matchlengthHeaderSize;
1279 }
1280
1281 { short litlengthNCount[MaxLL+1];
1282 unsigned litlengthMaxValue = MaxLL, litlengthLog;
1283 size_t const litlengthHeaderSize = FSE_readNCount(litlengthNCount, &litlengthMaxValue, &litlengthLog, dictPtr, (size_t)(dictEnd-dictPtr));
1284 RETURN_ERROR_IF(FSE_isError(litlengthHeaderSize), dictionary_corrupted, "");
1285 RETURN_ERROR_IF(litlengthMaxValue > MaxLL, dictionary_corrupted, "");
1286 RETURN_ERROR_IF(litlengthLog > LLFSELog, dictionary_corrupted, "");
1287 ZSTD_buildFSETable( entropy->LLTable,
1288 litlengthNCount, litlengthMaxValue,
1289 LL_base, LL_bits,
1290 litlengthLog,
1291 entropy->workspace, sizeof(entropy->workspace),
1292 0);
1293 dictPtr += litlengthHeaderSize;
1294 }
1295
1296 RETURN_ERROR_IF(dictPtr+12 > dictEnd, dictionary_corrupted, "");
1297 { int i;
1298 size_t const dictContentSize = (size_t)(dictEnd - (dictPtr+12));
1299 for (i=0; i<3; i++) {
1300 U32 const rep = MEM_readLE32(dictPtr); dictPtr += 4;
1301 RETURN_ERROR_IF(rep==0 || rep > dictContentSize,
1302 dictionary_corrupted, "");
1303 entropy->rep[i] = rep;
1304 } }
1305
1306 return (size_t)(dictPtr - (const BYTE*)dict);
1307 }
1308
1309 static size_t ZSTD_decompress_insertDictionary(ZSTD_DCtx* dctx, const void* dict, size_t dictSize)
1310 {
1311 if (dictSize < 8) return ZSTD_refDictContent(dctx, dict, dictSize);
1312 { U32 const magic = MEM_readLE32(dict);
1313 if (magic != ZSTD_MAGIC_DICTIONARY) {
1314 return ZSTD_refDictContent(dctx, dict, dictSize);
1315 } }
1316 dctx->dictID = MEM_readLE32((const char*)dict + ZSTD_FRAMEIDSIZE);
1317
1318
1319 { size_t const eSize = ZSTD_loadDEntropy(&dctx->entropy, dict, dictSize);
1320 RETURN_ERROR_IF(ZSTD_isError(eSize), dictionary_corrupted, "");
1321 dict = (const char*)dict + eSize;
1322 dictSize -= eSize;
1323 }
1324 dctx->litEntropy = dctx->fseEntropy = 1;
1325
1326
1327 return ZSTD_refDictContent(dctx, dict, dictSize);
1328 }
1329
1330 size_t ZSTD_decompressBegin(ZSTD_DCtx* dctx)
1331 {
1332 assert(dctx != NULL);
1333 dctx->expected = ZSTD_startingInputLength(dctx->format);
1334 dctx->stage = ZSTDds_getFrameHeaderSize;
1335 dctx->processedCSize = 0;
1336 dctx->decodedSize = 0;
1337 dctx->previousDstEnd = NULL;
1338 dctx->prefixStart = NULL;
1339 dctx->virtualStart = NULL;
1340 dctx->dictEnd = NULL;
1341 dctx->entropy.hufTable[0] = (HUF_DTable)((HufLog)*0x1000001);
1342 dctx->litEntropy = dctx->fseEntropy = 0;
1343 dctx->dictID = 0;
1344 dctx->bType = bt_reserved;
1345 ZSTD_STATIC_ASSERT(sizeof(dctx->entropy.rep) == sizeof(repStartValue));
1346 ZSTD_memcpy(dctx->entropy.rep, repStartValue, sizeof(repStartValue));
1347 dctx->LLTptr = dctx->entropy.LLTable;
1348 dctx->MLTptr = dctx->entropy.MLTable;
1349 dctx->OFTptr = dctx->entropy.OFTable;
1350 dctx->HUFptr = dctx->entropy.hufTable;
1351 return 0;
1352 }
1353
1354 size_t ZSTD_decompressBegin_usingDict(ZSTD_DCtx* dctx, const void* dict, size_t dictSize)
1355 {
1356 FORWARD_IF_ERROR( ZSTD_decompressBegin(dctx) , "");
1357 if (dict && dictSize)
1358 RETURN_ERROR_IF(
1359 ZSTD_isError(ZSTD_decompress_insertDictionary(dctx, dict, dictSize)),
1360 dictionary_corrupted, "");
1361 return 0;
1362 }
1363
1364
1365
1366
1367 size_t ZSTD_decompressBegin_usingDDict(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict)
1368 {
1369 DEBUGLOG(4, "ZSTD_decompressBegin_usingDDict");
1370 assert(dctx != NULL);
1371 if (ddict) {
1372 const char* const dictStart = (const char*)ZSTD_DDict_dictContent(ddict);
1373 size_t const dictSize = ZSTD_DDict_dictSize(ddict);
1374 const void* const dictEnd = dictStart + dictSize;
1375 dctx->ddictIsCold = (dctx->dictEnd != dictEnd);
1376 DEBUGLOG(4, "DDict is %s",
1377 dctx->ddictIsCold ? "~cold~" : "hot!");
1378 }
1379 FORWARD_IF_ERROR( ZSTD_decompressBegin(dctx) , "");
1380 if (ddict) {
1381 ZSTD_copyDDictParameters(dctx, ddict);
1382 }
1383 return 0;
1384 }
1385
1386
1387
1388
1389
1390 unsigned ZSTD_getDictID_fromDict(const void* dict, size_t dictSize)
1391 {
1392 if (dictSize < 8) return 0;
1393 if (MEM_readLE32(dict) != ZSTD_MAGIC_DICTIONARY) return 0;
1394 return MEM_readLE32((const char*)dict + ZSTD_FRAMEIDSIZE);
1395 }
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410 unsigned ZSTD_getDictID_fromFrame(const void* src, size_t srcSize)
1411 {
1412 ZSTD_frameHeader zfp = { 0, 0, 0, ZSTD_frame, 0, 0, 0 };
1413 size_t const hError = ZSTD_getFrameHeader(&zfp, src, srcSize);
1414 if (ZSTD_isError(hError)) return 0;
1415 return zfp.dictID;
1416 }
1417
1418
1419
1420
1421
1422 size_t ZSTD_decompress_usingDDict(ZSTD_DCtx* dctx,
1423 void* dst, size_t dstCapacity,
1424 const void* src, size_t srcSize,
1425 const ZSTD_DDict* ddict)
1426 {
1427
1428 return ZSTD_decompressMultiFrame(dctx, dst, dstCapacity, src, srcSize,
1429 NULL, 0,
1430 ddict);
1431 }
1432
1433
1434
1435
1436
1437
1438 ZSTD_DStream* ZSTD_createDStream(void)
1439 {
1440 DEBUGLOG(3, "ZSTD_createDStream");
1441 return ZSTD_createDStream_advanced(ZSTD_defaultCMem);
1442 }
1443
1444 ZSTD_DStream* ZSTD_initStaticDStream(void *workspace, size_t workspaceSize)
1445 {
1446 return ZSTD_initStaticDCtx(workspace, workspaceSize);
1447 }
1448
1449 ZSTD_DStream* ZSTD_createDStream_advanced(ZSTD_customMem customMem)
1450 {
1451 return ZSTD_createDCtx_advanced(customMem);
1452 }
1453
1454 size_t ZSTD_freeDStream(ZSTD_DStream* zds)
1455 {
1456 return ZSTD_freeDCtx(zds);
1457 }
1458
1459
1460
1461
1462 size_t ZSTD_DStreamInSize(void) { return ZSTD_BLOCKSIZE_MAX + ZSTD_blockHeaderSize; }
1463 size_t ZSTD_DStreamOutSize(void) { return ZSTD_BLOCKSIZE_MAX; }
1464
1465 size_t ZSTD_DCtx_loadDictionary_advanced(ZSTD_DCtx* dctx,
1466 const void* dict, size_t dictSize,
1467 ZSTD_dictLoadMethod_e dictLoadMethod,
1468 ZSTD_dictContentType_e dictContentType)
1469 {
1470 RETURN_ERROR_IF(dctx->streamStage != zdss_init, stage_wrong, "");
1471 ZSTD_clearDict(dctx);
1472 if (dict && dictSize != 0) {
1473 dctx->ddictLocal = ZSTD_createDDict_advanced(dict, dictSize, dictLoadMethod, dictContentType, dctx->customMem);
1474 RETURN_ERROR_IF(dctx->ddictLocal == NULL, memory_allocation, "NULL pointer!");
1475 dctx->ddict = dctx->ddictLocal;
1476 dctx->dictUses = ZSTD_use_indefinitely;
1477 }
1478 return 0;
1479 }
1480
1481 size_t ZSTD_DCtx_loadDictionary_byReference(ZSTD_DCtx* dctx, const void* dict, size_t dictSize)
1482 {
1483 return ZSTD_DCtx_loadDictionary_advanced(dctx, dict, dictSize, ZSTD_dlm_byRef, ZSTD_dct_auto);
1484 }
1485
1486 size_t ZSTD_DCtx_loadDictionary(ZSTD_DCtx* dctx, const void* dict, size_t dictSize)
1487 {
1488 return ZSTD_DCtx_loadDictionary_advanced(dctx, dict, dictSize, ZSTD_dlm_byCopy, ZSTD_dct_auto);
1489 }
1490
1491 size_t ZSTD_DCtx_refPrefix_advanced(ZSTD_DCtx* dctx, const void* prefix, size_t prefixSize, ZSTD_dictContentType_e dictContentType)
1492 {
1493 FORWARD_IF_ERROR(ZSTD_DCtx_loadDictionary_advanced(dctx, prefix, prefixSize, ZSTD_dlm_byRef, dictContentType), "");
1494 dctx->dictUses = ZSTD_use_once;
1495 return 0;
1496 }
1497
1498 size_t ZSTD_DCtx_refPrefix(ZSTD_DCtx* dctx, const void* prefix, size_t prefixSize)
1499 {
1500 return ZSTD_DCtx_refPrefix_advanced(dctx, prefix, prefixSize, ZSTD_dct_rawContent);
1501 }
1502
1503
1504
1505
1506
1507 size_t ZSTD_initDStream_usingDict(ZSTD_DStream* zds, const void* dict, size_t dictSize)
1508 {
1509 DEBUGLOG(4, "ZSTD_initDStream_usingDict");
1510 FORWARD_IF_ERROR( ZSTD_DCtx_reset(zds, ZSTD_reset_session_only) , "");
1511 FORWARD_IF_ERROR( ZSTD_DCtx_loadDictionary(zds, dict, dictSize) , "");
1512 return ZSTD_startingInputLength(zds->format);
1513 }
1514
1515
1516 size_t ZSTD_initDStream(ZSTD_DStream* zds)
1517 {
1518 DEBUGLOG(4, "ZSTD_initDStream");
1519 return ZSTD_initDStream_usingDDict(zds, NULL);
1520 }
1521
1522
1523
1524
1525 size_t ZSTD_initDStream_usingDDict(ZSTD_DStream* dctx, const ZSTD_DDict* ddict)
1526 {
1527 FORWARD_IF_ERROR( ZSTD_DCtx_reset(dctx, ZSTD_reset_session_only) , "");
1528 FORWARD_IF_ERROR( ZSTD_DCtx_refDDict(dctx, ddict) , "");
1529 return ZSTD_startingInputLength(dctx->format);
1530 }
1531
1532
1533
1534
1535 size_t ZSTD_resetDStream(ZSTD_DStream* dctx)
1536 {
1537 FORWARD_IF_ERROR(ZSTD_DCtx_reset(dctx, ZSTD_reset_session_only), "");
1538 return ZSTD_startingInputLength(dctx->format);
1539 }
1540
1541
1542 size_t ZSTD_DCtx_refDDict(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict)
1543 {
1544 RETURN_ERROR_IF(dctx->streamStage != zdss_init, stage_wrong, "");
1545 ZSTD_clearDict(dctx);
1546 if (ddict) {
1547 dctx->ddict = ddict;
1548 dctx->dictUses = ZSTD_use_indefinitely;
1549 if (dctx->refMultipleDDicts == ZSTD_rmd_refMultipleDDicts) {
1550 if (dctx->ddictSet == NULL) {
1551 dctx->ddictSet = ZSTD_createDDictHashSet(dctx->customMem);
1552 if (!dctx->ddictSet) {
1553 RETURN_ERROR(memory_allocation, "Failed to allocate memory for hash set!");
1554 }
1555 }
1556 assert(!dctx->staticSize);
1557 FORWARD_IF_ERROR(ZSTD_DDictHashSet_addDDict(dctx->ddictSet, ddict, dctx->customMem), "");
1558 }
1559 }
1560 return 0;
1561 }
1562
1563
1564
1565
1566 size_t ZSTD_DCtx_setMaxWindowSize(ZSTD_DCtx* dctx, size_t maxWindowSize)
1567 {
1568 ZSTD_bounds const bounds = ZSTD_dParam_getBounds(ZSTD_d_windowLogMax);
1569 size_t const min = (size_t)1 << bounds.lowerBound;
1570 size_t const max = (size_t)1 << bounds.upperBound;
1571 RETURN_ERROR_IF(dctx->streamStage != zdss_init, stage_wrong, "");
1572 RETURN_ERROR_IF(maxWindowSize < min, parameter_outOfBound, "");
1573 RETURN_ERROR_IF(maxWindowSize > max, parameter_outOfBound, "");
1574 dctx->maxWindowSize = maxWindowSize;
1575 return 0;
1576 }
1577
1578 size_t ZSTD_DCtx_setFormat(ZSTD_DCtx* dctx, ZSTD_format_e format)
1579 {
1580 return ZSTD_DCtx_setParameter(dctx, ZSTD_d_format, (int)format);
1581 }
1582
1583 ZSTD_bounds ZSTD_dParam_getBounds(ZSTD_dParameter dParam)
1584 {
1585 ZSTD_bounds bounds = { 0, 0, 0 };
1586 switch(dParam) {
1587 case ZSTD_d_windowLogMax:
1588 bounds.lowerBound = ZSTD_WINDOWLOG_ABSOLUTEMIN;
1589 bounds.upperBound = ZSTD_WINDOWLOG_MAX;
1590 return bounds;
1591 case ZSTD_d_format:
1592 bounds.lowerBound = (int)ZSTD_f_zstd1;
1593 bounds.upperBound = (int)ZSTD_f_zstd1_magicless;
1594 ZSTD_STATIC_ASSERT(ZSTD_f_zstd1 < ZSTD_f_zstd1_magicless);
1595 return bounds;
1596 case ZSTD_d_stableOutBuffer:
1597 bounds.lowerBound = (int)ZSTD_bm_buffered;
1598 bounds.upperBound = (int)ZSTD_bm_stable;
1599 return bounds;
1600 case ZSTD_d_forceIgnoreChecksum:
1601 bounds.lowerBound = (int)ZSTD_d_validateChecksum;
1602 bounds.upperBound = (int)ZSTD_d_ignoreChecksum;
1603 return bounds;
1604 case ZSTD_d_refMultipleDDicts:
1605 bounds.lowerBound = (int)ZSTD_rmd_refSingleDDict;
1606 bounds.upperBound = (int)ZSTD_rmd_refMultipleDDicts;
1607 return bounds;
1608 default:;
1609 }
1610 bounds.error = ERROR(parameter_unsupported);
1611 return bounds;
1612 }
1613
1614
1615
1616
1617 static int ZSTD_dParam_withinBounds(ZSTD_dParameter dParam, int value)
1618 {
1619 ZSTD_bounds const bounds = ZSTD_dParam_getBounds(dParam);
1620 if (ZSTD_isError(bounds.error)) return 0;
1621 if (value < bounds.lowerBound) return 0;
1622 if (value > bounds.upperBound) return 0;
1623 return 1;
1624 }
1625
1626 #define CHECK_DBOUNDS(p,v) { \
1627 RETURN_ERROR_IF(!ZSTD_dParam_withinBounds(p, v), parameter_outOfBound, ""); \
1628 }
1629
1630 size_t ZSTD_DCtx_getParameter(ZSTD_DCtx* dctx, ZSTD_dParameter param, int* value)
1631 {
1632 switch (param) {
1633 case ZSTD_d_windowLogMax:
1634 *value = (int)ZSTD_highbit32((U32)dctx->maxWindowSize);
1635 return 0;
1636 case ZSTD_d_format:
1637 *value = (int)dctx->format;
1638 return 0;
1639 case ZSTD_d_stableOutBuffer:
1640 *value = (int)dctx->outBufferMode;
1641 return 0;
1642 case ZSTD_d_forceIgnoreChecksum:
1643 *value = (int)dctx->forceIgnoreChecksum;
1644 return 0;
1645 case ZSTD_d_refMultipleDDicts:
1646 *value = (int)dctx->refMultipleDDicts;
1647 return 0;
1648 default:;
1649 }
1650 RETURN_ERROR(parameter_unsupported, "");
1651 }
1652
1653 size_t ZSTD_DCtx_setParameter(ZSTD_DCtx* dctx, ZSTD_dParameter dParam, int value)
1654 {
1655 RETURN_ERROR_IF(dctx->streamStage != zdss_init, stage_wrong, "");
1656 switch(dParam) {
1657 case ZSTD_d_windowLogMax:
1658 if (value == 0) value = ZSTD_WINDOWLOG_LIMIT_DEFAULT;
1659 CHECK_DBOUNDS(ZSTD_d_windowLogMax, value);
1660 dctx->maxWindowSize = ((size_t)1) << value;
1661 return 0;
1662 case ZSTD_d_format:
1663 CHECK_DBOUNDS(ZSTD_d_format, value);
1664 dctx->format = (ZSTD_format_e)value;
1665 return 0;
1666 case ZSTD_d_stableOutBuffer:
1667 CHECK_DBOUNDS(ZSTD_d_stableOutBuffer, value);
1668 dctx->outBufferMode = (ZSTD_bufferMode_e)value;
1669 return 0;
1670 case ZSTD_d_forceIgnoreChecksum:
1671 CHECK_DBOUNDS(ZSTD_d_forceIgnoreChecksum, value);
1672 dctx->forceIgnoreChecksum = (ZSTD_forceIgnoreChecksum_e)value;
1673 return 0;
1674 case ZSTD_d_refMultipleDDicts:
1675 CHECK_DBOUNDS(ZSTD_d_refMultipleDDicts, value);
1676 if (dctx->staticSize != 0) {
1677 RETURN_ERROR(parameter_unsupported, "Static dctx does not support multiple DDicts!");
1678 }
1679 dctx->refMultipleDDicts = (ZSTD_refMultipleDDicts_e)value;
1680 return 0;
1681 default:;
1682 }
1683 RETURN_ERROR(parameter_unsupported, "");
1684 }
1685
1686 size_t ZSTD_DCtx_reset(ZSTD_DCtx* dctx, ZSTD_ResetDirective reset)
1687 {
1688 if ( (reset == ZSTD_reset_session_only)
1689 || (reset == ZSTD_reset_session_and_parameters) ) {
1690 dctx->streamStage = zdss_init;
1691 dctx->noForwardProgress = 0;
1692 }
1693 if ( (reset == ZSTD_reset_parameters)
1694 || (reset == ZSTD_reset_session_and_parameters) ) {
1695 RETURN_ERROR_IF(dctx->streamStage != zdss_init, stage_wrong, "");
1696 ZSTD_clearDict(dctx);
1697 ZSTD_DCtx_resetParameters(dctx);
1698 }
1699 return 0;
1700 }
1701
1702
1703 size_t ZSTD_sizeof_DStream(const ZSTD_DStream* dctx)
1704 {
1705 return ZSTD_sizeof_DCtx(dctx);
1706 }
1707
1708 size_t ZSTD_decodingBufferSize_min(unsigned long long windowSize, unsigned long long frameContentSize)
1709 {
1710 size_t const blockSize = (size_t) MIN(windowSize, ZSTD_BLOCKSIZE_MAX);
1711 unsigned long long const neededRBSize = windowSize + blockSize + (WILDCOPY_OVERLENGTH * 2);
1712 unsigned long long const neededSize = MIN(frameContentSize, neededRBSize);
1713 size_t const minRBSize = (size_t) neededSize;
1714 RETURN_ERROR_IF((unsigned long long)minRBSize != neededSize,
1715 frameParameter_windowTooLarge, "");
1716 return minRBSize;
1717 }
1718
1719 size_t ZSTD_estimateDStreamSize(size_t windowSize)
1720 {
1721 size_t const blockSize = MIN(windowSize, ZSTD_BLOCKSIZE_MAX);
1722 size_t const inBuffSize = blockSize;
1723 size_t const outBuffSize = ZSTD_decodingBufferSize_min(windowSize, ZSTD_CONTENTSIZE_UNKNOWN);
1724 return ZSTD_estimateDCtxSize() + inBuffSize + outBuffSize;
1725 }
1726
1727 size_t ZSTD_estimateDStreamSize_fromFrame(const void* src, size_t srcSize)
1728 {
1729 U32 const windowSizeMax = 1U << ZSTD_WINDOWLOG_MAX;
1730 ZSTD_frameHeader zfh;
1731 size_t const err = ZSTD_getFrameHeader(&zfh, src, srcSize);
1732 if (ZSTD_isError(err)) return err;
1733 RETURN_ERROR_IF(err>0, srcSize_wrong, "");
1734 RETURN_ERROR_IF(zfh.windowSize > windowSizeMax,
1735 frameParameter_windowTooLarge, "");
1736 return ZSTD_estimateDStreamSize((size_t)zfh.windowSize);
1737 }
1738
1739
1740
1741
1742 static int ZSTD_DCtx_isOverflow(ZSTD_DStream* zds, size_t const neededInBuffSize, size_t const neededOutBuffSize)
1743 {
1744 return (zds->inBuffSize + zds->outBuffSize) >= (neededInBuffSize + neededOutBuffSize) * ZSTD_WORKSPACETOOLARGE_FACTOR;
1745 }
1746
1747 static void ZSTD_DCtx_updateOversizedDuration(ZSTD_DStream* zds, size_t const neededInBuffSize, size_t const neededOutBuffSize)
1748 {
1749 if (ZSTD_DCtx_isOverflow(zds, neededInBuffSize, neededOutBuffSize))
1750 zds->oversizedDuration++;
1751 else
1752 zds->oversizedDuration = 0;
1753 }
1754
1755 static int ZSTD_DCtx_isOversizedTooLong(ZSTD_DStream* zds)
1756 {
1757 return zds->oversizedDuration >= ZSTD_WORKSPACETOOLARGE_MAXDURATION;
1758 }
1759
1760
1761 static size_t ZSTD_checkOutBuffer(ZSTD_DStream const* zds, ZSTD_outBuffer const* output)
1762 {
1763 ZSTD_outBuffer const expect = zds->expectedOutBuffer;
1764
1765 if (zds->outBufferMode != ZSTD_bm_stable)
1766 return 0;
1767
1768
1769
1770 if (zds->streamStage == zdss_init)
1771 return 0;
1772
1773 if (expect.dst == output->dst && expect.pos == output->pos && expect.size == output->size)
1774 return 0;
1775 RETURN_ERROR(dstBuffer_wrong, "ZSTD_d_stableOutBuffer enabled but output differs!");
1776 }
1777
1778
1779
1780
1781
1782
1783 static size_t ZSTD_decompressContinueStream(
1784 ZSTD_DStream* zds, char** op, char* oend,
1785 void const* src, size_t srcSize) {
1786 int const isSkipFrame = ZSTD_isSkipFrame(zds);
1787 if (zds->outBufferMode == ZSTD_bm_buffered) {
1788 size_t const dstSize = isSkipFrame ? 0 : zds->outBuffSize - zds->outStart;
1789 size_t const decodedSize = ZSTD_decompressContinue(zds,
1790 zds->outBuff + zds->outStart, dstSize, src, srcSize);
1791 FORWARD_IF_ERROR(decodedSize, "");
1792 if (!decodedSize && !isSkipFrame) {
1793 zds->streamStage = zdss_read;
1794 } else {
1795 zds->outEnd = zds->outStart + decodedSize;
1796 zds->streamStage = zdss_flush;
1797 }
1798 } else {
1799
1800 size_t const dstSize = isSkipFrame ? 0 : (size_t)(oend - *op);
1801 size_t const decodedSize = ZSTD_decompressContinue(zds, *op, dstSize, src, srcSize);
1802 FORWARD_IF_ERROR(decodedSize, "");
1803 *op += decodedSize;
1804
1805 zds->streamStage = zdss_read;
1806 assert(*op <= oend);
1807 assert(zds->outBufferMode == ZSTD_bm_stable);
1808 }
1809 return 0;
1810 }
1811
1812 size_t ZSTD_decompressStream(ZSTD_DStream* zds, ZSTD_outBuffer* output, ZSTD_inBuffer* input)
1813 {
1814 const char* const src = (const char*)input->src;
1815 const char* const istart = input->pos != 0 ? src + input->pos : src;
1816 const char* const iend = input->size != 0 ? src + input->size : src;
1817 const char* ip = istart;
1818 char* const dst = (char*)output->dst;
1819 char* const ostart = output->pos != 0 ? dst + output->pos : dst;
1820 char* const oend = output->size != 0 ? dst + output->size : dst;
1821 char* op = ostart;
1822 U32 someMoreWork = 1;
1823
1824 DEBUGLOG(5, "ZSTD_decompressStream");
1825 RETURN_ERROR_IF(
1826 input->pos > input->size,
1827 srcSize_wrong,
1828 "forbidden. in: pos: %u vs size: %u",
1829 (U32)input->pos, (U32)input->size);
1830 RETURN_ERROR_IF(
1831 output->pos > output->size,
1832 dstSize_tooSmall,
1833 "forbidden. out: pos: %u vs size: %u",
1834 (U32)output->pos, (U32)output->size);
1835 DEBUGLOG(5, "input size : %u", (U32)(input->size - input->pos));
1836 FORWARD_IF_ERROR(ZSTD_checkOutBuffer(zds, output), "");
1837
1838 while (someMoreWork) {
1839 switch(zds->streamStage)
1840 {
1841 case zdss_init :
1842 DEBUGLOG(5, "stage zdss_init => transparent reset ");
1843 zds->streamStage = zdss_loadHeader;
1844 zds->lhSize = zds->inPos = zds->outStart = zds->outEnd = 0;
1845 zds->legacyVersion = 0;
1846 zds->hostageByte = 0;
1847 zds->expectedOutBuffer = *output;
1848 ZSTD_FALLTHROUGH;
1849
1850 case zdss_loadHeader :
1851 DEBUGLOG(5, "stage zdss_loadHeader (srcSize : %u)", (U32)(iend - ip));
1852 { size_t const hSize = ZSTD_getFrameHeader_advanced(&zds->fParams, zds->headerBuffer, zds->lhSize, zds->format);
1853 if (zds->refMultipleDDicts && zds->ddictSet) {
1854 ZSTD_DCtx_selectFrameDDict(zds);
1855 }
1856 DEBUGLOG(5, "header size : %u", (U32)hSize);
1857 if (ZSTD_isError(hSize)) {
1858 return hSize;
1859 }
1860 if (hSize != 0) {
1861 size_t const toLoad = hSize - zds->lhSize;
1862 size_t const remainingInput = (size_t)(iend-ip);
1863 assert(iend >= ip);
1864 if (toLoad > remainingInput) {
1865 if (remainingInput > 0) {
1866 ZSTD_memcpy(zds->headerBuffer + zds->lhSize, ip, remainingInput);
1867 zds->lhSize += remainingInput;
1868 }
1869 input->pos = input->size;
1870 return (MAX((size_t)ZSTD_FRAMEHEADERSIZE_MIN(zds->format), hSize) - zds->lhSize) + ZSTD_blockHeaderSize;
1871 }
1872 assert(ip != NULL);
1873 ZSTD_memcpy(zds->headerBuffer + zds->lhSize, ip, toLoad); zds->lhSize = hSize; ip += toLoad;
1874 break;
1875 } }
1876
1877
1878 if (zds->fParams.frameContentSize != ZSTD_CONTENTSIZE_UNKNOWN
1879 && zds->fParams.frameType != ZSTD_skippableFrame
1880 && (U64)(size_t)(oend-op) >= zds->fParams.frameContentSize) {
1881 size_t const cSize = ZSTD_findFrameCompressedSize(istart, (size_t)(iend-istart));
1882 if (cSize <= (size_t)(iend-istart)) {
1883
1884 size_t const decompressedSize = ZSTD_decompress_usingDDict(zds, op, (size_t)(oend-op), istart, cSize, ZSTD_getDDict(zds));
1885 if (ZSTD_isError(decompressedSize)) return decompressedSize;
1886 DEBUGLOG(4, "shortcut to single-pass ZSTD_decompress_usingDDict()")
1887 ip = istart + cSize;
1888 op += decompressedSize;
1889 zds->expected = 0;
1890 zds->streamStage = zdss_init;
1891 someMoreWork = 0;
1892 break;
1893 } }
1894
1895
1896 if (zds->outBufferMode == ZSTD_bm_stable
1897 && zds->fParams.frameType != ZSTD_skippableFrame
1898 && zds->fParams.frameContentSize != ZSTD_CONTENTSIZE_UNKNOWN
1899 && (U64)(size_t)(oend-op) < zds->fParams.frameContentSize) {
1900 RETURN_ERROR(dstSize_tooSmall, "ZSTD_obm_stable passed but ZSTD_outBuffer is too small");
1901 }
1902
1903
1904 DEBUGLOG(4, "Consume header");
1905 FORWARD_IF_ERROR(ZSTD_decompressBegin_usingDDict(zds, ZSTD_getDDict(zds)), "");
1906
1907 if ((MEM_readLE32(zds->headerBuffer) & ZSTD_MAGIC_SKIPPABLE_MASK) == ZSTD_MAGIC_SKIPPABLE_START) {
1908 zds->expected = MEM_readLE32(zds->headerBuffer + ZSTD_FRAMEIDSIZE);
1909 zds->stage = ZSTDds_skipFrame;
1910 } else {
1911 FORWARD_IF_ERROR(ZSTD_decodeFrameHeader(zds, zds->headerBuffer, zds->lhSize), "");
1912 zds->expected = ZSTD_blockHeaderSize;
1913 zds->stage = ZSTDds_decodeBlockHeader;
1914 }
1915
1916
1917 DEBUGLOG(4, "Control max memory usage (%u KB <= max %u KB)",
1918 (U32)(zds->fParams.windowSize >>10),
1919 (U32)(zds->maxWindowSize >> 10) );
1920 zds->fParams.windowSize = MAX(zds->fParams.windowSize, 1U << ZSTD_WINDOWLOG_ABSOLUTEMIN);
1921 RETURN_ERROR_IF(zds->fParams.windowSize > zds->maxWindowSize,
1922 frameParameter_windowTooLarge, "");
1923
1924
1925 { size_t const neededInBuffSize = MAX(zds->fParams.blockSizeMax, 4 );
1926 size_t const neededOutBuffSize = zds->outBufferMode == ZSTD_bm_buffered
1927 ? ZSTD_decodingBufferSize_min(zds->fParams.windowSize, zds->fParams.frameContentSize)
1928 : 0;
1929
1930 ZSTD_DCtx_updateOversizedDuration(zds, neededInBuffSize, neededOutBuffSize);
1931
1932 { int const tooSmall = (zds->inBuffSize < neededInBuffSize) || (zds->outBuffSize < neededOutBuffSize);
1933 int const tooLarge = ZSTD_DCtx_isOversizedTooLong(zds);
1934
1935 if (tooSmall || tooLarge) {
1936 size_t const bufferSize = neededInBuffSize + neededOutBuffSize;
1937 DEBUGLOG(4, "inBuff : from %u to %u",
1938 (U32)zds->inBuffSize, (U32)neededInBuffSize);
1939 DEBUGLOG(4, "outBuff : from %u to %u",
1940 (U32)zds->outBuffSize, (U32)neededOutBuffSize);
1941 if (zds->staticSize) {
1942 DEBUGLOG(4, "staticSize : %u", (U32)zds->staticSize);
1943 assert(zds->staticSize >= sizeof(ZSTD_DCtx));
1944 RETURN_ERROR_IF(
1945 bufferSize > zds->staticSize - sizeof(ZSTD_DCtx),
1946 memory_allocation, "");
1947 } else {
1948 ZSTD_customFree(zds->inBuff, zds->customMem);
1949 zds->inBuffSize = 0;
1950 zds->outBuffSize = 0;
1951 zds->inBuff = (char*)ZSTD_customMalloc(bufferSize, zds->customMem);
1952 RETURN_ERROR_IF(zds->inBuff == NULL, memory_allocation, "");
1953 }
1954 zds->inBuffSize = neededInBuffSize;
1955 zds->outBuff = zds->inBuff + zds->inBuffSize;
1956 zds->outBuffSize = neededOutBuffSize;
1957 } } }
1958 zds->streamStage = zdss_read;
1959 ZSTD_FALLTHROUGH;
1960
1961 case zdss_read:
1962 DEBUGLOG(5, "stage zdss_read");
1963 { size_t const neededInSize = ZSTD_nextSrcSizeToDecompressWithInputSize(zds, (size_t)(iend - ip));
1964 DEBUGLOG(5, "neededInSize = %u", (U32)neededInSize);
1965 if (neededInSize==0) {
1966 zds->streamStage = zdss_init;
1967 someMoreWork = 0;
1968 break;
1969 }
1970 if ((size_t)(iend-ip) >= neededInSize) {
1971 FORWARD_IF_ERROR(ZSTD_decompressContinueStream(zds, &op, oend, ip, neededInSize), "");
1972 ip += neededInSize;
1973
1974 break;
1975 } }
1976 if (ip==iend) { someMoreWork = 0; break; }
1977 zds->streamStage = zdss_load;
1978 ZSTD_FALLTHROUGH;
1979
1980 case zdss_load:
1981 { size_t const neededInSize = ZSTD_nextSrcSizeToDecompress(zds);
1982 size_t const toLoad = neededInSize - zds->inPos;
1983 int const isSkipFrame = ZSTD_isSkipFrame(zds);
1984 size_t loadedSize;
1985
1986 assert(neededInSize == ZSTD_nextSrcSizeToDecompressWithInputSize(zds, iend - ip));
1987 if (isSkipFrame) {
1988 loadedSize = MIN(toLoad, (size_t)(iend-ip));
1989 } else {
1990 RETURN_ERROR_IF(toLoad > zds->inBuffSize - zds->inPos,
1991 corruption_detected,
1992 "should never happen");
1993 loadedSize = ZSTD_limitCopy(zds->inBuff + zds->inPos, toLoad, ip, (size_t)(iend-ip));
1994 }
1995 ip += loadedSize;
1996 zds->inPos += loadedSize;
1997 if (loadedSize < toLoad) { someMoreWork = 0; break; }
1998
1999
2000 zds->inPos = 0;
2001 FORWARD_IF_ERROR(ZSTD_decompressContinueStream(zds, &op, oend, zds->inBuff, neededInSize), "");
2002
2003 break;
2004 }
2005 case zdss_flush:
2006 { size_t const toFlushSize = zds->outEnd - zds->outStart;
2007 size_t const flushedSize = ZSTD_limitCopy(op, (size_t)(oend-op), zds->outBuff + zds->outStart, toFlushSize);
2008 op += flushedSize;
2009 zds->outStart += flushedSize;
2010 if (flushedSize == toFlushSize) {
2011 zds->streamStage = zdss_read;
2012 if ( (zds->outBuffSize < zds->fParams.frameContentSize)
2013 && (zds->outStart + zds->fParams.blockSizeMax > zds->outBuffSize) ) {
2014 DEBUGLOG(5, "restart filling outBuff from beginning (left:%i, needed:%u)",
2015 (int)(zds->outBuffSize - zds->outStart),
2016 (U32)zds->fParams.blockSizeMax);
2017 zds->outStart = zds->outEnd = 0;
2018 }
2019 break;
2020 } }
2021
2022 someMoreWork = 0;
2023 break;
2024
2025 default:
2026 assert(0);
2027 RETURN_ERROR(GENERIC, "impossible to reach");
2028 } }
2029
2030
2031 input->pos = (size_t)(ip - (const char*)(input->src));
2032 output->pos = (size_t)(op - (char*)(output->dst));
2033
2034
2035 zds->expectedOutBuffer = *output;
2036
2037 if ((ip==istart) && (op==ostart)) {
2038 zds->noForwardProgress ++;
2039 if (zds->noForwardProgress >= ZSTD_NO_FORWARD_PROGRESS_MAX) {
2040 RETURN_ERROR_IF(op==oend, dstSize_tooSmall, "");
2041 RETURN_ERROR_IF(ip==iend, srcSize_wrong, "");
2042 assert(0);
2043 }
2044 } else {
2045 zds->noForwardProgress = 0;
2046 }
2047 { size_t nextSrcSizeHint = ZSTD_nextSrcSizeToDecompress(zds);
2048 if (!nextSrcSizeHint) {
2049 if (zds->outEnd == zds->outStart) {
2050 if (zds->hostageByte) {
2051 if (input->pos >= input->size) {
2052
2053 zds->streamStage = zdss_read;
2054 return 1;
2055 }
2056 input->pos++;
2057 }
2058 return 0;
2059 }
2060 if (!zds->hostageByte) {
2061 input->pos--;
2062 zds->hostageByte=1;
2063 }
2064 return 1;
2065 }
2066 nextSrcSizeHint += ZSTD_blockHeaderSize * (ZSTD_nextInputType(zds) == ZSTDnit_block);
2067 assert(zds->inPos <= nextSrcSizeHint);
2068 nextSrcSizeHint -= zds->inPos;
2069 return nextSrcSizeHint;
2070 }
2071 }
2072
2073 size_t ZSTD_decompressStream_simpleArgs (
2074 ZSTD_DCtx* dctx,
2075 void* dst, size_t dstCapacity, size_t* dstPos,
2076 const void* src, size_t srcSize, size_t* srcPos)
2077 {
2078 ZSTD_outBuffer output = { dst, dstCapacity, *dstPos };
2079 ZSTD_inBuffer input = { src, srcSize, *srcPos };
2080
2081 size_t const cErr = ZSTD_decompressStream(dctx, &output, &input);
2082 *dstPos = output.pos;
2083 *srcPos = input.pos;
2084 return cErr;
2085 }