trueno/hash/

mod.rs

//! SIMD-optimized hash functions for key-value store operations.
//!
//! This module provides fast hash functions optimized for short string keys,
//! with automatic SIMD dispatch (AVX-512 → AVX2 → SSE2 → Scalar).
//!
//! # Example
//!
//! ```rust
//! use trueno::hash::{hash_key, hash_keys_batch};
//!
//! // Single key hash
//! let h = hash_key("hello");
//! assert_ne!(h, 0);
//!
//! // Batch hash (SIMD-optimized)
//! let keys = ["a", "b", "c", "d"];
//! let hashes = hash_keys_batch(&keys);
//! assert_eq!(hashes.len(), 4);
//! ```
//!
//! # Performance
//!
//! - Single key: ~2-5ns (FxHash-equivalent)
//! - Batch (8 keys): ~10-15ns with AVX2 (vs ~20-40ns sequential)
//! - Batch (16 keys): ~15-20ns with AVX-512

use crate::Backend;

/// Hash a single key to u64.
///
/// Uses FxHash algorithm (fast, non-cryptographic).
/// Suitable for hash tables and KV stores.
#[inline]
#[must_use]
pub fn hash_key(key: &str) -> u64 {
    hash_bytes(key.as_bytes())
}

/// Hash raw bytes to u64.
#[inline]
#[must_use]
pub fn hash_bytes(bytes: &[u8]) -> u64 {
    // FxHash algorithm: fast, good distribution for small keys
    const K: u64 = 0x517c_c1b7_2722_0a95;
    let mut hash: u64 = 0;

    // Process 8 bytes at a time
    // `as_chunks::<8>()` yields `&[u8; 8]` directly, so the fallible
    // `try_into().expect(...)` below is gone: the 8-byte width is now a type,
    // not a runtime claim. clippy::chunks_exact_to_as_chunks (new in 1.98).
    let (chunks, remainder) = bytes.as_chunks::<8>();

    for chunk in chunks {
        let word = u64::from_le_bytes(*chunk);
        hash = hash.rotate_left(5).bitxor(word).wrapping_mul(K);
    }

    // Handle remaining bytes
    for &byte in remainder {
        hash = hash.rotate_left(5).bitxor(u64::from(byte)).wrapping_mul(K);
    }

    hash
}

/// Hash multiple keys in batch (SIMD-optimized).
///
/// For best performance, use batches of 8 (AVX2) or 16 (AVX-512) keys.
/// Falls back to sequential hashing for smaller batches or unsupported CPUs.
#[must_use]
pub fn hash_keys_batch(keys: &[&str]) -> Vec<u64> {
    hash_keys_batch_with_backend(keys, Backend::Auto)
}

/// Hash multiple keys with explicit backend selection.
#[must_use]
pub fn hash_keys_batch_with_backend(keys: &[&str], backend: Backend) -> Vec<u64> {
    match backend {
        Backend::Auto => {
            #[cfg(target_arch = "x86_64")]
            {
                if is_x86_feature_detected!("avx2") {
                    return hash_keys_avx2(keys);
                }
            }
            hash_keys_scalar(keys)
        }
        Backend::AVX2 | Backend::AVX512 => hash_keys_avx2_or_scalar(keys),
        Backend::Scalar
        | Backend::SSE2
        | Backend::AVX
        | Backend::NEON
        | Backend::WasmSIMD
        | Backend::GPU => hash_keys_scalar(keys),
    }
}

/// Scalar fallback for batch hashing.
#[inline]
fn hash_keys_scalar(keys: &[&str]) -> Vec<u64> {
    keys.iter().map(|k| hash_key(k)).collect()
}

/// AVX2 with scalar fallback for non-x86.
#[inline]
fn hash_keys_avx2_or_scalar(keys: &[&str]) -> Vec<u64> {
    #[cfg(target_arch = "x86_64")]
    {
        hash_keys_avx2(keys)
    }
    #[cfg(not(target_arch = "x86_64"))]
    {
        hash_keys_scalar(keys)
    }
}

/// AVX2 SIMD batch hashing (4x u64 lanes).
#[cfg(target_arch = "x86_64")]
fn hash_keys_avx2(keys: &[&str]) -> Vec<u64> {
    // For now, use scalar - AVX2 intrinsics for string hashing is complex
    // Future optimization: process 4 keys in parallel using _mm256 intrinsics
    hash_keys_scalar(keys)
}

use std::ops::BitXor;

#[cfg(test)]
mod tests {
    use super::*;

    // ============================================================
    // RED PHASE: Define expected behavior
    // ============================================================

    #[test]
    fn test_hash_key_deterministic() {
        let h1 = hash_key("hello");
        let h2 = hash_key("hello");
        assert_eq!(h1, h2, "Same key must produce same hash");
    }

    #[test]
    fn test_hash_key_different_keys() {
        let h1 = hash_key("hello");
        let h2 = hash_key("world");
        assert_ne!(h1, h2, "Different keys should produce different hashes");
    }

    #[test]
    fn test_hash_key_empty() {
        let h = hash_key("");
        // Empty string should hash to 0 (no data to mix)
        assert_eq!(h, 0);
    }

