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
#![deny(missing_docs)]
#![allow(unknown_lints)]
#![allow(mut_from_ref)]

//! When a value is put into the Arena, it will stay there for the whole
//! lifetime of the arena, and never move.
extern crate vec_map;

use std::cell::{Ref, RefCell, RefMut, UnsafeCell};
use std::marker::PhantomData;
use std::ops::{Deref, DerefMut};
use std::rc::Rc;
use std::{fmt, mem};

use vec_map::VecMap;

const BASE: usize = 32;
const NUM_ALLOCATIONS: usize = 32;
const USIZE_BITS: usize = mem::size_of::<usize>() * 8;

struct ArenaIdxIsNotSend;

thread_local! {
    static IDS: RefCell<usize> = RefCell::new(0);
}

/// A reference into the arena that can be used for lookup
/// Also contains a hacky !Send workaround by bundling a
/// `PhantomData<Rc<_>>`
#[derive(Clone, Copy, Debug)]
pub struct ArenaIdx {
    arena: usize,
    offset: usize,
    _marker: PhantomData<Rc<ArenaIdxIsNotSend>>,
}

#[derive(Debug)]
/// An immutable reference into the arena
pub struct ArenaRef<'a, T: 'a>(Ref<'a, T>);

#[derive(Debug)]
/// A mutable reference into the arena
pub struct ArenaRefMut<'a, T: 'a>(RefMut<'a, T>);

impl<'a, T> Deref for ArenaRef<'a, T> {
    type Target = T;
    fn deref(&self) -> &T {
        &*self.0
    }
}

impl<'a, T> Deref for ArenaRefMut<'a, T> {
    type Target = T;
    fn deref(&self) -> &T {
        &*self.0
    }
}

impl<'a, T> DerefMut for ArenaRefMut<'a, T> {
    fn deref_mut(&mut self) -> &mut T {
        &mut *self.0
    }
}

struct ArenaInner<T> {
    rows: UnsafeCell<[Vec<RefCell<T>>; NUM_ALLOCATIONS]>,
    len: UnsafeCell<usize>,
}

impl<T> Default for ArenaInner<T> {
    fn default() -> Self {
        ArenaInner {
            rows: UnsafeCell::new(Default::default()),
            len: UnsafeCell::new(0),
        }
    }
}

/// An arena that can hold values of type `T`.
pub struct Arena<T> {
    id: UnsafeCell<usize>,
    arenas: UnsafeCell<VecMap<Rc<ArenaInner<T>>>>,
}

impl<T> Clone for Arena<T> {
    fn clone(&self) -> Self {
        let new_id_a = new_id();
        let new_id_b = new_id();
        let inner_a = ArenaInner::default();
        let inner_b = ArenaInner::default();
        unsafe {
            *self.id.get() = new_id_a;
            let arenas = &mut *self.arenas.get();
            arenas.insert(new_id_a, Rc::new(inner_a));
            arenas.insert(new_id_b, Rc::new(inner_b));
            Arena {
                id: UnsafeCell::new(new_id_b),
                arenas: UnsafeCell::new(arenas.clone()),
            }
        }
    }
}

fn new_id() -> usize {
    IDS.with(|ids| {
        let id = *ids.borrow();
        *ids.borrow_mut() += 1;
        id
    })
}

impl<T> Default for Arena<T> {
    fn default() -> Self {
        let mut map = VecMap::new();
        let id = new_id();
        map.insert(id, Default::default());
        Arena {
            id: UnsafeCell::new(id),
            arenas: UnsafeCell::new(map),
        }
    }
}

impl<T> fmt::Debug for Arena<T>
where
    T: fmt::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "[")?;
        // let len = unsafe { *self.len.get() };
        // for i in 0..len.saturating_sub(1) {
        //     write!(f, "{:?}, ", self.get(&ArenaIdx(i, PhantomData)))?;
        // }
        // if len > 0 {
        //     write!(f, "{:?}, ", self.get(&ArenaIdx(len - 1, PhantomData)))?;
        // }
        write!(f, "]")
    }
}

impl<T> ArenaInner<T> {
    fn get(&self, offset: usize) -> ArenaRef<T> {
        if offset >= unsafe { *self.len.get() } {
            panic!("Index out of bounds")
        }
        let (row, col) = Self::index(offset);
        unsafe {
            let rows = self.rows.get();
            ArenaRef((*rows)[row][col].borrow())
        }
    }

    pub fn get_mut(&self, offset: usize) -> ArenaRefMut<T> {
        if offset >= unsafe { *self.len.get() } {
            panic!("Index out of bounds")
        }
        let (row, col) = Self::index(offset);
        unsafe {
            let rows = &mut *self.rows.get();
            ArenaRefMut(rows[row][col].borrow_mut())
        }
    }

    // [0, 1]
    // [2, 3, 4, 5]
    // [6, 7, 8, 9, 10, 11, 12, 13]
    fn index(i: usize) -> (usize, usize) {
        let j = i / BASE + 1;
        let row = USIZE_BITS - j.leading_zeros() as usize - 1;
        (row, i - (2usize.pow(row as u32) - 1) * BASE)
    }

