Files

T

fix(build): rebuild C outputs on HUF mode changes

Mode-specific Rust archives exposed the test makefiles' flat C-object cache:
switching from default to forced HUF mode could relink stale default C objects
with a newly built forced Rust archive. That hybrid has incompatible decoder
table expectations and can corrupt dictionary decompression.

Track each makefile's effective HUF mode with an empty archive stamp. It is a
safe normal linker prerequisite, and every mode transition advances its mtime
so cached C objects and direct-source binaries rebuild while unchanged modes
remain incremental.

Test Plan:
- cargo clippy; cargo clippy --benches; cargo clippy --tests
- cargo +nightly fmt, then repeat the Clippy checks
- cargo test --all-targets
- Default -> forced-X1 -> default fuzzer builds without -B, each running
  ./fuzzer -s5346 -i1 --no-big-tests
- Equivalent zstd-small default/forced/default rebuild and --version checks

Refs: rust/README.md
Fixes: d89ebb31

2026-07-10 21:08:14 +02:00

src

feat(rust): port Huffman decompression

2026-07-10 20:48:51 +02:00

Cargo.lock

feat(rust): add common primitive compatibility layer

2026-07-10 20:02:17 +02:00

Cargo.toml

build(rust): select archives by target and HUF mode

2026-07-10 20:46:23 +02:00

README.md

fix(build): rebuild C outputs on HUF mode changes

2026-07-10 21:08:14 +02:00

README.md

Rust rewrite

This directory contains the in-progress Rust replacement for the zstd library and command-line program. During the migration, the crate is built as a static library and linked into the original C test programs. Production C translation units become declaration-only shims as their implementations move to Rust; the original C tests remain unchanged and provide compatibility coverage.

Component map

The crate is organized from low-level representation helpers toward the public zstd ABI:

Common primitives
- mem, bits, bitstream, and cpu implement byte-order, bitstream, and target-feature operations used by the codecs.
- errors, debug, xxhash, and zstd_common provide common exported ABI functions and state.
- common contains shared frame constants and internal data types.
Entropy coding
- entropy_common reads FSE normalized counts and Huffman statistics.
- fse_decompress builds FSE decoding tables and decodes FSE streams.
- fse_compress normalizes counts, writes FSE headers, builds compression tables, and encodes FSE streams.
- huf_decompress builds Huffman decoding tables and decodes X1 and X2 Huffman streams.
Compression primitives
- hist counts byte frequencies for FSE and Huffman compression.
Runtime support
- threading provides platform pthread wrappers required by zstd headers.
- pool implements the bounded worker pool used by multithreaded compression.

The remaining block compression, general decompression, dictionary, legacy, 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

The public ABI continues to come from the existing headers under lib/. Exported Rust functions therefore use C layout and calling conventions. A C source file whose implementation has moved to Rust remains in the original makefile source list as a small shim so header configuration and platform preprocessor behavior stay available during the transition.

The test and program makefiles select an archive directory for the active C configuration: default, forced HUF X1/X2, and the matching Rust target for 32-bit C binaries. When the HUF mode changes, they also rebuild cached C outputs before linking. This prevents original C tests from using a stale or configuration-incompatible implementation.

Validation

Run focused Rust checks from this directory:

cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo test --all-targets
cargo build --release

Then run original compatibility tests from the repository root, starting with the narrow target for the component being migrated. For example:

make -C tests fuzzer
./tests/fuzzer -i1 --no-big-tests

Broader tests/Makefile targets remain the authoritative integration gates as more of the library and CLI are rewritten.