intrusive-listeners 0.6.0

A compact reentrant type-erased event-listener registry
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
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
use crate::{ALIVE, EventFamily, LIFO, Listener, Ordering, RECURSIVE_CANCEL, RECURSIVE_VISIT};
use alloc::boxed::Box;
use core::cell::Cell;
use core::future::Future;
use core::marker::{PhantomData, PhantomPinned};
use core::mem::{self, ManuallyDrop};
use core::pin::{Pin, UnsafePinned};
use core::ptr::{self, DynMetadata, NonNull, null};
use core::task::{Context, LocalWaker, Poll};

pub trait Policy {
    type Ordering: Ordering;

    /// Called when the last listener is cancelled (i.e. registry just became empty).
    /// Dropping the registry in this function is allowed, but doing so will invalidate `this`;
    /// hence it is a `NonNull` instead of a `&self`.
    fn last_listener_cancelled(this: NonNull<Self>);
}

impl Policy for () {
    type Ordering = LIFO;
    fn last_listener_cancelled(_: NonNull<Self>) {}
}

#[repr(C, align(2))]
pub struct Registry<T: EventFamily, P: Policy = ()> {
    head: Cell<*const ()>,
    tail: Cell<<P::Ordering as Ordering>::Tail>,
    pub policy: P,
    _p: PhantomData<for<'a> fn(T::Event<'a>)>,
    _pin: PhantomPinned,
}

#[must_use]
pub struct Guard<T: EventFamily, P: Policy = ()> {
    node: NonNull<()>,
    _p: PhantomData<*const Registry<T, P>>,
}

#[repr(C, align(2))]
struct Node<T: EventFamily, L: Listener<T> + ?Sized> {
    meta: DynMetadata<dyn Listener<T>>,
    /// At head, points back to the registry with LSB=1.
    prev: Cell<*const ()>,
    /// At tail, points back to the registry with LSB=1.
    next: Cell<*const ()>,
    state: Cell<usize>,
    listener: ManuallyDrop<L>,
}

unsafe fn resolve<T: EventFamily>(thin: *const ()) -> *const Node<T, dyn Listener<T>> {
    let meta = unsafe { *thin.cast::<DynMetadata<dyn Listener<T>>>() };
    ptr::from_raw_parts::<Node<T, dyn Listener<T>>>(thin, meta)
}

impl<T: EventFamily> Node<T, dyn Listener<T>> {
    /// Return the registry iff it just became empty.
    unsafe fn unlink<O: Ordering>(&self) -> *const () {
        let (prev, next) = (self.prev.get(), self.next.get());
        let is_tail = next.addr() & 1 == 1;
        let mut registry = null();
        if prev.addr() & 1 == 1 {
            registry = prev.map_addr(|x| x & !1);
            unsafe { (*registry.cast::<Cell<*const ()>>()).set(if is_tail { null() } else { next }) };
        } else {
            unsafe { (*resolve::<T>(prev)).next.set(next) };
        }
        if !is_tail {
            unsafe { (*resolve::<T>(next)).prev.set(prev) };
            registry = null();
        } else if O::FIFO {
            let tail = unsafe { &*next.map_addr(|x| x & !1).cast::<Cell<*const ()>>().add(1) };
            tail.set(if registry.is_null() { prev } else { null() });
        }
        registry
    }
}

impl<T: EventFamily, P: Policy> Drop for Registry<T, P> {
    fn drop(&mut self) {
        self.walk(|thin| {
            let node = unsafe { &mut *resolve::<T>(thin).cast_mut() };
            *node.state.get_mut() = RECURSIVE_VISIT;
            *node.next.get_mut()
        });
        self.walk(|thin| {
            let ptr = unsafe { resolve::<T>(thin) }.cast_mut();
            let next = unsafe { *(*ptr).next.get_mut() };
            unsafe { ManuallyDrop::drop(&mut (*ptr).listener) };
            let state = unsafe { (*ptr).state.get_mut() };
            if *state & RECURSIVE_CANCEL != 0 {
                drop(unsafe { Box::from_raw(ptr) });
            } else {
                *state = 0;
            }
            next
        });
    }
}

