cgc-single-threaded 0.1.1

Compacting garbage collector
Documentation
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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
use crate::mem::Address;
use smallvec::SmallVec;
pub unsafe trait Trace: Finalizer {
    fn mark(&self);
    fn unmark(&self);
    fn references(&self) -> SmallVec<[*const dyn HeapTrait; 64]>;
}

#[derive(Default)]
pub struct Tracer {
    stack: SmallVec<[*const dyn HeapTrait; 64]>,
}
impl Tracer {
    pub fn for_each(&mut self, mut f: impl FnMut(*const dyn HeapTrait)) {
        while let Some(item) = self.stack.pop() {
            f(item);
        }
        //self.stack.into_iter().for_each(|x| f(*x));
    }

    pub fn trace(&mut self, item: *const dyn HeapTrait) {
        self.stack.push(item);
    }
}

pub trait Traceable
where
    Self: Finalizer,
{
    fn trace_with(&self, _: &mut Tracer) {}
}

unsafe impl<T: Traceable> Trace for T {
    fn mark(&self) {
        let mut tracer = Tracer::default();
        self.trace_with(&mut tracer);
        tracer.for_each(|pointer| unsafe { (*pointer).mark() });
    }
    fn unmark(&self) {
        let mut tracer = Tracer::default();
        self.trace_with(&mut tracer);
        tracer.for_each(|pointer| unsafe { (*pointer).unmark() });
    }

    fn references(&self) -> SmallVec<[*const dyn HeapTrait; 64]> {
        let mut tracer = Tracer::default();
        self.trace_with(&mut tracer);
        tracer.stack
    }
}

pub unsafe trait HeapTrait {
    fn mark(&self);
    fn unmark(&self);
    fn slot(&self) -> Address;
    fn get_fwd(&self) -> Address;
    fn set_fwd(&self, _: Address);
    fn copy_to(&self, addr: Address);
    fn addr(&self) -> Address;
    fn inner(&self) -> *mut crate::heap::HeapInner<dyn Trace>;

    fn is_marked(&self) -> bool;
}

pub trait Finalizer {
    fn finalize(&mut self) {}
}

macro_rules! simple {
    ($($t: ty)*) => {
        $(
            impl Traceable for $t {}
            impl Finalizer for $t {}
        )*
    };
}

simple!(
    i8
    i16
    i32
    i64
    i128
    u8
    u16
    u32
    u64
    u128
    f64
    f32
    bool
    String
    isize
    usize
    std::fs::File
    std::fs::FileType
    std::fs::Metadata
    std::fs::OpenOptions
    std::io::Stdin
    std::io::Stdout
    std::io::Stderr
    std::io::Error
    std::net::TcpStream
    std::net::TcpListener
    std::net::UdpSocket
    std::net::Ipv4Addr
    std::net::Ipv6Addr
    std::net::SocketAddrV4
    std::net::SocketAddrV6
    std::path::Path
    std::path::PathBuf
    std::process::Command
    std::process::Child
    std::process::ChildStdout
    std::process::ChildStdin
    std::process::ChildStderr
    std::process::Output
    std::process::ExitStatus
    std::process::Stdio
    std::sync::Barrier
    std::sync::Condvar
    std::sync::Once
    std::ffi::CStr
    std::ffi::CString
    &'static str
);

impl<T: Traceable> Traceable for Option<T> {
    fn trace_with(&self, tracer: &mut Tracer) {
        if let Some(item) = self {
            item.trace_with(tracer);
        }
    }
}
impl<T: Traceable> Finalizer for Option<T> {
    fn finalize(&mut self) {
        if let Some(item) = self {
            item.finalize();
        }
    }
}

impl<T: Traceable> Traceable for Vec<T> {
    fn trace_with(&self, tracer: &mut Tracer) {
        for item in self.iter() {
            item.trace_with(tracer);
        }
    }
}

impl<T: HeapTrait + Finalizer + 'static> Traceable for T {
    fn trace_with(&self, tracer: &mut Tracer) {
        tracer.trace(self as *const dyn HeapTrait);
    }
}

impl<T: Finalizer> Finalizer for Vec<T> {
    fn finalize(&mut self) {
        for item in self.iter_mut() {
            item.finalize();
        }
    }
}

pub trait RootedTrait
where
    Self: HeapTrait,
{
    fn is_rooted(&self) -> bool;
    fn references(&self) -> SmallVec<[*const dyn HeapTrait; 64]>;
}

