xref: /freebsd/sys/contrib/zstd/lib/common/huf.h (revision 5ff13fbc199bdf5f0572845351c68ee5ca828e71)
1 /* ******************************************************************
2  * huff0 huffman codec,
3  * part of Finite State Entropy library
4  * Copyright (c) Yann Collet, Facebook, Inc.
5  *
6  * You can contact the author at :
7  * - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
8  *
9  * This source code is licensed under both the BSD-style license (found in the
10  * LICENSE file in the root directory of this source tree) and the GPLv2 (found
11  * in the COPYING file in the root directory of this source tree).
12  * You may select, at your option, one of the above-listed licenses.
13 ****************************************************************** */
14 
15 #if defined (__cplusplus)
16 extern "C" {
17 #endif
18 
19 #ifndef HUF_H_298734234
20 #define HUF_H_298734234
21 
22 /* *** Dependencies *** */
23 #include "zstd_deps.h"    /* size_t */
24 
25 
26 /* *** library symbols visibility *** */
27 /* Note : when linking with -fvisibility=hidden on gcc, or by default on Visual,
28  *        HUF symbols remain "private" (internal symbols for library only).
29  *        Set macro FSE_DLL_EXPORT to 1 if you want HUF symbols visible on DLL interface */
30 #if defined(FSE_DLL_EXPORT) && (FSE_DLL_EXPORT==1) && defined(__GNUC__) && (__GNUC__ >= 4)
31 #  define HUF_PUBLIC_API __attribute__ ((visibility ("default")))
32 #elif defined(FSE_DLL_EXPORT) && (FSE_DLL_EXPORT==1)   /* Visual expected */
33 #  define HUF_PUBLIC_API __declspec(dllexport)
34 #elif defined(FSE_DLL_IMPORT) && (FSE_DLL_IMPORT==1)
35 #  define HUF_PUBLIC_API __declspec(dllimport)  /* not required, just to generate faster code (saves a function pointer load from IAT and an indirect jump) */
36 #else
37 #  define HUF_PUBLIC_API
38 #endif
39 
40 
41 /* ========================== */
42 /* ***  simple functions  *** */
43 /* ========================== */
44 
45 /** HUF_compress() :
46  *  Compress content from buffer 'src', of size 'srcSize', into buffer 'dst'.
47  * 'dst' buffer must be already allocated.
48  *  Compression runs faster if `dstCapacity` >= HUF_compressBound(srcSize).
49  * `srcSize` must be <= `HUF_BLOCKSIZE_MAX` == 128 KB.
50  * @return : size of compressed data (<= `dstCapacity`).
51  *  Special values : if return == 0, srcData is not compressible => Nothing is stored within dst !!!
52  *                   if HUF_isError(return), compression failed (more details using HUF_getErrorName())
53  */
54 HUF_PUBLIC_API size_t HUF_compress(void* dst, size_t dstCapacity,
55                              const void* src, size_t srcSize);
56 
57 /** HUF_decompress() :
58  *  Decompress HUF data from buffer 'cSrc', of size 'cSrcSize',
59  *  into already allocated buffer 'dst', of minimum size 'dstSize'.
60  * `originalSize` : **must** be the ***exact*** size of original (uncompressed) data.
61  *  Note : in contrast with FSE, HUF_decompress can regenerate
62  *         RLE (cSrcSize==1) and uncompressed (cSrcSize==dstSize) data,
63  *         because it knows size to regenerate (originalSize).
64  * @return : size of regenerated data (== originalSize),
65  *           or an error code, which can be tested using HUF_isError()
66  */
67 HUF_PUBLIC_API size_t HUF_decompress(void* dst,  size_t originalSize,
68                                const void* cSrc, size_t cSrcSize);
69 
70 
71 /* ***   Tool functions *** */
72 #define HUF_BLOCKSIZE_MAX (128 * 1024)                  /**< maximum input size for a single block compressed with HUF_compress */
73 HUF_PUBLIC_API size_t HUF_compressBound(size_t size);   /**< maximum compressed size (worst case) */
74 
75 /* Error Management */
76 HUF_PUBLIC_API unsigned    HUF_isError(size_t code);       /**< tells if a return value is an error code */
77 HUF_PUBLIC_API const char* HUF_getErrorName(size_t code);  /**< provides error code string (useful for debugging) */
78 
79 
80 /* ***   Advanced function   *** */
81 
82 /** HUF_compress2() :
83  *  Same as HUF_compress(), but offers control over `maxSymbolValue` and `tableLog`.
84  * `maxSymbolValue` must be <= HUF_SYMBOLVALUE_MAX .
85  * `tableLog` must be `<= HUF_TABLELOG_MAX` . */
86 HUF_PUBLIC_API size_t HUF_compress2 (void* dst, size_t dstCapacity,
87                                const void* src, size_t srcSize,
88                                unsigned maxSymbolValue, unsigned tableLog);
89 
90 /** HUF_compress4X_wksp() :
91  *  Same as HUF_compress2(), but uses externally allocated `workSpace`.
92  * `workspace` must be at least as large as HUF_WORKSPACE_SIZE */
93 #define HUF_WORKSPACE_SIZE ((8 << 10) + 512 /* sorting scratch space */)
94 #define HUF_WORKSPACE_SIZE_U64 (HUF_WORKSPACE_SIZE / sizeof(U64))
95 HUF_PUBLIC_API size_t HUF_compress4X_wksp (void* dst, size_t dstCapacity,
96                                      const void* src, size_t srcSize,
97                                      unsigned maxSymbolValue, unsigned tableLog,
98                                      void* workSpace, size_t wkspSize);
99 
100 #endif   /* HUF_H_298734234 */
101 
102 /* ******************************************************************
103  *  WARNING !!
104  *  The following section contains advanced and experimental definitions
105  *  which shall never be used in the context of a dynamic library,
106  *  because they are not guaranteed to remain stable in the future.
107  *  Only consider them in association with static linking.
108  * *****************************************************************/
109 #if defined(HUF_STATIC_LINKING_ONLY) && !defined(HUF_H_HUF_STATIC_LINKING_ONLY)
110 #define HUF_H_HUF_STATIC_LINKING_ONLY
111 
112 /* *** Dependencies *** */
113 #include "mem.h"   /* U32 */
114 #define FSE_STATIC_LINKING_ONLY
115 #include "fse.h"
116 
117 
118 /* *** Constants *** */
119 #define HUF_TABLELOG_MAX      12      /* max runtime value of tableLog (due to static allocation); can be modified up to HUF_TABLELOG_ABSOLUTEMAX */
120 #define HUF_TABLELOG_DEFAULT  11      /* default tableLog value when none specified */
121 #define HUF_SYMBOLVALUE_MAX  255
122 
123 #define HUF_TABLELOG_ABSOLUTEMAX  12  /* absolute limit of HUF_MAX_TABLELOG. Beyond that value, code does not work */
124 #if (HUF_TABLELOG_MAX > HUF_TABLELOG_ABSOLUTEMAX)
125 #  error "HUF_TABLELOG_MAX is too large !"
126 #endif
127 
128 
129 /* ****************************************
130 *  Static allocation
131 ******************************************/
132 /* HUF buffer bounds */
133 #define HUF_CTABLEBOUND 129
134 #define HUF_BLOCKBOUND(size) (size + (size>>8) + 8)   /* only true when incompressible is pre-filtered with fast heuristic */
135 #define HUF_COMPRESSBOUND(size) (HUF_CTABLEBOUND + HUF_BLOCKBOUND(size))   /* Macro version, useful for static allocation */
136 
137 /* static allocation of HUF's Compression Table */
138 /* this is a private definition, just exposed for allocation and strict aliasing purpose. never EVER access its members directly */
139 typedef size_t HUF_CElt;   /* consider it an incomplete type */
140 #define HUF_CTABLE_SIZE_ST(maxSymbolValue)   ((maxSymbolValue)+2)   /* Use tables of size_t, for proper alignment */
141 #define HUF_CTABLE_SIZE(maxSymbolValue)       (HUF_CTABLE_SIZE_ST(maxSymbolValue) * sizeof(size_t))
142 #define HUF_CREATE_STATIC_CTABLE(name, maxSymbolValue) \
143     HUF_CElt name[HUF_CTABLE_SIZE_ST(maxSymbolValue)] /* no final ; */
144 
145 /* static allocation of HUF's DTable */
146 typedef U32 HUF_DTable;
147 #define HUF_DTABLE_SIZE(maxTableLog)   (1 + (1<<(maxTableLog)))
148 #define HUF_CREATE_STATIC_DTABLEX1(DTable, maxTableLog) \
149         HUF_DTable DTable[HUF_DTABLE_SIZE((maxTableLog)-1)] = { ((U32)((maxTableLog)-1) * 0x01000001) }
150 #define HUF_CREATE_STATIC_DTABLEX2(DTable, maxTableLog) \
151         HUF_DTable DTable[HUF_DTABLE_SIZE(maxTableLog)] = { ((U32)(maxTableLog) * 0x01000001) }
152 
153 
154 /* ****************************************
155 *  Advanced decompression functions
156 ******************************************/
157 size_t HUF_decompress4X1 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< single-symbol decoder */
158 #ifndef HUF_FORCE_DECOMPRESS_X1
159 size_t HUF_decompress4X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< double-symbols decoder */
160 #endif
161 
162 size_t HUF_decompress4X_DCtx (HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< decodes RLE and uncompressed */
163 size_t HUF_decompress4X_hufOnly(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< considers RLE and uncompressed as errors */
164 size_t HUF_decompress4X_hufOnly_wksp(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize); /**< considers RLE and uncompressed as errors */
165 size_t HUF_decompress4X1_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< single-symbol decoder */
166 size_t HUF_decompress4X1_DCtx_wksp(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize);   /**< single-symbol decoder */
167 #ifndef HUF_FORCE_DECOMPRESS_X1
168 size_t HUF_decompress4X2_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< double-symbols decoder */
169 size_t HUF_decompress4X2_DCtx_wksp(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize);   /**< double-symbols decoder */
170 #endif
171 
172 
173 /* ****************************************
174  *  HUF detailed API
175  * ****************************************/
176 
177 /*! HUF_compress() does the following:
178  *  1. count symbol occurrence from source[] into table count[] using FSE_count() (exposed within "fse.h")
179  *  2. (optional) refine tableLog using HUF_optimalTableLog()
180  *  3. build Huffman table from count using HUF_buildCTable()
181  *  4. save Huffman table to memory buffer using HUF_writeCTable()
182  *  5. encode the data stream using HUF_compress4X_usingCTable()
183  *
184  *  The following API allows targeting specific sub-functions for advanced tasks.
185  *  For example, it's possible to compress several blocks using the same 'CTable',
186  *  or to save and regenerate 'CTable' using external methods.
187  */
188 unsigned HUF_optimalTableLog(unsigned maxTableLog, size_t srcSize, unsigned maxSymbolValue);
189 size_t HUF_buildCTable (HUF_CElt* CTable, const unsigned* count, unsigned maxSymbolValue, unsigned maxNbBits);   /* @return : maxNbBits; CTable and count can overlap. In which case, CTable will overwrite count content */
190 size_t HUF_writeCTable (void* dst, size_t maxDstSize, const HUF_CElt* CTable, unsigned maxSymbolValue, unsigned huffLog);
191 size_t HUF_writeCTable_wksp(void* dst, size_t maxDstSize, const HUF_CElt* CTable, unsigned maxSymbolValue, unsigned huffLog, void* workspace, size_t workspaceSize);
192 size_t HUF_compress4X_usingCTable(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable);
193 size_t HUF_compress4X_usingCTable_bmi2(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable, int bmi2);
194 size_t HUF_estimateCompressedSize(const HUF_CElt* CTable, const unsigned* count, unsigned maxSymbolValue);
195 int HUF_validateCTable(const HUF_CElt* CTable, const unsigned* count, unsigned maxSymbolValue);
196 
197 typedef enum {
198    HUF_repeat_none,  /**< Cannot use the previous table */
199    HUF_repeat_check, /**< Can use the previous table but it must be checked. Note : The previous table must have been constructed by HUF_compress{1, 4}X_repeat */
200    HUF_repeat_valid  /**< Can use the previous table and it is assumed to be valid */
201  } HUF_repeat;
202 /** HUF_compress4X_repeat() :
203  *  Same as HUF_compress4X_wksp(), but considers using hufTable if *repeat != HUF_repeat_none.
204  *  If it uses hufTable it does not modify hufTable or repeat.
205  *  If it doesn't, it sets *repeat = HUF_repeat_none, and it sets hufTable to the table used.
206  *  If preferRepeat then the old table will always be used if valid.
207  *  If suspectUncompressible then some sampling checks will be run to potentially skip huffman coding */
208 size_t HUF_compress4X_repeat(void* dst, size_t dstSize,
209                        const void* src, size_t srcSize,
210                        unsigned maxSymbolValue, unsigned tableLog,
211                        void* workSpace, size_t wkspSize,    /**< `workSpace` must be aligned on 4-bytes boundaries, `wkspSize` must be >= HUF_WORKSPACE_SIZE */
212                        HUF_CElt* hufTable, HUF_repeat* repeat, int preferRepeat, int bmi2, unsigned suspectUncompressible);
213 
214 /** HUF_buildCTable_wksp() :
215  *  Same as HUF_buildCTable(), but using externally allocated scratch buffer.
216  * `workSpace` must be aligned on 4-bytes boundaries, and its size must be >= HUF_CTABLE_WORKSPACE_SIZE.
217  */
218 #define HUF_CTABLE_WORKSPACE_SIZE_U32 (2*HUF_SYMBOLVALUE_MAX +1 +1)
219 #define HUF_CTABLE_WORKSPACE_SIZE (HUF_CTABLE_WORKSPACE_SIZE_U32 * sizeof(unsigned))
220 size_t HUF_buildCTable_wksp (HUF_CElt* tree,
221                        const unsigned* count, U32 maxSymbolValue, U32 maxNbBits,
222                              void* workSpace, size_t wkspSize);
223 
224 /*! HUF_readStats() :
225  *  Read compact Huffman tree, saved by HUF_writeCTable().
226  * `huffWeight` is destination buffer.
227  * @return : size read from `src` , or an error Code .
228  *  Note : Needed by HUF_readCTable() and HUF_readDTableXn() . */
229 size_t HUF_readStats(BYTE* huffWeight, size_t hwSize,
230                      U32* rankStats, U32* nbSymbolsPtr, U32* tableLogPtr,
231                      const void* src, size_t srcSize);
232 
233 /*! HUF_readStats_wksp() :
234  * Same as HUF_readStats() but takes an external workspace which must be
235  * 4-byte aligned and its size must be >= HUF_READ_STATS_WORKSPACE_SIZE.
236  * If the CPU has BMI2 support, pass bmi2=1, otherwise pass bmi2=0.
237  */
238 #define HUF_READ_STATS_WORKSPACE_SIZE_U32 FSE_DECOMPRESS_WKSP_SIZE_U32(6, HUF_TABLELOG_MAX-1)
239 #define HUF_READ_STATS_WORKSPACE_SIZE (HUF_READ_STATS_WORKSPACE_SIZE_U32 * sizeof(unsigned))
240 size_t HUF_readStats_wksp(BYTE* huffWeight, size_t hwSize,
241                           U32* rankStats, U32* nbSymbolsPtr, U32* tableLogPtr,
242                           const void* src, size_t srcSize,
243                           void* workspace, size_t wkspSize,
244                           int bmi2);
245 
246 /** HUF_readCTable() :
247  *  Loading a CTable saved with HUF_writeCTable() */
248 size_t HUF_readCTable (HUF_CElt* CTable, unsigned* maxSymbolValuePtr, const void* src, size_t srcSize, unsigned *hasZeroWeights);
249 
250 /** HUF_getNbBitsFromCTable() :
251  *  Read nbBits from CTable symbolTable, for symbol `symbolValue` presumed <= HUF_SYMBOLVALUE_MAX
252  *  Note 1 : is not inlined, as HUF_CElt definition is private */
253 U32 HUF_getNbBitsFromCTable(const HUF_CElt* symbolTable, U32 symbolValue);
254 
255 /*
256  * HUF_decompress() does the following:
257  * 1. select the decompression algorithm (X1, X2) based on pre-computed heuristics
258  * 2. build Huffman table from save, using HUF_readDTableX?()
259  * 3. decode 1 or 4 segments in parallel using HUF_decompress?X?_usingDTable()
260  */
261 
262 /** HUF_selectDecoder() :
263  *  Tells which decoder is likely to decode faster,
264  *  based on a set of pre-computed metrics.
265  * @return : 0==HUF_decompress4X1, 1==HUF_decompress4X2 .
266  *  Assumption : 0 < dstSize <= 128 KB */
267 U32 HUF_selectDecoder (size_t dstSize, size_t cSrcSize);
268 
269 /**
270  *  The minimum workspace size for the `workSpace` used in
271  *  HUF_readDTableX1_wksp() and HUF_readDTableX2_wksp().
272  *
273  *  The space used depends on HUF_TABLELOG_MAX, ranging from ~1500 bytes when
274  *  HUF_TABLE_LOG_MAX=12 to ~1850 bytes when HUF_TABLE_LOG_MAX=15.
275  *  Buffer overflow errors may potentially occur if code modifications result in
276  *  a required workspace size greater than that specified in the following
277  *  macro.
278  */
279 #define HUF_DECOMPRESS_WORKSPACE_SIZE ((2 << 10) + (1 << 9))
280 #define HUF_DECOMPRESS_WORKSPACE_SIZE_U32 (HUF_DECOMPRESS_WORKSPACE_SIZE / sizeof(U32))
281 
282 #ifndef HUF_FORCE_DECOMPRESS_X2
283 size_t HUF_readDTableX1 (HUF_DTable* DTable, const void* src, size_t srcSize);
284 size_t HUF_readDTableX1_wksp (HUF_DTable* DTable, const void* src, size_t srcSize, void* workSpace, size_t wkspSize);
285 #endif
286 #ifndef HUF_FORCE_DECOMPRESS_X1
287 size_t HUF_readDTableX2 (HUF_DTable* DTable, const void* src, size_t srcSize);
288 size_t HUF_readDTableX2_wksp (HUF_DTable* DTable, const void* src, size_t srcSize, void* workSpace, size_t wkspSize);
289 #endif
290 
291 size_t HUF_decompress4X_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
292 #ifndef HUF_FORCE_DECOMPRESS_X2
293 size_t HUF_decompress4X1_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
294 #endif
295 #ifndef HUF_FORCE_DECOMPRESS_X1
296 size_t HUF_decompress4X2_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
297 #endif
298 
299 
300 /* ====================== */
301 /* single stream variants */
302 /* ====================== */
303 
304 size_t HUF_compress1X (void* dst, size_t dstSize, const void* src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog);
305 size_t HUF_compress1X_wksp (void* dst, size_t dstSize, const void* src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void* workSpace, size_t wkspSize);  /**< `workSpace` must be a table of at least HUF_WORKSPACE_SIZE_U64 U64 */
306 size_t HUF_compress1X_usingCTable(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable);
307 size_t HUF_compress1X_usingCTable_bmi2(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable, int bmi2);
308 /** HUF_compress1X_repeat() :
309  *  Same as HUF_compress1X_wksp(), but considers using hufTable if *repeat != HUF_repeat_none.
310  *  If it uses hufTable it does not modify hufTable or repeat.
311  *  If it doesn't, it sets *repeat = HUF_repeat_none, and it sets hufTable to the table used.
312  *  If preferRepeat then the old table will always be used if valid.
313  *  If suspectUncompressible then some sampling checks will be run to potentially skip huffman coding */
314 size_t HUF_compress1X_repeat(void* dst, size_t dstSize,
315                        const void* src, size_t srcSize,
316                        unsigned maxSymbolValue, unsigned tableLog,
317                        void* workSpace, size_t wkspSize,   /**< `workSpace` must be aligned on 4-bytes boundaries, `wkspSize` must be >= HUF_WORKSPACE_SIZE */
318                        HUF_CElt* hufTable, HUF_repeat* repeat, int preferRepeat, int bmi2, unsigned suspectUncompressible);
319 
320 size_t HUF_decompress1X1 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /* single-symbol decoder */
321 #ifndef HUF_FORCE_DECOMPRESS_X1
322 size_t HUF_decompress1X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /* double-symbol decoder */
323 #endif
324 
325 size_t HUF_decompress1X_DCtx (HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);
326 size_t HUF_decompress1X_DCtx_wksp (HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize);
327 #ifndef HUF_FORCE_DECOMPRESS_X2
328 size_t HUF_decompress1X1_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< single-symbol decoder */
329 size_t HUF_decompress1X1_DCtx_wksp(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize);   /**< single-symbol decoder */
330 #endif
331 #ifndef HUF_FORCE_DECOMPRESS_X1
332 size_t HUF_decompress1X2_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< double-symbols decoder */
333 size_t HUF_decompress1X2_DCtx_wksp(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize);   /**< double-symbols decoder */
334 #endif
335 
336 size_t HUF_decompress1X_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);   /**< automatic selection of sing or double symbol decoder, based on DTable */
337 #ifndef HUF_FORCE_DECOMPRESS_X2
338 size_t HUF_decompress1X1_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
339 #endif
340 #ifndef HUF_FORCE_DECOMPRESS_X1
341 size_t HUF_decompress1X2_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
342 #endif
343 
344 /* BMI2 variants.
345  * If the CPU has BMI2 support, pass bmi2=1, otherwise pass bmi2=0.
346  */
347 size_t HUF_decompress1X_usingDTable_bmi2(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable, int bmi2);
348 #ifndef HUF_FORCE_DECOMPRESS_X2
349 size_t HUF_decompress1X1_DCtx_wksp_bmi2(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize, int bmi2);
350 #endif
351 size_t HUF_decompress4X_usingDTable_bmi2(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable, int bmi2);
352 size_t HUF_decompress4X_hufOnly_wksp_bmi2(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize, int bmi2);
353 #ifndef HUF_FORCE_DECOMPRESS_X2
354 size_t HUF_readDTableX1_wksp_bmi2(HUF_DTable* DTable, const void* src, size_t srcSize, void* workSpace, size_t wkspSize, int bmi2);
355 #endif
356 #ifndef HUF_FORCE_DECOMPRESS_X1
357 size_t HUF_readDTableX2_wksp_bmi2(HUF_DTable* DTable, const void* src, size_t srcSize, void* workSpace, size_t wkspSize, int bmi2);
358 #endif
359 
360 #endif /* HUF_STATIC_LINKING_ONLY */
361 
362 #if defined (__cplusplus)
363 }
364 #endif
365