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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
use super::ChannelSendError;
use crate::intrusive_double_linked_list::ListNode;
use core::marker::PhantomData;
use core::pin::Pin;
use futures_core::future::{FusedFuture, Future};
use futures_core::task::{Context, Poll, Waker};

/// Conveys additional information regarding the status of a channel
/// following a `close` operation.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
pub enum CloseStatus {
    /// The channel has just been closed by the operation.
    NewlyClosed,

    /// The channel was already closed prior to the operation.
    AlreadyClosed,
}

impl CloseStatus {
    /// Returns whether the value is the `NewlyClosed` variant.
    pub fn is_newly_closed(self) -> bool {
        match self {
            Self::NewlyClosed => true,
            _ => false,
        }
    }

    /// Returns whether the value is the `AlreadyClosed` variant.
    pub fn is_already_closed(self) -> bool {
        match self {
            Self::AlreadyClosed => true,
            _ => false,
        }
    }
}

/// Tracks how the future had interacted with the channel
#[derive(PartialEq, Debug)]
pub enum RecvPollState {
    /// The task is not registered at the wait queue at the channel
    Unregistered,
    /// The task was added to the wait queue at the channel.
    Registered,
    /// The task was notified that a value is available or can be sent,
    /// but hasn't interacted with the channel since then
    Notified,
}

/// Tracks the channel futures waiting state.
/// Access to this struct is synchronized through the channel.
#[derive(Debug)]
pub struct RecvWaitQueueEntry {
    /// The task handle of the waiting task
    pub task: Option<Waker>,
    /// Current polling state
    pub state: RecvPollState,
}

impl RecvWaitQueueEntry {
    /// Creates a new RecvWaitQueueEntry
    pub fn new() -> RecvWaitQueueEntry {
        RecvWaitQueueEntry {
            task: None,
            state: RecvPollState::Unregistered,
        }
    }
}

/// Tracks how the future had interacted with the channel
#[derive(PartialEq, Debug)]
pub enum SendPollState {
    /// The task is not registered at the wait queue at the channel
    Unregistered,
    /// The task was added to the wait queue at the channel.
    Registered,
    /// The value has been transmitted to the other task
    SendComplete,
}

/// Tracks the channel futures waiting state.
/// Access to this struct is synchronized through the channel.
pub struct SendWaitQueueEntry<T> {
    /// The task handle of the waiting task
    pub task: Option<Waker>,
    /// Current polling state
    pub state: SendPollState,
    /// The value to send
    pub value: Option<T>,
}

impl<T> core::fmt::Debug for SendWaitQueueEntry<T> {
    fn fmt(
        &self,
        fmt: &mut core::fmt::Formatter<'_>,
    ) -> core::result::Result<(), core::fmt::Error> {
        fmt.debug_struct("SendWaitQueueEntry")
            .field("task", &self.task)
            .field("state", &self.state)
            .finish()
    }
}

impl<T> SendWaitQueueEntry<T> {
    /// Creates a new SendWaitQueueEntry
    pub fn new(value: T) -> SendWaitQueueEntry<T> {
        SendWaitQueueEntry {
            task: None,
            state: SendPollState::Unregistered,
            value: Some(value),
        }
    }
}

/// Adapter trait that allows Futures to generically interact with Channel
/// implementations via dynamic dispatch.
pub trait ChannelSendAccess<T> {
    unsafe fn send_or_register(
        &self,
        wait_node: &mut ListNode<SendWaitQueueEntry<T>>,
        cx: &mut Context<'_>,
    ) -> (Poll<()>, Option<T>);

    fn remove_send_waiter(
        &self,
        wait_node: &mut ListNode<SendWaitQueueEntry<T>>,
    );
}

/// Adapter trait that allows Futures to generically interact with Channel
/// implementations via dynamic dispatch.
pub trait ChannelReceiveAccess<T> {
    unsafe fn receive_or_register(
        &self,
        wait_node: &mut ListNode<RecvWaitQueueEntry>,
        cx: &mut Context<'_>,
    ) -> Poll<Option<T>>;

    fn remove_receive_waiter(
        &self,
        wait_node: &mut ListNode<RecvWaitQueueEntry>,
    );
}

