keyhog-scanner 0.5.41

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

//! `scan_inner` prepare/phase-1 overhead profiler, split out of `engine/scan.rs`
//! to keep that file under the standard 500-LOC cap.
//!
//! MEASUREMENT (`keyhog scan --profile`): per-`scan_inner` `prepare_chunk`
//! (preprocessing) + phase-1 (`collect_triggered_patterns`) overhead, the part
//! the phase-2 profiler does NOT capture, paid once per chunk incl. every decode
//! sub-chunk. `scan_inner_profile_dump()` prints + resets. Zero-cost unset.

use std::sync::atomic::AtomicU64;

pub(super) static SCAN_PREPARE_NS: AtomicU64 = AtomicU64::new(0);
pub(super) static SCAN_PHASE1_NS: AtomicU64 = AtomicU64::new(0);
pub(super) static SCAN_INNER_CALLS: AtomicU64 = AtomicU64::new(0);

pub(super) fn scan_inner_prof_enabled() -> bool {
    super::profile::enabled()
}

/// Print + reset the prepare/phase-1 overhead counters.
pub(crate) fn scan_inner_profile_dump() {
    use std::sync::atomic::Ordering::Relaxed;
    let prep = SCAN_PREPARE_NS.swap(0, Relaxed) as f64 / 1e6;
    let p1 = SCAN_PHASE1_NS.swap(0, Relaxed) as f64 / 1e6;
    let calls = SCAN_INNER_CALLS.swap(0, Relaxed);
    if calls == 0 && prep == 0.0 && p1 == 0.0 {
        return;
    }
    eprintln!(
        "scan_inner overhead: calls={calls} prepare={prep:.1}ms phase1={p1:.1}ms \
         ({:.2} µs/call prep+p1)",
        if calls > 0 {
            (prep + p1) * 1000.0 / calls as f64
        } else {
            0.0
        }
    );
}

pub(crate) fn scan_inner_profile_reset() {
    use std::sync::atomic::Ordering::Relaxed;
    SCAN_PREPARE_NS.store(0, Relaxed);
    SCAN_PHASE1_NS.store(0, Relaxed);
    SCAN_INNER_CALLS.store(0, Relaxed);
}