ReactOS 0.4.15-dev-7924-g5949c20
Classes | Macros | Functions
zstd_compress_superblock.c File Reference
#include "zstd_compress_superblock.h"
#include "zstd_internal.h"
#include "hist.h"
#include "zstd_compress_internal.h"
#include "zstd_compress_sequences.h"
#include "zstd_compress_literals.h"
Include dependency graph for zstd_compress_superblock.c:

Go to the source code of this file.

Classes

struct  ZSTD_hufCTablesMetadata_t
 
struct  ZSTD_fseCTablesMetadata_t
 
struct  ZSTD_entropyCTablesMetadata_t
 

Macros

#define COMPRESS_LITERALS_SIZE_MIN   63
 

Functions

static size_t ZSTD_buildSuperBlockEntropy_literal (void *const src, size_t srcSize, const ZSTD_hufCTables_t *prevHuf, ZSTD_hufCTables_t *nextHuf, ZSTD_hufCTablesMetadata_t *hufMetadata, const int disableLiteralsCompression, void *workspace, size_t wkspSize)
 
static size_t ZSTD_buildSuperBlockEntropy_sequences (seqStore_t *seqStorePtr, const ZSTD_fseCTables_t *prevEntropy, ZSTD_fseCTables_t *nextEntropy, const ZSTD_CCtx_params *cctxParams, ZSTD_fseCTablesMetadata_t *fseMetadata, void *workspace, size_t wkspSize)
 
static size_t ZSTD_buildSuperBlockEntropy (seqStore_t *seqStorePtr, const ZSTD_entropyCTables_t *prevEntropy, ZSTD_entropyCTables_t *nextEntropy, const ZSTD_CCtx_params *cctxParams, ZSTD_entropyCTablesMetadata_t *entropyMetadata, void *workspace, size_t wkspSize)
 
static size_t ZSTD_compressSubBlock_literal (const HUF_CElt *hufTable, const ZSTD_hufCTablesMetadata_t *hufMetadata, const BYTE *literals, size_t litSize, void *dst, size_t dstSize, const int bmi2, int writeEntropy, int *entropyWritten)
 
static size_t ZSTD_seqDecompressedSize (seqStore_t const *seqStore, const seqDef *sequences, size_t nbSeq, size_t litSize, int lastSequence)
 
static size_t ZSTD_compressSubBlock_sequences (const ZSTD_fseCTables_t *fseTables, const ZSTD_fseCTablesMetadata_t *fseMetadata, const seqDef *sequences, size_t nbSeq, const BYTE *llCode, const BYTE *mlCode, const BYTE *ofCode, const ZSTD_CCtx_params *cctxParams, void *dst, size_t dstCapacity, const int bmi2, int writeEntropy, int *entropyWritten)
 
static size_t ZSTD_compressSubBlock (const ZSTD_entropyCTables_t *entropy, const ZSTD_entropyCTablesMetadata_t *entropyMetadata, const seqDef *sequences, size_t nbSeq, const BYTE *literals, size_t litSize, const BYTE *llCode, const BYTE *mlCode, const BYTE *ofCode, const ZSTD_CCtx_params *cctxParams, void *dst, size_t dstCapacity, const int bmi2, int writeLitEntropy, int writeSeqEntropy, int *litEntropyWritten, int *seqEntropyWritten, U32 lastBlock)
 
static size_t ZSTD_estimateSubBlockSize_literal (const BYTE *literals, size_t litSize, const ZSTD_hufCTables_t *huf, const ZSTD_hufCTablesMetadata_t *hufMetadata, void *workspace, size_t wkspSize, int writeEntropy)
 
static size_t ZSTD_estimateSubBlockSize_symbolType (symbolEncodingType_e type, const BYTE *codeTable, unsigned maxCode, size_t nbSeq, const FSE_CTable *fseCTable, const U32 *additionalBits, short const *defaultNorm, U32 defaultNormLog, void *workspace, size_t wkspSize)
 
static size_t ZSTD_estimateSubBlockSize_sequences (const BYTE *ofCodeTable, const BYTE *llCodeTable, const BYTE *mlCodeTable, size_t nbSeq, const ZSTD_fseCTables_t *fseTables, const ZSTD_fseCTablesMetadata_t *fseMetadata, void *workspace, size_t wkspSize, int writeEntropy)
 
static size_t ZSTD_estimateSubBlockSize (const BYTE *literals, size_t litSize, const BYTE *ofCodeTable, const BYTE *llCodeTable, const BYTE *mlCodeTable, size_t nbSeq, const ZSTD_entropyCTables_t *entropy, const ZSTD_entropyCTablesMetadata_t *entropyMetadata, void *workspace, size_t wkspSize, int writeLitEntropy, int writeSeqEntropy)
 
static int ZSTD_needSequenceEntropyTables (ZSTD_fseCTablesMetadata_t const *fseMetadata)
 
static size_t ZSTD_compressSubBlock_multi (const seqStore_t *seqStorePtr, const ZSTD_compressedBlockState_t *prevCBlock, ZSTD_compressedBlockState_t *nextCBlock, const ZSTD_entropyCTablesMetadata_t *entropyMetadata, const ZSTD_CCtx_params *cctxParams, void *dst, size_t dstCapacity, const void *src, size_t srcSize, const int bmi2, U32 lastBlock, void *workspace, size_t wkspSize)
 
size_t ZSTD_compressSuperBlock (ZSTD_CCtx *zc, void *dst, size_t dstCapacity, void const *src, size_t srcSize, unsigned lastBlock)
 

Macro Definition Documentation

◆ COMPRESS_LITERALS_SIZE_MIN

#define COMPRESS_LITERALS_SIZE_MIN   63

Function Documentation

◆ ZSTD_buildSuperBlockEntropy()

static size_t ZSTD_buildSuperBlockEntropy ( seqStore_t *  seqStorePtr,
const ZSTD_entropyCTables_t *  prevEntropy,
ZSTD_entropyCTables_t *  nextEntropy,
const ZSTD_CCtx_params *  cctxParams,
ZSTD_entropyCTablesMetadata_t *  entropyMetadata,
void *  workspace,
size_t  wkspSize 
)
static

ZSTD_buildSuperBlockEntropy() : Builds entropy for the super-block.

Returns
: 0 on success or error code

Definition at line 274 of file zstd_compress_superblock.c.

280{
281 size_t const litSize = seqStorePtr->lit - seqStorePtr->litStart;
282 DEBUGLOG(5, "ZSTD_buildSuperBlockEntropy");
283 entropyMetadata->hufMetadata.hufDesSize =
284 ZSTD_buildSuperBlockEntropy_literal(seqStorePtr->litStart, litSize,
285 &prevEntropy->huf, &nextEntropy->huf,
286 &entropyMetadata->hufMetadata,
287 ZSTD_disableLiteralsCompression(cctxParams),
288 workspace, wkspSize);
289 FORWARD_IF_ERROR(entropyMetadata->hufMetadata.hufDesSize, "ZSTD_buildSuperBlockEntropy_literal failed");
290 entropyMetadata->fseMetadata.fseTablesSize =
291 ZSTD_buildSuperBlockEntropy_sequences(seqStorePtr,
292 &prevEntropy->fse, &nextEntropy->fse,
293 cctxParams,
294 &entropyMetadata->fseMetadata,
295 workspace, wkspSize);
296 FORWARD_IF_ERROR(entropyMetadata->fseMetadata.fseTablesSize, "ZSTD_buildSuperBlockEntropy_sequences failed");
297 return 0;
298}
DEBUGLOG
#define DEBUGLOG(l,...)
Definition: debug.h:106
ZSTD_entropyCTablesMetadata_t::hufMetadata
ZSTD_hufCTablesMetadata_t hufMetadata
Definition: zstd_compress_superblock.c:51
ZSTD_entropyCTablesMetadata_t::fseMetadata
ZSTD_fseCTablesMetadata_t fseMetadata
Definition: zstd_compress_superblock.c:52
ZSTD_entropyCTables_t::huf
ZSTD_hufCTables_t huf
Definition: zstd_compress_internal.h:75
ZSTD_entropyCTables_t::fse
ZSTD_fseCTables_t fse
Definition: zstd_compress_internal.h:76
ZSTD_fseCTablesMetadata_t::fseTablesSize
size_t fseTablesSize
Definition: zstd_compress_superblock.c:46
ZSTD_hufCTablesMetadata_t::hufDesSize
size_t hufDesSize
Definition: zstd_compress_superblock.c:33
seqStore_t::lit
BYTE * lit
Definition: zstd_internal.h:337
seqStore_t::litStart
BYTE * litStart
Definition: zstd_internal.h:336
ZSTD_disableLiteralsCompression
MEM_STATIC int ZSTD_disableLiteralsCompression(const ZSTD_CCtx_params *cctxParams)
Definition: zstd_compress_internal.h:396
ZSTD_buildSuperBlockEntropy_literal
static size_t ZSTD_buildSuperBlockEntropy_literal(void *const src, size_t srcSize, const ZSTD_hufCTables_t *prevHuf, ZSTD_hufCTables_t *nextHuf, ZSTD_hufCTablesMetadata_t *hufMetadata, const int disableLiteralsCompression, void *workspace, size_t wkspSize)
Definition: zstd_compress_superblock.c:61
ZSTD_buildSuperBlockEntropy_sequences
static size_t ZSTD_buildSuperBlockEntropy_sequences(seqStore_t *seqStorePtr, const ZSTD_fseCTables_t *prevEntropy, ZSTD_fseCTables_t *nextEntropy, const ZSTD_CCtx_params *cctxParams, ZSTD_fseCTablesMetadata_t *fseMetadata, void *workspace, size_t wkspSize)
Definition: zstd_compress_superblock.c:163
FORWARD_IF_ERROR
#define FORWARD_IF_ERROR(err,...)
Definition: zstd_internal.h:121

