nuclei 0.5.2

Proactive IO & runtime system
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! What a shard publishes of its own cells for `stats`, each time it looks
//! at its driver.

use super::{Driver, Shard};
use crate::rt::counters::Published;

impl Driver {
    /// The kernel interface the driver runs IO on.
    pub(super) fn backend(&self) -> crate::IoBackend {
        match self {
            Driver::Poll(_) => crate::proactor::POLLER,
            #[cfg(ring)]
            Driver::Ring(_) | Driver::Gone => crate::IoBackend::IoUring,
        }
    }
}

impl Shard {
    /// Publishes at once what the shard holds, its run loop's polls
    /// counted in: what a test reads without waiting for the shard to look.
    #[cfg(test)]
    pub(crate) fn publish_now(&self) {
        self.count_again(self.since_drive());
        self.publish();
    }

    #[cfg(all(completion, feature = "io-stats"))]
    /// Has the shard's ring or port stamp the operations it issues from now
    /// on, to record their latencies; a readiness poller issues none.
    pub(super) fn time_io(&self) {
        let Some(times) = self.shared.counters.io_times() else {
            return;
        };
        match &self.driver {
            #[cfg(ring)]
            Driver::Ring(ring) => ring.time_with(std::sync::Arc::clone(times)),
            #[cfg(ring)]
            Driver::Gone => {}
            #[cfg(readiness)]
            Driver::Poll(_) => {}
            #[cfg(port)]
            Driver::Poll(_) => self.shared.port.time_with(std::sync::Arc::clone(times)),
        }
    }

    /// Counts a sleep of `slept` for `stats` and, unless a blocking job was out
    /// (`tells_the_spin` false), tells the spin how long it was.
    pub(super) fn slept_for(&self, slept: std::time::Duration, tells_the_spin: bool) {
        self.sleeps.set(self.sleeps.get() + 1);
        self.slept.set(self.slept.get() + slept);
        if tells_the_spin {
            self.spin.parked_for(slept);
        }
    }

    /// Publishes the polls, the sleeps, the queue, the remote wakes, the
    /// timers, the buffer pool and the driver's operations.
    pub(super) fn publish(&self) {
        let (ops_in_flight, cq_overflows) = match &self.driver {
            #[cfg(ring)]
            Driver::Ring(ring) => (ring.in_flight(), ring.overflows()),
            #[cfg(ring)]
            Driver::Gone => (0, 0),
            // A readiness poller hands the kernel no operation.
            #[cfg(readiness)]
            Driver::Poll(_) => (0, 0),
            #[cfg(port)]
            Driver::Poll(_) => (self.shared.port.out(), 0),
        };
        self.shared.counters.publish(Published {
            polls: self.polls.get(),
            parks: self.sleeps.get(),
            parked: self.slept.get(),
            queue_depth: self.queued(),
            remote_wakes: self.remote_wakes.get(),
            timers: self.wheel.borrow().armed(),
            buffer_bytes: self.pool.charged(),
            buffer_exhausted: self.pool.exhausted(),
            ops_in_flight,
            cq_overflows,
        });
    }
}