rsgc 1.1.0

Concurrent GC library for Rust
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

//! # RSGC
//! 
//! RSGC is a garbage collector for Rust. It is designed to be used for languge runtimes. 
//! 
//! RSGC is concurrent and conservative-on-stack precise on heap garbage collector. 
//! 
//! For example usage see `examples` directory or implementations of basic types in `src/system` directory.
//! 
//! ## Features
//! - Conservative on stack garbage collection, no need to register your pointers precisely.
//! - Concurrent garbage collection, mutators are stoped only for small period of time.
//! - Small latency, usually less than 20ms. 
//! - A lot of tuning options. You can choose different region sizes, different GC heuristics, configure GC threads, etc.
//! - Supports multiple mutators (threads) running and allocating at the same time.

#![feature(
    const_type_id,
    const_refs_to_cell,
    const_type_name,
    panic_always_abort,
    ptr_metadata,
    core_intrinsics,
    specialization,
    thread_local,
    ptr_sub_ptr,
    portable_simd,
    arbitrary_self_types
)]
#![allow(dead_code, unused_imports, incomplete_features)]

use std::{cell::UnsafeCell, sync::atomic::AtomicPtr};

pub mod heap;
pub mod sync;
pub mod system;
pub mod utils;

pub struct FormattedSize {
    pub size: f64,
}

impl std::fmt::Display for FormattedSize {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        let ksize = (self.size as f64) / 1024f64;

        if ksize < 1f64 {
            return write!(f, "{}B", self.size);
        }

        let msize = ksize / 1024f64;

        if msize < 1f64 {
            return write!(f, "{:.1}K", ksize);
        }

        let gsize = msize / 1024f64;

        if gsize < 8f64 {
            write!(f, "{:.1}M", msize)
        } else {
            write!(f, "{:.1}G", gsize)
        }
    }
}

impl std::fmt::Debug for FormattedSize {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self)
    }
}

pub fn formatted_size(size: usize) -> FormattedSize {
    FormattedSize { size: size as f64 }
}

pub fn formatted_sizef(size: f64) -> FormattedSize {
    FormattedSize { size: size as f64 }
}

static mut SINK: usize = 0;

pub fn force_on_stack<T>(val: *const T) {
    unsafe {
        core::ptr::write_volatile(&mut SINK, val as usize);
        core::sync::atomic::fence(core::sync::atomic::Ordering::SeqCst);
    }
}

#[macro_export]
macro_rules! offsetof {
    ($obj: ty, $($field: ident).+) => {{
        #[allow(unused_unsafe)]
        unsafe {
            let addr = 0x4000 as *const $obj;
            &(*addr).$($field).* as *const _ as usize - 0x4000
        }
    }
    };
}

pub use heap::thread;
use system::object::Allocation;

/// Returns true if write barrier is required when writing to a field of type `T`.
///
/// Write barrier is required only if `T` contains heap pointers.
pub const fn needs_write_barrier<T: Allocation>() -> bool {
    !T::NO_HEAP_PTRS || (T::VARSIZE && !T::VARSIZE_NO_HEAP_PTRS)
}

pub mod prelude {
    pub use super::heap;
    pub use super::system;
    pub use heap::thread::*;
    pub use heap::region::*;
    pub use system::{object::*, traits::*};
}

cfg_if::cfg_if! {
    if #[cfg(not(any(feature="gc-satb", feature="gc-incremental-update", feature="gc-passive")))] {
        compile_error!("No GC mode selected, enable one of through features: gc-satb, gc-incremental-update, gc-passive");
    } else if #[cfg(all(feature="gc-satb", not(feature="gc-incremental-update"), not(feature = "gc-passive")))] {
    } else if #[cfg(all(feature="gc-incremental-update", not(feature="gc-satb"), not(feature = "gc-passive")))] {
    } else if #[cfg(all(feature="gc-passive", not(feature="gc-satb"), not(feature = "gc-incremental-update")))] {
    } else {
        compile_error!("Multiple GC modes selected, enable only one of through features: gc-satb, gc-incremental-update, gc-passive");
    }
}

pub fn new_i32(thread: &mut prelude::Thread, x: i32) -> prelude::Handle<i32> {
    let handle = thread.allocate(x);
    handle
}