mpmc-async 0.1.7

A multi-producer, multi-consumer async channel with reservations
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
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
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
use std::ops::DerefMut;
use std::sync::{Arc, Mutex};
use std::task::{Context, Poll, Waker};

use crate::linked_list::{LinkedList, NodeRef};
use crate::queue::{Queue, Recv, Spot};
use crate::{
    Receiver, RecvError, ReserveError, SendError, Sender, TryRecvError, TryReserveError,
    TrySendError,
};

pub struct State<T> {
    inner: Arc<Mutex<InnerState<T>>>,
}

impl<T> State<T> {}

impl<T> Clone for State<T> {
    fn clone(&self) -> Self {
        Self {
            inner: Arc::clone(&self.inner),
        }
    }
}

impl<T> State<T> {
    pub fn new(cap: usize) -> Self {
        State {
            inner: Arc::new(Mutex::new(InnerState::new(cap))),
        }
    }

    fn inner_mut(&self) -> impl DerefMut<Target = InnerState<T>> + '_ {
        self.inner.lock().unwrap()
    }

    pub fn new_sender(&self) -> Sender<T> {
        self.inner_mut().senders_count += 1;
        Sender::new(self.clone())
    }

    pub fn new_receiver(&self) -> Receiver<T> {
        self.inner_mut().receivers_count += 1;
        Receiver::new(self.clone())
    }

    pub fn close_all_receivers(&self) {
        let (send_futures, recv_futures) = {
            let mut inner = self.inner_mut();
            // inner.disconnected = true;

            (
                inner.mark_disconnected_and_take_send_futures(),
                inner.mark_disconnected_and_take_recv_futures(),
            )
        };

        for send_future in send_futures {
            send_future.wake();
        }

        for recv_future in recv_futures {
            recv_future.wake()
        }
    }

    pub fn drop_sender(&self) {
        let recv_futures = {
            let mut inner = self.inner_mut();
            inner.senders_count -= 1;

            (inner.senders_count == 0).then(|| inner.mark_disconnected_and_take_recv_futures())
        };

        if let Some(recv_futures) = recv_futures {
            for recv_future in recv_futures {
                recv_future.wake();
            }
        }
    }

    pub fn drop_receiver(&self) {
        let send_futures = {
            let mut inner = self.inner_mut();
            inner.receivers_count -= 1;

            (inner.receivers_count == 0).then(|| inner.mark_disconnected_and_take_send_futures())
        };

        if let Some(send_futures) = send_futures {
            for send_future in send_futures {
                send_future.wake();
            }
        }
    }

    pub fn try_send(&self, value: T) -> Result<(), TrySendError<T>> {
        let mut opt = Some(value);
        match self.inner_mut().try_send(&mut opt) {
            Ok(()) => Ok(()),
            Err(InnerSendError::Disconnected) => {
                Err(TrySendError::Disconnected(opt.take().unwrap()))
            }
            Err(InnerSendError::Full) => Err(TrySendError::Full(opt.take().unwrap())),
        }
    }

    pub fn send(
        &self,
        value: &mut Option<T>,
        cx: &mut Context<'_>,
        waker_ref: &mut Option<NodeRef<SendWaker>>,
    ) -> Poll<Result<(), SendError<T>>> {
        let mut inner = self.inner_mut();

        match inner.try_send(value) {
            Ok(()) => {
                if let Some(send_future) = waker_ref.take() {
                    inner.send_futures.remove(send_future);
                }

                Self::inner_drop_send_future(inner, value, waker_ref);

                Poll::Ready(Ok(()))
            }
            Err(InnerSendError::Full) => {
                let send_future = SendWaker::new(1, cx.waker().clone());

                match waker_ref {
                    None => {
                        *waker_ref = Some(inner.send_futures.push_tail(send_future));
                    }
                    Some(waker_ref) => {
                        // Satisfying the following requirement from std::future::Future::poll
                        // docs:
                        //
                        //     Note that on multiple calls to poll, only the Waker from the Context
                        //     passed to the most recent call should be scheduled to receive a
                        //     wakeup.
                        let send_future_mut =
                            inner.send_futures.get_mut(waker_ref).expect("send_future");
                        *send_future_mut = send_future;
                    }
                }

                Poll::Pending
            }
            Err(InnerSendError::Disconnected) => Poll::Ready(Err(SendError(value.take().unwrap()))),
        }
    }

    pub fn drop_send_future(
        &self,
        value: &mut Option<T>,
        waker_ref: &mut Option<NodeRef<SendWaker>>,
    ) {
        let inner = self.inner_mut();
        // If we'd already sent, both value and waker_ref will be None. It means we'd already
        // dropped everything we needed.
        if value.is_some() || waker_ref.is_some() {
            Self::inner_drop_send_future(inner, value, waker_ref);
        }
    }

    fn inner_drop_send_future(
        mut inner: impl DerefMut<Target = InnerState<T>>,
        value: &mut Option<T>,
        waker_ref: &mut Option<NodeRef<SendWaker>>,
    ) {
        let sent = value.is_none();

        let waker = {
            if let Some(node_ref) = waker_ref.take() {
                inner.send_futures.remove(node_ref);
            }
            let waker = if sent {
                // We just sent, wake a receiver.
                inner.next_recv_future_waker()
            } else {
                // A spot was freed, wake another sender
                inner.next_send_future_waker()
            };

            drop(inner);

            waker
        };

        if let Some(waker) = waker {
            waker.wake();
        }
    }

    pub fn try_reserve(&self, count: usize) -> Result<NodeRef<Spot<T>>, TryReserveError> {
        let mut inner = self.inner_mut();
        inner.try_reserve(count)
    }

    pub fn reserve(
        &self,
        count: usize,
        cx: &mut Context<'_>,
        waker_ref: &mut Option<NodeRef<SendWaker>>,
    ) -> Poll<Result<NodeRef<Spot<T>>, ReserveError>> {
        let mut inner = self.inner_mut();

        match inner.try_reserve(count) {
            Ok(reservation) => {
                if let Some(send_future) = waker_ref.take() {
                    inner.send_futures.remove(send_future);
                }

                Poll::Ready(Ok(reservation))
            }
            Err(TryReserveError::Full) => {
                let send_future = SendWaker::new(count, cx.waker().clone());

                match waker_ref {
                    None => {
                        *waker_ref = Some(inner.send_futures.push_tail(send_future));
                    }
                    Some(waker_ref) => {
                        // Satisfying the following requirement from std::future::Future::poll
                        // docs:
                        //
                        //     Note that on multiple calls to poll, only the Waker from the Context
                        //     passed to the most recent call should be scheduled to receive a
                        //     wakeup.
                        let send_future_mut =
                            inner.send_futures.get_mut(waker_ref).expect("send_future");
                        *send_future_mut = send_future;
                    }
                }

                Poll::Pending
            }
            Err(TryReserveError::Disconnected) => Poll::Ready(Err(ReserveError)),
        }
    }

    pub fn drop_reserve_future(&self, waker_ref: &mut Option<NodeRef<SendWaker>>) {
        let (recv_waker, send_waker) = {
            let mut inner = self.inner_mut();

            if let Some(node_ref) = waker_ref.take() {
                inner.send_futures.remove(node_ref);
            }

            (
                inner.next_recv_future_waker(),
                inner.next_send_future_waker(),
            )
        };

        if let Some(waker) = recv_waker {
            waker.wake();
        }

        if let Some(waker) = send_waker {
            waker.wake();
        }
    }

    pub fn send_with_permit(&self, reservation: NodeRef<Spot<T>>, value: T) {
        let waker = {
            let mut inner = self.inner_mut();
            inner.queue.send(reservation, value);
            inner.recv_futures.head().cloned()
        };

        if let Some(waker) = waker {
            waker.wake()
        }
    }

    pub fn drop_permit(&self, reservation: NodeRef<Spot<T>>, count: usize) {
        let waker = {
            let mut inner = self.inner_mut();

            let released = inner.queue.release(reservation, count);

            // When the permit was not used for sending, it means a spot was freed, so we can
            // notify the next sender that it can proceed.
            released
                .then(|| {
                    inner
                        .send_futures
                        .head()
                        .filter(|send_waker| inner.queue.has_room_for(send_waker.count))
                        .map(|send_waker| send_waker.waker.clone())
                })
                .flatten()
        };

        if let Some(waker) = waker {
            waker.wake();
        }
    }

    pub fn try_recv(&self) -> Result<T, TryRecvError> {
        let mut inner = self.inner_mut();
        inner.try_recv()
    }

    pub fn recv(
        &self,
        cx: &mut Context<'_>,
        has_received: &mut bool,
        waker_ref: &mut Option<NodeRef<Waker>>,
    ) -> Poll<Result<T, RecvError>> {
        self.recv_with_callback(cx, has_received, waker_ref, |value, _inner| value)
    }

    fn recv_with_callback<F, R>(
        &self,
        cx: &mut Context<'_>,
        has_received: &mut bool,
        waker_ref: &mut Option<NodeRef<Waker>>,
        callback: F,
    ) -> Poll<Result<R, RecvError>>
    where
        F: FnOnce(T, &mut InnerState<T>) -> R,
    {
        let mut inner = self.inner_mut();

        match inner.try_recv() {
            Ok(value) => {
                if let Some(node_ref) = waker_ref.take() {
                    inner.recv_futures.remove(node_ref);
                }

                *has_received = true;

                let ret = callback(value, &mut inner);

                Self::inner_drop_recv_future(inner, true, waker_ref);

                Poll::Ready(Ok(ret))
            }
            Err(TryRecvError::Disconnected) => Poll::Ready(Err(RecvError)),
            Err(TryRecvError::Empty) => {
                let waker = cx.waker().clone();
                match waker_ref {
                    None => {
                        *waker_ref = Some(inner.recv_futures.push_tail(waker));
                    }
                    Some(waker_ref) => {
                        // Satisfying the following requirement from std::future::Future::poll
                        // docs:
                        //
                        //     Note that on multiple calls to poll, only the Waker from the Context
                        //     passed to the most recent call should be scheduled to receive a
                        //     wakeup.
                        let waker_ref_mut =
                            inner.recv_futures.get_mut(waker_ref).expect("recv_future");
                        *waker_ref_mut = waker;
                    }
                }

                Poll::Pending
            }
        }
    }

    pub fn try_recv_many(&self, vec: &mut Vec<T>, count: usize) -> Result<usize, TryRecvError> {
        let mut inner = self.inner_mut();
        inner.try_recv_many(vec, count)
    }

    pub fn recv_many(
        &self,
        cx: &mut Context<'_>,
        has_received: &mut bool,
        waker_ref: &mut Option<NodeRef<Waker>>,
        vec: &mut Vec<T>,
        count: usize,
    ) -> Poll<Result<usize, RecvError>> {
        self.recv_with_callback(cx, has_received, waker_ref, |value, inner| {
            vec.push(value);
            inner.fill_rest(vec, count)
        })
    }

    pub fn drop_recv_future(&self, has_received: bool, waker_ref: &mut Option<NodeRef<Waker>>) {
        let inner = self.inner_mut();
        if !has_received {
            Self::inner_drop_recv_future(inner, has_received, waker_ref);
        }
    }

    fn inner_drop_recv_future(
        mut inner: impl DerefMut<Target = InnerState<T>>,
        has_received: bool,
        waker_ref: &mut Option<NodeRef<Waker>>,
    ) {
        let waker = {
            if let Some(node_ref) = waker_ref.take() {
                inner.recv_futures.remove(node_ref);
            }

            let waker = if !has_received {
                // If we have not received, it means another RecvFuture might take over.
                inner.next_recv_future_waker()
            } else {
                // If we have received, it means a spot was freed in the internal buffer, so wake
                // one send_future
                inner.next_send_future_waker()
            };

            drop(inner);

            waker
        };

        if let Some(waker) = waker {
            waker.wake();
        }
    }
}

