Skip to main content

net_io/
session.rs

1//! Sans-IO sessions: a protocol engine reacts to bytes and returns what to do next.
2
3use std::collections::VecDeque;
4use std::fmt;
5use std::fs::File;
6use std::sync::Arc;
7use std::sync::atomic::{AtomicU64, Ordering};
8use std::time::{Duration, Instant};
9
10use crate::buf::{Buffer, BufferPool};
11use crate::completer::Completer;
12use crate::error::{CloseReason, LimitKind, NetError, RefusalCause, TimeoutKind};
13use crate::gate::KillHandle;
14use crate::id::WorkerId;
15use crate::info::{ConnectionInfo, GateTag};
16use crate::limits::SizeClass;
17use crate::link::Link;
18
19/// A sans-IO protocol engine bound to one connection.
20///
21/// net-io reads, calls the session with the bytes, and does what the returned
22/// [`Step`] says. Sessions are called only on the worker that owns the
23/// connection, never concurrently.
24///
25/// # Examples
26///
27/// ```no_run
28/// use net_io::{Input, Session, SessionContext, Step};
29///
30/// struct Echo;
31/// impl Session for Echo {
32///     fn on_data(&mut self, cx: &mut SessionContext<'_>, input: &mut Input) -> Step {
33///         // Copy as much as the output budget takes; the rest stays in `input`,
34///         // and net-io calls on_data again after the flush because the input changed.
35///         let taken = cx.output().push_partial(input.bytes());
36///         input.consume(taken);
37///         Step::Write
38///     }
39/// }
40///
41/// let server = net_io::serve_sessions("127.0.0.1:7002", |_info: &net_io::ConnectionInfo| Echo)?;
42/// server.wait_for_stop();
43/// # Ok::<(), net_io::NetError>(())
44/// ```
45pub trait Session: Send + 'static {
46    /// Once, after admission and the handshake.
47    fn on_open(&mut self, cx: &mut SessionContext<'_>) -> Step {
48        let _ = cx;
49        Step::Read
50    }
51
52    /// Bytes arrived; `input` holds everything not yet consumed.
53    fn on_data(&mut self, cx: &mut SessionContext<'_>, input: &mut Input) -> Step;
54
55    /// After a `Step::Write` flushed all pending output.
56    fn on_writable(&mut self, cx: &mut SessionContext<'_>) -> Step {
57        let _ = cx;
58        Step::Read
59    }
60
61    /// Another thread posted a completion through this connection's [`Completer`].
62    fn on_wake(&mut self, cx: &mut SessionContext<'_>, token: u32, value: u64) -> Step {
63        let _ = (cx, token, value);
64        Step::Abort
65    }
66
67    /// A deadline passed. `Close` or `Abort` closes with the timeout's own reason
68    /// and close style; anything else re-arms with the same limits.
69    fn on_timeout(&mut self, cx: &mut SessionContext<'_>, which: TimeoutKind) -> Step {
70        let _ = (cx, which);
71        Step::Close
72    }
73
74    /// The peer sent FIN; the session may keep writing (half-close).
75    fn on_peer_closed(&mut self, cx: &mut SessionContext<'_>) -> Step {
76        let _ = cx;
77        Step::Close
78    }
79
80    /// The gate denied a write and no byte of the current response has left:
81    /// write the protocol's refusal for `code` into `output`.
82    fn on_denied(&mut self, code: u16, output: &mut Output) {
83        let _ = (code, output);
84    }
85
86    /// Exactly once, with the one close reason.
87    fn on_close(&mut self, info: &ConnectionInfo, reason: CloseReason) {
88        let _ = (info, reason);
89    }
90}
91
92/// Creates one session per admitted connection. Any `Fn(&ConnectionInfo) -> S` is one.
93///
94/// # Examples
95///
96/// ```
97/// use net_io::{ConnectionInfo, Input, RefusalCause, Session, SessionContext, SessionFactory, Step};
98///
99/// struct Discard;
100/// impl Session for Discard {
101///     fn on_data(&mut self, _cx: &mut SessionContext<'_>, input: &mut Input) -> Step {
102///         let n = input.bytes().len();
103///         input.consume(n);
104///         Step::Read
105///     }
106/// }
107///
108/// struct OnlyLoopback;
109/// impl SessionFactory for OnlyLoopback {
110///     type Session = Discard;
111///     fn open(&self, info: &ConnectionInfo) -> Result<Discard, RefusalCause> {
112///         match info.client_addr() {
113///             Some(addr) if addr.ip().is_loopback() => Ok(Discard),
114///             _ => Err(RefusalCause::Session),
115///         }
116///     }
117/// }
118///
119/// let info = ConnectionInfo::for_testing("10.0.0.1:1".parse().unwrap());
120/// assert!(OnlyLoopback.open(&info).is_err());
121/// ```
122pub trait SessionFactory: Send + Sync + 'static {
123    /// The session type.
124    type Session: Session;
125
126    /// A session for this connection.
127    ///
128    /// # Errors
129    ///
130    /// Refusing closes the connection with `CloseReason::Refused(cause)`.
131    fn open(&self, info: &ConnectionInfo) -> Result<Self::Session, RefusalCause>;
132}
133
134impl<F, S> SessionFactory for F
135where
136    F: Fn(&ConnectionInfo) -> S + Send + Sync + 'static,
137    S: Session,
138{
139    type Session = S;
140    fn open(&self, info: &ConnectionInfo) -> Result<S, RefusalCause> {
141        Ok(self(info))
142    }
143}
144
145/// What the session wants next.
146///
147/// ```
148/// assert_ne!(net_io::Step::Close, net_io::Step::Abort);
149/// ```
150#[non_exhaustive]
151#[derive(Clone, Copy, Debug, PartialEq, Eq)]
152pub enum Step {
153    /// Wait for more input. Output pushed in this call is not sent: return
154    /// `Write` (or `Close`) to flush it first.
155    Read,
156    /// Flush pending output, then `on_writable`.
157    Write,
158    /// No reads, no idle timer, until a completion or the park deadline.
159    Park {
160        /// The deadline; `None` uses the park timeout.
161        until: Option<Instant>,
162    },
163    /// Graceful: flush, FIN, bounded linger.
164    Close,
165    /// RST now.
166    Abort,
167}
168
169/// Which deadlines run.
170///
171/// ```
172/// assert_eq!(net_io::Phase::default(), net_io::Phase::Idle);
173/// ```
174#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
175pub enum Phase {
176    /// Between exchanges: the idle timeout.
177    #[default]
178    Idle,
179    /// Receiving an exchange: the read timeout, the inbound rate, the exchange deadline.
180    Receiving,
181    /// Sending: the write timeout, the outbound rate, the exchange deadline.
182    Sending,
183}
184
185/// Why a swap was refused.
186///
187/// ```
188/// assert_ne!(net_io::SwapError::NotEmpty, net_io::SwapError::Busy);
189/// ```
190#[non_exhaustive]
191#[derive(Clone, Copy, Debug, PartialEq, Eq)]
192pub enum SwapError {
193    /// The buffers are of different size classes.
194    ClassMismatch,
195    /// The incoming buffer has data.
196    NotEmpty,
197    /// A driver operation holds the buffer.
198    Busy,
199}
200
201impl fmt::Display for SwapError {
202    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
203        f.write_str(match self {
204            SwapError::ClassMismatch => "the buffers are of different size classes",
205            SwapError::NotEmpty => "the incoming buffer is not empty",
206            SwapError::Busy => "a driver operation holds the buffer",
207        })
208    }
209}
210
211impl std::error::Error for SwapError {}
212
213/// The connection's read buffer: a zero-copy view of what was read and not yet consumed.
214///
215/// ```
216/// let mut input = net_io::Input::from_bytes(b"GET / HTTP/1.1\r\n");
217/// assert_eq!(input.bytes(), b"GET / HTTP/1.1\r\n");
218/// input.consume(4);
219/// assert_eq!(input.bytes(), b"/ HTTP/1.1\r\n");
220/// ```
221#[derive(Debug)]
222pub struct Input {
223    pub(crate) buf: Buffer,
224    pub(crate) start: usize,
225    pub(crate) changed: bool,
226    /// The buffer travels with a receive on the reactor: `buf` is a stand-in, and
227    /// the unconsumed bytes are in the lent buffer until it comes back.
228    lent: bool,
229}
230
231impl Input {
232    pub(crate) fn new(buf: Buffer) -> Input {
233        Input {
234            buf,
235            lent: false,
236            start: 0,
237            changed: false,
238        }
239    }
240
241    /// An input holding `bytes`, for tests of sessions (allocates).
242    #[must_use]
243    pub fn from_bytes(bytes: &[u8]) -> Input {
244        let class = (bytes.len() as u32)
245            .max(1024)
246            .next_power_of_two()
247            .max(SizeClass::SMALL.bytes());
248        let class = SizeClass::new(class.min(1 << 20)).unwrap_or(SizeClass::LARGE);
249        let mut pool = BufferPool::standalone(u64::from(class.bytes()));
250        let mut input = Input::new(match pool.take(class) {
251            Some(b) => b,
252            None => return Input::new(Buffer::detached(class)),
253        });
254        let n = bytes.len().min(input.buf.capacity());
255        input.buf.spare()[..n].copy_from_slice(&bytes[..n]);
256        input.buf.set_len(n);
257        input
258    }
259
260    /// The unconsumed bytes.
261    #[must_use]
262    pub fn bytes(&self) -> &[u8] {
263        self.buf.as_slice().get(self.start..).unwrap_or(&[])
264    }
265
266    /// Consumes `n` bytes (saturating at the length).
267    pub fn consume(&mut self, n: usize) {
268        let n = n.min(self.buf.len() - self.start);
269        self.start += n;
270        if n > 0 {
271            self.changed = true;
272        }
273        if self.start == self.buf.len() {
274            self.buf.clear();
275            self.start = 0;
276        }
277    }
278
279    /// Whether the buffer is full: the session must consume or grow it.
280    #[must_use]
281    pub fn is_full(&self) -> bool {
282        !self.lent && self.buf.len() == self.buf.capacity() && self.start == 0
283    }
284
285    /// The buffer's size class.
286    #[must_use]
287    pub fn class(&self) -> SizeClass {
288        self.buf.class()
289    }
290
291    /// Exchanges the read buffer with an empty `other` of the same class in O(1):
292    /// `other` now holds the unconsumed bytes, and the connection reads into the
293    /// buffer it was given.
294    ///
295    /// # Errors
296    ///
297    /// [`SwapError::ClassMismatch`], [`SwapError::NotEmpty`].
298    ///
299    /// ```
300    /// use net_io::{BufferPool, Input};
301    /// let mut input = Input::from_bytes(b"body");
302    /// let mut pool = BufferPool::standalone(1 << 20);
303    /// let mut spare = pool.take(input.class()).unwrap();
304    /// input.swap(&mut spare).unwrap();
305    /// assert_eq!(spare.as_slice(), b"body");
306    /// assert!(input.bytes().is_empty());
307    /// ```
308    pub fn swap(&mut self, other: &mut Buffer) -> Result<(), SwapError> {
309        if other.class() != self.buf.class() {
310            return Err(SwapError::ClassMismatch);
311        }
312        if !other.is_empty() {
313            return Err(SwapError::NotEmpty);
314        }
315        if self.start > 0 {
316            self.buf.compact(self.start);
317            self.start = 0;
318        }
319        std::mem::swap(&mut self.buf, other);
320        self.changed = true;
321        Ok(())
322    }
323
324    /// Room to read into, compacting first when the free tail is under a quarter.
325    pub(crate) fn spare_for_read(&mut self) -> &mut [u8] {
326        let free = self.buf.capacity() - self.buf.len();
327        if self.start > 0 && free < self.buf.capacity() / 4 {
328            self.buf.compact(self.start);
329            self.start = 0;
330        }
331        self.buf.spare()
332    }
333
334    /// Hands the buffer to a receive (compacted first when the free tail is small),
335    /// leaving an empty stand-in until [`Input::give_back`].
336    #[cfg(feature = "reactor")]
337    pub(crate) fn lend(&mut self) -> Buffer {
338        let _ = self.spare_for_read();
339        self.lent = true;
340        std::mem::replace(&mut self.buf, Buffer::placeholder())
341    }
342
343    /// The lent buffer is back, with what the receive added.
344    #[cfg(feature = "reactor")]
345    pub(crate) fn give_back(&mut self, buf: Buffer) {
346        self.buf = buf;
347        self.lent = false;
348    }
349
350    /// Whether a receive holds the buffer.
351    #[cfg(feature = "reactor")]
352    pub(crate) fn lent(&self) -> bool {
353        self.lent
354    }
355
356    pub(crate) fn filled(&mut self, n: usize) {
357        let len = self.buf.len() + n;
358        self.buf.set_len(len);
359        self.changed = true;
360    }
361}
362
363/// The output budget was reached; return `Step::Write` and continue after the flush.
364///
365/// ```
366/// assert_eq!(net_io::OutputFull.to_string(), "the connection's output budget is full");
367/// ```
368#[derive(Clone, Copy, Debug, PartialEq, Eq)]
369pub struct OutputFull;
370
371impl fmt::Display for OutputFull {
372    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
373        f.write_str("the connection's output budget is full")
374    }
375}
376
377impl std::error::Error for OutputFull {}
378
379#[derive(Debug)]
380pub(crate) enum Chunk {
381    Pooled(Buffer, usize),
382    Static(&'static [u8], usize),
383    /// `left` bytes of a file from `offset`.
384    File {
385        file: Arc<File>,
386        offset: u64,
387        left: u64,
388    },
389}
390
391impl Chunk {
392    /// The bytes in memory; a file has none.
393    pub(crate) fn remaining(&self) -> &[u8] {
394        match self {
395            Chunk::Pooled(b, off) => &b.as_slice()[*off..],
396            Chunk::Static(s, off) => &s[*off..],
397            Chunk::File { .. } => &[],
398        }
399    }
400
401    /// Bytes still to go.
402    pub(crate) fn len(&self) -> usize {
403        match self {
404            Chunk::File { left, .. } => usize::try_from(*left).unwrap_or(usize::MAX),
405            other => other.remaining().len(),
406        }
407    }
408
409    pub(crate) fn is_file(&self) -> bool {
410        matches!(self, Chunk::File { .. })
411    }
412
413    /// `n` bytes of this chunk went out.
414    pub(crate) fn advance(&mut self, n: usize) {
415        match self {
416            Chunk::Pooled(_, off) | Chunk::Static(_, off) => *off += n,
417            Chunk::File { offset, left, .. } => {
418                *offset += n as u64;
419                *left -= n as u64;
420            }
421        }
422    }
423}
424
425/// What the session wants written: a bounded queue of chunks.
426///
427/// ```
428/// let mut out = net_io::Output::standalone(64 * 1024);
429/// out.push(b"hello ").unwrap();
430/// out.push_static(b"world").unwrap();
431/// assert_eq!(out.pending(), 11);
432/// ```
433#[derive(Debug)]
434pub struct Output {
435    pub(crate) chunks: VecDeque<Chunk>,
436    free: Vec<Buffer>,
437    budget: Arc<AtomicU64>,
438    limit: u32,
439    used: u32,
440    wipe: bool,
441    /// A push found no free buffer and the budget spent since the last flush.
442    refused: bool,
443    pub(crate) response_open: bool,
444    pub(crate) response_tag: Option<GateTag>,
445    pub(crate) bytes_since_begin: u64,
446}
447
448const OUTPUT_CLASS: SizeClass = SizeClass::MEDIUM;
449const MAX_CHUNKS: usize = 64;
450/// The most free buffers one output holds; the rest of a large close goes to the budget.
451const FREE_MAX: usize = 4;
452
453impl Output {
454    pub(crate) fn new(budget: Arc<AtomicU64>, limit: u32, wipe: bool) -> Output {
455        Output {
456            chunks: VecDeque::with_capacity(MAX_CHUNKS),
457            free: Vec::new(),
458            budget,
459            limit,
460            used: 0,
461            wipe,
462            refused: false,
463            response_open: false,
464            response_tag: None,
465            bytes_since_begin: 0,
466        }
467    }
468
469    /// An output with its own budget, for tests of sessions (allocates).
470    #[must_use]
471    pub fn standalone(limit: u32) -> Output {
472        Output::new(Arc::new(AtomicU64::new(u64::from(limit))), limit, true)
473    }
474
475    fn take_buffer(&mut self) -> Option<Buffer> {
476        if let Some(b) = self.free.pop() {
477            return Some(b);
478        }
479        let bytes = u64::from(OUTPUT_CLASS.bytes());
480        let mut left = self.budget.load(Ordering::Relaxed);
481        loop {
482            if left < bytes {
483                self.refused = true;
484                return None;
485            }
486            match self.budget.compare_exchange_weak(
487                left,
488                left - bytes,
489                Ordering::AcqRel,
490                Ordering::Relaxed,
491            ) {
492                Ok(_) => return Some(Buffer::detached(OUTPUT_CLASS)),
493                Err(actual) => left = actual,
494            }
495        }
496    }
497
498    /// Takes buffers the worker's pool already holds, so the next pushes reuse them
499    /// instead of charging the budget again. Before this, spares an output gave the
500    /// pool after a send were never taken back, and every flush of more than one
501    /// buffer charged the budget anew until it ran out (found by ws-net).
502    pub(crate) fn refill(&mut self, pool: &mut BufferPool) {
503        while self.free.len() < FREE_MAX {
504            match pool.take_cached(OUTPUT_CLASS) {
505                Some(b) => self.free.push(b),
506                None => return,
507            }
508        }
509    }
510
511    /// Whether a push was refused for want of budget since the last call: a flush
512    /// that then finds nothing queued must not call the session back at once.
513    pub(crate) fn take_refused(&mut self) -> bool {
514        std::mem::take(&mut self.refused)
515    }
516
517    fn room(&self) -> usize {
518        let tail = match self.chunks.back() {
519            Some(Chunk::Pooled(b, _)) => b.capacity() - b.len(),
520            _ => 0,
521        };
522        let more = (self.limit.saturating_sub(self.used) / OUTPUT_CLASS.bytes()) as usize
523            * OUTPUT_CLASS.bytes() as usize;
524        tail + more
525    }
526
527    /// Copies as much of `bytes` as the budget allows; returns how many were taken.
528    pub fn push_partial(&mut self, mut bytes: &[u8]) -> usize {
529        let mut taken = 0;
530        while !bytes.is_empty() {
531            if let Some(Chunk::Pooled(b, _)) = self.chunks.back_mut() {
532                let spare = b.spare();
533                if !spare.is_empty() {
534                    let n = spare.len().min(bytes.len());
535                    spare[..n].copy_from_slice(&bytes[..n]);
536                    let len = b.len() + n;
537                    b.set_len(len);
538                    bytes = &bytes[n..];
539                    taken += n;
540                    continue;
541                }
542            }
543            if self.chunks.len() >= MAX_CHUNKS
544                || self.used.saturating_add(OUTPUT_CLASS.bytes()) > self.limit
545            {
546                break;
547            }
548            match self.take_buffer() {
549                Some(b) => {
550                    self.used += OUTPUT_CLASS.bytes();
551                    self.chunks.push_back(Chunk::Pooled(b, 0));
552                }
553                None => break,
554            }
555        }
556        taken
557    }
558
559    /// Copies all of `bytes`, or nothing.
560    ///
561    /// # Errors
562    ///
563    /// [`OutputFull`] when the budget cannot take all of it.
564    pub fn push(&mut self, bytes: &[u8]) -> Result<(), OutputFull> {
565        if bytes.len() > self.room() {
566            return Err(OutputFull);
567        }
568        let n = self.push_partial(bytes);
569        if n == bytes.len() {
570            Ok(())
571        } else {
572            Err(OutputFull)
573        }
574    }
575
576    /// Moves an owned buffer in (no copy).
577    ///
578    /// # Errors
579    ///
580    /// [`OutputFull`] when the budget or the chunk limit is reached.
581    pub fn push_buffer(&mut self, buffer: Buffer) -> Result<(), OutputFull> {
582        let size = u32::try_from(buffer.capacity()).unwrap_or(u32::MAX);
583        if self.chunks.len() >= MAX_CHUNKS || self.used.saturating_add(size) > self.limit {
584            return Err(OutputFull);
585        }
586        self.used += size;
587        self.chunks.push_back(Chunk::Pooled(buffer, 0));
588        Ok(())
589    }
590
591    /// Queues a static slice (no copy, not counted against the budget).
592    ///
593    /// # Errors
594    ///
595    /// [`OutputFull`] when the chunk limit is reached.
596    pub fn push_static(&mut self, bytes: &'static [u8]) -> Result<(), OutputFull> {
597        if self.chunks.len() >= MAX_CHUNKS {
598            return Err(OutputFull);
599        }
600        if !bytes.is_empty() {
601            self.chunks.push_back(Chunk::Static(bytes, 0));
602        }
603        Ok(())
604    }
605
606    /// Queues `len` bytes of `file` from `offset`, sent zero copy where the OS can and
607    /// read in pieces otherwise (TLS, named pipes). Not counted against the budget; the
608    /// file stays open until the chunk has gone. Keep it from shrinking meanwhile: the
609    /// connection is reset with `Io(FileTruncated)` if it does. A read on TLS or a pipe
610    /// happens on the worker's thread, so a slow disk holds that worker.
611    ///
612    /// On the reactor a file goes out in pieces of at most 256 KiB, each after a gate
613    /// check, and a worker sends at most 256 KiB of file between two looks at the OS,
614    /// so a stream to a fast reader cannot hold off the worker's other connections.
615    /// To interleave small replies with a stream on one connection, push the stream a
616    /// few pieces at a time from `on_writable`.
617    ///
618    /// # Errors
619    ///
620    /// [`OutputFull`] when the chunk limit is reached.
621    pub fn push_file(&mut self, file: Arc<File>, offset: u64, len: u64) -> Result<(), OutputFull> {
622        if self.chunks.len() >= MAX_CHUNKS {
623            return Err(OutputFull);
624        }
625        if len > 0 {
626            self.chunks.push_back(Chunk::File {
627                file,
628                offset,
629                left: len,
630            });
631        }
632        Ok(())
633    }
634
635    /// The file at the front of the queue, if that is what goes next.
636    pub(crate) fn front_file(&self) -> Option<(Arc<File>, u64, u64)> {
637        match self.chunks.front() {
638            Some(Chunk::File { file, offset, left }) => Some((file.clone(), *offset, *left)),
639            _ => None,
640        }
641    }
642
643    /// Reads the front file's next piece into a buffer at the front of the queue, for
644    /// a path that cannot send a file directly.
645    #[cfg(feature = "reactor")]
646    pub(crate) fn pull_file(&mut self) -> Result<(), crate::error::CloseReason> {
647        use crate::error::{CloseReason, LimitKind, OsErrorClass};
648        let Some((file, offset, left)) = self.front_file() else {
649            return Ok(());
650        };
651        let Some(mut b) = self.take_buffer() else {
652            return Err(CloseReason::Limit(LimitKind::BufferBudget));
653        };
654        let spare = b.spare();
655        let take = usize::try_from(left).unwrap_or(usize::MAX).min(spare.len());
656        let read = crate::sys::read_file_at(&file, &mut spare[..take], offset);
657        let n = match read {
658            Ok(0) => {
659                self.release_chunk(b);
660                return Err(CloseReason::Io(OsErrorClass::FileTruncated));
661            }
662            Ok(n) => n,
663            Err(e) => {
664                self.release_chunk(b);
665                return Err(CloseReason::Io(OsErrorClass::from_io(&e)));
666            }
667        };
668        b.set_len(n);
669        self.used += OUTPUT_CLASS.bytes();
670        if let Some(front) = self.chunks.front_mut() {
671            front.advance(n);
672            if front.len() == 0 {
673                self.chunks.pop_front();
674            }
675        }
676        self.chunks.push_front(Chunk::Pooled(b, 0));
677        Ok(())
678    }
679
680    /// Marks the start of a response (for the gate's denial boundary).
681    pub fn begin_response(&mut self) {
682        self.response_open = true;
683        self.response_tag = None;
684        self.bytes_since_begin = 0;
685    }
686
687    /// Marks the start of a response and tags it for the gate (`WriteCheck::response`).
688    pub fn begin_tagged_response(&mut self, tag: GateTag) {
689        self.begin_response();
690        self.response_tag = Some(tag);
691    }
692
693    /// Marks the end of the response; clears the tag.
694    pub fn end_response(&mut self) {
695        self.response_open = false;
696        self.response_tag = None;
697    }
698
699    /// Bytes queued and not yet sent.
700    #[must_use]
701    pub fn pending(&self) -> usize {
702        self.chunks.iter().map(Chunk::len).sum()
703    }
704
705    /// Whether nothing is queued.
706    #[must_use]
707    pub fn is_empty(&self) -> bool {
708        self.chunks.is_empty()
709    }
710
711    /// Overwrites every pending chunk net-io owns with zeroes and drops it.
712    pub fn wipe_all(&mut self) {
713        while let Some(chunk) = self.chunks.pop_front() {
714            if let Chunk::Pooled(mut b, _) = chunk {
715                b.wipe();
716                self.release_chunk(b);
717            }
718        }
719        self.used = 0;
720    }
721
722    fn release_chunk(&mut self, mut b: Buffer) {
723        self.used = self
724            .used
725            .saturating_sub(u32::try_from(b.capacity()).unwrap_or(u32::MAX));
726        if self.wipe {
727            b.wipe();
728        } else {
729            b.clear();
730        }
731        if b.class() == OUTPUT_CLASS && self.free.len() < FREE_MAX {
732            self.free.push(b);
733        } else {
734            // A buffer moved in with push_buffer goes back to the shared budget.
735            self.budget
736                .fetch_add(b.capacity() as u64, Ordering::Release);
737        }
738    }
739
740    /// Keeps one free buffer and gives the rest to `pool`. A buffer moved in with
741    /// `push_buffer` came from that pool, and kept here it would be allocated again
742    /// for the next one.
743    pub(crate) fn return_spares(&mut self, pool: &mut BufferPool) {
744        while self.free.len() > 1 {
745            if let Some(b) = self.free.pop() {
746                pool.put(b);
747            }
748        }
749    }
750
751    /// The bytes one send offers: at most the chunks one vectored call takes.
752    #[cfg(feature = "reactor")]
753    pub(crate) fn pending_in_send(&self) -> usize {
754        self.chunks
755            .iter()
756            .take(crate::sys::MAX_SLICES)
757            .take_while(|c| !c.is_file())
758            .map(Chunk::len)
759            .sum()
760    }
761
762    /// The chunks as slices for one send; returns how many.
763    #[cfg(feature = "reactor")]
764    pub(crate) fn fill_slices<'a>(&'a self, out: &mut [std::io::IoSlice<'a>]) -> usize {
765        let mut n = 0;
766        for chunk in self
767            .chunks
768            .iter()
769            .take(out.len())
770            .take_while(|c| !c.is_file())
771        {
772            out[n] = std::io::IoSlice::new(chunk.remaining());
773            n += 1;
774        }
775        n
776    }
777
778    /// Marks `n` bytes as sent, releasing finished chunks.
779    pub(crate) fn advance(&mut self, mut n: usize) {
780        while let Some(front) = self.chunks.front_mut() {
781            let rem = front.len();
782            if n < rem {
783                front.advance(n);
784                return;
785            }
786            n -= rem;
787            if let Some(Chunk::Pooled(b, _)) = self.chunks.pop_front() {
788                self.release_chunk(b);
789            }
790        }
791    }
792
793    /// Resets for the next connection.
794    pub(crate) fn reset(&mut self) {
795        self.wipe_all();
796        self.response_open = false;
797        self.response_tag = None;
798        self.bytes_since_begin = 0;
799        self.refused = false;
800    }
801}
802
803/// Everything a session may touch, for one call.
804pub struct SessionContext<'a> {
805    pub(crate) link: &'a mut Link,
806    pub(crate) output: &'a mut Output,
807    pub(crate) pool: &'a mut BufferPool,
808    pub(crate) completer: &'a Completer,
809    pub(crate) draining: bool,
810    pub(crate) pressure: f32,
811    pub(crate) worker: WorkerId,
812    pub(crate) grow_to: Option<SizeClass>,
813}
814
815impl SessionContext<'_> {
816    /// The connection's facts.
817    #[must_use]
818    pub fn info(&self) -> &ConnectionInfo {
819        &self.link.info
820    }
821
822    /// The output queue.
823    pub fn output(&mut self) -> &mut Output {
824        // Spares the output gave the pool after its last send come back first, up to
825        // what one output may hold: a few pops, no allocation.
826        if self.output.free.len() < FREE_MAX {
827            self.output.refill(self.pool);
828        }
829        self.output
830    }
831
832    /// The worker's clock.
833    #[must_use]
834    pub fn now(&self) -> Instant {
835        self.link.now()
836    }
837
838    /// Chooses which deadlines run.
839    pub fn set_phase(&mut self, phase: crate::session::Phase) {
840        self.link.set_phase(phase);
841    }
842
843    /// The deadline for the current exchange (`None` clears it).
844    pub fn set_exchange_deadline(&mut self, at: Option<Instant>) {
845        self.link.set_exchange_deadline(at);
846    }
847
848    /// Overrides this connection's idle timeout from its next wait for an
849    /// exchange on; `None` restores the listener's limit. For example, a
850    /// protocol shortens keep-alive while the worker pool is nearly full.
851    /// Values below the timer tick are raised to one tick.
852    ///
853    /// ```no_run
854    /// use std::time::Duration;
855    /// use net_io::{Input, Session, SessionContext, Step};
856    ///
857    /// struct KeepAlive;
858    /// impl Session for KeepAlive {
859    ///     fn on_data(&mut self, cx: &mut SessionContext<'_>, input: &mut Input) -> Step {
860    ///         let n = input.bytes().len();
861    ///         input.consume(n);
862    ///         let short = (cx.pressure() > 0.75).then_some(Duration::from_secs(2));
863    ///         cx.set_idle_timeout(short);
864    ///         Step::Write
865    ///     }
866    /// }
867    /// ```
868    pub fn set_idle_timeout(&mut self, timeout: Option<Duration>) {
869        self.link.set_idle_timeout(timeout);
870    }
871
872    /// Whether drain started: finish the current exchange, then close.
873    #[must_use]
874    pub fn draining(&self) -> bool {
875        self.draining
876    }
877
878    /// 0.0 to 1.0: busy workers (blocking driver); 1.0 while the control line sheds.
879    #[must_use]
880    pub fn pressure(&self) -> f32 {
881        self.pressure
882    }
883
884    /// A handle other threads can use to abort this connection.
885    #[must_use]
886    pub fn kill_handle(&self) -> KillHandle {
887        KillHandle {
888            slot: self.link.slot.clone(),
889            generation: self.link.generation,
890            id: self.link.info.id,
891        }
892    }
893
894    /// This worker's completion queue. A connection whose session takes it is
895    /// woken for posts while it waits for input too; on the blocking driver on
896    /// Linux that wait then costs one `poll` before each receive.
897    #[must_use]
898    pub fn completer(&self) -> Completer {
899        self.link.wakeable.set(true);
900        self.completer.clone()
901    }
902
903    /// The worker that runs this connection.
904    #[must_use]
905    pub fn worker(&self) -> WorkerId {
906        self.worker
907    }
908
909    /// This worker's buffer pool.
910    pub fn buffers(&mut self) -> &mut BufferPool {
911        self.pool
912    }
913
914    /// Returns a buffer (for example one taken by `Input::swap`); it is wiped.
915    pub fn release(&mut self, buffer: Buffer) {
916        self.pool.put(buffer);
917    }
918
919    /// Moves the unconsumed input into a buffer of `class` after this call returns.
920    ///
921    /// # Errors
922    ///
923    /// `Limit { which: ReadBuffer }` above the maximum read class.
924    pub fn grow_input(&mut self, class: SizeClass) -> Result<(), NetError> {
925        if class > self.link.limits.read_class_max {
926            return Err(NetError::Limit {
927                which: LimitKind::ReadBuffer,
928            });
929        }
930        self.grow_to = Some(class);
931        Ok(())
932    }
933}
934
935impl fmt::Debug for SessionContext<'_> {
936    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
937        f.debug_struct("SessionContext")
938            .field("id", &self.link.info.id)
939            .field("draining", &self.draining)
940            .finish()
941    }
942}
943
944#[cfg(test)]
945mod tests {
946    use super::*;
947
948    #[test]
949    fn test_input_consume_saturates_and_resets() {
950        let mut i = Input::from_bytes(b"abc");
951        i.consume(10);
952        assert!(i.bytes().is_empty());
953        assert_eq!(i.start, 0);
954    }
955
956    #[test]
957    fn test_input_swap_rules() {
958        let mut i = Input::from_bytes(b"xyz");
959        let mut pool = BufferPool::standalone(1 << 22);
960        let mut wrong = pool.take(SizeClass::LARGE).unwrap();
961        assert_eq!(i.swap(&mut wrong), Err(SwapError::ClassMismatch));
962        let mut full = pool.take(i.class()).unwrap();
963        full.set_len(1);
964        assert_eq!(i.swap(&mut full), Err(SwapError::NotEmpty));
965        let mut empty = pool.take(i.class()).unwrap();
966        i.consume(1);
967        i.swap(&mut empty).unwrap();
968        assert_eq!(empty.as_slice(), b"yz");
969    }
970
971    #[test]
972    fn test_output_push_all_or_nothing_and_partial() {
973        let mut o = Output::standalone(OUTPUT_CLASS.bytes());
974        let big = vec![7u8; OUTPUT_CLASS.bytes() as usize + 1];
975        assert_eq!(o.push(&big), Err(OutputFull));
976        assert!(o.is_empty());
977        assert_eq!(o.push_partial(&big), OUTPUT_CLASS.bytes() as usize);
978        assert_eq!(o.pending(), OUTPUT_CLASS.bytes() as usize);
979    }
980
981    #[test]
982    fn test_output_advance_releases_chunks() {
983        let mut o = Output::standalone(1 << 20);
984        o.push(b"hello").unwrap();
985        o.push_static(b" world").unwrap();
986        o.advance(7);
987        assert_eq!(o.pending(), 4);
988        assert_eq!(o.chunks.len(), 1);
989        assert_eq!(o.used, 0);
990        o.advance(4);
991        assert!(o.is_empty());
992    }
993
994    #[test]
995    fn test_output_response_markers() {
996        let mut o = Output::standalone(1 << 20);
997        o.begin_tagged_response(GateTag(3));
998        assert_eq!(o.response_tag, Some(GateTag(3)));
999        o.end_response();
1000        assert_eq!(o.response_tag, None);
1001    }
1002
1003    /// Property: whatever mix of pushes is accepted and however the sends split,
1004    /// the bytes that leave are the accepted bytes in order, and the budget returns.
1005    #[test]
1006    fn prop_output_stream_matches_accepted_pushes() {
1007        use crate::testing::Gen;
1008        static TEXT: [u8; 4096] = {
1009            let mut t = [0u8; 4096];
1010            let mut i = 0;
1011            while i < t.len() {
1012                t[i] = (i % 251) as u8;
1013                i += 1;
1014            }
1015            t
1016        };
1017        let mut g = Gen::new(0x0047_0041);
1018        for round in 0..if cfg!(miri) { 3 } else { 300 } {
1019            let mut o = Output::standalone(64 * 1024);
1020            let mut expected = Vec::new();
1021            let mut sent = Vec::new();
1022            for _ in 0..200 {
1023                match g.below(4) {
1024                    0 => {
1025                        let n = g.below(40_000) as usize;
1026                        let data: Vec<u8> = (0..n).map(|_| g.next_u64() as u8).collect();
1027                        let took = o.push_partial(&data);
1028                        expected.extend_from_slice(&data[..took]);
1029                    }
1030                    1 => {
1031                        let n = g.below(3000) as usize;
1032                        let data: Vec<u8> = (0..n).map(|_| g.next_u64() as u8).collect();
1033                        if o.push(&data).is_ok() {
1034                            expected.extend_from_slice(&data);
1035                        }
1036                    }
1037                    2 => {
1038                        let start = g.below(TEXT.len() as u64) as usize;
1039                        let piece = &TEXT[start..];
1040                        if o.push_static(piece).is_ok() {
1041                            expected.extend_from_slice(piece);
1042                        }
1043                    }
1044                    _ => {
1045                        // A send of a random size, taken from the front chunks as a vectored write would.
1046                        let mut want = g.below(70_000) as usize;
1047                        let mut taken = 0;
1048                        for chunk in o.chunks.iter() {
1049                            if want == 0 {
1050                                break;
1051                            }
1052                            let r = chunk.remaining();
1053                            let n = r.len().min(want);
1054                            sent.extend_from_slice(&r[..n]);
1055                            want -= n;
1056                            taken += n;
1057                        }
1058                        o.advance(taken);
1059                    }
1060                }
1061            }
1062            while !o.is_empty() {
1063                let n = o.chunks.front().map_or(0, |c| c.remaining().len());
1064                if let Some(c) = o.chunks.front() {
1065                    sent.extend_from_slice(c.remaining());
1066                }
1067                o.advance(n);
1068            }
1069            assert!(sent == expected, "round {round}: stream differs");
1070            assert_eq!(o.used, 0, "round {round}: budget not returned");
1071            assert_eq!(o.pending(), 0);
1072        }
1073    }
1074}