Struct CpuId

pub struct CpuId<R: CpuIdReader> { /* private fields */ }

The main type used to query information about the CPU we’re running on.

Other structs can be accessed by going through this type.

Implementations

impl CpuId<CpuIdReaderNative>

pub fn new() -> Self

Create a new CpuId instance.

impl<R: CpuIdReader> CpuId<R>

pub fn with_cpuid_reader(cpuid_fn: R) -> Self

Return new CpuId struct with custom reader function.

This is useful for example when testing code or if we want to interpose on the CPUID calls this library makes.

pub fn with_cpuid_fn(cpuid_fn: R) -> Self

See CpuId::with_cpuid_reader.

Note

This function will likely be deprecated in the future. Use the identical with_cpuid_reader function instead.

pub fn get_vendor_info(&self) -> Option<VendorInfo>

Return information about the vendor (LEAF=0x00).

This leaf will contain a ASCII readable string such as “GenuineIntel” for Intel CPUs or “AuthenticAMD” for AMD CPUs.

Platforms

✅ AMD ✅ Intel

pub fn get_feature_info(&self) -> Option<FeatureInfo>

Query a set of features that are available on this CPU (LEAF=0x01).

Platforms

✅ AMD ✅ Intel

pub fn get_cache_info(&self) -> Option<CacheInfoIter>

Query basic information about caches (LEAF=0x02).

Platforms

❌ AMD ✅ Intel

pub fn get_processor_serial(&self) -> Option<ProcessorSerial>

Retrieve serial number of processor (LEAF=0x03).

Platforms

❌ AMD ✅ Intel

pub fn get_cache_parameters(&self) -> Option<CacheParametersIter<R>>

Retrieve more elaborate information about caches (LEAF=0x04 or 0x8000_001D).

As opposed to get_cache_info, this will tell us about associativity, set size, line size of each level in the cache hierarchy.

Platforms

🟡 AMD ✅ Intel

pub fn get_monitor_mwait_info(&self) -> Option<MonitorMwaitInfo>

Information about how monitor/mwait works on this CPU (LEAF=0x05).

Platforms

🟡 AMD ✅ Intel

pub fn get_thermal_power_info(&self) -> Option<ThermalPowerInfo>

Query information about thermal and power management features of the CPU (LEAF=0x06).

Platforms

🟡 AMD ✅ Intel

pub fn get_extended_feature_info(&self) -> Option<ExtendedFeatures>

Find out about more features supported by this CPU (LEAF=0x07).

Platforms

🟡 AMD ✅ Intel

pub fn get_direct_cache_access_info(&self) -> Option<DirectCacheAccessInfo>

Direct cache access info (LEAF=0x09).

Platforms

❌ AMD ✅ Intel

pub fn get_performance_monitoring_info( &self, ) -> Option<PerformanceMonitoringInfo>

Info about performance monitoring (LEAF=0x0A).

Platforms

❌ AMD ✅ Intel

pub fn get_extended_topology_info(&self) -> Option<ExtendedTopologyIter<R>>

Information about topology (LEAF=0x0B).

Intel SDM suggests software should check support for leaf 0x1F (CpuId::get_extended_topology_info_v2), and if supported, enumerate that leaf instead.

Platforms

✅ AMD ✅ Intel

pub fn get_extended_topology_info_v2(&self) -> Option<ExtendedTopologyIter<R>>

Extended information about topology (LEAF=0x1F).

Platforms

❌ AMD ✅ Intel

pub fn get_extended_state_info(&self) -> Option<ExtendedStateInfo<R>>

Information for saving/restoring extended register state (LEAF=0x0D).

Platforms

✅ AMD ✅ Intel

pub fn get_rdt_monitoring_info(&self) -> Option<RdtMonitoringInfo<R>>

Quality of service monitoring information (LEAF=0x0F).

Platforms

❌ AMD ✅ Intel

pub fn get_rdt_allocation_info(&self) -> Option<RdtAllocationInfo<R>>

Quality of service enforcement information (LEAF=0x10).

Platforms

❌ AMD ✅ Intel

pub fn get_sgx_info(&self) -> Option<SgxInfo<R>>

Information about secure enclave support (LEAF=0x12).

Platforms

❌ AMD ✅ Intel

