Struct Commpage 

pub struct Commpage { /* private fields */ }

Handle to a commpage backed by shared memory.

Implementations

impl Commpage

pub fn create() -> Result<Self, CommpageError>

Create a new commpage with a unique OS name. Initializes header and both cursors.

pub fn open(name: &str) -> Result<Self, CommpageError>

Open an existing commpage by its OS identifier. Validates magic and version.

pub fn os_id(&self) -> &str

Get the OS identifier for this shared memory region.

pub fn set_cursor_value(&mut self, role: Role, sample_no: u64)

Advance this role’s cursor after completing a sample.

pub fn wait_for_cursor_value(&self, role: Role, target: u64) -> bool

Spin-wait until the peer’s cursor reaches at least target, or the peer sets DONE.

Returns true if the peer caught up, false if the peer exited early (DONE).

pub fn mark_done(&mut self, role: Role)

Mark this role’s cursor as done.

pub fn is_done(&self, role: Role) -> bool

Check if this role’s cursor has the DONE bit set.

pub fn is_some_done(&self) -> bool

Either candidate or baseline has DONE bit set.

pub fn load_cursor_value(&self, role: Role) -> usize

Read the sample counter for a given role (cursor value without the DONE bit). Sample counter is the number of a sample the children is collecting right now. 0 means that measurement has not start yet.

pub fn set_stop(&mut self)

Set the STOP flag. Called by runner to signal time-budget exhaustion.

pub fn is_stopped(&self) -> bool

Check if the STOP flag is set.

pub fn reset(&mut self)

Reset the commpage for a new benchmark run.