Struct mmtk::scheduler::GCWorker

pub struct GCWorker<VM: VMBinding> {
    pub tls: VMWorkerThread,
    pub ordinal: usize,
    pub mmtk: &'static MMTK<VM>,
    pub shared: Arc<GCWorkerShared<VM>>,
    pub local_work_buffer: Worker<Box<dyn GCWork<VM>>>,
    /* private fields */
}

A GC worker. This part is privately owned by a worker thread. The GC controller also has an embedded GCWorker because it may also execute work packets.

Fields

tls: VMWorkerThread

The VM-specific thread-local state of the GC thread.

ordinal: usize

The ordinal of the worker, numbered from 0 to the number of workers minus one. The ordinal is usize::MAX if it is the embedded worker of the GC controller thread.

mmtk: &'static MMTK<VM>

The reference to the MMTk instance.

shared: Arc<GCWorkerShared<VM>>

Reference to the shared part of the GC worker. It is used for synchronization.

local_work_buffer: Worker<Box<dyn GCWork<VM>>>

Local work packet queue.

Implementations

impl<VM: VMBinding> GCWorker<VM>

pub fn add_work_prioritized( &mut self, bucket: WorkBucketStage, work: impl GCWork<VM> )

Add a work packet to the work queue and mark it with a higher priority. If the bucket is activated, the packet will be pushed to the local queue, otherwise it will be pushed to the global bucket with a higher priority.

pub fn add_work(&mut self, bucket: WorkBucketStage, work: impl GCWork<VM>)

Add a work packet to the work queue. If the bucket is activated, the packet will be pushed to the local queue, otherwise it will be pushed to the global bucket.

pub fn is_coordinator(&self) -> bool

Is this worker a coordinator or a normal GC worker?

pub fn scheduler(&self) -> &GCWorkScheduler<VM>

Get the scheduler. There is only one scheduler per MMTk instance.

pub fn get_copy_context_mut(&mut self) -> &mut GCWorkerCopyContext<VM>

Get a mutable reference of the copy context for this worker.

pub fn run(&mut self, tls: VMWorkerThread, mmtk: &'static MMTK<VM>)

Entry of the worker thread. Resolve thread affinity, if it has been specified by the user. Each worker will keep polling and executing work packets in a loop.