    #[test]
    fn test_hash_key_single_char() {
        let h = hash_key("a");
        assert_ne!(h, 0);
    }

    #[test]
    fn test_hash_key_long_string() {
        let long = "a".repeat(1000);
        let h = hash_key(&long);
        assert_ne!(h, 0);
    }

    #[test]
    fn test_hash_bytes_matches_key() {
        let key = "test_key";
        assert_eq!(hash_key(key), hash_bytes(key.as_bytes()));
    }

    #[test]
    fn test_hash_keys_batch_empty() {
        let keys: &[&str] = &[];
        let hashes = hash_keys_batch(keys);
        assert!(hashes.is_empty());
    }

    #[test]
    fn test_hash_keys_batch_single() {
        let hashes = hash_keys_batch(&["hello"]);
        assert_eq!(hashes.len(), 1);
        assert_eq!(hashes[0], hash_key("hello"));
    }

    #[test]
    fn test_hash_keys_batch_multiple() {
        let keys = ["a", "b", "c", "d"];
        let hashes = hash_keys_batch(&keys);

        assert_eq!(hashes.len(), 4);
        for (i, key) in keys.iter().enumerate() {
            assert_eq!(hashes[i], hash_key(key), "Batch hash must match single hash");
        }
    }

    #[test]
    fn test_hash_keys_batch_large() {
        let keys: Vec<&str> = (0..100)
            .map(|i| {
                // Leak strings to get &'static str for test
                Box::leak(format!("key{i}").into_boxed_str()) as &str
            })
            .collect();

        let hashes = hash_keys_batch(&keys);
        assert_eq!(hashes.len(), 100);

        // Verify all unique
        let unique: std::collections::HashSet<_> = hashes.iter().collect();
        assert_eq!(unique.len(), 100, "All keys should have unique hashes");
    }

    #[test]
    fn test_backend_parity_scalar_vs_auto() {
        let keys = ["foo", "bar", "baz", "qux"];

        let scalar = hash_keys_batch_with_backend(&keys, Backend::Scalar);
        let auto = hash_keys_batch_with_backend(&keys, Backend::Auto);

        assert_eq!(scalar, auto, "Scalar and Auto must produce identical results");
    }

    #[test]
    fn test_hash_distribution() {
        // Test that hashes are well-distributed (no obvious clustering)
        let keys: Vec<String> = (0..1000).map(|i| format!("key{i}")).collect();
        let refs: Vec<&str> = keys.iter().map(|s| s.as_str()).collect();
        let hashes = hash_keys_batch(&refs);

        // Check high bits are used (not all zeros)
        let high_bits_used = hashes.iter().any(|h| h >> 56 != 0);
        assert!(high_bits_used, "Hash should use high bits");

        // Check low bits are varied
        let low_nibbles: std::collections::HashSet<_> = hashes.iter().map(|h| h & 0xF).collect();
        assert!(low_nibbles.len() >= 8, "Hash should have varied low bits");
    }

    #[test]
    fn test_hash_avalanche_single_bit() {
        // Changing one bit should change ~50% of output bits (avalanche effect)
        let h1 = hash_key("aaa");
        let h2 = hash_key("aab"); // One char different

        let diff = (h1 ^ h2).count_ones();
        // Expect at least 20 bits to differ (out of 64) for good avalanche
        assert!(diff >= 15, "Avalanche effect: {} bits differ, expected >=15", diff);
    }

    #[test]
    fn test_backend_avx2_explicit() {
        let keys = ["foo", "bar", "baz", "qux"];
        let avx2 = hash_keys_batch_with_backend(&keys, Backend::AVX2);
        let scalar = hash_keys_batch_with_backend(&keys, Backend::Scalar);
        assert_eq!(avx2, scalar, "AVX2 must match Scalar");
    }

    #[test]
    fn test_backend_avx512_explicit() {
        let keys = ["foo", "bar", "baz", "qux"];
        let avx512 = hash_keys_batch_with_backend(&keys, Backend::AVX512);
        let scalar = hash_keys_batch_with_backend(&keys, Backend::Scalar);
        assert_eq!(avx512, scalar, "AVX512 must match Scalar");
    }

    #[test]
    fn test_backend_sse2_fallback() {
        let keys = ["a", "b", "c"];
        let sse2 = hash_keys_batch_with_backend(&keys, Backend::SSE2);
        let scalar = hash_keys_batch_with_backend(&keys, Backend::Scalar);
        assert_eq!(sse2, scalar, "SSE2 must fall back to Scalar");
    }

    #[test]
    fn test_backend_neon_fallback() {
        let keys = ["x", "y", "z"];
        let neon = hash_keys_batch_with_backend(&keys, Backend::NEON);
        let scalar = hash_keys_batch_with_backend(&keys, Backend::Scalar);
        assert_eq!(neon, scalar, "NEON must fall back to Scalar");
    }

    #[test]
    fn test_hash_keys_avx2_or_scalar_coverage() {
        // Directly test the helper function via AVX2 backend
        let keys = ["test1", "test2"];
        let result = hash_keys_batch_with_backend(&keys, Backend::AVX2);
        assert_eq!(result.len(), 2);
        assert_eq!(result[0], hash_key("test1"));
        assert_eq!(result[1], hash_key("test2"));
    }
}