Referenced by ZSTD_compressSuperBlock().

◆ ZSTD_buildSuperBlockEntropy_literal()

static size_t ZSTD_buildSuperBlockEntropy_literal ( void *const  src,
size_t  srcSize,
const ZSTD_hufCTables_t *  prevHuf,
ZSTD_hufCTables_t *  nextHuf,
ZSTD_hufCTablesMetadata_t *  hufMetadata,
const int  disableLiteralsCompression,
void *  workspace,
size_t  wkspSize 
)
static

ZSTD_buildSuperBlockEntropy_literal() : Builds entropy for the super-block literals. Stores literals block type (raw, rle, compressed, repeat) and huffman description table to hufMetadata.

Returns
: size of huffman description table or error code

Definition at line 61 of file zstd_compress_superblock.c.

67{
68 BYTE* const wkspStart = (BYTE*)workspace;
69 BYTE* const wkspEnd = wkspStart + wkspSize;
70 BYTE* const countWkspStart = wkspStart;
71 unsigned* const countWksp = (unsigned*)workspace;
72 const size_t countWkspSize = (HUF_SYMBOLVALUE_MAX + 1) * sizeof(unsigned);
73 BYTE* const nodeWksp = countWkspStart + countWkspSize;
74 const size_t nodeWkspSize = wkspEnd-nodeWksp;
75 unsigned maxSymbolValue = 255;
76 unsigned huffLog = HUF_TABLELOG_DEFAULT;
77 HUF_repeat repeat = prevHuf->repeatMode;
78
79 DEBUGLOG(5, "ZSTD_buildSuperBlockEntropy_literal (srcSize=%zu)", srcSize);
80
81 /* Prepare nextEntropy assuming reusing the existing table */
82 memcpy(nextHuf, prevHuf, sizeof(*prevHuf));
83
84 if (disableLiteralsCompression) {
85 DEBUGLOG(5, "set_basic - disabled");
86 hufMetadata->hType = set_basic;
87 return 0;
88 }
89
90 /* small ? don't even attempt compression (speed opt) */
91# define COMPRESS_LITERALS_SIZE_MIN 63
92 { size_t const minLitSize = (prevHuf->repeatMode == HUF_repeat_valid) ? 6 : COMPRESS_LITERALS_SIZE_MIN;
93 if (srcSize <= minLitSize) {
94 DEBUGLOG(5, "set_basic - too small");
95 hufMetadata->hType = set_basic;
96 return 0;
97 }
98 }
99
100 /* Scan input and build symbol stats */
101 { size_t const largest = HIST_count_wksp (countWksp, &maxSymbolValue, (const BYTE*)src, srcSize, workspace, wkspSize);
102 FORWARD_IF_ERROR(largest, "HIST_count_wksp failed");
103 if (largest == srcSize) {
104 DEBUGLOG(5, "set_rle");
105 hufMetadata->hType = set_rle;
106 return 0;
107 }
108 if (largest <= (srcSize >> 7)+4) {
109 DEBUGLOG(5, "set_basic - no gain");
110 hufMetadata->hType = set_basic;
111 return 0;
112 }
113 }
114
115 /* Validate the previous Huffman table */
116 if (repeat == HUF_repeat_check && !HUF_validateCTable((HUF_CElt const*)prevHuf->CTable, countWksp, maxSymbolValue)) {
117 repeat = HUF_repeat_none;
118 }
119
120 /* Build Huffman Tree */
121 memset(nextHuf->CTable, 0, sizeof(nextHuf->CTable));
122 huffLog = HUF_optimalTableLog(huffLog, srcSize, maxSymbolValue);
123 { size_t const maxBits = HUF_buildCTable_wksp((HUF_CElt*)nextHuf->CTable, countWksp,
124 maxSymbolValue, huffLog,
125 nodeWksp, nodeWkspSize);
126 FORWARD_IF_ERROR(maxBits, "HUF_buildCTable_wksp");
127 huffLog = (U32)maxBits;
128 { /* Build and write the CTable */
129 size_t const newCSize = HUF_estimateCompressedSize(
130 (HUF_CElt*)nextHuf->CTable, countWksp, maxSymbolValue);
131 size_t const hSize = HUF_writeCTable(
132 hufMetadata->hufDesBuffer, sizeof(hufMetadata->hufDesBuffer),
133 (HUF_CElt*)nextHuf->CTable, maxSymbolValue, huffLog);
134 /* Check against repeating the previous CTable */
135 if (repeat != HUF_repeat_none) {
136 size_t const oldCSize = HUF_estimateCompressedSize(
137 (HUF_CElt const*)prevHuf->CTable, countWksp, maxSymbolValue);
138 if (oldCSize < srcSize && (oldCSize <= hSize + newCSize || hSize + 12 >= srcSize)) {
139 DEBUGLOG(5, "set_repeat - smaller");
140 memcpy(nextHuf, prevHuf, sizeof(*prevHuf));
141 hufMetadata->hType = set_repeat;
142 return 0;
143 }
144 }
145 if (newCSize + hSize >= srcSize) {
146 DEBUGLOG(5, "set_basic - no gains");
147 memcpy(nextHuf, prevHuf, sizeof(*prevHuf));
148 hufMetadata->hType = set_basic;
149 return 0;
150 }
151 DEBUGLOG(5, "set_compressed (hSize=%u)", (U32)hSize);
152 hufMetadata->hType = set_compressed;
153 nextHuf->repeatMode = HUF_repeat_check;
154 return hSize;
155 }
156 }
157}
src
GLenum src
Definition: glext.h:6340
HIST_count_wksp
size_t HIST_count_wksp(unsigned *count, unsigned *maxSymbolValuePtr, const void *source, size_t sourceSize, void *workSpace, size_t workSpaceSize)
Definition: hist.c:166
HUF_validateCTable
int HUF_validateCTable(const HUF_CElt *CTable, const unsigned *count, unsigned maxSymbolValue)
Definition: huf_compress.c:432
HUF_optimalTableLog
unsigned HUF_optimalTableLog(unsigned maxTableLog, size_t srcSize, unsigned maxSymbolValue)
Definition: huf_compress.c:48
HUF_writeCTable
size_t HUF_writeCTable(void *dst, size_t maxDstSize, const HUF_CElt *CTable, unsigned maxSymbolValue, unsigned huffLog)
Definition: huf_compress.c:114
HUF_estimateCompressedSize
size_t HUF_estimateCompressedSize(const HUF_CElt *CTable, const unsigned *count, unsigned maxSymbolValue)
Definition: huf_compress.c:422
HUF_buildCTable_wksp
size_t HUF_buildCTable_wksp(HUF_CElt *tree, const unsigned *count, U32 maxSymbolValue, U32 maxNbBits, void *workSpace, size_t wkspSize)
Definition: huf_compress.c:338
memcpy
#define memcpy(s1, s2, n)
Definition: mkisofs.h:878
memset
#define memset(x, y, z)
Definition: compat.h:39
ZSTD_hufCTablesMetadata_t::hufDesBuffer
BYTE hufDesBuffer[500]
Definition: zstd_compress_superblock.c:32
ZSTD_hufCTablesMetadata_t::hType
symbolEncodingType_e hType
Definition: zstd_compress_superblock.c:31
ZSTD_hufCTables_t::repeatMode
HUF_repeat repeatMode
Definition: zstd_compress_internal.h:62
ZSTD_hufCTables_t::CTable
U32 CTable[HUF_CTABLE_SIZE_U32(255)]
Definition: zstd_compress_internal.h:61
repeat
static int repeat
Definition: xmllint.c:137
BYTE
unsigned char BYTE
Definition: xxhash.c:193
U32
unsigned int U32
Definition: xxhash.c:195
COMPRESS_LITERALS_SIZE_MIN
#define COMPRESS_LITERALS_SIZE_MIN
set_repeat
@ set_repeat
Definition: zstd_internal.h:171
set_basic
@ set_basic
Definition: zstd_internal.h:171
set_compressed
@ set_compressed
Definition: zstd_internal.h:171
set_rle
@ set_rle
Definition: zstd_internal.h:171

Referenced by ZSTD_buildSuperBlockEntropy().

◆ ZSTD_buildSuperBlockEntropy_sequences()

static size_t ZSTD_buildSuperBlockEntropy_sequences ( seqStore_t *  seqStorePtr,
const ZSTD_fseCTables_t *  prevEntropy,
ZSTD_fseCTables_t *  nextEntropy,
const ZSTD_CCtx_params *  cctxParams,
ZSTD_fseCTablesMetadata_t *  fseMetadata,
void *  workspace,
size_t  wkspSize 
)
static