pub struct SendWaker {
    count: usize,
    waker: Waker,
}

impl SendWaker {
    pub fn new(count: usize, waker: Waker) -> Self {
        Self { count, waker }
    }

    pub fn wake(self) {
        self.waker.wake()
    }
}

struct InnerState<T> {
    /// Contains ordered values and pending entries.
    queue: Queue<T>,
    /// Total of created receivers.
    receivers_count: usize,
    /// Total of created senders.
    senders_count: usize,
    /// Senders waiting to send.
    send_futures: LinkedList<SendWaker>,
    /// Receivers waiting to receive.
    recv_futures: LinkedList<Waker>,
    /// False by default, true when all senders or all receivers are dropped.
    disconnected: bool,
}

pub enum InnerSendError {
    Disconnected,
    Full,
}

impl<T> InnerState<T> {
    pub fn new(cap: usize) -> Self {
        Self {
            queue: Queue::new(cap),
            receivers_count: 0,
            senders_count: 0,
            send_futures: LinkedList::new(),
            recv_futures: LinkedList::new(),
            disconnected: false,
        }
    }

    pub fn try_send(&mut self, value: &mut Option<T>) -> Result<(), InnerSendError> {
        if self.disconnected {
            Err(InnerSendError::Disconnected)
        } else {
            self.queue.try_send(value).ok_or(InnerSendError::Full)
        }
    }

