Line data    Source code

       1              : use std::{collections::VecDeque, sync::Arc};
       2              : 
       3              : use parking_lot::{Mutex, MutexGuard};
       4              : 
       5              : use crate::executor::{self, PollSome, Waker};
       6              : 
       7              : /// FIFO channel with blocking send and receive. Can be cloned and shared between threads.
       8              : /// Blocking functions should be used only from threads that are managed by the executor.
       9              : pub struct Chan<T> {
      10              :     shared: Arc<State<T>>,
      11              : }
      12              : 
      13              : impl<T> Clone for Chan<T> {
      14       606114 :     fn clone(&self) -> Self {
      15       606114 :         Chan {
      16       606114 :             shared: self.shared.clone(),
      17       606114 :         }
      18       606114 :     }
      19              : }
      20              : 
      21              : impl<T> Default for Chan<T> {
      22            0 :     fn default() -> Self {
      23            0 :         Self::new()
      24            0 :     }
      25              : }
      26              : 
      27              : impl<T> Chan<T> {
      28        81704 :     pub fn new() -> Chan<T> {
      29        81704 :         Chan {
      30        81704 :             shared: Arc::new(State {
      31        81704 :                 queue: Mutex::new(VecDeque::new()),
      32        81704 :                 waker: Waker::new(),
      33        81704 :             }),
      34        81704 :         }
      35        81704 :     }
      36              : 
      37              :     /// Get a message from the front of the queue, block if the queue is empty.
      38              :     /// If not called from the executor thread, it can block forever.
      39         1279 :     pub fn recv(&self) -> T {
      40         1279 :         self.shared.recv()
      41         1279 :     }
      42              : 
      43              :     /// Panic if the queue is empty.
      44        66286 :     pub fn must_recv(&self) -> T {
      45        66286 :         self.shared
      46        66286 :             .try_recv()
      47        66286 :             .expect("message should've been ready")
      48        66286 :     }
      49              : 
      50              :     /// Get a message from the front of the queue, return None if the queue is empty.
      51              :     /// Never blocks.
      52        56999 :     pub fn try_recv(&self) -> Option<T> {
      53        56999 :         self.shared.try_recv()
      54        56999 :     }
      55              : 
      56              :     /// Send a message to the back of the queue.
      57       121777 :     pub fn send(&self, t: T) {
      58       121777 :         self.shared.send(t);
      59       121777 :     }
      60              : }
      61              : 
      62              : struct State<T> {
      63              :     queue: Mutex<VecDeque<T>>,
      64              :     waker: Waker,
      65              : }
      66              : 
      67              : impl<T> State<T> {
      68       121777 :     fn send(&self, t: T) {
      69       121777 :         self.queue.lock().push_back(t);
      70       121777 :         self.waker.wake_all();
      71       121777 :     }
      72              : 
      73       123285 :     fn try_recv(&self) -> Option<T> {
      74       123285 :         let mut q = self.queue.lock();
      75       123285 :         q.pop_front()
      76       123285 :     }
      77              : 
      78         1279 :     fn recv(&self) -> T {
      79         1279 :         // interrupt the receiver to prevent consuming everything at once
      80         1279 :         executor::yield_me(0);
      81         1279 : 
      82         1279 :         let mut queue = self.queue.lock();
      83         1279 :         if let Some(t) = queue.pop_front() {
      84            0 :             return t;
      85         1279 :         }
      86              :         loop {
      87         2765 :             self.waker.wake_me_later();
      88         2765 :             if let Some(t) = queue.pop_front() {
      89         1207 :                 return t;
      90         1486 :             }
      91         1486 :             MutexGuard::unlocked(&mut queue, || {
      92         1486 :                 executor::yield_me(-1);
      93         1486 :             });
      94              :         }
      95         1207 :     }
      96              : }
      97              : 
      98              : impl<T> PollSome for Chan<T> {
      99              :     /// Schedules a wakeup for the current thread.
     100       781893 :     fn wake_me(&self) {
     101       781893 :         self.shared.waker.wake_me_later();
     102       781893 :     }
     103              : 
     104              :     /// Checks if chan has any pending messages.
     105       633596 :     fn has_some(&self) -> bool {
     106       633596 :         !self.shared.queue.lock().is_empty()
     107       633596 :     }
     108              : }