    pub fn append(&self, id: usize, t: T) -> ArenaIdx {
        let i = unsafe { *self.len.get() };
        let (row, col) = Self::index(i);
        if row > 31 {
            panic!("Arena out of space!");
        }
        let rows = unsafe { &mut *self.rows.get() };
        if col == 0 {
            // allocate new memory
            rows[row] = Vec::with_capacity(BASE << row);
        }
        rows[row].push(RefCell::new(t));
        unsafe {
            *self.len.get() += 1;
        }
        ArenaIdx {
            offset: i,
            arena: id,
            _marker: PhantomData,
        }
    }
}

impl<T: Clone> Arena<T> {
    /// Creates a new empty arena.
    pub fn new() -> Self {
        Arena::default()
    }

    /// Merges two Arenas into one, in which all
    /// nodes reachable from `a` and `b` are reachable
    pub fn merge(a: &Self, b: &Self) -> Self {
        unsafe {
            let arenas_a = &*a.arenas.get();
            let arenas_b = &*b.arenas.get();

            let mut new_arenas = VecMap::new();
            let from_a = arenas_a.iter().map(|(k, v)| (k.clone(), v.clone()));
            let from_b = arenas_b.iter().map(|(k, v)| (k.clone(), v.clone()));
            new_arenas.extend(from_a);
            new_arenas.extend(from_b);

            Arena {
                id: UnsafeCell::new(new_id()),
                arenas: UnsafeCell::new(new_arenas),
            }
        }
    }

    /// Get a reference into the arena.
    ///
    /// Panics on out-of bound access.
    pub fn get(&self, arena_idx: &ArenaIdx) -> ArenaRef<T> {
        let arenas = unsafe { &mut *self.arenas.get() };
        arenas
            .get(arena_idx.arena)
            .expect("Invalid arena_idx")
            .get(arena_idx.offset)
    }

    /// Get a mutable reference into the arena.
    /// Panics if aliased, through a `RefCell` wrapper
    pub fn get_mut(&self, arena_idx: &mut ArenaIdx) -> ArenaRefMut<T> {
        let arenas = unsafe { &mut *self.arenas.get() };
        let id = unsafe { *self.id.get() };
        if arena_idx.arena == id {
            arenas
                .get(arena_idx.arena)
                .expect("Invalid arena_idx")
                .get_mut(arena_idx.offset)
        } else {
            let t: T = (*self.get(arena_idx)).clone();
            *arena_idx = self.append(t);
            self.get_mut(arena_idx)
        }
    }

    /// Puts a value into the arena, returning an index
    pub fn append(&self, t: T) -> ArenaIdx {
        let arenas = unsafe { &mut *self.arenas.get() };
        let id = unsafe { *self.id.get() };
        arenas.get(id).expect("Invalid arena_idx").append(id, t)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::rc::Rc;

    #[test]
    fn simple() {
        let arena = Arena::new();
        let mut a = arena.append(13);

        assert!(*arena.get(&a) == 13);
        *arena.get_mut(&mut a) += 1;

        assert!(*arena.get(&a) == 14);
    }

    #[test]
    #[should_panic]
    fn mutable_aliasing_panics() {
        let arena = Arena::new();
        let mut a = arena.append(13);

        let _ref_a = arena.get_mut(&mut a);
        let _ref_b = arena.get_mut(&mut a);
    }

    #[test]
    fn should_drop() {
        let rcs: Vec<_> = (0..1024).map(|_| Rc::new(0)).collect();
        {
            let arena = Arena::new();

            for rc in rcs.iter() {
                arena.append(rc.clone());
            }

            for rc in rcs.iter() {
                assert!(Rc::strong_count(rc) == 2);
            }
            // drop arena
        }
        for rc in rcs.iter() {
            assert!(Rc::strong_count(rc) == 1);
        }
    }

    #[test]
    fn readme_example() {
        let arena = Arena::new();

        let a = arena.append(0);
        let mut b = arena.append(1);

        assert_eq!(*arena.get(&a), 0);
        *arena.get_mut(&mut b) += 1;

        assert_eq!(*arena.get(&b), 2);
    }

    #[test]
    fn clone() {
        let arena_a = Arena::new();

        let a = arena_a.append(0);
        let mut b = arena_a.append(1);
        let c = b.clone();

        assert_eq!(*arena_a.get(&a), 0);
        assert_eq!(*arena_a.get(&b), 1);

        let arena_b = arena_a.clone();

        *arena_a.get_mut(&mut b) += 1;

        assert_eq!(*arena_a.get(&b), 2);
        assert_eq!(*arena_b.get(&c), 1);
    }

    #[test]
    fn merge() {
        let arena_a = Arena::new();
        let arena_b = Arena::new();

        let a = arena_a.append(0);
        let b = arena_b.append(0);

        let arena_c = Arena::merge(&arena_a, &arena_b);

        assert_eq!(*arena_c.get(&a), 0);
        assert_eq!(*arena_c.get(&b), 0);
    }
}