keyhog-scanner 0.5.37

keyhog-scanner: high-performance SIMD-accelerated secret detection engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! One-line startup banner formatter. Stable text shape is part of
//! the CLI contract (parsed by the `keyhog backend` text-vs-JSON
//! diffing tests).

use super::HardwareCaps;

/// Format a one-line startup banner summarizing detected hardware.
pub fn startup_banner(caps: &HardwareCaps, detector_count: usize, pattern_count: usize) -> String {
    let gpu = if let Some(name) = &caps.gpu_name {
        if caps.gpu_is_software {
            // Software-only adapters (llvmpipe, lavapipe, swiftshader) get
            // detected and probed, but `select_backend` rejects them
            // because dispatching the literal-set pipeline through CPU-
            // emulated GL/Vulkan is slower than just running the SIMD
            // path directly. Surface this in the banner so users on
            // headless boxes (CI runners, containers) understand why
            // their scan is using SIMD even though `keyhog backend`
            // shows a "GPU" line.
            format!("GPU: {name} (software, ignored)")
        } else {
            format!("GPU: {name}")
        }
    } else {
        "GPU: none".to_string()
    };

    let simd = if caps.has_avx512 {
        "AVX-512"
    } else if caps.has_avx2 {
        "AVX2"
    } else if caps.has_neon {
        "NEON"
    } else {
        "scalar"
    };

    let hs = if caps.hyperscan_available {
        "Hyperscan"
    } else {
        "AC"
    };
    let uring = if caps.io_uring_available {
        " io_uring"
    } else {
        ""
    };

    format!(
        "{} cores | {} | SIMD: {} | {} | {detector_count} detectors ({pattern_count} patterns){uring}",
        caps.physical_cores, gpu, simd, hs,
    )
}