noatun 0.1.3

Noatun is an in-process, distributed database with materialized view support.
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
use indexmap::map::Entry;
use indexmap::IndexMap;
use std::sync::atomic::AtomicBool;

mod known_good_mini_pather;

#[derive(Debug, Default)]
struct Peer {
    visited: AtomicBool,
    /// Each node that this node hears
    neighbors: Vec<u16>,
}

#[derive(Debug)]
pub struct MiniPather {
    whoami: u16,
    /// Mapping from node to each node it hears
    nodes: IndexMap<u16, Peer>,
    /// Mapping from node, to each node that hears it
    reverse: IndexMap<u16, Vec<u16>>,
    /// Map from `(origin, received_from) tuple to result of
    /// calling 'should_i_forward(origin, received_from)`
    memoization: IndexMap<(u16, u16), bool>,
}

impl MiniPather {
    /// Return our id
    pub fn my_id(&self) -> u16 {
        self.whoami
    }

    pub fn remove_neighbor(&mut self, neighbor: u16) {
        self.memoization.clear();
        if let Some(peer_obj) = self.nodes.swap_remove(&neighbor) {
            Self::del_reverse(neighbor, &mut self.reverse, &peer_obj.neighbors);
        }
    }

    pub fn new(whoami: u16) -> Self {
        Self {
            whoami,
            nodes: Default::default(),
            reverse: Default::default(),
            memoization: Default::default(),
        }
    }
    fn add_reverse(node: u16, reverse: &mut IndexMap<u16, Vec<u16>>, added: &[u16]) {
        for added in added {
            let temp = reverse.entry(*added).or_default();
            assert!(!temp.contains(&node));
            temp.push(node);
        }
    }
    fn del_reverse(node: u16, reverse: &mut IndexMap<u16, Vec<u16>>, deleted: &[u16]) {
        for deleted in deleted {
            match reverse.entry(*deleted) {
                Entry::Occupied(mut occ) => {
                    occ.get_mut().retain(|x| *x != node);
                    if occ.get().is_empty() {
                        occ.swap_remove();
                    }
                }
                Entry::Vacant(_vac) => {}
            }
        }
    }

    /// Report which neighbors 'node' can hear
    pub fn report_neighbors(&mut self, node: u16, hears_neighbors: impl Iterator<Item = u16>) {
        let mut hears_neighbors: Vec<u16> = hears_neighbors.collect();

        match self.nodes.entry(node) {
            Entry::Occupied(mut cur) => {
                for new in &hears_neighbors {
                    if !cur.get().neighbors.contains(new) {
                        Self::add_reverse(node, &mut self.reverse, &[*new]);
                        self.memoization.clear();
                        cur.get_mut().neighbors.push(*new);
                    }
                }
                cur.get_mut().neighbors.retain(|old| {
                    if !hears_neighbors.contains(old) {
                        Self::del_reverse(node, &mut self.reverse, &[*old]);
                        self.memoization.clear();
                        false
                    } else {
                        true
                    }
                });
            }
            Entry::Vacant(entry) => {
                hears_neighbors.sort_unstable();
                hears_neighbors.dedup();
                Self::add_reverse(node, &mut self.reverse, &hears_neighbors);
                self.memoization.clear();
                entry.insert(Peer {
                    visited: AtomicBool::new(false),
                    neighbors: hears_neighbors,
                });
            }
        }
    }

    /// Report which neighbors we ourselves can hear
    pub fn report_own_neighbors(&mut self, hears_neighbors: impl Iterator<Item = u16>) {
        self.report_neighbors(self.whoami, hears_neighbors);
    }

