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      2458481 :     fn clone(&self) -> Self {
      15      2458481 :         Chan {
      16      2458481 :             shared: self.shared.clone(),
      17      2458481 :         }
      18      2458481 :     }
      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       313064 :     pub fn new() -> Chan<T> {
      29       313064 :         Chan {
      30       313064 :             shared: Arc::new(State {
      31       313064 :                 queue: Mutex::new(VecDeque::new()),
      32       313064 :                 waker: Waker::new(),
      33       313064 :             }),
      34       313064 :         }
      35       313064 :     }
      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         2145 :     pub fn recv(&self) -> T {
      40         2145 :         self.shared.recv()
      41         2145 :     }
      42              : 
      43              :     /// Panic if the queue is empty.
      44       262870 :     pub fn must_recv(&self) -> T {
      45       262870 :         self.shared
      46       262870 :             .try_recv()
      47       262870 :             .expect("message should've been ready")
      48       262870 :     }
      49              : 
      50              :     /// Get a message from the front of the queue, return None if the queue is empty.
      51              :     /// Never blocks.
      52       231048 :     pub fn try_recv(&self) -> Option<T> {
      53       231048 :         self.shared.try_recv()
      54       231048 :     }
      55              : 
      56              :     /// Send a message to the back of the queue.
      57       478642 :     pub fn send(&self, t: T) {
      58       478642 :         self.shared.send(t);
      59       478642 :     }
      60              : }
      61              : 
      62              : struct State<T> {
      63              :     queue: Mutex<VecDeque<T>>,
      64              :     waker: Waker,
      65              : }
      66              : 
      67              : impl<T> State<T> {
      68       478642 :     fn send(&self, t: T) {
      69       478642 :         self.queue.lock().push_back(t);
      70       478642 :         self.waker.wake_all();
      71       478642 :     }
      72              : 
      73       493918 :     fn try_recv(&self) -> Option<T> {
      74       493918 :         let mut q = self.queue.lock();
      75       493918 :         q.pop_front()
      76       493918 :     }
      77              : 
      78         2145 :     fn recv(&self) -> T {
      79         2145 :         // interrupt the receiver to prevent consuming everything at once
      80         2145 :         executor::yield_me(0);
      81         2145 : 
      82         2145 :         let mut queue = self.queue.lock();
      83         2145 :         if let Some(t) = queue.pop_front() {
      84            0 :             return t;
      85         2145 :         }
      86              :         loop {
      87         5268 :             self.waker.wake_me_later();
      88         5268 :             if let Some(t) = queue.pop_front() {
      89         1888 :                 return t;
      90         3123 :             }
      91         3123 :             MutexGuard::unlocked(&mut queue, || {
      92         3123 :                 executor::yield_me(-1);
      93         3123 :             });
      94              :         }
      95         1888 :     }
      96              : }
      97              : 
      98              : impl<T> PollSome for Chan<T> {
      99              :     /// Schedules a wakeup for the current thread.
     100      3096779 :     fn wake_me(&self) {
     101      3096779 :         self.shared.waker.wake_me_later();
     102      3096779 :     }
     103              : 
     104              :     /// Checks if chan has any pending messages.
     105      2492066 :     fn has_some(&self) -> bool {
     106      2492066 :         !self.shared.queue.lock().is_empty()
     107      2492066 :     }
     108              : }