Creating a default set of floating point exceptions (#199)

* Setting a default set of fp exceptions

* Avoid clang optimization in testFloatingPointExceptions

* Updating LC hostconfig tpl location to 2020-09-18

Co-authored-by: Andrea Franceschini <[email protected]>
Co-authored-by: Nicola Castelletto <[email protected]>

Author: 3 people

host-configs/LLNL/[email protected]

@@ -2,7 +2,7 @@ set(CONFIG_NAME "lassen-clang@upstream" CACHE PATH "")
 
 # Set up the tpls
 set(GEOSX_TPL_ROOT_DIR /usr/gapps/GEOSX/thirdPartyLibs CACHE PATH "")
-set(GEOSX_TPL_DIR ${GEOSX_TPL_ROOT_DIR}/2020-08-05/install-${CONFIG_NAME}-release CACHE PATH "")
+set(GEOSX_TPL_DIR ${GEOSX_TPL_ROOT_DIR}/2020-09-18/install-${CONFIG_NAME}-release CACHE PATH "")
 
 set(ENABLE_UMPIRE ON CACHE BOOL "")
 set(ENABLE_CHAI ON CACHE BOOL "")

host-configs/LLNL/[email protected]

@@ -3,7 +3,7 @@ set(CONFIG_NAME "[email protected]" CACHE PATH "")
 # Set up the tpls
 # These were probably built with clang (no guarantee that they would work)
 set(GEOSX_TPL_ROOT_DIR /usr/gapps/GEOSX/thirdPartyLibs CACHE PATH "")
-set(GEOSX_TPL_DIR ${GEOSX_TPL_ROOT_DIR}/2020-08-05/install-${CONFIG_NAME}-release CACHE PATH "")
+set(GEOSX_TPL_DIR ${GEOSX_TPL_ROOT_DIR}/2020-09-18/install-${CONFIG_NAME}-release CACHE PATH "")
 
 set(ENABLE_UMPIRE ON CACHE BOOL "")
 set(ENABLE_CHAI ON CACHE BOOL "")

host-configs/LLNL/quartz-base.cmake

@@ -23,7 +23,7 @@ set(MPIEXEC              /usr/bin/srun CACHE PATH "")
 set(MPIEXEC_NUMPROC_FLAG "-n" CACHE STRING "")
 
 set(GEOSX_TPL_ROOT_DIR /usr/gapps/GEOSX/thirdPartyLibs CACHE PATH "")
-set(GEOSX_TPL_DIR ${GEOSX_TPL_ROOT_DIR}/2020-08-05/install-${CONFIG_NAME}-release CACHE PATH "")
+set(GEOSX_TPL_DIR ${GEOSX_TPL_ROOT_DIR}/2020-09-18/install-${CONFIG_NAME}-release CACHE PATH "")
 
 set(ENABLE_UMPIRE ON CACHE BOOL "")
 set(ENABLE_CHAI ON CACHE BOOL "")

src/system.cpp

@@ -506,6 +506,11 @@ void resetSignalHandling()
   }
 }
 
+///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+int getDefaultFloatingPointExceptions()
+{
+  return ( FE_DIVBYZERO | FE_OVERFLOW | FE_INVALID );
+}
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 int enableFloatingPointExceptions( int const exceptions )
@@ -515,14 +520,13 @@ int enableFloatingPointExceptions( int const exceptions )
   // http://www-personal.umich.edu/~williams/archive/computation/fe-handling-example.c
   static fenv_t fenv;
   int const newExcepts = exceptions & FE_ALL_EXCEPT;
-  // previous masks
-  int oldExcepts;
 
   if( fegetenv( &fenv ))
   {
     return -1;
   }
-  oldExcepts = fenv.__control & FE_ALL_EXCEPT;
+  // all previous masks
+  int const oldExcepts = fenv.__control & FE_ALL_EXCEPT;
 
   // unmask
   fenv.__control &= ~newExcepts;
@@ -544,14 +548,13 @@ int disableFloatingPointExceptions( int const exceptions )
   // http://www-personal.umich.edu/~williams/archive/computation/fe-handling-example.c
   static fenv_t fenv;
   int const newExcepts = exceptions & FE_ALL_EXCEPT;
-  // all previous masks
-  int oldExcepts;
 
   if( fegetenv( &fenv ))
   {
     return -1;
   }
-  oldExcepts = fenv.__control & FE_ALL_EXCEPT;
+  // all previous masks
+  int const oldExcepts = ~( fenv.__control & FE_ALL_EXCEPT );
 
   // mask
   fenv.__control |= newExcepts;
@@ -575,13 +578,9 @@ void setFPE()
   _MM_SET_DENORMALS_ZERO_MODE( _MM_DENORMALS_ZERO_ON );
 #endif
 #if defined(__x86_64__)
-  enableFloatingPointExceptions( FE_DIVBYZERO | FE_OVERFLOW | FE_INVALID );
+  enableFloatingPointExceptions( getDefaultFloatingPointExceptions() );
 #endif
 }
 
-///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-int getAllExceptionsMask()
-{ return FE_ALL_EXCEPT; }
-
 } // namespace system
 } // namespace LvArray

src/system.hpp

@@ -82,19 +82,25 @@ void setSignalHandling( void (* handler)( int ) );
  */
 void resetSignalHandling();
 
+/**
+ * @brief Get the default set of exceptions to check.
+ * @return The default set of exceptions.
+ */
+int getDefaultFloatingPointExceptions();
+
 /**
  * @brief A wrapper around @c feenableexcept that work on OSX.
  * @param exceptions The set of floating point exceptions to enable.
  * @return The old exception mask or -1 if there was an error.
  */
-int enableFloatingPointExceptions( int const exceptions );
+int enableFloatingPointExceptions( int const exceptions = getDefaultFloatingPointExceptions() );
 
 /**
  * @brief A wrapper around @c fedisableexcept that work on OSX.
  * @param exceptions The set of floating point exceptions to disable.
  * @return The old exception mask or -1 if there was an error.
  */
-int disableFloatingPointExceptions( int const exceptions );
+int disableFloatingPointExceptions( int const exceptions = getDefaultFloatingPointExceptions() );
 
 /**
  * @brief Sets the floating point environment.
@@ -114,7 +120,7 @@ class FloatingPointExceptionGuard
    * @brief Disable the floating point exceptions given by @p exceptions.
    * @param exceptions The floating point exceptions to disable.
    */
-  FloatingPointExceptionGuard( int const exceptions ):
+  FloatingPointExceptionGuard( int const exceptions = getDefaultFloatingPointExceptions() ):
     m_previousExceptions( disableFloatingPointExceptions( exceptions ) )
   {}
 

unitTests/CMakeLists.txt

@@ -87,6 +87,11 @@ blt_add_executable( NAME testFloatingPointExceptions
                     OUTPUT_DIR ${TEST_OUTPUT_DIRECTORY}
                     DEPENDS_ON gtest lvarray ${lvarray_dependencies} )
 
+# Need to avoid optimization to catch invalid operations
+if( APPLE AND ${CMAKE_CXX_COMPILER} MATCHES "clang" )
+  set_source_files_properties( testFloatingPointExceptionsHelpers.cpp PROPERTIES COMPILE_FLAGS "-O0" )
+endif()
+
 target_include_directories( testFloatingPointExceptions PUBLIC ${CMAKE_CURRENT_LIST_DIR}/../src )
 
 blt_add_test( NAME testFloatingPointExceptions