Struct mmtk::scheduler::gc_work::ProcessRootNode

pub(crate) struct ProcessRootNode<VM: VMBinding, R2OPE: ProcessEdgesWork<VM = VM>, O2OPE: ProcessEdgesWork<VM = VM>> {
    phantom: PhantomData<(VM, R2OPE, O2OPE)>,
    roots: Vec<ObjectReference>,
    bucket: WorkBucketStage,
}

This work packet processes pinning roots.

The roots member holds a list of ObjectReference to objects directly pointed by roots. These objects will be traced using R2OPE (Root-to-Object Process Edges).

After that, it will create work packets for tracing their children. Those work packets (and the work packets further created by them) will use O2OPE (Object-to-Object Process Edges) as their ProcessEdgesWork implementations.

Because roots are pinning roots, R2OPE must be a ProcessEdgesWork that never moves any object.

The choice of O2OPE determines whether the roots are transitively pinning or not.

• If O2OPE is set to a ProcessEdgesWork that never moves objects, all descendents of roots will not be moved in this GC. That implements transitive pinning roots.
• If O2OPE may move objects, then this ProcessRootsNode<VM, R2OPE, O2OPE> work packet will only pin the objects in roots (because R2OPE must not move objects anyway), but not their descendents.

Fields

phantom: PhantomData<(VM, R2OPE, O2OPE)>

roots: Vec<ObjectReference>

bucket: WorkBucketStage

Implementations

impl<VM: VMBinding, R2OPE: ProcessEdgesWork<VM = VM>, O2OPE: ProcessEdgesWork<VM = VM>> ProcessRootNode<VM, R2OPE, O2OPE>

pub fn new(nodes: Vec<ObjectReference>, bucket: WorkBucketStage) -> Self

Trait Implementations

impl<VM: VMBinding, R2OPE: ProcessEdgesWork<VM = VM>, O2OPE: ProcessEdgesWork<VM = VM>> GCWork<VM> for ProcessRootNode<VM, R2OPE, O2OPE>

fn do_work(&mut self, worker: &mut GCWorker<VM>, mmtk: &'static MMTK<VM>)

Define the work for this packet. However, this is not supposed to be called directly. Usually do_work_with_stat() should be used.

fn do_work_with_stat( &mut self, worker: &mut GCWorker<VM>, mmtk: &'static MMTK<VM> )

Do work and collect statistics. This internally calls do_work(). In most cases, this should be called rather than do_work() so that MMTk can correctly collect statistics for the work packets. If the feature “work_packet_stats” is not enabled, this call simply forwards the call to do_work().

fn get_type_name(&self) -> &'static str

Get the compile-time static type name for the work packet.