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
use crate::RootObj;
use crate::stm::Journal;
use crate::alloc::MemPool;
use crate::{PSafe, VSafe, utils};
use std::cmp::*;
use std::mem::*;
use std::marker::PhantomData;
use std::ops::{Deref, DerefMut};
use std::fmt::{self,Debug};

/// A persistent memory location containing a volatile data valid during a
/// single transaction
/// 
/// The underlying data is valid throughout of the course of a single
/// transaction scope. When the transaction is finished, the data is back to its
/// default value. Type `T` in `TCell<T>` should implement [`Default`] and
/// [`VSafe`].
/// 
/// # Examples
/// 
/// ```
/// use corundum::default::*;
/// use std::cell::RefCell;
/// 
/// type P = Allocator;
/// 
/// #[derive(Root)]
/// struct Root {
///     v: TCell<RefCell<i32>>
/// }
///
/// let root = P::open::<Root>("foo.pool", O_CF).unwrap();
///     
/// P::transaction(|j| {
///   let mut v = root.v.borrow_mut();
///   assert_eq!(*v, i32::default());
///   *v = 20; // This value is volatile and resets when transaction is complete
///   assert_eq!(*v, 20);
/// }).unwrap();
/// 
/// let v = root.v.borrow();
/// assert_eq!(*v, i32::default()); // It contains the default value outside the transaction
/// ```
/// 
/// [`Default`]: std::default::Default
/// [`VSafe`]: ../trait.VSafe.html
pub struct TCell<T: Default + VSafe + ?Sized, A: MemPool> {
    gen: u32,
    tx_gen: u32,
    phantom: PhantomData<(A, T)>,
    value: T,
}

/// Not Safe to transfer between thread boundaries
impl<T, A> !Send for TCell<T, A> {}

/// Not Safe to be shared between threads
impl<T, A> !Sync for TCell<T, A> {}

/// Safe to be stored in persistent memory
unsafe impl<T: Default + VSafe + ?Sized, A: MemPool> PSafe for TCell<T, A> {}

impl<T: Default + Debug + VSafe + ?Sized, A: MemPool> Debug for TCell<T, A> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        write!(f, "{:?}", self.deref())
    }
}

impl<T: Default + VSafe, A: MemPool> TCell<T, A> {
    /// Create a new valid cell
    pub fn new(v: T, j: &Journal<A>) -> Self {
        Self {
            gen: A::gen(),
            tx_gen: j.gen(),
            value: v,
            phantom: PhantomData,
        }
    }

    #[inline]
    pub(crate) fn as_mut(&self) -> &mut T {
        unsafe { &mut *(self.deref() as *const T as *mut T) }
    }

    #[inline]
    /// Create a new invalid cell to be used in const functions
    pub const fn new_invalid(v: T) -> Self {
        Self {
            gen: 0,
            tx_gen: 0,
            value: v,
            phantom: PhantomData,
        }
    }

    #[inline]
    /// Invalidates the underlying value
    pub fn invalidate(this: &mut Self) {
        this.gen = 0;
    }

    fn force(&mut self) -> &mut T {
        let gen = A::gen();
        unsafe {
            if let Some((j, _)) = Journal::<A>::current(false) {
                let j = &*j;
                let tx_gen = j.gen();
                if self.gen != gen || self.tx_gen != tx_gen {
                    forget(replace(&mut self.value, T::default()));
                    self.gen = gen;
                    self.tx_gen = tx_gen;
                }
            } else {
                forget(replace(&mut self.value, T::default()));
                self.gen = gen;
            }
        }
        &mut self.value
    }
}

impl<T: Default + VSafe, A: MemPool> RootObj<A> for TCell<T, A> {
    fn init(j: &Journal<A>) -> Self {
        Self {
            gen: A::gen(),
            tx_gen: j.gen(),
            value: T::default(),
            phantom: PhantomData,
        }
    }
}

impl<T: Default + VSafe, A: MemPool> Deref for TCell<T, A> {
    type Target = T;

    #[inline]
    fn deref(&self) -> &T {
        unsafe { utils::as_mut(self).force() }
    }
}

impl<T: Default + VSafe, A: MemPool> DerefMut for TCell<T, A> {
    #[inline]
    fn deref_mut(&mut self) -> &mut T {
        self.force()
    }
}

impl<T: Default + VSafe + PartialEq + Copy, A: MemPool> PartialEq for TCell<T, A> {
    #[inline]
    fn eq(&self, other: &TCell<T, A>) -> bool {
        self.value == other.value
    }
}

impl<T: Default + VSafe + Eq + Copy, A: MemPool> Eq for TCell<T, A> {}

impl<T: Default + VSafe + PartialOrd + Copy, A: MemPool> PartialOrd for TCell<T, A> {
    #[inline]
    fn partial_cmp(&self, other: &TCell<T, A>) -> Option<Ordering> {
        self.value.partial_cmp(&other.value)
    }

    #[inline]
    fn lt(&self, other: &TCell<T, A>) -> bool {
        self.value < other.value
    }

    #[inline]
    fn le(&self, other: &TCell<T, A>) -> bool {
        self.value <= other.value
    }

    #[inline]
    fn gt(&self, other: &TCell<T, A>) -> bool {
        self.value > other.value
    }

    #[inline]
    fn ge(&self, other: &TCell<T, A>) -> bool {
        self.value >= other.value
    }
}

impl<T: Default + VSafe + Ord + Copy, A: MemPool> Ord for TCell<T, A> {
    #[inline]
    fn cmp(&self, other: &TCell<T, A>) -> Ordering {
        self.value.cmp(&other.value)
    }
}

impl<T: Default + VSafe + PartialEq + Copy, A: MemPool> PartialEq<T> for TCell<T, A> {
    #[inline]
    fn eq(&self, other: &T) -> bool {
        self.value == *other
    }
}

impl<T: Default + VSafe + PartialOrd + Copy, A: MemPool> PartialOrd<T> for TCell<T, A> {
    #[inline]
    fn partial_cmp(&self, other: &T) -> Option<Ordering> {
        self.value.partial_cmp(&other)
    }

    #[inline]
    fn lt(&self, other: &T) -> bool {
        self.value < *other
    }

    #[inline]
    fn le(&self, other: &T) -> bool {
        self.value <= *other
    }

    #[inline]
    fn gt(&self, other: &T) -> bool {
        self.value > *other
    }

    #[inline]
    fn ge(&self, other: &T) -> bool {
        self.value >= *other
    }
}