    pub fn try_reserve(&mut self, count: usize) -> Result<NodeRef<Spot<T>>, TryReserveError> {
        if self.disconnected {
            Err(TryReserveError::Disconnected)
        } else {
            self.queue.try_reserve(count).ok_or(TryReserveError::Full)
        }
    }

    pub fn try_recv(&mut self) -> Result<T, TryRecvError> {
        match self.queue.try_recv() {
            Recv::Value(value) => Ok(value),
            Recv::Pending => Err(TryRecvError::Empty),
            Recv::Empty => {
                if self.disconnected {
                    Err(TryRecvError::Disconnected)
                } else {
                    Err(TryRecvError::Empty)
                }
            }
        }
    }

    pub fn try_recv_many(&mut self, vec: &mut Vec<T>, count: usize) -> Result<usize, TryRecvError> {
        let value = self.try_recv()?;
        vec.push(value);
        Ok(self.fill_rest(vec, count))
    }

    pub fn fill_rest(&mut self, vec: &mut Vec<T>, count: usize) -> usize {
        let mut total = 1;

        for _ in 1..count {
            match self.queue.try_recv() {
                Recv::Value(value) => {
                    vec.push(value);
                    total += 1;
                }
                Recv::Pending | Recv::Empty => break,
            }
        }

        total
    }

    fn mark_disconnected_and_take_send_futures(&mut self) -> LinkedList<SendWaker> {
        self.disconnected = true;
        std::mem::take(&mut self.send_futures)
    }

    fn mark_disconnected_and_take_recv_futures(&mut self) -> LinkedList<Waker> {
        self.disconnected = true;
        std::mem::take(&mut self.recv_futures)
    }

    #[must_use]
    fn next_send_future_waker(&self) -> Option<Waker> {
        let send_future = self.send_futures.head()?;

        // NOTE: Not calling pop_head() because calling wake() does not guarantee that the future
        // will be chosen (e.g. in a tokio::select!)
        self.queue
            .has_room_for(send_future.count)
            .then_some(send_future.waker.clone())
    }

    #[must_use]
    fn next_recv_future_waker(&mut self) -> Option<Waker> {
        // NOTE: Not calling pop_head() because calling wake() does not guarantee that the future
        // will be chosen (e.g. in a tokio::select!)
        self.queue
            .can_recv()
            .then(|| self.recv_futures.head().cloned())
            .flatten()
    }
}