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
use arc_swap::ArcSwap;
use async_trait::async_trait;
use lockfree::stack::Stack;
use std::{
    fmt::Debug, future::Future, marker::PhantomData, sync::atomic::AtomicBool,
    sync::atomic::Ordering, sync::Arc, task::Poll, task::Waker,
};

use crate::{Channel, Receiver, Sender, Storage};

/// Constructs a new barrier pair (sender/receiver)
///
/// The barrier channel is a variant of a oneshot channel.
///
/// The sender can be released (or dropped), which will resolve all receivers.
///
/// Receivers implement Future, and resolve when the barrier is released.
///
/// # Example
/// ```
/// use lifeline::barrier::*;
///
/// #[derive(Debug, Clone, Default)]
/// struct Message {}
///
///
///
/// async fn run() {
///    let (tx, rx) = barrier();
///    tx.release(Message {});
///    rx.await;
/// }
/// ```
pub fn barrier<T: Clone + Default + Sync>() -> (Barrier<T>, BarrierReceiver<T>) {
    let inner = Arc::new(BarrierInner::new());
    let barrier = Barrier::new(inner.clone());
    let receiver = BarrierReceiver::new(inner);

    (barrier, receiver)
}

/// A type which provdides a runtime synchronization barrier.
/// BarrierReceiver implements Future, and the associated receiver completes when this barrier is dropped, or when release is called.
///
/// # Example
/// ```
/// use lifeline::barrier::*;
///
/// #[derive(Debug, Clone, Default)]
/// struct Message {}
///
/// async fn run() {
///    let (tx, _rx) = barrier();
///    tx.release(Message {});
/// }
/// ```
#[derive(Debug)]
pub struct Barrier<T: Clone + Default + Sync> {
    inner: Arc<BarrierInner<T>>,
    _t: PhantomData<T>,
}

impl<T: Clone + Default + Sync> Barrier<T> {
    pub(in crate::channel::barrier) fn new(inner: Arc<BarrierInner<T>>) -> Self {
        Self {
            inner,
            _t: PhantomData,
        }
    }

    /// Releases the waker early.  
    pub fn release(self, value: T) {
        self.inner.release(Some(value))
    }
}

impl<T: Clone + Default + Sync> Drop for Barrier<T> {
    fn drop(&mut self) {
        self.inner.release(None)
    }
}

impl<T: Clone + Default + Sync + 'static> Storage for Barrier<T> {
    fn take_or_clone(res: &mut Option<Self>) -> Option<Self> {
        Self::take_slot(res)
    }
}

#[async_trait]
impl<T: Clone + Debug + Default + Send + Sync> Sender<T> for Barrier<T> {
    async fn send(&mut self, value: T) -> Result<(), crate::error::SendError<T>> {
        self.inner.release(Some(value));

        Ok(())
    }
}

/// A receiver for a Barrier channel.
///
/// The barrier channel is a variant of a oneshot channel,
/// where a Barrier sender acts as a synchronization fence.
///
/// The receiver implements Future and lifeline::Receiver, and resolves
/// when the barrier sender is released or dropped
///
/// # Example
/// ```
/// use lifeline::barrier::*;
///
/// #[derive(Debug, Clone, Default)]
/// struct Message {}
///
/// async fn run() {
///    let (_tx, rx) = barrier::<Message>();
///    drop(_tx);
///    rx.await;
/// }
/// ```
#[derive(Debug)]
pub struct BarrierReceiver<T: Clone + Default + Sync> {
    inner: Arc<BarrierInner<T>>,
    _t: PhantomData<T>,
}

impl<T: Clone + Default + Sync> BarrierReceiver<T> {
    pub(in crate::channel::barrier) fn new(inner: Arc<BarrierInner<T>>) -> Self {
        Self {
            inner,
            _t: PhantomData,
        }
    }

    /// Returns when the associated barrier has been dropped.
    ///
    /// Equivalent to `self.await` or `self.clone().await`
    pub async fn recv(&self) -> T {
        let receiver = self.clone();
        receiver.await
    }
}

impl<T: Clone + Default + Sync> Future for BarrierReceiver<T> {
    type Output = T;

    fn poll(
        self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Self::Output> {
        if self.inner.released.load(Ordering::Relaxed) {
            return Poll::Ready(self.inner.value());
        }

        self.inner.waker.register(cx.waker());

        if self.inner.released.load(Ordering::Relaxed) {
            return Poll::Ready(self.inner.value());
        }

        Poll::Pending
    }
}

impl<T: Clone + Default + Sync> Clone for BarrierReceiver<T> {
    fn clone(&self) -> Self {
        Self {
            inner: self.inner.clone(),
            _t: PhantomData,
        }
    }
}

/// Barrier doesn't actually contain a T, and Arc is send
unsafe impl<T: Clone + Default + Sync> Send for BarrierReceiver<T> {}

impl<T: Clone + Default + Sync + 'static> Storage for BarrierReceiver<T> {
    fn take_or_clone(res: &mut Option<Self>) -> Option<Self> {
        Self::clone_slot(res)
    }
}