impl<T: EventFamily, P: Policy> Guard<T, P> {
    /// Obtain the pointer to the listener. It may be already destructed if
    /// [`is_alive`](Self::is_alive) returns false, but the allocation stays valid.
    pub fn as_ptr(&self) -> NonNull<dyn Listener<T>> {
        let node = unsafe { resolve::<T>(self.node.as_ptr()) };
        unsafe { NonNull::new_unchecked(&raw const (*node).listener as *mut dyn Listener<T>) }
    }

    /// Whether the listener hasn't been (or about to be) destructed yet.
    pub fn is_alive(&self) -> bool { unsafe { (*resolve::<T>(self.node.as_ptr())).state.get() & ALIVE != 0 } }
}

impl<T: EventFamily, P: Policy> Drop for Guard<T, P> {
    /// May overlap listener destructor.
    fn drop(&mut self) {
        let ptr = unsafe { resolve::<T>(self.node.as_ptr()) };
        let state = unsafe { (*ptr).state.get() };
        if state & !(RECURSIVE_VISIT - 1) != 0 {
            unsafe { (*ptr).state.set(state | RECURSIVE_CANCEL) };
        } else if state & ALIVE != 0 {
            let node = unsafe { &mut *ptr.cast_mut() };
            let registry = unsafe { node.unlink::<P::Ordering>() };
            if !registry.is_null() {
                P::last_listener_cancelled(NonNull::from_ref(unsafe { &(*registry.cast::<Registry<T, P>>()).policy }));
            }
            unsafe { ManuallyDrop::drop(&mut node.listener) };
            drop(unsafe { Box::from_raw(ptr.cast_mut()) });
        } else {
            drop(unsafe { Box::from_raw(ptr.cast_mut()) });
        }
    }
}

impl<T: EventFamily, P: Policy + Default> Default for Registry<T, P> {
    fn default() -> Self { Self::new(P::default()) }
}

impl<T: EventFamily, P: Policy> Registry<T, P> {
    pub fn new(policy: P) -> Self { Self { head: <_>::default(), tail: <_>::default(), policy, _p: PhantomData, _pin: PhantomPinned } }

    pub fn is_empty(&self) -> bool { self.head.get().is_null() }

    pub fn register(self: Pin<&Self>, listener: impl Listener<T> + 'static) -> Guard<T, P> {
        let old = if <P::Ordering as Ordering>::FIFO { <P::Ordering as Ordering>::from_tail(self.tail.get()) } else { self.head.get() };
        let sentinel = (&raw const *self).map_addr(|x| x | 1).cast::<()>();
        let old_as_link = if old.is_null() { sentinel } else { old };
        let (prev, next) = if <P::Ordering as Ordering>::FIFO { (old_as_link, sentinel) } else { (sentinel, old_as_link) };
        let node = Box::new(Node {
            meta: ptr::metadata(&listener as &dyn Listener<T>),
            prev: prev.into(),
            next: next.into(),
            state: Cell::new(ALIVE),
            listener: ManuallyDrop::new(listener),
        }) as Box<Node<T, dyn Listener<T>>>;
        let thin = Box::into_raw(node).cast_const().to_raw_parts().0;
        if <P::Ordering as Ordering>::FIFO {
            if old.is_null() { &self.head } else { &unsafe { &*resolve::<T>(old) }.next }.set(thin);
            self.tail.set(<P::Ordering as Ordering>::into_tail(thin));
        } else {
            self.head.set(thin);
            if !old.is_null() {
                unsafe { &*resolve::<T>(old) }.prev.set(thin);
            }
        }
        Guard { node: unsafe { NonNull::new_unchecked(thin.cast_mut()) }, _p: PhantomData }
    }

