aboutsummaryrefslogtreecommitdiffstats
path: root/src/wireguard/router/runq.rs
blob: 44e11a15e6fcb152065c2d3b0df78a236ec5fb41 (plain) (blame)
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
use std::hash::Hash;
use std::mem;
use std::sync::{Condvar, Mutex};

use std::collections::hash_map::Entry;
use std::collections::HashMap;
use std::collections::VecDeque;

pub trait ToKey {
    type Key: Hash + Eq;
    fn to_key(&self) -> Self::Key;
}

pub struct RunQueue<T: ToKey> {
    cvar: Condvar,
    inner: Mutex<Inner<T>>,
}

struct Inner<T: ToKey> {
    stop: bool,
    queue: VecDeque<T>,
    members: HashMap<T::Key, usize>,
}

impl<T: ToKey> RunQueue<T> {
    pub fn close(&self) {
        let mut inner = self.inner.lock().unwrap();
        inner.stop = true;
        self.cvar.notify_all();
    }

    pub fn new() -> RunQueue<T> {
        RunQueue {
            cvar: Condvar::new(),
            inner: Mutex::new(Inner {
                stop: false,
                queue: VecDeque::new(),
                members: HashMap::new(),
            }),
        }
    }

    pub fn insert(&self, v: T) {
        let key = v.to_key();
        let mut inner = self.inner.lock().unwrap();
        match inner.members.entry(key) {
            Entry::Occupied(mut elem) => {
                *elem.get_mut() += 1;
            }
            Entry::Vacant(spot) => {
                // add entry to back of queue
                spot.insert(0);
                inner.queue.push_back(v);

                // wake a thread
                self.cvar.notify_one();
            }
        }
    }

    /// Run (consume from) the run queue using the provided function.
    /// The function should return wheter the given element should be rescheduled.
    ///
    /// # Arguments
    ///
    /// - `f` : function to apply to every element
    ///
    /// # Note
    ///
    /// The function f may be called again even when the element was not inserted back in to the
    /// queue since the last applciation and no rescheduling was requested.
    ///
    /// This happens then the function handles all work for T,
    /// but T is added to the run queue while the function is running.
    pub fn run<F: Fn(&T) -> bool>(&self, f: F) {
        let mut inner = self.inner.lock().unwrap();
        loop {
            // fetch next element
            let elem = loop {
                // run-queue closed
                if inner.stop {
                    return;
                }

                // try to pop from queue
                match inner.queue.pop_front() {
                    Some(elem) => {
                        break elem;
                    }
                    None => (),
                };

                // wait for an element to be inserted
                inner = self.cvar.wait(inner).unwrap();
            };

            // fetch current request number
            let key = elem.to_key();
            let old_n = *inner.members.get(&key).unwrap();
            mem::drop(inner); // drop guard

            // handle element
            let rerun = f(&elem);

            // if the function requested a re-run add the element to the back of the queue
            inner = self.inner.lock().unwrap();
            if rerun {
                inner.queue.push_back(elem);
                continue;
            }

            // otherwise check if new requests have come in since we ran the function
            match inner.members.entry(key) {
                Entry::Occupied(occ) => {
                    if *occ.get() == old_n {
                        // no new requests since last, remove entry.
                        occ.remove();
                    } else {
                        // new requests, reschedule.
                        inner.queue.push_back(elem);
                    }
                }
                Entry::Vacant(_) => {
                    unreachable!();
                }
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::thread;
    use std::time::Duration;

    /*
    #[test]
    fn test_wait() {
        let queue: Arc<RunQueue<usize>> = Arc::new(RunQueue::new());

        {
            let queue = queue.clone();
            thread::spawn(move || {
                queue.run(|e| {
                    println!("t0 {}", e);
                    thread::sleep(Duration::from_millis(100));
                })
            });
        }

        {
            let queue = queue.clone();
            thread::spawn(move || {
                queue.run(|e| {
                    println!("t1 {}", e);
                    thread::sleep(Duration::from_millis(100));
                })
            });
        }

    }
    */
}