/// A Future that is returned by the `receive` function on a channel.
/// The future gets resolved with `Some(value)` when a value could be
/// received from the channel.
/// If the channels gets closed and no items are still enqueued inside the
/// channel, the future will resolve to `None`.
#[must_use = "futures do nothing unless polled"]
pub struct ChannelReceiveFuture<'a, MutexType, T> {
    /// The channel that is associated with this ChannelReceiveFuture
    pub(crate) channel: Option<&'a dyn ChannelReceiveAccess<T>>,
    /// Node for waiting on the channel
    pub(crate) wait_node: ListNode<RecvWaitQueueEntry>,
    /// Marker for mutex type
    pub(crate) _phantom: PhantomData<MutexType>,
}

// Safety: Channel futures can be sent between threads as long as the underlying
// channel is thread-safe (Sync), which allows to poll/register/unregister from
// a different thread.
unsafe impl<'a, MutexType: Sync, T: Send> Send
    for ChannelReceiveFuture<'a, MutexType, T>
{
}

impl<'a, MutexType, T> core::fmt::Debug
    for ChannelReceiveFuture<'a, MutexType, T>
{
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        f.debug_struct("ChannelReceiveFuture").finish()
    }
}

impl<'a, MutexType, T> Future for ChannelReceiveFuture<'a, MutexType, T> {
    type Output = Option<T>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<T>> {
        // It might be possible to use Pin::map_unchecked here instead of the two unsafe APIs.
        // However this didn't seem to work for some borrow checker reasons

        // Safety: The next operations are safe, because Pin promises us that
        // the address of the wait queue entry inside ChannelReceiveFuture is stable,
        // and we don't move any fields inside the future until it gets dropped.
        let mut_self: &mut ChannelReceiveFuture<MutexType, T> =
            unsafe { Pin::get_unchecked_mut(self) };

        let channel = mut_self
            .channel
            .expect("polled ChannelReceiveFuture after completion");

        let poll_res =
            unsafe { channel.receive_or_register(&mut mut_self.wait_node, cx) };

        if poll_res.is_ready() {
            // A value was available
            mut_self.channel = None;
        }

        poll_res
    }
}

impl<'a, MutexType, T> FusedFuture for ChannelReceiveFuture<'a, MutexType, T> {
    fn is_terminated(&self) -> bool {
        self.channel.is_none()
    }
}

impl<'a, MutexType, T> Drop for ChannelReceiveFuture<'a, MutexType, T> {
    fn drop(&mut self) {
        // If this ChannelReceiveFuture has been polled and it was added to the
        // wait queue at the channel, it must be removed before dropping.
        // Otherwise the channel would access invalid memory.
        if let Some(channel) = self.channel {
            channel.remove_receive_waiter(&mut self.wait_node);
        }
    }
}

/// A Future that is returned by the `send` function on a channel.
/// The future gets resolved with `None` when a value could be
/// written to the channel.
/// If the channel gets closed the send operation will fail, and the
/// Future will resolve to `ChannelSendError(T)` and return the item to send.
#[must_use = "futures do nothing unless polled"]
pub struct ChannelSendFuture<'a, MutexType, T> {
    /// The Channel that is associated with this ChannelSendFuture
    pub(crate) channel: Option<&'a dyn ChannelSendAccess<T>>,
    /// Node for waiting on the channel
    pub(crate) wait_node: ListNode<SendWaitQueueEntry<T>>,
    /// Marker for mutex type
    pub(crate) _phantom: PhantomData<MutexType>,
}

// Safety: Channel futures can be sent between threads as long as the underlying
// channel is thread-safe (Sync), which allows to poll/register/unregister from
// a different thread.
unsafe impl<'a, MutexType: Sync, T: Send> Send
    for ChannelSendFuture<'a, MutexType, T>
{
}

impl<'a, MutexType, T> core::fmt::Debug
    for ChannelSendFuture<'a, MutexType, T>
{
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        f.debug_struct("ChannelSendFuture").finish()
    }
}

impl<'a, MutexType, T> ChannelSendFuture<'a, MutexType, T> {
    /// Tries to cancel the ongoing send operation
    pub fn cancel(&mut self) -> Option<T> {
        let channel = self.channel.take();
        match channel {
            None => None,
            Some(channel) => {
                channel.remove_send_waiter(&mut self.wait_node);
                self.wait_node.value.take()
            }
        }
    }
}

impl<'a, MutexType, T> Future for ChannelSendFuture<'a, MutexType, T> {
    type Output = Result<(), ChannelSendError<T>>;