    fn walk(&self, mut f: impl FnMut(*const ()) -> *const ()) {
        let mut thin = self.head.get();
        if !thin.is_null() {
            loop {
                thin = f(thin);
                if thin.addr() & 1 == 1 {
                    break;
                }
            }
        }
    }

    pub fn broadcast(&self, event: T::Event<'_>) {
        let mut deferred_cancels = null::<()>();
        self.walk(|thin| {
            let node = unsafe { &*resolve::<T>(thin) };
            let mut state = node.state.get();
            if state & RECURSIVE_CANCEL != 0 {
                // Node already cancelled by an outer `accept` call. Outermost `broadcast` will unlink it.
                return node.next.get();
            }
            node.state.set(state + RECURSIVE_VISIT);
            node.listener.accept(event.clone());
            let next = node.next.get();
            state = node.state.get() - RECURSIVE_VISIT;
            if state & !(RECURSIVE_CANCEL - 1) == RECURSIVE_CANCEL {
                unsafe { node.unlink::<P::Ordering>() };
                node.next.set(deferred_cancels);
                deferred_cancels = thin;
            } else {
                node.state.set(state);
            }
            next
        });
        if !deferred_cancels.is_null() && self.is_empty() {
            P::last_listener_cancelled(NonNull::from_ref(&self.policy));
        }
        while !deferred_cancels.is_null() {
            let ptr = unsafe { resolve::<T>(deferred_cancels) }.cast_mut();
            let node = unsafe { &mut *ptr };
            deferred_cancels = *node.next.get_mut();
            unsafe { ManuallyDrop::drop(&mut node.listener) };
            drop(unsafe { Box::from_raw(ptr) });
        }
    }
}

impl<E: 'static, T: for<'a> EventFamily<Event<'a> = E> + 'static, P: Policy> Registry<T, P> {
    /// Return a future that holds a listener to wait for the immediate next event.
    /// The future will resolve to the event, or `None` if the registry is dropped.
    pub fn next(self: Pin<&Self>) -> Next<E, T, P> {
        Next { guard: self.register(NextListener(ManuallyDrop::new(UnsafePinned::new(NextState::Init)))), _p: PhantomData }
    }
}

/// See [`Registry::next`].
pub struct Next<E, T: EventFamily, P: Policy> {
    guard: Guard<T, P>,
    _p: PhantomData<E>,
}

enum NextState<E> {
    Init,
    Wait(LocalWaker),
    Ready(E),
    Dead,
}

#[repr(transparent)]
struct NextListener<E>(ManuallyDrop<UnsafePinned<NextState<E>>>);

impl<E, T: for<'a> EventFamily<Event<'a> = E> + 'static> Listener<T> for NextListener<E> {
    fn accept(&self, event: E) {
        let state = unsafe { &mut *self.0.get() };
        if matches!(*state, NextState::Init | NextState::Wait(_)) {
            if let NextState::Wait(waker) = mem::replace(state, NextState::Ready(event)) {
                waker.wake();
            }
        }
    }
}

impl<E> Drop for NextListener<E> {
    fn drop(&mut self) {
        let state = unsafe { &mut *self.0.get() };
        if matches!(*state, NextState::Init | NextState::Wait(_)) {
            if let NextState::Wait(waker) = mem::replace(state, NextState::Dead) {
                waker.wake();
            }
        }
    }
}

impl<E, T: EventFamily, P: Policy> Next<E, T, P> {
    fn state(&self) -> NonNull<NextState<E>> { self.guard.as_ptr().cast() }
}

impl<E, T: EventFamily, P: Policy> Drop for Next<E, T, P> {
    fn drop(&mut self) { let _defer = mem::replace(unsafe { self.state().as_mut() }, NextState::Dead); }
}

