echeneis 0.1.0

Testing framework for non-blocking code
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

//! crate internal sync plumbing for testing

#![allow(
    dead_code,
    unused_imports,
    unknown_lints,
    clippy::disallowed_modules,
    missing_docs
)]

#[cfg(all(not(loom), not(shuttle)))]
pub(crate) use core_::*;
#[cfg(loom)]
pub(crate) use loom_::*;
#[cfg(shuttle)]
pub(crate) use shuttle_::*;

#[cfg(shuttle)]
mod shuttle_ {
    pub(crate) use shuttle::{
        hint,
        sync::{Arc, Weak, atomic},
        thread,
        thread_local,
    };

    pub(crate) mod cell {
        #[derive(Debug)]
        pub(crate) struct UnsafeCell<T>(core::cell::UnsafeCell<T>);

        #[allow(dead_code)]
        impl<T> UnsafeCell<T> {
            pub(crate) fn new(data: T) -> UnsafeCell<T> {
                UnsafeCell(core::cell::UnsafeCell::new(data))
            }

            pub(crate) fn with<R>(&self, f: impl FnOnce(*const T) -> R) -> R {
                f(self.0.get())
            }

            pub(crate) fn with_mut<R>(&self, f: impl FnOnce(*mut T) -> R) -> R {
                f(self.0.get())
            }
        }

        impl<T: Default> Default for UnsafeCell<T> {
            fn default() -> Self {
                Self::new(T::default())
            }
        }
    }
}

#[cfg(loom)]
mod loom_ {
    pub(crate) use loom::{
        cell,
        hint,
        sync::{Arc, Weak, atomic},
        thread,
        thread_local,
    };
}

#[cfg(all(not(loom), not(shuttle)))]
mod core_ {
    pub(crate) mod cell {
        //! UnsafeCell
        #[derive(Debug)]
        /// wraps core::cell::UnsafeCell
        pub(crate) struct UnsafeCell<T>(std::cell::UnsafeCell<T>);

        #[allow(dead_code)]
        impl<T> UnsafeCell<T> {
            /// creates a new UnsafeCell
            pub(crate) fn new(data: T) -> UnsafeCell<T> {
                UnsafeCell(std::cell::UnsafeCell::new(data))
            }

            /// allows immutable acces to the stored value
            pub(crate) fn with<R>(&self, f: impl FnOnce(*const T) -> R) -> R {
                f(self.0.get())
            }

            /// allows mutable access to the stored value
            pub(crate) fn with_mut<R>(&self, f: impl FnOnce(*mut T) -> R) -> R {
                f(self.0.get())
            }
        }

        impl<T: Default> Default for UnsafeCell<T> {
            fn default() -> Self {
                Self::new(T::default())
            }
        }
    }

    #[cfg(not(feature = "portable-atomics"))]
    pub(crate) use std::sync::atomic;
    pub(crate) use std::{
        hint,
        sync::{Arc, Condvar},
        thread,
        thread_local,
    };

    #[cfg(feature = "portable-atomics")]
    pub(crate) use portable_atomic as atomic;
}

#[cfg(all(not(loom), not(shuttle)))]
pub(crate) use mutex::*;

#[cfg(all(not(loom), not(shuttle)))]
mod mutex {
    pub(crate) use std::sync::MutexGuard;

    #[derive(Debug, Default)]
    /// wraps std::sync::Mutex
    pub(crate) struct Mutex<T>(std::sync::Mutex<T>);

    impl<T> Mutex<T> {
        #[allow(dead_code)]
        /// Constructs a new Mutex
        pub(crate) const fn new(t: T) -> Self {
            Self(std::sync::Mutex::new(t))
        }

