use super::*;
const BTULTRA2_HC_CONFIG: HcConfig = HcConfig {
hash_log: 24,
chain_log: 24,
search_depth: 512,
target_len: 256,
search_mls: 4,
};
const BTULTRA2_HC_CONFIG_L22: HcConfig = HcConfig {
hash_log: 25,
chain_log: 27,
search_depth: 512,
target_len: 999,
search_mls: 4,
};
const BTULTRA2_HC_CONFIG_L22_16K: HcConfig = HcConfig {
hash_log: 15,
chain_log: 15,
search_depth: 1 << 10,
target_len: 999,
search_mls: 4,
};
#[cfg(test)]
impl MatchGeneratorDriver {
pub(crate) fn set_config_override(
&mut self,
search: super::super::strategy::SearchMethod,
parse: super::super::strategy::ParseMode,
) {
self.config_override = Some((search, parse));
}
pub(crate) fn reset_on_hc_lazy(&mut self, level: CompressionLevel) {
self.set_config_override(
super::super::strategy::SearchMethod::HashChain,
super::super::strategy::ParseMode::Lazy2,
);
self.reset(level);
}
}
#[cfg(test)]
fn drive_roundtrip_with_override(
level: CompressionLevel,
over: Option<(
super::super::strategy::SearchMethod,
super::super::strategy::ParseMode,
)>,
data: &[u8],
) -> Vec<u8> {
let mut driver = MatchGeneratorDriver::new(1 << 17, 8);
if let Some((s, p)) = over {
driver.set_config_override(s, p);
}
driver.reset(level);
let mut out: Vec<u8> = Vec::with_capacity(data.len());
let mut offset_in_data = 0usize;
while offset_in_data < data.len() {
let mut space = driver.get_next_space();
let take = (data.len() - offset_in_data).min(space.len());
space[..take].copy_from_slice(&data[offset_in_data..offset_in_data + take]);
space.truncate(take);
driver.commit_space(space);
offset_in_data += take;
driver.start_matching(|seq| match seq {
Sequence::Literals { literals } => out.extend_from_slice(literals),
Sequence::Triple {
literals,
offset,
match_len,
} => {
out.extend_from_slice(literals);
let start = out.len() - offset;
for i in 0..match_len {
let byte = out[start + i];
out.push(byte);
}
}
});
}
out
}
#[test]
fn parse_search_matrix_decoupled_roundtrips() {
use super::super::strategy::{ParseMode, SearchMethod};
let mut data = Vec::new();
for i in 0..4000u32 {
data.extend_from_slice(b"the quick brown fox ");
data.extend_from_slice(&i.to_le_bytes());
}
let got = drive_roundtrip_with_override(
CompressionLevel::Level(5),
Some((SearchMethod::HashChain, ParseMode::Greedy)),
&data,
);
assert_eq!(got, data, "greedy-on-hashchain diverged");
let got = drive_roundtrip_with_override(
CompressionLevel::Level(8),
Some((SearchMethod::RowHash, ParseMode::Lazy2)),
&data,
);
assert_eq!(got, data, "lazy2-on-rowhash diverged");
let got = drive_roundtrip_with_override(
CompressionLevel::Level(6),
Some((SearchMethod::RowHash, ParseMode::Lazy)),
&data,
);
assert_eq!(got, data, "lazy-on-rowhash diverged");
}
#[test]
fn row_mls_knob_gates_matches_and_roundtrips() {
let data: Vec<u8> = (0..4000u32)
.flat_map(|i| {
let mut v = b"abcdefgh".to_vec();
v.extend_from_slice(&i.to_le_bytes());
v
})
.collect();
for mls in [4usize, 5, 6, 7] {
let mut matcher = RowMatchGenerator::new(1 << 22);
let mut cfg = ROW_CONFIG;
cfg.mls = mls;
matcher.configure(cfg);
matcher.add_data(data.clone(), |_| {});
let mut out: Vec<u8> = Vec::with_capacity(data.len());
let mut shortest_match = usize::MAX;
matcher.start_matching(|seq| match seq {
Sequence::Literals { literals } => out.extend_from_slice(literals),
Sequence::Triple {
literals,
offset,
match_len,
} => {
out.extend_from_slice(literals);
shortest_match = shortest_match.min(match_len);
let start = out.len() - offset;
for i in 0..match_len {
let byte = out[start + i];
out.push(byte);
}
}
});
assert_eq!(out, data, "mls={mls} round-trip diverged");
if shortest_match != usize::MAX {
assert!(
shortest_match >= mls,
"mls={mls}: emitted a {shortest_match}-byte match below the floor",
);
}
}
}
#[test]
fn parse_mode_follows_search_axis_not_strategy_tag() {
use super::super::strategy::{ParseMode, SearchMethod};
let mut p = resolve_level_params(CompressionLevel::Level(16), None);
assert_eq!(p.parse(), ParseMode::Optimal, "BinaryTree search → Optimal");
p.search = SearchMethod::RowHash;
p.lazy_depth = 0;
assert_eq!(p.parse(), ParseMode::Greedy, "RowHash + depth 0 → Greedy");
p.lazy_depth = 2;
assert_eq!(p.parse(), ParseMode::Lazy2, "RowHash + depth 2 → Lazy2");
}
#[test]
fn config_override_is_consumed_by_reset() {
use super::super::strategy::{ParseMode, SearchMethod};
let mut driver = MatchGeneratorDriver::new(1 << 17, 8);
driver.set_config_override(SearchMethod::RowHash, ParseMode::Lazy2);
assert!(driver.config_override.is_some());
driver.reset(CompressionLevel::Level(5));
assert!(
driver.config_override.is_none(),
"override must be consumed after one reset",
);
}
#[cfg(test)]
fn l4_greedy_round_trip(slice_size: usize, max_slices: usize, data: &[u8]) -> (usize, usize) {
let mut driver = MatchGeneratorDriver::new(slice_size, max_slices);
driver.reset(CompressionLevel::Level(4));
let mut reconstructed: Vec<u8> = Vec::with_capacity(data.len());
let mut triple_count = 0usize;
let mut max_offset = 0usize;
let mut offset_in_data = 0usize;
while offset_in_data < data.len() {
let mut space = driver.get_next_space();
let space_cap = space.len();
let take = (data.len() - offset_in_data).min(space_cap);
space[..take].copy_from_slice(&data[offset_in_data..offset_in_data + take]);
space.truncate(take);
driver.commit_space(space);
offset_in_data += take;
driver.start_matching(|seq| match seq {
Sequence::Literals { literals } => reconstructed.extend_from_slice(literals),
Sequence::Triple {
literals,
offset,
match_len,
} => {
triple_count += 1;
if offset > max_offset {
max_offset = offset;
}
reconstructed.extend_from_slice(literals);
let start = reconstructed.len() - offset;
for i in 0..match_len {
let byte = reconstructed[start + i];
reconstructed.push(byte);
}
}
});
}
if data.is_empty() {
let mut space = driver.get_next_space();
space.truncate(0);
driver.commit_space(space);
driver.start_matching(|seq| match seq {
Sequence::Literals { literals } => reconstructed.extend_from_slice(literals),
Sequence::Triple { .. } => panic!("empty input must not emit any matches"),
});
}
assert_eq!(reconstructed, data, "L4 greedy round-trip diverged");
(triple_count, max_offset)
}
#[test]
fn driver_level5_greedy_tail_rep_only_reachable() {
let first: &[u8] = b"ABCDABCDABCDABCD"; let second: &[u8] = b"ABCDA"; let mut driver = MatchGeneratorDriver::new(16, 2);
driver.reset(CompressionLevel::Level(5));
let mut first_space = driver.get_next_space();
first_space[..first.len()].copy_from_slice(first);
first_space.truncate(first.len());
driver.commit_space(first_space);
driver.start_matching(|_| {});
let mut second_space = driver.get_next_space();
second_space[..second.len()].copy_from_slice(second);
second_space.truncate(second.len());
driver.commit_space(second_space);
let mut second_slice_triples = 0usize;
driver.start_matching(|seq| {
if matches!(seq, Sequence::Triple { .. }) {
second_slice_triples += 1;
}
});
assert!(
second_slice_triples >= 1,
"tail rep-only position must produce a match in the second slice \
(got {second_slice_triples} triples)",
);
}
#[test]
fn driver_level4_greedy_empty_input_emits_nothing() {
let mut driver = MatchGeneratorDriver::new(64, 2);
driver.reset(CompressionLevel::Level(4));
let mut space = driver.get_next_space();
space.truncate(0);
driver.commit_space(space);
let mut emitted_anything = false;
driver.start_matching(|_| emitted_anything = true);
assert!(!emitted_anything, "empty slice must not emit any sequences",);
}
#[test]
fn driver_level4_greedy_sub_min_lookahead_input() {
let data: &[u8] = b"abcd"; let (triples, _) = l4_greedy_round_trip(64, 2, data);
assert_eq!(
triples, 0,
"sub-min-lookahead input must not emit any matches (got {triples})",
);
}
#[test]
fn driver_level4_greedy_incompressible_input() {
let mut data = alloc::vec::Vec::with_capacity(256);
let mut x: u32 = 0xDEAD_BEEF;
for _ in 0..256 {
x = x.wrapping_mul(1_103_515_245).wrapping_add(12345);
data.push((x >> 16) as u8);
}
let (_triples, _) = l4_greedy_round_trip(64, 8, &data);
}
#[test]
fn driver_level4_greedy_long_literal_run_skip_step_growth() {
let mut data = alloc::vec::Vec::with_capacity(2048);
let mut x: u32 = 0xC0FF_EE00;
for _ in 0..2048 {
x = x.wrapping_mul(0x9E37_79B9).wrapping_add(0xCAFEBABE);
data.push((x >> 24) as u8);
}
let (_triples, _) = l4_greedy_round_trip(512, 8, &data);
}
#[test]
fn driver_level4_greedy_all_zeros_heavy_rep1() {
let data: Vec<u8> = alloc::vec![0u8; 128];
let (triples, max_offset) = l4_greedy_round_trip(64, 8, &data);
assert!(
triples >= 1,
"all-zeros input must produce at least one rep1 match",
);
assert_eq!(
max_offset, 1,
"all-zeros L4 greedy parse should commit at offset 1 (got {max_offset})",
);
}
#[test]
fn driver_level4_greedy_periodic_pattern_rep_cascade() {
let unit: &[u8] = b"alpha_beta_gamma";
assert_eq!(unit.len(), 16);
let mut data: Vec<u8> = Vec::with_capacity(unit.len() * 32);
for _ in 0..32 {
data.extend_from_slice(unit);
}
let (triples, max_offset) = l4_greedy_round_trip(64, 16, &data);
assert!(
triples >= 1,
"periodic 16-byte payload must emit matches (got {triples})",
);
assert!(
max_offset >= 16,
"periodic 16-byte payload must produce at least one offset >= 16 \
(got max_offset = {max_offset})",
);
}
#[test]
fn driver_reset_keeps_strategy_tag_in_sync_with_active_backend() {
use super::super::strategy::StrategyTag;
fn check(level: CompressionLevel, expected: StrategyTag) {
let mut driver = MatchGeneratorDriver::new(32, 2);
driver.reset(level);
assert_eq!(
driver.strategy_tag, expected,
"strategy_tag wrong for {level:?}"
);
assert_eq!(
driver.strategy_tag.backend(),
driver.active_backend(),
"strategy_tag backend disagrees with active_backend for {level:?}"
);
}
check(CompressionLevel::Level(1), StrategyTag::Fast);
check(CompressionLevel::Level(2), StrategyTag::Fast);
check(CompressionLevel::Level(3), StrategyTag::Dfast);
check(CompressionLevel::Level(4), StrategyTag::Dfast);
check(CompressionLevel::Level(5), StrategyTag::Greedy);
check(CompressionLevel::Level(7), StrategyTag::Lazy);
check(CompressionLevel::Level(12), StrategyTag::Lazy);
check(CompressionLevel::Level(13), StrategyTag::Btlazy2);
check(CompressionLevel::Level(14), StrategyTag::Btlazy2);
check(CompressionLevel::Level(15), StrategyTag::Btlazy2);
check(CompressionLevel::Level(16), StrategyTag::BtOpt);
check(CompressionLevel::Level(18), StrategyTag::BtUltra);
check(CompressionLevel::Level(22), StrategyTag::BtUltra2);
check(CompressionLevel::Fastest, StrategyTag::Fast);
check(CompressionLevel::Default, StrategyTag::Dfast);
check(CompressionLevel::Better, StrategyTag::Lazy);
check(CompressionLevel::Best, StrategyTag::Btlazy2);
}
#[test]
fn level_16_17_map_to_btopt_strategy() {
use super::super::strategy::{BackendTag, StrategyTag};
let p16 = resolve_level_params(CompressionLevel::Level(16), None);
let p17 = resolve_level_params(CompressionLevel::Level(17), None);
assert_eq!(p16.backend(), BackendTag::HashChain);
assert_eq!(p17.backend(), BackendTag::HashChain);
assert_eq!(StrategyTag::for_level(16), StrategyTag::BtOpt);
assert_eq!(StrategyTag::for_level(17), StrategyTag::BtOpt);
}
#[test]
fn level_18_maps_to_btultra_level_19_to_btultra2_strategy() {
use super::super::strategy::{BackendTag, StrategyTag};
let p18 = resolve_level_params(CompressionLevel::Level(18), None);
let p19 = resolve_level_params(CompressionLevel::Level(19), None);
assert_eq!(p18.backend(), BackendTag::HashChain);
assert_eq!(p19.backend(), BackendTag::HashChain);
assert_eq!(StrategyTag::for_level(18), StrategyTag::BtUltra);
assert_eq!(StrategyTag::for_level(19), StrategyTag::BtUltra2);
}
#[test]
fn level_20_22_map_to_btultra2_strategy() {
use super::super::strategy::{BackendTag, StrategyTag};
for level in 20..=22 {
let params = resolve_level_params(CompressionLevel::Level(level), None);
assert_eq!(params.backend(), BackendTag::HashChain);
assert_eq!(StrategyTag::for_level(level as u8), StrategyTag::BtUltra2);
}
}
#[test]
fn level22_uses_target_length_and_large_input_tables() {
let params = resolve_level_params(CompressionLevel::Level(22), None);
assert_eq!(params.window_log, 27);
let hc = params.hc.unwrap();
assert_eq!(hc.hash_log, 25);
assert_eq!(hc.chain_log, 27);
assert_eq!(hc.search_depth, 1 << 9);
assert_eq!(hc.target_len, 999);
}
#[test]
fn bt_levels_16_to_21_pin_clevels_params() {
let expected = [
(16u8, 22u8, 22usize, 22usize, 32usize, 48usize),
(17, 23, 22, 23, 32, 64),
(18, 23, 22, 23, 64, 64),
(19, 23, 22, 24, 128, 256),
(20, 25, 23, 25, 128, 256),
(21, 26, 24, 26, 128, 512),
];
for (level, wlog, hlog, clog, sd, tl) in expected {
let p = resolve_level_params(CompressionLevel::Level(level as i32), None);
assert_eq!(p.window_log, wlog, "level {level} window_log");
let hc = p.hc.unwrap();
assert_eq!(hc.hash_log, hlog, "level {level} hash_log");
assert_eq!(hc.chain_log, clog, "level {level} chain_log");
assert_eq!(hc.search_depth, sd, "level {level} search_depth");
assert_eq!(hc.target_len, tl, "level {level} target_len");
}
}
#[test]
fn level22_source_size_hint_uses_btultra2_tiers() {
let p16k = resolve_level_params(CompressionLevel::Level(22), Some(16 * 1024));
assert_eq!(p16k.window_log, 14);
let hc16k = p16k.hc.unwrap();
assert_eq!(hc16k.hash_log, 15);
assert_eq!(hc16k.chain_log, 15);
assert_eq!(hc16k.search_depth, 1 << 10);
assert_eq!(hc16k.target_len, 999);
let p128k = resolve_level_params(CompressionLevel::Level(22), Some(128 * 1024));
assert_eq!(p128k.window_log, 17);
let hc128k = p128k.hc.unwrap();
assert_eq!(hc128k.hash_log, 17);
assert_eq!(hc128k.chain_log, 18);
assert_eq!(hc128k.search_depth, 1 << 11);
assert_eq!(hc128k.target_len, 999);
let p256k = resolve_level_params(CompressionLevel::Level(22), Some(256 * 1024));
assert_eq!(p256k.window_log, 18);
let hc256k = p256k.hc.unwrap();
assert_eq!(hc256k.hash_log, 19);
assert_eq!(hc256k.chain_log, 19);
assert_eq!(hc256k.search_depth, 1 << 13);
assert_eq!(hc256k.target_len, 999);
}
#[test]
fn level22_non_power_of_two_small_source_uses_tier3_params() {
let source_size = 15_027u64;
let params = resolve_level_params(CompressionLevel::Level(22), Some(source_size));
let hc = params.hc.unwrap();
assert_eq!(params.window_log, 14);
assert_eq!(hc.chain_log, 15);
assert_eq!(hc.hash_log, 15);
assert_eq!(hc.search_depth, 1 << 10);
assert_eq!(HC_OPT_MIN_MATCH_LEN, 3);
assert_eq!(hc.target_len, 999);
}
#[test]
fn levels_above_max_resolve_identically_to_max() {
let sizes = [
None,
Some(1024u64),
Some(16 * 1024),
Some(128 * 1024),
Some(1 << 20),
];
for &sz in &sizes {
let at_max = resolve_level_params(CompressionLevel::Level(CompressionLevel::MAX_LEVEL), sz);
for over in [
CompressionLevel::MAX_LEVEL + 1,
CompressionLevel::MAX_LEVEL + 50,
1000,
] {
let clamped = resolve_level_params(CompressionLevel::Level(over), sz);
assert!(
clamped == at_max,
"Level({over}) size {sz:?} must resolve identically to Level(MAX_LEVEL)"
);
}
}
}
#[test]
fn level22_small_source_uses_window_bounded_hash3_log() {
let mut hc = HcMatchGenerator::new(1 << 14);
hc.configure(
BTULTRA2_HC_CONFIG_L22_16K,
super::super::strategy::StrategyTag::BtUltra2,
14,
);
assert_eq!(hc.table.hash3_log, 14);
hc.configure(
BTULTRA2_HC_CONFIG_L22,
super::super::strategy::StrategyTag::BtUltra2,
27,
);
assert_eq!(hc.table.hash3_log, HC3_HASH_LOG);
}
#[test]
fn btultra2_seed_pass_initializes_opt_state() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
let data: Vec<u8> = (0..32 * 1024).map(|i| (i % 251) as u8).collect();
hc.table.add_data(data, |_| {});
hc.start_matching(|_| {});
assert!(
hc.backend.bt_mut().opt_state.lit_length_sum > 0,
"btultra2 first block should seed non-zero sequence statistics"
);
assert!(
hc.backend.bt_mut().opt_state.off_code_sum > 0,
"btultra2 first block should seed offset-code statistics"
);
}
#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
#[test]
fn bt_optimal_all_kernel_tiers_emit_identical_sequences() {
use crate::encoding::Sequence;
use crate::encoding::fastpath::FastpathKernel;
let mut tiers = Vec::new();
tiers.push(FastpathKernel::Scalar);
if std::is_x86_feature_detected!("sse4.2") {
tiers.push(FastpathKernel::Sse42);
}
if std::is_x86_feature_detected!("avx2") && std::is_x86_feature_detected!("bmi2") {
tiers.push(FastpathKernel::Avx2Bmi2);
}
let data: Vec<u8> = (0..48 * 1024)
.map(|i| ((i * 7 + i / 13) % 67) as u8)
.collect();
let run = |tier: FastpathKernel| -> Vec<(usize, usize, usize)> {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
hc.table.add_data(data.clone(), |_| {});
hc.table.kernel = tier;
let mut seqs = Vec::new();
hc.start_matching(|seq| match seq {
Sequence::Triple {
literals,
offset,
match_len,
} => seqs.push((literals.len(), offset, match_len)),
Sequence::Literals { literals } => seqs.push((literals.len(), 0, 0)),
});
seqs
};
let reference = run(tiers[0]);
assert!(
!reference.is_empty(),
"btultra2 should emit sequences on mixed-redundancy input"
);
for &tier in &tiers[1..] {
assert_eq!(
run(tier),
reference,
"kernel tier {tier:?} diverged from {:?}: scalar/SIMD bit-identity broken",
tiers[0],
);
}
}
#[test]
fn level_params_strategy_and_search_method_agree_across_tiers() {
use super::super::strategy::{SearchMethod, StrategyTag};
let sizes = [
Some(1024u64),
Some(16 * 1024),
Some(128 * 1024),
Some(256 * 1024),
Some(8 << 20),
None,
];
let mut seen: Vec<StrategyTag> = Vec::new();
for lvl in 1..=22i32 {
for &sz in &sizes {
let p = resolve_level_params(CompressionLevel::Level(lvl), sz);
let consistent = match p.strategy_tag {
StrategyTag::Fast => p.search == SearchMethod::Fast,
StrategyTag::Dfast => p.search == SearchMethod::DoubleFast,
StrategyTag::Greedy | StrategyTag::Lazy => p.search == SearchMethod::RowHash,
StrategyTag::Btlazy2
| StrategyTag::BtOpt
| StrategyTag::BtUltra
| StrategyTag::BtUltra2 => p.search == SearchMethod::BinaryTree,
};
assert!(
consistent,
"level {lvl} size {sz:?}: strategy {:?} paired with search {:?}",
p.strategy_tag, p.search
);
if !seen.contains(&p.strategy_tag) {
seen.push(p.strategy_tag);
}
}
}
assert!(
seen.len() >= 4,
"level/size matrix only reached {} strategy arms: {seen:?}",
seen.len()
);
}
#[test]
fn btultra2_profile_disables_small_offset_handicap() {
let profile = HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra2>();
assert!(
!profile.favor_small_offsets,
"btultra2 should match upstream zstd opt2 offset pricing"
);
assert!(
profile.accurate,
"btultra2 should use upstream zstd opt2 accurate pricing"
);
}
#[test]
fn btultra_profile_keeps_search_depth_budget() {
let p = HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra>();
assert_eq!(
p.max_chain_depth, 64,
"btultra chain-depth budget must match clevels.h level 18 searchLog 6 (1 << 6 = 64)"
);
}
#[test]
fn btopt_profile_keeps_search_depth_budget() {
let p = HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtOpt>();
assert_eq!(
p.max_chain_depth, 32,
"btopt should not cap chain depth below upstream zstd btopt search budget"
);
}
#[test]
fn sufficient_match_len_is_clamped_by_target_len() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
hc.hc.target_len = 13;
let profile = HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra2>();
assert_eq!(hc.hc.sufficient_match_len_for_pass(profile), 13);
}
#[test]
fn opt_modes_use_target_len_as_sufficient_len() {
use super::super::strategy;
let mut hc = HcMatchGenerator::new(1 << 20);
hc.hc.target_len = 57;
let profiles = [
HcOptimalCostProfile::const_for_strategy::<strategy::BtOpt>(),
HcOptimalCostProfile::const_for_strategy::<strategy::BtUltra>(),
HcOptimalCostProfile::const_for_strategy::<strategy::BtUltra2>(),
];
for profile in profiles {
assert_eq!(hc.hc.sufficient_match_len_for_pass(profile), 57);
}
}
#[test]
fn sufficient_match_len_is_capped_by_opt_num() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.hc.target_len = usize::MAX / 2;
let profile = HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra2>();
assert_eq!(hc.hc.sufficient_match_len_for_pass(profile), HC_OPT_NUM - 1);
}
#[test]
#[allow(clippy::borrow_deref_ref)]
fn dictionary_entropy_seed_initializes_opt_state_from_tables() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
let huff = crate::huff0::huff0_encoder::HuffmanTable::build_from_data(
b"aaabbbbccccddddeeeeefffffgggg",
);
let ll = crate::fse::fse_encoder::default_ll_table();
let ml = crate::fse::fse_encoder::default_ml_table();
let of = crate::fse::fse_encoder::default_of_table();
hc.seed_dictionary_entropy(Some(&huff), Some(&*ll), Some(&*ml), Some(&*of));
hc.backend.bt_mut().opt_state.rescale_freqs(
b"abcd",
HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra2>(),
);
let base_ll_freqs: [u32; HC_MAX_LL + 1] = [
4, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1,
];
assert_ne!(
hc.backend.bt_mut().opt_state.lit_length_freq,
base_ll_freqs,
"dictionary entropy should override fallback LL bootstrap frequencies"
);
assert!(
hc.backend
.bt_mut()
.opt_state
.match_length_freq
.iter()
.any(|&v| v != 1),
"dictionary entropy should seed non-uniform ML frequencies"
);
assert_ne!(
hc.backend.bt_mut().opt_state.off_code_freq[0],
6,
"dictionary entropy should override fallback OF bootstrap frequencies"
);
}
#[test]
#[allow(clippy::borrow_deref_ref)]
fn dictionary_fse_seed_applies_without_huffman_seed() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
let ll = crate::fse::fse_encoder::default_ll_table();
let ml = crate::fse::fse_encoder::default_ml_table();
let of = crate::fse::fse_encoder::default_of_table();
hc.seed_dictionary_entropy(None, Some(&*ll), Some(&*ml), Some(&*of));
hc.backend.bt_mut().opt_state.rescale_freqs(
b"abcd",
HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra2>(),
);
let base_ll_freqs: [u32; HC_MAX_LL + 1] = [
4, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1,
];
assert_ne!(
hc.backend.bt_mut().opt_state.lit_length_freq,
base_ll_freqs,
"FSE seed should still override LL bootstrap frequencies without huffman seed"
);
assert!(
hc.backend
.bt_mut()
.opt_state
.match_length_freq
.iter()
.any(|&v| v != 1),
"FSE seed should still seed non-uniform ML frequencies"
);
assert_ne!(
hc.backend.bt_mut().opt_state.off_code_freq[0],
6,
"FSE seed should still override OF bootstrap frequencies without huffman seed"
);
}
#[test]
#[allow(clippy::borrow_deref_ref)]
fn dictionary_seed_overrides_predef_price_mode_on_tiny_input() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
let ll = crate::fse::fse_encoder::default_ll_table();
let ml = crate::fse::fse_encoder::default_ml_table();
let of = crate::fse::fse_encoder::default_of_table();
hc.seed_dictionary_entropy(None, Some(&*ll), Some(&*ml), Some(&*of));
hc.backend.bt_mut().opt_state.rescale_freqs(
b"abc",
HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra2>(),
);
assert!(
matches!(
hc.backend.bt_mut().opt_state.price_type,
HcOptPriceType::Dynamic
),
"dictionary-seeded first block should stay in dynamic mode even for tiny src"
);
}
#[test]
fn lit_length_price_blocksize_max_costs_one_extra_bit() {
let profile_predef =
HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra2>();
let mut stats_predef = HcOptState::new();
stats_predef.price_type = HcOptPriceType::Predefined;
let predef_max = profile_predef.lit_length_price(&stats_predef, HC_BLOCKSIZE_MAX);
let predef_prev =
profile_predef.lit_length_price(&stats_predef, HC_BLOCKSIZE_MAX.saturating_sub(1));
assert_eq!(
predef_max,
predef_prev + HC_BITCOST_MULTIPLIER,
"predefined litLength pricing at BLOCKSIZE_MAX must add exactly one bit"
);
let profile_dyn =
HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra2>();
let mut stats_dyn = HcOptState::new();
stats_dyn.price_type = HcOptPriceType::Dynamic;
stats_dyn.lit_length_freq.fill(1);
stats_dyn.lit_length_sum = (HC_MAX_LL + 1) as u32;
stats_dyn.match_length_freq.fill(1);
stats_dyn.match_length_sum = (HC_MAX_ML + 1) as u32;
stats_dyn.off_code_freq.fill(1);
stats_dyn.off_code_sum = (HC_MAX_OFF + 1) as u32;
stats_dyn.lit_freq.fill(1);
stats_dyn.lit_sum = (HC_MAX_LIT + 1) as u32;
stats_dyn.set_base_prices(true);
let dyn_max = profile_dyn.lit_length_price(&stats_dyn, HC_BLOCKSIZE_MAX);
let dyn_prev = profile_dyn.lit_length_price(&stats_dyn, HC_BLOCKSIZE_MAX.saturating_sub(1));
assert_eq!(
dyn_max,
dyn_prev + HC_BITCOST_MULTIPLIER,
"dynamic litLength pricing at BLOCKSIZE_MAX must add exactly one bit"
);
}
#[test]
#[allow(clippy::borrow_deref_ref)]
fn btultra2_seed_pass_disabled_when_dictionary_entropy_seed_present() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
let ll = crate::fse::fse_encoder::default_ll_table();
let ml = crate::fse::fse_encoder::default_ml_table();
let of = crate::fse::fse_encoder::default_of_table();
hc.seed_dictionary_entropy(None, Some(&*ll), Some(&*ml), Some(&*of));
assert!(
!hc.should_run_btultra2_seed_pass::<super::super::strategy::BtUltra2>(
HC_PREDEF_THRESHOLD + 1
),
"dictionary-seeded first block should skip btultra2 warmup pass"
);
}
#[test]
fn btultra2_seed_pass_disabled_when_prefix_history_exists() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
hc.table.history_abs_start = 17;
hc.table.push_test_chunk(b"abcdefghijklmnop".to_vec());
assert!(
!hc.should_run_btultra2_seed_pass::<super::super::strategy::BtUltra2>(
HC_PREDEF_THRESHOLD + 9
),
"btultra2 warmup must be first-block only (no prefix history)"
);
}
#[test]
fn btultra2_seed_pass_disabled_for_tiny_block() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
assert!(
!hc.should_run_btultra2_seed_pass::<super::super::strategy::BtUltra2>(HC_PREDEF_THRESHOLD),
"btultra2 warmup should not run at or below predefined threshold"
);
}
#[test]
fn btultra2_seed_pass_disabled_after_stats_initialized() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
hc.backend.bt_mut().opt_state.lit_length_sum = 1;
assert!(
!hc.should_run_btultra2_seed_pass::<super::super::strategy::BtUltra2>(
HC_PREDEF_THRESHOLD + 32
),
"btultra2 warmup should run only for first block before stats are initialized"
);
}
#[test]
fn btultra2_seed_pass_disabled_when_not_at_frame_start() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
hc.table.window_size = HC_PREDEF_THRESHOLD + 64;
hc.table.chunk_lens.push_back(HC_PREDEF_THRESHOLD + 32);
assert!(
!hc.should_run_btultra2_seed_pass::<super::super::strategy::BtUltra2>(
HC_PREDEF_THRESHOLD + 32
),
"btultra2 warmup must not run after frame start"
);
}
#[test]
fn btultra2_seed_pass_disabled_when_ldm_sequences_exist() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG,
super::super::strategy::StrategyTag::BtUltra2,
26,
);
hc.table.window_size = HC_PREDEF_THRESHOLD + 64;
hc.table.chunk_lens.push_back(HC_PREDEF_THRESHOLD + 64);
hc.backend.bt_mut().ldm_sequences.push(HcRawSeq {
lit_length: 8,
offset: 16,
match_length: 32,
});
assert!(
!hc.should_run_btultra2_seed_pass::<super::super::strategy::BtUltra2>(
HC_PREDEF_THRESHOLD + 32
),
"btultra2 warmup must not run when LDM already produced sequences"
);
}
#[test]
fn literal_price_uses_eight_bits_when_literals_uncompressed() {
let profile = HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra2>();
let mut stats = HcOptState::new();
stats.set_literals_compressed_for_tests(false);
stats.price_type = HcOptPriceType::Predefined;
assert_eq!(
profile.literal_price(&stats, b'a'),
8 * HC_BITCOST_MULTIPLIER,
"uncompressed literals should cost 8 bits regardless of price mode"
);
}
#[test]
fn update_stats_skips_literal_frequencies_when_uncompressed() {
let mut stats = HcOptState::new();
stats.set_literals_compressed_for_tests(false);
stats.update_stats(3, b"abc", 4, 8);
assert_eq!(
stats.lit_sum, 0,
"literal sum must remain unchanged when literal compression is disabled"
);
assert_eq!(
stats.lit_freq.iter().copied().sum::<u32>(),
0,
"literal frequencies must not be updated when literal compression is disabled"
);
assert_eq!(
stats.lit_length_sum, 1,
"literal-length stats still update for sequence modeling"
);
assert_eq!(
stats.match_length_sum, 1,
"match-length stats still update for sequence modeling"
);
assert_eq!(
stats.off_code_sum, 1,
"offset-code stats still update for sequence modeling"
);
}
#[test]
#[allow(clippy::borrow_deref_ref)]
fn dictionary_huffman_seed_ignored_when_literals_uncompressed() {
let mut stats = HcOptState::new();
stats.set_literals_compressed_for_tests(false);
let huff = crate::huff0::huff0_encoder::HuffmanTable::build_from_data(
b"aaaaabbbbcccddeeff00112233445566778899",
);
let ll = crate::fse::fse_encoder::default_ll_table();
let ml = crate::fse::fse_encoder::default_ml_table();
let of = crate::fse::fse_encoder::default_of_table();
stats.seed_dictionary_entropy(Some(&huff), Some(&*ll), Some(&*ml), Some(&*of));
stats.rescale_freqs(
b"abcd",
HcOptimalCostProfile::const_for_strategy::<super::super::strategy::BtUltra2>(),
);
assert_eq!(
stats.lit_sum, 0,
"literal sum must stay zero when literals are uncompressed"
);
assert_eq!(
stats.lit_freq.iter().copied().sum::<u32>(),
0,
"literal frequencies must ignore dictionary huffman seed when uncompressed"
);
}
#[test]
fn hc_repcode_candidates_respect_litlen_dependent_rep_order() {
let mut hc = HcMatchGenerator::new(64);
hc.table.history = b"xxxxxxABCDEFABCDEF".to_vec();
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
let abs_pos = 12usize; let current_abs_end = hc.table.history.len();
let reps = [6u32, 3u32, 9u32];
let mut lit_pos_candidates = Vec::new();
hc.hc.for_each_repcode_candidate_with_reps(
&hc.table,
abs_pos,
1,
reps,
current_abs_end,
HC_OPT_MIN_MATCH_LEN,
|c| {
lit_pos_candidates.push(c.offset);
},
);
assert!(
lit_pos_candidates.contains(&6),
"when lit_len>0, rep0 should be considered and match"
);
let mut ll0_candidates = Vec::new();
hc.hc.for_each_repcode_candidate_with_reps(
&hc.table,
abs_pos,
0,
reps,
current_abs_end,
HC_OPT_MIN_MATCH_LEN,
|c| {
ll0_candidates.push(c.offset);
},
);
assert!(
!ll0_candidates.contains(&6),
"when lit_len==0, rep0 is not directly eligible (ll0 semantics)"
);
}
#[test]
fn hc_collect_optimal_candidates_keeps_reps_when_chain_depth_zero() {
let mut hc = HcMatchGenerator::new(64);
hc.strategy_tag = crate::encoding::strategy::StrategyTag::BtOpt;
hc.hc.search_depth = 0;
hc.table.history = b"xyzxyzxyzxyz".to_vec();
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
let abs_pos = 6usize;
let current_abs_end = hc.table.history.len();
let profile = HcOptimalCostProfile {
max_chain_depth: 0,
sufficient_match_len: usize::MAX / 2,
accurate: false,
favor_small_offsets: false,
};
let mut out = Vec::new();
hc.collect_optimal_candidates(
abs_pos,
current_abs_end,
profile,
HcCandidateQuery {
reps: [3, 6, 9],
lit_len: 1,
ldm_candidate: None,
},
&mut out,
);
assert!(
!out.is_empty(),
"rep candidates should remain available even when chain depth is zero"
);
assert!(
out.iter().any(|c| c.offset == 3),
"rep0 candidate should be retained"
);
}
#[test]
#[should_panic(expected = "binary-tree only")]
fn hc_collect_optimal_candidates_panics_for_non_bt_strategy() {
let mut hc = HcMatchGenerator::new(64);
hc.strategy_tag = crate::encoding::strategy::StrategyTag::Lazy;
hc.table.history = b"abcabcabcabc".to_vec();
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
hc.table.ensure_tables();
let profile = HcOptimalCostProfile {
max_chain_depth: 0,
sufficient_match_len: usize::MAX / 2,
accurate: false,
favor_small_offsets: false,
};
let mut out = Vec::new();
hc.collect_optimal_candidates(
6,
hc.table.history.len(),
profile,
HcCandidateQuery {
reps: [1, 2, 3],
lit_len: 1,
ldm_candidate: None,
},
&mut out,
);
}
#[test]
fn hc_collect_optimal_candidates_dispatches_every_bt_strategy() {
use crate::encoding::fastpath::FastpathKernel;
use crate::encoding::strategy::StrategyTag;
for tag in [
StrategyTag::BtOpt,
StrategyTag::BtUltra,
StrategyTag::BtUltra2,
StrategyTag::Btlazy2,
] {
let mut hc = HcMatchGenerator::new(64);
hc.strategy_tag = tag;
hc.table.kernel = FastpathKernel::Scalar;
hc.table.history = b"abcQ00000000abcZ00000000".to_vec();
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
hc.table.hash_log = 8;
hc.table.chain_log = 8;
hc.table.hash3_log = 8;
hc.table.ensure_tables();
let abs_pos = 12usize;
let profile = HcOptimalCostProfile {
max_chain_depth: 8,
sufficient_match_len: usize::MAX / 2,
accurate: false,
favor_small_offsets: false,
};
let mut out = Vec::new();
hc.collect_optimal_candidates(
abs_pos,
hc.table.history.len(),
profile,
HcCandidateQuery {
reps: [50, 60, 70],
lit_len: 1,
ldm_candidate: None,
},
&mut out,
);
let uses_hash3 = matches!(tag, StrategyTag::BtUltra | StrategyTag::BtUltra2);
let found_hash3_match = out.iter().any(|c| c.offset == 12 && c.match_len == 3);
assert_eq!(
found_hash3_match, uses_hash3,
"tag {tag:?}: presence of the hash3-only 3-byte match must equal USE_HASH3 \
(a cross-group dispatch mis-mapping would flip this)"
);
}
}
#[test]
fn hc_collect_optimal_candidates_rep_tail_match_skips_chain_probe() {
let mut hc = HcMatchGenerator::new(64);
hc.strategy_tag = crate::encoding::strategy::StrategyTag::BtOpt;
hc.table.history = b"aaaaaaaaaa".to_vec();
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
hc.table.position_base = 0;
hc.hc.search_depth = 32;
let abs_pos = 6usize;
hc.table.ensure_tables();
hc.table.insert_positions(0, abs_pos);
let profile = HcOptimalCostProfile {
max_chain_depth: 32,
sufficient_match_len: usize::MAX / 2,
accurate: true,
favor_small_offsets: false,
};
let mut out = Vec::new();
hc.collect_optimal_candidates(
abs_pos,
hc.table.history.len(),
profile,
HcCandidateQuery {
reps: [1, 4, 8],
lit_len: 1,
ldm_candidate: None,
},
&mut out,
);
assert!(
out.iter()
.all(|candidate| matches!(candidate.offset, 1 | 4)),
"terminal rep match should return before chain probing adds non-rep offsets"
);
}
#[test]
fn hc_collect_optimal_candidates_long_chain_match_advances_skip_window() {
let mut hc = HcMatchGenerator::new(128);
hc.strategy_tag = crate::encoding::strategy::StrategyTag::BtOpt;
hc.table.history = b"abcabcabcabcabcabcabcabc".to_vec();
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
hc.table.position_base = 0;
hc.hc.search_depth = 32;
let abs_pos = 9usize;
hc.table.ensure_tables();
hc.table.insert_positions(0, abs_pos);
hc.table.skip_insert_until_abs = 0;
let profile = HcOptimalCostProfile {
max_chain_depth: 32,
sufficient_match_len: usize::MAX / 2,
accurate: true,
favor_small_offsets: false,
};
let mut out = Vec::new();
hc.collect_optimal_candidates(
abs_pos,
hc.table.history.len(),
profile,
HcCandidateQuery {
reps: [1, 4, 8],
lit_len: 1,
ldm_candidate: None,
},
&mut out,
);
assert!(
hc.table.skip_insert_until_abs > abs_pos,
"long chain match should advance skip window to avoid redundant immediate insertions"
);
}
#[test]
fn hc_collect_optimal_candidates_advances_skip_window_on_plain_bt_path() {
let mut hc = HcMatchGenerator::new(256);
hc.strategy_tag = crate::encoding::strategy::StrategyTag::BtOpt;
hc.table.history = b"abcdefghijklmnop".to_vec();
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
hc.table.position_base = 0;
hc.hc.search_depth = 0;
hc.table.ensure_tables();
let abs_pos = 8usize;
hc.table.skip_insert_until_abs = 0;
let profile = HcOptimalCostProfile {
max_chain_depth: 0,
sufficient_match_len: usize::MAX / 2,
accurate: true,
favor_small_offsets: false,
};
let mut out = Vec::new();
hc.collect_optimal_candidates(
abs_pos,
hc.table.history.len(),
profile,
HcCandidateQuery {
reps: [1, 4, 8],
lit_len: 1,
ldm_candidate: None,
},
&mut out,
);
assert_eq!(
hc.table.skip_insert_until_abs,
abs_pos.saturating_add(1),
"plain BT path should advance skip window by 1 via upstream zstd matchEndIdx baseline"
);
}
#[test]
fn hc_ldm_candidates_are_merged_into_optimal_candidates() {
let mut hc = HcMatchGenerator::new(512);
hc.strategy_tag = crate::encoding::strategy::StrategyTag::BtOpt;
hc.table.history = (0..256).map(|i| (i % 251) as u8).collect();
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
let abs_pos = 128usize;
let current_abs_end = 256usize;
let ldm = MatchCandidate {
start: abs_pos,
offset: 96,
match_len: 40,
};
let profile = HcOptimalCostProfile {
max_chain_depth: 0,
sufficient_match_len: usize::MAX / 2,
accurate: true,
favor_small_offsets: false,
};
let mut out = Vec::new();
hc.collect_optimal_candidates(
abs_pos,
current_abs_end,
profile,
HcCandidateQuery {
reps: [1, 4, 8],
lit_len: 1,
ldm_candidate: Some(ldm),
},
&mut out,
);
assert!(
out.iter().any(
|candidate| candidate.offset == ldm.offset && candidate.match_len == ldm.match_len
),
"LDM candidate should be present in optimal candidate set"
);
}
#[test]
fn btultra_and_btultra2_both_keep_dictionary_candidates() {
use super::super::strategy::StrategyTag;
let test_config = HcConfig {
hash_log: 23,
chain_log: 22,
search_depth: 32,
target_len: 256,
search_mls: 4,
};
let window_log = 20u8;
let prepare_history = |hc: &mut HcMatchGenerator, abs_pos: usize| {
hc.table.history = alloc::vec![0u8; 160];
for i in 0..64 {
hc.table.history[i] = b'a' + (i % 7) as u8;
}
for i in 64..160 {
hc.table.history[i] = b'k' + (i % 5) as u8;
}
for i in 0..24 {
hc.table.history[abs_pos + i] = hc.table.history[16 + i];
}
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
hc.table.position_base = 0;
hc.table.ensure_tables();
hc.table.insert_positions(0, abs_pos);
hc.table.dictionary_limit_abs = Some(64);
hc.table.skip_insert_until_abs = 0;
};
let profile = HcOptimalCostProfile {
max_chain_depth: 32,
sufficient_match_len: usize::MAX / 2,
accurate: true,
favor_small_offsets: false,
};
let abs_pos = 96usize;
let mut out = Vec::new();
let mut hc = HcMatchGenerator::new(256);
hc.configure(test_config, StrategyTag::BtUltra2, window_log);
prepare_history(&mut hc, abs_pos);
hc.collect_optimal_candidates(
abs_pos,
160,
profile,
HcCandidateQuery {
reps: [1, 4, 8],
lit_len: 1,
ldm_candidate: None,
},
&mut out,
);
assert!(
out.iter().any(|candidate| candidate.offset >= 32),
"btultra2 should retain dictionary candidates on upstream zstd-parity path"
);
let mut hc = HcMatchGenerator::new(256);
hc.configure(test_config, StrategyTag::BtUltra, window_log);
prepare_history(&mut hc, abs_pos);
hc.collect_optimal_candidates(
abs_pos,
160,
profile,
HcCandidateQuery {
reps: [1, 4, 8],
lit_len: 1,
ldm_candidate: None,
},
&mut out,
);
assert!(
out.iter().any(|candidate| candidate.offset >= 32),
"btultra should retain dictionary candidates"
);
}
#[test]
fn driver_small_source_hint_shrinks_dfast_hash_tables() {
let mut driver = MatchGeneratorDriver::new(32, 2);
driver.reset(CompressionLevel::Level(3));
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"abcabcabcabc");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
let full_long = driver.dfast_matcher().long_len();
let full_short = driver.dfast_matcher().short_len();
assert_eq!(full_long, 1 << DFAST_HASH_BITS);
assert_eq!(
full_short,
1 << (DFAST_HASH_BITS - DFAST_SHORT_HASH_BITS_DELTA)
);
driver.set_source_size_hint(1024);
driver.reset(CompressionLevel::Level(3));
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"xyzxyzxyzxyz");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
let hinted_long = driver.dfast_matcher().long_len();
let hinted_short = driver.dfast_matcher().short_len();
assert_eq!(driver.window_size(), 1 << MIN_WINDOW_LOG);
assert_eq!(hinted_long, 1 << MIN_WINDOW_LOG);
assert_eq!(hinted_short, 1 << MIN_WINDOW_LOG);
assert!(
hinted_long < full_long && hinted_short < full_short,
"tiny source hint should reduce both dfast tables"
);
}
#[test]
fn driver_huge_source_hint_does_not_overflow_table_window_shift() {
let mut driver = MatchGeneratorDriver::new(32, 2);
driver.set_source_size_hint(u64::MAX);
driver.reset(CompressionLevel::Level(3));
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"abcabcabcabc");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
assert!(
driver.dfast_matcher().long_len() >= 1 << MIN_WINDOW_LOG,
"huge hint must size the dfast table from the real window, not wrap to zero"
);
}
#[test]
fn driver_huge_source_hint_with_dict_does_not_overflow_hc_reserve() {
let mut driver = MatchGeneratorDriver::new(32, 2);
driver.set_source_size_hint(u64::MAX);
driver.set_dictionary_size_hint(64 * 1024);
driver.reset(CompressionLevel::Level(16));
let window = 1usize << 22;
let expected_history_ceiling = window + (window >> 2) + crate::common::MAX_BLOCK_SIZE as usize;
assert!(
driver.hc_matcher().table.history.capacity() >= expected_history_ceiling,
"huge source + dict hint must reserve the clamped HC history ceiling, got {}",
driver.hc_matcher().table.history.capacity()
);
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"abcabcabcabc");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
}
#[test]
fn driver_chain_log_override_survives_row_to_hc_fallback() {
let chain_log_override = 10u32;
let ov = super::super::parameters::ParamOverrides {
chain_log: Some(chain_log_override),
..Default::default()
};
let mut driver = MatchGeneratorDriver::new(32, 2);
driver.set_source_size_hint(1 << 12);
driver.set_param_overrides(Some(ov));
driver.reset(CompressionLevel::Level(6));
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"abcabcabcabc");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
assert_eq!(
driver.hc_matcher().table.chain_log,
chain_log_override as usize,
"explicit chain_log override must survive the Row->HC fallback, got {}",
driver.hc_matcher().table.chain_log
);
}
#[test]
fn driver_small_source_hint_shrinks_row_hash_tables() {
let mut driver = MatchGeneratorDriver::new(32, 2);
driver.reset(CompressionLevel::Level(5));
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"abcabcabcabc");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
let full_rows = driver.row_matcher().row_heads.len();
assert_eq!(full_rows, 1 << (ROW_L5.hash_bits - ROW_L5.row_log));
driver.set_source_size_hint(1 << 16);
driver.reset(CompressionLevel::Level(5));
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"xyzxyzxyzxyz");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
assert_eq!(
driver.active_backend(),
super::super::strategy::BackendTag::Row,
"windowLog > 14 keeps the upstream row matchfinder"
);
let hinted_rows = driver.row_matcher().row_heads.len();
assert!(
hinted_rows < full_rows,
"a window>14 source hint should reduce the row hash table footprint"
);
driver.set_source_size_hint(1024);
driver.reset(CompressionLevel::Level(5));
assert_eq!(driver.window_size(), 1 << MIN_WINDOW_LOG);
assert_eq!(
driver.active_backend(),
super::super::strategy::BackendTag::HashChain,
"windowLog <= 14 must fall back to the upstream zstd hash-chain matchfinder",
);
}
#[test]
fn row_matches_roundtrip_multi_block_pattern() {
let pattern = [7, 13, 44, 184, 19, 96, 171, 109, 141, 251];
let first_block: Vec<u8> = pattern.iter().copied().cycle().take(128 * 1024).collect();
let second_block: Vec<u8> = pattern.iter().copied().cycle().take(128 * 1024).collect();
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
matcher.ensure_tables();
let replay_sequence = |decoded: &mut Vec<u8>, seq: Sequence<'_>| match seq {
Sequence::Literals { literals } => decoded.extend_from_slice(literals),
Sequence::Triple {
literals,
offset,
match_len,
} => {
decoded.extend_from_slice(literals);
let start = decoded.len() - offset;
for i in 0..match_len {
let byte = decoded[start + i];
decoded.push(byte);
}
}
};
matcher.add_data(first_block.clone(), |_| {});
let mut history = Vec::new();
matcher.start_matching(|seq| replay_sequence(&mut history, seq));
assert_eq!(history, first_block);
matcher.add_data(second_block.clone(), |_| {});
let prefix_len = history.len();
matcher.start_matching(|seq| replay_sequence(&mut history, seq));
assert_eq!(&history[prefix_len..], second_block.as_slice());
let third_block: Vec<u8> = (0u8..=255).collect();
matcher.add_data(third_block.clone(), |_| {});
let third_prefix = history.len();
matcher.start_matching(|seq| replay_sequence(&mut history, seq));
assert_eq!(&history[third_prefix..], third_block.as_slice());
}
#[test]
fn row_short_block_emits_literals_only() {
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
matcher.add_data(b"abcde".to_vec(), |_| {});
let mut saw_triple = false;
let mut reconstructed = Vec::new();
matcher.start_matching(|seq| match seq {
Sequence::Literals { literals } => reconstructed.extend_from_slice(literals),
Sequence::Triple { .. } => saw_triple = true,
});
assert!(
!saw_triple,
"row backend must not emit triples for short blocks"
);
assert_eq!(reconstructed, b"abcde");
saw_triple = false;
matcher.add_data(b"abcdeabcde".to_vec(), |_| {});
matcher.start_matching(|seq| {
if let Sequence::Triple { .. } = seq {
saw_triple = true;
}
});
assert!(
saw_triple,
"row backend should emit triples on repeated data"
);
}
#[test]
fn row_pick_lazy_returns_best_when_lookahead_is_out_of_bounds() {
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
matcher.add_data(b"abcabc".to_vec(), |_| {});
matcher.ensure_tables();
let best = MatchCandidate {
start: 0,
offset: 1,
match_len: ROW_MIN_MATCH_LEN,
};
let picked = matcher
.pick_lazy_match(0, 0, Some(best))
.expect("best candidate must survive");
assert_eq!(picked.start, best.start);
assert_eq!(picked.offset, best.offset);
assert_eq!(picked.match_len, best.match_len);
}
#[test]
fn row_backfills_previous_block_tail_for_cross_boundary_match() {
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
let mut first_block = alloc::vec![0xA5; 64];
first_block.extend_from_slice(b"XYZ");
let second_block = b"XYZXYZtail".to_vec();
let replay_sequence = |decoded: &mut Vec<u8>, seq: Sequence<'_>| match seq {
Sequence::Literals { literals } => decoded.extend_from_slice(literals),
Sequence::Triple {
literals,
offset,
match_len,
} => {
decoded.extend_from_slice(literals);
let start = decoded.len() - offset;
for i in 0..match_len {
let byte = decoded[start + i];
decoded.push(byte);
}
}
};
matcher.add_data(first_block.clone(), |_| {});
let mut reconstructed = Vec::new();
matcher.start_matching(|seq| replay_sequence(&mut reconstructed, seq));
assert_eq!(reconstructed, first_block);
matcher.add_data(second_block.clone(), |_| {});
let mut saw_cross_boundary = false;
let prefix_len = reconstructed.len();
matcher.start_matching(|seq| {
if let Sequence::Triple {
literals,
offset,
match_len,
} = seq
&& literals.is_empty()
&& offset == 3
&& match_len >= ROW_MIN_MATCH_LEN
{
saw_cross_boundary = true;
}
replay_sequence(&mut reconstructed, seq);
});
assert!(
saw_cross_boundary,
"row matcher should reuse the 3-byte previous-block tail"
);
assert_eq!(&reconstructed[prefix_len..], second_block.as_slice());
}
#[test]
fn row_skip_matching_with_incompressible_hint_uses_sparse_prefix() {
let data = deterministic_high_entropy_bytes(0xA713_9C5D_44E2_10B1, 4096);
let mut dense = RowMatchGenerator::new(1 << 22);
dense.configure(ROW_CONFIG);
dense.add_data(data.clone(), |_| {});
dense.skip_matching_with_hint(Some(false));
let dense_slots = dense
.row_positions
.iter()
.filter(|&&pos| pos != ROW_EMPTY_SLOT)
.count();
let mut sparse = RowMatchGenerator::new(1 << 22);
sparse.configure(ROW_CONFIG);
sparse.add_data(data, |_| {});
sparse.skip_matching_with_hint(Some(true));
let sparse_slots = sparse
.row_positions
.iter()
.filter(|&&pos| pos != ROW_EMPTY_SLOT)
.count();
assert!(
sparse_slots < dense_slots,
"incompressible hint should seed fewer row slots (sparse={sparse_slots}, dense={dense_slots})"
);
}
#[test]
fn row_skip_matching_with_none_hint_leaves_interior_empty() {
let data = deterministic_high_entropy_bytes(0x9B47_F2A1_8C5E_3306, 4096);
let mut none_hint = RowMatchGenerator::new(1 << 22);
none_hint.configure(ROW_CONFIG);
none_hint.add_data(data.clone(), |_| {});
none_hint.skip_matching_with_hint(None);
let none_slots = none_hint
.row_positions
.iter()
.filter(|&&pos| pos != ROW_EMPTY_SLOT)
.count();
let mut dense = RowMatchGenerator::new(1 << 22);
dense.configure(ROW_CONFIG);
dense.add_data(data, |_| {});
dense.skip_matching_with_hint(Some(false));
let dense_slots = dense
.row_positions
.iter()
.filter(|&&pos| pos != ROW_EMPTY_SLOT)
.count();
assert_eq!(
none_slots, 0,
"None hint at block_start=0 must leave row table fully empty \
(upstream zstd parity — interior NOT inserted, no pre-block backfill possible)",
);
assert!(
dense_slots > 0,
"Some(false) dict-priming path must still insert densely \
(sanity check: control case for the `none_slots == 0` assertion)",
);
}
#[test]
fn driver_unhinted_level2_keeps_default_dfast_hash_table_size() {
let mut driver = MatchGeneratorDriver::new(32, 2);
driver.reset(CompressionLevel::Level(3));
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"abcabcabcabc");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
let long_len = driver.dfast_matcher().long_len();
let short_len = driver.dfast_matcher().short_len();
assert_eq!(
long_len,
1 << DFAST_HASH_BITS,
"unhinted Level(2) should keep default long-hash table size"
);
assert_eq!(
short_len,
1 << (DFAST_HASH_BITS - DFAST_SHORT_HASH_BITS_DELTA),
"unhinted Level(2) short-hash should be one bit smaller than long-hash"
);
}
#[cfg(any())] #[test]
fn simple_backend_rejects_undersized_pooled_suffix_store() {
let mut driver = MatchGeneratorDriver::new(128 * 1024, 2);
driver.reset(CompressionLevel::Fastest);
driver.suffix_pool.push(SuffixStore::with_capacity(1024));
let mut space = driver.get_next_space();
space.clear();
space.resize(4096, 0xAB);
driver.commit_space(space);
let last_suffix_slots = driver
.simple()
.window
.last()
.expect("window entry must exist after commit")
.suffixes
.slots
.len();
assert!(
last_suffix_slots >= 4096,
"undersized pooled suffix store must not be reused for larger blocks"
);
}
#[test]
fn source_hint_clamps_driver_slice_size_to_window() {
let mut driver = MatchGeneratorDriver::new(128 * 1024, 2);
driver.set_source_size_hint(1024);
driver.reset(CompressionLevel::Default);
let window = driver.window_size() as usize;
assert_eq!(window, 1 << MIN_WINDOW_LOG);
assert_eq!(driver.slice_size, window);
let space = driver.get_next_space();
assert_eq!(space.len(), window);
driver.commit_space(space);
}
#[test]
fn pooled_space_keeps_capacity_when_slice_size_shrinks() {
let mut driver = MatchGeneratorDriver::new(128 * 1024, 2);
driver.reset(CompressionLevel::Default);
let large = driver.get_next_space();
let large_capacity = large.capacity();
assert!(large_capacity >= 128 * 1024);
driver.commit_space(large);
driver.set_source_size_hint(1024);
driver.reset(CompressionLevel::Default);
let small = driver.get_next_space();
assert_eq!(small.len(), 1 << MIN_WINDOW_LOG);
assert!(
small.capacity() >= large_capacity,
"pooled buffer capacity should be preserved to avoid shrink/grow churn"
);
}
#[test]
fn driver_best_to_fastest_releases_oversized_hc_tables() {
let mut driver = MatchGeneratorDriver::new(32, 2);
driver.reset_on_hc_lazy(CompressionLevel::Best);
assert_eq!(driver.window_size(), (1u64 << 22));
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"abcabcabcabc");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
driver.reset(CompressionLevel::Fastest);
assert_eq!(driver.window_size(), (1u64 << 19));
assert_eq!(
driver.active_backend(),
super::super::strategy::BackendTag::Simple
);
}
#[test]
fn driver_better_to_best_resizes_hc_tables() {
let mut driver = MatchGeneratorDriver::new(32, 2);
driver.reset(CompressionLevel::Level(13));
assert_eq!(driver.window_size(), (1u64 << 22));
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"abcabcabcabc");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
let hc = driver.hc_matcher();
let better_hash_len = hc.table.hash_table.len();
let better_chain_len = hc.table.chain_table.len();
driver.reset(CompressionLevel::Level(15));
assert_eq!(driver.window_size(), (1u64 << 22));
let mut space = driver.get_next_space();
space[..12].copy_from_slice(b"xyzxyzxyzxyz");
space.truncate(12);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
let hc = driver.hc_matcher();
assert!(
hc.table.hash_table.len() > better_hash_len,
"L15 hash_table ({}) should be larger than L13 ({})",
hc.table.hash_table.len(),
better_hash_len
);
assert!(
hc.table.chain_table.len() > better_chain_len,
"L15 chain_table ({}) should be larger than L13 ({})",
hc.table.chain_table.len(),
better_chain_len
);
}
#[cfg(any())]
#[test]
fn prime_with_dictionary_preserves_history_for_first_full_block() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Fastest);
driver.prime_with_dictionary(b"abcdefgh", [1, 4, 8]);
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(b"abcdefgh");
driver.commit_space(space);
let mut saw_match = false;
driver.start_matching(|seq| {
if let Sequence::Triple {
literals,
offset,
match_len,
} = seq
&& literals.is_empty()
&& offset == 8
&& match_len >= MIN_MATCH_LEN
{
saw_match = true;
}
});
assert!(
saw_match,
"first full block should still match dictionary-primed history"
);
}
#[cfg(any())]
#[test]
fn prime_with_large_dictionary_preserves_early_history_until_first_block() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Fastest);
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(b"abcdefgh");
driver.commit_space(space);
let mut saw_match = false;
driver.start_matching(|seq| {
if let Sequence::Triple {
literals,
offset,
match_len,
} = seq
&& literals.is_empty()
&& offset == 24
&& match_len >= MIN_MATCH_LEN
{
saw_match = true;
}
});
assert!(
saw_match,
"dictionary bytes should remain addressable until frame output exceeds the live window"
);
}
#[test]
fn prime_with_dictionary_applies_offset_history_even_when_content_is_empty() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Fastest);
driver.prime_with_dictionary(&[], [11, 7, 3]);
assert_eq!(driver.simple_mut().offset_hist, [11, 7, 3]);
}
#[test]
fn hc_prime_with_empty_dictionary_disables_btultra2_seed_pass() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset_on_hc_lazy(CompressionLevel::Better);
driver.prime_with_dictionary(&[], [11, 7, 3]);
assert_eq!(driver.hc_matcher().table.offset_hist, [11, 7, 3]);
assert!(
!driver
.hc_matcher()
.should_run_btultra2_seed_pass::<super::super::strategy::BtUltra2>(
HC_PREDEF_THRESHOLD + 1
),
"btultra2 warmup must stay disabled after dictionary priming, even when dict content is empty"
);
}
#[test]
fn primed_snapshot_not_restored_across_ldm_config_change() {
use super::super::parameters::CompressionParameters;
let dict = b"abcdefghabcdefghabcdefgh";
let ldm_on = CompressionParameters::builder(CompressionLevel::Level(19))
.enable_long_distance_matching(true)
.build()
.unwrap()
.overrides();
let ldm_off = CompressionParameters::builder(CompressionLevel::Level(19))
.build()
.unwrap()
.overrides();
let mut driver = MatchGeneratorDriver::new(1024, 1);
driver.set_param_overrides(Some(ldm_on));
driver.reset(CompressionLevel::Level(19));
driver.prime_with_dictionary(dict, [1, 4, 8]);
driver.capture_primed_dictionary(CompressionLevel::Level(19));
driver.set_param_overrides(Some(ldm_off));
driver.reset(CompressionLevel::Level(19));
assert!(
!driver.restore_primed_dictionary(CompressionLevel::Level(19)),
"primed snapshot restored across an LDM config change (stale producer)",
);
driver.prime_with_dictionary(dict, [1, 4, 8]);
driver.capture_primed_dictionary(CompressionLevel::Level(19));
driver.reset(CompressionLevel::Level(19));
assert!(
driver.restore_primed_dictionary(CompressionLevel::Level(19)),
"primed snapshot not restored under identical LDM config",
);
}
#[test]
fn hc_prime_with_dictionary_disables_btultra2_seed_pass() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset_on_hc_lazy(CompressionLevel::Better);
driver.prime_with_dictionary(b"abcdefgh", [1, 4, 8]);
assert!(
!driver
.hc_matcher()
.should_run_btultra2_seed_pass::<super::super::strategy::BtUltra2>(
HC_PREDEF_THRESHOLD + 1
),
"btultra2 warmup must stay disabled after dictionary priming with content"
);
}
#[test]
fn dfast_prime_with_dictionary_preserves_history_for_first_full_block() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Level(4));
let payload = b"abcdefghijklmnop";
driver.prime_with_dictionary(payload, [1, 4, 8]);
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(payload);
driver.commit_space(space);
let mut saw_match = false;
driver.start_matching(|seq| {
if let Sequence::Triple {
literals,
offset,
match_len,
} = seq
&& literals.is_empty()
&& offset == payload.len()
&& match_len >= DFAST_MIN_MATCH_LEN
{
saw_match = true;
}
});
assert!(
saw_match,
"dfast backend should match dictionary-primed history in first full block"
);
}
#[test]
fn prime_with_dictionary_does_not_inflate_reported_window_size() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Fastest);
let before = driver.window_size();
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
let after = driver.window_size();
assert_eq!(
after, before,
"dictionary retention budget must not change reported frame window size"
);
}
#[test]
fn primed_snapshot_not_restored_when_window_hint_differs() {
let mut driver = MatchGeneratorDriver::new(8, 1);
let level = CompressionLevel::Best;
driver.set_source_size_hint(256 * 1024);
driver.reset(level);
let big_window = driver.window_size();
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
driver.capture_primed_dictionary(level);
driver.set_source_size_hint(48 * 1024);
driver.reset(level);
let small_window = driver.window_size();
assert!(
small_window < big_window,
"precondition: the two hints must resolve to different windows \
(small={small_window}, big={big_window})"
);
let restored = driver.restore_primed_dictionary(level);
assert!(
!restored,
"snapshot captured at window {big_window} must NOT be restored into a \
reset advertising window {small_window} (level alone is an insufficient key)"
);
}
#[test]
fn primed_snapshot_restored_for_hints_in_same_window_bucket() {
let mut driver = MatchGeneratorDriver::new(8, 1);
let level = CompressionLevel::Best;
driver.set_source_size_hint(300 * 1024);
driver.reset(level);
let window_a = driver.window_size();
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
driver.capture_primed_dictionary(level);
driver.set_source_size_hint(400 * 1024);
driver.reset(level);
let window_b = driver.window_size();
assert_eq!(
window_a, window_b,
"precondition: same-bucket hints must resolve to the same window \
(a={window_a}, b={window_b})"
);
let restored = driver.restore_primed_dictionary(level);
assert!(
restored,
"snapshot captured at a 300 KiB hint must be restored into a 400 KiB \
hint that resolves to the identical matcher shape (raw bytes over-key)"
);
}
#[test]
fn primed_snapshot_restored_across_level22_tier_hints() {
let mut driver = MatchGeneratorDriver::new(8, 1);
let level = CompressionLevel::Level(22);
driver.set_source_size_hint(20 * 1024);
driver.reset(level);
let window_a = driver.window_size();
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
driver.capture_primed_dictionary(level);
driver.set_source_size_hint(25 * 1024);
driver.reset(level);
let window_b = driver.window_size();
assert_eq!(
window_a, window_b,
"precondition: both hints must land in the same Level 22 upstream zstd tier \
(a={window_a}, b={window_b})"
);
let restored = driver.restore_primed_dictionary(level);
assert!(
restored,
"Level 22 snapshot captured at a 20 KiB hint must be restored into a \
25 KiB hint that resolves to the same window_log 15 (different raw \
sizes, identical matcher shape)"
);
}
#[test]
fn fast_dict_attaches_within_cutoff_bounds() {
let level = CompressionLevel::Level(1);
for hint in [8192u64, 8193, 1 << 20] {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.set_source_size_hint(hint);
driver.reset(level);
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
assert!(
driver.borrowed_dict_supported(),
"Fast dict frame with hint {hint} must attach (borrowed in-place \
dict scan), never fall back to the copy-mode input-copy path"
);
}
}
#[test]
fn fast_attach_cutoff_keeps_virtual_positions_within_u32() {
let max_attached: u64 = 1u64 << FAST_ATTACH_DICT_CUTOFF_LOG;
assert!(
max_attached <= u32::MAX as u64,
"the largest attached source 2^{FAST_ATTACH_DICT_CUTOFF_LOG} must fit u32 \
virtual positions",
);
assert!(
(1u64 << (FAST_ATTACH_DICT_CUTOFF_LOG + 1)) > u32::MAX as u64,
"the next bucket 2^{} would overflow u32 virtual positions",
FAST_ATTACH_DICT_CUTOFF_LOG + 1,
);
}
#[test]
fn oversized_dict_hint_routes_fast_to_copy_mode() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.set_dictionary_size_hint(MAX_FAST_ATTACH_DICT_REGION + 1);
driver.reset(CompressionLevel::Level(1));
driver.prime_with_dictionary(b"small dict content with some padding here", [1, 4, 8]);
assert!(
!driver.borrowed_dict_supported(),
"an oversized dict must use copy mode, not the tagged attach fill"
);
}
#[test]
fn block_samples_match_dict_is_true_for_non_simple_backend() {
let dict = b"the quick brown fox jumps over the lazy dog 0123456789abcdef";
let mut row = MatchGeneratorDriver::new(8, 6);
row.set_dictionary_size_hint(dict.len());
row.reset(CompressionLevel::Level(6));
row.prime_with_dictionary(dict, [1, 4, 8]);
assert!(
row.block_samples_match_dict(&dict[..32]),
"non-Simple backend must stay on the scan (true) for a dict frame"
);
let random: alloc::vec::Vec<u8> = (0..64u8)
.map(|i| i.wrapping_mul(37).wrapping_add(13))
.collect();
assert!(
row.block_samples_match_dict(&random),
"non-Simple backend reports true regardless of block content"
);
}
#[test]
fn primed_snapshot_fast_attach_does_not_over_key_non_simple_backends() {
let mut driver = MatchGeneratorDriver::new(8, 1);
let level = CompressionLevel::Level(12);
driver.reset(level);
let window_a = driver.window_size();
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
driver.capture_primed_dictionary(level);
driver.set_source_size_hint(64 * 1024 * 1024);
driver.reset(level);
let window_b = driver.window_size();
assert_eq!(
window_a, window_b,
"precondition: the large hint must resolve to the same window as the \
unhinted level (a={window_a}, b={window_b})"
);
let restored = driver.restore_primed_dictionary(level);
assert!(
restored,
"a Row snapshot must restore across an unhinted vs large-hinted \
reset that resolves to the identical matcher — `fast_attach` is a Fast \
backend concept and must not over-key non-Simple shapes"
);
}
#[cfg(any())] #[test]
fn prime_with_dictionary_does_not_reuse_tiny_suffix_store() {
let mut driver = MatchGeneratorDriver::new(8, 2);
driver.reset(CompressionLevel::Fastest);
driver.prime_with_dictionary(b"abcdefghi", [1, 4, 8]);
assert!(
driver
.simple()
.window
.iter()
.all(|entry| entry.data.len() >= MIN_MATCH_LEN),
"dictionary priming must not commit tails shorter than MIN_MATCH_LEN"
);
}
#[test]
fn prime_with_dictionary_counts_only_committed_tail_budget() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Fastest);
let before = driver.simple_mut().max_window_size;
driver.prime_with_dictionary(b"abcdefghi", [1, 4, 8]);
assert_eq!(
driver.simple_mut().max_window_size,
before + 8,
"retention budget must account only for dictionary bytes actually committed to history"
);
}
#[test]
fn dfast_prime_with_dictionary_counts_four_byte_tail_budget() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Level(3));
let before = driver.dfast_matcher().max_window_size;
driver.prime_with_dictionary(b"abcdefghijkl", [1, 4, 8]);
assert_eq!(
driver.dfast_matcher().max_window_size,
before + 12,
"dfast retention budget should include 4-byte dictionary tails"
);
}
#[test]
fn row_prime_with_dictionary_preserves_history_for_first_full_block() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Level(5));
let payload = b"abcdefghijklmnop";
driver.prime_with_dictionary(payload, [1, 4, 8]);
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(payload);
driver.commit_space(space);
let mut saw_match = false;
driver.start_matching(|seq| {
if let Sequence::Triple {
literals,
offset,
match_len,
} = seq
&& literals.is_empty()
&& offset == payload.len()
&& match_len >= ROW_MIN_MATCH_LEN
{
saw_match = true;
}
});
assert!(
saw_match,
"row backend should match dictionary-primed history in first full block"
);
}
#[test]
fn row_prime_with_dictionary_subtracts_uncommitted_tail_budget() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Level(5));
let base_window = driver.row_matcher().max_window_size;
driver.prime_with_dictionary(b"abcdefghi", [1, 4, 8]);
assert_eq!(
driver.row_matcher().max_window_size,
base_window + 8,
"row retained window must exclude uncommitted 1-byte tail"
);
}
#[test]
fn prime_with_dictionary_budget_shrinks_after_row_eviction() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Level(5));
driver.row_matcher_mut().max_window_size = 8;
driver.reported_window_size = 8;
let base_window = driver.row_matcher().max_window_size;
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
assert_eq!(driver.row_matcher().max_window_size, base_window + 24);
for block in [b"AAAAAAAA", b"BBBBBBBB"] {
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(block);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
}
assert_eq!(
driver.dictionary_retained_budget, 0,
"dictionary budget should be fully retired once primed dict slices are evicted"
);
assert_eq!(
driver.row_matcher().max_window_size,
base_window,
"retired dictionary budget must not remain reusable for live history"
);
}
#[test]
fn row_get_last_space_then_reset_to_fastest_drops_row_variant() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Level(5));
assert_eq!(
driver.active_backend(),
super::super::strategy::BackendTag::Row
);
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(b"row-data");
driver.commit_space(space);
assert_eq!(driver.get_last_space(), b"row-data");
driver.reset(CompressionLevel::Fastest);
assert_eq!(
driver.active_backend(),
super::super::strategy::BackendTag::Simple
);
}
#[test]
fn driver_row_commit_recycles_block_buffer_into_pool() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Level(5));
assert_eq!(
driver.active_backend(),
super::super::strategy::BackendTag::Row
);
let before_pool = driver.vec_pool.len();
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(b"row-data-to-recycle");
driver.commit_space(space);
assert!(
driver.vec_pool.len() > before_pool,
"row commit must recycle the committed block buffer into vec_pool \
(before_pool = {before_pool}, after = {})",
driver.vec_pool.len()
);
assert_eq!(driver.get_last_space(), b"row-data-to-recycle");
}
#[test]
fn adjust_params_for_zero_source_size_clamps_window_to_absolute_min() {
let mut params = resolve_level_params(CompressionLevel::Level(4), None);
params.window_log = 22;
let adjusted = adjust_params_for_source_size(params, 0);
assert_eq!(adjusted.window_log, MIN_WINDOW_LOG);
}
#[test]
fn common_prefix_len_matches_scalar_reference_across_offsets() {
fn scalar_reference(a: &[u8], b: &[u8]) -> usize {
a.iter()
.zip(b.iter())
.take_while(|(lhs, rhs)| lhs == rhs)
.count()
}
for total_len in [
0usize, 1, 5, 15, 16, 17, 31, 32, 33, 64, 65, 127, 191, 257, 320,
] {
let base: Vec<u8> = (0..total_len)
.map(|i| ((i * 13 + 7) & 0xFF) as u8)
.collect();
for start in [0usize, 1, 3] {
if start > total_len {
continue;
}
let a = &base[start..];
let b = a.to_vec();
assert_eq!(
common_prefix_len(a, &b),
scalar_reference(a, &b),
"equal slices total_len={total_len} start={start}"
);
let len = a.len();
for mismatch in [0usize, 1, 7, 15, 16, 31, 32, 47, 63, 95, 127, 128, 129, 191] {
if mismatch >= len {
continue;
}
let mut altered = b.clone();
altered[mismatch] ^= 0x5A;
assert_eq!(
common_prefix_len(a, &altered),
scalar_reference(a, &altered),
"total_len={total_len} start={start} mismatch={mismatch}"
);
}
if len > 0 {
let mismatch = len - 1;
let mut altered = b.clone();
altered[mismatch] ^= 0xA5;
assert_eq!(
common_prefix_len(a, &altered),
scalar_reference(a, &altered),
"tail mismatch total_len={total_len} start={start} mismatch={mismatch}"
);
}
}
}
let long = alloc::vec![0xAB; 320];
let shorter = alloc::vec![0xAB; 137];
assert_eq!(
common_prefix_len(&long, &shorter),
scalar_reference(&long, &shorter)
);
}
#[test]
fn row_pick_lazy_returns_none_when_next_is_better() {
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
matcher.add_data(alloc::vec![b'a'; 64], |_| {});
matcher.ensure_tables();
let abs_pos = matcher.history_abs_start + 16;
let best = MatchCandidate {
start: abs_pos,
offset: 8,
match_len: ROW_MIN_MATCH_LEN,
};
assert!(
matcher.pick_lazy_match(abs_pos, 0, Some(best)).is_none(),
"lazy picker should defer when next position is clearly better"
);
}
#[test]
fn row_pick_lazy_depth2_returns_none_when_next2_significantly_better() {
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
matcher.lazy_depth = 2;
matcher.search_depth = 0;
matcher.offset_hist = [6, 9, 1];
let mut data = alloc::vec![b'x'; 40];
data[11..30].copy_from_slice(b"EFABCABCAEFABCAEFAB");
matcher.add_data(data, |_| {});
matcher.ensure_tables();
let abs_pos = matcher.history_abs_start + 20;
let best = matcher
.best_match(abs_pos, 0)
.expect("expected baseline repcode match");
assert_eq!(best.offset, 9);
assert_eq!(best.match_len, 6);
if let Some(next) = matcher.best_match(abs_pos + 1, 1) {
assert!(next.match_len <= best.match_len);
}
let next2 = matcher
.best_match(abs_pos + 2, 2)
.expect("expected +2 candidate");
assert!(
next2.match_len > best.match_len + 1,
"+2 candidate must be significantly better for depth-2 lazy skip"
);
assert!(
matcher.pick_lazy_match(abs_pos, 0, Some(best)).is_none(),
"lazy picker should defer when +2 candidate is significantly better"
);
}
#[test]
fn row_pick_lazy_depth2_keeps_best_when_next2_is_only_one_byte_better() {
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
matcher.lazy_depth = 2;
matcher.search_depth = 0;
matcher.offset_hist = [6, 9, 1];
let mut data = alloc::vec![b'x'; 40];
data[11..30].copy_from_slice(b"EFABCABCAEFABCAEFAZ");
matcher.add_data(data, |_| {});
matcher.ensure_tables();
let abs_pos = matcher.history_abs_start + 20;
let best = matcher
.best_match(abs_pos, 0)
.expect("expected baseline repcode match");
assert_eq!(best.offset, 9);
assert_eq!(best.match_len, 6);
let next2 = matcher
.best_match(abs_pos + 2, 2)
.expect("expected +2 candidate");
assert_eq!(next2.match_len, best.match_len + 1);
let chosen = matcher
.pick_lazy_match(abs_pos, 0, Some(best))
.expect("lazy picker should keep current best");
assert_eq!(chosen.start, best.start);
assert_eq!(chosen.offset, best.offset);
assert_eq!(chosen.match_len, best.match_len);
}
#[test]
fn row_hash_and_row_extracts_high_bits() {
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
matcher.add_data(
alloc::vec![
0xAA, 0xBB, 0xCC, 0x11, 0x10, 0x20, 0x30, 0x40, 0xAA, 0xBB, 0xCC, 0x22, 0x50, 0x60,
0x70, 0x80,
],
|_| {},
);
matcher.ensure_tables();
let pos = matcher.history_abs_start + 8;
let (row, tag) = matcher
.hash_and_row(pos)
.expect("row hash should be available");
let idx = pos - matcher.history_abs_start;
let concat = matcher.live_history();
let key_len = matcher.mls.min(6);
let value = u64::from_le_bytes(concat[idx..idx + 8].try_into().unwrap())
& ((1u64 << (key_len * 8)) - 1);
let hash = crate::encoding::fastpath::hash_mix_u64_with_kernel(matcher.hash_kernel, value);
let total_bits = matcher.row_hash_log + ROW_TAG_BITS;
let combined = hash >> (u64::BITS as usize - total_bits);
let expected_row =
((combined >> ROW_TAG_BITS) as usize) & ((1usize << matcher.row_hash_log) - 1);
let expected_tag = combined as u8;
assert_eq!(row, expected_row);
assert_eq!(tag, expected_tag);
}
#[test]
fn row_repcode_skips_candidate_before_history_start() {
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
matcher.history = alloc::vec![b'a'; 20];
matcher.history_start = 0;
matcher.history_abs_start = 10;
matcher.offset_hist = [3, 0, 0];
assert!(matcher.repcode_candidate(12, 1).is_none());
}
#[test]
fn row_repcode_returns_none_when_position_too_close_to_history_end() {
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
matcher.history = b"abcde".to_vec();
matcher.history_start = 0;
matcher.history_abs_start = 0;
matcher.offset_hist = [1, 0, 0];
assert!(matcher.repcode_candidate(4, 1).is_none());
}
#[cfg(all(feature = "std", target_arch = "x86_64"))]
#[test]
fn hash_mix_sse42_path_is_available_and_matches_accelerated_impl_when_supported() {
use crate::encoding::fastpath::{self, FastpathKernel};
if !is_x86_feature_detected!("sse4.2") {
return;
}
let v = 0x0123_4567_89AB_CDEFu64;
let accelerated = unsafe { fastpath::sse42::hash_mix_u64(v) };
let dispatched = fastpath::dispatch_hash_mix_u64(v);
let kernel = fastpath::select_kernel();
if kernel == FastpathKernel::Sse42 {
assert_eq!(dispatched, accelerated);
} else {
assert_eq!(dispatched, accelerated, "AVX2/SSE4.2 share CRC32 mix");
}
}
#[cfg(all(feature = "std", target_arch = "aarch64", target_endian = "little"))]
#[test]
fn hash_mix_crc_path_is_available_and_matches_accelerated_impl_when_supported() {
use crate::encoding::fastpath;
if !is_aarch64_feature_detected!("crc") {
return;
}
let v = 0x0123_4567_89AB_CDEFu64;
let accelerated = unsafe { fastpath::neon::hash_mix_u64(v) };
let dispatched = fastpath::dispatch_hash_mix_u64(v);
assert_eq!(dispatched, accelerated);
}
#[test]
fn hc_hash3_position_matches_hash3_formula() {
let bytes = [b'a', b'b', b'c', b'd'];
let read32 = u32::from_le_bytes(bytes);
let expected = (((read32 << 8).wrapping_mul(HC_PRIME3BYTES)) >> (32 - HC3_HASH_LOG)) as usize;
assert_eq!(
super::super::match_table::storage::MatchTable::hash3_position(&bytes, HC3_HASH_LOG),
expected
);
}
#[test]
fn hc_hash_position_matches_hash4_formula() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(HC_CONFIG, super::super::strategy::StrategyTag::Lazy, 22);
let bytes = [b'a', b'b', b'c', b'd'];
let read32 = u32::from_le_bytes(bytes);
let expected = ((read32.wrapping_mul(HC_PRIME4BYTES)) >> (32 - hc.table.hash_log)) as usize;
assert_eq!(hc.table.hash_position(&bytes), expected);
}
#[test]
fn btultra2_main_hash_uses_hash4_formula() {
let mut hc = HcMatchGenerator::new(1 << 20);
hc.configure(
BTULTRA2_HC_CONFIG_L22,
super::super::strategy::StrategyTag::BtUltra2,
27,
);
let bytes = [b'a', b'b', b'c', b'd', b'e', b'f', b'g', b'h'];
let read32 = u32::from_le_bytes(bytes[..4].try_into().unwrap());
let expected = ((read32.wrapping_mul(HC_PRIME4BYTES)) >> (32 - hc.table.hash_log)) as usize;
let actual = super::super::match_table::storage::MatchTable::hash_position_with_mls(
&bytes,
hc.table.hash_log,
super::super::bt::BtMatcher::HASH_MLS,
);
assert_eq!(actual, expected);
}
#[test]
fn row_candidate_returns_none_when_abs_pos_near_end_of_history() {
let mut matcher = RowMatchGenerator::new(1 << 22);
matcher.configure(ROW_CONFIG);
matcher.history = alloc::vec![b'a'; ROW_MIN_MATCH_LEN - 1];
matcher.history_start = 0;
matcher.history_abs_start = 0;
assert!(matcher.row_candidate(0, 0).is_none());
}
#[test]
fn hc_reset_advances_floor_past_prior_frame_entries() {
use super::super::match_table::storage::MatchTable;
let mut hc = HcMatchGenerator::new(32);
hc.table.add_data(b"abcdeabcde".to_vec(), |_| {});
hc.table.ensure_tables();
hc.table.insert_positions(0, 6);
let prev_end = hc.table.history_abs_end();
assert_eq!(prev_end, 10);
assert!(hc.table.hash_table.iter().any(|&v| v != HC_EMPTY));
hc.reset(|_| {});
assert_eq!(hc.table.history_abs_start, prev_end);
for &slot in hc.table.hash_table.iter() {
if let Some(candidate_abs) =
MatchTable::stored_abs_position_fast(slot, hc.table.position_base, hc.table.index_shift)
{
assert!(
candidate_abs < hc.table.history_abs_start,
"a prior-frame entry must resolve below the advanced floor"
);
}
}
}
#[test]
fn hc_reset_full_zeroes_when_floor_would_cross_ceiling() {
use super::super::match_table::storage::REBASE_RESET_FLOOR_CEILING;
let mut hc = HcMatchGenerator::new(32);
hc.table.add_data(b"abcdeabcde".to_vec(), |_| {});
hc.table.ensure_tables();
hc.table.hash_table.fill(123);
hc.table.chain_table.fill(456);
hc.table.history_abs_start = REBASE_RESET_FLOOR_CEILING;
hc.reset(|_| {});
assert_eq!(hc.table.history_abs_start, 0);
assert_eq!(hc.table.position_base, 0);
assert!(hc.table.hash_table.iter().all(|&v| v == HC_EMPTY));
assert!(hc.table.chain_table.iter().all(|&v| v == HC_EMPTY));
}
#[test]
fn hc_start_matching_returns_early_for_empty_current_block() {
let mut hc = HcMatchGenerator::new(32);
hc.table.add_data(Vec::new(), |_| {});
let mut called = false;
hc.start_matching(|_| called = true);
assert!(!called, "empty current block should not emit sequences");
}
#[cfg(test)]
fn deterministic_high_entropy_bytes(seed: u64, len: usize) -> Vec<u8> {
let mut out = Vec::with_capacity(len);
let mut state = seed;
for _ in 0..len {
state ^= state << 13;
state ^= state >> 7;
state ^= state << 17;
out.push((state >> 40) as u8);
}
out
}
#[test]
fn hc_sparse_skip_matching_preserves_tail_cross_block_match() {
let mut matcher = HcMatchGenerator::new(1 << 22);
let tail = b"Qz9kLm2Rp";
let mut first = deterministic_high_entropy_bytes(0xD1B5_4A32_9C77_0E19, 4096);
let tail_start = first.len() - tail.len();
first[tail_start..].copy_from_slice(tail);
matcher.table.add_data(first.clone(), |_| {});
matcher.skip_matching(Some(true));
let mut second = tail.to_vec();
second.extend_from_slice(b"after-tail-literals");
matcher.table.add_data(second, |_| {});
let mut first_sequence = None;
matcher.start_matching(|seq| {
if first_sequence.is_some() {
return;
}
first_sequence = Some(match seq {
Sequence::Literals { literals } => (literals.len(), 0usize, 0usize),
Sequence::Triple {
literals,
offset,
match_len,
} => (literals.len(), offset, match_len),
});
});
let (literals_len, offset, match_len) =
first_sequence.expect("expected at least one sequence after sparse skip");
assert_eq!(
literals_len, 0,
"first sequence should start at block boundary"
);
assert_eq!(
offset,
tail.len(),
"first match should reference previous tail"
);
assert!(
match_len >= tail.len(),
"tail-aligned cross-block match must be preserved"
);
}
#[test]
fn btultra2_sparse_skip_matching_preserves_tail_cross_block_match() {
let mut matcher = HcMatchGenerator::new(1 << 20);
matcher.configure(
BTULTRA2_HC_CONFIG_L22,
super::super::strategy::StrategyTag::BtUltra2,
20,
);
let tail = b"Bt9kLm2Rp";
let mut first = deterministic_high_entropy_bytes(0xA9C3_7F21_D4E8_510B, 4096);
let tail_start = first.len() - tail.len();
first[tail_start..].copy_from_slice(tail);
matcher.table.add_data(first, |_| {});
matcher.skip_matching(Some(true));
let mut second = tail.to_vec();
second.extend_from_slice(b"after-tail-literals");
matcher.table.add_data(second, |_| {});
let mut first_sequence = None;
matcher.start_matching(|seq| {
if first_sequence.is_some() {
return;
}
first_sequence = Some(match seq {
Sequence::Literals { literals } => (literals.len(), 0usize, 0usize),
Sequence::Triple {
literals,
offset,
match_len,
} => (literals.len(), offset, match_len),
});
});
let (literals_len, offset, match_len) =
first_sequence.expect("expected at least one sequence after sparse BT skip");
assert_eq!(
literals_len, 0,
"BT sparse skip should preserve an immediate boundary match"
);
assert_eq!(
offset,
tail.len(),
"first BT match should reference previous tail"
);
assert!(
match_len >= tail.len(),
"BT sparse skip must seed the dense tail for cross-block matching"
);
}
#[test]
fn hc_sparse_skip_matching_does_not_reinsert_sparse_tail_positions() {
let mut matcher = HcMatchGenerator::new(1 << 22);
let first = deterministic_high_entropy_bytes(0xC2B2_AE3D_27D4_EB4F, 4096);
matcher.table.add_data(first.clone(), |_| {});
matcher.skip_matching(Some(true));
let current_len = first.len();
let current_abs_start =
matcher.table.history_abs_start + matcher.table.window_size - current_len;
let current_abs_end = current_abs_start + current_len;
let dense_tail = HC_MIN_MATCH_LEN + INCOMPRESSIBLE_SKIP_STEP;
let tail_start = current_abs_end
.saturating_sub(dense_tail)
.max(matcher.table.history_abs_start)
.max(current_abs_start);
let overlap_pos = (tail_start..current_abs_end)
.find(|&pos| (pos - current_abs_start).is_multiple_of(INCOMPRESSIBLE_SKIP_STEP))
.expect("fixture should contain at least one sparse-grid overlap in dense tail");
let rel = matcher
.table
.relative_position(overlap_pos)
.expect("overlap position should be representable as relative position");
let chain_idx = rel as usize & ((1 << matcher.table.chain_log) - 1);
assert_ne!(
matcher.table.chain_table[chain_idx],
rel + 1,
"sparse-grid tail positions must not be reinserted (self-loop chain entry)"
);
}
#[test]
fn hc_compact_history_drains_when_threshold_crossed() {
let mut hc = HcMatchGenerator::new(8);
hc.table.history = b"abcdefghijklmnopqrstuvwxyz".to_vec();
hc.table.history_start = 16;
hc.table.compact_history();
assert_eq!(hc.table.history_start, 0);
assert_eq!(hc.table.history, b"qrstuvwxyz");
}
#[test]
fn hc_insert_position_no_rebase_returns_when_relative_pos_unavailable() {
let mut hc = HcMatchGenerator::new(32);
hc.table.history = b"abcdefghijklmnop".to_vec();
hc.table.history_abs_start = 0;
hc.table.position_base = 1;
hc.table.ensure_tables();
let before_hash = hc.table.hash_table.clone();
let before_chain = hc.table.chain_table.clone();
hc.table.insert_position_no_rebase(0);
assert_eq!(hc.table.hash_table, before_hash);
assert_eq!(hc.table.chain_table, before_chain);
}
#[test]
fn hc_insert_positions_advances_next_to_update3_for_contiguous_range() {
let mut hc = HcMatchGenerator::new(64);
hc.table.history = b"abcdefghijklmnopqrstuvwxyz".to_vec();
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
hc.table.position_base = 0;
hc.table.ensure_tables();
hc.table.next_to_update3 = 0;
hc.table.insert_positions(0, 9);
assert_eq!(
hc.table.next_to_update3, 9,
"contiguous insert_positions should advance hash3 update cursor"
);
}
#[test]
fn hc_insert_positions_with_step_keeps_next_to_update3_cursor_for_sparse_ranges() {
let mut hc = HcMatchGenerator::new(64);
hc.table.history = b"abcdefghijklmnopqrstuvwxyz".to_vec();
hc.table.history_start = 0;
hc.table.history_abs_start = 0;
hc.table.position_base = 0;
hc.table.ensure_tables();
hc.table.next_to_update3 = 0;
hc.table.insert_positions_with_step(0, 16, 4);
assert_eq!(
hc.table.next_to_update3, 0,
"sparse insert_positions_with_step must not mark skipped positions as hash3-updated"
);
}
#[cfg(any())]
#[test]
fn prime_with_dictionary_budget_shrinks_after_simple_eviction() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Fastest);
driver.simple_mut().max_window_size = 8;
driver.reported_window_size = 8;
let base_window = driver.simple_mut().max_window_size;
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
assert_eq!(driver.simple_mut().max_window_size, base_window + 24);
for block in [b"AAAAAAAA", b"BBBBBBBB"] {
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(block);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
}
assert_eq!(
driver.dictionary_retained_budget, 0,
"dictionary budget should be fully retired once primed dict slices are evicted"
);
assert_eq!(
driver.simple_mut().max_window_size,
base_window,
"retired dictionary budget must not remain reusable for live history"
);
}
#[test]
fn prime_with_dictionary_budget_shrinks_after_dfast_eviction() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Level(3));
driver.dfast_matcher_mut().max_window_size = 8;
driver.reported_window_size = 8;
let base_window = driver.dfast_matcher().max_window_size;
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
assert_eq!(driver.dfast_matcher().max_window_size, base_window + 24);
for block in [b"AAAAAAAA", b"BBBBBBBB"] {
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(block);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
}
assert_eq!(
driver.dictionary_retained_budget, 0,
"dictionary budget should be fully retired once primed dict slices are evicted"
);
assert_eq!(
driver.dfast_matcher().max_window_size,
base_window,
"retired dictionary budget must not remain reusable for live history"
);
}
#[test]
fn hc_prime_with_dictionary_preserves_history_for_first_full_block() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset_on_hc_lazy(CompressionLevel::Better);
driver.prime_with_dictionary(b"abcdefgh", [1, 4, 8]);
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(b"abcdefgh");
driver.commit_space(space);
let mut saw_match = false;
driver.start_matching(|seq| {
if let Sequence::Triple {
literals,
offset,
match_len,
} = seq
&& literals.is_empty()
&& offset == 8
&& match_len >= HC_MIN_MATCH_LEN
{
saw_match = true;
}
});
assert!(
saw_match,
"hash-chain backend should match dictionary-primed history in first full block"
);
}
#[test]
fn prime_with_dictionary_budget_shrinks_after_hc_eviction() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset_on_hc_lazy(CompressionLevel::Better);
driver.hc_matcher_mut().table.max_window_size = 8;
driver.reported_window_size = 8;
let base_window = driver.hc_matcher().table.max_window_size;
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
assert_eq!(driver.hc_matcher().table.max_window_size, base_window + 24);
for block in [b"AAAAAAAA", b"BBBBBBBB"] {
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(block);
driver.commit_space(space);
driver.skip_matching_with_hint(None);
}
assert_eq!(
driver.dictionary_retained_budget, 0,
"dictionary budget should be fully retired once primed dict slices are evicted"
);
assert_eq!(
driver.hc_matcher().table.max_window_size,
base_window,
"retired dictionary budget must not remain reusable for live history"
);
}
#[test]
fn resident_reapply_restores_retained_dictionary_budget() {
let mut driver = MatchGeneratorDriver::new(1 << 16, 1);
let dict = b"abcdefghABCDEFGHijklmnopqrstuvwxyz0123456789";
driver.set_dictionary_size_hint(dict.len());
driver.reset_on_hc_lazy(CompressionLevel::Better);
driver.prime_with_dictionary(dict, [1, 4, 8]);
let base = driver.reported_window_size;
assert!(
driver.dictionary_retained_budget > 0,
"the priming frame must retain a non-zero dict budget"
);
driver.set_dictionary_size_hint(dict.len());
driver.reset_on_hc_lazy(CompressionLevel::Better);
assert!(
driver.dictionary_is_resident(),
"the second frame must re-borrow the resident dictionary"
);
assert_eq!(
driver.dictionary_retained_budget, 0,
"reset clears the retained-dict budget"
);
let inflated = driver.hc_matcher().table.max_window_size;
assert!(
inflated > base,
"reset re-inflates the window by the resident dict region \
(inflated={inflated}, base={base})"
);
driver.reapply_resident_dictionary([1, 4, 8]);
assert_eq!(
driver.dictionary_retained_budget,
inflated - base,
"resident reapply must restore the retained-dict budget (= window \
inflation) so the retire path can shrink the window as the dict evicts"
);
}
#[test]
fn hc_commit_without_eviction_retires_no_dictionary_budget() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset_on_hc_lazy(CompressionLevel::Better);
driver.hc_matcher_mut().table.max_window_size = 1 << 20;
driver.reported_window_size = 1 << 20;
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
let budget_after_prime = driver.dictionary_retained_budget;
assert!(
budget_after_prime > 0,
"priming must retain a non-zero dictionary budget"
);
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(b"AAAAAAAA");
driver.commit_space(space);
driver.skip_matching_with_hint(None);
assert_eq!(
driver.dictionary_retained_budget, budget_after_prime,
"a commit that evicts nothing must retire no dictionary budget"
);
}
#[test]
fn row_commit_without_eviction_retires_no_dictionary_budget() {
let mut driver = MatchGeneratorDriver::new(8, 1);
driver.reset(CompressionLevel::Level(5));
assert!(matches!(driver.storage, MatcherStorage::Row(_)));
driver.row_matcher_mut().max_window_size = 1 << 20;
driver.reported_window_size = 1 << 20;
driver.prime_with_dictionary(b"abcdefghABCDEFGHijklmnop", [1, 4, 8]);
let budget_after_prime = driver.dictionary_retained_budget;
assert!(
budget_after_prime > 0,
"priming must retain a non-zero dictionary budget"
);
let mut space = driver.get_next_space();
space.clear();
space.extend_from_slice(b"AAAAAAAA");
driver.commit_space(space);
driver.skip_matching_with_hint(None);
assert_eq!(
driver.dictionary_retained_budget, budget_after_prime,
"a Row commit that evicts nothing must retire no dictionary budget"
);
}
#[test]
fn hc_rebases_positions_after_u32_boundary() {
let mut matcher = HcMatchGenerator::new(64);
matcher.table.add_data(b"abcdeabcdeabcde".to_vec(), |_| {});
matcher.table.ensure_tables();
matcher.table.position_base = 0;
let history_abs_start: usize = match (u64::from(u32::MAX) + 64).try_into() {
Ok(value) => value,
Err(_) => return,
};
matcher.table.history_abs_start = history_abs_start;
matcher.skip_matching(None);
assert_eq!(
matcher.table.position_base, matcher.table.history_abs_start,
"rebase should anchor to the oldest live absolute position"
);
assert!(
matcher
.table
.hash_table
.iter()
.any(|entry| *entry != HC_EMPTY),
"HC hash table should still be populated after crossing u32 boundary"
);
}
#[cfg(target_pointer_width = "64")]
#[test]
fn row_rebases_positions_after_u32_boundary() {
let mut m = RowMatchGenerator::new(64);
m.add_data(b"abcdeabcdeabcde".to_vec(), |_| {});
let near_ceiling = (u32::MAX as usize) - 16;
m.history_abs_start = near_ceiling;
m.add_data(b"fghij".to_vec(), |_| {});
assert!(
m.history_abs_start < near_ceiling,
"add_data must rebase the absolute origin down when the cursor nears \
u32::MAX (got {})",
m.history_abs_start
);
assert!(
(m.history_abs_start + m.window_size) < u32::MAX as usize,
"after rebase the live window must fit below the u32 position ceiling"
);
}
#[test]
fn hc_rebase_rebuilds_only_inserted_prefix() {
let mut matcher = HcMatchGenerator::new(64);
matcher.table.add_data(b"abcdeabcdeabcde".to_vec(), |_| {});
matcher.table.ensure_tables();
matcher.table.position_base = 0;
let history_abs_start: usize = match (u64::from(u32::MAX) + 64).try_into() {
Ok(value) => value,
Err(_) => return,
};
matcher.table.history_abs_start = history_abs_start;
let abs_pos = matcher.table.history_abs_start + 6;
let mut expected = HcMatchGenerator::new(64);
expected.table.add_data(b"abcdeabcdeabcde".to_vec(), |_| {});
expected.table.ensure_tables();
expected.table.history_abs_start = history_abs_start;
expected.table.position_base = expected.table.history_abs_start;
expected.table.hash_table.fill(HC_EMPTY);
expected.table.chain_table.fill(HC_EMPTY);
for pos in expected.table.history_abs_start..abs_pos {
expected.table.insert_position_no_rebase(pos);
}
matcher.table.maybe_rebase_positions(abs_pos);
assert_eq!(
matcher.table.position_base, matcher.table.history_abs_start,
"rebase should still anchor to the oldest live absolute position"
);
assert_eq!(
matcher.table.hash_table, expected.table.hash_table,
"rebase must rebuild only positions already inserted before abs_pos"
);
assert_eq!(
matcher.table.chain_table, expected.table.chain_table,
"future positions must not be pre-seeded into HC chains during rebase"
);
}
#[cfg(any())] #[test]
fn suffix_store_with_single_slot_does_not_panic_on_keying() {
let mut suffixes = SuffixStore::with_capacity(1);
suffixes.insert(b"abcde", 0);
assert!(suffixes.contains_key(b"abcde"));
assert_eq!(suffixes.get(b"abcde"), Some(0));
}
#[cfg(any())]
#[test]
fn fastest_reset_uses_interleaved_hash_fill_step() {
let mut driver = MatchGeneratorDriver::new(32, 2);
driver.reset(CompressionLevel::Uncompressed);
assert_eq!(driver.simple().hash_fill_step, 1);
driver.reset(CompressionLevel::Fastest);
assert_eq!(driver.simple().hash_fill_step, FAST_HASH_FILL_STEP);
driver.reset(CompressionLevel::Better);
assert_eq!(
driver.active_backend(),
super::super::strategy::BackendTag::HashChain
);
assert_eq!(driver.window_size(), (1u64 << 23));
assert_eq!(driver.hc_matcher().hc.lazy_depth, 2);
}
#[cfg(any())] #[test]
fn simple_matcher_updates_offset_history_after_emitting_match() {
let mut matcher = MatchGenerator::new(64);
matcher.add_data(
b"abcdeabcdeabcde".to_vec(),
SuffixStore::with_capacity(64),
|_, _| {},
);
assert!(matcher.next_sequence(|seq| {
assert_eq!(
seq,
Sequence::Triple {
literals: b"abcde",
offset: 5,
match_len: 10,
}
);
}));
assert_eq!(matcher.offset_hist, [5, 1, 4]);
}
#[cfg(any())] #[test]
fn simple_matcher_zero_literal_repcode_checks_rep1_before_hash_lookup() {
let mut matcher = MatchGenerator::new(64);
matcher.add_data(
b"abcdefghijabcdefghij".to_vec(),
SuffixStore::with_capacity(64),
|_, _| {},
);
matcher.suffix_idx = 10;
matcher.last_idx_in_sequence = 10;
matcher.offset_hist = [99, 10, 4];
let candidate = matcher.repcode_candidate(&matcher.window.last().unwrap().data[10..], 0);
assert_eq!(candidate, Some((10, 10)));
}
#[cfg(any())] #[test]
fn simple_matcher_repcode_can_target_previous_window_entry() {
let mut matcher = MatchGenerator::new(64);
matcher.add_data(
b"abcdefghij".to_vec(),
SuffixStore::with_capacity(64),
|_, _| {},
);
matcher.skip_matching();
matcher.add_data(
b"abcdefghij".to_vec(),
SuffixStore::with_capacity(64),
|_, _| {},
);
matcher.offset_hist = [99, 10, 4];
let candidate = matcher.repcode_candidate(&matcher.window.last().unwrap().data, 0);
assert_eq!(candidate, Some((10, 10)));
}
#[cfg(any())] #[test]
fn simple_matcher_zero_literal_repcode_checks_rep2() {
let mut matcher = MatchGenerator::new(64);
matcher.add_data(
b"abcdefghijabcdefghij".to_vec(),
SuffixStore::with_capacity(64),
|_, _| {},
);
matcher.suffix_idx = 10;
matcher.last_idx_in_sequence = 10;
matcher.offset_hist = [99, 4, 10];
let candidate = matcher.repcode_candidate(&matcher.window.last().unwrap().data[10..], 0);
assert_eq!(candidate, Some((10, 10)));
}
#[cfg(any())] #[test]
fn simple_matcher_zero_literal_repcode_checks_rep0_minus1() {
let mut matcher = MatchGenerator::new(64);
matcher.add_data(
b"abcdefghijabcdefghij".to_vec(),
SuffixStore::with_capacity(64),
|_, _| {},
);
matcher.suffix_idx = 10;
matcher.last_idx_in_sequence = 10;
matcher.offset_hist = [11, 4, 99];
let candidate = matcher.repcode_candidate(&matcher.window.last().unwrap().data[10..], 0);
assert_eq!(candidate, Some((10, 10)));
}
#[cfg(any())] #[test]
fn simple_matcher_repcode_rejects_offsets_beyond_searchable_prefix() {
let mut matcher = MatchGenerator::new(64);
matcher.add_data(
b"abcdefghij".to_vec(),
SuffixStore::with_capacity(64),
|_, _| {},
);
matcher.skip_matching();
matcher.add_data(
b"klmnopqrst".to_vec(),
SuffixStore::with_capacity(64),
|_, _| {},
);
matcher.suffix_idx = 3;
let candidate = matcher.offset_match_len(14, &matcher.window.last().unwrap().data[3..]);
assert_eq!(candidate, None);
}
#[cfg(any())] #[test]
fn simple_matcher_skip_matching_seeds_every_position_even_with_fast_step() {
let mut matcher = MatchGenerator::new(64);
matcher.hash_fill_step = FAST_HASH_FILL_STEP;
matcher.add_data(
b"abcdefghijklmnop".to_vec(),
SuffixStore::with_capacity(64),
|_, _| {},
);
matcher.skip_matching();
matcher.add_data(b"bcdef".to_vec(), SuffixStore::with_capacity(64), |_, _| {});
assert!(matcher.next_sequence(|seq| {
assert_eq!(
seq,
Sequence::Triple {
literals: b"",
offset: 15,
match_len: 5,
}
);
}));
assert!(!matcher.next_sequence(|_| {}));
}
#[cfg(any())] #[test]
fn simple_matcher_skip_matching_with_incompressible_hint_uses_sparse_prefix() {
let mut matcher = MatchGenerator::new(128);
let first = b"abcdefghijklmnopqrstuvwxyz012345".to_vec();
let sparse_probe = first[3..3 + MIN_MATCH_LEN].to_vec();
let tail_start = first.len() - MIN_MATCH_LEN;
let tail_probe = first[tail_start..tail_start + MIN_MATCH_LEN].to_vec();
matcher.add_data(first, SuffixStore::with_capacity(256), |_, _| {});
matcher.skip_matching_with_hint(Some(true));
matcher.add_data(sparse_probe, SuffixStore::with_capacity(256), |_, _| {});
let mut sparse_first_is_literals = None;
assert!(matcher.next_sequence(|seq| {
if sparse_first_is_literals.is_none() {
sparse_first_is_literals = Some(matches!(seq, Sequence::Literals { .. }));
}
}));
assert!(
sparse_first_is_literals.unwrap_or(false),
"sparse-start probe should not produce an immediate match"
);
let mut matcher = MatchGenerator::new(128);
matcher.add_data(
b"abcdefghijklmnopqrstuvwxyz012345".to_vec(),
SuffixStore::with_capacity(256),
|_, _| {},
);
matcher.skip_matching_with_hint(Some(true));
matcher.add_data(tail_probe, SuffixStore::with_capacity(256), |_, _| {});
let mut tail_first_is_immediate_match = None;
assert!(matcher.next_sequence(|seq| {
if tail_first_is_immediate_match.is_none() {
tail_first_is_immediate_match =
Some(matches!(seq, Sequence::Triple { literals, .. } if literals.is_empty()));
}
}));
assert!(
tail_first_is_immediate_match.unwrap_or(false),
"dense tail probe should match immediately at block start"
);
}
#[cfg(any())] #[test]
fn simple_matcher_add_suffixes_till_backfills_last_searchable_anchor() {
let mut matcher = MatchGenerator::new(64);
matcher.hash_fill_step = FAST_HASH_FILL_STEP;
matcher.add_data(
b"01234abcde".to_vec(),
SuffixStore::with_capacity(64),
|_, _| {},
);
matcher.add_suffixes_till(10, FAST_HASH_FILL_STEP);
let last = matcher.window.last().unwrap();
let tail = &last.data[5..10];
assert_eq!(last.suffixes.get(tail), Some(5));
}
#[cfg(any())] #[test]
fn simple_matcher_add_suffixes_till_skips_when_idx_below_min_match_len() {
let mut matcher = MatchGenerator::new(128);
matcher.hash_fill_step = FAST_HASH_FILL_STEP;
matcher.add_data(
b"abcdefghijklmnopqrstuvwxyz".to_vec(),
SuffixStore::with_capacity(1 << 16),
|_, _| {},
);
matcher.add_suffixes_till(MIN_MATCH_LEN - 1, FAST_HASH_FILL_STEP);
let last = matcher.window.last().unwrap();
let first_key = &last.data[..MIN_MATCH_LEN];
assert_eq!(last.suffixes.get(first_key), None);
}
#[cfg(any())] #[test]
fn simple_matcher_add_suffixes_till_fast_step_registers_interleaved_positions() {
let mut matcher = MatchGenerator::new(128);
matcher.hash_fill_step = FAST_HASH_FILL_STEP;
matcher.add_data(
b"abcdefghijklmnopqrstuvwxyz".to_vec(),
SuffixStore::with_capacity(1 << 16),
|_, _| {},
);
matcher.add_suffixes_till(17, FAST_HASH_FILL_STEP);
let last = matcher.window.last().unwrap();
for pos in [0usize, 3, 6, 9, 12] {
let key = &last.data[pos..pos + MIN_MATCH_LEN];
assert_eq!(
last.suffixes.get(key),
Some(pos),
"expected interleaved suffix registration at pos {pos}"
);
}
}
#[test]
fn dfast_skip_matching_handles_window_eviction() {
let mut matcher = DfastMatchGenerator::new(16);
matcher.add_data(alloc::vec![1, 2, 3, 4, 5, 6], |_| {});
matcher.skip_matching(None);
matcher.add_data(alloc::vec![7, 8, 9, 10, 11, 12], |_| {});
matcher.skip_matching(None);
matcher.add_data(alloc::vec![7, 8, 9, 10, 11, 12], |_| {});
let mut reconstructed = alloc::vec![7, 8, 9, 10, 11, 12];
matcher.start_matching(|seq| match seq {
Sequence::Literals { literals } => reconstructed.extend_from_slice(literals),
Sequence::Triple {
literals,
offset,
match_len,
} => {
reconstructed.extend_from_slice(literals);
let start = reconstructed.len() - offset;
for i in 0..match_len {
let byte = reconstructed[start + i];
reconstructed.push(byte);
}
}
});
assert_eq!(reconstructed, [7, 8, 9, 10, 11, 12, 7, 8, 9, 10, 11, 12]);
}
#[test]
fn dfast_add_data_callback_reports_evicted_len_not_capacity() {
let mut matcher = DfastMatchGenerator::new(8);
let mut first = Vec::with_capacity(64);
first.extend_from_slice(b"abcdefgh");
matcher.add_data(first, |_| {});
let mut second = Vec::with_capacity(64);
second.extend_from_slice(b"ijklmnop");
let mut observed_evicted_len = None;
matcher.add_data(second, |data| {
observed_evicted_len = Some(data.len());
});
assert_eq!(
observed_evicted_len,
Some(8),
"eviction callback must report evicted byte length, not backing capacity"
);
}
#[test]
fn dfast_commit_space_eviction_uses_window_size_delta() {
use crate::encoding::CompressionLevel;
let mut driver = MatchGeneratorDriver::new(10, 1);
driver.reset(CompressionLevel::Level(3));
assert!(matches!(driver.storage, MatcherStorage::Dfast(_)));
driver.dfast_matcher_mut().max_window_size = 10;
driver.dictionary_retained_budget = 100;
let mut space1 = Vec::with_capacity(64);
space1.extend_from_slice(b"abcd");
driver.commit_space(space1);
assert_eq!(
driver.dictionary_retained_budget, 100,
"1st commit fills window 0 → 4, no eviction, no retire"
);
let mut space2 = Vec::with_capacity(64);
space2.extend_from_slice(b"efgh");
driver.commit_space(space2);
assert_eq!(
driver.dictionary_retained_budget, 100,
"2nd commit fills window 4 → 8, no eviction, no retire"
);
let mut space3 = Vec::with_capacity(64);
space3.extend_from_slice(b"ijklm");
driver.commit_space(space3);
assert_eq!(
driver.dictionary_retained_budget, 87,
"3rd commit + trim_after_budget_retire cascade. With the fix \
(evicted=4 from window_size delta) the cascade reclaims 100 \
→ 96 → 92 → 87. With the bug (evicted=5 from data.len()) the \
3rd commit would panic on `data.len() <= max_window_size` \
after the 2nd commit's cascade had already shrunk \
max_window_size to 0."
);
assert_eq!(
driver.dfast_matcher_mut().max_window_size,
0,
"cascade drains max_window_size to 0 once budget reclaim \
exceeds the initial window size"
);
}
#[test]
fn dfast_trim_to_window_evicts_oldest_block_by_length() {
let mut matcher = DfastMatchGenerator::new(16);
let mut first = Vec::with_capacity(64);
first.extend_from_slice(b"abcdefgh");
matcher.add_data(first, |_| {});
let mut second = Vec::with_capacity(64);
second.extend_from_slice(b"ijklmnop");
matcher.add_data(second, |_| {});
assert_eq!(matcher.window_size, 16);
assert_eq!(matcher.window_blocks.len(), 2);
matcher.max_window_size = 8;
matcher.trim_to_window();
assert_eq!(
matcher.window_size, 8,
"exactly one 8-byte block must remain"
);
assert_eq!(matcher.window_blocks.len(), 1);
assert_eq!(matcher.history_abs_start, 8);
}
#[test]
fn dfast_inserts_tail_positions_for_next_block_matching() {
let mut matcher = DfastMatchGenerator::new(1 << 22);
matcher.add_data(b"012345bcdea".to_vec(), |_| {});
let mut history = Vec::new();
matcher.start_matching(|seq| match seq {
Sequence::Literals { literals } => history.extend_from_slice(literals),
Sequence::Triple { .. } => unreachable!("first block should not match history"),
});
assert_eq!(history, b"012345bcdea");
matcher.add_data(b"bcdeabcdeab".to_vec(), |_| {});
let mut saw_first_sequence = false;
matcher.start_matching(|seq| {
assert!(!saw_first_sequence, "expected a single cross-block match");
saw_first_sequence = true;
match seq {
Sequence::Literals { .. } => {
panic!("expected tail-anchored cross-block match before any literals")
}
Sequence::Triple {
literals,
offset,
match_len,
} => {
assert_eq!(literals, b"");
assert_eq!(offset, 5);
assert_eq!(match_len, 11);
let start = history.len() - offset;
for i in 0..match_len {
let byte = history[start + i];
history.push(byte);
}
}
}
});
assert!(
saw_first_sequence,
"expected tail-anchored cross-block match"
);
assert_eq!(history, b"012345bcdeabcdeabcdeab");
}
#[test]
fn hashchain_inserts_tail_positions_for_next_block_matching() {
let mut matcher = HcMatchGenerator::new(1 << 22);
matcher.configure(HC_CONFIG, super::super::strategy::StrategyTag::Lazy, 22);
matcher.table.add_data(b"PQRSTBCD".to_vec(), |_| {});
let mut history = alloc::vec::Vec::new();
matcher.start_matching(|seq| match seq {
Sequence::Literals { literals } => history.extend_from_slice(literals),
Sequence::Triple { .. } => unreachable!("first block has no internal repeats"),
});
assert_eq!(history, b"PQRSTBCD");
matcher.table.add_data(b"BCDBCDBCDB".to_vec(), |_| {});
let mut first_sequence_offset: Option<usize> = None;
let mut first_sequence_match_len: Option<usize> = None;
matcher.start_matching(|seq| {
if first_sequence_offset.is_some() {
return;
}
match seq {
Sequence::Literals { .. } => {
panic!(
"expected tail-anchored cross-block match before any literals — \
backfill_boundary_positions did not seed positions 5/6/7"
)
}
Sequence::Triple {
literals,
offset,
match_len,
} => {
assert_eq!(literals, b"", "no leading literals on the boundary match");
first_sequence_offset = Some(offset);
first_sequence_match_len = Some(match_len);
}
}
});
let offset = first_sequence_offset.expect(
"expected tail-anchored cross-block match emitted from backfill_boundary_positions",
);
assert!(
(1..=3).contains(&offset),
"boundary match offset {offset} must point into the unhashable tail \
(positions 5/6/7 of an 8-byte block 1) so the test specifically \
locks down backfill_boundary_positions",
);
assert_eq!(
offset, 3,
"candidate position must land at 5 (= block_1_len - 3) so the 4-byte \
window `data[5..9] = b\"BCDB\"` matches block 2's first hash lookup",
);
let match_len = first_sequence_match_len.unwrap();
assert!(
match_len >= HC_MIN_MATCH_LEN,
"match_len {match_len} must clear the HC min-match floor",
);
}
#[test]
fn dfast_dense_skip_matching_backfills_previous_tail_for_next_block() {
let mut matcher = DfastMatchGenerator::new(1 << 22);
let tail = b"Qz9kLm2Rp";
let mut first = b"0123456789abcdef".to_vec();
first.extend_from_slice(tail);
matcher.add_data(first.clone(), |_| {});
matcher.skip_matching(Some(false));
let mut second = tail.to_vec();
second.extend_from_slice(b"after-tail-literals");
matcher.add_data(second, |_| {});
let mut first_sequence = None;
matcher.start_matching(|seq| {
if first_sequence.is_some() {
return;
}
first_sequence = Some(match seq {
Sequence::Literals { literals } => (literals.len(), 0usize, 0usize),
Sequence::Triple {
literals,
offset,
match_len,
} => (literals.len(), offset, match_len),
});
});
let (lit_len, offset, match_len) = first_sequence.expect("expected at least one sequence");
assert_eq!(
lit_len, 0,
"expected immediate cross-block match at block start"
);
assert_eq!(
offset,
tail.len(),
"expected dense skip to preserve cross-boundary tail match"
);
assert!(
match_len >= DFAST_MIN_MATCH_LEN,
"match length should satisfy dfast minimum match length"
);
}
#[test]
fn dfast_sparse_skip_matching_preserves_tail_cross_block_match() {
let mut matcher = DfastMatchGenerator::new(1 << 22);
let tail = b"Qz9kLm2Rp";
let mut first = deterministic_high_entropy_bytes(0x9E37_79B9_7F4A_7C15, 4096);
let tail_start = first.len() - tail.len();
first[tail_start..].copy_from_slice(tail);
matcher.add_data(first.clone(), |_| {});
matcher.skip_matching(Some(true));
let mut second = tail.to_vec();
second.extend_from_slice(b"after-tail-literals");
matcher.add_data(second, |_| {});
let mut first_sequence = None;
matcher.start_matching(|seq| {
if first_sequence.is_some() {
return;
}
first_sequence = Some(match seq {
Sequence::Literals { literals } => (literals.len(), 0usize, 0usize),
Sequence::Triple {
literals,
offset,
match_len,
} => (literals.len(), offset, match_len),
});
});
let (lit_len, offset, match_len) = first_sequence.expect("expected at least one sequence");
assert_eq!(
lit_len, 0,
"expected immediate cross-block match at block start"
);
assert_eq!(
offset,
tail.len(),
"expected match against densely seeded tail"
);
assert!(
match_len >= DFAST_MIN_MATCH_LEN,
"match length should satisfy dfast minimum match length"
);
}
#[test]
fn dfast_skip_matching_dense_backfills_newly_hashable_long_tail_positions() {
let mut matcher = DfastMatchGenerator::new(1 << 22);
let first = deterministic_high_entropy_bytes(0x7A64_0315_D4E1_91C3, 4096);
let first_len = first.len();
matcher.add_data(first, |_| {});
matcher.skip_matching_dense();
matcher.add_data(alloc::vec![0xAB], |_| {});
matcher.skip_matching_dense();
let target_abs_pos = first_len - 7;
let target_rel = target_abs_pos - matcher.history_abs_start;
let live = matcher.live_history();
assert!(
target_rel + 8 <= live.len(),
"fixture must make the boundary start long-hashable"
);
let long_hash = matcher.long_hash_index(&live[target_rel..]);
let target_slot = matcher.pack_slot(target_abs_pos);
assert_ne!(
target_slot, DFAST_EMPTY_SLOT,
"pack_slot must never return the empty-slot sentinel for a real position"
);
assert_eq!(
matcher.tables[long_hash], target_slot,
"dense skip must seed long-hash entry for newly hashable boundary start"
);
}
#[test]
fn dfast_seed_remaining_hashable_starts_seeds_last_short_hash_positions() {
let mut matcher = DfastMatchGenerator::new(1 << 20);
let block = deterministic_high_entropy_bytes(0x13F0_9A6D_55CE_7B21, 64);
matcher.add_data(block, |_| {});
matcher.ensure_hash_tables();
let current_len = matcher.window_blocks.back().copied().unwrap_or(0);
let current_abs_start = matcher.history_abs_start + matcher.window_size - current_len;
let seed_start = current_len - DFAST_MIN_MATCH_LEN;
matcher.seed_remaining_hashable_starts(current_abs_start, current_len, seed_start);
let target_abs_pos = current_abs_start + current_len - 5;
let target_rel = target_abs_pos - matcher.history_abs_start;
let live = matcher.live_history();
assert!(
target_rel + 5 <= live.len(),
"fixture must leave the last short-hash start valid"
);
let short_hash = matcher.short_hash_index(&live[target_rel..]);
let target_slot = matcher.pack_slot(target_abs_pos);
assert_ne!(
target_slot, DFAST_EMPTY_SLOT,
"pack_slot must never return the empty-slot sentinel for a real position"
);
assert_eq!(
matcher.tables[matcher.long_len() + short_hash],
target_slot,
"tail seeding must include the last 5-byte-hashable start"
);
}
#[test]
fn dfast_seed_remaining_hashable_starts_handles_pos_at_block_end() {
let mut matcher = DfastMatchGenerator::new(1 << 20);
let block = deterministic_high_entropy_bytes(0x7BB2_DA91_441E_C0EF, 64);
matcher.add_data(block, |_| {});
matcher.ensure_hash_tables();
let current_len = matcher.window_blocks.back().copied().unwrap_or(0);
let current_abs_start = matcher.history_abs_start + matcher.window_size - current_len;
matcher.seed_remaining_hashable_starts(current_abs_start, current_len, current_len);
let target_abs_pos = current_abs_start + current_len - 5;
let target_rel = target_abs_pos - matcher.history_abs_start;
let live = matcher.live_history();
assert!(
target_rel + 5 <= live.len(),
"fixture must leave the last short-hash start valid"
);
let short_hash = matcher.short_hash_index(&live[target_rel..]);
let target_slot = matcher.pack_slot(target_abs_pos);
assert_ne!(
target_slot, DFAST_EMPTY_SLOT,
"pack_slot must never return the empty-slot sentinel for a real position"
);
assert_eq!(
matcher.tables[matcher.long_len() + short_hash],
target_slot,
"tail seeding must still include the last 5-byte-hashable start when pos is at block end"
);
}
#[test]
fn dfast_ensure_room_for_rebases_above_guard_band() {
let mut dfast = DfastMatchGenerator::new(1 << 22);
dfast.set_hash_bits(10, 10);
dfast.ensure_hash_tables();
let early_abs = 1024usize;
let early_packed = dfast.pack_slot(early_abs);
assert_ne!(early_packed, DFAST_EMPTY_SLOT);
let short0 = dfast.long_len();
dfast.tables[short0] = early_packed;
dfast.tables[0] = early_packed;
let trigger_abs = (u32::MAX as usize) - (DFAST_REBASE_GUARD_BAND as usize) + 1;
assert_eq!(dfast.position_base, 0);
dfast.ensure_room_for(trigger_abs);
assert_eq!(
dfast.position_base, DFAST_REBASE_GUARD_BAND as usize,
"rebase must advance position_base by DFAST_REBASE_GUARD_BAND"
);
assert_eq!(
dfast.tables[dfast.long_len()],
DFAST_EMPTY_SLOT,
"pre-rebase short-hash entries below the reducer must become empty"
);
assert_eq!(
dfast.tables[0], DFAST_EMPTY_SLOT,
"pre-rebase long-hash entries below the reducer must become empty"
);
let post_packed = dfast.pack_slot(trigger_abs);
assert_ne!(post_packed, DFAST_EMPTY_SLOT);
let unpacked = dfast.position_base + (post_packed as usize) - 1;
assert_eq!(
unpacked, trigger_abs,
"post-rebase pack/unpack must round-trip the absolute position"
);
}
#[test]
fn dfast_sparse_skip_matching_backfills_previous_tail_for_consecutive_sparse_blocks() {
let mut matcher = DfastMatchGenerator::new(1 << 22);
let boundary_prefix = [0xFA, 0xFB, 0xFC];
let boundary_suffix = [0xFD, 0xEE, 0xAD, 0xBE, 0xEF, 0x11, 0x22, 0x33];
let mut first = deterministic_high_entropy_bytes(0xA5A5_5A5A_C3C3_3C3C, 4096);
let first_tail_start = first.len() - boundary_prefix.len();
first[first_tail_start..].copy_from_slice(&boundary_prefix);
matcher.add_data(first, |_| {});
matcher.skip_matching(Some(true));
let mut second = deterministic_high_entropy_bytes(0xA5A5_5A5A_C3C3_3C3C, 4096);
second[..boundary_suffix.len()].copy_from_slice(&boundary_suffix);
matcher.add_data(second.clone(), |_| {});
matcher.skip_matching(Some(true));
let mut third = boundary_prefix.to_vec();
third.extend_from_slice(&boundary_suffix);
third.extend_from_slice(b"-trailing-literals");
matcher.add_data(third, |_| {});
let mut first_sequence = None;
matcher.start_matching(|seq| {
if first_sequence.is_some() {
return;
}
first_sequence = Some(match seq {
Sequence::Literals { literals } => (literals.len(), 0usize, 0usize),
Sequence::Triple {
literals,
offset,
match_len,
} => (literals.len(), offset, match_len),
});
});
let (lit_len, offset, match_len) = first_sequence.expect("expected at least one sequence");
assert_eq!(
lit_len, 0,
"expected immediate match from the prior sparse-skip boundary"
);
assert_eq!(
offset,
second.len() + boundary_prefix.len(),
"expected match against backfilled first→second boundary start"
);
assert!(
match_len >= DFAST_MIN_MATCH_LEN,
"match length should satisfy dfast minimum match length"
);
}
#[test]
fn fastest_hint_iteration_23_sequences_reconstruct_source() {
fn generate_data(seed: u64, len: usize) -> Vec<u8> {
let mut state = seed;
let mut data = Vec::with_capacity(len);
for _ in 0..len {
state = state
.wrapping_mul(6364136223846793005)
.wrapping_add(1442695040888963407);
data.push((state >> 33) as u8);
}
data
}
let i = 23u64;
let len = (i * 89 % 16384) as usize;
let mut data = generate_data(i, len);
let repeat = data[128..256].to_vec();
data.extend_from_slice(&repeat);
data.extend_from_slice(&repeat);
let mut driver = MatchGeneratorDriver::new(1024 * 128, 1);
driver.set_source_size_hint(data.len() as u64);
driver.reset(CompressionLevel::Fastest);
let mut space = driver.get_next_space();
space[..data.len()].copy_from_slice(&data);
space.truncate(data.len());
driver.commit_space(space);
let mut rebuilt = Vec::with_capacity(data.len());
let mut saw_triple = false;
driver.start_matching(|seq| match seq {
Sequence::Literals { literals } => rebuilt.extend_from_slice(literals),
Sequence::Triple {
literals,
offset,
match_len,
} => {
saw_triple = true;
rebuilt.extend_from_slice(literals);
assert!(offset > 0, "offset must be non-zero");
assert!(
offset <= rebuilt.len(),
"offset must reference already-produced bytes: offset={} produced={}",
offset,
rebuilt.len()
);
let start = rebuilt.len() - offset;
for idx in 0..match_len {
let b = rebuilt[start + idx];
rebuilt.push(b);
}
}
});
let _ = saw_triple;
assert_eq!(rebuilt, data);
}
#[test]
fn fast_levels_dispatch_per_level_hash_log_and_mls() {
let f1 = resolve_level_params(CompressionLevel::Level(1), None)
.fast
.unwrap();
assert_eq!(f1.hash_log, 14);
assert_eq!(f1.mls, 7);
assert_eq!(f1.step_size, 2);
for n in -7..=-1 {
let f = resolve_level_params(CompressionLevel::Level(n), None)
.fast
.unwrap();
assert_eq!(f.hash_log, 13, "Level({n}) fast_hash_log");
assert_eq!(f.mls, 6, "Level({n}) fast_mls");
let expected_step = ((-n) as usize) + 1;
assert_eq!(f.step_size, expected_step, "Level({n}) fast_step_size");
}
let pf = resolve_level_params(CompressionLevel::Fastest, None);
let ff = pf.fast.unwrap();
assert_eq!(
(pf.window_log, ff.hash_log, ff.mls, ff.step_size),
(19, 14, 7, 2),
);
let pu = resolve_level_params(CompressionLevel::Uncompressed, None);
let fu = pu.fast.unwrap();
assert_eq!(
(pu.window_log, fu.hash_log, fu.mls, fu.step_size),
(17, 14, 6, 2),
);
}
#[test]
fn fast_levels_driver_wiring_threads_cparams_into_inner_matcher() {
let mut driver = MatchGeneratorDriver::new(64 * 1024, 1);
let fast_levels = [
CompressionLevel::Level(1),
CompressionLevel::Fastest,
CompressionLevel::Uncompressed,
CompressionLevel::Level(-1),
CompressionLevel::Level(-2),
CompressionLevel::Level(-3),
CompressionLevel::Level(-4),
CompressionLevel::Level(-5),
CompressionLevel::Level(-6),
CompressionLevel::Level(-7),
];
for &level in &fast_levels {
let p = resolve_level_params(level, None);
assert_eq!(
p.strategy_tag,
super::super::strategy::StrategyTag::Fast,
"{level:?} must resolve to Fast strategy",
);
crate::encoding::Matcher::reset(&mut driver, CompressionLevel::Default);
crate::encoding::Matcher::reset(&mut driver, level);
let f = p.fast.unwrap();
let m = driver.simple_mut();
assert_eq!(
m.hash_log(),
f.hash_log,
"{level:?}: inner matcher hash_log mismatch — argument swap?",
);
assert_eq!(
m.mls(),
f.mls,
"{level:?}: inner matcher mls mismatch — argument swap?",
);
assert_eq!(
m.step_size(),
f.step_size,
"{level:?}: inner matcher step_size mismatch — stale value carried from prior reset?",
);
}
}
#[test]
fn lazy_band_target_len_matches_default_table() {
let expected: [(i32, usize); 11] = [
(5, 2),
(6, 4),
(7, 8),
(8, 16),
(9, 16),
(10, 16),
(11, 16),
(12, 32),
(13, 32),
(14, 32),
(15, 32),
];
for (level, want) in expected {
let params = resolve_level_params(CompressionLevel::Level(level), None);
let target_len = params
.hc
.map(|hc| hc.target_len)
.or_else(|| params.row.map(|row| row.target_len))
.expect("lazy/greedy level carries hc or row config");
assert_eq!(target_len, want, "L{level}: target_len must match table[0]");
}
}
#[test]
fn upper_lazy_band_params_match_default_table() {
let expected: [(i32, u8, usize, usize, usize); 3] = [
(13, 22, 22, 22, 1 << 4),
(14, 22, 23, 22, 1 << 5),
(15, 22, 23, 23, 1 << 6),
];
for (level, wlog, hlog, clog, sd) in expected {
let params = resolve_level_params(CompressionLevel::Level(level), None);
let hc = params.hc.unwrap();
assert_eq!(hc.search_depth, sd, "L{level}: search_depth");
assert_eq!(params.window_log, wlog, "L{level}: window_log");
assert_eq!(hc.hash_log, hlog, "L{level}: hash_log");
assert_eq!(hc.chain_log, clog, "L{level}: chain_log");
}
}