    fn poll(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Result<(), ChannelSendError<T>>> {
        // It might be possible to use Pin::map_unchecked here instead of the two unsafe APIs.
        // However this didn't seem to work for some borrow checker reasons

        // Safety: The next operations are safe, because Pin promises us that
        // the address of the wait queue entry inside ChannelSendFuture is stable,
        // and we don't move any fields inside the future until it gets dropped.
        let mut_self: &mut ChannelSendFuture<MutexType, T> =
            unsafe { Pin::get_unchecked_mut(self) };

        let channel = mut_self
            .channel
            .expect("polled ChannelSendFuture after completion");

        let send_res =
            unsafe { channel.send_or_register(&mut mut_self.wait_node, cx) };

        match send_res.0 {
            Poll::Ready(()) => {
                // Value has been transmitted or channel was closed
                mut_self.channel = None;
                match send_res.1 {
                    Some(v) => {
                        // Channel must have been closed
                        Poll::Ready(Err(ChannelSendError(v)))
                    }
                    None => Poll::Ready(Ok(())),
                }
            }
            Poll::Pending => Poll::Pending,
        }
    }
}

impl<'a, MutexType, T> FusedFuture for ChannelSendFuture<'a, MutexType, T> {
    fn is_terminated(&self) -> bool {
        self.channel.is_none()
    }
}

impl<'a, MutexType, T> Drop for ChannelSendFuture<'a, MutexType, T> {
    fn drop(&mut self) {
        // If this ChannelSendFuture has been polled and it was added to the
        // wait queue at the channel, it must be removed before dropping.
        // Otherwise the channel would access invalid memory.
        if let Some(channel) = self.channel {
            channel.remove_send_waiter(&mut self.wait_node);
        }
    }
}

#[cfg(feature = "alloc")]
mod if_alloc {
    use super::*;

    pub mod shared {
        use super::*;

        /// A Future that is returned by the `receive` function on a channel.
        /// The future gets resolved with `Some(value)` when a value could be
        /// received from the channel.
        /// If the channels gets closed and no items are still enqueued inside the
        /// channel, the future will resolve to `None`.
        #[must_use = "futures do nothing unless polled"]
        pub struct ChannelReceiveFuture<MutexType, T> {
            /// The Channel that is associated with this ChannelReceiveFuture
            pub(crate) channel:
                Option<alloc::sync::Arc<dyn ChannelReceiveAccess<T>>>,
            /// Node for waiting on the channel
            pub(crate) wait_node: ListNode<RecvWaitQueueEntry>,
            /// Marker for mutex type
            pub(crate) _phantom: PhantomData<MutexType>,
        }

        // Safety: Channel futures can be sent between threads as long as the underlying
        // channel is thread-safe (Sync), which allows to poll/register/unregister from
        // a different thread.
        unsafe impl<MutexType: Sync, T: Send> Send
            for ChannelReceiveFuture<MutexType, T>
        {
        }

        impl<MutexType, T> core::fmt::Debug for ChannelReceiveFuture<MutexType, T> {
            fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
                f.debug_struct("ChannelReceiveFuture").finish()
            }
        }

        impl<MutexType, T> Future for ChannelReceiveFuture<MutexType, T> {
            type Output = Option<T>;

            fn poll(
                self: Pin<&mut Self>,
                cx: &mut Context<'_>,
            ) -> Poll<Option<T>> {
                // It might be possible to use Pin::map_unchecked here instead of the two unsafe APIs.
                // However this didn't seem to work for some borrow checker reasons

                // Safety: The next operations are safe, because Pin promises us that
                // the address of the wait queue entry inside ChannelReceiveFuture is stable,
                // and we don't move any fields inside the future until it gets dropped.
                let mut_self: &mut ChannelReceiveFuture<MutexType, T> =
                    unsafe { Pin::get_unchecked_mut(self) };

                let channel = mut_self
                    .channel
                    .take()
                    .expect("polled ChannelReceiveFuture after completion");

                let poll_res = unsafe {
                    channel.receive_or_register(&mut mut_self.wait_node, cx)
                };

                if poll_res.is_ready() {
                    // A value was available
                    mut_self.channel = None;
                } else {
                    mut_self.channel = Some(channel)
                }

                poll_res
            }
        }