        /// locks the Mutex. This calls unwrap() on the internal Mutex, panicking on poison.
        pub(crate) fn lock(&self) -> MutexGuard<'_, T> {
            self.0.lock().unwrap()
        }
    }

    pub(crate) use std::sync::{RwLockReadGuard, RwLockWriteGuard};

    #[derive(Debug, Default)]
    /// wraps std::sync::RwLock
    pub(crate) struct RwLock<T>(std::sync::RwLock<T>);

    impl<T> RwLock<T> {
        #[allow(dead_code)]
        /// Constructs a new RwLock
        pub(crate) const fn new(t: T) -> Self {
            Self(std::sync::RwLock::new(t))
        }

        /// read locks the RwLock. This calls unwrap() on the internal RwLock, panicking on poison.
        pub(crate) fn read(&self) -> RwLockReadGuard<'_, T> {
            self.0.read().unwrap()
        }

        /// write locks the RwLock. This calls unwrap() on the internal RwLock, panicking on poison.
        pub(crate) fn write(&self) -> RwLockWriteGuard<'_, T> {
            self.0.write().unwrap()
        }
    }
}

#[cfg(loom)]
pub(crate) use mutex::*;

#[cfg(loom)]
mod mutex {
    use core::ops::{Deref, DerefMut};

    pub(crate) use loom::sync::{Arc, MutexGuard};

    #[derive(Debug, Default)]
    /// wraps a loom:::sync::Mutext
    pub(crate) struct Mutex<T>(loom::sync::Mutex<T>);

    impl<T> Mutex<T> {
        #[allow(dead_code)]
        /// constructs a new Mutex
        pub(crate) const fn new(t: T) -> Self {
            Self(loom::sync::Mutex::new(t))
        }

        /// locks the mutex. unwraps poison
        pub(crate) fn lock(&self) -> MutexGuard<'_, T> {
            self.0.lock().unwrap()
        }
    }

    pub(crate) use loom::sync::{RwLockReadGuard, RwLockWriteGuard};

    #[derive(Debug, Default)]
    /// wraps loom::sync::RwLock
    pub(crate) struct RwLock<T>(loom::sync::RwLock<T>);

    impl<T> RwLock<T> {
        #[allow(dead_code)]
        /// Constructs a new RwLock
        pub(crate) const fn new(t: T) -> Self {
            Self(loom::sync::RwLock::new(t))
        }

        /// read locks the RwLock. This calls unwrap() on the internal RwLock, panicking on poison.
        pub(crate) fn read(&self) -> RwLockReadGuard<'_, T> {
            self.0.read().unwrap()
        }

        /// write locks the RwLock. This calls unwrap() on the internal RwLock, panicking on poison.
        pub(crate) fn write(&self) -> RwLockWriteGuard<'_, T> {
            self.0.write().unwrap()
        }
    }
}

#[cfg(shuttle)]
pub(crate) use mutex::*;

#[cfg(shuttle)]
mod mutex {
    use core::ops::{Deref, DerefMut};

    pub(crate) use shuttle::sync::{Arc, MutexGuard};

    #[derive(Debug, Default)]
    /// wraps a shuttle::sync::mutex
    pub(crate) struct Mutex<T>(shuttle::sync::Mutex<T>);

    impl<T> Mutex<T> {
        #[allow(dead_code)]
        /// constructs a new mutex
        pub(crate) const fn new(t: T) -> Self {
            Self(shuttle::sync::Mutex::new(t))
        }

        /// locks the mutex. unwrapsp poison
        pub(crate) fn lock(&self) -> MutexGuard<'_, T> {
            self.0.lock().unwrap()
        }
    }

    pub(crate) use shuttle::sync::{RwLockReadGuard, RwLockWriteGuard};

    #[derive(Debug, Default)]
    /// wraps shuttle::sync::RwLock
    pub(crate) struct RwLock<T>(shuttle::sync::RwLock<T>);

    impl<T> RwLock<T> {
        #[allow(dead_code)]
        /// Constructs a new RwLock
        pub(crate) const fn new(t: T) -> Self {
            Self(shuttle::sync::RwLock::new(t))
        }

        /// read locks the RwLock. This calls unwrap() on the internal RwLock, panicking on poison.
        pub(crate) fn read(&self) -> RwLockReadGuard<'_, T> {
            self.0.read().unwrap()
        }

        /// write locks the RwLock. This calls unwrap() on the internal RwLock, panicking on poison.
        pub(crate) fn write(&self) -> RwLockWriteGuard<'_, T> {
            self.0.write().unwrap()
        }
    }
}