Struct TreadMill

pub struct TreadMill {
    sync: Mutex<TreadMillSync>,
}

A data structure for recording objects in the LOS.

All operations are protected by a single mutex TreadMill::sync.

Fields

sync: Mutex<TreadMillSync>

Implementations

impl TreadMill

pub fn new() -> Self

pub fn add_to_treadmill(&self, object: ObjectReference, nursery: bool)

Add an object to the treadmill.

New objects are normally added to alloc_nursery. But when allocating as live (e.g. when concurrent marking is active), we directly add into the to_space.

pub fn collect_nursery(&self) -> impl IntoIterator<Item = ObjectReference>

Take all objects from the collect_nursery. This is called during sweeping at which time all unreachable young objects are in the collection nursery.

pub fn collect_mature(&self) -> impl IntoIterator<Item = ObjectReference>

Take all objects from the from_space. This is called during sweeping at which time all unreachable old objects are in the from-space.

pub fn copy(&self, object: ObjectReference, is_in_nursery: bool)

Move an object to to_space. Called when an object is determined to be reachable.

pub fn is_to_space_empty(&self) -> bool

Return true if the to-space is empty.

pub fn is_from_space_empty(&self) -> bool

Return true if the from-space is empty.

pub fn is_alloc_nursery_empty(&self) -> bool

Return true if the allocation nursery is empty.

pub fn is_collect_nursery_empty(&self) -> bool

Return true if the collection nursery is empty.

pub fn flip(&mut self, full_heap: bool)

Flip object sets.

It will flip the allocation nursery and the collection nursery.

If full_heap is true, it will also flip the from-space and the to-space.

pub(crate) fn enumerate_objects( &self, enumerator: &mut dyn ObjectEnumerator, all: bool, )

Enumerate objects.

Objects in the allocation nursery and the to-spaces are always enumerated. They include all objects during mutator time, and objects determined to be live during a GC.

If all is true, it will enumerate the collection nursery and the from-space, too.

Trait Implementations

impl Debug for TreadMill

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TreadMill

fn default() -> Self

Returns the “default value” for a type.