pub struct Rooted<T: Trace + ?Sized> {
    pub(crate) inner: *mut RootedInner<T>,
}

impl<T: Trace + ?Sized> Rooted<T> {
    fn inner(&self) -> &mut RootedInner<T> {
        unsafe { &mut *self.inner }
    }
    pub fn to_heap(&self) -> Handle<T> {
        Handle {
            inner: self.inner().inner,
        }
    }
    pub fn get(&self) -> &T {
        unsafe { &(&*self.inner().inner).value }
    }
    pub fn get_mut(&self) -> &mut T {
        unsafe { &mut (&mut *self.inner().inner).value }
    }
}

pub(crate) struct RootedInner<T: Trace + ?Sized> {
    pub(crate) counter: u32,
    pub(crate) inner: *mut crate::heap::HeapInner<T>,
}
impl<T: Trace + ?Sized> Drop for Rooted<T> {
    fn drop(&mut self) {
        unsafe {
            debug_assert!(!self.inner.is_null());
            let inner = &mut *self.inner;
            inner.counter = inner.counter.wrapping_sub(1);
        }
    }
}

impl<T: Trace + ?Sized> Clone for Rooted<T> {
    fn clone(&self) -> Self {
        unsafe {
            let inner = &mut *self.inner;
            inner.counter = inner.counter + 1;
            Rooted {
                inner: inner as *mut _,
            }
        }
    }
}

unsafe impl<T: Trace + Sized + 'static> HeapTrait for RootedInner<T> {
    fn mark(&self) {
        unsafe {
            (&mut *self.inner).mark(true);
        }
    }

    fn unmark(&self) {
        unsafe {
            (&mut *self.inner).mark(false);
        }
    }
    fn get_fwd(&self) -> Address {
        unsafe { (&*self.inner).fwdptr() }
    }

    fn set_fwd(&self, fwd: Address) {
        unsafe {
            (&mut *self.inner).set_fwdptr(fwd);
        }
    }

    fn copy_to(&self, addr: Address) {
        debug_assert!(addr.is_non_null() && !self.inner.is_null());
        unsafe {
            std::ptr::copy(
                self.inner as *const u8,
                addr.to_mut_ptr(),
                std::mem::size_of_val(&*self.inner),
            )
        }
    }
    fn slot(&self) -> Address {
        debug_assert!(!self.inner.is_null());
        let slot = &self.inner;
        Address::from_ptr(slot)
    }
    fn addr(&self) -> Address {
        Address::from_ptr(self.inner as *const u8)
    }
    fn is_marked(&self) -> bool {
        unsafe { (&*self.inner).is_marked() }
    }
    fn inner(&self) -> *mut crate::heap::HeapInner<dyn Trace> {
        self.inner
    }
}

impl<T: Trace + Sized + 'static> RootedTrait for RootedInner<T> {
    fn is_rooted(&self) -> bool {
        self.counter >= 1
    }
    fn references(&self) -> SmallVec<[*const dyn HeapTrait; 64]> {
        unsafe { (&*self.inner).value.references() }
    }
}

/// Wraps GC heap pointer.
///
/// GC thing pointers on the heap must be wrapped in a `Handle<T>`
pub struct Handle<T: Trace + ?Sized> {
    pub(crate) inner: *mut crate::heap::HeapInner<T>,
}
impl<T: Trace + ?Sized> From<Rooted<T>> for Handle<T> {
    fn from(x: Rooted<T>) -> Self {
        unsafe {
            Self {
                inner: (*x.inner).inner,
            }
        }
    }
}

impl<T: Trace + ?Sized> From<&Rooted<T>> for Handle<T> {
    fn from(x: &Rooted<T>) -> Self {
        unsafe {
            Self {
                inner: (*x.inner).inner,
            }
        }
    }
}

impl<T: Trace + ?Sized> Handle<T> {
    pub fn get(&self) -> &T {
        unsafe {
            debug_assert!(!self.inner.is_null());
            let inner = &*self.inner;
            &inner.value
        }
    }

    /// Returns mutable reference to rooted value
    ///
    /// # Safety
    /// Rust semantics doesn't allow two mutable references at the same time and this function is safe as long as you have only one mutable reference.
    ///
    /// If you want to be 100% sure that you don't have two or more mutable references at the same time please use `Heap<RefCell<T>>`
    ///
    ///
    pub fn get_mut(&mut self) -> &mut T {
        unsafe {
            let inner = &mut *self.inner;
            &mut inner.value
        }
    }
}

