fips-core 0.3.82

Reusable FIPS mesh, endpoint, transport, and protocol library
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
53
54
55
56
57
58
59
60
61
62
63
64
65

use std::time::Duration;

/// Read-only control queries are status/observability work, not dataplane bulk.
/// Keep their reserved slice tiny so a burst of fipstop/fipsctl reads cannot
/// convoy ahead of packet receive or endpoint/TUN progress.
pub(super) const CONTROL_QUERY_INTERLEAVE_BUDGET: usize = 4;
/// Endpoint commands are app/control-facing work. Keep their reserved slice
/// short so peer status, liveness, and route queries cannot convoy ahead of
/// packet receive.
pub(super) const ENDPOINT_DRAIN_BUDGET: usize = 16;
/// Raw receive burst cap for pure bulk. Four Linux UDP receive batches keeps
/// high-throughput streams from paying scheduler overhead on every kernel
/// drain.
pub(super) const PACKET_DRAIN_BUDGET: usize = 512;
/// Raw receive burst cap when protocol/control, TUN, or endpoint work is
/// already waiting. Two Linux UDP receive batches are enough to amortize kernel
/// drains without sitting on the runtime for a long GSO-heavy turn.
pub(super) const LATENCY_PACKET_DRAIN_BUDGET: usize = 256;
/// TUN outbound is canonical packet ingress, not a side-control queue. Give it
/// a dataplane-sized slice whenever it is co-drained with hot UDP receive.
pub(super) const TUN_DRAIN_BUDGET: usize = LATENCY_PACKET_DRAIN_BUDGET;
/// Bulk service is multiple canonical dataplane turns, capped so control/timer work
/// gets a regular select boundary even under a continuously ready receive lane.
pub(super) const RX_LOOP_BULK_SERVICE_MAX_TURNS: usize = 8;
pub(super) const RX_LOOP_BULK_SERVICE_MAX_ELAPSED: Duration = Duration::from_millis(2);
pub(super) const RX_LOOP_SLOW_MAINTENANCE_IDLE_TIMEOUT: Duration = Duration::from_millis(100);
pub(super) const RX_LOOP_SLOW_MAINTENANCE_BUSY_TIMEOUT: Duration = Duration::from_millis(10);
pub(super) const RX_LOOP_RECENT_DATA_ACTIVITY_WINDOW: Duration = Duration::from_secs(2);
const RX_LOOP_FAULT_MAX_DELAY_MS: u64 = 5_000;

pub(super) fn endpoint_drain_budget(packet_budget: usize) -> usize {
    packet_budget.min(ENDPOINT_DRAIN_BUDGET)
}

pub(super) fn tun_drain_budget(packet_budget: usize) -> usize {
    packet_budget.min(TUN_DRAIN_BUDGET)
}

pub(super) fn packet_drain_budget(latency_work_ready: bool) -> usize {
    if latency_work_ready {
        LATENCY_PACKET_DRAIN_BUDGET
    } else {
        PACKET_DRAIN_BUDGET
    }
}

pub(super) fn mixed_dataplane_crypto_budget(
    packet_budget: usize,
    endpoint_budget: usize,
    tun_budget: usize,
) -> usize {
    packet_budget
        .saturating_add(endpoint_budget)
        .saturating_add(tun_budget)
}

pub(super) fn rx_loop_slow_maintenance_fault_delay() -> Option<Duration> {
    let raw = std::env::var("FIPS_FAULT_INJECT_RX_LOOP_SLOW_MAINTENANCE_MS").ok()?;
    let ms = raw
        .trim()
        .parse::<u64>()
        .ok()?
        .min(RX_LOOP_FAULT_MAX_DELAY_MS);
    (ms > 0).then(|| Duration::from_millis(ms))
}