    /// Return everybody who can hear 'node'
    pub fn who_can_hear(&self, node: u16) -> impl Iterator<Item = u16> + use<'_> {
        self.reverse.get(&node).into_iter().flatten().copied()
    }

    fn ranking(&self, of: u16) -> (isize, u16) {
        let neighbors = self.nodes.get(&of).map(|x| x.neighbors.len()).unwrap_or(0);
        (-(neighbors as isize), of)
    }

    /// Returns the ordinal for ourselves, regarding retransmission requests. Some(0) means
    /// we should ask for retransmission immediately. Some(5) means there are 5 others
    /// that we believe will ask for retransmission. Some(1) means that one other is believed
    /// to do so. In general, we should wait longer the more there are before us that should
    /// retransmit. If retransmission is carried out, we should, of course, cancel our request,
    /// regardless of whether anyone else actually managed to get a request in.
    ///
    /// Returns None if we should *not* ask for retransmission
    pub fn should_i_ask_for_retransmission(&mut self, received_from: u16) -> Option<usize> {
        if received_from == self.whoami {
            return None;
        }
        let Some(neighbor) = self.nodes.get(&received_from) else {
            // We *do* ask for retransmission even for nodes we've never actually established
            // contact with, but we do it with some delay to try and avoid storms when connectivity
            // is bad.
            return Some(2 + self.whoami as usize % 10);
        };

        if neighbor.neighbors.is_empty() {
            return Some(2 + self.whoami as usize % 10);
        }
        if !neighbor.neighbors.contains(&self.whoami) {
            return None;
        }

        let my_rank = self.ranking(self.whoami);

        let count = self
            .nodes
            .iter()
            .filter(|(x, _)| {
                **x != received_from
                    && neighbor.neighbors.contains(x)
                    && self.ranking(**x) < my_rank
            })
            .count();

        Some(count)
    }

    pub fn should_i_forward(&mut self, origin: u16, received_from: u16) -> bool {
        if origin == self.whoami || received_from == self.whoami {
            return false;
        }

        if let Some(memoized) = self.memoization.get(&(origin, received_from)) {
            return *memoized;
        }

        for peer in self.nodes.values_mut() {
            if !peer.neighbors.contains(&self.whoami) {
                // Since it can't hear us, we can't help it.
                // We consider it taken care of for the purpose of deciding if to forward
                peer.visited = AtomicBool::new(true);
            } else {
                peer.visited = AtomicBool::new(false);
            }
        }

        if let Some(temp) = self.nodes.get_mut(&origin) {
            temp.visited = AtomicBool::new(true);
        }
        if let Some(temp) = self.nodes.get_mut(&received_from) {
            temp.visited = AtomicBool::new(true);
        }
        for temp in self.reverse.get(&origin).into_iter().flatten()
        /*self.who_can_hear inlined*/
        {
            if let Some(temp) = self.nodes.get_mut(temp) {
                temp.visited = AtomicBool::new(true);
            }
        }
        for temp in self.reverse.get(&received_from).into_iter().flatten()
        /*self.who_can_hear inlined*/
        {
            if let Some(temp) = self.nodes.get_mut(temp) {
                temp.visited = AtomicBool::new(true);
            }
        }

        let my_rank = self.ranking(self.whoami);
        for (other_forwarder, other_forwarder_hears) in self
            .nodes
            .iter()
            .filter(|(x, _)| **x != origin && **x != received_from && self.ranking(**x) < my_rank)
        {
            if other_forwarder_hears.neighbors.contains(&origin)
                || other_forwarder_hears.neighbors.contains(&received_from)
            {
                for temp in self.reverse.get(other_forwarder).into_iter().flatten()
                /*self.who_can_hear inlined*/
                {
                    if let Some(temp) = self.nodes.get(temp) {
                        temp.visited
                            .store(true, std::sync::atomic::Ordering::Relaxed);
                    }
                }
            }
        }

        let all_visited = self
            .nodes
            .values()
            .all(|x| x.visited.load(std::sync::atomic::Ordering::Relaxed));
        if self.memoization.len() > 1000 {
            let l = self.memoization.len() / 2;
            self.memoization.drain(0..l);
        }
        self.memoization
            .insert((origin, received_from), !all_visited);

        !all_visited
    }
}

#[cfg(test)]
mod tests {
    use indexmap::IndexSet;

    use super::{known_good_mini_pather, MiniPather};

    use proptest::prelude::*;
    use std::collections::BTreeSet;

