wakerpool 0.1.0

lightweight object pool for lists of Wakers
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

use core::sync::atomic::AtomicU64;
use core::sync::atomic::Ordering;
use core::task::Waker;
use rand::Rng;
use std::sync::Arc;
use std::thread;
use wakerpool::WakerList;

struct Task {
    wake_count: AtomicU64,
}

impl Task {
    fn new() -> Arc<Self> {
        Arc::new(Self {
            wake_count: AtomicU64::new(0),
        })
    }

    fn waker(self: &Arc<Self>) -> Waker {
        self.clone().into()
    }

    fn wake_count(&self) -> u64 {
        self.wake_count.load(Ordering::Acquire)
    }
}

impl std::task::Wake for Task {
    fn wake(self: Arc<Self>) {
        self.wake_count.fetch_add(1, Ordering::AcqRel);
    }
}

#[test]
fn marker_traits() {
    use static_assertions::assert_impl_all;
    use static_assertions::assert_not_impl_any;
    assert_impl_all!(WakerList: Send, Unpin);
    assert_not_impl_any!(WakerList: Sync);
}

#[test]
fn default_list_is_empty() {
    let wl: WakerList = Default::default();
    assert!(wl.is_empty());
}

#[test]
fn wake_one() {
    let task = Task::new();

    let mut wl = WakerList::new();
    wl.push(task.waker());
    wl.pop().unwrap().wake();

    assert_eq!(1, task.wake_count());
}

#[test]
fn into_iter() {
    let task = Task::new();

    let mut wl = WakerList::new();
    wl.push(task.waker());
    wl.push(task.waker());
    wl.push(task.waker());

    for waker in wl {
        waker.wake();
    }
    assert_eq!(3, task.wake_count());
}

#[test]
fn drop_list_with_waker() {
    let task = Task::new();

    let mut wl = WakerList::new();
    wl.push(task.waker());

    // TODO: assert pool size
}

#[test]
fn drop_list_on_another_thread() {
    let task = Task::new();

    let mut wl = WakerList::new();
    wl.push(task.waker());
    thread::spawn(move || {
        drop(wl);
    })
    .join()
    .unwrap();

    let mut wl = WakerList::new();
    wl.push(task.waker());
}

#[test]
fn stress() {
    const I: usize = if cfg!(miri) { 100 } else { 100000 };
    const J: usize = if cfg!(miri) { 10 } else { 100 };
    let thread_count = thread::available_parallelism().unwrap().get();

    let task = Task::new();

    let mut jh = Vec::with_capacity(thread_count);
    for _ in 0..thread_count {
        let task = task.clone();
        jh.push(thread::spawn(move || {
            let mut rng = rand::thread_rng();
            for _ in 0..I {
                let mut wl = WakerList::new();
                for _ in 0..rng.gen_range(0..J) {
                    wl.push(task.waker());
                }
            }
        }));
    }
    drop(task);
    for h in jh {
        h.join().unwrap();
    }
}