impl<E, T: for<'a> EventFamily<Event<'a> = E> + 'static, P: Policy> Future for Next<E, T, P> {
    type Output = Option<E>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<E>> {
        let mut state = self.state();
        let waker = matches!(unsafe { state.as_ref() }, NextState::Init | NextState::Wait(_)).then(|| cx.local_waker().clone());
        // State may have changed if the waker's `clone` impl for whatever reason touches the registry.
        let state = unsafe { state.as_mut() };
        if matches!(*state, NextState::Init | NextState::Wait(_)) {
            let _defer = mem::replace(state, NextState::Wait(unsafe { waker.unwrap_unchecked() }));
            Poll::Pending
        } else {
            Poll::Ready(if let NextState::Ready(event) = mem::replace(state, NextState::Dead) { Some(event) } else { None })
        }
    }
}

#[cfg(test)]
mod tests {
    extern crate std;

    use super::{Guard, Policy, Registry};
    use crate::{ByVal, FIFO, LIFO, Listener};
    use alloc::boxed::Box;
    use alloc::rc::{Rc, Weak};
    use alloc::vec::Vec;
    use core::array;
    use core::cell::{Cell, OnceCell, RefCell};
    use core::pin::{Pin, pin};
    use core::ptr::NonNull;
    use futures_task::{LocalFutureObj, LocalSpawn};

    struct CounterPolicy(Rc<Cell<u32>>);

    impl Policy for CounterPolicy {
        type Ordering = LIFO;
        fn last_listener_cancelled(this: NonNull<Self>) { unsafe { this.as_ref() }.0.update(|x| x + 1); }
    }

    struct FifoPolicy;

    impl Policy for FifoPolicy {
        type Ordering = FIFO;
        fn last_listener_cancelled(_: NonNull<Self>) {}
    }

    #[test]
    fn guard_drop_notifies_policy() {
        let ctr = Rc::new(Cell::new(0u32));
        let reg = pin!(Registry::<ByVal<u32>, _>::new(CounterPolicy(ctr.clone())));
        let reg = reg.as_ref();
        let a = reg.register(|_| ());
        let b = reg.register(|_| ());
        drop(a);
        assert_eq!(ctr.get(), 0);
        drop(b);
        assert_eq!(ctr.get(), 1);
        let c = reg.register(|_| ());
        drop(c);
        assert_eq!(ctr.get(), 2);
    }

    #[test]
    fn self_cancel_notifies_policy() {
        let ctr = Rc::new(Cell::new(0u32));
        let reg = pin!(Registry::<ByVal<u32>, _>::new(CounterPolicy(ctr.clone())));
        let reg = reg.as_ref();
        let guard = Rc::new(Cell::new(None));
        guard.set(Some(reg.register({
            let me = guard.clone();
            move |_: u32| me.set(None)
        })));
        reg.broadcast(0);
        assert_eq!(ctr.get(), 1);
    }

    #[test]
    fn policy_observes_empty_before_destructor_reregisters() {
        type Reg = Registry<ByVal<u32>, Observer>;
        struct Observer {
            reg: OnceCell<Weak<Reg>>,
            empty_observed: Rc<Cell<bool>>,
        }
        impl Policy for Observer {
            type Ordering = LIFO;
            fn last_listener_cancelled(this: NonNull<Self>) {
                let this = unsafe { this.as_ref() };
                let reg = this.reg.get().unwrap().upgrade().unwrap();
                this.empty_observed.set(reg.is_empty());
            }
        }
        struct Reregisterer {
            reg: Weak<Reg>,
            child: Rc<OnceCell<Guard<ByVal<u32>, Observer>>>,
        }
        impl Listener<ByVal<u32>> for Reregisterer {
            fn accept(&self, _: u32) {}
        }
        impl Drop for Reregisterer {
            fn drop(&mut self) {
                self.child.get_or_init(|| {
                    let reg = self.reg.upgrade().unwrap();
                    unsafe { Pin::new_unchecked(&*reg) }.register(|_| {})
                });
            }
        }
        let empty_observed = Rc::new(Cell::new(false));
        let reg = Rc::new(Reg::new(Observer { reg: OnceCell::new(), empty_observed: empty_observed.clone() }));
        reg.policy.reg.get_or_init(|| Rc::downgrade(&reg));
        let child = Rc::new(OnceCell::new());
        let guard = unsafe { Pin::new_unchecked(&*reg) }.register(Reregisterer { reg: Rc::downgrade(&reg), child: child.clone() });
        drop(guard);
        assert_eq!(empty_observed.get(), true);
        assert!(!reg.is_empty());
        empty_observed.set(false);
        drop(child);
        assert_eq!(empty_observed.get(), true);
        assert!(reg.is_empty());
    }

