Struct ProcessorTopology 

pub struct ProcessorTopology<T: ArchTopology = TargetTopology> { /* private fields */ }

A description of the VM’s processor topology.

Currently this just tracks the APIC IDs for the processors.

Build one with TopologyBuilder.

Implementations

impl ProcessorTopology<Aarch64Topology>

pub fn gic_version(&self) -> GicVersion

Returns the GIC version and version-specific addresses.

pub fn gic_distributor_base(&self) -> u64

Returns the GIC distributor base

pub fn pmu_gsiv(&self) -> Option<u32>

Returns the PMU GSIV

pub fn gic_msi(&self) -> GicMsiController

Returns the MSI controller configuration.

pub fn virt_timer_ppi(&self) -> u32

Returns the virtual timer PPI (GIC INTID).

pub fn gic_nr_irqs(&self) -> u32

Returns the total number of GIC interrupts to configure.

impl ProcessorTopology<X86Topology>

pub fn max_apic_id(&self) -> u32

Returns the largest APIC ID in use.

pub fn apic_mode(&self) -> ApicMode

Returns the APIC mode configured for the processors.

impl<T: ArchTopology + Inspect> ProcessorTopology<T>

pub fn vp_count(&self) -> u32

Returns the number of VPs.

pub fn vp(&self, vp_index: VpIndex) -> VpInfo

Returns information for the given processor by VP index.

Panics if the VP index is out of range.

pub fn vp_arch(&self, vp_index: VpIndex) -> T::ArchVpInfo

Returns information for the given processor by VP index, including architecture-specific information.

Panics if the VP index is out of range.

pub fn vps(&self) -> impl '_ + ExactSizeIterator<Item = VpInfo> + Clone

Returns an iterator over all VPs.

pub fn vps_arch( &self, ) -> impl '_ + ExactSizeIterator<Item = T::ArchVpInfo> + Clone

Returns an iterator over all VPs, including architecture-specific information.

pub fn smt_enabled(&self) -> bool

Returns whether SMT (hyperthreading) is enabled.

pub fn vps_per_socket(&self) -> u32

Returns the configured number of VPs per socket.

This is the logical socket size before power-of-two rounding. Use this for NUMA VP assignment and other logical topology queries.

pub fn reserved_vps_per_socket(&self) -> u32

Returns the number of VPs per socket, rounded up to a power of 2.

This is the APIC-ID-space reservation per socket. The number of VPs actually populated in a socket may be smaller than this.

pub fn vp_topology(&self, vp_index: VpIndex) -> VpTopologyInfo

Computes the processor topology information for a VP.

This reports the topology the VM was configured with, which is only as accurate as that configuration. It is not recovered from the VP’s architectural identity, and callers should not treat it as a measurement of the underlying hardware.

pub fn set_vnodes(&mut self, vnodes: &[u32])

where T::ArchVpInfo: AsMut<VpInfo>,

Sets the virtual NUMA node for each VP.

vnodes must have exactly vp_count() entries, where vnodes[i] is the vnode for VP index i.

Panics

Panics if vnodes.len() != vp_count().

Trait Implementations

impl<T: Clone + ArchTopology> Clone for ProcessorTopology<T>

where T::ArchVpInfo: Clone,

fn clone(&self) -> ProcessorTopology<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ArchTopology> Debug for ProcessorTopology<T>

where T::ArchVpInfo: Debug,

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

Formats the value using the given formatter.

impl<T> Inspect for ProcessorTopology<T>

where T: Inspect + ArchTopology, T::ArchVpInfo: Inspect,

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

Inspects the object.