Struct x86_64_xsave::ExtendedStateInformation

pub struct ExtendedStateInformation {
    pub xsave_area_size_supported_features: usize,
    pub xsave_area_size_enabled_features: usize,
    pub xsaves_area_size_enabled_features: usize,
    pub has_xsaveopt_feature: bool,
    pub has_xsavec_feature: bool,
    pub xgetbv_supports_ecx_equals_one: bool,
    pub has_xsaves_feature: bool,
    // some fields omitted
}

Extended state information, as defined in Section 13.2 of the Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 1 (Basic Architecture).

Fields

xsave_area_size_supported_features: usize

Maximum size (in bytes) of an XSAVE area if all supported features in the processor are set as feature bits in the XCR0 register.

To access the XCR0 register use the struct StateComponentBitmap.

xsave_area_size_enabled_features: usize

Maximum size (in bytes) of an XSAVE area required by the feature bits enabled in the XCR0 register.

May be less than xsave_area_size_supported_features if compaction is used.

xsaves_area_size_enabled_features: usize

Maximum size (in bytes) of an XSAVE area saved by the XSAVES instruction required by the feature bits enabled in the XCR0 and IA32_XSS MCR registers.

May be less than xsave_area_size_supported_features if compaction is used.

To access the XCR0 register use the struct StateComponentBitmap.

has_xsaveopt_feature: bool

Has the XSAVEOPT instruction (xsaveopt feature).

has_xsavec_feature: bool

Has XSAVE compaction extensions (xsavec feature):-

• The compacted format of the extended region of XSAVE areas;
• Has the XSAVEC instruction;
• Execution of the compacted form of XRSTOR.

xgetbv_supports_ecx_equals_one: bool

The XGETBV instruction supports execution with XGETBV == 1.

has_xsaves_feature: bool

Has XSAVE supervisor extensions (xsaves feature):-

• Has the XSAVES instruction;
• Has the XRSTORS instruction;
• Has the IA32_XSS MSR.

If this is true then has_xsavec_feature is also true.

Methods

impl ExtendedStateInformation

pub fn user_state_component_possible(
    &self,
    user_state_component: UserStateComponent
) -> bool

Is an user state component present?

pub fn supervisor_state_component_possible(
    &self,
    supervisor_state_component: SupervisorStateComponent
) -> bool

Is a supervisor state component present?

pub fn new() -> Option<Self>

Creates a new instance.

Returns None if unsupported by the CPU.

Trait Implementations

impl PartialEq<ExtendedStateInformation> for ExtendedStateInformation

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for ExtendedStateInformation

impl PartialOrd<ExtendedStateInformation> for ExtendedStateInformation

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Ord for ExtendedStateInformation

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Clone for ExtendedStateInformation

fn clone(&self) -> ExtendedStateInformation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ExtendedStateInformation

impl Debug for ExtendedStateInformation

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

Formats the value using the given formatter.