ZSTD_buildSuperBlockEntropy_sequences() : Builds entropy for the super-block sequences. Stores symbol compression modes and fse table to fseMetadata.

Returns
: size of fse tables or error code

Definition at line 163 of file zstd_compress_superblock.c.

169{
170 BYTE* const wkspStart = (BYTE*)workspace;
171 BYTE* const wkspEnd = wkspStart + wkspSize;
172 BYTE* const countWkspStart = wkspStart;
173 unsigned* const countWksp = (unsigned*)workspace;
174 const size_t countWkspSize = (MaxSeq + 1) * sizeof(unsigned);
175 BYTE* const cTableWksp = countWkspStart + countWkspSize;
176 const size_t cTableWkspSize = wkspEnd-cTableWksp;
177 ZSTD_strategy const strategy = cctxParams->cParams.strategy;
178 FSE_CTable* CTable_LitLength = nextEntropy->litlengthCTable;
179 FSE_CTable* CTable_OffsetBits = nextEntropy->offcodeCTable;
180 FSE_CTable* CTable_MatchLength = nextEntropy->matchlengthCTable;
181 const BYTE* const ofCodeTable = seqStorePtr->ofCode;
182 const BYTE* const llCodeTable = seqStorePtr->llCode;
183 const BYTE* const mlCodeTable = seqStorePtr->mlCode;
184 size_t const nbSeq = seqStorePtr->sequences - seqStorePtr->sequencesStart;
185 BYTE* const ostart = fseMetadata->fseTablesBuffer;
186 BYTE* const oend = ostart + sizeof(fseMetadata->fseTablesBuffer);
187 BYTE* op = ostart;
188
189 assert(cTableWkspSize >= (1 << MaxFSELog) * sizeof(FSE_FUNCTION_TYPE));
190 DEBUGLOG(5, "ZSTD_buildSuperBlockEntropy_sequences (nbSeq=%zu)", nbSeq);
191 memset(workspace, 0, wkspSize);
192
193 fseMetadata->lastCountSize = 0;
194 /* convert length/distances into codes */
195 ZSTD_seqToCodes(seqStorePtr);
196 /* build CTable for Literal Lengths */
197 { U32 LLtype;
198 unsigned max = MaxLL;
199 size_t const mostFrequent = HIST_countFast_wksp(countWksp, &max, llCodeTable, nbSeq, workspace, wkspSize); /* can't fail */
200 DEBUGLOG(5, "Building LL table");
201 nextEntropy->litlength_repeatMode = prevEntropy->litlength_repeatMode;
202 LLtype = ZSTD_selectEncodingType(&nextEntropy->litlength_repeatMode,
203 countWksp, max, mostFrequent, nbSeq,
204 LLFSELog, prevEntropy->litlengthCTable,
205 LL_defaultNorm, LL_defaultNormLog,
206 ZSTD_defaultAllowed, strategy);
207 assert(set_basic < set_compressed && set_rle < set_compressed);
208 assert(!(LLtype < set_compressed && nextEntropy->litlength_repeatMode != FSE_repeat_none)); /* We don't copy tables */
209 { size_t const countSize = ZSTD_buildCTable(op, oend - op, CTable_LitLength, LLFSELog, (symbolEncodingType_e)LLtype,
210 countWksp, max, llCodeTable, nbSeq, LL_defaultNorm, LL_defaultNormLog, MaxLL,
211 prevEntropy->litlengthCTable, sizeof(prevEntropy->litlengthCTable),
212 cTableWksp, cTableWkspSize);
213 FORWARD_IF_ERROR(countSize, "ZSTD_buildCTable for LitLens failed");
214 if (LLtype == set_compressed)
215 fseMetadata->lastCountSize = countSize;
216 op += countSize;
217 fseMetadata->llType = (symbolEncodingType_e) LLtype;
218 } }
219 /* build CTable for Offsets */
220 { U32 Offtype;
221 unsigned max = MaxOff;
222 size_t const mostFrequent = HIST_countFast_wksp(countWksp, &max, ofCodeTable, nbSeq, workspace, wkspSize); /* can't fail */
223 /* We can only use the basic table if max <= DefaultMaxOff, otherwise the offsets are too large */
224 ZSTD_defaultPolicy_e const defaultPolicy = (max <= DefaultMaxOff) ? ZSTD_defaultAllowed : ZSTD_defaultDisallowed;
225 DEBUGLOG(5, "Building OF table");
226 nextEntropy->offcode_repeatMode = prevEntropy->offcode_repeatMode;
227 Offtype = ZSTD_selectEncodingType(&nextEntropy->offcode_repeatMode,
228 countWksp, max, mostFrequent, nbSeq,
229 OffFSELog, prevEntropy->offcodeCTable,
230 OF_defaultNorm, OF_defaultNormLog,
231 defaultPolicy, strategy);
232 assert(!(Offtype < set_compressed && nextEntropy->offcode_repeatMode != FSE_repeat_none)); /* We don't copy tables */
233 { size_t const countSize = ZSTD_buildCTable(op, oend - op, CTable_OffsetBits, OffFSELog, (symbolEncodingType_e)Offtype,
234 countWksp, max, ofCodeTable, nbSeq, OF_defaultNorm, OF_defaultNormLog, DefaultMaxOff,
235 prevEntropy->offcodeCTable, sizeof(prevEntropy->offcodeCTable),
236 cTableWksp, cTableWkspSize);
237 FORWARD_IF_ERROR(countSize, "ZSTD_buildCTable for Offsets failed");
238 if (Offtype == set_compressed)
239 fseMetadata->lastCountSize = countSize;
240 op += countSize;
241 fseMetadata->ofType = (symbolEncodingType_e) Offtype;
242 } }
243 /* build CTable for MatchLengths */
244 { U32 MLtype;
245 unsigned max = MaxML;
246 size_t const mostFrequent = HIST_countFast_wksp(countWksp, &max, mlCodeTable, nbSeq, workspace, wkspSize); /* can't fail */
247 DEBUGLOG(5, "Building ML table (remaining space : %i)", (int)(oend-op));
248 nextEntropy->matchlength_repeatMode = prevEntropy->matchlength_repeatMode;
249 MLtype = ZSTD_selectEncodingType(&nextEntropy->matchlength_repeatMode,
250 countWksp, max, mostFrequent, nbSeq,
251 MLFSELog, prevEntropy->matchlengthCTable,
252 ML_defaultNorm, ML_defaultNormLog,
253 ZSTD_defaultAllowed, strategy);
254 assert(!(MLtype < set_compressed && nextEntropy->matchlength_repeatMode != FSE_repeat_none)); /* We don't copy tables */
255 { size_t const countSize = ZSTD_buildCTable(op, oend - op, CTable_MatchLength, MLFSELog, (symbolEncodingType_e)MLtype,
256 countWksp, max, mlCodeTable, nbSeq, ML_defaultNorm, ML_defaultNormLog, MaxML,
257 prevEntropy->matchlengthCTable, sizeof(prevEntropy->matchlengthCTable),
258 cTableWksp, cTableWkspSize);
259 FORWARD_IF_ERROR(countSize, "ZSTD_buildCTable for MatchLengths failed");
260 if (MLtype == set_compressed)
261 fseMetadata->lastCountSize = countSize;
262 op += countSize;
263 fseMetadata->mlType = (symbolEncodingType_e) MLtype;
264 } }
265 assert((size_t) (op-ostart) <= sizeof(fseMetadata->fseTablesBuffer));
266 return op-ostart;
267}
op
UINT op
Definition: effect.c:236
assert
#define assert(x)
Definition: debug.h:53
FSE_CTable
unsigned FSE_CTable
Definition: fse.h:160
HIST_countFast_wksp
size_t HIST_countFast_wksp(unsigned *count, unsigned *maxSymbolValuePtr, const void *source, size_t sourceSize, void *workSpace, size_t workSpaceSize)
Definition: hist.c:144
ZSTD_fseCTablesMetadata_t::llType
symbolEncodingType_e llType
Definition: zstd_compress_superblock.c:42
ZSTD_fseCTablesMetadata_t::ofType
symbolEncodingType_e ofType
Definition: zstd_compress_superblock.c:43
ZSTD_fseCTablesMetadata_t::mlType
symbolEncodingType_e mlType
Definition: zstd_compress_superblock.c:44
ZSTD_fseCTablesMetadata_t::fseTablesBuffer
BYTE fseTablesBuffer[500]
Definition: zstd_compress_superblock.c:45
ZSTD_fseCTablesMetadata_t::lastCountSize
size_t lastCountSize
Definition: zstd_compress_superblock.c:47
ZSTD_fseCTables_t::matchlength_repeatMode
FSE_repeat matchlength_repeatMode
Definition: zstd_compress_internal.h:70
ZSTD_fseCTables_t::offcodeCTable
FSE_CTable offcodeCTable[FSE_CTABLE_SIZE_U32(OffFSELog, MaxOff)]
Definition: zstd_compress_internal.h:66
ZSTD_fseCTables_t::offcode_repeatMode
FSE_repeat offcode_repeatMode
Definition: zstd_compress_internal.h:69
ZSTD_fseCTables_t::litlengthCTable
FSE_CTable litlengthCTable[FSE_CTABLE_SIZE_U32(LLFSELog, MaxLL)]
Definition: zstd_compress_internal.h:68
ZSTD_fseCTables_t::litlength_repeatMode
FSE_repeat litlength_repeatMode
Definition: zstd_compress_internal.h:71
ZSTD_fseCTables_t::matchlengthCTable
FSE_CTable matchlengthCTable[FSE_CTABLE_SIZE_U32(MLFSELog, MaxML)]
Definition: zstd_compress_internal.h:67
seqStore_t::ofCode
BYTE * ofCode
Definition: zstd_internal.h:340
seqStore_t::llCode
BYTE * llCode
Definition: zstd_internal.h:338
seqStore_t::sequencesStart
seqDef * sequencesStart
Definition: zstd_internal.h:334
seqStore_t::mlCode
BYTE * mlCode
Definition: zstd_internal.h:339
seqStore_t::sequences
seqDef * sequences
Definition: zstd_internal.h:335
max
#define max(a, b)
Definition: svc.c:63
ZSTD_strategy
ZSTD_strategy
Definition: zstd.h:251
ZSTD_seqToCodes
void ZSTD_seqToCodes(const seqStore_t *seqStorePtr)
Definition: zstd_compress.c:1929
ZSTD_buildCTable
size_t ZSTD_buildCTable(void *dst, size_t dstCapacity, FSE_CTable *nextCTable, U32 FSELog, symbolEncodingType_e type, unsigned *count, U32 max, const BYTE *codeTable, size_t nbSeq, const S16 *defaultNorm, U32 defaultNormLog, U32 defaultMax, const FSE_CTable *prevCTable, size_t prevCTableSize, void *entropyWorkspace, size_t entropyWorkspaceSize)
Definition: zstd_compress_sequences.c:223
ZSTD_selectEncodingType
symbolEncodingType_e ZSTD_selectEncodingType(FSE_repeat *repeatMode, unsigned const *count, unsigned const max, size_t const mostFrequent, size_t nbSeq, unsigned const FSELog, FSE_CTable const *prevCTable, short const *defaultNorm, U32 defaultNormLog, ZSTD_defaultPolicy_e const isDefaultAllowed, ZSTD_strategy const strategy)
Definition: zstd_compress_sequences.c:142
ZSTD_defaultPolicy_e
ZSTD_defaultPolicy_e
Definition: zstd_compress_sequences.h:17
ZSTD_defaultAllowed
@ ZSTD_defaultAllowed
Definition: zstd_compress_sequences.h:19
ZSTD_defaultDisallowed
@ ZSTD_defaultDisallowed
Definition: zstd_compress_sequences.h:18
MaxLL
#define MaxLL
Definition: zstd_internal.h:180
LL_defaultNormLog
static const U32 LL_defaultNormLog
Definition: zstd_internal.h:200
MaxML
#define MaxML
Definition: zstd_internal.h:179
OF_defaultNormLog
static const U32 OF_defaultNormLog
Definition: zstd_internal.h:224
MaxFSELog
#define MaxFSELog
Definition: zstd_internal.h:187
MLFSELog
#define MLFSELog
Definition: zstd_internal.h:184
LL_defaultNorm
static const S16 LL_defaultNorm[MaxLL+1]
Definition: zstd_internal.h:194
symbolEncodingType_e
symbolEncodingType_e
Definition: zstd_internal.h:171
MaxSeq
#define MaxSeq
Definition: zstd_internal.h:183
MaxOff
#define MaxOff
Definition: zstd_internal.h:182
LLFSELog
#define LLFSELog
Definition: zstd_internal.h:185
ML_defaultNorm
static const S16 ML_defaultNorm[MaxML+1]
Definition: zstd_internal.h:209
ML_defaultNormLog
static const U32 ML_defaultNormLog
Definition: zstd_internal.h:217
OF_defaultNorm
static const S16 OF_defaultNorm[DefaultMaxOff+1]
Definition: zstd_internal.h:219
DefaultMaxOff
#define DefaultMaxOff
Definition: zstd_internal.h:181
OffFSELog
#define OffFSELog
Definition: zstd_internal.h:186

