zstd_internal.h
373 lines
| 12.4 KiB
| text/x-c
|
CLexer
|
r37513 | /* | ||
|
r30434 | * Copyright (c) 2016-present, Yann Collet, Facebook, Inc. | ||
* All rights reserved. | ||||
* | ||||
|
r37513 | * This source code is licensed under both the BSD-style license (found in the | ||
* LICENSE file in the root directory of this source tree) and the GPLv2 (found | ||||
* in the COPYING file in the root directory of this source tree). | ||||
* You may select, at your option, one of the above-listed licenses. | ||||
|
r30434 | */ | ||
#ifndef ZSTD_CCOMMON_H_MODULE | ||||
#define ZSTD_CCOMMON_H_MODULE | ||||
|
r37513 | /* this module contains definitions which must be identical | ||
* across compression, decompression and dictBuilder. | ||||
* It also contains a few functions useful to at least 2 of them | ||||
* and which benefit from being inlined */ | ||||
/*-************************************* | ||||
* Dependencies | ||||
***************************************/ | ||||
#include "compiler.h" | ||||
#include "mem.h" | ||||
|
r40157 | #include "debug.h" /* assert, DEBUGLOG, RAWLOG, g_debuglevel */ | ||
|
r37513 | #include "error_private.h" | ||
#define ZSTD_STATIC_LINKING_ONLY | ||||
#include "zstd.h" | ||||
#define FSE_STATIC_LINKING_ONLY | ||||
#include "fse.h" | ||||
#define HUF_STATIC_LINKING_ONLY | ||||
#include "huf.h" | ||||
#ifndef XXH_STATIC_LINKING_ONLY | ||||
# define XXH_STATIC_LINKING_ONLY /* XXH64_state_t */ | ||||
|
r30434 | #endif | ||
|
r37513 | #include "xxhash.h" /* XXH_reset, update, digest */ | ||
|
r30434 | |||
|
r37513 | #if defined (__cplusplus) | ||
extern "C" { | ||||
|
r30434 | #endif | ||
|
r40157 | /* ---- static assert (debug) --- */ | ||
#define ZSTD_STATIC_ASSERT(c) DEBUG_STATIC_ASSERT(c) | ||||
|
r42237 | #define ZSTD_isError ERR_isError /* for inlining */ | ||
#define FSE_isError ERR_isError | ||||
#define HUF_isError ERR_isError | ||||
|
r30434 | |||
/*-************************************* | ||||
* shared macros | ||||
***************************************/ | ||||
|
r37513 | #undef MIN | ||
#undef MAX | ||||
|
r30434 | #define MIN(a,b) ((a)<(b) ? (a) : (b)) | ||
#define MAX(a,b) ((a)>(b) ? (a) : (b)) | ||||
|
r43207 | |||
/** | ||||
* Return the specified error if the condition evaluates to true. | ||||
* | ||||
* In debug modes, prints additional information. | ||||
* In order to do that (particularly, printing the conditional that failed), | ||||
* this can't just wrap RETURN_ERROR(). | ||||
*/ | ||||
#define RETURN_ERROR_IF(cond, err, ...) \ | ||||
if (cond) { \ | ||||
RAWLOG(3, "%s:%d: ERROR!: check %s failed, returning %s", __FILE__, __LINE__, ZSTD_QUOTE(cond), ZSTD_QUOTE(ERROR(err))); \ | ||||
RAWLOG(3, ": " __VA_ARGS__); \ | ||||
RAWLOG(3, "\n"); \ | ||||
return ERROR(err); \ | ||||
} | ||||
/** | ||||
* Unconditionally return the specified error. | ||||
* | ||||
* In debug modes, prints additional information. | ||||
*/ | ||||
#define RETURN_ERROR(err, ...) \ | ||||
do { \ | ||||
RAWLOG(3, "%s:%d: ERROR!: unconditional check failed, returning %s", __FILE__, __LINE__, ZSTD_QUOTE(ERROR(err))); \ | ||||
RAWLOG(3, ": " __VA_ARGS__); \ | ||||
RAWLOG(3, "\n"); \ | ||||
return ERROR(err); \ | ||||
} while(0); | ||||
/** | ||||
* If the provided expression evaluates to an error code, returns that error code. | ||||
* | ||||
* In debug modes, prints additional information. | ||||
*/ | ||||
#define FORWARD_IF_ERROR(err, ...) \ | ||||
do { \ | ||||
size_t const err_code = (err); \ | ||||
if (ERR_isError(err_code)) { \ | ||||
RAWLOG(3, "%s:%d: ERROR!: forwarding error in %s: %s", __FILE__, __LINE__, ZSTD_QUOTE(err), ERR_getErrorName(err_code)); \ | ||||
RAWLOG(3, ": " __VA_ARGS__); \ | ||||
RAWLOG(3, "\n"); \ | ||||
return err_code; \ | ||||
} \ | ||||
} while(0); | ||||
|
r30434 | |||
/*-************************************* | ||||
* Common constants | ||||
***************************************/ | ||||
#define ZSTD_OPT_NUM (1<<12) | ||||
#define ZSTD_REP_NUM 3 /* number of repcodes */ | ||||
#define ZSTD_REP_MOVE (ZSTD_REP_NUM-1) | ||||
static const U32 repStartValue[ZSTD_REP_NUM] = { 1, 4, 8 }; | ||||
#define KB *(1 <<10) | ||||
#define MB *(1 <<20) | ||||
#define GB *(1U<<30) | ||||
#define BIT7 128 | ||||
#define BIT6 64 | ||||
#define BIT5 32 | ||||
#define BIT4 16 | ||||
#define BIT1 2 | ||||
#define BIT0 1 | ||||
#define ZSTD_WINDOWLOG_ABSOLUTEMIN 10 | ||||
static const size_t ZSTD_fcs_fieldSize[4] = { 0, 2, 4, 8 }; | ||||
static const size_t ZSTD_did_fieldSize[4] = { 0, 1, 2, 4 }; | ||||
|
r40157 | #define ZSTD_FRAMEIDSIZE 4 /* magic number size */ | ||
|
r37513 | |||
|
r30434 | #define ZSTD_BLOCKHEADERSIZE 3 /* C standard doesn't allow `static const` variable to be init using another `static const` variable */ | ||
static const size_t ZSTD_blockHeaderSize = ZSTD_BLOCKHEADERSIZE; | ||||
typedef enum { bt_raw, bt_rle, bt_compressed, bt_reserved } blockType_e; | ||||
#define MIN_SEQUENCES_SIZE 1 /* nbSeq==0 */ | ||||
#define MIN_CBLOCK_SIZE (1 /*litCSize*/ + 1 /* RLE or RAW */ + MIN_SEQUENCES_SIZE /* nbSeq==0 */) /* for a non-null block */ | ||||
#define HufLog 12 | ||||
typedef enum { set_basic, set_rle, set_compressed, set_repeat } symbolEncodingType_e; | ||||
#define LONGNBSEQ 0x7F00 | ||||
#define MINMATCH 3 | ||||
#define Litbits 8 | ||||
#define MaxLit ((1<<Litbits) - 1) | ||||
|
r37513 | #define MaxML 52 | ||
#define MaxLL 35 | ||||
#define DefaultMaxOff 28 | ||||
#define MaxOff 31 | ||||
|
r30434 | #define MaxSeq MAX(MaxLL, MaxML) /* Assumption : MaxOff < MaxLL,MaxML */ | ||
#define MLFSELog 9 | ||||
#define LLFSELog 9 | ||||
#define OffFSELog 8 | ||||
|
r37513 | #define MaxFSELog MAX(MAX(MLFSELog, LLFSELog), OffFSELog) | ||
|
r30434 | |||
|
r37513 | static const U32 LL_bits[MaxLL+1] = { 0, 0, 0, 0, 0, 0, 0, 0, | ||
0, 0, 0, 0, 0, 0, 0, 0, | ||||
1, 1, 1, 1, 2, 2, 3, 3, | ||||
4, 6, 7, 8, 9,10,11,12, | ||||
|
r30434 | 13,14,15,16 }; | ||
|
r37513 | static const S16 LL_defaultNorm[MaxLL+1] = { 4, 3, 2, 2, 2, 2, 2, 2, | ||
2, 2, 2, 2, 2, 1, 1, 1, | ||||
2, 2, 2, 2, 2, 2, 2, 2, | ||||
2, 3, 2, 1, 1, 1, 1, 1, | ||||
|
r30434 | -1,-1,-1,-1 }; | ||
#define LL_DEFAULTNORMLOG 6 /* for static allocation */ | ||||
static const U32 LL_defaultNormLog = LL_DEFAULTNORMLOG; | ||||
|
r37513 | static const U32 ML_bits[MaxML+1] = { 0, 0, 0, 0, 0, 0, 0, 0, | ||
0, 0, 0, 0, 0, 0, 0, 0, | ||||
0, 0, 0, 0, 0, 0, 0, 0, | ||||
0, 0, 0, 0, 0, 0, 0, 0, | ||||
1, 1, 1, 1, 2, 2, 3, 3, | ||||
4, 4, 5, 7, 8, 9,10,11, | ||||
|
r30434 | 12,13,14,15,16 }; | ||
|
r37513 | static const S16 ML_defaultNorm[MaxML+1] = { 1, 4, 3, 2, 2, 2, 2, 2, | ||
2, 1, 1, 1, 1, 1, 1, 1, | ||||
1, 1, 1, 1, 1, 1, 1, 1, | ||||
1, 1, 1, 1, 1, 1, 1, 1, | ||||
1, 1, 1, 1, 1, 1, 1, 1, | ||||
1, 1, 1, 1, 1, 1,-1,-1, | ||||
|
r30434 | -1,-1,-1,-1,-1 }; | ||
#define ML_DEFAULTNORMLOG 6 /* for static allocation */ | ||||
static const U32 ML_defaultNormLog = ML_DEFAULTNORMLOG; | ||||
|
r37513 | static const S16 OF_defaultNorm[DefaultMaxOff+1] = { 1, 1, 1, 1, 1, 1, 2, 2, | ||
2, 1, 1, 1, 1, 1, 1, 1, | ||||
1, 1, 1, 1, 1, 1, 1, 1, | ||||
-1,-1,-1,-1,-1 }; | ||||
|
r30434 | #define OF_DEFAULTNORMLOG 5 /* for static allocation */ | ||
static const U32 OF_defaultNormLog = OF_DEFAULTNORMLOG; | ||||
/*-******************************************* | ||||
* Shared functions to include for inlining | ||||
*********************************************/ | ||||
static void ZSTD_copy8(void* dst, const void* src) { memcpy(dst, src, 8); } | ||||
|
r43207 | |||
|
r30434 | #define COPY8(d,s) { ZSTD_copy8(d,s); d+=8; s+=8; } | ||
|
r43207 | static void ZSTD_copy16(void* dst, const void* src) { memcpy(dst, src, 16); } | ||
#define COPY16(d,s) { ZSTD_copy16(d,s); d+=16; s+=16; } | ||||
#define WILDCOPY_OVERLENGTH 8 | ||||
#define VECLEN 16 | ||||
typedef enum { | ||||
ZSTD_no_overlap, | ||||
ZSTD_overlap_src_before_dst, | ||||
/* ZSTD_overlap_dst_before_src, */ | ||||
} ZSTD_overlap_e; | ||||
|
r30434 | |||
/*! ZSTD_wildcopy() : | ||||
|
r37513 | * custom version of memcpy(), can overwrite up to WILDCOPY_OVERLENGTH bytes (if length==0) */ | ||
|
r43207 | MEM_STATIC FORCE_INLINE_ATTR DONT_VECTORIZE | ||
void ZSTD_wildcopy(void* dst, const void* src, ptrdiff_t length, ZSTD_overlap_e ovtype) | ||||
|
r30434 | { | ||
|
r43207 | ptrdiff_t diff = (BYTE*)dst - (const BYTE*)src; | ||
|
r30434 | const BYTE* ip = (const BYTE*)src; | ||
BYTE* op = (BYTE*)dst; | ||||
BYTE* const oend = op + length; | ||||
|
r43207 | |||
assert(diff >= 8 || (ovtype == ZSTD_no_overlap && diff < -8)); | ||||
if (length < VECLEN || (ovtype == ZSTD_overlap_src_before_dst && diff < VECLEN)) { | ||||
do | ||||
COPY8(op, ip) | ||||
while (op < oend); | ||||
} | ||||
else { | ||||
if ((length & 8) == 0) | ||||
COPY8(op, ip); | ||||
do { | ||||
COPY16(op, ip); | ||||
} | ||||
while (op < oend); | ||||
} | ||||
} | ||||
/*! ZSTD_wildcopy_16min() : | ||||
* same semantics as ZSTD_wilcopy() except guaranteed to be able to copy 16 bytes at the start */ | ||||
MEM_STATIC FORCE_INLINE_ATTR DONT_VECTORIZE | ||||
void ZSTD_wildcopy_16min(void* dst, const void* src, ptrdiff_t length, ZSTD_overlap_e ovtype) | ||||
{ | ||||
ptrdiff_t diff = (BYTE*)dst - (const BYTE*)src; | ||||
const BYTE* ip = (const BYTE*)src; | ||||
BYTE* op = (BYTE*)dst; | ||||
BYTE* const oend = op + length; | ||||
assert(length >= 8); | ||||
assert(diff >= 8 || (ovtype == ZSTD_no_overlap && diff < -8)); | ||||
if (ovtype == ZSTD_overlap_src_before_dst && diff < VECLEN) { | ||||
do | ||||
COPY8(op, ip) | ||||
while (op < oend); | ||||
} | ||||
else { | ||||
if ((length & 8) == 0) | ||||
COPY8(op, ip); | ||||
do { | ||||
COPY16(op, ip); | ||||
} | ||||
while (op < oend); | ||||
} | ||||
|
r30434 | } | ||
MEM_STATIC void ZSTD_wildcopy_e(void* dst, const void* src, void* dstEnd) /* should be faster for decoding, but strangely, not verified on all platform */ | ||||
{ | ||||
const BYTE* ip = (const BYTE*)src; | ||||
BYTE* op = (BYTE*)dst; | ||||
BYTE* const oend = (BYTE*)dstEnd; | ||||
do | ||||
COPY8(op, ip) | ||||
while (op < oend); | ||||
} | ||||
/*-******************************************* | ||||
|
r37513 | * Private declarations | ||
|
r30434 | *********************************************/ | ||
typedef struct seqDef_s { | ||||
U32 offset; | ||||
U16 litLength; | ||||
U16 matchLength; | ||||
} seqDef; | ||||
typedef struct { | ||||
seqDef* sequencesStart; | ||||
seqDef* sequences; | ||||
BYTE* litStart; | ||||
BYTE* lit; | ||||
BYTE* llCode; | ||||
BYTE* mlCode; | ||||
BYTE* ofCode; | ||||
|
r40157 | size_t maxNbSeq; | ||
size_t maxNbLit; | ||||
|
r30434 | U32 longLengthID; /* 0 == no longLength; 1 == Lit.longLength; 2 == Match.longLength; */ | ||
U32 longLengthPos; | ||||
} seqStore_t; | ||||
|
r43207 | /** | ||
* Contains the compressed frame size and an upper-bound for the decompressed frame size. | ||||
* Note: before using `compressedSize`, check for errors using ZSTD_isError(). | ||||
* similarly, before using `decompressedBound`, check for errors using: | ||||
* `decompressedBound != ZSTD_CONTENTSIZE_ERROR` | ||||
*/ | ||||
typedef struct { | ||||
size_t compressedSize; | ||||
unsigned long long decompressedBound; | ||||
} ZSTD_frameSizeInfo; /* decompress & legacy */ | ||||
|
r37513 | const seqStore_t* ZSTD_getSeqStore(const ZSTD_CCtx* ctx); /* compress & dictBuilder */ | ||
void ZSTD_seqToCodes(const seqStore_t* seqStorePtr); /* compress, dictBuilder, decodeCorpus (shouldn't get its definition from here) */ | ||||
|
r30434 | |||
/* custom memory allocation functions */ | ||||
void* ZSTD_malloc(size_t size, ZSTD_customMem customMem); | ||||
|
r37513 | void* ZSTD_calloc(size_t size, ZSTD_customMem customMem); | ||
|
r30434 | void ZSTD_free(void* ptr, ZSTD_customMem customMem); | ||
|
r37513 | MEM_STATIC U32 ZSTD_highbit32(U32 val) /* compress, dictBuilder, decodeCorpus */ | ||
|
r30434 | { | ||
|
r37513 | assert(val != 0); | ||
{ | ||||
|
r30434 | # if defined(_MSC_VER) /* Visual */ | ||
|
r37513 | unsigned long r=0; | ||
_BitScanReverse(&r, val); | ||||
return (unsigned)r; | ||||
|
r30434 | # elif defined(__GNUC__) && (__GNUC__ >= 3) /* GCC Intrinsic */ | ||
|
r37513 | return 31 - __builtin_clz(val); | ||
|
r43207 | # elif defined(__ICCARM__) /* IAR Intrinsic */ | ||
return 31 - __CLZ(val); | ||||
|
r30434 | # else /* Software version */ | ||
|
r37513 | static const U32 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; | ||||
v |= v >> 1; | ||||
v |= v >> 2; | ||||
v |= v >> 4; | ||||
v |= v >> 8; | ||||
v |= v >> 16; | ||||
return DeBruijnClz[(v * 0x07C4ACDDU) >> 27]; | ||||
|
r30434 | # endif | ||
|
r37513 | } | ||
|
r30434 | } | ||
|
r30895 | /* ZSTD_invalidateRepCodes() : | ||
* ensures next compression will not use repcodes from previous block. | ||||
* Note : only works with regular variant; | ||||
* do not use with extDict variant ! */ | ||||
|
r37513 | void ZSTD_invalidateRepCodes(ZSTD_CCtx* cctx); /* zstdmt, adaptive_compression (shouldn't get this definition from here) */ | ||
|
r30895 | |||
|
r37513 | typedef struct { | ||
blockType_e blockType; | ||||
U32 lastBlock; | ||||
U32 origSize; | ||||
|
r42237 | } blockProperties_t; /* declared here for decompress and fullbench */ | ||
|
r37513 | |||
/*! ZSTD_getcBlockSize() : | ||||
* Provides the size of compressed block from block header `src` */ | ||||
/* Used by: decompress, fullbench (does not get its definition from here) */ | ||||
size_t ZSTD_getcBlockSize(const void* src, size_t srcSize, | ||||
blockProperties_t* bpPtr); | ||||
|
r42237 | /*! ZSTD_decodeSeqHeaders() : | ||
* decode sequence header from src */ | ||||
/* Used by: decompress, fullbench (does not get its definition from here) */ | ||||
size_t ZSTD_decodeSeqHeaders(ZSTD_DCtx* dctx, int* nbSeqPtr, | ||||
const void* src, size_t srcSize); | ||||
|
r37513 | #if defined (__cplusplus) | ||
} | ||||
#endif | ||||
|
r30434 | #endif /* ZSTD_CCOMMON_H_MODULE */ | ||