ddidderr/zstd-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(rust): port FSE entropy decoding

Browse Source 
Move FSE normalized-count parsing, Huffman statistics decoding, FSE table
construction, and FSE stream decompression into Rust. The C source files now
only retain the headers needed by the existing build configuration.

The implementation keeps the public C ABI and verifies C-generated balanced,
skewed, and Huffman-statistics streams. Compression and the higher-level frame
decoder remain C for now.

Test Plan:
- cargo fmt --check
- cargo test --all-targets
- cargo clippy --all-targets -- -D warnings
- cargo build --release
- compile both C shims with -Werror and -Wredundant-decls

Refs: rust/README.md
This commit is contained in:
ddidderr
2026-07-10 20:04:26 +02:00
parent 554a30da41
commit a0f2b2a14c
6 changed files with 1264 additions and 652 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/common/entropy_common.c
+3 -336
View File
@@ -1,340 +1,7 @@
/* ******************************************************************
* Common functions of New Generation Entropy library
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* You can contact the author at :
* - FSE+HUF source repository : https://github.com/Cyan4973/FiniteStateEntropy
* - Public forum : https://groups.google.com/forum/#!forum/lz4c
*
* 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.
****************************************************************** */
/* *************************************
* Dependencies
***************************************/
#include "mem.h"
#include "error_private.h" /* ERR_*, ERROR */
#define FSE_STATIC_LINKING_ONLY /* FSE_MIN_TABLELOG */
#include "error_private.h"
#define FSE_STATIC_LINKING_ONLY
#include "fse.h"
#include "huf.h"
#include "bits.h" /* ZSDT_highbit32, ZSTD_countTrailingZeros32 */
/*=== Version ===*/
unsigned FSE_versionNumber(void) { return FSE_VERSION_NUMBER; }
/*=== Error Management ===*/
unsigned FSE_isError(size_t code) { return ERR_isError(code); }
const char* FSE_getErrorName(size_t code) { return ERR_getErrorName(code); }
unsigned HUF_isError(size_t code) { return ERR_isError(code); }
const char* HUF_getErrorName(size_t code) { return ERR_getErrorName(code); }
/*-**************************************************************
* FSE NCount encoding-decoding
****************************************************************/
FORCE_INLINE_TEMPLATE
size_t FSE_readNCount_body(short* normalizedCounter, unsigned* maxSVPtr, unsigned* tableLogPtr,
const void* headerBuffer, size_t hbSize)
{
const BYTE* const istart = (const BYTE*) headerBuffer;
const BYTE* const iend = istart + hbSize;
const BYTE* ip = istart;
int nbBits;
int remaining;
int threshold;
U32 bitStream;
int bitCount;
unsigned charnum = 0;
unsigned const maxSV1 = *maxSVPtr + 1;
int previous0 = 0;
if (hbSize < 8) {
/* This function only works when hbSize >= 8 */
char buffer[8] = {0};
ZSTD_memcpy(buffer, headerBuffer, hbSize);
{ size_t const countSize = FSE_readNCount(normalizedCounter, maxSVPtr, tableLogPtr,
buffer, sizeof(buffer));
if (FSE_isError(countSize)) return countSize;
if (countSize > hbSize) return ERROR(corruption_detected);
return countSize;
} }
assert(hbSize >= 8);
/* init */
ZSTD_memset(normalizedCounter, 0, (*maxSVPtr+1) * sizeof(normalizedCounter[0])); /* all symbols not present in NCount have a frequency of 0 */
bitStream = MEM_readLE32(ip);
nbBits = (bitStream & 0xF) + FSE_MIN_TABLELOG; /* extract tableLog */
if (nbBits > FSE_TABLELOG_ABSOLUTE_MAX) return ERROR(tableLog_tooLarge);
bitStream >>= 4;
bitCount = 4;
*tableLogPtr = nbBits;
remaining = (1<<nbBits)+1;
threshold = 1<<nbBits;
nbBits++;
for (;;) {
if (previous0) {
/* Count the number of repeats. Each time the
* 2-bit repeat code is 0b11 there is another
* repeat.
* Avoid UB by setting the high bit to 1.
*/
int repeats = ZSTD_countTrailingZeros32(~bitStream | 0x80000000) >> 1;
while (repeats >= 12) {
charnum += 3 * 12;
if (LIKELY(ip <= iend-7)) {
ip += 3;
} else {
bitCount -= (int)(8 * (iend - 7 - ip));
bitCount &= 31;
ip = iend - 4;
}
bitStream = MEM_readLE32(ip) >> bitCount;
repeats = ZSTD_countTrailingZeros32(~bitStream | 0x80000000) >> 1;
}
charnum += 3 * repeats;
bitStream >>= 2 * repeats;
bitCount += 2 * repeats;
/* Add the final repeat which isn't 0b11. */
assert((bitStream & 3) < 3);
charnum += bitStream & 3;
bitCount += 2;
/* This is an error, but break and return an error
* at the end, because returning out of a loop makes
* it harder for the compiler to optimize.
*/
if (charnum >= maxSV1) break;
/* We don't need to set the normalized count to 0
* because we already memset the whole buffer to 0.
*/
if (LIKELY(ip <= iend-7) || (ip + (bitCount>>3) <= iend-4)) {
assert((bitCount >> 3) <= 3); /* For first condition to work */
ip += bitCount>>3;
bitCount &= 7;
} else {
bitCount -= (int)(8 * (iend - 4 - ip));
bitCount &= 31;
ip = iend - 4;
}
bitStream = MEM_readLE32(ip) >> bitCount;
}
{
int const max = (2*threshold-1) - remaining;
int count;
if ((bitStream & (threshold-1)) < (U32)max) {
count = bitStream & (threshold-1);
bitCount += nbBits-1;
} else {
count = bitStream & (2*threshold-1);
if (count >= threshold) count -= max;
bitCount += nbBits;
}
count--; /* extra accuracy */
/* When it matters (small blocks), this is a
* predictable branch, because we don't use -1.
*/
if (count >= 0) {
remaining -= count;
} else {
assert(count == -1);
remaining += count;
}
normalizedCounter[charnum++] = (short)count;
previous0 = !count;
assert(threshold > 1);
if (remaining < threshold) {
/* This branch can be folded into the
* threshold update condition because we
* know that threshold > 1.
*/
if (remaining <= 1) break;
nbBits = ZSTD_highbit32(remaining) + 1;
threshold = 1 << (nbBits - 1);
}
if (charnum >= maxSV1) break;
if (LIKELY(ip <= iend-7) || (ip + (bitCount>>3) <= iend-4)) {
ip += bitCount>>3;
bitCount &= 7;
} else {
bitCount -= (int)(8 * (iend - 4 - ip));
bitCount &= 31;
ip = iend - 4;
}
bitStream = MEM_readLE32(ip) >> bitCount;
} }
if (remaining != 1) return ERROR(corruption_detected);
/* Only possible when there are too many zeros. */
if (charnum > maxSV1) return ERROR(maxSymbolValue_tooSmall);
if (bitCount > 32) return ERROR(corruption_detected);
*maxSVPtr = charnum-1;
ip += (bitCount+7)>>3;
return ip-istart;
}
/* Avoids the FORCE_INLINE of the _body() function. */
static size_t FSE_readNCount_body_default(
short* normalizedCounter, unsigned* maxSVPtr, unsigned* tableLogPtr,
const void* headerBuffer, size_t hbSize)
{
return FSE_readNCount_body(normalizedCounter, maxSVPtr, tableLogPtr, headerBuffer, hbSize);
}
#if DYNAMIC_BMI2
BMI2_TARGET_ATTRIBUTE static size_t FSE_readNCount_body_bmi2(
short* normalizedCounter, unsigned* maxSVPtr, unsigned* tableLogPtr,
const void* headerBuffer, size_t hbSize)
{
return FSE_readNCount_body(normalizedCounter, maxSVPtr, tableLogPtr, headerBuffer, hbSize);
}
#endif
size_t FSE_readNCount_bmi2(
short* normalizedCounter, unsigned* maxSVPtr, unsigned* tableLogPtr,
const void* headerBuffer, size_t hbSize, int bmi2)
{
#if DYNAMIC_BMI2
if (bmi2) {
return FSE_readNCount_body_bmi2(normalizedCounter, maxSVPtr, tableLogPtr, headerBuffer, hbSize);
}
#endif
(void)bmi2;
return FSE_readNCount_body_default(normalizedCounter, maxSVPtr, tableLogPtr, headerBuffer, hbSize);
}
size_t FSE_readNCount(
short* normalizedCounter, unsigned* maxSVPtr, unsigned* tableLogPtr,
const void* headerBuffer, size_t hbSize)
{
return FSE_readNCount_bmi2(normalizedCounter, maxSVPtr, tableLogPtr, headerBuffer, hbSize, /* bmi2 */ 0);
}
/*! HUF_readStats() :
Read compact Huffman tree, saved by HUF_writeCTable().
`huffWeight` is destination buffer.
`rankStats` is assumed to be a table of at least HUF_TABLELOG_MAX U32.
@return : size read from `src` , or an error Code .
Note : Needed by HUF_readCTable() and HUF_readDTableX?() .
*/
size_t HUF_readStats(BYTE* huffWeight, size_t hwSize, U32* rankStats,
U32* nbSymbolsPtr, U32* tableLogPtr,
const void* src, size_t srcSize)
{
U32 wksp[HUF_READ_STATS_WORKSPACE_SIZE_U32];
return HUF_readStats_wksp(huffWeight, hwSize, rankStats, nbSymbolsPtr, tableLogPtr, src, srcSize, wksp, sizeof(wksp), /* flags */ 0);
}
FORCE_INLINE_TEMPLATE size_t
HUF_readStats_body(BYTE* huffWeight, size_t hwSize, U32* rankStats,
U32* nbSymbolsPtr, U32* tableLogPtr,
const void* src, size_t srcSize,
void* workSpace, size_t wkspSize,
int bmi2)
{
U32 weightTotal;
const BYTE* ip = (const BYTE*) src;
size_t iSize;
size_t oSize;
if (!srcSize) return ERROR(srcSize_wrong);
iSize = ip[0];
/* ZSTD_memset(huffWeight, 0, hwSize); *//* is not necessary, even though some analyzer complain ... */
if (iSize >= 128) { /* special header */
oSize = iSize - 127;
iSize = ((oSize+1)/2);
if (iSize+1 > srcSize) return ERROR(srcSize_wrong);
if (oSize >= hwSize) return ERROR(corruption_detected);
ip += 1;
{ U32 n;
for (n=0; n<oSize; n+=2) {
huffWeight[n] = ip[n/2] >> 4;
huffWeight[n+1] = ip[n/2] & 15;
} } }
else { /* header compressed with FSE (normal case) */
if (iSize+1 > srcSize) return ERROR(srcSize_wrong);
/* max (hwSize-1) values decoded, as last one is implied */
oSize = FSE_decompress_wksp_bmi2(huffWeight, hwSize-1, ip+1, iSize, 6, workSpace, wkspSize, bmi2);
if (FSE_isError(oSize)) return oSize;
}
/* collect weight stats */
ZSTD_memset(rankStats, 0, (HUF_TABLELOG_MAX + 1) * sizeof(U32));
weightTotal = 0;
{ U32 n; for (n=0; n<oSize; n++) {
if (huffWeight[n] > HUF_TABLELOG_MAX) return ERROR(corruption_detected);
rankStats[huffWeight[n]]++;
weightTotal += (1 << huffWeight[n]) >> 1;
} }
if (weightTotal == 0) return ERROR(corruption_detected);
/* get last non-null symbol weight (implied, total must be 2^n) */
{ U32 const tableLog = ZSTD_highbit32(weightTotal) + 1;
if (tableLog > HUF_TABLELOG_MAX) return ERROR(corruption_detected);
*tableLogPtr = tableLog;
/* determine last weight */
{ U32 const total = 1 << tableLog;
U32 const rest = total - weightTotal;
U32 const verif = 1 << ZSTD_highbit32(rest);
U32 const lastWeight = ZSTD_highbit32(rest) + 1;
if (verif != rest) return ERROR(corruption_detected); /* last value must be a clean power of 2 */
huffWeight[oSize] = (BYTE)lastWeight;
rankStats[lastWeight]++;
} }
/* check tree construction validity */
if ((rankStats[1] < 2) || (rankStats[1] & 1)) return ERROR(corruption_detected); /* by construction : at least 2 elts of rank 1, must be even */
/* results */
*nbSymbolsPtr = (U32)(oSize+1);
return iSize+1;
}
/* Avoids the FORCE_INLINE of the _body() function. */
static size_t HUF_readStats_body_default(BYTE* huffWeight, size_t hwSize, U32* rankStats,
U32* nbSymbolsPtr, U32* tableLogPtr,
const void* src, size_t srcSize,
void* workSpace, size_t wkspSize)
{
return HUF_readStats_body(huffWeight, hwSize, rankStats, nbSymbolsPtr, tableLogPtr, src, srcSize, workSpace, wkspSize, 0);
}
#if DYNAMIC_BMI2
static BMI2_TARGET_ATTRIBUTE size_t HUF_readStats_body_bmi2(BYTE* huffWeight, size_t hwSize, U32* rankStats,
U32* nbSymbolsPtr, U32* tableLogPtr,
const void* src, size_t srcSize,
void* workSpace, size_t wkspSize)
{
return HUF_readStats_body(huffWeight, hwSize, rankStats, nbSymbolsPtr, tableLogPtr, src, srcSize, workSpace, wkspSize, 1);
}
#endif
size_t HUF_readStats_wksp(BYTE* huffWeight, size_t hwSize, U32* rankStats,
U32* nbSymbolsPtr, U32* tableLogPtr,
const void* src, size_t srcSize,
void* workSpace, size_t wkspSize,
int flags)
{
#if DYNAMIC_BMI2
if (flags & HUF_flags_bmi2) {
return HUF_readStats_body_bmi2(huffWeight, hwSize, rankStats, nbSymbolsPtr, tableLogPtr, src, srcSize, workSpace, wkspSize);
}
#endif
(void)flags;
return HUF_readStats_body_default(huffWeight, hwSize, rankStats, nbSymbolsPtr, tableLogPtr, src, srcSize, workSpace, wkspSize);
}
/* Implementation moved to Rust (rust/src/entropy_common.rs) */
lib/common/fse_decompress.c
+1 -312
View File
@@ -1,315 +1,4 @@
/* ******************************************************************
* FSE : Finite State Entropy decoder
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* You can contact the author at :
* - FSE source repository : https://github.com/Cyan4973/FiniteStateEntropy
* - Public forum : https://groups.google.com/forum/#!forum/lz4c
*
* 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.
****************************************************************** */
/* **************************************************************
* Includes
****************************************************************/
#include "debug.h" /* assert */
#include "bitstream.h"
#include "compiler.h"
#define FSE_STATIC_LINKING_ONLY
#include "fse.h"
#include "error_private.h"
#include "zstd_deps.h" /* ZSTD_memcpy */
#include "bits.h" /* ZSTD_highbit32 */
/* **************************************************************
* Error Management
****************************************************************/
#define FSE_isError ERR_isError
#define FSE_STATIC_ASSERT(c) DEBUG_STATIC_ASSERT(c) /* use only *after* variable declarations */
/* **************************************************************
* Templates
****************************************************************/
/*
designed to be included
for type-specific functions (template emulation in C)
Objective is to write these functions only once, for improved maintenance
*/
/* safety checks */
#ifndef FSE_FUNCTION_EXTENSION
# error "FSE_FUNCTION_EXTENSION must be defined"
#endif
#ifndef FSE_FUNCTION_TYPE
# error "FSE_FUNCTION_TYPE must be defined"
#endif
/* Function names */
#define FSE_CAT(X,Y) X##Y
#define FSE_FUNCTION_NAME(X,Y) FSE_CAT(X,Y)
#define FSE_TYPE_NAME(X,Y) FSE_CAT(X,Y)
static size_t FSE_buildDTable_internal(FSE_DTable* dt, const short* normalizedCounter, unsigned maxSymbolValue, unsigned tableLog, void* workSpace, size_t wkspSize)
{
void* const tdPtr = dt+1; /* because *dt is unsigned, 32-bits aligned on 32-bits */
FSE_DECODE_TYPE* const tableDecode = (FSE_DECODE_TYPE*) (tdPtr);
U16* symbolNext = (U16*)workSpace;
BYTE* spread = (BYTE*)(symbolNext + maxSymbolValue + 1);
U32 const maxSV1 = maxSymbolValue + 1;
U32 const tableSize = 1 << tableLog;
U32 highThreshold = tableSize-1;
/* Sanity Checks */
if (FSE_BUILD_DTABLE_WKSP_SIZE(tableLog, maxSymbolValue) > wkspSize) return ERROR(maxSymbolValue_tooLarge);
if (maxSymbolValue > FSE_MAX_SYMBOL_VALUE) return ERROR(maxSymbolValue_tooLarge);
if (tableLog > FSE_MAX_TABLELOG) return ERROR(tableLog_tooLarge);
/* Init, lay down lowprob symbols */
{ FSE_DTableHeader DTableH;
DTableH.tableLog = (U16)tableLog;
DTableH.fastMode = 1;
{ S16 const largeLimit= (S16)(1 << (tableLog-1));
U32 s;
for (s=0; s<maxSV1; s++) {
if (normalizedCounter[s]==-1) {
tableDecode[highThreshold--].symbol = (FSE_FUNCTION_TYPE)s;
symbolNext[s] = 1;
} else {
if (normalizedCounter[s] >= largeLimit) DTableH.fastMode=0;
symbolNext[s] = (U16)normalizedCounter[s];
} } }
ZSTD_memcpy(dt, &DTableH, sizeof(DTableH));
}
/* Spread symbols */
if (highThreshold == tableSize - 1) {
size_t const tableMask = tableSize-1;
size_t const step = FSE_TABLESTEP(tableSize);
/* First lay down the symbols in order.
* We use a uint64_t to lay down 8 bytes at a time. This reduces branch
* misses since small blocks generally have small table logs, so nearly
* all symbols have counts <= 8. We ensure we have 8 bytes at the end of
* our buffer to handle the over-write.
*/
{ U64 const add = 0x0101010101010101ull;
size_t pos = 0;
U64 sv = 0;
U32 s;
for (s=0; s<maxSV1; ++s, sv += add) {
int i;
int const n = normalizedCounter[s];
MEM_write64(spread + pos, sv);
for (i = 8; i < n; i += 8) {
MEM_write64(spread + pos + i, sv);
}
pos += (size_t)n;
} }
/* Now we spread those positions across the table.
* The benefit of doing it in two stages is that we avoid the
* variable size inner loop, which caused lots of branch misses.
* Now we can run through all the positions without any branch misses.
* We unroll the loop twice, since that is what empirically worked best.
*/
{
size_t position = 0;
size_t s;
size_t const unroll = 2;
assert(tableSize % unroll == 0); /* FSE_MIN_TABLELOG is 5 */
for (s = 0; s < (size_t)tableSize; s += unroll) {
size_t u;
for (u = 0; u < unroll; ++u) {
size_t const uPosition = (position + (u * step)) & tableMask;
tableDecode[uPosition].symbol = spread[s + u];
}
position = (position + (unroll * step)) & tableMask;
}
assert(position == 0);
}
} else {
U32 const tableMask = tableSize-1;
U32 const step = FSE_TABLESTEP(tableSize);
U32 s, position = 0;
for (s=0; s<maxSV1; s++) {
int i;
for (i=0; i<normalizedCounter[s]; i++) {
tableDecode[position].symbol = (FSE_FUNCTION_TYPE)s;
position = (position + step) & tableMask;
while (position > highThreshold) position = (position + step) & tableMask; /* lowprob area */
} }
if (position!=0) return ERROR(GENERIC); /* position must reach all cells once, otherwise normalizedCounter is incorrect */
}
/* Build Decoding table */
{ U32 u;
for (u=0; u<tableSize; u++) {
FSE_FUNCTION_TYPE const symbol = (FSE_FUNCTION_TYPE)(tableDecode[u].symbol);
U32 const nextState = symbolNext[symbol]++;
tableDecode[u].nbBits = (BYTE) (tableLog - ZSTD_highbit32(nextState) );
tableDecode[u].newState = (U16) ( (nextState << tableDecode[u].nbBits) - tableSize);
} }
return 0;
}
size_t FSE_buildDTable_wksp(FSE_DTable* dt, const short* normalizedCounter, unsigned maxSymbolValue, unsigned tableLog, void* workSpace, size_t wkspSize)
{
return FSE_buildDTable_internal(dt, normalizedCounter, maxSymbolValue, tableLog, workSpace, wkspSize);
}
#ifndef FSE_COMMONDEFS_ONLY
/*-*******************************************************
* Decompression (Byte symbols)
*********************************************************/
FORCE_INLINE_TEMPLATE size_t FSE_decompress_usingDTable_generic(
void* dst, size_t maxDstSize,
const void* cSrc, size_t cSrcSize,
const FSE_DTable* dt, const unsigned fast)
{
BYTE* const ostart = (BYTE*) dst;
BYTE* op = ostart;
BYTE* const omax = op + maxDstSize;
BYTE* const olimit = omax-3;
BIT_DStream_t bitD;
FSE_DState_t state1;
FSE_DState_t state2;
/* Init */
CHECK_F(BIT_initDStream(&bitD, cSrc, cSrcSize));
FSE_initDState(&state1, &bitD, dt);
FSE_initDState(&state2, &bitD, dt);
RETURN_ERROR_IF(BIT_reloadDStream(&bitD)==BIT_DStream_overflow, corruption_detected, "");
#define FSE_GETSYMBOL(statePtr) fast ? FSE_decodeSymbolFast(statePtr, &bitD) : FSE_decodeSymbol(statePtr, &bitD)
/* 4 symbols per loop */
for ( ; (BIT_reloadDStream(&bitD)==BIT_DStream_unfinished) & (op<olimit) ; op+=4) {
op[0] = FSE_GETSYMBOL(&state1);
if (FSE_MAX_TABLELOG*2+7 > sizeof(bitD.bitContainer)*8) /* This test must be static */
BIT_reloadDStream(&bitD);
op[1] = FSE_GETSYMBOL(&state2);
if (FSE_MAX_TABLELOG*4+7 > sizeof(bitD.bitContainer)*8) /* This test must be static */
{ if (BIT_reloadDStream(&bitD) > BIT_DStream_unfinished) { op+=2; break; } }
op[2] = FSE_GETSYMBOL(&state1);
if (FSE_MAX_TABLELOG*2+7 > sizeof(bitD.bitContainer)*8) /* This test must be static */
BIT_reloadDStream(&bitD);
op[3] = FSE_GETSYMBOL(&state2);
}
/* tail */
/* note : BIT_reloadDStream(&bitD) >= FSE_DStream_partiallyFilled; Ends at exactly BIT_DStream_completed */
while (1) {
if (op>(omax-2)) return ERROR(dstSize_tooSmall);
*op++ = FSE_GETSYMBOL(&state1);
if (BIT_reloadDStream(&bitD)==BIT_DStream_overflow) {
*op++ = FSE_GETSYMBOL(&state2);
break;
}
if (op>(omax-2)) return ERROR(dstSize_tooSmall);
*op++ = FSE_GETSYMBOL(&state2);
if (BIT_reloadDStream(&bitD)==BIT_DStream_overflow) {
*op++ = FSE_GETSYMBOL(&state1);
break;
} }
assert(op >= ostart);
return (size_t)(op-ostart);
}
typedef struct {
short ncount[FSE_MAX_SYMBOL_VALUE + 1];
} FSE_DecompressWksp;
FORCE_INLINE_TEMPLATE size_t FSE_decompress_wksp_body(
void* dst, size_t dstCapacity,
const void* cSrc, size_t cSrcSize,
unsigned maxLog, void* workSpace, size_t wkspSize,
int bmi2)
{
const BYTE* const istart = (const BYTE*)cSrc;
const BYTE* ip = istart;
unsigned tableLog;
unsigned maxSymbolValue = FSE_MAX_SYMBOL_VALUE;
FSE_DecompressWksp* const wksp = (FSE_DecompressWksp*)workSpace;
size_t const dtablePos = sizeof(FSE_DecompressWksp) / sizeof(FSE_DTable);
FSE_DTable* const dtable = (FSE_DTable*)workSpace + dtablePos;
FSE_STATIC_ASSERT((FSE_MAX_SYMBOL_VALUE + 1) % 2 == 0);
if (wkspSize < sizeof(*wksp)) return ERROR(GENERIC);
/* correct offset to dtable depends on this property */
FSE_STATIC_ASSERT(sizeof(FSE_DecompressWksp) % sizeof(FSE_DTable) == 0);
/* normal FSE decoding mode */
{ size_t const NCountLength =
FSE_readNCount_bmi2(wksp->ncount, &maxSymbolValue, &tableLog, istart, cSrcSize, bmi2);
if (FSE_isError(NCountLength)) return NCountLength;
if (tableLog > maxLog) return ERROR(tableLog_tooLarge);
assert(NCountLength <= cSrcSize);
ip += NCountLength;
cSrcSize -= NCountLength;
}
if (FSE_DECOMPRESS_WKSP_SIZE(tableLog, maxSymbolValue) > wkspSize) return ERROR(tableLog_tooLarge);
assert(sizeof(*wksp) + FSE_DTABLE_SIZE(tableLog) <= wkspSize);
workSpace = (BYTE*)workSpace + sizeof(*wksp) + FSE_DTABLE_SIZE(tableLog);
wkspSize -= sizeof(*wksp) + FSE_DTABLE_SIZE(tableLog);
CHECK_F( FSE_buildDTable_internal(dtable, wksp->ncount, maxSymbolValue, tableLog, workSpace, wkspSize) );
{
const void* ptr = dtable;
const FSE_DTableHeader* DTableH = (const FSE_DTableHeader*)ptr;
const U32 fastMode = DTableH->fastMode;
/* select fast mode (static) */
if (fastMode) return FSE_decompress_usingDTable_generic(dst, dstCapacity, ip, cSrcSize, dtable, 1);
return FSE_decompress_usingDTable_generic(dst, dstCapacity, ip, cSrcSize, dtable, 0);
}
}
/* Avoids the FORCE_INLINE of the _body() function. */
static size_t FSE_decompress_wksp_body_default(void* dst, size_t dstCapacity, const void* cSrc, size_t cSrcSize, unsigned maxLog, void* workSpace, size_t wkspSize)
{
return FSE_decompress_wksp_body(dst, dstCapacity, cSrc, cSrcSize, maxLog, workSpace, wkspSize, 0);
}
#if DYNAMIC_BMI2
BMI2_TARGET_ATTRIBUTE static size_t FSE_decompress_wksp_body_bmi2(void* dst, size_t dstCapacity, const void* cSrc, size_t cSrcSize, unsigned maxLog, void* workSpace, size_t wkspSize)
{
return FSE_decompress_wksp_body(dst, dstCapacity, cSrc, cSrcSize, maxLog, workSpace, wkspSize, 1);
}
#endif
size_t FSE_decompress_wksp_bmi2(void* dst, size_t dstCapacity, const void* cSrc, size_t cSrcSize, unsigned maxLog, void* workSpace, size_t wkspSize, int bmi2)
{
#if DYNAMIC_BMI2
if (bmi2) {
return FSE_decompress_wksp_body_bmi2(dst, dstCapacity, cSrc, cSrcSize, maxLog, workSpace, wkspSize);
}
#endif
(void)bmi2;
return FSE_decompress_wksp_body_default(dst, dstCapacity, cSrc, cSrcSize, maxLog, workSpace, wkspSize);
}
#endif /* FSE_COMMONDEFS_ONLY */
/* Implementation moved to Rust (rust/src/fse_decompress.rs). */
rust/README.md
+8 -4
View File
@@ -17,10 +17,14 @@ zstd ABI:
- `errors`, `debug`, `xxhash`, and `zstd_common` provide common exported ABI
functions and state.
- `common` contains shared frame constants and internal data types.
All entropy coding, compression, decompression, dictionary, legacy, runtime,
and CLI translation units are still C at this initial stage. They must move
before the rewrite is complete. Keeping that boundary explicit prevents a
passing hybrid build from being mistaken for the final all-Rust result.
- Entropy coding
- `entropy_common` reads FSE normalized counts and Huffman statistics.
- `fse_decompress` builds FSE decoding tables and decodes FSE streams.
The remaining compression, general decompression, dictionary, legacy, runtime,
and CLI translation units are still C. They must move before the rewrite is
complete. Keeping that boundary explicit prevents a passing hybrid build from
being mistaken for the final all-Rust result.
## Compatibility boundary
rust/src/entropy_common.rs
+597
View File
@@ -0,0 +1,597 @@
#![allow(non_snake_case)]
use crate::bits::{ZSTD_countTrailingZeros32, ZSTD_highbit32};
use crate::errors::{ERR_getErrorName, ERR_isError, ZstdErrorCode, ERROR};
use crate::mem::{MEM_readLE32, BYTE, U32};
use std::os::raw::{c_char, c_int, c_short, c_uint, c_void};
pub const FSE_VERSION_MAJOR: u32 = 0;
pub const FSE_VERSION_MINOR: u32 = 9;
pub const FSE_VERSION_RELEASE: u32 = 0;
pub const FSE_VERSION_NUMBER: u32 =
FSE_VERSION_MAJOR * 100 * 100 + FSE_VERSION_MINOR * 100 + FSE_VERSION_RELEASE;
pub const FSE_MIN_TABLELOG: u32 = 5;
pub const FSE_TABLELOG_ABSOLUTE_MAX: u32 = 15;
pub const HUF_TABLELOG_MAX: u32 = 12;
pub const HUF_FLAGS_BMI2: c_int = 1 << 0;
// FSE_DECOMPRESS_WKSP_SIZE_U32(6, HUF_TABLELOG_MAX-1) from fse.h / huf.h
const HUF_READ_STATS_WORKSPACE_SIZE_U32: usize = 219;
#[no_mangle]
pub extern "C" fn FSE_versionNumber() -> c_uint {
FSE_VERSION_NUMBER
}
#[no_mangle]
pub extern "C" fn FSE_isError(code: usize) -> c_uint {
ERR_isError(code) as c_uint
}
#[no_mangle]
pub extern "C" fn FSE_getErrorName(code: usize) -> *const c_char {
ERR_getErrorName(code)
}
#[no_mangle]
pub extern "C" fn HUF_isError(code: usize) -> c_uint {
ERR_isError(code) as c_uint
}
#[no_mangle]
pub extern "C" fn HUF_getErrorName(code: usize) -> *const c_char {
ERR_getErrorName(code)
}
fn fse_read_ncount_body(
normalized_counter: *mut c_short,
max_sv_ptr: *mut c_uint,
table_log_ptr: *mut c_uint,
header_buffer: *const c_void,
hb_size: usize,
) -> usize {
unsafe {
if hb_size < 8 {
let mut buffer = [0u8; 8];
if hb_size > 0 {
std::ptr::copy_nonoverlapping(
header_buffer as *const u8,
buffer.as_mut_ptr(),
hb_size,
);
}
let count_size = FSE_readNCount(
normalized_counter,
max_sv_ptr,
table_log_ptr,
buffer.as_ptr() as *const c_void,
buffer.len(),
);
if ERR_isError(count_size) {
return count_size;
}
if count_size > hb_size {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
return count_size;
}
let istart = header_buffer as *const BYTE;
let iend = istart.add(hb_size);
let mut ip = istart;
let max_sv1 = *max_sv_ptr + 1;
// Zero frequency table for all symbols up to maxSVPtr.
std::ptr::write_bytes(normalized_counter, 0, (*max_sv_ptr as usize) + 1);
let mut bit_stream = MEM_readLE32(ip as *const c_void);
let mut nb_bits = ((bit_stream & 0xF) + FSE_MIN_TABLELOG) as i32;
if nb_bits as u32 > FSE_TABLELOG_ABSOLUTE_MAX {
return ERROR(ZstdErrorCode::TableLogTooLarge);
}
bit_stream >>= 4;
let mut bit_count: i32 = 4;
*table_log_ptr = nb_bits as c_uint;
let mut remaining = (1 << nb_bits) + 1;
let mut threshold = 1 << nb_bits;
nb_bits += 1;
let mut charnum: u32 = 0;
let mut previous0 = false;
loop {
if previous0 {
let mut repeats =
(ZSTD_countTrailingZeros32((!bit_stream) | 0x8000_0000) >> 1) as i32;
while repeats >= 12 {
charnum += 3 * 12;
if ip <= iend.sub(7) {
ip = ip.add(3);
} else {
bit_count -= 8 * (iend.offset_from(ip) as i32 - 7);
bit_count &= 31;
ip = iend.sub(4);
}
bit_stream = MEM_readLE32(ip as *const c_void) >> bit_count;
repeats = (ZSTD_countTrailingZeros32((!bit_stream) | 0x8000_0000) >> 1) as i32;
}
charnum += 3 * repeats as u32;
bit_stream >>= 2 * repeats;
bit_count += 2 * repeats;
debug_assert!((bit_stream & 3) < 3);
charnum += bit_stream & 3;
bit_count += 2;
if charnum >= max_sv1 {
break;
}
if ip <= iend.sub(7) || ip.add((bit_count >> 3) as usize) <= iend.sub(4) {
debug_assert!((bit_count >> 3) <= 3);
ip = ip.add((bit_count >> 3) as usize);
bit_count &= 7;
} else {
bit_count -= 8 * (iend.offset_from(ip) as i32 - 4);
bit_count &= 31;
ip = iend.sub(4);
}
bit_stream = MEM_readLE32(ip as *const c_void) >> bit_count;
}
{
let max = (2 * threshold - 1) - remaining;
let mut count: i32;
if (bit_stream & ((threshold as u32) - 1)) < max as u32 {
count = (bit_stream & ((threshold as u32) - 1)) as i32;
bit_count += nb_bits - 1;
} else {
count = (bit_stream & ((2 * threshold as u32) - 1)) as i32;
if count >= threshold {
count -= max;
}
bit_count += nb_bits;
}
count -= 1;
if count >= 0 {
remaining -= count;
} else {
debug_assert!(count == -1);
remaining += count;
}
*normalized_counter.add(charnum as usize) = count as c_short;
charnum += 1;
previous0 = count == 0;
debug_assert!(threshold > 1);
if remaining < threshold {
if remaining <= 1 {
break;
}
nb_bits = ZSTD_highbit32(remaining as u32) as i32 + 1;
threshold = 1 << (nb_bits - 1);
}
if charnum >= max_sv1 {
break;
}
if ip <= iend.sub(7) || ip.add((bit_count >> 3) as usize) <= iend.sub(4) {
ip = ip.add((bit_count >> 3) as usize);
bit_count &= 7;
} else {
bit_count -= 8 * (iend.offset_from(ip) as i32 - 4);
bit_count &= 31;
ip = iend.sub(4);
}
bit_stream = MEM_readLE32(ip as *const c_void) >> bit_count;
}
}
if remaining != 1 {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
if charnum > max_sv1 {
return ERROR(ZstdErrorCode::MaxSymbolValueTooSmall);
}
if bit_count > 32 {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
*max_sv_ptr = charnum - 1;
ip = ip.add(((bit_count + 7) >> 3) as usize);
ip.offset_from(istart) as usize
}
}
#[no_mangle]
pub unsafe extern "C" fn FSE_readNCount_bmi2(
normalized_counter: *mut c_short,
max_sv_ptr: *mut c_uint,
table_log_ptr: *mut c_uint,
header_buffer: *const c_void,
hb_size: usize,
_bmi2: c_int,
) -> usize {
fse_read_ncount_body(
normalized_counter,
max_sv_ptr,
table_log_ptr,
header_buffer,
hb_size,
)
}
#[no_mangle]
pub unsafe extern "C" fn FSE_readNCount(
normalized_counter: *mut c_short,
max_sv_ptr: *mut c_uint,
table_log_ptr: *mut c_uint,
header_buffer: *const c_void,
hb_size: usize,
) -> usize {
FSE_readNCount_bmi2(
normalized_counter,
max_sv_ptr,
table_log_ptr,
header_buffer,
hb_size,
0,
)
}
#[allow(clippy::too_many_arguments)]
fn huf_read_stats_body(
huff_weight: *mut BYTE,
hw_size: usize,
rank_stats: *mut U32,
nb_symbols_ptr: *mut U32,
table_log_ptr: *mut U32,
src: *const c_void,
src_size: usize,
work_space: *mut c_void,
wksp_size: usize,
bmi2: c_int,
) -> usize {
unsafe {
if src_size == 0 {
return ERROR(ZstdErrorCode::SrcSizeWrong);
}
let mut ip = src as *const BYTE;
let mut i_size = *ip as usize;
let o_size: usize;
if i_size >= 128 {
o_size = i_size - 127;
i_size = o_size.div_ceil(2);
if i_size + 1 > src_size {
return ERROR(ZstdErrorCode::SrcSizeWrong);
}
if o_size >= hw_size {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
ip = ip.add(1);
let mut n = 0usize;
while n < o_size {
*huff_weight.add(n) = *ip.add(n / 2) >> 4;
*huff_weight.add(n + 1) = *ip.add(n / 2) & 15;
n += 2;
}
} else {
if i_size + 1 > src_size {
return ERROR(ZstdErrorCode::SrcSizeWrong);
}
let dec = crate::fse_decompress::FSE_decompress_wksp_bmi2(
huff_weight as *mut c_void,
hw_size - 1,
ip.add(1) as *const c_void,
i_size,
6,
work_space,
wksp_size,
bmi2,
);
if ERR_isError(dec) {
return dec;
}
o_size = dec;
}
std::ptr::write_bytes(rank_stats, 0, (HUF_TABLELOG_MAX as usize) + 1);
let mut weight_total: U32 = 0;
for n in 0..o_size {
let w = *huff_weight.add(n) as U32;
if w > HUF_TABLELOG_MAX {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
*rank_stats.add(w as usize) += 1;
weight_total += (1u32 << w) >> 1;
}
if weight_total == 0 {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
let table_log = ZSTD_highbit32(weight_total) + 1;
if table_log > HUF_TABLELOG_MAX {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
*table_log_ptr = table_log;
{
let total = 1u32 << table_log;
let rest = total - weight_total;
let verif = 1u32 << ZSTD_highbit32(rest);
let last_weight = ZSTD_highbit32(rest) + 1;
if verif != rest {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
*huff_weight.add(o_size) = last_weight as BYTE;
*rank_stats.add(last_weight as usize) += 1;
}
let r1 = *rank_stats.add(1);
if r1 < 2 || (r1 & 1) != 0 {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
*nb_symbols_ptr = (o_size + 1) as U32;
i_size + 1
}
}
#[no_mangle]
pub unsafe extern "C" fn HUF_readStats_wksp(
huff_weight: *mut BYTE,
hw_size: usize,
rank_stats: *mut U32,
nb_symbols_ptr: *mut U32,
table_log_ptr: *mut U32,
src: *const c_void,
src_size: usize,
work_space: *mut c_void,
wksp_size: usize,
flags: c_int,
) -> usize {
let bmi2 = if (flags & HUF_FLAGS_BMI2) != 0 { 1 } else { 0 };
huf_read_stats_body(
huff_weight,
hw_size,
rank_stats,
nb_symbols_ptr,
table_log_ptr,
src,
src_size,
work_space,
wksp_size,
bmi2,
)
}
#[no_mangle]
pub unsafe extern "C" fn HUF_readStats(
huff_weight: *mut BYTE,
hw_size: usize,
rank_stats: *mut U32,
nb_symbols_ptr: *mut U32,
table_log_ptr: *mut U32,
src: *const c_void,
src_size: usize,
) -> usize {
let mut wksp = [0u32; HUF_READ_STATS_WORKSPACE_SIZE_U32];
HUF_readStats_wksp(
huff_weight,
hw_size,
rank_stats,
nb_symbols_ptr,
table_log_ptr,
src,
src_size,
wksp.as_mut_ptr() as *mut c_void,
std::mem::size_of_val(&wksp),
0,
)
}
#[cfg(test)]
mod tests {
use super::*;
fn bytes(hex: &str) -> Vec<u8> {
assert_eq!(hex.len() % 2, 0);
hex.as_bytes()
.chunks_exact(2)
.map(|pair| {
let digit = |byte: u8| match byte {
b'0'..=b'9' => byte - b'0',
b'a'..=b'f' => byte - b'a' + 10,
_ => panic!("invalid hex digit"),
};
(digit(pair[0]) << 4) | digit(pair[1])
})
.collect()
}
#[test]
fn fse_version_matches_public_header() {
assert_eq!(FSE_versionNumber(), 900);
}
#[test]
fn fse_read_ncount_matches_reference_header_and_short_prefix_errors() {
// Written by FSE_writeNCount() in the pristine C implementation.
let header = [0xd1u8, 0x28, 0x4a, 0xa9, 0x7c];
let mut normalized = [0x7fffi16; 7];
let mut max_symbol = 6u32;
let mut table_log = 0u32;
let result = unsafe {
FSE_readNCount(
normalized.as_mut_ptr(),
&mut max_symbol,
&mut table_log,
header.as_ptr() as *const c_void,
header.len(),
)
};
assert_eq!(result, header.len());
assert_eq!(max_symbol, 6);
assert_eq!(table_log, 6);
assert_eq!(normalized, [12, 9, 9, 9, 9, 8, 8]);
for prefix_size in 0..header.len() {
normalized.fill(0x7fff);
max_symbol = 6;
table_log = 0;
let result = unsafe {
FSE_readNCount(
normalized.as_mut_ptr(),
&mut max_symbol,
&mut table_log,
header.as_ptr() as *const c_void,
prefix_size,
)
};
assert_eq!(result, ERROR(ZstdErrorCode::CorruptionDetected));
}
}
#[test]
fn huf_read_stats_decodes_direct_even_weight_header() {
let source = [129u8, 0x11];
let mut weights = [0u8; 4];
let mut ranks = [0u32; HUF_TABLELOG_MAX as usize + 1];
let mut symbols = 0u32;
let mut table_log = 0u32;
let result = unsafe {
HUF_readStats(
weights.as_mut_ptr(),
weights.len(),
ranks.as_mut_ptr(),
&mut symbols,
&mut table_log,
source.as_ptr() as *const c_void,
source.len(),
)
};
assert_eq!(result, source.len());
assert_eq!(symbols, 3);
assert_eq!(table_log, 2);
assert_eq!(&weights[..symbols as usize], &[1, 1, 2]);
assert_eq!(ranks[1], 2);
assert_eq!(ranks[2], 1);
}
#[test]
fn huf_read_stats_decodes_direct_odd_weight_header() {
let source = [128u8, 0x1f];
let mut weights = [0u8; 2];
let mut ranks = [0u32; HUF_TABLELOG_MAX as usize + 1];
let mut symbols = 0u32;
let mut table_log = 0u32;
let result = unsafe {
HUF_readStats(
weights.as_mut_ptr(),
weights.len(),
ranks.as_mut_ptr(),
&mut symbols,
&mut table_log,
source.as_ptr() as *const c_void,
source.len(),
)
};
assert_eq!(result, source.len());
assert_eq!(symbols, 2);
assert_eq!(table_log, 1);
assert_eq!(weights, [1, 1]);
assert_eq!(ranks[1], 2);
}
#[test]
fn huf_read_stats_rejects_empty_truncated_and_invalid_trees() {
let mut weights = [0u8; 4];
let mut ranks = [0u32; HUF_TABLELOG_MAX as usize + 1];
let mut symbols = 0u32;
let mut table_log = 0u32;
let empty = unsafe {
HUF_readStats(
weights.as_mut_ptr(),
weights.len(),
ranks.as_mut_ptr(),
&mut symbols,
&mut table_log,
std::ptr::null(),
0,
)
};
assert_eq!(empty, ERROR(ZstdErrorCode::SrcSizeWrong));
let truncated_source = [130u8, 0x11];
let truncated = unsafe {
HUF_readStats(
weights.as_mut_ptr(),
weights.len(),
ranks.as_mut_ptr(),
&mut symbols,
&mut table_log,
truncated_source.as_ptr() as *const c_void,
truncated_source.len(),
)
};
assert_eq!(truncated, ERROR(ZstdErrorCode::SrcSizeWrong));
let invalid_tree_source = [128u8, 0x20];
let invalid_tree = unsafe {
HUF_readStats(
weights.as_mut_ptr(),
weights.len(),
ranks.as_mut_ptr(),
&mut symbols,
&mut table_log,
invalid_tree_source.as_ptr() as *const c_void,
invalid_tree_source.len(),
)
};
assert_eq!(invalid_tree, ERROR(ZstdErrorCode::CorruptionDetected));
}
#[test]
fn huf_read_stats_decodes_fse_compressed_reference_c_header() {
// Produced by HUF_writeCTable_wksp() from the pristine C implementation.
let source = bytes("181010c4a87a61c89e4674d3cb1ee70281b784d34794aa614a");
let expected_weights = bytes(
"0204060306050404040506030604020606020406030605040404050603060402\
0606020406030605040404050603060401060601040603060504030405060306",
);
let expected_ranks = [0u32, 2, 5, 9, 18, 8, 22, 0, 0, 0, 0, 0, 0];
for flags in [0, HUF_FLAGS_BMI2] {
let mut weights = [0u8; 256];
let mut ranks = [0u32; HUF_TABLELOG_MAX as usize + 1];
let mut symbols = 0u32;
let mut table_log = 0u32;
let mut workspace = [0u32; HUF_READ_STATS_WORKSPACE_SIZE_U32];
let result = unsafe {
HUF_readStats_wksp(
weights.as_mut_ptr(),
weights.len(),
ranks.as_mut_ptr(),
&mut symbols,
&mut table_log,
source.as_ptr() as *const c_void,
source.len(),
workspace.as_mut_ptr() as *mut c_void,
std::mem::size_of_val(&workspace),
flags,
)
};
assert_eq!(result, source.len());
assert_eq!(symbols, expected_weights.len() as u32);
assert_eq!(table_log, 10);
assert_eq!(&weights[..symbols as usize], expected_weights);
assert_eq!(ranks, expected_ranks);
}
}
}
rust/src/fse_decompress.rs
+653
View File
@@ -0,0 +1,653 @@
#![allow(non_snake_case)]
use crate::bits::ZSTD_highbit32;
use crate::bitstream::*;
use crate::errors::{ERR_isError, ZstdErrorCode, ERROR};
use crate::mem::MEM_write64;
use std::os::raw::{c_int, c_uint, c_void};
pub const FSE_MAX_SYMBOL_VALUE: u32 = 255;
pub const FSE_MAX_TABLELOG: u32 = 12;
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct FSE_DTableHeader {
pub tableLog: u16,
pub fastMode: u16,
}
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct FSE_decode_t {
pub newState: u16,
pub symbol: u8,
pub nbBits: u8,
}
/// `FSE_DTable` is an opaque `unsigned` in the C API. Its first word stores
/// `FSE_DTableHeader`, followed by `1 << tableLog` `FSE_decode_t` entries.
#[repr(C, align(4))]
pub struct FSE_DTable {
pub header: FSE_DTableHeader,
}
#[repr(C)]
pub struct FSE_DState_t {
pub state: usize,
pub table: *const c_void,
}
#[repr(C)]
pub struct FSE_DecompressWksp {
pub ncount: [i16; (FSE_MAX_SYMBOL_VALUE + 1) as usize],
}
#[inline]
fn FSE_TABLESTEP(table_size: usize) -> usize {
(table_size >> 1) + (table_size >> 3) + 3
}
#[inline]
fn fse_build_dtable_wksp_size(table_log: u32, max_symbol_value: u32) -> Option<usize> {
let table_size = 1usize.checked_shl(table_log)?;
let symbols_size = 2usize.checked_mul(max_symbol_value as usize + 1)?;
symbols_size.checked_add(table_size)?.checked_add(8)
}
#[inline]
fn fse_dtable_size(table_log: u32) -> Option<usize> {
let table_size = 1usize.checked_shl(table_log)?;
(table_size + 1).checked_mul(std::mem::size_of::<FSE_DTable>())
}
#[inline]
fn fse_decompress_wksp_size(table_log: u32, max_symbol_value: u32) -> Option<usize> {
let dtable_u32 = (1usize.checked_shl(table_log)?).checked_add(1)?;
let build_size = fse_build_dtable_wksp_size(table_log, max_symbol_value)?;
let build_u32 = build_size.checked_add(3)? / 4;
// Keep the extra trailing word from FSE_DECOMPRESS_WKSP_SIZE_U32.
let ncount_u32 = ((FSE_MAX_SYMBOL_VALUE as usize + 1) >> 1) + 1;
dtable_u32
.checked_add(1)?
.checked_add(build_u32)?
.checked_add(ncount_u32)?
.checked_mul(4)
}
unsafe fn FSE_buildDTable_internal(
dt: *mut FSE_DTable,
normalized_counter: *const i16,
max_symbol_value: u32,
table_log: u32,
work_space: *mut c_void,
wksp_size: usize,
) -> usize {
let required_wksp = match fse_build_dtable_wksp_size(table_log, max_symbol_value) {
Some(size) => size,
None => return ERROR(ZstdErrorCode::MaxSymbolValueTooLarge),
};
if required_wksp > wksp_size {
return ERROR(ZstdErrorCode::MaxSymbolValueTooLarge);
}
if max_symbol_value > FSE_MAX_SYMBOL_VALUE {
return ERROR(ZstdErrorCode::MaxSymbolValueTooLarge);
}
if table_log > FSE_MAX_TABLELOG {
return ERROR(ZstdErrorCode::TableLogTooLarge);
}
if table_log == 0 {
return ERROR(ZstdErrorCode::Generic);
}
let table_decode = (dt as *mut u8).add(std::mem::size_of::<FSE_DTable>()) as *mut FSE_decode_t;
let symbol_next = work_space as *mut u16;
let spread = symbol_next.add(max_symbol_value as usize + 1) as *mut u8;
let max_sv1 = max_symbol_value + 1;
let table_size = 1usize << table_log;
let mut high_threshold = table_size - 1;
let mut low_probability_count = 0usize;
let mut fast_mode = 1u16;
let large_limit = (1u32 << (table_log - 1)) as i16;
for symbol in 0..max_sv1 {
let count = *normalized_counter.add(symbol as usize);
if count == -1 {
if low_probability_count == table_size {
return ERROR(ZstdErrorCode::Generic);
}
let target = table_size - 1 - low_probability_count;
(*table_decode.add(target)).symbol = symbol as u8;
*symbol_next.add(symbol as usize) = 1;
low_probability_count += 1;
high_threshold = if low_probability_count == table_size {
usize::MAX
} else {
table_size - 1 - low_probability_count
};
} else {
if count >= large_limit {
fast_mode = 0;
}
*symbol_next.add(symbol as usize) = count as u16;
}
}
std::ptr::write(
dt,
FSE_DTable {
header: FSE_DTableHeader {
tableLog: table_log as u16,
fastMode: fast_mode,
},
},
);
if high_threshold == table_size - 1 {
let table_mask = table_size - 1;
let step = FSE_TABLESTEP(table_size);
let mut pos = 0usize;
let mut repeated_symbol = 0u64;
for symbol in 0..max_sv1 {
let count = *normalized_counter.add(symbol as usize);
if count < 0 {
return ERROR(ZstdErrorCode::Generic);
}
let count = count as usize;
MEM_write64(spread.add(pos) as *mut c_void, repeated_symbol);
for offset in (8..count).step_by(8) {
MEM_write64(spread.add(pos + offset) as *mut c_void, repeated_symbol);
}
pos += count;
repeated_symbol = repeated_symbol.wrapping_add(0x0101_0101_0101_0101);
}
let mut position = 0usize;
for symbol_index in (0..table_size).step_by(2) {
for unroll in 0..2 {
let target = (position + unroll * step) & table_mask;
(*table_decode.add(target)).symbol = *spread.add(symbol_index + unroll);
}
position = (position + 2 * step) & table_mask;
}
debug_assert_eq!(position, 0);
} else {
let table_mask = table_size - 1;
let step = FSE_TABLESTEP(table_size);
let mut position = 0usize;
for symbol in 0..max_sv1 {
let count = *normalized_counter.add(symbol as usize);
for _ in 0..count.max(0) as usize {
(*table_decode.add(position)).symbol = symbol as u8;
position = (position + step) & table_mask;
while position > high_threshold {
position = (position + step) & table_mask;
}
}
}
if position != 0 {
return ERROR(ZstdErrorCode::Generic);
}
}
for index in 0..table_size {
let symbol = (*table_decode.add(index)).symbol;
let next_state_ptr = symbol_next.add(symbol as usize);
let next_state = *next_state_ptr as u32;
*next_state_ptr = (*next_state_ptr).wrapping_add(1);
if next_state == 0 {
return ERROR(ZstdErrorCode::Generic);
}
let nb_bits = table_log - ZSTD_highbit32(next_state);
(*table_decode.add(index)).nbBits = nb_bits as u8;
(*table_decode.add(index)).newState =
((next_state << nb_bits).wrapping_sub(table_size as u32)) as u16;
}
0
}
#[no_mangle]
pub unsafe extern "C" fn FSE_buildDTable_wksp(
dt: *mut FSE_DTable,
normalized_counter: *const i16,
max_symbol_value: c_uint,
table_log: c_uint,
work_space: *mut c_void,
wksp_size: usize,
) -> usize {
FSE_buildDTable_internal(
dt,
normalized_counter,
max_symbol_value,
table_log,
work_space,
wksp_size,
)
}
unsafe fn FSE_initDState(
state: *mut FSE_DState_t,
bit_stream: *mut BIT_DStream_t,
dt: *const FSE_DTable,
) {
(*state).state = BIT_readBits(bit_stream, (*dt).header.tableLog as u32);
BIT_reloadDStream(bit_stream);
(*state).table = dt.add(1) as *const c_void;
}
unsafe fn FSE_decodeSymbol(state: *mut FSE_DState_t, bit_stream: *mut BIT_DStream_t) -> u8 {
let entry = &*((*state).table as *const FSE_decode_t).add((*state).state);
let low_bits = BIT_readBits(bit_stream, entry.nbBits as u32);
(*state).state = entry.newState as usize + low_bits;
entry.symbol
}
unsafe fn FSE_decodeSymbolFast(state: *mut FSE_DState_t, bit_stream: *mut BIT_DStream_t) -> u8 {
let entry = &*((*state).table as *const FSE_decode_t).add((*state).state);
let low_bits = BIT_readBitsFast(bit_stream, entry.nbBits as u32);
(*state).state = entry.newState as usize + low_bits;
entry.symbol
}
#[inline]
unsafe fn fse_decode_symbol(
state: *mut FSE_DState_t,
bit_stream: *mut BIT_DStream_t,
fast: bool,
) -> u8 {
if fast {
FSE_decodeSymbolFast(state, bit_stream)
} else {
FSE_decodeSymbol(state, bit_stream)
}
}
unsafe fn FSE_decompress_usingDTable_generic(
dst: *mut c_void,
max_dst_size: usize,
c_src: *const c_void,
c_src_size: usize,
dt: *const FSE_DTable,
fast: bool,
) -> usize {
let mut bit_stream = std::mem::zeroed::<BIT_DStream_t>();
let init_result = BIT_initDStream(&mut bit_stream, c_src, c_src_size);
if ERR_isError(init_result) {
return init_result;
}
let mut state1 = FSE_DState_t {
state: 0,
table: std::ptr::null(),
};
let mut state2 = FSE_DState_t {
state: 0,
table: std::ptr::null(),
};
FSE_initDState(&mut state1, &mut bit_stream, dt);
FSE_initDState(&mut state2, &mut bit_stream, dt);
if BIT_reloadDStream(&mut bit_stream) == BIT_DStream_status::Overflow {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
let output = dst as *mut u8;
let mut output_pos = 0usize;
while BIT_reloadDStream(&mut bit_stream) == BIT_DStream_status::Unfinished
&& output_pos < max_dst_size.saturating_sub(3)
{
*output.add(output_pos) = fse_decode_symbol(&mut state1, &mut bit_stream, fast);
output_pos += 1;
if FSE_MAX_TABLELOG * 2 + 7 > usize::BITS {
BIT_reloadDStream(&mut bit_stream);
}
*output.add(output_pos) = fse_decode_symbol(&mut state2, &mut bit_stream, fast);
output_pos += 1;
if FSE_MAX_TABLELOG * 4 + 7 > usize::BITS
&& BIT_reloadDStream(&mut bit_stream) != BIT_DStream_status::Unfinished
{
break;
}
*output.add(output_pos) = fse_decode_symbol(&mut state1, &mut bit_stream, fast);
output_pos += 1;
if FSE_MAX_TABLELOG * 2 + 7 > usize::BITS {
BIT_reloadDStream(&mut bit_stream);
}
*output.add(output_pos) = fse_decode_symbol(&mut state2, &mut bit_stream, fast);
output_pos += 1;
}
loop {
if max_dst_size.saturating_sub(output_pos) < 2 {
return ERROR(ZstdErrorCode::DstSizeTooSmall);
}
*output.add(output_pos) = fse_decode_symbol(&mut state1, &mut bit_stream, fast);
output_pos += 1;
if BIT_reloadDStream(&mut bit_stream) == BIT_DStream_status::Overflow {
*output.add(output_pos) = fse_decode_symbol(&mut state2, &mut bit_stream, fast);
output_pos += 1;
break;
}
if max_dst_size.saturating_sub(output_pos) < 2 {
return ERROR(ZstdErrorCode::DstSizeTooSmall);
}
*output.add(output_pos) = fse_decode_symbol(&mut state2, &mut bit_stream, fast);
output_pos += 1;
if BIT_reloadDStream(&mut bit_stream) == BIT_DStream_status::Overflow {
*output.add(output_pos) = fse_decode_symbol(&mut state1, &mut bit_stream, fast);
output_pos += 1;
break;
}
}
output_pos
}
#[allow(clippy::too_many_arguments)]
unsafe fn FSE_decompress_wksp_body(
dst: *mut c_void,
dst_capacity: usize,
c_src: *const c_void,
mut c_src_size: usize,
max_log: u32,
work_space: *mut c_void,
wksp_size: usize,
bmi2: c_int,
) -> usize {
if wksp_size < std::mem::size_of::<FSE_DecompressWksp>() {
return ERROR(ZstdErrorCode::Generic);
}
let input_start = c_src as *const u8;
let wksp = work_space as *mut FSE_DecompressWksp;
let dtable =
(work_space as *mut u8).add(std::mem::size_of::<FSE_DecompressWksp>()) as *mut FSE_DTable;
let mut table_log = 0u32;
let mut max_symbol_value = FSE_MAX_SYMBOL_VALUE;
let ncount_length = crate::entropy_common::FSE_readNCount_bmi2(
(*wksp).ncount.as_mut_ptr(),
&mut max_symbol_value,
&mut table_log,
c_src,
c_src_size,
bmi2,
);
if ERR_isError(ncount_length) {
return ncount_length;
}
if table_log > max_log {
return ERROR(ZstdErrorCode::TableLogTooLarge);
}
if ncount_length > c_src_size {
return ERROR(ZstdErrorCode::CorruptionDetected);
}
let required_size = match fse_decompress_wksp_size(table_log, max_symbol_value) {
Some(size) => size,
None => return ERROR(ZstdErrorCode::TableLogTooLarge),
};
if required_size > wksp_size {
return ERROR(ZstdErrorCode::TableLogTooLarge);
}
let dtable_size = fse_dtable_size(table_log).expect("validated FSE table dimensions fit usize");
let build_offset = std::mem::size_of::<FSE_DecompressWksp>() + dtable_size;
let build_workspace = (work_space as *mut u8).add(build_offset) as *mut c_void;
let build_workspace_size = wksp_size - build_offset;
let build_result = FSE_buildDTable_internal(
dtable,
(*wksp).ncount.as_ptr(),
max_symbol_value,
table_log,
build_workspace,
build_workspace_size,
);
if ERR_isError(build_result) {
return build_result;
}
let payload = input_start.add(ncount_length);
c_src_size -= ncount_length;
FSE_decompress_usingDTable_generic(
dst,
dst_capacity,
payload as *const c_void,
c_src_size,
dtable,
(*dtable).header.fastMode != 0,
)
}
#[no_mangle]
pub unsafe extern "C" fn FSE_decompress_wksp_bmi2(
dst: *mut c_void,
dst_capacity: usize,
c_src: *const c_void,
c_src_size: usize,
max_log: c_uint,
work_space: *mut c_void,
wksp_size: usize,
bmi2: c_int,
) -> usize {
FSE_decompress_wksp_body(
dst,
dst_capacity,
c_src,
c_src_size,
max_log,
work_space,
wksp_size,
bmi2,
)
}
#[cfg(test)]
mod tests {
use super::*;
fn dtable_storage(table_log: u32) -> Vec<u32> {
vec![0; 1 + (1usize << table_log)]
}
fn bytes(hex: &str) -> Vec<u8> {
assert_eq!(hex.len() % 2, 0);
hex.as_bytes()
.chunks_exact(2)
.map(|pair| {
let digit = |byte: u8| match byte {
b'0'..=b'9' => byte - b'0',
b'a'..=b'f' => byte - b'a' + 10,
_ => panic!("invalid hex digit"),
};
(digit(pair[0]) << 4) | digit(pair[1])
})
.collect()
}
fn decompress(compressed: &[u8], capacity: usize) -> (usize, Vec<u8>) {
let mut output = vec![0u8; capacity];
let mut workspace = vec![0u32; 6000];
let result = unsafe {
FSE_decompress_wksp_bmi2(
output.as_mut_ptr() as *mut c_void,
output.len(),
compressed.as_ptr() as *const c_void,
compressed.len(),
FSE_MAX_TABLELOG,
workspace.as_mut_ptr() as *mut c_void,
workspace.len() * 4,
0,
)
};
(result, output)
}
#[test]
fn abi_layout_matches_fse_h() {
assert_eq!(std::mem::size_of::<FSE_DTable>(), 4);
assert_eq!(std::mem::align_of::<FSE_DTable>(), 4);
assert_eq!(std::mem::size_of::<FSE_decode_t>(), 4);
assert_eq!(std::mem::size_of::<FSE_DecompressWksp>(), 512);
}
#[test]
fn build_dtable_advances_each_symbol_state() {
let normalized = [8i16, 8, 8, 8];
let mut table = dtable_storage(5);
let mut workspace = vec![0u32; 64];
let result = unsafe {
FSE_buildDTable_wksp(
table.as_mut_ptr() as *mut FSE_DTable,
normalized.as_ptr(),
3,
5,
workspace.as_mut_ptr() as *mut c_void,
workspace.len() * 4,
)
};
assert_eq!(result, 0);
let header = unsafe { &*(table.as_ptr() as *const FSE_DTableHeader) };
assert_eq!(
*header,
FSE_DTableHeader {
tableLog: 5,
fastMode: 1
}
);
let entries = unsafe {
std::slice::from_raw_parts(
table.as_ptr().add(1) as *const FSE_decode_t,
1 << header.tableLog,
)
};
for symbol in 0..4u8 {
let mut states: Vec<u16> = entries
.iter()
.filter(|entry| entry.symbol == symbol)
.map(|entry| {
assert_eq!(entry.nbBits, 2);
entry.newState
})
.collect();
states.sort_unstable();
assert_eq!(states, [0, 4, 8, 12, 16, 20, 24, 28]);
}
}
#[test]
fn build_dtable_places_low_probability_symbols_at_end() {
let normalized = [-1i16, -1, 15, 15];
let mut table = dtable_storage(5);
let mut workspace = vec![0u32; 64];
let result = unsafe {
FSE_buildDTable_wksp(
table.as_mut_ptr() as *mut FSE_DTable,
normalized.as_ptr(),
3,
5,
workspace.as_mut_ptr() as *mut c_void,
workspace.len() * 4,
)
};
assert_eq!(result, 0);
let entries =
unsafe { std::slice::from_raw_parts(table.as_ptr().add(1) as *const FSE_decode_t, 32) };
assert_eq!(entries[31].symbol, 0);
assert_eq!(entries[30].symbol, 1);
assert_eq!(entries[31].nbBits, 5);
assert_eq!(entries[31].newState, 0);
assert_eq!(entries[30].nbBits, 5);
assert_eq!(entries[30].newState, 0);
}
#[test]
fn build_dtable_reports_workspace_and_dimension_errors() {
let normalized = [32i16];
let mut table = dtable_storage(5);
let mut workspace = [0u32; 1];
let too_small = unsafe {
FSE_buildDTable_wksp(
table.as_mut_ptr() as *mut FSE_DTable,
normalized.as_ptr(),
0,
5,
workspace.as_mut_ptr() as *mut c_void,
workspace.len() * 4,
)
};
assert_eq!(too_small, ERROR(ZstdErrorCode::MaxSymbolValueTooLarge));
let mut large_workspace = vec![0u32; 4096];
let table_log_too_large = unsafe {
FSE_buildDTable_wksp(
table.as_mut_ptr() as *mut FSE_DTable,
normalized.as_ptr(),
0,
FSE_MAX_TABLELOG + 1,
large_workspace.as_mut_ptr() as *mut c_void,
large_workspace.len() * 4,
)
};
assert_eq!(table_log_too_large, ERROR(ZstdErrorCode::TableLogTooLarge));
}
#[test]
fn decompression_workspace_size_matches_c_macro() {
assert_eq!(fse_build_dtable_wksp_size(6, 11), Some(96));
assert_eq!(fse_decompress_wksp_size(6, 11), Some(876));
assert_eq!(fse_dtable_size(6), Some(260));
}
#[test]
fn decompresses_balanced_reference_c_stream() {
// Generated by the pristine HEAD implementation using a 257-byte,
// seven-symbol input and FSE_compress_usingCTable().
let compressed = bytes(
"d1284aa97cd5fce4cd4fdefce4cd4fdefce4cd4fdefce4cd4fdefce4cd4fdefc\
e4cd4fdefce4cd4fdefce4cd4fdefce4cd4fdefce4cd4fdefce4cd4fdefce4cd\
4fdefce4cd4fdefce4cd4fdefce4cd4fdefce4cd4fdefce4cd4fdefce4cd4fde\
c415",
);
let expected: Vec<u8> = (0..257).map(|index| (index % 7) as u8).collect();
let (result, output) = decompress(&compressed, expected.len());
assert_eq!(result, expected.len());
assert_eq!(output, expected);
}
#[test]
fn decompresses_skewed_reference_c_stream_and_reports_small_output() {
// Exercises low-probability symbols and the non-fast decode path.
let compressed = bytes(
"0100800c000000003dc2200147143cc008a2061471b400828c42a4a2871844e090\
820e18429481428e2a40a0518858d41103093852e001460835a0c8a1051034142\
20bf00f",
);
let expected: Vec<u8> = (0..511)
.map(|index| {
if index % 10 != 0 {
3
} else {
(index % 17) as u8
}
})
.collect();
let (result, output) = decompress(&compressed, expected.len());
assert_eq!(result, expected.len());
assert_eq!(output, expected);
let (too_small, _) = decompress(&compressed, expected.len() - 1);
assert_eq!(too_small, ERROR(ZstdErrorCode::DstSizeTooSmall));
}
}
rust/src/lib.rs
+2
View File
@@ -5,7 +5,9 @@ pub mod bitstream;
pub mod common;
pub mod cpu;
pub mod debug;
pub mod entropy_common;
pub mod errors;
pub mod fse_decompress;
pub mod mem;
pub mod xxhash;
pub mod zstd_common;