Skip to main content

FpuGuard

Struct FpuGuard 

Source
pub struct FpuGuard { /* private fields */ }
Expand description

RAII guard that protects a computation from dangerous FPU settings

On creation:

  1. Triggers one-time FPU check and warning (if not already done)
  2. If FZ or DAZ is enabled, disables them temporarily

On drop:

  • Restores the original FPU state

§Example

use sparse_ir_sve::unstable::fpu_check::{FpuGuard, get_fpu_state};

let before = get_fpu_state();
{
    let _guard = FpuGuard::new_protect_computation();
    // Computation here - FZ/DAZ are disabled
    assert!(!get_fpu_state().is_dangerous());
    let subnormal = std::hint::black_box(f64::MIN_POSITIVE) / 2.0;
    assert!(subnormal > 0.0); // not flushed to zero
} // Original FPU state is restored here
let after = get_fpu_state();
assert_eq!(after.flush_to_zero, before.flush_to_zero);
assert_eq!(after.denormals_are_zero, before.denormals_are_zero);

§Performance

The overhead is negligible (a few CPU cycles for stmxcsr/ldmxcsr).

Implementations§

Source§

impl FpuGuard

Source

pub fn new_protect_computation() -> Self

Create a new guard that protects computation from FZ/DAZ

  • Triggers one-time warning if dangerous FPU settings are detected
  • Temporarily disables FZ/DAZ if they are enabled
  • Restores original state when dropped
Source

pub fn was_modified(&self) -> bool

Check if the guard needed to modify FPU state

Trait Implementations§

Source§

impl Drop for FpuGuard

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.