    #[derive(Default)]
    struct State {
        accept_count: Cell<u32>,
        drop_count: Cell<u32>,
        sum: Cell<u32>,
    }

    struct Capturer(Rc<State>);

    impl Listener<ByVal<u32>> for Capturer {
        fn accept(&self, event: u32) {
            self.0.accept_count.update(|x| x + 1);
            self.0.sum.update(|x| x + event);
        }
    }

    impl Drop for Capturer {
        fn drop(&mut self) { self.0.drop_count.update(|x| x + 1); }
    }

    #[test]
    fn is_empty() {
        let reg = pin!(Registry::<ByVal<u32>>::default());
        let reg = reg.as_ref();
        assert!(reg.is_empty());
        let a = reg.register(Capturer(Rc::default()));
        assert!(!reg.is_empty());
        let b = reg.register(Capturer(Rc::default()));
        drop(a);
        assert!(!reg.is_empty());
        drop(b);
        assert!(reg.is_empty());
    }

    #[test]
    fn normal_path() {
        let reg = pin!(Registry::<ByVal<u32>>::default());
        let reg = reg.as_ref();
        let states = <[Rc<State>; 3]>::default();
        let _guards = states.each_ref().map(|x| reg.register(Capturer(x.clone())));
        reg.broadcast(3);
        reg.broadcast(4);
        assert_eq!(states.each_ref().map(|x| x.accept_count.get()), [2, 2, 2]);
        assert_eq!(states.each_ref().map(|x| x.sum.get()), [7, 7, 7]);
    }

    #[test]
    fn registry_dropped_early() {
        let state = Rc::<State>::default();
        let _guards: [_; 2];
        {
            let reg = pin!(Registry::<ByVal<u32>>::default());
            let reg = reg.as_ref();
            _guards = array::from_fn(|_| reg.register(Capturer(state.clone())));
        }
        assert_eq!(state.drop_count.get(), 2);
    }

    #[test]
    fn registry_dropped_late() {
        let state = Rc::<State>::default();
        let reg = pin!(Registry::<ByVal<u32>>::default());
        let reg = reg.as_ref();
        let guards: [_; 3] = array::from_fn(|_| reg.register(Capturer(state.clone())));
        drop(guards);
        assert_eq!(state.drop_count.get(), 3);
    }

    #[test]
    fn cancel_internal() {
        let state = Rc::<State>::default();
        let reg = pin!(Registry::<ByVal<u32>>::default());
        let reg = reg.as_ref();
        let [_a, b, _c] = array::from_fn(|_| reg.register(Capturer(state.clone())));
        drop(b);
        assert_eq!(state.drop_count.get(), 1);
        reg.broadcast(5);
        assert_eq!(state.sum.get(), 10);
    }