unsafe impl<T: Trace + Sized + 'static> HeapTrait for Handle<T> {
    fn copy_to(&self, addr: Address) {
        debug_assert!(addr.is_non_null() && !self.inner.is_null());
        unsafe {
            std::ptr::copy(
                self.inner as *const u8,
                addr.to_mut_ptr(),
                std::mem::size_of_val(&*self.inner),
            )
        }
    }
    fn mark(&self) {
        unsafe {
            (&mut *self.inner).mark(true);
        }
    }
    fn unmark(&self) {
        unsafe {
            (&mut *self.inner).mark(false);
        }
    }
    fn get_fwd(&self) -> Address {
        unsafe { (&*self.inner).fwdptr() }
    }

    fn set_fwd(&self, fwd: Address) {
        unsafe {
            (&mut *self.inner).set_fwdptr(fwd);
        }
    }
    fn slot(&self) -> Address {
        debug_assert!(!self.inner.is_null());
        let slot = &self.inner;
        Address::from_ptr(slot)
    }
    fn addr(&self) -> Address {
        Address::from_ptr(self.inner as *const u8)
    }
    fn is_marked(&self) -> bool {
        unsafe { (&*self.inner).is_marked() }
    }
    fn inner(&self) -> *mut crate::heap::HeapInner<dyn Trace> {
        self.inner
    }
}
impl<T: Trace> Copy for Handle<T> {}
impl<T: Trace> Clone for Handle<T> {
    fn clone(&self) -> Self {
        *self
    }
}

use std::cmp;

impl<T: Trace + PartialOrd> PartialOrd for Handle<T> {
    fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
        self.get().partial_cmp(other.get())
    }
}

impl<T: Trace + Ord> Ord for Handle<T> {
    fn cmp(&self, other: &Self) -> cmp::Ordering {
        self.get().cmp(other.get())
    }
}

impl<T: Trace + PartialEq> PartialEq for Handle<T> {
    fn eq(&self, other: &Self) -> bool {
        self.get().eq(other.get())
    }
}

impl<T: Trace + Eq> Eq for Handle<T> {}

use std::hash::{Hash, Hasher};

impl<T: Trace + Hash> Hash for Handle<T> {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.get().hash(state);
    }
}

use std::fmt;

impl<T: Trace + fmt::Display> fmt::Display for Handle<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.get().fmt(f)
    }
}

impl<T: Trace + fmt::Debug> fmt::Debug for Handle<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.get().fmt(f)
    }
}

impl<T: Trace + PartialOrd> PartialOrd for Rooted<T> {
    fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
        self.get().partial_cmp(other.get())
    }
}

impl<T: Trace + Ord> Ord for Rooted<T> {
    fn cmp(&self, other: &Self) -> cmp::Ordering {
        self.get().cmp(other.get())
    }
}

impl<T: Trace + PartialEq> PartialEq for Rooted<T> {
    fn eq(&self, other: &Self) -> bool {
        self.get().eq(other.get())
    }
}

impl<T: Trace + Eq> Eq for Rooted<T> {}

impl<T: Trace + Hash> Hash for Rooted<T> {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.get().hash(state);
    }
}

impl<T: Trace + fmt::Display> fmt::Display for Rooted<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.get().fmt(f)
    }
}

impl<T: Trace + fmt::Debug> fmt::Debug for Rooted<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:?}", self.get())
    }
}

impl<T: Trace> Finalizer for Handle<T> {
    fn finalize(&mut self) {}
}

impl<T: Traceable> Finalizer for Rooted<T> {
    fn finalize(&mut self) {
        self.get_mut().finalize();
    }
}

use std::ops::{Deref, DerefMut};

impl<T: Traceable> Deref for Rooted<T> {
    type Target = T;
    fn deref(&self) -> &T {
        self.get()
    }
}

impl<T: Traceable> DerefMut for Rooted<T> {
    fn deref_mut(&mut self) -> &mut T {
        self.get_mut()
    }
}

impl<T: Traceable> Deref for Handle<T> {
    type Target = T;
    fn deref(&self) -> &T {
        self.get()
    }
}

impl<T: Traceable> DerefMut for Handle<T> {
    fn deref_mut(&mut self) -> &mut T {
        self.get_mut()
    }
}