Referenced by ZSTD_buildSuperBlockEntropy().

◆ ZSTD_compressSubBlock()

static size_t ZSTD_compressSubBlock ( const ZSTD_entropyCTables_t *  entropy,
const ZSTD_entropyCTablesMetadata_t *  entropyMetadata,
const seqDef *  sequences,
size_t  nbSeq,
const BYTE *  literals,
size_t  litSize,
const BYTE *  llCode,
const BYTE *  mlCode,
const BYTE *  ofCode,
const ZSTD_CCtx_params *  cctxParams,
void *  dst,
size_t  dstCapacity,
const int  bmi2,
int  writeLitEntropy,
int  writeSeqEntropy,
int *  litEntropyWritten,
int *  seqEntropyWritten,
U32  lastBlock 
)
static

ZSTD_compressSubBlock() : Compresses a single sub-block.

Returns
: compressed size of the sub-block Or 0 if it failed to compress.

Definition at line 536 of file zstd_compress_superblock.c.

547{
548 BYTE* const ostart = (BYTE*)dst;
549 BYTE* const oend = ostart + dstCapacity;
550 BYTE* op = ostart + ZSTD_blockHeaderSize;
551 DEBUGLOG(5, "ZSTD_compressSubBlock (litSize=%zu, nbSeq=%zu, writeLitEntropy=%d, writeSeqEntropy=%d, lastBlock=%d)",
552 litSize, nbSeq, writeLitEntropy, writeSeqEntropy, lastBlock);
553 { size_t cLitSize = ZSTD_compressSubBlock_literal((const HUF_CElt*)entropy->huf.CTable,
554 &entropyMetadata->hufMetadata, literals, litSize,
555 op, oend-op, bmi2, writeLitEntropy, litEntropyWritten);
556 FORWARD_IF_ERROR(cLitSize, "ZSTD_compressSubBlock_literal failed");
557 if (cLitSize == 0) return 0;
558 op += cLitSize;
559 }
560 { size_t cSeqSize = ZSTD_compressSubBlock_sequences(&entropy->fse,
561 &entropyMetadata->fseMetadata,
562 sequences, nbSeq,
563 llCode, mlCode, ofCode,
564 cctxParams,
565 op, oend-op,
566 bmi2, writeSeqEntropy, seqEntropyWritten);
567 FORWARD_IF_ERROR(cSeqSize, "ZSTD_compressSubBlock_sequences failed");
568 if (cSeqSize == 0) return 0;
569 op += cSeqSize;
570 }
571 /* Write block header */
572 { size_t cSize = (op-ostart)-ZSTD_blockHeaderSize;
573 U32 const cBlockHeader24 = lastBlock + (((U32)bt_compressed)<<1) + (U32)(cSize << 3);
574 MEM_writeLE24(ostart, cBlockHeader24);
575 }
576 return op-ostart;
577}
MEM_writeLE24
MEM_STATIC void MEM_writeLE24(void *memPtr, U32 val)
Definition: mem.h:340
dst
GLenum GLenum dst
Definition: glext.h:6340
sequences
static struct msg_sequence * sequences[NUM_MSG_SEQUENCES]
Definition: button.c:54
ZSTD_compressSubBlock_literal
static size_t ZSTD_compressSubBlock_literal(const HUF_CElt *hufTable, const ZSTD_hufCTablesMetadata_t *hufMetadata, const BYTE *literals, size_t litSize, void *dst, size_t dstSize, const int bmi2, int writeEntropy, int *entropyWritten)
Definition: zstd_compress_superblock.c:319
ZSTD_compressSubBlock_sequences
static size_t ZSTD_compressSubBlock_sequences(const ZSTD_fseCTables_t *fseTables, const ZSTD_fseCTablesMetadata_t *fseMetadata, const seqDef *sequences, size_t nbSeq, const BYTE *llCode, const BYTE *mlCode, const BYTE *ofCode, const ZSTD_CCtx_params *cctxParams, void *dst, size_t dstCapacity, const int bmi2, int writeEntropy, int *entropyWritten)
Definition: zstd_compress_superblock.c:436
ZSTD_blockHeaderSize
static const size_t ZSTD_blockHeaderSize
Definition: zstd_internal.h:162
bt_compressed
@ bt_compressed
Definition: zstd_internal.h:163

Referenced by ZSTD_compressSubBlock_multi().

◆ ZSTD_compressSubBlock_literal()

static size_t ZSTD_compressSubBlock_literal ( const HUF_CElt *  hufTable,
const ZSTD_hufCTablesMetadata_t *  hufMetadata,
const BYTE *  literals,
size_t  litSize,
void *  dst,
size_t  dstSize,
const int  bmi2,
int  writeEntropy,
int *  entropyWritten 
)
static

ZSTD_compressSubBlock_literal() : Compresses literals section for a sub-block. When we have to write the Huffman table we will sometimes choose a header size larger than necessary. This is because we have to pick the header size before we know the table size + compressed size, so we have a bound on the table size. If we guessed incorrectly, we fall back to uncompressed literals.

We write the header when writeEntropy=1 and set entropyWrriten=1 when we succeeded in writing the header, otherwise it is set to 0.

