Struct ApicIdDecoder 

pub struct ApicIdDecoder { /* private fields */ }

ApicIdDecoder is a utility for extracting particular topological level IDs from an (x2)APIC ID.

In full generality, an APIC ID might decompose as follows:

[intel/vol3]: Figure 8-5. Generalized Seven Level Interpretation of the APIC ID.

| CLUSTER ID | PACKAGE ID | DIE ID | TILE ID | MODULE ID | CORE ID | SMT ID |

where the full ID width is 32-bit (if x2APIC) or 8-bit.

This, however, is higher fidelity than we are able to make use of. Since CLUSTER ID and PACKAGE_ID are not directly enumerable from CPUID, we elide the two IDs into a single PACKAGE ID, defined as the rest of the ID above DIE. Moreover, the system currently has no use for enumerating tiles and modules directly (which is also a practice that AMD does not do): we elide the TILE and MODULE IDs into DIE ID alone. Accordingly, ApicIdDecoder partitions up the APIC address space as

| PACKAGE ID | DIE ID | CORE ID | SMT ID |

Implementations

impl ApicIdDecoder

pub fn from_cpuid(cpuid: impl Cpuid) -> Self

Constructs a new ApicIdDecoder by querying the given Cpuid.

pub const fn smt_id(&self, apic_id: u32) -> u32

Extracts the SMT ID from the provided APIC ID.

pub const fn core_id(&self, apic_id: u32) -> u32

Extracts the Core ID from the provided APIC ID.

pub const fn die_id(&self, apic_id: u32) -> u32

Extracts the Die ID from the provided APIC ID.

pub const fn package_id(&self, apic_id: u32) -> u32

Extracts the Package ID from the provided APIC ID.

pub const fn smt_id_width(&self) -> usize

Returns the bit width allocated to the SMT ID.

pub const fn core_id_cumulative_width(&self) -> usize

Returns the cumulative bit width allocated to Core and SMT IDs.

pub const fn die_id_cumulative_width(&self) -> usize

Returns the cumulative bit width allocated to Die, Core, and SMT IDs.

Trait Implementations

impl Clone for ApicIdDecoder

fn clone(&self) -> ApicIdDecoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ApicIdDecoder

impl Debug for ApicIdDecoder

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

Formats the value using the given formatter.

impl Default for ApicIdDecoder

fn default() -> ApicIdDecoder

Returns the “default value” for a type.

impl Eq for ApicIdDecoder

impl PartialEq for ApicIdDecoder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ApicIdDecoder