art::FloatingPointControl Class Reference

#include <FloatingPointControl.h>

Classes
struct	Config

Public Types
using	precision_t = fp_detail::precision_t
using	mask_t = unsigned short int
using	Parameters = ServiceTable< Config >

Public Member Functions
	FloatingPointControl (Parameters const &, ActivityRegistry &)
	FloatingPointControl (FloatingPointControl const &)=delete
FloatingPointControl &	operator= (FloatingPointControl const &)=delete
precision_t	getPrecision () const
mask_t	getMask () const

Private Member Functions
void	postEndJob ()

Private Attributes
bool	enableDivByZeroEx_
bool	enableInvalidEx_
bool	enableOverFlowEx_
bool	enableUnderFlowEx_
bool	setPrecisionDouble_
bool	reportSettings_
fp_detail::fp_control_t	OSdefault_ {}

Detailed Description

Definition at line 51 of file FloatingPointControl.h.

Member Typedef Documentation

using art::FloatingPointControl::mask_t = unsigned short int

Definition at line 54 of file FloatingPointControl.h.

using art::FloatingPointControl::Parameters = ServiceTable<Config>

Definition at line 68 of file FloatingPointControl.h.

using art::FloatingPointControl::precision_t = fp_detail::precision_t

Definition at line 53 of file FloatingPointControl.h.

Constructor & Destructor Documentation

art::FloatingPointControl::FloatingPointControl ( Parameters const &  c, ActivityRegistry &  reg  )

explicit

Definition at line 29 of file FloatingPointControl.cc.

    : enableDivByZeroEx_{c().enableDivByZeroEx()}
    , enableInvalidEx_{c().enableInvalidEx()}
    , enableOverFlowEx_{c().enableOverFlowEx()}
    , enableUnderFlowEx_{c().enableUnderFlowEx()}
    , setPrecisionDouble_{c().setPrecisionDouble()}
    , reportSettings_{c().reportSettings()}
    , OSdefault_(getFPControl())
  {
    reg.sPostEndJob.watch(this, &FloatingPointControl::postEndJob);
    if (reportSettings_) {
      mf::LogVerbatim("FPE_Enable") << "\nOS's FP settings";
      echoState();
    }
    // Update the state according to the user's configuration
    {
      // NB: We do not let users configure signaling of denormalized operand
      // (fpControl_DENORMALOPERAND) or inexact (FE_INEXACT), both of which
      // are suppressed.
      unsigned short int enable_except{};
      unsigned short int enable_sse{};
      if (enableDivByZeroEx_) {
        enable_except |= FE_DIVBYZERO;
        enable_sse |= fpControl_ZM_MASK;
      }
      if (enableInvalidEx_) {
        enable_except |= FE_INVALID;
        enable_sse |= fpControl_IM_MASK;
      }
      if (enableOverFlowEx_) {
        enable_except |= FE_OVERFLOW;
        enable_sse |= fpControl_OM_MASK;
      }
      if (enableUnderFlowEx_) {
        enable_except |= FE_UNDERFLOW;
        enable_sse |= fpControl_UM_MASK;
      }
      auto fpControl = getFPControl();
      // Reset exception mask before clearing the bits we care about.
      fpControl.fpcw = (fpControl.fpcw | FE_ALL_EXCEPT) & (~enable_except);
      if (setPrecisionDouble_) {
        // Clear precision bits before setting only the ones we care about.
        fpControl.fpcw =
          (fpControl.fpcw & (~fpControl_ALL_PREC)) | fpControl_DOUBLE_PREC;
      }
#ifdef fpControl_HAVE_MXCSR
      // Reset exception mask before clearing the bits we care about.
      fpControl.mxcsr =
        (fpControl.mxcsr | fpControl_ALL_SSE_EXCEPT) & (~enable_sse);
#endif
      // Write back.
      (void)setFPControl(fpControl);
    }
    if (reportSettings_) {
      mf::LogVerbatim("FPE_Enable")
        << "\nUpdated FP settings per user's configuration";
      if (reportSettings_) {
        echoState();
      }
    }
  }

art::FloatingPointControl::FloatingPointControl ( FloatingPointControl const &  )

delete

Member Function Documentation

auto art::FloatingPointControl::getMask

(

)

const

Definition at line 109 of file FloatingPointControl.cc.

  {
    return static_cast<mask_t>(getFPCW() & FE_ALL_EXCEPT);
  }

auto art::FloatingPointControl::getPrecision

(

)

const

Definition at line 103 of file FloatingPointControl.cc.

  {
    return static_cast<precision_t>(getFPCW() & fpControl_ALL_PREC);
  }

FloatingPointControl& art::FloatingPointControl::operator= ( FloatingPointControl const &  )

delete

void art::FloatingPointControl::postEndJob ( )

private

Definition at line 93 of file FloatingPointControl.cc.

  {
    (void)setFPControl(OSdefault_);
    if (reportSettings_) {
      mf::LogVerbatim("FPE_Enable") << "\nRestored to OS's FPE settings";
      echoState();
    }
  }

Member Data Documentation

bool art::FloatingPointControl::enableDivByZeroEx_

private

Definition at line 82 of file FloatingPointControl.h.

bool art::FloatingPointControl::enableInvalidEx_

private

Definition at line 83 of file FloatingPointControl.h.

bool art::FloatingPointControl::enableOverFlowEx_

private

Definition at line 84 of file FloatingPointControl.h.

bool art::FloatingPointControl::enableUnderFlowEx_

private

Definition at line 85 of file FloatingPointControl.h.

fp_detail::fp_control_t art::FloatingPointControl::OSdefault_ {}

private

Definition at line 89 of file FloatingPointControl.h.

bool art::FloatingPointControl::reportSettings_

private

Definition at line 87 of file FloatingPointControl.h.

bool art::FloatingPointControl::setPrecisionDouble_

private

Definition at line 86 of file FloatingPointControl.h.

---

The documentation for this class was generated from the following files:

• art/art/Framework/Services/System/FloatingPointControl.h
• art/art/Framework/Services/System/FloatingPointControl.cc