zstd_decompress_internal.h File Reference

#include "../common/mem.h"
#include "../common/zstd_internal.h"

Go to the source code of this file.

Data Structures
struct	ZSTD_seqSymbol_header
struct	ZSTD_seqSymbol
struct	ZSTD_entropyDTables_t
struct	ZSTD_DDictHashSet
struct	ZSTD_DCtx_s

Macros
#define	SEQSYMBOL_TABLE_SIZE(log)
#define	ZSTD_BUILD_FSE_TABLE_WKSP_SIZE   (sizeof(S16) * (MaxSeq + 1) + (1u << MaxFSELog) + sizeof(U64))
#define	ZSTD_BUILD_FSE_TABLE_WKSP_SIZE_U32   ((ZSTD_BUILD_FSE_TABLE_WKSP_SIZE + sizeof(U32) - 1) / sizeof(U32))
#define	ZSTD_DECODER_INTERNAL_BUFFER   (1 << 16)
#define	ZSTD_LBMIN   64
#define	ZSTD_LBMAX   (128 << 10)
#define	ZSTD_LITBUFFEREXTRASIZE   BOUNDED(ZSTD_LBMIN, ZSTD_DECODER_INTERNAL_BUFFER, ZSTD_LBMAX)

Enumerations
enum	ZSTD_dStage {   ZSTDds_getFrameHeaderSize , ZSTDds_decodeFrameHeader , ZSTDds_decodeBlockHeader , ZSTDds_decompressBlock ,   ZSTDds_decompressLastBlock , ZSTDds_checkChecksum , ZSTDds_decodeSkippableHeader , ZSTDds_skipFrame }
enum	ZSTD_dStreamStage {   zdss_init =0 , zdss_loadHeader , zdss_read , zdss_load ,   zdss_flush }
enum	ZSTD_dictUses_e { ZSTD_use_indefinitely = -1 , ZSTD_dont_use = 0 , ZSTD_use_once = 1 }
enum	ZSTD_litLocation_e { ZSTD_not_in_dst = 0 , ZSTD_in_dst = 1 , ZSTD_split = 2 }

Functions
MEM_STATIC int	ZSTD_DCtx_get_bmi2 (const struct ZSTD_DCtx_s *dctx)
size_t	ZSTD_loadDEntropy (ZSTD_entropyDTables_t *entropy, const void *const dict, size_t const dictSize)
void	ZSTD_checkContinuity (ZSTD_DCtx *dctx, const void *dst, size_t dstSize)

Macro Definition Documentation

SEQSYMBOL_TABLE_SIZE

#define SEQSYMBOL_TABLE_SIZE

(

log

)

Value:

(1 + (1 << (log)))

ZSTD_BUILD_FSE_TABLE_WKSP_SIZE

#define ZSTD_BUILD_FSE_TABLE_WKSP_SIZE   (sizeof(S16) * (MaxSeq + 1) + (1u << MaxFSELog) + sizeof(U64))

ZSTD_BUILD_FSE_TABLE_WKSP_SIZE_U32

#define ZSTD_BUILD_FSE_TABLE_WKSP_SIZE_U32   ((ZSTD_BUILD_FSE_TABLE_WKSP_SIZE + sizeof(U32) - 1) / sizeof(U32))

ZSTD_DECODER_INTERNAL_BUFFER

#define ZSTD_DECODER_INTERNAL_BUFFER   (1 << 16)

ZSTD_LBMAX

#define ZSTD_LBMAX   (128 << 10)

ZSTD_LBMIN

#define ZSTD_LBMIN   64

ZSTD_LITBUFFEREXTRASIZE

#define ZSTD_LITBUFFEREXTRASIZE   BOUNDED(ZSTD_LBMIN, ZSTD_DECODER_INTERNAL_BUFFER, ZSTD_LBMAX)

Enumeration Type Documentation

ZSTD_dictUses_e

enum ZSTD_dictUses_e

Enumerator
ZSTD_use_indefinitely
ZSTD_dont_use
ZSTD_use_once

ZSTD_dStage

enum ZSTD_dStage

Enumerator
ZSTDds_getFrameHeaderSize
ZSTDds_decodeFrameHeader
ZSTDds_decodeBlockHeader
ZSTDds_decompressBlock
ZSTDds_decompressLastBlock
ZSTDds_checkChecksum
ZSTDds_decodeSkippableHeader
ZSTDds_skipFrame

ZSTD_dStreamStage

enum ZSTD_dStreamStage

Enumerator
zdss_init
zdss_loadHeader
zdss_read
zdss_load
zdss_flush

ZSTD_litLocation_e

enum ZSTD_litLocation_e

Enumerator
ZSTD_not_in_dst
ZSTD_in_dst
ZSTD_split

Function Documentation

ZSTD_checkContinuity()

void ZSTD_checkContinuity	(	ZSTD_DCtx *	dctx,
		const void *	dst,
		size_t	dstSize )

ZSTD_checkContinuity() : check if next dst follows previous position, where decompression ended. If yes, do nothing (continue on current segment). If not, classify previous segment as "external dictionary", and start a new segment. This function cannot fail.

ZSTD_DCtx_get_bmi2()

MEM_STATIC int ZSTD_DCtx_get_bmi2

(

const struct ZSTD_DCtx_s *

dctx

)

ZSTD_loadDEntropy()

size_t ZSTD_loadDEntropy	(	ZSTD_entropyDTables_t *	entropy,
		const void *const	dict,
		size_t const	dictSize )

ZSTD_loadDEntropy() : dict : must point at beginning of a valid zstd dictionary.

Returns

: size of dictionary header (size of magic number + dict ID + entropy tables)

ZSTD_loadDEntropy() : dict : must point at beginning of a valid zstd dictionary.

Returns

: size of entropy tables read