Struct vm_topology::processor::VpIndex

pub struct VpIndex(/* private fields */);

The virtual processor index.

This value is used inside the VMM to identify the processor. It is expected to be used as an index into processor arrays, so it starts at zero and has no gaps.

VP index zero is special in that it is always present and is always the BSP.

The same value is exposed to the guest operating system as the HV VP index, via the Microsoft hypervisor guest interface. This constrains the HV VP index to start at zero and have no gaps, which is not required by the hypervisor interface, but it matches the behavior of Hyper-V and is not a practical limitation.

This value is distinct from the APIC ID, although they are often the same for all processors in small VMs and some in large VMs. Be careful not to use them interchangeably.

Implementations

impl VpIndex

pub const fn new(index: u32) -> Self

Returns index as a VP index.

pub const BSP: Self = _

VP index zero, corresponding to the boot processor (BSP).

Note that this being a constant means that the BSP’s HV VP index observed by the guest will always be zero. This is consistent with Hyper-V and is not a practical limitation.

Note that the APIC ID of the BSP might not be zero.

pub fn index(&self) -> u32

Returns the VP index value.

pub fn is_bsp(&self) -> bool

Returns true if this is the index of the BSP (0).

Trait Implementations

impl Clone for VpIndex

fn clone(&self) -> VpIndex

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VpIndex

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

Formats the value using the given formatter.

impl Inspect for VpIndex

fn inspect(&self, req: Request<'_>)

Inspects the object.

impl Ord for VpIndex

fn cmp(&self, other: &VpIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for VpIndex

fn eq(&self, other: &VpIndex) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for VpIndex

fn partial_cmp(&self, other: &VpIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for VpIndex

impl Eq for VpIndex

impl StructuralPartialEq for VpIndex