#[async_trait]
impl<T: Clone + Default + Sync> Receiver<T> for BarrierReceiver<T> {
    async fn recv(&mut self) -> Option<T> {
        let receiver = self.clone();
        let value = receiver.await;

        Some(value)
    }
}

#[derive(Debug)]
struct BarrierWaker {
    wakers: Stack<Waker>,
}

impl BarrierWaker {
    pub fn new() -> Self {
        Self {
            wakers: Stack::new(),
        }
    }

    pub fn register(&self, waker: &Waker) {
        self.wakers.push(waker.clone());
    }

    pub fn wake(&self) {
        for waker in self.wakers.pop_iter() {
            waker.wake();
        }
    }
}

#[derive(Debug)]
struct BarrierValue<T: Default + Sync> {
    slot: ArcSwap<Option<T>>,
}

impl<T: Clone + Default + Sync> BarrierValue<T> {
    pub fn new() -> Self {
        Self {
            slot: ArcSwap::new(Arc::new(None)),
        }
    }

    pub fn store(&self, value: Option<T>) {
        if value.is_none() && self.slot.load().is_some() {
            return;
        }

        self.slot.store(Arc::new(value));
    }

    pub fn retrieve(&self) -> Option<T> {
        (**self.slot.load()).clone()
    }
}

#[derive(Debug)]
struct BarrierInner<T: Clone + Default + Sync> {
    released: AtomicBool,
    waker: BarrierWaker,
    value: BarrierValue<T>,
}

impl<T: Clone + Default + Sync> BarrierInner<T> {
    pub fn new() -> Self {
        Self {
            released: AtomicBool::new(false),
            waker: BarrierWaker::new(),
            value: BarrierValue::new(),
        }
    }

    pub fn value(&self) -> T {
        self.value.retrieve().unwrap_or_else(|| T::default())
    }

    pub fn release(&self, value: Option<T>) {
        self.value.store(value);
        self.released.store(true, Ordering::Relaxed);
        self.waker.wake();
    }
}

impl<T: Clone + Default + Send + Sync + 'static> Channel for Barrier<T> {
    type Tx = Barrier<T>;
    type Rx = BarrierReceiver<T>;

    fn channel(_capacity: usize) -> (Self::Tx, Self::Rx) {
        barrier()
    }

    fn default_capacity() -> usize {
        0
    }
}

#[cfg(test)]
mod tests {
    use super::barrier;
    use crate::{assert_completes, assert_times_out};

    #[derive(Debug, Default, Clone, PartialEq, Eq)]
    struct Message {
        data: bool,
    }

    #[tokio::test]
    async fn simple_barrier() {
        let (tx, rx) = barrier();

        let rx_timeout = rx.clone();
        assert_times_out!(async {
            rx_timeout.await;
        });

        tx.release(Message { data: true });
        println!("{:?}", &rx);

        assert_completes!(async {
            let message = rx.await;
            assert_eq!(Message { data: true }, message);
        });
    }

    #[tokio::test]
    async fn sender_receiver() -> anyhow::Result<()> {
        use crate::Sender;

        let (mut tx, mut rx) = barrier();

        let rx_timeout = rx.clone();

        assert_times_out!(async {
            rx_timeout.recv().await;
        });

        tx.send(Message { data: true }).await?;

        assert_completes!(async {
            let message = crate::Receiver::recv(&mut rx).await;
            assert_eq!(Some(Message { data: true }), message);
        });

        Ok(())
    }

    #[tokio::test]
    async fn drop_sends() {
        let (tx, rx) = barrier();

        let rx_timeout = rx.clone();

        assert_times_out!(async {
            rx_timeout.recv().await;
        });

        drop(tx);

        assert_completes!(async {
            let message = rx.recv().await;
            assert_eq!(Message { data: false }, message);
        });
    }

    #[tokio::test]
    async fn multiple_receivers() {
        let (tx, rx) = barrier();

        let rx_timeout = rx.clone();
        assert_times_out!(async {
            rx_timeout.recv().await;
        });

        drop(tx);

        let rx2 = rx.clone();

        assert_completes!(async {
            assert_eq!(Message { data: false }, rx.recv().await);
            assert_eq!(Message { data: false }, rx.await);
            assert_eq!(Message { data: false }, rx2.await);
        });
    }
}