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
precision_t	getPrecision () const
mask_t	getMask () const
	FloatingPointControl (Parameters const &, ActivityRegistry &)

Private Member Functions
	FloatingPointControl (FloatingPointControl const &)=delete
FloatingPointControl &	operator= (FloatingPointControl const &)=delete
void	postEndJob ()
void	controlFpe ()
void	echoState ()

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 55 of file FloatingPointControl.h.

Member Typedef Documentation

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

Definition at line 63 of file FloatingPointControl.h.

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

Definition at line 83 of file FloatingPointControl.h.

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

Definition at line 57 of file FloatingPointControl.h.

Constructor & Destructor Documentation

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

privatedelete

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

explicit

Definition at line 10 of file FloatingPointControl_service.cc.

References controlFpe(), echoState(), enableInvalidEx_, enableOverFlowEx_, enableUnderFlowEx_, art::fp_detail::getFPControl(), OSdefault_, postEndJob(), reportSettings_, and setPrecisionDouble_.

  : 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
  controlFpe();
  if (reportSettings_) {
    mf::LogVerbatim("FPE_Enable")
      << "\nUpdated FP settings per user's configuration";
    echoState();
  }
}

Member Function Documentation

void art::FloatingPointControl::controlFpe ( )

private

Definition at line 61 of file FloatingPointControl_service.cc.

References enableDivByZeroEx_, enableInvalidEx_, enableOverFlowEx_, enableUnderFlowEx_, art::fp_detail::getFPControl(), art::fp_detail::setFPControl(), and setPrecisionDouble_.

Referenced by FloatingPointControl().

{
  // 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);
}

void art::FloatingPointControl::echoState ( )

private

Definition at line 113 of file FloatingPointControl_service.cc.

References FHICL_PROVIDE_ALLOWED_CONFIGURATION, art::fp_detail::getFPCW(), art::fp_detail::on_or_off(), and reportSettings_.

Referenced by FloatingPointControl(), and postEndJob().

{
  if (reportSettings_) {
    auto const femask{getFPCW()};
    mf::LogVerbatim("FPE_Enable")
      << "Floating point exception mask is " << std::showbase << std::hex
      << femask << "\tDivByZero exception is"
      << on_or_off(femask & FE_DIVBYZERO) << "\tInvalid exception is"
      << on_or_off(femask & FE_INVALID) << "\tOverFlow exception is"
      << on_or_off(femask & FE_OVERFLOW) << "\tUnderFlow exception is"
      << on_or_off(femask & FE_UNDERFLOW);
  }
}

auto art::FloatingPointControl::getMask

(

)

const

Definition at line 43 of file FloatingPointControl_service.cc.

References art::fp_detail::getFPCW().

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

auto art::FloatingPointControl::getPrecision

(

)

const

Definition at line 37 of file FloatingPointControl_service.cc.

References art::fp_detail::getFPCW().

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

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

privatedelete

void art::FloatingPointControl::postEndJob ( )

private

Definition at line 49 of file FloatingPointControl_service.cc.

References echoState(), OSdefault_, reportSettings_, and art::fp_detail::setFPControl().

Referenced by FloatingPointControl().

{
  (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 91 of file FloatingPointControl.h.

Referenced by controlFpe().

bool art::FloatingPointControl::enableInvalidEx_

private

Definition at line 92 of file FloatingPointControl.h.

Referenced by controlFpe(), and FloatingPointControl().

bool art::FloatingPointControl::enableOverFlowEx_

private

Definition at line 93 of file FloatingPointControl.h.

Referenced by controlFpe(), and FloatingPointControl().

bool art::FloatingPointControl::enableUnderFlowEx_

private

Definition at line 94 of file FloatingPointControl.h.

Referenced by controlFpe(), and FloatingPointControl().

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

private

Definition at line 98 of file FloatingPointControl.h.

Referenced by FloatingPointControl(), and postEndJob().

bool art::FloatingPointControl::reportSettings_

private

Definition at line 96 of file FloatingPointControl.h.

Referenced by echoState(), FloatingPointControl(), and postEndJob().

bool art::FloatingPointControl::setPrecisionDouble_

private

Definition at line 95 of file FloatingPointControl.h.

Referenced by controlFpe(), and FloatingPointControl().

---

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

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