Add option to control whether pyimath uses the fp exception mechanism

Signed-off-by: Kimball Thurston <[email protected]>
AcademySoftwareFoundation · Aug 29, 2019 · be0df7b · be0df7b
1 parent 5b64c63
commit be0df7b
Show file tree

Hide file tree

Showing 9 changed files with 55 additions and 14 deletions.
diff --git a/PyIlmBase/PyImath/CMakeLists.txt b/PyIlmBase/PyImath/CMakeLists.txt
@@ -81,6 +81,6 @@ pyilmbase_define_module(imath
     PyImathVec4Impl.h
     PyImathVecOperators.h
   DEPENDENCIES
-    IlmBase::Iex IlmBase::IexMath IlmBase::Imath
+    IlmBase::Iex IlmBase::IexMath IlmBase::Imath PyIlmBase::Config
   MODULE_DEPS PyIex
   )
diff --git a/PyIlmBase/PyImath/PyImathAutovectorize.h b/PyIlmBase/PyImath/PyImathAutovectorize.h
@@ -442,7 +442,7 @@ struct VectorizedFunction1 {
         result_type retval = create_uninitalized_return_value<result_type>::apply(len);
         VectorizedOperation1<Op,result_type,arg1_type> vop(retval,arg1);
         dispatchTask(vop,len);
-        mathexcon.handleOutstandingExceptions();
+        PY_IMATH_RETURN_PYTHON;
         return retval;
     }
 
@@ -474,7 +474,7 @@ struct VectorizedFunction2 {
         result_type retval = create_uninitalized_return_value<result_type>::apply(len);
         VectorizedOperation2<Op,result_type,arg1_type,arg2_type> vop(retval,arg1,arg2);
         dispatchTask(vop,len);
-        mathexcon.handleOutstandingExceptions();
+        PY_IMATH_RETURN_PYTHON;
         return retval;
     }
 
@@ -507,7 +507,7 @@ struct VectorizedFunction3 {
         result_type retval = create_uninitalized_return_value<result_type>::apply(len);
         VectorizedOperation3<Op,result_type,arg1_type,arg2_type,arg3_type> vop(retval,arg1,arg2,arg3);
         dispatchTask(vop,len);
-        mathexcon.handleOutstandingExceptions();
+        PY_IMATH_RETURN_PYTHON;
         return retval;
     }
 
@@ -682,7 +682,7 @@ struct VectorizedVoidMemberFunction0 {
         op_precompute<Op>::apply(len);
         VectorizedVoidOperation0<Op,class_type> vop(cls);
         dispatchTask(vop,len);
-        mathexcon.handleOutstandingExceptions();
+        PY_IMATH_RETURN_PYTHON;
         return cls;
     }
 };
@@ -704,7 +704,7 @@ struct VectorizedVoidMemberFunction1 {
         op_precompute<Op>::apply(len);
         VectorizedVoidOperation1<Op,class_type,arg1_type> vop(cls,arg1);
         dispatchTask(vop,len);
-        mathexcon.handleOutstandingExceptions();
+        PY_IMATH_RETURN_PYTHON;
         return cls;
     }
 
@@ -751,7 +751,7 @@ struct VectorizedVoidMaskableMemberFunction1 {
             dispatchTask(vop,len);
         }
 
-        mathexcon.handleOutstandingExceptions();
+        PY_IMATH_RETURN_PYTHON;
         return cls;
     }
 
@@ -781,7 +781,7 @@ struct VectorizedVoidMemberFunction2 {
         op_precompute<Op>::apply(len);
         VectorizedVoidOperation2<Op,class_type,arg1_type,arg2_type> vop(cls,arg1,arg2);
         dispatchTask(vop,len);
-        mathexcon.handleOutstandingExceptions();
+        PY_IMATH_RETURN_PYTHON;
         return cls;
     }
 
@@ -812,7 +812,7 @@ struct VectorizedMemberFunction0 {
         result_type retval = create_uninitalized_return_value<result_type>::apply(len);
         VectorizedOperation1<Op,result_type,class_type> vop(retval,cls);
         dispatchTask(vop,len);
-        mathexcon.handleOutstandingExceptions();
+        PY_IMATH_RETURN_PYTHON;
         return retval;
     }
 };
@@ -836,7 +836,7 @@ struct VectorizedMemberFunction1 {
         result_type retval = create_uninitalized_return_value<result_type>::apply(len);
         VectorizedOperation2<Op,result_type,class_type,arg1_type> vop(retval,cls,arg1);
         dispatchTask(vop,len);
-        mathexcon.handleOutstandingExceptions();
+        PY_IMATH_RETURN_PYTHON;
         return retval;
     }
 
@@ -868,7 +868,7 @@ struct VectorizedMemberFunction2 {
         result_type retval = create_uninitalized_return_value<result_type>::apply(len);
         VectorizedOperation3<Op,result_type,class_type,arg1_type,arg2_type> vop(retval,cls,arg1,arg2);
         dispatchTask(vop,len);
-        mathexcon.handleOutstandingExceptions();
+        PY_IMATH_RETURN_PYTHON;
         return retval;
     }
 

diff --git a/PyIlmBase/PyImath/PyImathFixedArray.h b/PyIlmBase/PyImath/PyImathFixedArray.h
@@ -43,11 +43,18 @@
 #include <iostream>
 #include <IexMathFloatExc.h>
 #include "PyImathUtil.h"
