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
use crossbeam_epoch::{Atomic, Guard, Owned, Shared};
use std::fmt;
use std::ops::Deref;
use std::sync::atomic::Ordering;
pub const ORDERING: Ordering = Ordering::SeqCst;
pub struct NotNull<'t, T: 't>(Shared<'t, T>);
impl<'t, T> NotNull<'t, T> {
pub fn as_maybe_null(&self) -> MaybeNull<'t, T> {
MaybeNull(self.0)
}
pub fn as_shared(&self) -> Shared<'t, T> {
self.0
}
pub fn deref<'f>(&'f self) -> &'t T {
debug_assert!(!self.0.is_null());
unsafe { self.0.deref() }
}
pub unsafe fn drop(self) {
let shared = self.0;
debug_assert!(!shared.is_null());
drop(shared.into_owned());
}
}
impl<'t, T: fmt::Debug> fmt::Debug for NotNull<'t, T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{:?}", self.as_maybe_null())
}
}
impl<'t, T> Clone for NotNull<'t, T> {
fn clone<'b>(&'b self) -> Self {
NotNull(self.0)
}
}
impl<'t, T> Copy for NotNull<'t, T> { }
impl<'t, T> Deref for NotNull<'t, T> {
type Target = T;
fn deref(&self) -> &T {
self.deref()
}
}
pub struct NotNullOwned<T>(Owned<T>);
impl<T> NotNullOwned<T> {
pub fn new(value: T) -> Self {
NotNullOwned(Owned::new(value))
}
pub fn into_owned(self) -> Owned<T> {
self.0
}
}
impl<T: fmt::Debug> fmt::Debug for NotNullOwned<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{:?}", self.deref())
}
}
impl<T> Deref for NotNullOwned<T> {
type Target = T;
fn deref(&self) -> &T {
self.0.deref()
}
}
pub struct MaybeNull<'t, T: 't>(Shared<'t, T>);
impl<'t, T> Clone for MaybeNull<'t, T> {
fn clone<'b>(&'b self) -> Self {
MaybeNull(self.0)
}
}
impl<'t, T> Copy for MaybeNull<'t, T> { }
impl<'t, T> MaybeNull<'t, T> {
pub fn from_shared(shared: Shared<'t, T>) -> Self {
MaybeNull(shared)
}
pub fn as_shared(&self) -> Shared<T> {
self.0
}
pub fn as_option(&self) -> Option<NotNull<'t, T>> {
match self.0.is_null() {
true => None,
false => Some(NotNull(self.0)),
}
}
pub unsafe fn try_defer_drop(self, guard: &Guard) {
if !self.as_shared().is_null() {
guard.defer(move || {
self.as_shared().into_owned();
})
}
}
}
impl<'t, T: fmt::Debug> fmt::Debug for MaybeNull<'t, T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self.as_option() {
Some(not_null) => write!(f, "{:?}", not_null.deref()),
None => write!(f, "(Null)"),
}
}
}
pub struct AtomicPtr<T>(Atomic<T>);
impl<T> AtomicPtr<T> {
pub fn new(value: Option<T>) -> Self {
match value {
Some(t) => AtomicPtr(Atomic::new(t)),
None => AtomicPtr(Atomic::null()),
}
}
pub fn load<'g>(&self, guard: &'g Guard) -> MaybeNull<'g, T> {
MaybeNull(self.0.load(ORDERING, guard))
}
pub fn relaxed_exists<'g>(&self, guard: &'g Guard) -> bool {
!self.0.load(Ordering::Relaxed, guard).is_null()
}
pub unsafe fn take<'g>(&self, guard: &'g Guard) -> Option<Box<T>> {
let shared = self.0.swap(Shared::null(), ORDERING, guard);
match shared.is_null() {
true => None,
false => Some(shared.into_owned().into_box())
}
}
pub fn compare_and_set<'g>(&self, compare: MaybeNull<T>, set: NotNull<'g, T>, guard: &'g Guard)
-> Result<NotNull<'g, T>, (MaybeNull<'g, T>, NotNull<'g, T>)>
{
self.0.compare_and_set(compare.as_shared(), set.as_shared(), ORDERING, guard)
.map(|set| NotNull(set))
.map_err(|e| (MaybeNull(e.current), NotNull(e.new)))
}
pub fn compare_null_and_set<'g>(
&self,
set: NotNull<'g, T>,
guard: &'g Guard
) -> Result<NotNull<'g, T>, (NotNull<'g, T>, NotNull<'g, T>)>
{
self.0.compare_and_set(Shared::null(), set.as_shared(), ORDERING, guard)
.map(|set| NotNull(set))
.map_err(|e| (NotNull(e.current), NotNull(e.new)))
}
pub fn compare_null_and_set_owned<'g>(
&self,
set: NotNullOwned<T>,
guard: &'g Guard
) -> Result<NotNull<'g, T>, (NotNull<'g, T>, NotNullOwned<T>)>
{
self.0.compare_and_set(Shared::null(), set.into_owned(), ORDERING, guard)
.map(|set| NotNull(set))
.map_err(|e| (NotNull(e.current), NotNullOwned(e.new)))
}
pub fn compare_and_set_owned<'g>(
&self,
compare: MaybeNull<T>,
set: NotNullOwned<T>,
guard: &'g Guard
) -> Result<NotNull<'g, T>, (MaybeNull<'g, T>, NotNullOwned<T>)>
{
self.0.compare_and_set(compare.as_shared(), set.into_owned(), ORDERING, guard)
.map(|set| NotNull(set))
.map_err(|e| (MaybeNull(e.current), NotNullOwned(e.new)))
}
pub fn compare_and_set_owned_weak<'g>(
&self,
compare: MaybeNull<T>,
set: NotNullOwned<T>,
guard: &'g Guard
) -> Result<NotNull<'g, T>, (MaybeNull<'g, T>, NotNullOwned<T>)>
{
self.0.compare_and_set_weak(compare.as_shared(), set.into_owned(), ORDERING, guard)
.map(|set| NotNull(set))
.map_err(|e| (MaybeNull(e.current), NotNullOwned(e.new)))
}
pub fn tag<'g>(&self, guard: &'g Guard) {
self.0.fetch_or(1, ORDERING, guard);
}
pub fn is_tagged<'g>(&self, guard: &'g Guard) -> bool {
self.0.fetch_or(0, ORDERING, guard).tag() == 1
}
pub unsafe fn try_drop(&mut self, guard: &Guard) {
let inner = self.0.swap(Shared::null(), ORDERING, &guard);
if !inner.is_null() {
inner.into_owned();
}
}
}
impl<T: fmt::Debug> fmt::Debug for AtomicPtr<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let guard = ::pin();
write!(f, "{:?}", self.load(&guard))
}
}
pub struct AtomicBox<T>(Atomic<T>);
impl<T> AtomicBox<T> {
pub fn new(value: T) -> Self {
AtomicBox(Atomic::new(value))
}
pub fn load<'g>(&self, guard: &'g Guard) -> NotNull<'g, T> {
NotNull(self.0.load(ORDERING, guard))
}
pub fn replace<'g>(&self, value: T) {
let guard = &::pin();
let contents = self.0.swap(Owned::new(value), ORDERING, &guard);
unsafe { guard.defer(move || contents.into_owned()); }
}
pub fn compare_and_set_shared<'g>(
&'g self,
compare: NotNull<T>,
set: NotNull<'g, T>,
guard: &'g Guard
)
-> Result<NotNull<'g, T>, (NotNull<'g, T>, NotNull<T>)>
{
self.0.compare_and_set(compare.0, set.0, ORDERING, guard)
.map(|set| NotNull(set))
.map_err(|e| (NotNull(e.current), NotNull(e.new)))
}
}
impl<T: fmt::Debug> fmt::Debug for AtomicBox<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let guard = ::pin();
write!(f, "{:?}", self.load(&guard).as_maybe_null())
}
}
impl<T> Drop for AtomicBox<T> {
fn drop(&mut self) {
let guard = ::pin();
let inner = self.0.swap(Shared::null(), ORDERING, &guard);
debug_assert!(!inner.is_null());
if !inner.is_null() {
unsafe { inner.into_owned(); }
}
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_atomic_ptr() {
let ptr = AtomicPtr::new(None);
let guard = ::pin();
assert!(!ptr.relaxed_exists(&guard));
assert!(ptr.load(&guard).as_option().is_none());
let _ok = ptr.compare_null_and_set_owned(NotNullOwned::new(String::from("first")), &guard);
let err = ptr.compare_null_and_set_owned(NotNullOwned::new(String::from("second")), &guard)
.unwrap_err();
let current = err.0;
let tried_to_insert = err.1;
assert_eq!(&*tried_to_insert, "second");
assert_eq!(&*current, "first");
let _ok = ptr.compare_and_set_owned(
current.as_maybe_null(), NotNullOwned::new(String::from("third")), &guard
).unwrap();
unsafe { guard.defer(move || current.drop()); }
assert_eq!(*_ok, "third");
assert!(!ptr.is_tagged(&guard));
ptr.tag(&guard);
assert!(ptr.is_tagged(&guard));
let inner = unsafe { ptr.take(&guard).unwrap() };
assert_eq!(*inner, "third");
drop(ptr);
}
}