    #[test]
    fn register_inside_callback() {
        let reg = Rc::<Registry<ByVal<u32>>>::default();
        let state = Rc::<State>::default();
        let _g = unsafe { Pin::new_unchecked(&*reg) }.register({
            let (reg, state, capturer) = (Rc::downgrade(&reg), state.clone(), OnceCell::new());
            move |_| {
                capturer.get_or_init(|| {
                    let reg = reg.upgrade().unwrap();
                    unsafe { Pin::new_unchecked(&*reg) }.register(Capturer(state.clone()))
                });
            }
        });
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 0);
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 1);
    }

    #[test]
    fn self_cancel() {
        let reg = pin!(Registry::<ByVal<u32>>::default());
        let reg = reg.as_ref();
        let state = Rc::<State>::default();
        let guard = Rc::new(Cell::new(None));
        guard.set(Some(reg.register({
            let (state, me) = (state.clone(), guard.clone());
            move |_| {
                me.set(None);
                // Access listener state after self-cancel.
                state.accept_count.update(|x| x + 1);
            }
        })));
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 1);
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 1);
    }

    #[test]
    fn cancel_in_flight() {
        let reg = pin!(Registry::<ByVal<u32>>::default());
        let reg = reg.as_ref();
        let state = Rc::<State>::default();
        let victim = Cell::new(Some(reg.register(Capturer(state.clone()))));
        let _g = reg.register(move |_| victim.set(None));
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 0);
        assert_eq!(state.drop_count.get(), 1);
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 0);
    }

    #[test]
    fn destructor_cancel_in_flight() {
        struct Saboteur {
            me: Rc<Cell<Option<Guard<ByVal<u32>>>>>,
            victim: Rc<Cell<Option<Guard<ByVal<u32>>>>>,
        }

        impl Listener<ByVal<u32>> for Saboteur {
            fn accept(&self, _: u32) { self.me.set(None); }
        }

        impl Drop for Saboteur {
            fn drop(&mut self) { self.victim.set(None); }
        }

        let reg = pin!(Registry::<ByVal<u32>>::default());
        let reg = reg.as_ref();
        let state = Rc::<State>::default();
        let a = Rc::new(Cell::new(Some(reg.register(Capturer(state.clone())))));
        let b = Rc::new(Cell::new(None));
        b.set(Some(reg.register(Saboteur { me: b.clone(), victim: a.clone() })));
        reg.broadcast(7);
        assert_eq!(state.accept_count.get(), 1);
        assert_eq!(state.sum.get(), 7);
        assert_eq!(state.drop_count.get(), 1);
    }

    #[test]
    fn cancel_other_in_registry_destructor() {
        struct Saboteur {
            victim: Rc<Cell<Option<Guard<ByVal<u32>>>>>,
        }

        impl Listener<ByVal<u32>> for Saboteur {
            fn accept(&self, _: u32) {}
        }

        impl Drop for Saboteur {
            fn drop(&mut self) { self.victim.set(None); }
        }

        let state = Rc::<State>::default();
        let a = Rc::new(Cell::new(None));
        let b = {
            let reg = pin!(Registry::<ByVal<u32>>::default());
            let reg = reg.as_ref();
            a.set(Some(reg.register(Capturer(state.clone()))));
            reg.register(Saboteur { victim: a.clone() })
        };
        assert_eq!(state.drop_count.get(), 1);
        assert!(a.take().is_none());
        drop(b);
        assert_eq!(state.drop_count.get(), 1);
    }

    #[test]
    fn cancel_self_in_registry_destructor() {
        struct SelfCanceller {
            me: Rc<Cell<Option<Guard<ByVal<u32>>>>>,
            state: Rc<State>,
        }

        impl Listener<ByVal<u32>> for SelfCanceller {
            fn accept(&self, _: u32) {}
        }

        impl Drop for SelfCanceller {
            fn drop(&mut self) {
                self.me.set(None);
                // Access listener state after self-cancel.
                self.state.drop_count.update(|x| x + 1);
            }
        }

        let state = Rc::<State>::default();
        let me = Rc::new(Cell::new(None));
        {
            let reg = pin!(Registry::<ByVal<u32>>::default());
            let reg = reg.as_ref();
            me.set(Some(reg.register(SelfCanceller { me: me.clone(), state: state.clone() })));
        }
        assert_eq!(state.drop_count.get(), 1);
        assert!(me.take().is_none());
    }

    #[test]
    fn self_cancel_then_nested_broadcast_lifo() { self_cancel_then_nested_broadcast(()); }

    #[test]
    fn self_cancel_then_nested_broadcast_fifo() { self_cancel_then_nested_broadcast(FifoPolicy); }

    fn self_cancel_then_nested_broadcast<P: Policy + 'static>(policy: P) {
        let reg = Rc::new(Registry::<ByVal<u32>, P>::new(policy));
        let state = Rc::<State>::default();
        let guard = Rc::new(Cell::new(None));
        guard.set(Some(unsafe { Pin::new_unchecked(&*reg) }.register({
            let (reg, state, me) = (Rc::downgrade(&reg), state.clone(), guard.clone());
            move |depth| {
                state.accept_count.update(|x| x + 1);
                if depth == 0 {
                    me.set(None);
                    reg.upgrade().unwrap().broadcast(1);
                }
            }
        })));
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 1);
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 1);
    }

    #[test]
    fn nested_broadcast_is_safe() {
        let reg = Rc::<Registry<ByVal<u32>>>::default();
        let state = Rc::<State>::default();
        let _g = unsafe { Pin::new_unchecked(&*reg) }.register({
            let (reg, state, depth) = (Rc::downgrade(&reg), state.clone(), Cell::new(0u32));
            move |event| {
                state.accept_count.update(|x| x + 1);
                if depth.replace(depth.get() + 1) < 2 {
                    reg.upgrade().unwrap().broadcast(event);
                }
            }
        });
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 3);
    }

    #[test]
    fn lifo_broadcast() {
        let reg = pin!(Registry::<ByVal<u32>>::default());
        let reg = reg.as_ref();
        let order = Rc::new(RefCell::new(Vec::new()));
        let _g: [_; 3] = array::from_fn(|i| {
            let order = order.clone();
            reg.register(move |_| order.borrow_mut().push(i))
        });
        reg.broadcast(0);
        assert_eq!(*order.borrow(), [2, 1, 0]);
    }

    #[test]
    fn fifo_broadcast() {
        let reg = pin!(Registry::<ByVal<u32>, _>::new(FifoPolicy));
        let reg = reg.as_ref();
        let order = Rc::new(RefCell::new(Vec::new()));
        let mut guards: [_; 5] = array::from_fn(|i| {
            let order = order.clone();
            Some(reg.register(move |_| order.borrow_mut().push(i)))
        });
        guards[2] = None;
        reg.broadcast(0);
        assert_eq!(*order.borrow(), [0, 1, 3, 4]);
        guards[4] = None;
        guards[0] = None;
        let _g = reg.register({
            let order = order.clone();
            move |_| order.borrow_mut().push(9)
        });
        order.borrow_mut().clear();
        reg.broadcast(0);
        assert_eq!(*order.borrow(), [1, 3, 9]);
    }

    #[test]
    fn fifo_reentrant_register_receives_inflight() {
        let reg = Rc::new(Registry::<ByVal<u32>, FifoPolicy>::new(FifoPolicy));
        let state = Rc::<State>::default();
        let _g = unsafe { Pin::new_unchecked(&*reg) }.register({
            let (reg, state, capturer) = (Rc::downgrade(&reg), state.clone(), OnceCell::new());
            move |_| {
                capturer.get_or_init(|| {
                    let reg = reg.upgrade().unwrap();
                    unsafe { Pin::new_unchecked(&*reg) }.register(Capturer(state.clone()))
                });
            }
        });
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 1);
        reg.broadcast(0);
        assert_eq!(state.accept_count.get(), 2);
    }

    #[test]
    fn raw_ptr_access() {
        let state = Rc::<State>::default();
        let reg = pin!(Registry::<ByVal<u32>>::default());
        let reg = reg.as_ref();
        let guard = reg.register(Capturer(state.clone()));
        assert!(guard.is_alive());
        unsafe { guard.as_ptr().as_ref() }.accept(11);
        assert_eq!(state.sum.get(), 11);
        let downcast = unsafe { guard.as_ptr().cast::<Capturer>().as_ref() };
        assert_eq!(downcast.0.accept_count.get(), 1);
        reg.broadcast(22);
        assert_eq!(state.sum.get(), 33);
        let state = Rc::<State>::default();
        let guard = {
            let reg = pin!(Registry::<ByVal<u32>>::default());
            reg.as_ref().register(Capturer(state.clone()))
        };
        assert_eq!(state.drop_count.get(), 1);
        assert!(!guard.is_alive());
    }

    #[test]
    fn is_alive_cleared_eagerly() {
        struct State {
            other: Cell<Option<Guard<ByVal<u32>>>>,
            wrong: Cell<bool>,
        }

        struct Probe(Rc<State>);

        impl Listener<ByVal<u32>> for Probe {
            fn accept(&self, _: u32) {}
        }

        impl Drop for Probe {
            fn drop(&mut self) {
                let guard = self.0.other.take().unwrap();
                self.0.wrong.set(guard.is_alive());
                self.0.other.set(Some(guard));
            }
        }

        let s0 = Rc::new(State { other: Cell::new(None), wrong: Cell::new(true) });
        let s1 = Rc::new(State { other: Cell::new(None), wrong: Cell::new(true) });
        {
            let reg = pin!(Registry::<ByVal<u32>>::default());
            let reg = reg.as_ref();
            s0.other.set(Some(reg.register(Probe(s1.clone()))));
            s1.other.set(Some(reg.register(Probe(s0.clone()))));
        }
        assert!(!s0.wrong.get() && !s1.wrong.get());
    }

    #[test]
    fn next_polled_after_broadcast() {
        futures_executor::block_on(async {
            let reg = pin!(Registry::<ByVal<u32>>::default());
            let reg = reg.as_ref();
            let next = reg.next();
            reg.broadcast(11);
            reg.broadcast(22);
            assert_eq!(next.await, Some(11));
            assert!(reg.is_empty());
        });
    }

    #[test]
    fn next_polled_after_registry_drop() {
        futures_executor::block_on(async {
            let next = {
                let reg = pin!(Registry::<ByVal<u32>>::default());
                reg.as_ref().next()
            };
            assert_eq!(next.await, None);
        });
    }

    #[test]
    fn next_retains_result_after_registry_drop() {
        futures_executor::block_on(async {
            let data = Rc::new(5);
            let next = {
                let reg = pin!(Registry::<ByVal<Rc<u32>>>::default());
                let reg = reg.as_ref();
                let next = reg.next();
                reg.broadcast(data.clone());
                next
            };
            assert_eq!(next.await.as_deref(), Some(&5));
            Rc::into_inner(data).unwrap();
        });
    }

    #[test]
    fn next_wakes_on_broadcast() {
        let mut pool = futures_executor::LocalPool::new();
        let reg = Box::pin(Registry::<ByVal<u32>>::default());
        let result = Rc::new(Cell::new(None));
        let task = {
            let (next, result) = (reg.as_ref().next(), result.clone());
            async move { result.set(Some(next.await)) }
        };
        pool.spawner().spawn_local_obj(LocalFutureObj::new(Box::pin(task))).unwrap();
        pool.run_until_stalled();
        assert_eq!(result.get(), None);
        reg.as_ref().broadcast(5);
        pool.run_until_stalled();
        assert_eq!(result.get(), Some(Some(5)));
        assert!(reg.is_empty());
    }

    #[test]
    fn next_wakes_on_registry_drop() {
        let mut pool = futures_executor::LocalPool::new();
        let reg = Box::pin(Registry::<ByVal<u32>>::default());
        let result = Rc::new(Cell::new(None));
        let task = {
            let (next, result) = (reg.as_ref().next(), result.clone());
            async move { result.set(Some(next.await)) }
        };
        pool.spawner().spawn_local_obj(LocalFutureObj::new(Box::pin(task))).unwrap();
        pool.run_until_stalled();
        assert_eq!(result.get(), None);
        drop(reg);
        pool.run_until_stalled();
        assert_eq!(result.get(), Some(None));
    }
}