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
use std::fmt::{Debug, Display};
use std::ops::{Deref, DerefMut};
use std::ptr::{drop_in_place, null_mut, NonNull};
use std::sync::atomic::{AtomicUsize, Ordering};

/// ArcIllegal is an Arc that's illegal
///
/// ArcIllegal can always use it's contents as mutable, it sounds unsafe and
/// is unsafe too, but now without unsafe code blocks (they're just hidden in this lib), because that's what we're
/// Measuring these days
///
/// ```rust
/// use eater_arc_illegal::ArcIllegal;
/// use std::time::Duration;
/// use std::thread::{spawn, sleep};
///
/// let mut x = ArcIllegal::new("hewwo".to_string());
/// let mut y = x.clone();
/// let mut z = y.dup();
/// let a = &mut *x;
/// let b = &mut *y.dup();
/// let c = &mut *z.dup();
/// c.push_str(" wo");
/// b.push_str("rl");
/// a.push_str("d!");
/// y.push_str(" :)");
///
/// let mut zz = z.dup();
///
/// spawn(move || {
///     z.push_str(" :OOO");
/// });
///
/// spawn(move || {
///     zz.push_str("race!!!");
/// });
///
/// println!("{}", a);
/// delay(Duration::from_millis(50));
/// println!("{}", a);
/// ```
pub struct ArcIllegal<T> {
    inner: NonNull<ArcIllegalInner<T>>,
}

unsafe impl<T> Send for ArcIllegal<T> {}
unsafe impl<T> Sync for ArcIllegal<T> {}

impl<T: Debug> Debug for ArcIllegal<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::result::Result<(), std::fmt::Error> {
        T::fmt(&*self, f)
    }
}

impl<T: Display> Display for ArcIllegal<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::result::Result<(), std::fmt::Error> {
        T::fmt(&*self, f)
    }
}

struct ArcIllegalInner<T: ?Sized> {
    refs: AtomicUsize,
    weak_refs: AtomicUsize,
    value: *mut T,
}

/// Creates a new [ArcIllegal], inlines [ArcIllegal::new]
#[inline]
pub fn arc<T>(inner: T) -> ArcIllegal<T> {
    ArcIllegal::new(inner)
}

impl<T> ArcIllegal<T> {
    /// Creates a new [ArcIllegal] for given object
    #[inline]
    pub fn new(inner: T) -> ArcIllegal<T> {
        let inner_arc = Box::new(ArcIllegalInner {
            refs: AtomicUsize::new(1),
            weak_refs: AtomicUsize::new(0),
            value: Box::leak(Box::new(inner)),
        });

        unsafe {
            ArcIllegal {
                inner: NonNull::new_unchecked(Box::leak(inner_arc)),
            }
        }
    }

    /// Returns the raw pointer of the value
    pub fn as_ptr(&self) -> *mut T {
        unsafe { (*self.inner.as_ptr()).value }
    }

    /// Return the amount of references that hold this object
    pub fn ref_count(&self) -> usize {
        self.strong_ref_count() + self.weak_ref_count()
    }

    /// Return the amount of weak references that hold this object
    pub fn weak_ref_count(&self) -> usize {
        unsafe {
            let inner = &*self.inner.as_ptr();
            inner.weak_refs.load(Ordering::SeqCst)
        }
    }

    /// Return the amount of "strong" references that hold this object
    pub fn strong_ref_count(&self) -> usize {
        unsafe {
            let inner = &*self.inner.as_ptr();
            inner.refs.load(Ordering::SeqCst)
        }
    }

    /// Clones the ArcIllegal,
    /// convenience function for when the held type can be cloned
    pub fn dup(&self) -> Self {
        ArcIllegal::clone(&self)
    }

    /// Get a Weak reference to the value inside the IllegalArc
    pub fn weak(&self) -> WeakIllegal<T> {
        unsafe {
            (&mut *self.inner.as_ptr())
                .weak_refs
                .fetch_add(1, Ordering::SeqCst);

            WeakIllegal {
                inner: NonNull::new_unchecked(self.inner.as_ptr()),
            }
        }
    }

    /// If we're the only reference, destroy it and give the object back as owned
    pub fn dismantle(self) -> Result<T, Self> {
        unsafe {
            if 1 != self.ref_count() {
                return Err(self);
            }
            (&mut *self.inner.as_ptr())
                .refs
                .fetch_sub(1, Ordering::SeqCst);

            let inner = self.inner.as_ptr();
            let obj = (*inner).value.read();
            drop_in_place(inner);

            Ok(obj)
        }
    }

    pub fn dismantle_with_weak(self) -> Result<T, Self> {
        unsafe {
            if 1 != self.strong_ref_count() {
                return Err(self);
            }

            (&mut *self.inner.as_ptr())
                .refs
                .fetch_sub(1, Ordering::SeqCst);

            let obj = (*self.inner.as_ptr()).value.read();
            (*self.inner.as_ptr()).value = null_mut();
            Ok(obj)
        }
    }
}

impl<T> Drop for ArcIllegal<T> {
    fn drop(&mut self) {
        unsafe {
            let prev = (&mut *self.inner.as_ptr())
                .refs
                .fetch_sub(1, Ordering::SeqCst);
            if 1 != prev {
                return;
            }

            if (&mut *self.inner.as_ptr()).refs.load(Ordering::SeqCst) == 0 {
                drop_in_place((*self.inner.as_ptr()).value);
                (*self.inner.as_ptr()).value = null_mut();
            }

            if (&mut *self.inner.as_ptr()).weak_refs.load(Ordering::SeqCst) == 0 {
                drop_in_place(self.inner.as_ptr());
            }
        }
    }
}