pub fn get_processor_trace_info(&self) -> Option<ProcessorTraceInfo>

Intel Processor Trace Enumeration Information (LEAF=0x14).

Platforms

❌ AMD ✅ Intel

pub fn get_tsc_info(&self) -> Option<TscInfo>

Time Stamp Counter/Core Crystal Clock Information (LEAF=0x15).

Platforms

❌ AMD ✅ Intel

pub fn get_processor_frequency_info(&self) -> Option<ProcessorFrequencyInfo>

Processor Frequency Information (LEAF=0x16).

Platforms

❌ AMD ✅ Intel

pub fn get_soc_vendor_info(&self) -> Option<SoCVendorInfo<R>>

Contains SoC vendor specific information (LEAF=0x17).

Platforms

❌ AMD ✅ Intel

pub fn get_deterministic_address_translation_info(&self) -> Option<DatIter<R>>

Query deterministic address translation feature (LEAF=0x18).

Platforms

❌ AMD ✅ Intel

pub fn get_hypervisor_info(&self) -> Option<HypervisorInfo<R>>

Returns information provided by the hypervisor, if running in a virtual environment (LEAF=0x4000_00xx).

Platform

Needs to be a virtual CPU to be supported.

pub fn get_extended_processor_and_feature_identifiers( &self, ) -> Option<ExtendedProcessorFeatureIdentifiers>

Extended Processor and Processor Feature Identifiers (LEAF=0x8000_0001).

Platforms

✅ AMD 🟡 Intel

pub fn get_processor_brand_string(&self) -> Option<ProcessorBrandString>

Retrieve processor brand string (LEAF=0x8000_000{2..4}).

Platforms

✅ AMD ✅ Intel

pub fn get_l1_cache_and_tlb_info(&self) -> Option<L1CacheTlbInfo>

L1 Instruction Cache Information (LEAF=0x8000_0005)

Platforms

✅ AMD ❌ Intel (reserved)

pub fn get_l2_l3_cache_and_tlb_info(&self) -> Option<L2And3CacheTlbInfo>

L2/L3 Cache and TLB Information (LEAF=0x8000_0006).

Platforms

✅ AMD 🟡 Intel

pub fn get_advanced_power_mgmt_info(&self) -> Option<ApmInfo>

Advanced Power Management Information (LEAF=0x8000_0007).

Platforms

✅ AMD 🟡 Intel

pub fn get_processor_capacity_feature_info( &self, ) -> Option<ProcessorCapacityAndFeatureInfo>

Processor Capacity Parameters and Extended Feature Identification (LEAF=0x8000_0008).

Platforms

✅ AMD 🟡 Intel

pub fn get_svm_info(&self) -> Option<SvmFeatures>

This function provides information about the SVM features that the processory supports. (LEAF=0x8000_000A)

If SVM is not supported if ExtendedProcessorFeatureIdentifiers::has_svm is false, this function is reserved then.

Platforms

✅ AMD ❌ Intel

pub fn get_tlb_1gb_page_info(&self) -> Option<Tlb1gbPageInfo>

TLB 1-GiB Pages Information (LEAF=0x8000_0019)

Platforms

✅ AMD ❌ Intel

pub fn get_performance_optimization_info( &self, ) -> Option<PerformanceOptimizationInfo>

Informations about performance optimization (LEAF=0x8000_001A)

Platforms

✅ AMD ❌ Intel (reserved)

pub fn get_processor_topology_info(&self) -> Option<ProcessorTopologyInfo>

Informations about processor topology (LEAF=0x8000_001E)

Platforms

✅ AMD ❌ Intel (reserved)

pub fn get_memory_encryption_info(&self) -> Option<MemoryEncryptionInfo>

Informations about memory encryption support (LEAF=0x8000_001F)

Platforms

✅ AMD ❌ Intel (reserved)

Trait Implementations

impl<R: Clone + CpuIdReader> Clone for CpuId<R>

fn clone(&self) -> CpuId<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: CpuIdReader> Debug for CpuId<R>

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

Formats the value using the given formatter.

impl Default for CpuId<CpuIdReaderNative>

fn default() -> Self

Create a new CpuId instance.

impl<R: Copy + CpuIdReader> Copy for CpuId<R>