nuclei 0.5.0

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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! The futures of a token: the borrowed and the owned wait for cancellation,
//! and the race of a future against one.

#![allow(unsafe_code)]

use core::fmt;
use core::future::Future;
use core::mem::MaybeUninit;
use core::pin::Pin;
use core::task::{Context, Poll};

use super::CancellationToken;
use crate::sync::event::{Event, EventWait};

/// `fut`, or `None` if the token is cancelled first; `fut` wins a tie.
pub(super) struct RunUntilCancelled<'a, F: Future> {
    pub(super) cancellation: WaitForCancellationFuture<'a>,
    pub(super) future: F,
}

impl<F: Future> Future for RunUntilCancelled<'_, F> {
    type Output = Option<F::Output>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        // SAFETY: `future` is pinned structurally: it is never moved out of
        // the struct, the struct has no `Drop`, and it is `Unpin` only when
        // `F` is. `cancellation` is `Unpin`.
        let this = unsafe { self.get_unchecked_mut() };
        // SAFETY: as above.
        let future = unsafe { Pin::new_unchecked(&mut this.future) };
        if let Poll::Ready(output) = future.poll(cx) {
            Poll::Ready(Some(output))
        } else if Pin::new(&mut this.cancellation).poll(cx).is_ready() {
            Poll::Ready(None)
        } else {
            Poll::Pending
        }
    }
}

/// A future that resolves once the corresponding [`CancellationToken`] is
/// cancelled.
///
/// Created by [`CancellationToken::cancelled`].
#[must_use = "futures do nothing unless polled"]
pub struct WaitForCancellationFuture<'a> {
    pub(super) wait: EventWait<'a>,
}

impl fmt::Debug for WaitForCancellationFuture<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("WaitForCancellationFuture").finish()
    }
}

impl Future for WaitForCancellationFuture<'_> {
    type Output = ();

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()> {
        Pin::new(&mut self.get_mut().wait).poll(cx)
    }
}

/// Tells the compiler its contents may dangle: a reference inside is not
/// assumed valid for as long as a function argument holding it is in scope,
/// which the owned future needs because it drops the node its reference
/// points into while it is itself being dropped.
#[repr(transparent)]
struct MaybeDangling<T>(MaybeUninit<T>);

impl<T> MaybeDangling<T> {
    fn new(inner: T) -> Self {
        Self(MaybeUninit::new(inner))
    }

    fn get_mut(&mut self) -> &mut T {
        // SAFETY: the cell is initialised by `new` and dropped only by `Drop`.
        unsafe { self.0.assume_init_mut() }
    }
}

impl<T> Drop for MaybeDangling<T> {
    fn drop(&mut self) {
        // SAFETY: the cell is initialised and dropped only here.
        unsafe { self.0.assume_init_drop() };
    }
}

/// A future that resolves once the corresponding [`CancellationToken`] is
/// cancelled, and owns the token.
///
/// Created by [`CancellationToken::cancelled_owned`].
#[must_use = "futures do nothing unless polled"]
pub struct WaitForCancellationFutureOwned {
    // The wait borrows the node `token` keeps alive, with the borrow's
    // lifetime erased to `'static`. It is declared first so it drops first:
    // it must never be used or dropped after `token` is gone.
    wait: MaybeDangling<EventWait<'static>>,
    _token: CancellationToken,
}

impl WaitForCancellationFutureOwned {
    pub(super) fn new(token: CancellationToken) -> Self {
        let event: *const Event = &token.node.cancelled;
        // SAFETY: the event lives inside the heap allocation `token` owns, so
        // it does not move when the future does and lives as long as `token`,
        // which is a field of the future that drops after `wait`.
        let wait = unsafe { (*event).wait() };
        Self {
            wait: MaybeDangling::new(wait),
            _token: token,
        }
    }
}

impl fmt::Debug for WaitForCancellationFutureOwned {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("WaitForCancellationFutureOwned").finish()
    }
}

impl Future for WaitForCancellationFutureOwned {
    type Output = ();

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()> {
        Pin::new(self.get_mut().wait.get_mut()).poll(cx)
    }
}