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

use std::cell::Cell;
use std::marker::PhantomData;
use std::mem;
use std::ops::Deref;
use std::ptr;
use std::sync::Arc;
use std::sync::atomic;
use std::sync::atomic::{AtomicPtr, AtomicUsize, Ordering};

use crate::{Epoch, Epochs, Inner, USIZE_MSB};

/// A handle used for accessing data immutably using RAII guards.
pub struct ReadHandle<T> {
    inner: Option<Arc<AtomicPtr<Inner<T>>>>,
    epochs: Option<Epochs>,

    global_epoch: Epoch,
    local_epoch: AtomicUsize,

    _not_sync: PhantomData<Cell<()>>,
}
impl<T> ReadHandle<T> {
    pub(crate) fn new(inner: Arc<AtomicPtr<Inner<T>>>, epochs: Epochs) -> Self {
        let global_epoch = Arc::new(AtomicUsize::new(0));
        epochs.lock().unwrap().push(Arc::downgrade(&global_epoch));

        Self {
            inner: Some(inner),
            epochs: Some(epochs),

            global_epoch,
            local_epoch: AtomicUsize::new(0),

            _not_sync: PhantomData,
        }
    }

    /// Create a RAII guard that allows reading the inner value directly.
    pub fn read(&'_ self) -> ReadHandleGuard<'_, T> {
        let epoch = self.local_epoch.fetch_add(1, Ordering::Relaxed) + 1;
        self.global_epoch.store(epoch, Ordering::Release);

        atomic::fence(Ordering::SeqCst);

        let pointer = self.inner.as_ref().unwrap().load(Ordering::Acquire);

        ReadHandleGuard {
            handle: self,
            pointer,
            epoch,
        }
    }
    /// Create a factory, used to make more read handles.
    pub fn factory(&self) -> ReadHandleFactory<T> {
        ReadHandleFactory {
            inner: Arc::clone(self.inner.as_ref().unwrap()),
            epochs: Arc::clone(self.epochs.as_ref().unwrap()),
        }
    }

    /// Consume this `ReadHandle` to create a factory
    pub fn into_factory(mut self) -> ReadHandleFactory<T> {
        ReadHandleFactory {
            inner: self.inner.take().unwrap(),
            epochs: self.epochs.take().unwrap(),
        }
    }
    /// Try to move out the inner value if no other readers exist.
    pub fn into_inner(mut self) -> Option<T> {
        let inner = self.inner.take().unwrap();

        if Arc::strong_count(&inner) == 1 {
            let readers_inner = inner.swap(ptr::null_mut(), Ordering::Relaxed);
            Some(unsafe { Box::from_raw(readers_inner) }.value)
        } else {
            None
        }
    }
}
impl<T> From<ReadHandleFactory<T>> for ReadHandle<T> {
    fn from(factory: ReadHandleFactory<T>) -> Self {
        factory.into_handle()
    }
}
impl<T> From<ReadHandle<T>> for ReadHandleFactory<T> {
    fn from(handle: ReadHandle<T>) -> Self {
        handle.into_factory()
    }
}
impl<T> Drop for ReadHandle<T> {
    fn drop(&mut self) {
        if let Some(inner) = self.inner.take() {
            if Arc::strong_count(&inner) == 1 {
                let readers_inner = inner.swap(ptr::null_mut(), Ordering::Relaxed);
                mem::drop(unsafe { Box::from_raw(readers_inner) });
            }
        }
    }
}
impl<T> Clone for ReadHandle<T> {
    fn clone(&self) -> Self{
        ReadHandle::new(Arc::clone(self.inner.as_ref().unwrap()), Arc::clone(self.epochs.as_ref().unwrap()))
    }
}

/// A factory for read handles, allows retrieving new `ReadHandle`s while still being `Sync`.
pub struct ReadHandleFactory<T> {
    inner: Arc<AtomicPtr<Inner<T>>>,
    epochs: Epochs,
}

impl<T> ReadHandleFactory<T> {
    /// Create a new handle.
    pub fn handle(&self) -> ReadHandle<T> {
        ReadHandle::new(Arc::clone(&self.inner), Arc::clone(&self.epochs))
    }

    /// Consume this factory, returning a handle.
    pub fn into_handle(self) -> ReadHandle<T> {
        ReadHandle::new(self.inner, self.epochs)
    }
}

/// A RAII guard used to directly access the data of a read handle, immutably.
pub struct ReadHandleGuard<'a, T> {
    handle: &'a ReadHandle<T>,
    epoch: usize,
    pointer: *const Inner<T>,
}
impl<T> Deref for ReadHandleGuard<'_, T> {
    type Target = T;
    fn deref(&self) -> &T {
        unsafe { &(*self.pointer).value }
    }
}
impl<T> Drop for ReadHandleGuard<'_, T> {
    fn drop(&mut self) {
        self.handle.global_epoch.store(self.epoch | USIZE_MSB, Ordering::Release);
    }
}