LCOV - code coverage report
Current view: top level - libs/desim/src - chan.rs (source / functions) Coverage Total Hit
Test: 5445d246133daeceb0507e6cc0797ab7c1c70cb8.info Lines: 90.0 % 60 54
Test Date: 2025-03-12 18:05:02 Functions: 69.0 % 29 20

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

Generated by: LCOV version 2.1-beta