hufMetadata->hType has literals block type info. If it is set_basic, all sub-blocks literals section will be Raw_Literals_Block. If it is set_rle, all sub-blocks literals section will be RLE_Literals_Block. If it is set_compressed, first sub-block's literals section will be Compressed_Literals_Block If it is set_compressed, first sub-block's literals section will be Treeless_Literals_Block and the following sub-blocks' literals sections will be Treeless_Literals_Block.

Returns
: compressed size of literals section of a sub-block Or 0 if it unable to compress. Or error code

Definition at line 319 of file zstd_compress_superblock.c.

324{
325 size_t const header = writeEntropy ? 200 : 0;
326 size_t const lhSize = 3 + (litSize >= (1 KB - header)) + (litSize >= (16 KB - header));
327 BYTE* const ostart = (BYTE*)dst;
328 BYTE* const oend = ostart + dstSize;
329 BYTE* op = ostart + lhSize;
330 U32 const singleStream = lhSize == 3;
331 symbolEncodingType_e hType = writeEntropy ? hufMetadata->hType : set_repeat;
332 size_t cLitSize = 0;
333
334 (void)bmi2; /* TODO bmi2... */
335
336 DEBUGLOG(5, "ZSTD_compressSubBlock_literal (litSize=%zu, lhSize=%zu, writeEntropy=%d)", litSize, lhSize, writeEntropy);
337
338 *entropyWritten = 0;
339 if (litSize == 0 || hufMetadata->hType == set_basic) {
340 DEBUGLOG(5, "ZSTD_compressSubBlock_literal using raw literal");
341 return ZSTD_noCompressLiterals(dst, dstSize, literals, litSize);
342 } else if (hufMetadata->hType == set_rle) {
343 DEBUGLOG(5, "ZSTD_compressSubBlock_literal using rle literal");
344 return ZSTD_compressRleLiteralsBlock(dst, dstSize, literals, litSize);
345 }
346
347 assert(litSize > 0);
348 assert(hufMetadata->hType == set_compressed || hufMetadata->hType == set_repeat);
349
350 if (writeEntropy && hufMetadata->hType == set_compressed) {
351 memcpy(op, hufMetadata->hufDesBuffer, hufMetadata->hufDesSize);
352 op += hufMetadata->hufDesSize;
353 cLitSize += hufMetadata->hufDesSize;
354 DEBUGLOG(5, "ZSTD_compressSubBlock_literal (hSize=%zu)", hufMetadata->hufDesSize);
355 }
356
357 /* TODO bmi2 */
358 { const size_t cSize = singleStream ? HUF_compress1X_usingCTable(op, oend-op, literals, litSize, hufTable)
359 : HUF_compress4X_usingCTable(op, oend-op, literals, litSize, hufTable);
360 op += cSize;
361 cLitSize += cSize;
362 if (cSize == 0 || ERR_isError(cSize)) {
363 DEBUGLOG(5, "Failed to write entropy tables %s", ZSTD_getErrorName(cSize));
364 return 0;
365 }
366 /* If we expand and we aren't writing a header then emit uncompressed */
367 if (!writeEntropy && cLitSize >= litSize) {
368 DEBUGLOG(5, "ZSTD_compressSubBlock_literal using raw literal because uncompressible");
369 return ZSTD_noCompressLiterals(dst, dstSize, literals, litSize);
370 }
371 /* If we are writing headers then allow expansion that doesn't change our header size. */
372 if (lhSize < (size_t)(3 + (cLitSize >= 1 KB) + (cLitSize >= 16 KB))) {
373 assert(cLitSize > litSize);
374 DEBUGLOG(5, "Literals expanded beyond allowed header size");
375 return ZSTD_noCompressLiterals(dst, dstSize, literals, litSize);
376 }
377 DEBUGLOG(5, "ZSTD_compressSubBlock_literal (cSize=%zu)", cSize);
378 }
379
380 /* Build header */
381 switch(lhSize)
382 {
383 case 3: /* 2 - 2 - 10 - 10 */
384 { U32 const lhc = hType + ((!singleStream) << 2) + ((U32)litSize<<4) + ((U32)cLitSize<<14);
385 MEM_writeLE24(ostart, lhc);
386 break;
387 }
388 case 4: /* 2 - 2 - 14 - 14 */
389 { U32 const lhc = hType + (2 << 2) + ((U32)litSize<<4) + ((U32)cLitSize<<18);
390 MEM_writeLE32(ostart, lhc);
391 break;
392 }
393 case 5: /* 2 - 2 - 18 - 18 */
394 { U32 const lhc = hType + (3 << 2) + ((U32)litSize<<4) + ((U32)cLitSize<<22);
395 MEM_writeLE32(ostart, lhc);
396 ostart[4] = (BYTE)(cLitSize >> 10);
397 break;
398 }
399 default: /* not possible : lhSize is {3,4,5} */
400 assert(0);
401 }
402 *entropyWritten = 1;
403 DEBUGLOG(5, "Compressed literals: %u -> %u", (U32)litSize, (U32)(op-ostart));
404 return op-ostart;
405}
MEM_writeLE32
MEM_STATIC void MEM_writeLE32(void *memPtr, U32 val32)
Definition: mem.h:354
ERR_isError
ERR_STATIC unsigned ERR_isError(size_t code)
Definition: error_private.h:56
HUF_compress4X_usingCTable
size_t HUF_compress4X_usingCTable(void *dst, size_t dstSize, const void *src, size_t srcSize, const HUF_CElt *CTable)
Definition: huf_compress.c:605
HUF_compress1X_usingCTable
size_t HUF_compress1X_usingCTable(void *dst, size_t dstSize, const void *src, size_t srcSize, const HUF_CElt *CTable)
Definition: huf_compress.c:546
KB
#define KB
Definition: setuplib.h:55
ZSTD_getErrorName
ZSTDLIB_API const char * ZSTD_getErrorName(size_t code)
Definition: zstd_common.c:41
ZSTD_noCompressLiterals
size_t ZSTD_noCompressLiterals(void *dst, size_t dstCapacity, const void *src, size_t srcSize)
Definition: zstd_compress_literals.c:16
ZSTD_compressRleLiteralsBlock
size_t ZSTD_compressRleLiteralsBlock(void *dst, size_t dstCapacity, const void *src, size_t srcSize)
Definition: zstd_compress_literals.c:43

Referenced by ZSTD_compressSubBlock().

◆ ZSTD_compressSubBlock_multi()

static size_t ZSTD_compressSubBlock_multi ( const seqStore_t *  seqStorePtr,
const ZSTD_compressedBlockState_t *  prevCBlock,
ZSTD_compressedBlockState_t *  nextCBlock,
const ZSTD_entropyCTablesMetadata_t *  entropyMetadata,
const ZSTD_CCtx_params *  cctxParams,
void *  dst,
size_t  dstCapacity,
const void *  src,
size_t  srcSize,
const int  bmi2,
U32  lastBlock,
void *  workspace,
size_t  wkspSize 
)
static

ZSTD_compressSubBlock_multi() : Breaks super-block into multiple sub-blocks and compresses them. Entropy will be written to the first block. The following blocks will use repeat mode to compress. All sub-blocks are compressed blocks (no raw or rle blocks).

Returns
: compressed size of the super block (which is multiple ZSTD blocks) Or 0 if it failed to compress.

Definition at line 697 of file zstd_compress_superblock.c.

