rust-gc

简单的跟踪（标记和清除）垃圾收集器for Rust

设计和动机在这篇博客文章中展示，代码草图在这个gist中。

还有一篇关于cgc初始设计的文章，它是实验性的并发分支。

如何使用

要在项目中包含，请将以下内容添加到您的Cargo.toml文件中

[dependencies]
gc = { version = "0.4", features = ["derive"] }

这可以像Rc一样使用，除了内部可变性。

虽然这可以广泛使用，但它是为了按需使用而设计的，遵循Rust的“按需付费”模型。避免在Rc或Box同样可用的地方使用Gc。

放置在Gc内部的类型必须实现Trace和Finalize。最简单的方法是使用gc_derive crate

use gc::{Finalize, Gc, Trace};

#[derive(Trace, Finalize)]
struct Foo {
    x: Option<Gc<Foo>>,
    y: u8,
    // ...
}

// now, `Gc<Foo>` may be used

Finalize也可以直接在结构体上实现，以便添加自定义的终结器行为

use gc::{Finalize, Trace};

#[derive(Trace)]
struct Foo {...}

impl Finalize for Foo {
    fn finalize(&self) {
        // Clean up resources for Foo, because we think it will be destroyed.
        // Foo may not be destroyed after a call to finalize, as another
        // finalizer may create a reference to it due to reference cycles.
    }
}

对于在stdlib中定义的类型，请在仓库中提交一个问题（使用下面的unsafe_ignore_trace方法来临时解决问题）。

请注意，只有在类型递归包含 Gc 的情况下才需要 Trace，如果您确定没有这种情况，您可以在您的类型上使用 unsafe_empty_trace! 宏。或者，您可以在结构体字段上使用 #[unsafe_ignore_trace] 注解。不正确地使用 unsafe_empty_trace 和 unsafe_ignore_trace 可能会导致不安全。

use gc::{Finalize, Gc, Trace};
use bar::Baz;

#[derive(Trace, Finalize)]
struct Foo {
    x: Option<Gc<Foo>>,
    #[unsafe_ignore_trace]
    y: Baz, // we are assuming that `Baz` doesn't contain any `Gc` objects
    // ...
}

要使用 Gc，只需调用 Gc::new

let x = Gc::new(1_u8);
let y = Gc::new(Box::new(Gc::new(1_u8)));

#[derive(Trace, Finalize)]
struct Foo {
    a: Gc<u8>,
    b: u8
}

let z = Gc::new(Foo {a: x.clone(), b: 1})

在 Gc 上调用 clone() 将为同一对象创建另一个垃圾回收引用。在可能的情况下，尽量使用内值的可借引用而不是克隆 Gc —— Gc 实现了 Deref 并与借用兼容。

Gc 是一个不可变容器。与 Rc 类似，为了获得可变性，我们必须使用单元格类型。stdlib 中的常规 RefCell 无法与 Gc 一起使用（因为它没有实现 Trace），而是使用 GcCell。 GcCell 的行为与 RefCell 非常相似，但它内部帮助跟踪 GC 根。

#[derive(Trace, Finalize)]
struct Foo {
    cyclic: GcCell<Option<Gc<Foo>>>,
    data: u8,
}

let foo1 = Gc::new(Foo {cyclic: GcCell::new(None), data: 1});
let foo2 = Gc::new(Foo {cyclic: GcCell::new(Some(foo1.clone())), data: 2});
let foo3 = Gc::new(Foo {cyclic: GcCell::new(Some(foo2.clone())), data: 3});
*foo1.cyclic.borrow_mut() = Some(foo3.clone());

已知问题

• 析构函数不应访问 Gc/GcCell 值。这通过 Trace 自定义 derive 自动实现 Drop 并使用安全的空释放方法来强制执行。应使用 Finalize 进行清理。
• 对于跨crate的 derive 需要更好的描述。
• 当前的 GC 不是并行的，GCed 对象被限制在线程内。在这个 pull request 中有一个实验性的并发收集器 [链接]。

相关项目

• RuScript：使用单线程 rust-gc 为各种对象分配内存