        impl<MutexType, T> FusedFuture for ChannelReceiveFuture<MutexType, T> {
            fn is_terminated(&self) -> bool {
                self.channel.is_none()
            }
        }

        impl<MutexType, T> Drop for ChannelReceiveFuture<MutexType, T> {
            fn drop(&mut self) {
                // If this ChannelReceiveFuture has been polled and it was added to the
                // wait queue at the channel, it must be removed before dropping.
                // Otherwise the channel would access invalid memory.
                if let Some(channel) = &self.channel {
                    channel.remove_receive_waiter(&mut self.wait_node);
                }
            }
        }

        /// A Future that is returned by the `send` function on a channel.
        /// The future gets resolved with `None` when a value could be
        /// written to the channel.
        /// If the channel gets closed the send operation will fail, and the
        /// Future will resolve to `ChannelSendError(T)` and return the item
        /// to send.
        #[must_use = "futures do nothing unless polled"]
        pub struct ChannelSendFuture<MutexType, T> {
            /// The LocalChannel that is associated with this ChannelSendFuture
            pub(crate) channel:
                Option<alloc::sync::Arc<dyn ChannelSendAccess<T>>>,
            /// Node for waiting on the channel
            pub(crate) wait_node: ListNode<SendWaitQueueEntry<T>>,
            /// Marker for mutex type
            pub(crate) _phantom: PhantomData<MutexType>,
        }

        impl<MutexType, T> ChannelSendFuture<MutexType, T> {
            /// Tries to cancel the ongoing send operation
            pub fn cancel(&mut self) -> Option<T> {
                let channel = self.channel.take();
                match channel {
                    None => None,
                    Some(channel) => {
                        channel.remove_send_waiter(&mut self.wait_node);
                        self.wait_node.value.take()
                    }
                }
            }
        }

        // Safety: Channel futures can be sent between threads as long as the underlying
        // channel is thread-safe (Sync), which allows to poll/register/unregister from
        // a different thread.
        unsafe impl<MutexType: Sync, T: Send> Send for ChannelSendFuture<MutexType, T> {}

        impl<MutexType, T> core::fmt::Debug for ChannelSendFuture<MutexType, T> {
            fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
                f.debug_struct("ChannelSendFuture").finish()
            }
        }

        impl<MutexType, T> Future for ChannelSendFuture<MutexType, T> {
            type Output = Result<(), ChannelSendError<T>>;

            fn poll(
                self: Pin<&mut Self>,
                cx: &mut Context<'_>,
            ) -> Poll<Result<(), ChannelSendError<T>>> {
                // It might be possible to use Pin::map_unchecked here instead of the two unsafe APIs.
                // However this didn't seem to work for some borrow checker reasons

                // Safety: The next operations are safe, because Pin promises us that
                // the address of the wait queue entry inside ChannelSendFuture is stable,
                // and we don't move any fields inside the future until it gets dropped.
                let mut_self: &mut ChannelSendFuture<MutexType, T> =
                    unsafe { Pin::get_unchecked_mut(self) };

                let channel = mut_self
                    .channel
                    .take()
                    .expect("polled ChannelSendFuture after completion");

                let send_res = unsafe {
                    channel.send_or_register(&mut mut_self.wait_node, cx)
                };

                match send_res.0 {
                    Poll::Ready(()) => {
                        // Value has been transmitted or channel was closed
                        match send_res.1 {
                            Some(v) => {
                                // Channel must have been closed
                                Poll::Ready(Err(ChannelSendError(v)))
                            }
                            None => Poll::Ready(Ok(())),
                        }
                    }
                    Poll::Pending => {
                        mut_self.channel = Some(channel);
                        Poll::Pending
                    }
                }
            }
        }

        impl<MutexType, T> FusedFuture for ChannelSendFuture<MutexType, T> {
            fn is_terminated(&self) -> bool {
                self.channel.is_none()
            }
        }

        impl<MutexType, T> Drop for ChannelSendFuture<MutexType, T> {
            fn drop(&mut self) {
                // If this ChannelSendFuture has been polled and it was added to the
                // wait queue at the channel, it must be removed before dropping.
                // Otherwise the channel would access invalid memory.
                if let Some(channel) = &self.channel {
                    channel.remove_send_waiter(&mut self.wait_node);
                }
            }
        }
    }
}

#[cfg(feature = "alloc")]
pub use self::if_alloc::*;