706{
707 const seqDef* const sstart = seqStorePtr->sequencesStart;
708 const seqDef* const send = seqStorePtr->sequences;
709 const seqDef* sp = sstart;
710 const BYTE* const lstart = seqStorePtr->litStart;
711 const BYTE* const lend = seqStorePtr->lit;
712 const BYTE* lp = lstart;
713 BYTE const* ip = (BYTE const*)src;
714 BYTE const* const iend = ip + srcSize;
715 BYTE* const ostart = (BYTE*)dst;
716 BYTE* const oend = ostart + dstCapacity;
717 BYTE* op = ostart;
718 const BYTE* llCodePtr = seqStorePtr->llCode;
719 const BYTE* mlCodePtr = seqStorePtr->mlCode;
720 const BYTE* ofCodePtr = seqStorePtr->ofCode;
721 size_t targetCBlockSize = cctxParams->targetCBlockSize;
722 size_t litSize, seqCount;
723 int writeLitEntropy = entropyMetadata->hufMetadata.hType == set_compressed;
724 int writeSeqEntropy = 1;
725 int lastSequence = 0;
726
727 DEBUGLOG(5, "ZSTD_compressSubBlock_multi (litSize=%u, nbSeq=%u)",
728 (unsigned)(lend-lp), (unsigned)(send-sstart));
729
730 litSize = 0;
731 seqCount = 0;
732 do {
733 size_t cBlockSizeEstimate = 0;
734 if (sstart == send) {
735 lastSequence = 1;
736 } else {
737 const seqDef* const sequence = sp + seqCount;
738 lastSequence = sequence == send - 1;
739 litSize += ZSTD_getSequenceLength(seqStorePtr, sequence).litLength;
740 seqCount++;
741 }
742 if (lastSequence) {
743 assert(lp <= lend);
744 assert(litSize <= (size_t)(lend - lp));
745 litSize = (size_t)(lend - lp);
746 }
747 /* I think there is an optimization opportunity here.
748 * Calling ZSTD_estimateSubBlockSize for every sequence can be wasteful
749 * since it recalculates estimate from scratch.
750 * For example, it would recount literal distribution and symbol codes everytime.
751 */
752 cBlockSizeEstimate = ZSTD_estimateSubBlockSize(lp, litSize, ofCodePtr, llCodePtr, mlCodePtr, seqCount,
753 &nextCBlock->entropy, entropyMetadata,
754 workspace, wkspSize, writeLitEntropy, writeSeqEntropy);
755 if (cBlockSizeEstimate > targetCBlockSize || lastSequence) {
756 int litEntropyWritten = 0;
757 int seqEntropyWritten = 0;
758 const size_t decompressedSize = ZSTD_seqDecompressedSize(seqStorePtr, sp, seqCount, litSize, lastSequence);
759 const size_t cSize = ZSTD_compressSubBlock(&nextCBlock->entropy, entropyMetadata,
760 sp, seqCount,
761 lp, litSize,
762 llCodePtr, mlCodePtr, ofCodePtr,
763 cctxParams,
764 op, oend-op,
765 bmi2, writeLitEntropy, writeSeqEntropy,
766 &litEntropyWritten, &seqEntropyWritten,
767 lastBlock && lastSequence);
768 FORWARD_IF_ERROR(cSize, "ZSTD_compressSubBlock failed");
769 if (cSize > 0 && cSize < decompressedSize) {
770 DEBUGLOG(5, "Committed the sub-block");
771 assert(ip + decompressedSize <= iend);
772 ip += decompressedSize;
773 sp += seqCount;
774 lp += litSize;
775 op += cSize;
776 llCodePtr += seqCount;
777 mlCodePtr += seqCount;
778 ofCodePtr += seqCount;
779 litSize = 0;
780 seqCount = 0;
781 /* Entropy only needs to be written once */
782 if (litEntropyWritten) {
783 writeLitEntropy = 0;
784 }
785 if (seqEntropyWritten) {
786 writeSeqEntropy = 0;
787 }
788 }
789 }
790 } while (!lastSequence);
791 if (writeLitEntropy) {
792 DEBUGLOG(5, "ZSTD_compressSubBlock_multi has literal entropy tables unwritten");
793 memcpy(&nextCBlock->entropy.huf, &prevCBlock->entropy.huf, sizeof(prevCBlock->entropy.huf));
794 }
795 if (writeSeqEntropy && ZSTD_needSequenceEntropyTables(&entropyMetadata->fseMetadata)) {
796 /* If we haven't written our entropy tables, then we've violated our contract and
797 * must emit an uncompressed block.
798 */
799 DEBUGLOG(5, "ZSTD_compressSubBlock_multi has sequence entropy tables unwritten");
800 return 0;
801 }
802 if (ip < iend) {
803 size_t const cSize = ZSTD_noCompressBlock(op, oend - op, ip, iend - ip, lastBlock);
804 DEBUGLOG(5, "ZSTD_compressSubBlock_multi last sub-block uncompressed, %zu bytes", (size_t)(iend - ip));
805 FORWARD_IF_ERROR(cSize, "ZSTD_noCompressBlock failed");
806 assert(cSize != 0);
807 op += cSize;
808 /* We have to regenerate the repcodes because we've skipped some sequences */
809 if (sp < send) {
810 seqDef const* seq;
811 repcodes_t rep;
812 memcpy(&rep, prevCBlock->rep, sizeof(rep));
813 for (seq = sstart; seq < sp; ++seq) {
814 rep = ZSTD_updateRep(rep.rep, seq->offset - 1, ZSTD_getSequenceLength(seqStorePtr, seq).litLength == 0);
815 }
816 memcpy(nextCBlock->rep, &rep, sizeof(rep));
817 }
818 }
819 DEBUGLOG(5, "ZSTD_compressSubBlock_multi compressed");
820 return op-ostart;
821}
sequence
static struct recvd_message * sequence
Definition: SystemMenu.c:63
send
INT WSAAPI send(IN SOCKET s, IN CONST CHAR FAR *buf, IN INT len, IN INT flags)
Definition: send.c:23
size_t
__kernel_size_t size_t
Definition: linux.h:237
sp
static const WCHAR sp[]
Definition: suminfo.c:287
ZSTD_compressedBlockState_t::entropy
ZSTD_entropyCTables_t entropy
Definition: zstd_compress_internal.h:117
ZSTD_compressedBlockState_t::rep
U32 rep[ZSTD_REP_NUM]
Definition: zstd_compress_internal.h:118
ZSTD_sequenceLength::litLength
U32 litLength
Definition: zstd_internal.h:348
ip
Definition: dhcpd.h:62
repcodes_s
Definition: zstd_compress_internal.h:323
repcodes_s::rep
U32 rep[3]
Definition: zstd_compress_internal.h:324
seqDef_s
Definition: zstd_internal.h:327
seqDef_s::offset
U32 offset
Definition: zstd_internal.h:328
ZSTD_noCompressBlock
MEM_STATIC size_t ZSTD_noCompressBlock(void *dst, size_t dstCapacity, const void *src, size_t srcSize, U32 lastBlock)
Definition: zstd_compress_internal.h:363
ZSTD_updateRep
MEM_STATIC repcodes_t ZSTD_updateRep(U32 const rep[3], U32 const offset, U32 const ll0)
Definition: zstd_compress_internal.h:327
ZSTD_needSequenceEntropyTables
static int ZSTD_needSequenceEntropyTables(ZSTD_fseCTablesMetadata_t const *fseMetadata)
Definition: zstd_compress_superblock.c:679
ZSTD_estimateSubBlockSize
static size_t ZSTD_estimateSubBlockSize(const BYTE *literals, size_t litSize, const BYTE *ofCodeTable, const BYTE *llCodeTable, const BYTE *mlCodeTable, size_t nbSeq, const ZSTD_entropyCTables_t *entropy, const ZSTD_entropyCTablesMetadata_t *entropyMetadata, void *workspace, size_t wkspSize, int writeLitEntropy, int writeSeqEntropy)
Definition: zstd_compress_superblock.c:660
ZSTD_seqDecompressedSize
static size_t ZSTD_seqDecompressedSize(seqStore_t const *seqStore, const seqDef *sequences, size_t nbSeq, size_t litSize, int lastSequence)
Definition: zstd_compress_superblock.c:407
ZSTD_compressSubBlock
static size_t ZSTD_compressSubBlock(const ZSTD_entropyCTables_t *entropy, const ZSTD_entropyCTablesMetadata_t *entropyMetadata, const seqDef *sequences, size_t nbSeq, const BYTE *literals, size_t litSize, const BYTE *llCode, const BYTE *mlCode, const BYTE *ofCode, const ZSTD_CCtx_params *cctxParams, void *dst, size_t dstCapacity, const int bmi2, int writeLitEntropy, int writeSeqEntropy, int *litEntropyWritten, int *seqEntropyWritten, U32 lastBlock)
Definition: zstd_compress_superblock.c:536
ZSTD_getSequenceLength
MEM_STATIC ZSTD_sequenceLength ZSTD_getSequenceLength(seqStore_t const *seqStore, seqDef const *seq)
Definition: zstd_internal.h:356

Referenced by ZSTD_compressSuperBlock().

◆ ZSTD_compressSubBlock_sequences()

static size_t ZSTD_compressSubBlock_sequences ( const ZSTD_fseCTables_t *  fseTables,
const ZSTD_fseCTablesMetadata_t *  fseMetadata,
const seqDef *  sequences,
size_t  nbSeq,
const BYTE *  llCode,
const BYTE *  mlCode,
const BYTE *  ofCode,
const ZSTD_CCtx_params *  cctxParams,
void *  dst,
size_t  dstCapacity,
const int  bmi2,
int  writeEntropy,
int *  entropyWritten 
)
static

ZSTD_compressSubBlock_sequences() : Compresses sequences section for a sub-block. fseMetadata->llType, fseMetadata->ofType, and fseMetadata->mlType have symbol compression modes for the super-block. The first successfully compressed block will have these in its header. We set entropyWritten=1 when we succeed in compressing the sequences. The following sub-blocks will always have repeat mode.

Returns
: compressed size of sequences section of a sub-block Or 0 if it is unable to compress Or error code.

Definition at line 436 of file zstd_compress_superblock.c.

