Nils Andreas Svee
9e3477e617
On Linux, best-effort upgrade the socket's SO_TIMESTAMPING flags to TX_SOFTWARE | OPT_ID | OPT_TSONLY after a successful Open and before the first Echo probe. Promote the #103 error-queue foundation to production: MSG_ERRQUEUE is drained opportunistically with a fixed per-call budget at several natural choke points (after a probe send, before processing a reply, before evaluating timeouts), and each automatic OPT_ID timestamp is correlated directly with wire_seq — safe because Linux rolls back its speculative sk_tskey increment on every send failure, wire_seq and the kernel counter start together at every Open, and a socket can never be reopened for a second session. The observed kernel TX wall timestamp is retained on PendingProbe (surviving pending -> timed-out retention) as dormant metadata only; RTT, OWD, and IPDV are unchanged and continue to use the userspace send timestamp exclusively. Capability failure is fully non-fatal and RX timestamping is unaffected either way. Non-Linux and non-ancillary builds are unchanged.
807 lines
29 KiB
Rust
807 lines
29 KiB
Rust
use std::{
|
|
io,
|
|
net::{SocketAddr, UdpSocket},
|
|
time::{Duration, Instant},
|
|
};
|
|
|
|
#[cfg(test)]
|
|
use std::cell::Cell;
|
|
|
|
#[cfg(test)]
|
|
use irtt_proto::{flags, Params, TimestampFields, PROTOCOL_VERSION};
|
|
|
|
use crate::{
|
|
config::{ClientConfig, RecvBudget},
|
|
error::ClientError,
|
|
event::{ClientEvent, OpenOutcome},
|
|
receive::{drain_tx_timestamps, recv_datagram, try_enable_tx_timestamping},
|
|
session::machine::{
|
|
recv_buffer_size, OpenDatagramDisposition, PreparedOpenAcceptance, ProbeSent,
|
|
SessionMachine, MAX_OPEN_PACKET_SIZE,
|
|
},
|
|
socket::{connect_udp_socket, resolve_remote, validate_open_timeouts},
|
|
socket_options::{apply_traffic_class_to_socket, clear_dscp_on_socket},
|
|
timing::ClientTimestamp,
|
|
};
|
|
|
|
pub(crate) mod schedule;
|
|
|
|
use schedule::{instant_abs_diff, ProbeSchedule};
|
|
|
|
#[derive(Debug, Clone, Copy)]
|
|
enum ProbeScheduleMode {
|
|
CallerPaced,
|
|
#[cfg(test)]
|
|
Managed {
|
|
scheduled_at: Instant,
|
|
},
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
struct PreparedClientOpen {
|
|
machine: PreparedOpenAcceptance,
|
|
schedule: Option<ProbeSchedule>,
|
|
recv_buffer_len: Option<usize>,
|
|
negotiated_traffic_class: Option<u8>,
|
|
previous_traffic_class: Option<u8>,
|
|
post_open_recv_timeout: Option<Duration>,
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
struct PreparedClientOpenFailure {
|
|
primary: ClientError,
|
|
machine: PreparedOpenAcceptance,
|
|
}
|
|
|
|
#[cfg(test)]
|
|
#[derive(Debug, Default)]
|
|
struct ClientTestHooks {
|
|
fail_open_dscp: Cell<bool>,
|
|
fail_open_timeout_restore: Cell<bool>,
|
|
fail_close_event_reserve: Cell<bool>,
|
|
fail_close_dscp_clear: Cell<bool>,
|
|
fail_close_send: Cell<bool>,
|
|
close_reported_len: Cell<Option<usize>>,
|
|
close_send_attempts: Cell<usize>,
|
|
close_sent_at: Cell<Option<ClientTimestamp>>,
|
|
fail_cleanup_send: Cell<bool>,
|
|
recv_buffer_len_override: Cell<Option<usize>>,
|
|
fail_dscp_restore: Cell<bool>,
|
|
last_restored_read_timeout: Cell<Option<Duration>>,
|
|
prepared_active_session_before_dscp: Cell<bool>,
|
|
}
|
|
|
|
#[cfg(test)]
|
|
#[derive(Debug, Clone, Copy)]
|
|
pub(crate) struct ProbeSendTimestamps {
|
|
pub(crate) permission_at: Instant,
|
|
pub(crate) sent_at: ClientTimestamp,
|
|
pub(crate) send_call_start: Instant,
|
|
pub(crate) send_finished_at: Instant,
|
|
}
|
|
|
|
#[cfg(test)]
|
|
use crate::{
|
|
session::machine::{
|
|
compute_one_way, compute_rtt, params_from_config, sequence_is_after, sequence_is_before,
|
|
unix_epoch_ns_i64, update_highest_received,
|
|
},
|
|
session::negotiate_params,
|
|
NegotiatedParams, RunMode, SignedDuration, WarningKind, MAX_UDP_PAYLOAD_LENGTH,
|
|
};
|
|
|
|
/// Low-level synchronous IRTT client.
|
|
///
|
|
/// `Client` exposes the protocol steps directly: connect a UDP socket, open a
|
|
/// session, send probes, receive replies, poll timeouts, and close. Callers
|
|
/// that do not need to own this loop can use the unified managed API in
|
|
/// [`crate::managed`] when the `tokio` feature is enabled.
|
|
#[derive(Debug)]
|
|
pub struct Client {
|
|
runtime: SessionMachine,
|
|
schedule: Option<ProbeSchedule>,
|
|
socket: UdpSocket,
|
|
remote: SocketAddr,
|
|
recv_buffer: Vec<u8>,
|
|
applied_traffic_class: Option<u8>,
|
|
/// Whether the socket's `SO_TIMESTAMPING` flags carry `TX_SOFTWARE` +
|
|
/// `OPT_ID` + `OPT_TSONLY`. Always `false` off Linux, without the
|
|
/// `ancillary` feature, or before the best-effort post-Open upgrade;
|
|
/// tracked here (adapter-owned capability, not protocol state) so
|
|
/// unnecessary error-queue drains are skipped once it is known there is
|
|
/// nothing to drain.
|
|
tx_timestamping_enabled: bool,
|
|
#[cfg(test)]
|
|
test_hooks: ClientTestHooks,
|
|
#[cfg(test)]
|
|
probe_reported_len: Option<usize>,
|
|
#[cfg(test)]
|
|
probe_send_error: bool,
|
|
#[cfg(test)]
|
|
probe_send_timestamps: Option<ProbeSendTimestamps>,
|
|
}
|
|
|
|
impl Client {
|
|
/// Resolve the configured server and create a connected UDP socket.
|
|
///
|
|
/// This validates local configuration and prepares the open request, but it
|
|
/// does not contact the server. Call [`open`](Self::open) to perform the
|
|
/// IRTT open exchange.
|
|
pub fn connect(config: ClientConfig) -> Result<Self, ClientError> {
|
|
validate_open_timeouts(&config.open_timeouts)?;
|
|
let remote = resolve_remote(&config)?;
|
|
let runtime = SessionMachine::new(config.clone(), remote)?;
|
|
let socket = connect_udp_socket(&config.socket_config, remote)?;
|
|
|
|
Ok(Self {
|
|
runtime,
|
|
schedule: None,
|
|
socket,
|
|
remote,
|
|
recv_buffer: vec![0_u8; recv_buffer_size(false, None)?],
|
|
applied_traffic_class: None,
|
|
tx_timestamping_enabled: false,
|
|
#[cfg(test)]
|
|
test_hooks: ClientTestHooks::default(),
|
|
#[cfg(test)]
|
|
probe_reported_len: None,
|
|
#[cfg(test)]
|
|
probe_send_error: false,
|
|
#[cfg(test)]
|
|
probe_send_timestamps: None,
|
|
})
|
|
}
|
|
|
|
/// Perform the IRTT open exchange.
|
|
///
|
|
/// On success, returns the negotiated open outcome and transitions the
|
|
/// client into either an open probe session or completed no-test state.
|
|
/// Open attempts use [`ClientConfig::open_timeouts`]. Malformed, unrelated,
|
|
/// or unauthenticated datagrams are ignored until the current attempt's
|
|
/// absolute deadline, so one attempt may consume several datagrams without
|
|
/// retransmitting. Silence or ignored traffic eventually produces
|
|
/// [`ClientError::OpenTimeout`], while authenticated incompatibility remains
|
|
/// terminal.
|
|
///
|
|
/// When a trusted reply allocates a token but later negotiation or socket
|
|
/// preparation fails, the client sends a best-effort cleanup close and
|
|
/// preserves the original failure. Failed opening never leaves the session
|
|
/// machine open.
|
|
pub fn open(&mut self) -> Result<OpenOutcome, ClientError> {
|
|
let result = self.open_transaction();
|
|
if result.is_err() {
|
|
let _ =
|
|
self.restore_open_read_timeout(self.runtime.config().socket_config.recv_timeout);
|
|
}
|
|
result
|
|
}
|
|
|
|
/// Send a close request and emit a [`ClientEvent::SessionClosed`] event.
|
|
///
|
|
/// The close event means the client has sent its close packet and stopped
|
|
/// tracking the session locally; it is not a server acknowledgement. If the
|
|
/// send fails, the negotiated DSCP is restored best-effort and the session
|
|
/// and probe schedule remain open.
|
|
pub fn close(&mut self) -> Result<Vec<ClientEvent>, ClientError> {
|
|
let prepared = self.runtime.prepare_close()?;
|
|
let mut events = Vec::new();
|
|
#[cfg(test)]
|
|
if self.test_hooks.fail_close_event_reserve.replace(false) {
|
|
events
|
|
.try_reserve(usize::MAX)
|
|
.map_err(|source| ClientError::AllocationFailed {
|
|
operation: "close event result",
|
|
source,
|
|
})?;
|
|
}
|
|
events
|
|
.try_reserve(1)
|
|
.map_err(|source| ClientError::AllocationFailed {
|
|
operation: "close event result",
|
|
source,
|
|
})?;
|
|
let previous_traffic_class = self.applied_traffic_class;
|
|
let expected_bytes = prepared.bytes.len();
|
|
|
|
self.clear_close_dscp()?;
|
|
let bytes = match self.send_close_datagram(prepared.bytes) {
|
|
Ok(bytes) => bytes,
|
|
Err(err) => {
|
|
self.restore_dscp_best_effort(previous_traffic_class);
|
|
return Err(ClientError::Socket(err));
|
|
}
|
|
};
|
|
#[cfg(not(test))]
|
|
let sent_at = ClientTimestamp::now();
|
|
#[cfg(test)]
|
|
let sent_at = self
|
|
.test_hooks
|
|
.close_sent_at
|
|
.take()
|
|
.unwrap_or_else(ClientTimestamp::now);
|
|
let event = self.runtime.commit_local_close(prepared.commit, sent_at);
|
|
self.schedule = None;
|
|
self.applied_traffic_class = None;
|
|
|
|
validate_datagram_length(expected_bytes, bytes)?;
|
|
events.push(event);
|
|
Ok(events)
|
|
}
|
|
|
|
/// Return the monotonic deadline for the next probe send, if another probe
|
|
/// is scheduled.
|
|
pub fn next_send_deadline(&self) -> Option<Instant> {
|
|
if !self.runtime.is_open() {
|
|
return None;
|
|
}
|
|
self.schedule.as_ref()?.next_send_deadline()
|
|
}
|
|
|
|
/// Return the local timeout used to classify pending probes as lost.
|
|
pub fn probe_timeout(&self) -> Duration {
|
|
self.runtime.probe_timeout()
|
|
}
|
|
|
|
/// Send one echo probe if the negotiated run is still active.
|
|
///
|
|
/// Returns an `EchoSent` event when a probe is sent. Returns an empty event
|
|
/// list when the run duration has elapsed and no further probe should be
|
|
/// sent.
|
|
pub fn send_probe(&mut self) -> Result<Vec<ClientEvent>, ClientError> {
|
|
self.send_probe_transaction(ProbeScheduleMode::CallerPaced)
|
|
}
|
|
|
|
/// Receive and classify at most one datagram from the socket.
|
|
///
|
|
/// Returns an empty event list when the socket read would block or times
|
|
/// out. Malformed or unrelated datagrams are reported as warning events.
|
|
pub fn recv_once(&mut self) -> Result<Vec<ClientEvent>, ClientError> {
|
|
self.socket
|
|
.set_read_timeout(self.runtime.config().socket_config.recv_timeout)?;
|
|
self.recv_once_inner()
|
|
}
|
|
|
|
fn recv_once_inner(&mut self) -> Result<Vec<ClientEvent>, ClientError> {
|
|
let datagram = match recv_datagram(&self.socket, &mut self.recv_buffer) {
|
|
Ok(datagram) => datagram,
|
|
Err(err)
|
|
if matches!(
|
|
err.kind(),
|
|
io::ErrorKind::WouldBlock | io::ErrorKind::TimedOut
|
|
) =>
|
|
{
|
|
return Ok(vec![]);
|
|
}
|
|
Err(err) => return Err(ClientError::Socket(err)),
|
|
};
|
|
|
|
// One final bounded drain before processing the reply, so a TX
|
|
// timestamp that raced the reply is still associated with its probe
|
|
// before that probe is looked up and possibly removed below.
|
|
self.drain_tx_timestamps()?;
|
|
|
|
let events = self.runtime.process_received_echo_packet(
|
|
&self.recv_buffer[..datagram.len],
|
|
datagram.received_at,
|
|
datagram.meta,
|
|
)?;
|
|
if self.runtime.is_peer_closed() {
|
|
self.schedule = None;
|
|
if self.clear_close_dscp().is_ok() {
|
|
self.applied_traffic_class = None;
|
|
}
|
|
}
|
|
Ok(events)
|
|
}
|
|
|
|
/// Receive and classify datagrams until a receive produces no events or the
|
|
/// receive budget is exhausted.
|
|
pub fn recv_available(&mut self, budget: RecvBudget) -> Result<Vec<ClientEvent>, ClientError> {
|
|
self.socket
|
|
.set_read_timeout(self.runtime.config().socket_config.recv_timeout)?;
|
|
let mut all_events = Vec::new();
|
|
for _ in 0..budget.max_packets {
|
|
let events = self.recv_once_inner()?;
|
|
if events.is_empty() {
|
|
break;
|
|
}
|
|
all_events.extend(events);
|
|
if self.is_peer_closed() {
|
|
break;
|
|
}
|
|
}
|
|
Ok(all_events)
|
|
}
|
|
|
|
/// Polls for probes that have timed out as of the current monotonic time.
|
|
pub fn poll_timeouts(&mut self) -> Result<Vec<ClientEvent>, ClientError> {
|
|
self.poll_timeouts_at(Instant::now())
|
|
}
|
|
|
|
/// Polls for probes that have timed out as of `now`.
|
|
///
|
|
/// This is useful for callers that drive `Client` from their own event loop and
|
|
/// want timeout decisions to use the same sampled `Instant` as their scheduling
|
|
/// logic.
|
|
///
|
|
/// `now` is monotonic time only; wall-clock time is not used for timeout expiry.
|
|
pub fn poll_timeouts_at(&mut self, now: Instant) -> Result<Vec<ClientEvent>, ClientError> {
|
|
self.drain_tx_timestamps()?;
|
|
self.runtime.poll_timeouts_at(now)
|
|
}
|
|
|
|
/// Return whether the current run has completed.
|
|
///
|
|
/// A normal run is complete once no more probes will be sent and all
|
|
/// pending probes have either replied or timed out. No-test and closed
|
|
/// sessions are also considered complete.
|
|
pub fn is_run_complete(&self) -> bool {
|
|
self.runtime.is_terminal()
|
|
|| self
|
|
.schedule
|
|
.as_ref()
|
|
.is_some_and(|schedule| schedule.is_finished() && self.runtime.pending_is_empty())
|
|
}
|
|
|
|
/// Return whether the session was closed by a peer close-flagged reply.
|
|
///
|
|
/// Direct operations on a closed client still return
|
|
/// [`ClientError::AlreadyClosed`]. This method lets higher-level run loops
|
|
/// avoid treating a successfully observed peer close as a local cleanup
|
|
/// failure.
|
|
pub fn is_peer_closed(&self) -> bool {
|
|
self.runtime.is_peer_closed()
|
|
}
|
|
|
|
#[cfg(test)]
|
|
pub(crate) fn send_managed_probe(
|
|
&mut self,
|
|
scheduled_at: Instant,
|
|
) -> Result<Vec<ClientEvent>, ClientError> {
|
|
self.send_probe_transaction(ProbeScheduleMode::Managed { scheduled_at })
|
|
}
|
|
|
|
fn send_probe_transaction(
|
|
&mut self,
|
|
mode: ProbeScheduleMode,
|
|
) -> Result<Vec<ClientEvent>, ClientError> {
|
|
self.runtime.ensure_open()?;
|
|
#[cfg(test)]
|
|
let test_timestamps = self.probe_send_timestamps.take();
|
|
#[cfg(test)]
|
|
let fail_send = std::mem::take(&mut self.probe_send_error);
|
|
let remote = self.remote;
|
|
let (runtime, schedule, socket) = (&mut self.runtime, &mut self.schedule, &self.socket);
|
|
let schedule = schedule
|
|
.as_mut()
|
|
.expect("open sessions always have a probe schedule");
|
|
#[cfg(not(test))]
|
|
let permission_at = Instant::now();
|
|
#[cfg(test)]
|
|
let permission_at = test_timestamps
|
|
.map(|timestamps| timestamps.permission_at)
|
|
.unwrap_or_else(Instant::now);
|
|
if !schedule.permit_probe_at(permission_at) {
|
|
return Ok(Vec::new());
|
|
}
|
|
|
|
let Some(prepared) = runtime.prepare_probe()? else {
|
|
return Ok(Vec::new());
|
|
};
|
|
let machine_preflight = runtime.preflight_probe_commit(&prepared)?;
|
|
let schedule_commit = match mode {
|
|
ProbeScheduleMode::CallerPaced => {
|
|
schedule.preflight_caller_commit(machine_preflight.next_packets_sent)?
|
|
}
|
|
#[cfg(test)]
|
|
ProbeScheduleMode::Managed { scheduled_at } => {
|
|
schedule.preflight_managed_commit(scheduled_at, permission_at)?
|
|
}
|
|
};
|
|
let mut events = Vec::new();
|
|
events
|
|
.try_reserve(1)
|
|
.map_err(|source| ClientError::AllocationFailed {
|
|
operation: "probe event result",
|
|
source,
|
|
})?;
|
|
|
|
let expected_bytes = prepared.bytes.len();
|
|
let scheduled_at = schedule_commit.scheduled_at;
|
|
#[cfg(test)]
|
|
let reported_bytes = self.probe_reported_len.take();
|
|
#[cfg(not(test))]
|
|
let sent_at = ClientTimestamp::now();
|
|
#[cfg(test)]
|
|
let sent_at = test_timestamps
|
|
.map(|timestamps| timestamps.sent_at)
|
|
.unwrap_or_else(ClientTimestamp::now);
|
|
let machine_commit = runtime.finalize_probe_commit(machine_preflight, sent_at)?;
|
|
#[cfg(not(test))]
|
|
let send_call_start = Instant::now();
|
|
#[cfg(test)]
|
|
let send_call_start = test_timestamps
|
|
.map(|timestamps| timestamps.send_call_start)
|
|
.unwrap_or_else(Instant::now);
|
|
#[cfg(test)]
|
|
if fail_send {
|
|
return Err(ClientError::Socket(io::Error::other(
|
|
"injected probe send failure",
|
|
)));
|
|
}
|
|
let bytes = socket.send(&prepared.bytes)?;
|
|
#[cfg(not(test))]
|
|
let send_finished_at = Instant::now();
|
|
#[cfg(test)]
|
|
let send_finished_at = test_timestamps
|
|
.map(|timestamps| timestamps.send_finished_at)
|
|
.unwrap_or_else(Instant::now);
|
|
let sent = runtime.commit_probe_sent(machine_commit, bytes);
|
|
schedule.commit(schedule_commit);
|
|
|
|
let send_call = send_finished_at.saturating_duration_since(send_call_start);
|
|
let timer_error = instant_abs_diff(sent_at.mono, scheduled_at);
|
|
#[cfg(test)]
|
|
let bytes = reported_bytes.unwrap_or(bytes);
|
|
validate_datagram_length(expected_bytes, bytes)?;
|
|
self.drain_tx_timestamps()?;
|
|
|
|
events.push(echo_sent_event(
|
|
remote,
|
|
sent,
|
|
send_call,
|
|
scheduled_at,
|
|
timer_error,
|
|
));
|
|
Ok(events)
|
|
}
|
|
|
|
fn open_transaction(&mut self) -> Result<OpenOutcome, ClientError> {
|
|
let request = self.runtime.prepare_open_request()?;
|
|
let mut buf = [0_u8; MAX_OPEN_PACKET_SIZE];
|
|
let attempt_count = self.runtime.config().open_timeouts.len();
|
|
|
|
for attempt in 0..attempt_count {
|
|
let timeout = self.runtime.config().open_timeouts[attempt];
|
|
let deadline = Instant::now()
|
|
.checked_add(timeout)
|
|
.ok_or(ClientError::DurationOverflow)?;
|
|
self.socket.set_read_timeout(Some(timeout))?;
|
|
self.socket.send(&request.bytes)?;
|
|
|
|
loop {
|
|
let now = Instant::now();
|
|
let Some(remaining) = deadline.checked_duration_since(now) else {
|
|
break;
|
|
};
|
|
if remaining.is_zero() {
|
|
break;
|
|
}
|
|
self.socket.set_read_timeout(Some(remaining))?;
|
|
|
|
let datagram = match recv_datagram(&self.socket, &mut buf) {
|
|
Ok(datagram) => datagram,
|
|
Err(err)
|
|
if matches!(
|
|
err.kind(),
|
|
io::ErrorKind::WouldBlock | io::ErrorKind::TimedOut
|
|
) =>
|
|
{
|
|
if Instant::now() >= deadline {
|
|
break;
|
|
}
|
|
continue;
|
|
}
|
|
Err(err) => return Err(ClientError::Socket(err)),
|
|
};
|
|
if datagram.received_at.mono > deadline {
|
|
break;
|
|
}
|
|
|
|
let reply = match self.runtime.inspect_open_datagram(&buf[..datagram.len])? {
|
|
OpenDatagramDisposition::Ignore => continue,
|
|
OpenDatagramDisposition::Trusted(reply) => reply,
|
|
};
|
|
let machine = match self
|
|
.runtime
|
|
.prepare_open_acceptance(reply, datagram.received_at)
|
|
{
|
|
Ok(machine) => machine,
|
|
Err(failure) => {
|
|
self.send_cleanup_close_best_effort(failure.cleanup_close.as_deref());
|
|
return Err(failure.primary);
|
|
}
|
|
};
|
|
let prepared = match self.prepare_client_open(machine, datagram.received_at) {
|
|
Ok(prepared) => prepared,
|
|
Err(failure) => {
|
|
self.send_cleanup_close_best_effort(failure.machine.cleanup_close_packet());
|
|
return Err(failure.primary);
|
|
}
|
|
};
|
|
return self.apply_prepared_open(prepared);
|
|
}
|
|
}
|
|
|
|
Err(ClientError::OpenTimeout)
|
|
}
|
|
|
|
fn prepare_client_open(
|
|
&self,
|
|
machine: PreparedOpenAcceptance,
|
|
opened_at: ClientTimestamp,
|
|
) -> Result<PreparedClientOpen, Box<PreparedClientOpenFailure>> {
|
|
let Some(negotiated) = machine.normal_negotiated() else {
|
|
return Ok(PreparedClientOpen {
|
|
machine,
|
|
schedule: None,
|
|
recv_buffer_len: None,
|
|
negotiated_traffic_class: None,
|
|
previous_traffic_class: self.applied_traffic_class,
|
|
post_open_recv_timeout: self.runtime.config().socket_config.recv_timeout,
|
|
});
|
|
};
|
|
let schedule = match ProbeSchedule::new(opened_at.mono, negotiated) {
|
|
Ok(schedule) => schedule,
|
|
Err(primary) => return Err(Box::new(PreparedClientOpenFailure { primary, machine })),
|
|
};
|
|
let recv_buffer_len = match recv_buffer_size(self.runtime.has_hmac(), Some(negotiated)) {
|
|
Ok(size) => size,
|
|
Err(primary) => return Err(Box::new(PreparedClientOpenFailure { primary, machine })),
|
|
};
|
|
#[cfg(test)]
|
|
let recv_buffer_len = self
|
|
.test_hooks
|
|
.recv_buffer_len_override
|
|
.get()
|
|
.unwrap_or(recv_buffer_len);
|
|
let negotiated_traffic_class = match u8::try_from(negotiated.params.dscp) {
|
|
Ok(traffic_class) => traffic_class,
|
|
Err(_) => {
|
|
return Err(Box::new(PreparedClientOpenFailure {
|
|
primary: ClientError::InvalidConfig {
|
|
reason: "negotiated dscp must be in range 0..=255".to_owned(),
|
|
},
|
|
machine,
|
|
}));
|
|
}
|
|
};
|
|
|
|
Ok(PreparedClientOpen {
|
|
machine,
|
|
schedule: Some(schedule),
|
|
recv_buffer_len: Some(recv_buffer_len),
|
|
negotiated_traffic_class: Some(negotiated_traffic_class),
|
|
previous_traffic_class: self.applied_traffic_class,
|
|
post_open_recv_timeout: self.runtime.config().socket_config.recv_timeout,
|
|
})
|
|
}
|
|
|
|
fn apply_prepared_open(
|
|
&mut self,
|
|
prepared: PreparedClientOpen,
|
|
) -> Result<OpenOutcome, ClientError> {
|
|
let PreparedClientOpen {
|
|
machine,
|
|
schedule,
|
|
recv_buffer_len,
|
|
negotiated_traffic_class,
|
|
previous_traffic_class,
|
|
post_open_recv_timeout,
|
|
} = prepared;
|
|
|
|
if let (Some(recv_buffer_len), Some(negotiated_traffic_class)) =
|
|
(recv_buffer_len, negotiated_traffic_class)
|
|
{
|
|
let previous_len = self.recv_buffer.len();
|
|
let additional = recv_buffer_len.saturating_sub(previous_len);
|
|
if let Err(source) = self.recv_buffer.try_reserve(additional) {
|
|
self.send_cleanup_close_best_effort(machine.cleanup_close_packet());
|
|
return Err(ClientError::AllocationFailed {
|
|
operation: "negotiated receive buffer",
|
|
source,
|
|
});
|
|
}
|
|
self.recv_buffer.resize(recv_buffer_len, 0);
|
|
|
|
#[cfg(test)]
|
|
self.test_hooks
|
|
.prepared_active_session_before_dscp
|
|
.set(machine.has_prepared_active_session());
|
|
if let Err(primary) = self.apply_open_dscp(negotiated_traffic_class) {
|
|
self.recv_buffer.truncate(previous_len);
|
|
self.restore_dscp_best_effort(previous_traffic_class);
|
|
self.send_cleanup_close_best_effort(machine.cleanup_close_packet());
|
|
return Err(primary);
|
|
}
|
|
if let Err(source) = self.restore_open_read_timeout(post_open_recv_timeout) {
|
|
let primary = ClientError::ReadTimeoutRestore { source };
|
|
self.recv_buffer.truncate(previous_len);
|
|
self.restore_dscp_best_effort(previous_traffic_class);
|
|
self.send_cleanup_close_best_effort(machine.cleanup_close_packet());
|
|
return Err(primary);
|
|
}
|
|
|
|
let outcome = self.runtime.commit_open(machine);
|
|
self.schedule = schedule;
|
|
self.applied_traffic_class = Some(negotiated_traffic_class);
|
|
self.tx_timestamping_enabled = try_enable_tx_timestamping(&self.socket);
|
|
Ok(outcome)
|
|
} else {
|
|
debug_assert!(schedule.is_none());
|
|
if let Err(source) = self.restore_open_read_timeout(post_open_recv_timeout) {
|
|
return Err(ClientError::ReadTimeoutRestore { source });
|
|
}
|
|
let outcome = self.runtime.commit_open(machine);
|
|
self.schedule = None;
|
|
self.applied_traffic_class = None;
|
|
self.tx_timestamping_enabled = try_enable_tx_timestamping(&self.socket);
|
|
Ok(outcome)
|
|
}
|
|
}
|
|
|
|
/// Best-effort, bounded, nonblocking drain of the socket's
|
|
/// `MSG_ERRQUEUE`. A no-op unless [`Self::apply_prepared_open`]
|
|
/// successfully upgraded the socket to TX timestamping. Any TX
|
|
/// timestamp found is handed to the session machine to attach to its
|
|
/// matching probe; a genuine socket/network error found on the queue is
|
|
/// surfaced through the normal socket-error path.
|
|
fn drain_tx_timestamps(&mut self) -> Result<(), ClientError> {
|
|
if !self.tx_timestamping_enabled {
|
|
return Ok(());
|
|
}
|
|
let runtime = &mut self.runtime;
|
|
drain_tx_timestamps(&self.socket, |id, timestamp| {
|
|
runtime.record_kernel_tx_timestamp(id, timestamp);
|
|
})
|
|
.map_err(ClientError::Socket)
|
|
}
|
|
|
|
fn restore_dscp_best_effort(&self, previous_traffic_class: Option<u8>) {
|
|
#[cfg(test)]
|
|
if self.test_hooks.fail_dscp_restore.replace(false) {
|
|
return;
|
|
}
|
|
let _ = match previous_traffic_class {
|
|
Some(traffic_class) => {
|
|
apply_traffic_class_to_socket(&self.socket, self.remote, traffic_class)
|
|
}
|
|
None => clear_dscp_on_socket(&self.socket, self.remote),
|
|
};
|
|
}
|
|
|
|
fn clear_close_dscp(&self) -> Result<(), ClientError> {
|
|
#[cfg(test)]
|
|
if self.test_hooks.fail_close_dscp_clear.replace(false) {
|
|
return Err(ClientError::SocketOption {
|
|
operation: "clear negotiated DSCP",
|
|
remote: self.remote,
|
|
source: io::Error::other("injected negotiated DSCP clear failure"),
|
|
});
|
|
}
|
|
clear_dscp_on_socket(&self.socket, self.remote)
|
|
}
|
|
|
|
fn send_cleanup_close_best_effort(&self, packet: Option<&[u8]>) {
|
|
if let Some(packet) = packet {
|
|
#[cfg(test)]
|
|
if self.test_hooks.fail_cleanup_send.replace(false) {
|
|
return;
|
|
}
|
|
let _ = self.socket.send(packet);
|
|
}
|
|
}
|
|
|
|
fn apply_open_dscp(&self, traffic_class: u8) -> Result<(), ClientError> {
|
|
#[cfg(test)]
|
|
if self.test_hooks.fail_open_dscp.replace(false) {
|
|
return Err(ClientError::SocketOption {
|
|
operation: "set negotiated DSCP",
|
|
remote: self.remote,
|
|
source: io::Error::other("injected negotiated DSCP failure"),
|
|
});
|
|
}
|
|
apply_traffic_class_to_socket(&self.socket, self.remote, traffic_class)
|
|
}
|
|
|
|
fn restore_open_read_timeout(&self, timeout: Option<Duration>) -> io::Result<()> {
|
|
#[cfg(test)]
|
|
self.test_hooks.last_restored_read_timeout.set(timeout);
|
|
#[cfg(test)]
|
|
if self.test_hooks.fail_open_timeout_restore.replace(false) {
|
|
return Err(io::Error::other(
|
|
"injected configured read timeout restoration failure",
|
|
));
|
|
}
|
|
self.socket.set_read_timeout(timeout)
|
|
}
|
|
|
|
fn send_close_datagram(&self, packet: &[u8]) -> io::Result<usize> {
|
|
#[cfg(test)]
|
|
{
|
|
self.test_hooks
|
|
.close_send_attempts
|
|
.set(self.test_hooks.close_send_attempts.get() + 1);
|
|
if self.test_hooks.fail_close_send.replace(false) {
|
|
return Err(io::Error::other("injected close send failure"));
|
|
}
|
|
}
|
|
let bytes = self.socket.send(packet)?;
|
|
#[cfg(test)]
|
|
if let Some(reported) = self.test_hooks.close_reported_len.take() {
|
|
return Ok(reported);
|
|
}
|
|
Ok(bytes)
|
|
}
|
|
}
|
|
|
|
pub(crate) fn echo_sent_event(
|
|
remote: SocketAddr,
|
|
sent: ProbeSent,
|
|
send_call: Duration,
|
|
scheduled_at: Instant,
|
|
timer_error: Duration,
|
|
) -> ClientEvent {
|
|
ClientEvent::EchoSent {
|
|
seq: sent.seq,
|
|
remote,
|
|
scheduled_at,
|
|
sent_at: sent.sent_at,
|
|
bytes: sent.bytes,
|
|
send_call,
|
|
timer_error,
|
|
}
|
|
}
|
|
|
|
pub(crate) fn validate_datagram_length(expected: usize, actual: usize) -> Result<(), ClientError> {
|
|
if actual == expected {
|
|
Ok(())
|
|
} else {
|
|
Err(ClientError::DatagramLengthMismatch { expected, actual })
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
impl Client {
|
|
fn send_probe_at(
|
|
&mut self,
|
|
timestamps: ProbeSendTimestamps,
|
|
) -> Result<Vec<ClientEvent>, ClientError> {
|
|
self.probe_send_timestamps = Some(timestamps);
|
|
self.send_probe()
|
|
}
|
|
|
|
fn send_managed_probe_at(
|
|
&mut self,
|
|
scheduled_at: Instant,
|
|
timestamps: ProbeSendTimestamps,
|
|
) -> Result<Vec<ClientEvent>, ClientError> {
|
|
self.probe_send_timestamps = Some(timestamps);
|
|
self.send_managed_probe(scheduled_at)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
fn bounded_receive_timeout(
|
|
deadline: Option<Instant>,
|
|
configured_timeout: Option<Duration>,
|
|
max_wait: Duration,
|
|
now: Instant,
|
|
) -> Option<Duration> {
|
|
if max_wait.is_zero() {
|
|
return None;
|
|
}
|
|
let mut timeout = configured_timeout.unwrap_or(max_wait).min(max_wait);
|
|
if let Some(deadline) = deadline {
|
|
let remaining = deadline.checked_duration_since(now)?;
|
|
if remaining.is_zero() {
|
|
return None;
|
|
}
|
|
timeout = timeout.min(remaining);
|
|
}
|
|
(!timeout.is_zero()).then_some(timeout)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests;
|