scc 2.4.0

High-performance containers and utilities for concurrent and asynchronous programming
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

#[cfg(feature = "loom")]
#[cfg(test)]
mod test_model {
    use crate::TreeIndex;
    use loom::model::Builder;
    use loom::thread::{spawn, yield_now};
    use sdd::Guard;
    use std::borrow::Borrow;
    use std::sync::atomic::AtomicUsize;
    use std::sync::atomic::Ordering::Relaxed;
    use std::sync::{Arc, Mutex};

    #[derive(Debug)]
    struct A(usize, Arc<AtomicUsize>);
    impl A {
        fn new(d: usize, c: Arc<AtomicUsize>) -> Self {
            c.fetch_add(1, Relaxed);
            Self(d, c)
        }
    }
    impl Clone for A {
        fn clone(&self) -> Self {
            self.1.fetch_add(1, Relaxed);
            Self(self.0, self.1.clone())
        }
    }
    impl Drop for A {
        fn drop(&mut self) {
            self.1.fetch_sub(1, Relaxed);
        }
    }

    static SERIALIZER: Mutex<()> = Mutex::new(());

    // Checks if keys are visible while the leaf node is being split.
    #[test]
    fn tree_index_split_leaf_node() {
        let _guard = SERIALIZER.lock().unwrap();

        let keys = 14;
        let key_to_remove = 0;
        let mut model_builder_leaf_node = Builder::new();
        model_builder_leaf_node.max_branches = 1_048_576;
        model_builder_leaf_node.check(move || {
            let cnt = Arc::new(AtomicUsize::new(0));
            let tree_index = Arc::new(TreeIndex::<usize, A>::default());

            for k in 0..keys {
                assert!(tree_index.insert(k, A::new(k, cnt.clone())).is_ok());
            }

            let cnt_clone = cnt.clone();
            let tree_index_clone = tree_index.clone();
            let thread_insert = spawn(move || {
                assert!(tree_index_clone
                    .insert(keys, A::new(keys, cnt_clone))
                    .is_ok());
            });

            let thread_remove = spawn(move || {
                let key: usize = key_to_remove;
                assert_eq!(
                    tree_index
                        .peek_with(key.borrow(), |_key, value| value.0)
                        .unwrap(),
                    key
                );
                assert!(tree_index.remove(key.borrow()));
                assert!(tree_index
                    .peek_with(key.borrow(), |_key, value| value.0)
                    .is_none());
            });

            assert!(thread_insert.join().is_ok());
            assert!(thread_remove.join().is_ok());

            while cnt.load(Relaxed) != 0 {
                Guard::new().accelerate();
                yield_now();
            }
        });
    }

    // Checks if keys are visible while the internal node is being split.
    #[test]
    fn tree_index_split_internal_node() {
        let _guard = SERIALIZER.lock().unwrap();

        let keys = 365;
        let key_to_remove = 0;
        let mut model_builder_new_internal_node = Builder::new();
        model_builder_new_internal_node.max_branches = 1_048_576 * 16;
        model_builder_new_internal_node.check(move || {
            let cnt = Arc::new(AtomicUsize::new(0));
            let tree_index = Arc::new(TreeIndex::<usize, A>::default());

            for k in 0..keys {
                assert!(tree_index.insert(k, A::new(k, cnt.clone())).is_ok());
            }

            let cnt_clone = cnt.clone();
            let tree_index_clone = tree_index.clone();
            let thread_insert = spawn(move || {
                assert!(tree_index_clone
                    .insert(keys, A::new(keys, cnt_clone))
                    .is_ok());
            });

            let thread_remove = spawn(move || {
                let key: usize = key_to_remove;
                assert_eq!(
                    tree_index
                        .peek_with(key.borrow(), |_key, value| value.0)
                        .unwrap(),
                    key
                );
                assert!(tree_index.remove(key.borrow()));
            });

            assert!(thread_insert.join().is_ok());
            assert!(thread_remove.join().is_ok());

            while cnt.load(Relaxed) != 0 {
                Guard::new().accelerate();
                yield_now();
            }
        });
    }

    // Checks if keys are visible while a leaf node is being removed.
    #[test]
    fn tree_index_remove_leaf_node() {
        let _guard = SERIALIZER.lock().unwrap();

        let keys = 15;
        let key_to_remove = 14;
        let mut model_builder_remove_leaf = Builder::new();
        model_builder_remove_leaf.max_branches = 1_048_576 * 16;
        model_builder_remove_leaf.check(move || {
            let cnt = Arc::new(AtomicUsize::new(0));
            let tree_index = Arc::new(TreeIndex::<usize, A>::default());

            for k in 0..keys {
                assert!(tree_index.insert(k, A::new(k, cnt.clone())).is_ok());
            }

            for k in 0..keys - 3 {
                assert!(tree_index.remove(k.borrow()));
            }

            let tree_index_clone = tree_index.clone();
            let thread_remove = spawn(move || {
                let key_to_remove = keys - 2;
                assert!(tree_index_clone.remove(key_to_remove.borrow()));
            });

            let thread_read = spawn(move || {
                let key = key_to_remove;
                assert_eq!(
                    tree_index.peek_with(&key, |_key, value| value.0).unwrap(),
                    key
                );
            });

            assert!(thread_remove.join().is_ok());
            assert!(thread_read.join().is_ok());

            while cnt.load(Relaxed) != 0 {
                Guard::new().accelerate();
                yield_now();
            }
        });
    }

    // Check if keys are visible while a node is being deallocated.
    #[test]
    fn tree_index_remove_internal_node() {
        let _guard = SERIALIZER.lock().unwrap();

        let keys = 366;
        let key_to_remove = 338;
        let mut model_builder_remove_node = Builder::new();
        model_builder_remove_node.max_branches = 1_048_576 * 16;
        model_builder_remove_node.check(move || {
            let cnt = Arc::new(AtomicUsize::new(0));
            let tree_index = Arc::new(TreeIndex::<usize, A>::default());

            for k in 0..keys {
                assert!(tree_index.insert(k, A::new(k, cnt.clone())).is_ok());
            }

            for k in key_to_remove + 1..keys {
                assert!(tree_index.remove(&k));
            }

            let tree_index_clone = tree_index.clone();
            let thread_read = spawn(move || {
                assert_eq!(
                    tree_index_clone
                        .peek_with(&0, |_key, value| value.0)
                        .unwrap(),
                    0
                );
            });

            let thread_remove = spawn(move || {
                assert!(tree_index.remove(key_to_remove.borrow()));
            });

            assert!(thread_read.join().is_ok());
            assert!(thread_remove.join().is_ok());

            while cnt.load(Relaxed) != 0 {
                Guard::new().accelerate();
                yield_now();
            }
        });
    }
}