    #[test]
    fn simple_remove_test() {
        let mut t = MiniPather::new(1);

        t.report_own_neighbors([1, 2, 3].into_iter());

        t.report_neighbors(2, [1, 3].into_iter());
        t.report_neighbors(3, [1, 2, 4].into_iter());

        assert_eq!(t.who_can_hear(3).collect::<Vec<_>>(), [1, 2]);
        assert_eq!(t.who_can_hear(1).collect::<Vec<_>>(), [1, 2, 3]);
        t.remove_neighbor(3);

        assert_eq!(t.who_can_hear(3).collect::<Vec<_>>(), [1, 2]);
        assert_eq!(t.who_can_hear(1).collect::<Vec<_>>(), [1, 2]);

        t.remove_neighbor(1);
        t.remove_neighbor(2);

        assert!(t.nodes.is_empty());
        assert!(t.reverse.is_empty());
    }

    fn verify_someone_always_forwards(node_neighbors: Vec<Vec<u16>>) {
        let islands = islands(&node_neighbors);
        let mut pathers: Vec<MiniPather> = vec![];
        let mut all_nodes = IndexSet::new();
        let node_count = node_neighbors.len();

        for node in 0..node_neighbors.len() {
            all_nodes.insert(node as u16);
            let mut pather = MiniPather::new(node as u16);
            for (i, neighbors) in node_neighbors.iter().enumerate() {
                if i != node {
                    pather.report_neighbors(i as u16, neighbors.iter().copied());
                } else {
                    pather.report_own_neighbors(neighbors.iter().copied());
                }
            }
            pathers.push(pather);
        }

        fn get_who_hears(node: u16, neighbors: &[Vec<u16>]) -> impl Iterator<Item = u16> + use<'_> {
            neighbors
                .iter()
                .enumerate()
                .filter_map(move |(x_node, x_neighbor)| {
                    if x_neighbor.contains(&{ node }) {
                        Some(x_node as u16)
                    } else {
                        None
                    }
                })
        }

        for src in 0..node_count {
            let mut front = IndexSet::new();
            let mut covered = IndexSet::new();
            let mut nodes_that_have_received_msg = IndexSet::new();
            front.extend(get_who_hears(src as u16, &node_neighbors).map(|x| (x, src as u16)));
            while let Some((dest, received_from)) = front.pop() {
                nodes_that_have_received_msg.insert(dest);
                if !covered.insert((dest, received_from)) {
                    continue;
                }

                {
                    let node = &mut pathers[dest as usize];
                    if node.should_i_forward(src as u16, received_from) {
                        assert!(node.should_i_forward(src as u16, received_from));
                        for hearing_node in get_who_hears(dest, &node_neighbors) {
                            front.insert((hearing_node, dest));
                        }
                    } else {
                        assert!(!node.should_i_forward(src as u16, received_from));
                    }
                }
            }

            for node_index in 0..pathers.len() {
                if node_index == src {
                    // We don't want re-delivery to the src
                    continue;
                }
                if islands[node_index] != islands[src] {
                    // Not expected to be forwarded correctly, no connection exists
                    continue;
                }
                let ok = nodes_that_have_received_msg.contains(&(node_index as u16));
                if !ok {
                    println!("Input: {node_neighbors:#?}");
                    println!("Src: {src}, reached {nodes_that_have_received_msg:?}, ok = {ok}, islands: {islands:?} (msg didn't reach {node_index})");
                    std::process::abort();
                }
                assert!(ok);
            }
        }

