waitfree-sync 0.3.3

A collection of wait-free data structures
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

use common::{ReadPrimitive, WritePrimitive};
#[cfg(loom)]
use loom::thread;
use std::fmt::Debug;
#[cfg(not(loom))]
use std::thread;
use waitfree_sync::spsc;
use waitfree_sync::triple_buffer;

mod common;

#[cfg(loom)]
const COUNT: usize = 4;
#[cfg(all(not(loom), not(miri)))]
const COUNT: usize = 16_384;
#[cfg(miri)]
const COUNT: usize = 1024;

type Payload = [i32; 50];
fn test_multithread<E: PartialEq + Debug>(
    reader_writer: (
        impl WritePrimitive<Payload, E> + Send + Sync + 'static,
        impl ReadPrimitive<Payload> + Send + Sync + 'static,
    ),
) {
    let (mut writer, mut reader) = reader_writer;
    assert_eq!(writer.write([1; 50]), Ok(()));
    assert_eq!(reader.read(), Some([1; 50]));

    let writer_thread = thread::spawn(move || {
        thread::park();
        for i in 0..COUNT {
            assert_eq!(writer.write([i as i32; 50]), Ok(()));
        }
    });
    let reader_thread = thread::spawn(move || {
        thread::park();
        for _ in 0..COUNT {
            if let Some(val) = reader.read() {
                let first_entry = val[0];
                for entry in val {
                    assert_eq!(entry, first_entry);
                }
            }
        }
    });
    writer_thread.thread().unpark();
    reader_thread.thread().unpark();
    assert!(writer_thread.join().is_ok());
    assert!(reader_thread.join().is_ok());
}

#[derive(Debug, PartialEq, Clone)]
pub struct SomeStruct {
    pub counter: i32,
    pub inner_field: Vec<Option<SomeEnum>>,
}
impl Default for SomeStruct {
    fn default() -> Self {
        Self {
            counter: 0,
            inner_field: vec![Some(SomeEnum::State1)],
        }
    }
}

#[derive(Debug, PartialEq, Clone)]
pub enum SomeEnum {
    State1,
    State2,
    State3,
    State4,
    State5,
}

fn test_heapdata<E: PartialEq + Debug>(
    reader_writer: (
        impl WritePrimitive<SomeStruct, E> + Send + Sync + 'static,
        impl ReadPrimitive<SomeStruct> + Send + Sync + 'static,
    ),
) {
    let (mut writer, mut reader) = reader_writer;
    assert_eq!(writer.write(SomeStruct::default()), Ok(()));
    assert_eq!(reader.read(), Some(SomeStruct::default()));
}

fn test_heapdata_multithread<E: PartialEq + Debug>(
    reader_writer: (
        impl WritePrimitive<SomeStruct, E> + Send + Sync + 'static,
        impl ReadPrimitive<SomeStruct> + Send + Sync + 'static,
    ),
) {
    let (mut writer, mut reader) = reader_writer;
    assert_eq!(writer.write(SomeStruct::default()), Ok(()));
    assert_eq!(reader.read(), Some(SomeStruct::default()));
    let writer_thread = thread::spawn(move || {
        thread::park();
        for i in 0..COUNT {
            assert_eq!(
                writer.write(SomeStruct {
                    counter: i as i32,
                    inner_field: vec![Some(SomeEnum::State1)]
                }),
                Ok(())
            );
        }
    });
    let reader_thread = thread::spawn(move || {
        thread::park();
        for _ in 0..COUNT {
            if let Some(val) = reader.read() {
                assert_eq!(val.inner_field, vec![Some(SomeEnum::State1)]);
            }
        }
    });
    writer_thread.thread().unpark();
    reader_thread.thread().unpark();
    assert!(writer_thread.join().is_ok());
    assert!(reader_thread.join().is_ok());
}

#[cfg(not(loom))]
#[test]
fn test_tripple_buffer() {
    test_multithread(triple_buffer::triple_buffer());
    test_heapdata(triple_buffer::triple_buffer());
    test_heapdata_multithread(triple_buffer::triple_buffer());
}

#[cfg(not(loom))]
#[test]
fn test_spsc() {
    test_multithread(spsc::spsc(COUNT));
    test_heapdata(spsc::spsc(COUNT));
    test_heapdata_multithread(spsc::spsc(COUNT));
}

#[test]
#[cfg(loom)]
fn loom_tripple_buffer() {
    loom::model(|| {
        test_multithread(triple_buffer::triple_buffer());
    });

    loom::model(|| {
        test_heapdata(triple_buffer::triple_buffer());
    });

    loom::model(|| {
        test_heapdata_multithread(triple_buffer::triple_buffer());
    });
}

#[test]
#[cfg(loom)]
fn loom_spsc() {
    loom::model(|| {
        test_multithread(spsc::spsc(COUNT));
    });
    loom::model(|| {
        test_heapdata(spsc::spsc(COUNT));
    });
    loom::model(|| {
        test_heapdata_multithread(spsc::spsc(COUNT));
    });
}