impl<T> Clone for ArcIllegal<T> {
    fn clone(&self) -> Self {
        unsafe {
            (&mut *self.inner.as_ptr())
                .refs
                .fetch_add(1, Ordering::SeqCst);

            ArcIllegal {
                inner: NonNull::new_unchecked(self.inner.as_ptr()),
            }
        }
    }
}

impl<T> Deref for ArcIllegal<T> {
    type Target = T;

    fn deref(&self) -> &T {
        unsafe { &*(*self.inner.as_ptr()).value }
    }
}

impl<T> DerefMut for ArcIllegal<T> {
    fn deref_mut(&mut self) -> &mut T {
        unsafe { &mut *(*self.inner.as_ptr()).value }
    }
}

/// A weak reference to T
pub struct WeakIllegal<T> {
    inner: NonNull<ArcIllegalInner<T>>,
}

unsafe impl<T> Sync for WeakIllegal<T> {}
unsafe impl<T> Send for WeakIllegal<T> {}

impl<T> WeakIllegal<T> {
    /// Get a reference to T if T still exists
    pub fn get(&self) -> Option<&T> {
        if unsafe { self.inner.as_ref() }.refs.load(Ordering::SeqCst) == 0 {
            None
        } else {
            Some(unsafe { &*self.inner.as_ref().value })
        }
    }

    /// Get a mutable reference to T if T still exists
    pub fn get_mut(&self) -> Option<&mut T> {
        if unsafe { self.inner.as_ref() }.refs.load(Ordering::SeqCst) == 0 {
            None
        } else {
            Some(unsafe { &mut *self.inner.as_ref().value })
        }
    }

    /// Upgrade this weak reference to a STRONG reference
    pub fn strong(&self) -> Option<ArcIllegal<T>> {
        if unsafe { self.inner.as_ref() }.refs.load(Ordering::SeqCst) == 0 {
            None
        } else {
            unsafe { self.inner.as_ref() }
                .refs
                .fetch_add(1, Ordering::SeqCst);

            Some(ArcIllegal {
                inner: unsafe { NonNull::new_unchecked(self.inner.as_ptr()) },
            })
        }
    }

    /// Upgrade this weak reference to a [ArcIllegal]
    pub fn upgrade(&self) -> Option<ArcIllegal<T>> {
        self.strong()
    }

    /// Return the amount of references that hold this object
    pub fn ref_count(&self) -> usize {
        self.strong_ref_count() + self.weak_ref_count()
    }

    /// Return the amount of weak references that hold this object
    pub fn weak_ref_count(&self) -> usize {
        unsafe {
            let inner = &*self.inner.as_ptr();
            inner.weak_refs.load(Ordering::SeqCst)
        }
    }

    /// Return the amount of "strong" references that hold this object
    pub fn strong_ref_count(&self) -> usize {
        unsafe {
            let inner = &*self.inner.as_ptr();
            inner.refs.load(Ordering::SeqCst)
        }
    }
}

impl<T> Clone for WeakIllegal<T> {
    fn clone(&self) -> Self {
        unsafe {
            (&mut *self.inner.as_ptr())
                .weak_refs
                .fetch_add(1, Ordering::SeqCst);

            WeakIllegal {
                inner: NonNull::new_unchecked(self.inner.as_ptr()),
            }
        }
    }
}

impl<T> Drop for WeakIllegal<T> {
    fn drop(&mut self) {
        unsafe {
            let prev = (&mut *self.inner.as_ptr())
                .weak_refs
                .fetch_sub(1, Ordering::SeqCst);
            if 1 != prev {
                return;
            }

            if (&mut *self.inner.as_ptr()).refs.load(Ordering::SeqCst) != 0 {
                return;
            }

            if (&mut *self.inner.as_ptr()).weak_refs.load(Ordering::SeqCst) == 0 {
                drop_in_place(self.inner.as_ptr());
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::arc;

    #[test]
    pub fn weak_works() {
        let aa = &[0u8; 4];
        let x = arc(&aa[..]);
        let y = x.weak();
        let z = y.strong().unwrap();
        assert_eq!(&[0, 0, 0, 0][..], *x);
        assert_eq!(Some(&[0, 0, 0, 0][..]), y.get().copied());
        drop(x);
        assert_eq!(Some(&[0, 0, 0, 0][..]), y.get().copied());
        drop(z);
        assert_eq!(None, y.get().copied());
        assert_eq!(None, y.strong().map(|_| true));
    }

    #[test]
    pub fn dismantle_works() {
        let input = {
            let input = arc(vec![1u8; 5]);
            let clone = input.dup();
            let _ = match clone.dismantle() {
                Err(clone) => clone,
                Ok(_) => panic!("Shouldn't be able to dismantle ArcIllegal with 2 references"),
            };

            input
        };

        assert_eq!(1, input.ref_count());
        assert_eq!(Some(vec![1u8; 5]), input.dismantle().ok());
    }

    #[test]
    pub fn dismantle_weak_works() {
        let (input, weak) = {
            let input = arc(vec![1u8; 5]);
            let clone = input.dup();
            let weak = input.weak();
            let _ = match clone.dismantle_with_weak() {
                Err(clone) => clone,
                Ok(_) => panic!("Shouldn't be able to dismantle ArcIllegal with 2 references"),
            };

            (input, weak)
        };

        assert_eq!(2, input.ref_count());
        let res = input.dismantle_with_weak().ok();
        assert_eq!(Some(vec![1u8; 5]), res);
        std::mem::drop(res.unwrap());
        unsafe {
            assert!((*weak.inner.as_ptr()).value.is_null());
        }
        assert_eq!(None, weak.get());
    }
}