        for src in 0..node_count {
            let mut some_ask = false;
            let mut some_ask0 = false;
            let mut have_same_island = 0;
            for dst in 0..node_count {
                if src == dst {
                    continue;
                }
                let ask = pathers[dst].should_i_ask_for_retransmission(src as u16);
                println!(
                    "{} -> {} Ask: {:?} (islands: {} {})",
                    src, dst, ask, islands[src], islands[dst]
                );
                if islands[src] == islands[dst] {
                    have_same_island += 1;
                }

                if ask.is_some() {
                    some_ask = true;
                }
                if ask == Some(0) {
                    println!("Set asome_ask0 = true");
                    some_ask0 = true;
                }
            }
            if have_same_island >= 2 {
                assert!(some_ask);
                assert!(some_ask0);
            }
        }
    }
    fn neighborhood() -> impl Strategy<Value = Vec<Vec<u16>>> {
        let n = 4_usize;
        proptest::collection::vec(
            proptest::collection::vec(any::<u16>().prop_map(move |x| x % (n as u16)), n..n + 1),
            n..n + 1,
        )
    }

    proptest! {
        #![proptest_config(ProptestConfig::with_cases(2_000))]
        #[test]
        fn verify_someone_always_forwards_test(neighbor_reports in neighborhood()) {
            verify_someone_always_forwards(neighbor_reports);
        }

    }

    proptest! {
        #![proptest_config(ProptestConfig::with_cases(1_000))]
        #[test]
        fn minipather_equals_to_ref(node_neighbors in neighborhood()) {
            let node_count = node_neighbors.len();
            for (node, _neighbors) in node_neighbors.iter().enumerate(){
                let mut pather = MiniPather::new(node as u16);
                let mut ref_pather = known_good_mini_pather::MiniPather::new(node as u16);
                for (i, neighbors) in node_neighbors.iter().enumerate() {
                    if i != node {
                        pather.report_neighbors(i as u16, neighbors.iter().copied());
                        ref_pather.report_neighbors(i as u16, neighbors.iter().copied());
                    }
                }
                for i in 0..node_count {
                    for j in 0..node_count {
                        assert_eq!(pather.should_i_forward(i as u16, j as u16),
                            ref_pather.should_i_forward(i as u16, j as u16));

                        assert_eq!(pather.should_i_forward(i as u16, j as u16),
                            ref_pather.should_i_forward(i as u16, j as u16));
                    }
                }
            }
        }

    }

    #[test]
    fn regression_verify_someone_always_forwards1() {
        let input = vec![vec![0, 2, 0], vec![0, 1, 2], vec![0, 0, 1]];
        verify_someone_always_forwards(input);
    }
    #[test]
    fn regression_verify_someone_always_forwards2() {
        let input = vec![
            vec![0, 0, 0, 1],
            vec![0, 0, 0, 0],
            vec![0, 0, 3, 0],
            vec![2, 2, 2, 0],
        ];

        verify_someone_always_forwards(input);
    }

    fn islands(node_neighbors: &[Vec<u16>]) -> Vec<u8> {
        let mut explored = IndexSet::new();
        fn explore(
            explored: &mut IndexSet<u16>,
            seed: u16,
            neighbors: &[Vec<u16>],
        ) -> BTreeSet<u16> {
            let mut front = IndexSet::new();
            let mut island = BTreeSet::new();
            front.insert(seed);
            while let Some(seed) = front.pop() {
                island.insert(seed);
                if explored.insert(seed) {
                    for neighbor in neighbors[seed as usize].iter() {
                        if neighbors[*neighbor as usize].contains(&seed) {
                            front.insert(*neighbor);
                        }
                    }
                }
            }
            island
        }
        let mut islands = BTreeSet::new();
        for seed in 0..node_neighbors.len() {
            let seed = seed as u16;
            if !explored.contains(&seed) {
                islands.insert(explore(&mut explored, seed, node_neighbors));
            }
        }

        let mut ret = vec![0; node_neighbors.len()];
        for (i, island_contents) in islands.iter().enumerate() {
            for island_inhabitant in island_contents {
                ret[*island_inhabitant as usize] = i.try_into().unwrap();
            }
        }
        ret
    }

    #[test]
    fn verify_islands() {
        assert_eq!(islands(&[vec![0, 1], vec![0, 1],]), vec![0, 0]);

        assert_eq!(islands(&[vec![0], vec![1],]), vec![0, 1]);

        assert_eq!(islands(&[vec![0, 1], vec![1],]), vec![0, 1]);

        assert_eq!(
            islands(&[vec![0, 1], vec![1, 2], vec![1, 2],]),
            vec![0, 1, 1]
        );

        assert_eq!(islands(&[vec![], vec![2], vec![1],]), vec![0, 1, 1]);
        assert_eq!(
            islands(&[vec![1], vec![0, 2], vec![1, 3], vec![2, 4], vec![3],]),
            vec![0, 0, 0, 0, 0]
        );
        assert_eq!(
            islands(&[vec![1], vec![0, 2], vec![1, 3], vec![2], vec![4],]),
            vec![0, 0, 0, 0, 1]
        );
        assert_eq!(
            islands(&[vec![], vec![], vec![], vec![], vec![],]),
            vec![0, 1, 2, 3, 4]
        );
    }
}