443{
444 const int longOffsets = cctxParams->cParams.windowLog > STREAM_ACCUMULATOR_MIN;
445 BYTE* const ostart = (BYTE*)dst;
446 BYTE* const oend = ostart + dstCapacity;
447 BYTE* op = ostart;
448 BYTE* seqHead;
449
450 DEBUGLOG(5, "ZSTD_compressSubBlock_sequences (nbSeq=%zu, writeEntropy=%d, longOffsets=%d)", nbSeq, writeEntropy, longOffsets);
451
452 *entropyWritten = 0;
453 /* Sequences Header */
454 RETURN_ERROR_IF((oend-op) < 3 /*max nbSeq Size*/ + 1 /*seqHead*/,
455 dstSize_tooSmall, "");
456 if (nbSeq < 0x7F)
457 *op++ = (BYTE)nbSeq;
458 else if (nbSeq < LONGNBSEQ)
459 op[0] = (BYTE)((nbSeq>>8) + 0x80), op[1] = (BYTE)nbSeq, op+=2;
460 else
461 op[0]=0xFF, MEM_writeLE16(op+1, (U16)(nbSeq - LONGNBSEQ)), op+=3;
462 if (nbSeq==0) {
463 return op - ostart;
464 }
465
466 /* seqHead : flags for FSE encoding type */
467 seqHead = op++;
468
469 DEBUGLOG(5, "ZSTD_compressSubBlock_sequences (seqHeadSize=%u)", (unsigned)(op-ostart));
470
471 if (writeEntropy) {
472 const U32 LLtype = fseMetadata->llType;
473 const U32 Offtype = fseMetadata->ofType;
474 const U32 MLtype = fseMetadata->mlType;
475 DEBUGLOG(5, "ZSTD_compressSubBlock_sequences (fseTablesSize=%zu)", fseMetadata->fseTablesSize);
476 *seqHead = (BYTE)((LLtype<<6) + (Offtype<<4) + (MLtype<<2));
477 memcpy(op, fseMetadata->fseTablesBuffer, fseMetadata->fseTablesSize);
478 op += fseMetadata->fseTablesSize;
479 } else {
480 const U32 repeat = set_repeat;
481 *seqHead = (BYTE)((repeat<<6) + (repeat<<4) + (repeat<<2));
482 }
483
484 { size_t const bitstreamSize = ZSTD_encodeSequences(
485 op, oend - op,
486 fseTables->matchlengthCTable, mlCode,
487 fseTables->offcodeCTable, ofCode,
488 fseTables->litlengthCTable, llCode,
489 sequences, nbSeq,
490 longOffsets, bmi2);
491 FORWARD_IF_ERROR(bitstreamSize, "ZSTD_encodeSequences failed");
492 op += bitstreamSize;
493 /* zstd versions <= 1.3.4 mistakenly report corruption when
494 * FSE_readNCount() receives a buffer < 4 bytes.
495 * Fixed by https://github.com/facebook/zstd/pull/1146.
496 * This can happen when the last set_compressed table present is 2
497 * bytes and the bitstream is only one byte.
498 * In this exceedingly rare case, we will simply emit an uncompressed
499 * block, since it isn't worth optimizing.
500 */
501#ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
502 if (writeEntropy && fseMetadata->lastCountSize && fseMetadata->lastCountSize + bitstreamSize < 4) {
503 /* NCountSize >= 2 && bitstreamSize > 0 ==> lastCountSize == 3 */
504 assert(fseMetadata->lastCountSize + bitstreamSize == 3);
505 DEBUGLOG(5, "Avoiding bug in zstd decoder in versions <= 1.3.4 by "
506 "emitting an uncompressed block.");
507 return 0;
508 }
509#endif
510 DEBUGLOG(5, "ZSTD_compressSubBlock_sequences (bitstreamSize=%zu)", bitstreamSize);
511 }
512
513 /* zstd versions <= 1.4.0 mistakenly report error when
514 * sequences section body size is less than 3 bytes.
515 * Fixed by https://github.com/facebook/zstd/pull/1664.
516 * This can happen when the previous sequences section block is compressed
517 * with rle mode and the current block's sequences section is compressed
518 * with repeat mode where sequences section body size can be 1 byte.
519 */
520#ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
521 if (op-seqHead < 4) {
522 DEBUGLOG(5, "Avoiding bug in zstd decoder in versions <= 1.4.0 by emitting "
523 "an uncompressed block when sequences are < 4 bytes");
524 return 0;
525 }
526#endif
527
528 *entropyWritten = 1;
529 return op - ostart;
530}
STREAM_ACCUMULATOR_MIN
#define STREAM_ACCUMULATOR_MIN
Definition: bitstream.h:47
MEM_writeLE16
MEM_STATIC void MEM_writeLE16(void *memPtr, U16 val)
Definition: mem.h:324
U16
unsigned short U16
Definition: xxhash.c:194
ZSTD_encodeSequences
size_t ZSTD_encodeSequences(void *dst, size_t dstCapacity, FSE_CTable const *CTable_MatchLength, BYTE const *mlCodeTable, FSE_CTable const *CTable_OffsetBits, BYTE const *ofCodeTable, FSE_CTable const *CTable_LitLength, BYTE const *llCodeTable, seqDef const *sequences, size_t nbSeq, int longOffsets, int bmi2)
Definition: zstd_compress_sequences.c:396
RETURN_ERROR_IF
#define RETURN_ERROR_IF(cond, err,...)
Definition: zstd_internal.h:91
LONGNBSEQ
#define LONGNBSEQ
Definition: zstd_internal.h:173

Referenced by ZSTD_compressSubBlock().

◆ ZSTD_compressSuperBlock()

size_t ZSTD_compressSuperBlock ( ZSTD_CCtx *  zc,
void *  dst,
size_t  dstCapacity,
void const *  src,
size_t  srcSize,
unsigned  lastBlock 
)

Definition at line 823 of file zstd_compress_superblock.c.

826 {
827 ZSTD_entropyCTablesMetadata_t entropyMetadata;
828
829 FORWARD_IF_ERROR(ZSTD_buildSuperBlockEntropy(&zc->seqStore,
830 &zc->blockState.prevCBlock->entropy,
831 &zc->blockState.nextCBlock->entropy,
832 &zc->appliedParams,
833 &entropyMetadata,
834 zc->entropyWorkspace, HUF_WORKSPACE_SIZE /* statically allocated in resetCCtx */), "");
835
836 return ZSTD_compressSubBlock_multi(&zc->seqStore,
837 zc->blockState.prevCBlock,
838 zc->blockState.nextCBlock,
839 &entropyMetadata,
840 &zc->appliedParams,
841 dst, dstCapacity,
842 src, srcSize,
843 zc->bmi2, lastBlock,
844 zc->entropyWorkspace, HUF_WORKSPACE_SIZE /* statically allocated in resetCCtx */);
845}
HUF_WORKSPACE_SIZE
#define HUF_WORKSPACE_SIZE
Definition: huf.h:93
ZSTD_CCtx_s::appliedParams
ZSTD_CCtx_params appliedParams
Definition: zstd_compress_internal.h:234
ZSTD_CCtx_s::blockState
ZSTD_blockState_t blockState
Definition: zstd_compress_internal.h:254
ZSTD_CCtx_s::bmi2
int bmi2
Definition: zstd_compress_internal.h:232
ZSTD_CCtx_s::entropyWorkspace
U32 * entropyWorkspace
Definition: zstd_compress_internal.h:255
ZSTD_CCtx_s::seqStore
seqStore_t seqStore
Definition: zstd_compress_internal.h:249
ZSTD_blockState_t::prevCBlock
ZSTD_compressedBlockState_t * prevCBlock
Definition: zstd_compress_internal.h:150
ZSTD_blockState_t::nextCBlock
ZSTD_compressedBlockState_t * nextCBlock
Definition: zstd_compress_internal.h:151
ZSTD_entropyCTablesMetadata_t
Definition: zstd_compress_superblock.c:50
ZSTD_buildSuperBlockEntropy
static size_t ZSTD_buildSuperBlockEntropy(seqStore_t *seqStorePtr, const ZSTD_entropyCTables_t *prevEntropy, ZSTD_entropyCTables_t *nextEntropy, const ZSTD_CCtx_params *cctxParams, ZSTD_entropyCTablesMetadata_t *entropyMetadata, void *workspace, size_t wkspSize)
Definition: zstd_compress_superblock.c:274
ZSTD_compressSubBlock_multi
static size_t ZSTD_compressSubBlock_multi(const seqStore_t *seqStorePtr, const ZSTD_compressedBlockState_t *prevCBlock, ZSTD_compressedBlockState_t *nextCBlock, const ZSTD_entropyCTablesMetadata_t *entropyMetadata, const ZSTD_CCtx_params *cctxParams, void *dst, size_t dstCapacity, const void *src, size_t srcSize, const int bmi2, U32 lastBlock, void *workspace, size_t wkspSize)
Definition: zstd_compress_superblock.c:697

Referenced by ZSTD_compressBlock_targetCBlockSize_body().

◆ ZSTD_estimateSubBlockSize()

static size_t ZSTD_estimateSubBlockSize ( const BYTE *  literals,
size_t  litSize,
const BYTE *  ofCodeTable,
const BYTE *  llCodeTable,
const BYTE *  mlCodeTable,
size_t  nbSeq,
const ZSTD_entropyCTables_t *  entropy,
const ZSTD_entropyCTablesMetadata_t *  entropyMetadata,
void *  workspace,
size_t  wkspSize,
int  writeLitEntropy,
int  writeSeqEntropy 
)
static

Definition at line 660 of file zstd_compress_superblock.c.

