Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Errors during floating-point operations are often neglected by applications; instead, the greatest effort is usually in validating the programmers who instead focus on validating operands before an operation. Errors occurring during floating-point operations are admittedly difficult to determine and diagnose, but the benefits of understanding how to check for these errors and employing the process of doing so may outweigh often outweighs the costs. This recommendation suggests ways to capture errors during floating-point operations.

The following code has exhibits undefined behavior:

Code Block
int j = 0;
int iResult = 1 / j;

...

Code Block
double x = 0.0;
double dResult = 1 / x;

Though the code above Floating-point division by zero also results in undefined behavior, although most implementations do not view floating point division by zero treat this as a terminal error. If extra steps additional precautions are not taken, the operation happens "silently."this results in a silent error.

Wiki Markup
The most portable way of determining a floating -point exceptional condition has occurred is to make use of the floating -point exception faculties provided by C99 in {{fenv.h}} \[[ISO/IEC 9899:1999|AA. C References#ISO/IEC 9899-1999]\].

However, the C99 floating-point exception functions are not without problems. The following caveats exist regarding the interaction between floating-point exceptions and conversions:

  • Conversion from floating-point to integer may cause an "invalid" floating-point exception. If this occurs, the value of that integer is undefined and should not be used.
  • Most implementations fail to raise "invalid" for conversions from any negative or "large" positive FP floating-point values to unsigned integer types or to signed char (see tflt2int.c).
  • When a nonnoninteger floating-integer floating point value is converted into to an integer the "inexact" floating-point exception is raised.

For information regarding floating-point number conversions, see FLP34-C. Ensure that floating point conversions are within range of the new type.

Though the notion of Although floating-point exceptions guaranteed are required by C99, floating point exceptions they generally exist only exist on architectures utilizing using IEEE-754. Despite thisNevertheless, these functions are the only somewhat most portable solution to for handling floating-point exceptions.

A less portable , but sometimes more intuitive and/or more informative, potentially more secure solution is to make use of the faculties capabilities provided by the underlying implementation. If this approach is taken, the caveats of that system need to be well understood. The following table Table 6-1 can serve as a starting point for some common architecturesoperating systems:

Operating System

How to handle floating point errors

Linux
Solaris 10
Mac OS X 10.5

Use the C99 floating-point exception functions.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="50ef89ede9362fe0-86c7503e-46b54055-8350b157-0e0c5a2704675b1c6fce4029"><ac:plain-text-body><![CDATA[

Windows

Either use the C99 floating-point exception function or structured exception handling through _fpieee_flt [[MSDN

AA. C References#MSDN]]

]]></ac:plain-text-body></ac:structured-macro>

Noncompliant Code Example

In the following this noncompliant code example, floating-point operations are carried out and there is no observation performed without checking for errors during floating point operations. Please note that the range check on various operands for the operations . Note that range checking has been intentionally ignored because we intend to capture the errors during a floating omitted because the intent is to detect errors following the floating-point operation.

Code Block
bgColor#FFCCCC
void fpOper_noErrorChecking(void) {
  /* ... */
  double a = 1e-40, b, c = 0.1;
  float x = 0, y;
  /* inexact and underflows */
  y = a;
  /* divide by zero operation */
  b = y / x;
  /* inexact (loss of precision) */
  c = sin(30) * a;
  /* ... */
}

However, exceptional conditions (as indicated by the comments indicate, various exceptional conditions )occur that may lead to unexpected arithmetic results.

Compliant Solution

...

(C99)

This compliant solution uses C99 standard functions to handle floating-point errors.

Code Block
bgColor#ccccff
#include <fenv.h>
#pragma STDC FENV_ACCESS ON

void fpOper_fenv(void) {
  double a = 1e-40, b, c = 0.1;
  float x = 0, y;
  int fpeRaised;
  /* ... */

  feclearexcept(FE_ALL_EXCEPT);
  /* Store a into y is inexact and underflows: */
  y = a;
  fpeRaised = fetestexcept(FE_ALL_EXCEPT);
  /* fpeRaised  has FE_INEXACT and FE_UNDERFLOW */

  feclearexcept(FE_ALL_EXCEPT);

  /* divide by zero operation */
  b = y / x;
  fpeRaised = fetestexcept(FE_ALL_EXCEPT);
  /* fpeRaised has FE_DIVBYZERO */

  feclearexcept(FE_ALL_EXCEPT);

  c = sin(30) * a;
  fpeRaised = fetestexcept(FE_ALL_EXCEPT);
  /* fpeRaised has FE_INEXACT */

  feclearexcept(FE_ALL_EXCEPT);
  /* ... */
}

Compliant Solution

...

(Windows)

Microsoft Visual Studio 2008 and earlier does versions do not support C99 functions to handle floating-point errors. Windows provides an alternative method to get for handling floating-point exception code errors using _statusfp(), _statusfp2(), and _clearfp().

Code Block
bgColor#ccccff
void fpOper_usingStatus(void) {
  /* ... */
  double a = 1e-40, b, c;
  float x = 0, y;
  unsigned int rv = _clearfp();

  /* Store into y is inexact and underflows: */
  y = a;
  rv = _clearfp();  /* rv has _SW_INEXACT and _SW_UNDERFLOW */

  /* zero-divide */
  b = y / x; rv = _clearfp(); /* rv has _SW_ZERODIVIDE */

  /* inexact */
  c = sin(30) * a; rv = _clearfp(); /* rv has _SW_INEXACT */
  /* ... */
}

Compliant Solution

...

(Windows SEH)

Microsoft Visual Studio 2008 also uses structured exception handling (SEH) to handle floating-point operation. Using the SEH . SEH provides more information about the error and allows the programmer to change the results of the floating-point operation that caused the error condition. Using SEH also provides more information about the error condition.

Code Block
bgColor#ccccff
void fp_usingSEH(void) {
  /* ... */
  double a = 1e-40, b, c = 0.1;
  float x = 0, y;
  unsigned int rv ;

  unmask_fpsr();

  _try {
    /* Store into y is inexact and underflows */
    y = a;

    /* divide by zero operation */
    b = y / x;

    /* inexact */
    c = sin(30) * a;
  }

  _except (_fpieee_flt(
             GetExceptionCode(),
             GetExceptionInformation(),
             fpieee_handler)) {
  {
	printf ("fpieee_handler: EXCEPTION_EXECUTE_HANDLER");
  }

  /* ... */
}

void unmask_fpsr(void) {
  unsigned int u;
  unsigned int control_word;
  _controlfp_s(&control_word, 0, 0);
  u = control_word & ~(_EM_INVALID
                     | _EM_DENORMAL
                     | _EM_ZERODIVIDE
                     | _EM_OVERFLOW
                     | _EM_UNDERFLOW
                     | _EM_INEXACT);
  _controlfp_s( &control_word, u, _MCW_EM);
  return ;
}

int fpieee_handler(_FPIEEE_RECORD *ieee) {
  /* ... */

  switch (ieee->RoundingMode) {
    case _FpRoundNearest:
      /* ... */
      break;

      /* Other RMs include _FpRoundMinusInfinity,
       * _FpRoundPlusInfinity, _FpRoundChopped */

      /* ... */
    }

  switch (ieee->Precision) {
    case _FpPrecision24:
      /* ... */
      break;

      /* Other Ps include _FpPrecision53*/
      /* ... */
    }

   switch (ieee->Operation) {
     case _FpCodeAdd:
       /* ... */
       break;

       /* Other Ops include _FpCodeSubtract, _FpCodeMultiply,
        * _FpCodeDivide, _FpCodeSquareRoot, _FpCodeCompare,
        * _FpCodeConvert, _FpCodeConvertTrunc */
       /* ... */
    }

  /* 
   * process the bitmap ieee->Cause.
 */
  /* process the bitmap ieee->Enable.
 */
  /* process the bitmap ieee->Status.
 */
  /* process the Operand ieee->Operand1, 
   * evaluate format and Value.
 */
  /* process the Operand ieee->Operand2, 
   * evaluate format and Value */.
   /* process the Result ieee->Result, 
   * evaluate format and Value */.
  / * The result should be set according to the operation 
   * specified in ieee->Cause and the result format as 
   * specified in ieee->Result.
   */

  /* ... */
}

Risk Assessment

If Undetected floating-point exceptions go undetected, they will cause one or more of these conditions: a security vulnerability, may result in lower program efficiency, and inaccurate results, or software vulnerabilities. Most processors stall for a significant duration (sometimes up to a second or to a second or even more on 32-bit desktop processors) when an operation incurs a NaN (not a number) value.

Recommendation

Severity

Likelihood

Remediation Cost

Priority

Level

FLP03-C

low

probable

high

P2

L3

...

Wiki Markup
\[[IEEE 754|AA. C References#IEEE 754 2006]\]
\[[Intel 01|AA. C References#Intel 01]\]
\[[Keil 08|AA. C References#Keil 08]\]
\[[MITRE 07|AA. C References#MITRE 07]\] [CWE ID 369|http://cwe.mitre.org/data/definitions/369.html], "Divide By Zero"
\[[MSDN|AA. C References#MSDN]\] "[fpieee_flt (CRT)|http://msdn.microsoft.com/en-us/library/te2k2f2t(VS.80).aspx]"
\[[Open Group 04|AA. C References#Open Group 04]\] "[{{fenv.h}} - Floating -point environment|http://www.opengroup.org/onlinepubs/009695399/basedefs/fenv.h.html]"
\[[SecurityFocus 07|AA. C References#SecurityFocus 07]\]

...