mirror of
https://github.com/jmcorgan/fips.git
synced 2026-07-30 11:36:15 +00:00
Johnathan Corgan
7493153a89
The tick arm runs twenty-six housekeeping steps in sequence on the one runtime thread, and is polled last, so anything slow in it holds up inbound packets, TUN traffic and control commands behind it. Field evidence says that happens for over a second at a time, but the attribution behind that is two months old and predates the connect-on-send gate, the control read isolation, and the peer lifecycle rework. This measures it rather than continuing to reason about it. Per step it records exact count, max and total into fixed static counters; a dedicated writer thread drains them every ten seconds to a TSV under /var/log/fips, one file per capture, capped at 32 MB. Nothing accumulates: the counters are swapped to zero each interval and the thread holds no history. Arming is `fipsctl profile tick on`, served in the control accept task so the toggle cannot queue behind the very behaviour it measures, and it does not survive a restart. The whole thing is behind a Cargo feature that is off by default, because the risk worth eliminating is the twenty-six edited call sites in the hot loop. With the feature off the macro expands to the bare expression, which makes the default build's neutrality something you read off the generated code rather than something a benchmark fails to disprove. The measurement that matters is how late each tick is against the deadline it was scheduled for, since the arm is polled last and that lateness is the delay. Two earlier designs derived it from the interval between entries and both under-reported: the schedule is fixed, so a steady delay leaves every gap exactly one period and any gap-derived figure reads zero under precisely the sustained overload this is meant to find. The interval hands back its own deadline, so the delay is now a subtraction with no model behind it, and a test drives three late ticks at a constant gap to keep it that way. CI gains a default-features clippy and a feature-on build and test on both runners, closing the gap left by clippy already running with all features.
104 lines
3.6 KiB
Rust
104 lines
3.6 KiB
Rust
//! FIPS: Free Internetworking Peering System
|
|
//!
|
|
//! A distributed, decentralized network routing protocol for mesh nodes
|
|
//! connecting over arbitrary transports.
|
|
|
|
// Name the `alloc` crate directly so the sans-IO protocol cores can spell their
|
|
// heap-type imports in `no_std`-forward form (`alloc::sync::Arc`,
|
|
// `alloc::collections::BTreeMap`). The crate remains `std`; this only reduces the
|
|
// distance to extracting the pure cores into a `no_std` crate later.
|
|
extern crate alloc;
|
|
|
|
pub mod cache;
|
|
pub mod config;
|
|
pub mod control;
|
|
#[cfg(target_os = "linux")]
|
|
pub mod gateway;
|
|
pub mod identity;
|
|
// Declared before `node` (and named to sort there) because it carries
|
|
// `#[macro_use]`: the tick instrumentation macro must be in scope for the
|
|
// modules that follow.
|
|
#[macro_use]
|
|
pub(crate) mod instr;
|
|
pub mod mdns;
|
|
pub mod node;
|
|
pub mod noise;
|
|
pub mod nostr;
|
|
pub mod peer;
|
|
pub mod perf_profile;
|
|
pub(crate) mod proto;
|
|
#[cfg(test)]
|
|
pub(crate) mod testutil;
|
|
mod time;
|
|
pub mod transport;
|
|
pub mod upper;
|
|
pub mod utils;
|
|
pub mod version;
|
|
|
|
// Re-export identity types
|
|
pub use identity::{
|
|
AuthChallenge, AuthResponse, FipsAddress, Identity, IdentityError, NodeAddr, PeerIdentity,
|
|
decode_npub, decode_nsec, decode_secret, encode_npub, encode_nsec,
|
|
};
|
|
|
|
// Re-export config types
|
|
pub use config::{Config, ConfigError, IdentityConfig, NymConfig, TorConfig, UdpConfig};
|
|
pub use upper::config::{DnsConfig, TunConfig};
|
|
|
|
// Re-export nostr rendezvous handoff types
|
|
pub use nostr::{BootstrapHandoffResult, EstablishedTraversal, is_punch_packet};
|
|
|
|
// Re-export tree types (relocated from tree:: to proto::stp)
|
|
pub use proto::stp::{
|
|
CoordEntry, CoordError, ParentDeclaration, TreeCoordinate, TreeError, TreeState,
|
|
};
|
|
|
|
// Re-export bloom filter types (relocated from bloom:: to proto::bloom)
|
|
pub use proto::bloom::{BloomError, BloomFilter, BloomState};
|
|
|
|
// Re-export transport types
|
|
pub use transport::udp::UdpTransport;
|
|
pub use transport::{
|
|
DiscoveredPeer, Link, LinkDirection, LinkId, LinkState, LinkStats, PacketRx, PacketTx,
|
|
ReceivedPacket, Transport, TransportAddr, TransportError, TransportHandle, TransportId,
|
|
TransportState, TransportType, packet_channel,
|
|
};
|
|
|
|
// Re-export link-layer types (relocated from protocol:: to proto::link)
|
|
pub use proto::link::{LinkMessageType, SessionDatagram};
|
|
|
|
// Re-export the shared protocol error (relocated from protocol:: to proto::Error)
|
|
pub use proto::Error;
|
|
|
|
// Re-export FSP session wire types (relocated from protocol:: to proto::fsp)
|
|
pub use proto::fsp::{SessionAck, SessionFlags, SessionMessageType, SessionSetup};
|
|
|
|
// Re-export STP wire types (relocated from protocol:: to proto::stp)
|
|
pub use proto::stp::TreeAnnounce;
|
|
|
|
// Re-export bloom wire types (relocated from protocol:: to proto::bloom)
|
|
pub use proto::bloom::FilterAnnounce;
|
|
|
|
// Re-export discovery wire types (relocated from protocol:: to proto::lookup)
|
|
pub use proto::lookup::{LookupRequest, LookupResponse};
|
|
|
|
// Re-export routing wire types (relocated from protocol:: to proto::routing)
|
|
pub use proto::routing::{
|
|
COORDS_REQUIRED_SIZE, CoordsRequired, MTU_EXCEEDED_SIZE, MtuExceeded, PathBroken,
|
|
};
|
|
|
|
// Re-export FMP link-framing wire type (relocated from protocol:: to proto::fmp)
|
|
pub use proto::fmp::HandshakeMessageType;
|
|
|
|
// Re-export cache types
|
|
pub use cache::{CacheEntry, CacheError, CacheStats, CoordCache};
|
|
|
|
// Re-export FMP tie-break helper and promotion result (relocated from peer:: to proto::fmp)
|
|
pub use proto::fmp::{PromotionResult, cross_connection_winner};
|
|
|
|
// Re-export peer types
|
|
pub use peer::{ActivePeer, ConnectivityState, PeerError};
|
|
|
|
// Re-export node types
|
|
pub use node::{Node, NodeError, NodeState, UpdatePeersOutcome};
|