668 {
669 size_t cSizeEstimate = 0;
670 cSizeEstimate += ZSTD_estimateSubBlockSize_literal(literals, litSize,
671 &entropy->huf, &entropyMetadata->hufMetadata,
672 workspace, wkspSize, writeLitEntropy);
673 cSizeEstimate += ZSTD_estimateSubBlockSize_sequences(ofCodeTable, llCodeTable, mlCodeTable,
674 nbSeq, &entropy->fse, &entropyMetadata->fseMetadata,
675 workspace, wkspSize, writeSeqEntropy);
676 return cSizeEstimate + ZSTD_blockHeaderSize;
677}
ZSTD_estimateSubBlockSize_sequences
static size_t ZSTD_estimateSubBlockSize_sequences(const BYTE *ofCodeTable, const BYTE *llCodeTable, const BYTE *mlCodeTable, size_t nbSeq, const ZSTD_fseCTables_t *fseTables, const ZSTD_fseCTablesMetadata_t *fseMetadata, void *workspace, size_t wkspSize, int writeEntropy)
Definition: zstd_compress_superblock.c:633
ZSTD_estimateSubBlockSize_literal
static size_t ZSTD_estimateSubBlockSize_literal(const BYTE *literals, size_t litSize, const ZSTD_hufCTables_t *huf, const ZSTD_hufCTablesMetadata_t *hufMetadata, void *workspace, size_t wkspSize, int writeEntropy)
Definition: zstd_compress_superblock.c:579

Referenced by ZSTD_compressSubBlock_multi().

◆ ZSTD_estimateSubBlockSize_literal()

static size_t ZSTD_estimateSubBlockSize_literal ( const BYTE *  literals,
size_t  litSize,
const ZSTD_hufCTables_t *  huf,
const ZSTD_hufCTablesMetadata_t *  hufMetadata,
void *  workspace,
size_t  wkspSize,
int  writeEntropy 
)
static

Definition at line 579 of file zstd_compress_superblock.c.

584{
585 unsigned* const countWksp = (unsigned*)workspace;
586 unsigned maxSymbolValue = 255;
587 size_t literalSectionHeaderSize = 3; /* Use hard coded size of 3 bytes */
588
589 if (hufMetadata->hType == set_basic) return litSize;
590 else if (hufMetadata->hType == set_rle) return 1;
591 else if (hufMetadata->hType == set_compressed || hufMetadata->hType == set_repeat) {
592 size_t const largest = HIST_count_wksp (countWksp, &maxSymbolValue, (const BYTE*)literals, litSize, workspace, wkspSize);
593 if (ZSTD_isError(largest)) return litSize;
594 { size_t cLitSizeEstimate = HUF_estimateCompressedSize((const HUF_CElt*)huf->CTable, countWksp, maxSymbolValue);
595 if (writeEntropy) cLitSizeEstimate += hufMetadata->hufDesSize;
596 return cLitSizeEstimate + literalSectionHeaderSize;
597 } }
598 assert(0); /* impossible */
599 return 0;
600}
ZSTD_isError
#define ZSTD_isError
Definition: zstd_internal.h:46

Referenced by ZSTD_estimateSubBlockSize().

◆ ZSTD_estimateSubBlockSize_sequences()

static size_t ZSTD_estimateSubBlockSize_sequences ( const BYTE *  ofCodeTable,
const BYTE *  llCodeTable,
const BYTE *  mlCodeTable,
size_t  nbSeq,
const ZSTD_fseCTables_t *  fseTables,
const ZSTD_fseCTablesMetadata_t *  fseMetadata,
void *  workspace,
size_t  wkspSize,
int  writeEntropy 
)
static

Definition at line 633 of file zstd_compress_superblock.c.

641{
642 size_t sequencesSectionHeaderSize = 3; /* Use hard coded size of 3 bytes */
643 size_t cSeqSizeEstimate = 0;
644 cSeqSizeEstimate += ZSTD_estimateSubBlockSize_symbolType(fseMetadata->ofType, ofCodeTable, MaxOff,
645 nbSeq, fseTables->offcodeCTable, NULL,
646 OF_defaultNorm, OF_defaultNormLog,
647 workspace, wkspSize);
648 cSeqSizeEstimate += ZSTD_estimateSubBlockSize_symbolType(fseMetadata->llType, llCodeTable, MaxLL,
649 nbSeq, fseTables->litlengthCTable, LL_bits,
650 LL_defaultNorm, LL_defaultNormLog,
651 workspace, wkspSize);
652 cSeqSizeEstimate += ZSTD_estimateSubBlockSize_symbolType(fseMetadata->mlType, mlCodeTable, MaxML,
653 nbSeq, fseTables->matchlengthCTable, ML_bits,
654 ML_defaultNorm, ML_defaultNormLog,
655 workspace, wkspSize);
656 if (writeEntropy) cSeqSizeEstimate += fseMetadata->fseTablesSize;
657 return cSeqSizeEstimate + sequencesSectionHeaderSize;
658}
NULL
#define NULL
Definition: types.h:112
ZSTD_estimateSubBlockSize_symbolType
static size_t ZSTD_estimateSubBlockSize_symbolType(symbolEncodingType_e type, const BYTE *codeTable, unsigned maxCode, size_t nbSeq, const FSE_CTable *fseCTable, const U32 *additionalBits, short const *defaultNorm, U32 defaultNormLog, void *workspace, size_t wkspSize)
Definition: zstd_compress_superblock.c:602
ML_bits
static const U32 ML_bits[MaxML+1]
Definition: zstd_internal.h:202
LL_bits
static const U32 LL_bits[MaxLL+1]
Definition: zstd_internal.h:189

Referenced by ZSTD_estimateSubBlockSize().

◆ ZSTD_estimateSubBlockSize_symbolType()

static size_t ZSTD_estimateSubBlockSize_symbolType ( symbolEncodingType_e  type,
const BYTE *  codeTable,
unsigned  maxCode,
size_t  nbSeq,
const FSE_CTable *  fseCTable,
const U32 *  additionalBits,
short const *  defaultNorm,
U32  defaultNormLog,
void *  workspace,
size_t  wkspSize 
)
static

Definition at line 602 of file zstd_compress_superblock.c.

608{
609 unsigned* const countWksp = (unsigned*)workspace;
610 const BYTE* ctp = codeTable;
611 const BYTE* const ctStart = ctp;
612 const BYTE* const ctEnd = ctStart + nbSeq;
613 size_t cSymbolTypeSizeEstimateInBits = 0;
614 unsigned max = maxCode;
615
616 HIST_countFast_wksp(countWksp, &max, codeTable, nbSeq, workspace, wkspSize); /* can't fail */
617 if (type == set_basic) {
618 cSymbolTypeSizeEstimateInBits = ZSTD_crossEntropyCost(defaultNorm, defaultNormLog, countWksp, max);
619 } else if (type == set_rle) {
620 cSymbolTypeSizeEstimateInBits = 0;
621 } else if (type == set_compressed || type == set_repeat) {
622 cSymbolTypeSizeEstimateInBits = ZSTD_fseBitCost(fseCTable, countWksp, max);
623 }
624 if (ZSTD_isError(cSymbolTypeSizeEstimateInBits)) return nbSeq * 10;
625 while (ctp < ctEnd) {
626 if (additionalBits) cSymbolTypeSizeEstimateInBits += additionalBits[*ctp];
627 else cSymbolTypeSizeEstimateInBits += *ctp; /* for offset, offset code is also the number of additional bits */
628 ctp++;
629 }
630 return cSymbolTypeSizeEstimateInBits / 8;
631}
type
GLuint GLuint GLsizei GLenum type
Definition: gl.h:1545
ZSTD_crossEntropyCost
size_t ZSTD_crossEntropyCost(short const *norm, unsigned accuracyLog, unsigned const *count, unsigned const max)
Definition: zstd_compress_sequences.c:124
ZSTD_fseBitCost
size_t ZSTD_fseBitCost(FSE_CTable const *ctable, unsigned const *count, unsigned const max)
Definition: zstd_compress_sequences.c:89

Referenced by ZSTD_estimateSubBlockSize_sequences().

◆ ZSTD_needSequenceEntropyTables()

static int ZSTD_needSequenceEntropyTables ( ZSTD_fseCTablesMetadata_t const *  fseMetadata)
static

Definition at line 679 of file zstd_compress_superblock.c.

680{
681 if (fseMetadata->llType == set_compressed || fseMetadata->llType == set_rle)
682 return 1;
683 if (fseMetadata->mlType == set_compressed || fseMetadata->mlType == set_rle)
684 return 1;
685 if (fseMetadata->ofType == set_compressed || fseMetadata->ofType == set_rle)
686 return 1;
687 return 0;
688}

Referenced by ZSTD_compressSubBlock_multi().

◆ ZSTD_seqDecompressedSize()

static size_t ZSTD_seqDecompressedSize ( seqStore_t const *  seqStore,
const seqDef *  sequences,
size_t  nbSeq,
size_t  litSize,
int  lastSequence 
)
static

Definition at line 407 of file zstd_compress_superblock.c.

407 {
408 const seqDef* const sstart = sequences;
409 const seqDef* const send = sequences + nbSeq;
410 const seqDef* sp = sstart;
411 size_t matchLengthSum = 0;
412 size_t litLengthSum = 0;
413 while (send-sp > 0) {
414 ZSTD_sequenceLength const seqLen = ZSTD_getSequenceLength(seqStore, sp);
415 litLengthSum += seqLen.litLength;
416 matchLengthSum += seqLen.matchLength;
417 sp++;
418 }
419 assert(litLengthSum <= litSize);
420 if (!lastSequence) {
421 assert(litLengthSum == litSize);
422 }
423 return matchLengthSum + litSize;
424}
ZSTD_sequenceLength
Definition: zstd_internal.h:347
ZSTD_sequenceLength::matchLength
U32 matchLength
Definition: zstd_internal.h:349

Referenced by ZSTD_compressSubBlock_multi().