/* * Copyright (c) Yann Collet, Facebook, Inc. * All rights reserved. * * 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. */ #ifndef ZSTD_CCOMMON_H_MODULE #define ZSTD_CCOMMON_H_MODULE /* 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 "cpu.h" #include "mem.h" #include "debug.h" /* assert, DEBUGLOG, RAWLOG, g_debuglevel */ #include "error_private.h" #define ZSTD_STATIC_LINKING_ONLY #include <linux/zstd.h> #define FSE_STATIC_LINKING_ONLY #include "fse.h" #define HUF_STATIC_LINKING_ONLY #include "huf.h" #include <linux/xxhash.h> /* XXH_reset, update, digest */ #define ZSTD_TRACE … /* ---- static assert (debug) --- */ #define ZSTD_STATIC_ASSERT(c) … #define ZSTD_isError … #define FSE_isError … #define HUF_isError … /*-************************************* * shared macros ***************************************/ #undef MIN #undef MAX #define MIN(a,b) … #define MAX(a,b) … #define BOUNDED(min,val,max) … /*-************************************* * Common constants ***************************************/ #define ZSTD_OPT_NUM … #define ZSTD_REP_NUM … static UNUSED_ATTR const U32 repStartValue[ZSTD_REP_NUM] = …; #define KB … #define MB … #define GB … #define BIT7 … #define BIT6 … #define BIT5 … #define BIT4 … #define BIT1 … #define BIT0 … #define ZSTD_WINDOWLOG_ABSOLUTEMIN … static UNUSED_ATTR const size_t ZSTD_fcs_fieldSize[4] = …; static UNUSED_ATTR const size_t ZSTD_did_fieldSize[4] = …; #define ZSTD_FRAMEIDSIZE … #define ZSTD_BLOCKHEADERSIZE … static UNUSED_ATTR const size_t ZSTD_blockHeaderSize = …; blockType_e; #define ZSTD_FRAMECHECKSUMSIZE … #define MIN_SEQUENCES_SIZE … #define MIN_CBLOCK_SIZE … #define HufLog … symbolEncodingType_e; #define LONGNBSEQ … #define MINMATCH … #define Litbits … #define MaxLit … #define MaxML … #define MaxLL … #define DefaultMaxOff … #define MaxOff … #define MaxSeq … #define MLFSELog … #define LLFSELog … #define OffFSELog … #define MaxFSELog … #define ZSTD_MAX_HUF_HEADER_SIZE … /* Each table cannot take more than #symbols * FSELog bits */ #define ZSTD_MAX_FSE_HEADERS_SIZE … static UNUSED_ATTR const U8 LL_bits[MaxLL+1] = …; static UNUSED_ATTR const S16 LL_defaultNorm[MaxLL+1] = …; #define LL_DEFAULTNORMLOG … static UNUSED_ATTR const U32 LL_defaultNormLog = …; static UNUSED_ATTR const U8 ML_bits[MaxML+1] = …; static UNUSED_ATTR const S16 ML_defaultNorm[MaxML+1] = …; #define ML_DEFAULTNORMLOG … static UNUSED_ATTR const U32 ML_defaultNormLog = …; static UNUSED_ATTR const S16 OF_defaultNorm[DefaultMaxOff+1] = …; #define OF_DEFAULTNORMLOG … static UNUSED_ATTR const U32 OF_defaultNormLog = …; /*-******************************************* * Shared functions to include for inlining *********************************************/ static void ZSTD_copy8(void* dst, const void* src) { … } #define COPY8(d,s) … /* Need to use memmove here since the literal buffer can now be located within the dst buffer. In circumstances where the op "catches up" to where the literal buffer is, there can be partial overlaps in this call on the final copy if the literal is being shifted by less than 16 bytes. */ static void ZSTD_copy16(void* dst, const void* src) { … } #define COPY16(d,s) … #define WILDCOPY_OVERLENGTH … #define WILDCOPY_VECLEN … ZSTD_overlap_e; /*! ZSTD_wildcopy() : * Custom version of ZSTD_memcpy(), can over read/write up to WILDCOPY_OVERLENGTH bytes (if length==0) * @param ovtype controls the overlap detection * - ZSTD_no_overlap: The source and destination are guaranteed to be at least WILDCOPY_VECLEN bytes apart. * - ZSTD_overlap_src_before_dst: The src and dst may overlap, but they MUST be at least 8 bytes apart. * The src buffer must be before the dst buffer. */ MEM_STATIC FORCE_INLINE_ATTR void ZSTD_wildcopy(void* dst, const void* src, ptrdiff_t length, ZSTD_overlap_e const ovtype) { … } MEM_STATIC size_t ZSTD_limitCopy(void* dst, size_t dstCapacity, const void* src, size_t srcSize) { … } /* define "workspace is too large" as this number of times larger than needed */ #define ZSTD_WORKSPACETOOLARGE_FACTOR … /* when workspace is continuously too large * during at least this number of times, * context's memory usage is considered wasteful, * because it's sized to handle a worst case scenario which rarely happens. * In which case, resize it down to free some memory */ #define ZSTD_WORKSPACETOOLARGE_MAXDURATION … /* Controls whether the input/output buffer is buffered or stable. */ ZSTD_bufferMode_e; /*-******************************************* * Private declarations *********************************************/ seqDef; /* Controls whether seqStore has a single "long" litLength or matchLength. See seqStore_t. */ ZSTD_longLengthType_e; seqStore_t; ZSTD_sequenceLength; /* * Returns the ZSTD_sequenceLength for the given sequences. It handles the decoding of long sequences * indicated by longLengthPos and longLengthType, and adds MINMATCH back to matchLength. */ MEM_STATIC ZSTD_sequenceLength ZSTD_getSequenceLength(seqStore_t const* seqStore, seqDef const* seq) { … } /* * 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` */ ZSTD_frameSizeInfo; /* decompress & legacy */ 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) */ /* custom memory allocation functions */ void* ZSTD_customMalloc(size_t size, ZSTD_customMem customMem); void* ZSTD_customCalloc(size_t size, ZSTD_customMem customMem); void ZSTD_customFree(void* ptr, ZSTD_customMem customMem); MEM_STATIC U32 ZSTD_highbit32(U32 val) /* compress, dictBuilder, decodeCorpus */ { … } /* * Counts the number of trailing zeros of a `size_t`. * Most compilers should support CTZ as a builtin. A backup * implementation is provided if the builtin isn't supported, but * it may not be terribly efficient. */ MEM_STATIC unsigned ZSTD_countTrailingZeros(size_t val) { … } /* ZSTD_invalidateRepCodes() : * ensures next compression will not use repcodes from previous block. * Note : only works with regular variant; * do not use with extDict variant ! */ void ZSTD_invalidateRepCodes(ZSTD_CCtx* cctx); /* zstdmt, adaptive_compression (shouldn't get this definition from here) */ blockProperties_t; /* declared here for decompress and fullbench */ /*! 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); /*! 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); /* * @returns true iff the CPU supports dynamic BMI2 dispatch. */ MEM_STATIC int ZSTD_cpuSupportsBmi2(void) { … } #endif /* ZSTD_CCOMMON_H_MODULE */
Codebase Browser
linux