+#include <PyIlmBaseConfigInternal.h>
 
-#define PY_IMATH_LEAVE_PYTHON IEX_NAMESPACE::MathExcOn mathexcon (IEX_NAMESPACE::IEEE_OVERFLOW | \
+#ifdef PYIMATH_ENABLE_EXCEPTIONS
+# define PY_IMATH_LEAVE_PYTHON IEX_NAMESPACE::MathExcOn mathexcon (IEX_NAMESPACE::IEEE_OVERFLOW | \
                                                         IEX_NAMESPACE::IEEE_DIVZERO |  \
                                                         IEX_NAMESPACE::IEEE_INVALID);  \
                               PyImath::PyReleaseLock pyunlock;
+# define PY_IMATH_RETURN_PYTHON mathexcon.handleOutstandingExceptions()
+#else
+# define PY_IMATH_LEAVE_PYTHON PyImath::PyReleaseLock pyunlock;
+# define PY_IMATH_RETURN_PYTHON
+#endif
 
 namespace PyImath {
 

diff --git a/PyIlmBase/PyImath/PyImathMathExc.h b/PyIlmBase/PyImath/PyImathMathExc.h
@@ -37,8 +37,12 @@
 
 #include <IexMathFloatExc.h>
 
-#define MATH_EXC_ON IEX_NAMESPACE::MathExcOn mathexcon (IEX_NAMESPACE::IEEE_OVERFLOW | \
+#ifdef PYIMATH_ENABLE_EXCEPTIONS
+# define MATH_EXC_ON IEX_NAMESPACE::MathExcOn mathexcon (IEX_NAMESPACE::IEEE_OVERFLOW | \
                                               IEX_NAMESPACE::IEEE_DIVZERO |  \
                                               IEX_NAMESPACE::IEEE_INVALID)
+#else
+# define MATH_EXC_ON
+#endif
 
 #endif
diff --git a/PyIlmBase/config/CMakeLists.txt b/PyIlmBase/config/CMakeLists.txt
@@ -4,6 +4,12 @@
 ### The autoconf setup for this folder generates a PyIlmBaseConfig.h file
 ### but no source actually uses that, so let's elide that for now
 
+configure_file(PyIlmBaseConfigInternal.h.in_cmake ${CMAKE_CURRENT_BINARY_DIR}/PyIlmBaseConfigInternal.h)
+add_library(PyIlmBaseConfig INTERFACE)
+target_include_directories(PyIlmBaseConfig INTERFACE
+  $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>)
+add_library(PyIlmBase::Config ALIAS PyIlmBaseConfig)
+
 # The main export of the configuration - This is the
 # moral equivalent of a pkg-config file for cmake
 # and replaces the Find*.cmake of the "old" cmake

diff --git a/PyIlmBase/config/ModuleDefine.cmake b/PyIlmBase/config/ModuleDefine.cmake
@@ -89,7 +89,7 @@ function(PYILMBASE_DEFINE_MODULE modname)
     list(APPEND libarglist CURDIR ${PYILMBASE_CURMOD_CURDIR})
   endif()
   if(PYILMBASE_CURMOD_CURBINDIR)
-    list(APPEND libarglist CURDIR ${PYILMBASE_CURMOD_CURBINDIR})
+    list(APPEND libarglist CURBINDIR ${PYILMBASE_CURMOD_CURBINDIR})
   endif()
   if(PYILMBASE_CURMOD_DEPENDENCIES)
     list(APPEND libarglist DEPENDENCIES ${PYILMBASE_CURMOD_DEPENDENCIES})

diff --git a/PyIlmBase/config/PyIlmBaseConfigInternal.h.in b/PyIlmBase/config/PyIlmBaseConfigInternal.h.in
@@ -0,0 +1,11 @@
+//
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright Contributors to the OpenEXR Project.
+//
+
+#pragma once
+
+//
+// Dealing with FPEs
+//
+#undef PYIMATH_ENABLE_EXCEPTIONS
diff --git a/PyIlmBase/config/PyIlmBaseConfigInternal.h.in_cmake b/PyIlmBase/config/PyIlmBaseConfigInternal.h.in_cmake
@@ -0,0 +1,9 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright Contributors to the OpenEXR Project.
+
+#pragma once
+
+//
+// Dealing with FPEs
+//
+#cmakedefine PYIMATH_ENABLE_EXCEPTIONS 0
diff --git a/PyIlmBase/config/PyIlmBaseSetup.cmake b/PyIlmBase/config/PyIlmBaseSetup.cmake
@@ -10,6 +10,10 @@ include(GNUInstallDirs)
 set(PYILMBASE_OVERRIDE_PYTHON2_INSTALL_DIR "" CACHE STRING "Override the install location for any python 2.x modules compiled")
 set(PYILMBASE_OVERRIDE_PYTHON3_INSTALL_DIR "" CACHE STRING "Override the install location for any python 3.x modules compiled")
 
+# Enables tracking of floating point exceptions and throwing them
+# as the signals are received
+option(PYIMATH_ENABLE_EXCEPTIONS "Enable runtime floating point exceptions" OFF)
+
 # What C++ standard to compile for
 # VFX Platform 18 is c++14, so let's enable that by default
 set(tmp 14)