Struct mmtk::plan::global::CommonPlan

pub struct CommonPlan<VM: VMBinding> {
    pub immortal: ImmortalSpace<VM>,
    pub los: LargeObjectSpace<VM>,
    pub nonmoving: ImmortalSpace<VM>,
    pub base: BasePlan<VM>,
}

CommonPlan is for representing state and features used by many plans, but that are not fundamental to all plans. Examples include the Large Object Space and an Immortal space. Features that are fundamental to all plans must be included in BasePlan.

Fields

immortal: ImmortalSpace<VM>

los: LargeObjectSpace<VM>

nonmoving: ImmortalSpace<VM>

base: BasePlan<VM>

Implementations

impl<VM: VMBinding> CommonPlan<VM>

pub fn new(args: CreateSpecificPlanArgs<'_, VM>) -> CommonPlan<VM>

pub fn get_used_pages(&self) -> usize

pub fn trace_object<Q: ObjectQueue>( &self, queue: &mut Q, object: ObjectReference, worker: &mut GCWorker<VM> ) -> ObjectReference

pub fn prepare(&mut self, tls: VMWorkerThread, full_heap: bool)

pub fn release(&mut self, tls: VMWorkerThread, full_heap: bool)

pub fn get_immortal(&self) -> &ImmortalSpace<VM>

pub fn get_los(&self) -> &LargeObjectSpace<VM>

pub fn get_nonmoving(&self) -> &ImmortalSpace<VM>

Trait Implementations

impl<VM: VMBinding> HasSpaces for CommonPlan<VM>

type VM = VM

fn for_each_space(&self, __func: &mut dyn FnMut(&dyn Space<VM>))

Visit each space field immutably.

fn for_each_space_mut(&mut self, __func: &mut dyn FnMut(&mut dyn Space<VM>))

Visit each space field mutably.

impl<VM: VMBinding> PlanTraceObject<VM> for CommonPlan<VM>

fn trace_object<Q: ObjectQueue, const KIND: u8>( &self, __mmtk_queue: &mut Q, __mmtk_objref: ObjectReference, __mmtk_worker: &mut GCWorker<VM> ) -> ObjectReference

Trace objects in the plan. Generally one needs to figure out which space an object resides in, and invokes the corresponding policy trace object method.

fn post_scan_object(&self, __mmtk_objref: ObjectReference)

Post-scan objects in the plan. Each object is scanned by VM::VMScanning::scan_object(), and this function will be called after the VM::VMScanning::scan_object() as a hook to invoke possible policy post scan method. If a plan does not have any policy that needs post scan, this method can be implemented as empty. If a plan has a policy that has some policy specific behaviors for scanning (e.g. mark lines in Immix), this method should also invoke those policy specific methods for objects in that space.

fn may_move_objects<const KIND: u8>() -> bool

Whether objects in this plan may move. If any of the spaces used by the plan may move objects, this should return true.