feat: Adding signal and external error detection & output

src/coreComponents/common/CMakeLists.txt

@@ -19,7 +19,6 @@ Also provides commonly used components for such as logging, formatting, memory a
  dependencies.
 #]]
 
-
 #
 # Specify all headers
 #
@@ -32,7 +31,6 @@ set( common_headers
      format/LogPart.hpp
      format/Format.hpp
      format/StringUtilities.hpp
-     logger/Logger.hpp
      BufferAllocator.hpp
      DataLayouts.hpp
      DataTypes.hpp
@@ -41,6 +39,8 @@ set( common_headers
      GeosxMacros.hpp
      MemoryInfos.hpp
      logger/Logger.hpp
+     logger/ErrorHandling.hpp
+     logger/ExternalErrorHandler.hpp
      MpiWrapper.hpp
      Path.hpp
      Span.hpp
@@ -76,6 +76,8 @@ set( common_sources
      format/LogPart.cpp
      format/StringUtilities.cpp
      logger/Logger.cpp
+     logger/ErrorHandling.cpp
+     logger/ExternalErrorHandler.cpp
      BufferAllocator.cpp
      MemoryInfos.cpp
      MpiWrapper.cpp

src/coreComponents/common/GeosxMacros.hpp

@@ -133,4 +133,71 @@ void i_g_n_o_r_e( ARGS const & ... ) {}
     #endif
 #endif
 
+/**
+ * @name Parameters processing internal macros
+ *
+ * These internal macros allow to craft macros with multiple count of parameters.
+ */
+///@{
+
+/// internal macro for GEOS_DETAIL_MORE_THAN_ONE_ARG
+#define GEOS_DETAIL_MORE_THAN_ONE_ARG_VALUE( _00, _01, _02, _03, _04, _05, _06, _07, \
+                                             _08, _09, _10, _11, _12, _13, _14, _15, \
+                                             _INDEX, ... ) _INDEX
+
+/**
+ * @return 1 if variadic argument has more than 1 element, 0 otherwise.
+ * @note Undefined behaviour if variadic argument has more that 16 elements.
+ */
+#define GEOS_DETAIL_MORE_THAN_ONE_ARG( ... ) \
+  GEOS_DETAIL_MORE_THAN_ONE_ARG_VALUE( __VA_ARGS__, \
+                                       true, true, true, true, true, true, true, true, \
+                                       true, true, true, true, true, true, true, false, false )
+
+/// @cond DO_NOT_DOCUMENT
+
+/// internal macros for GEOS_DETAIL_FIRST_ARG
+#define GEOS_DETAIL_FIRST_ARG_false( FIRST ) FIRST
+#define GEOS_DETAIL_FIRST_ARG_true( FIRST, ... ) FIRST
+#define GEOS_DETAIL_FIRST_ARG_FUNC( COND ) GEOS_DETAIL_FIRST_ARG_ ## COND
+#define GEOS_DETAIL_FIRST_ARG_DISPATCH( COND, ... ) GEOS_DETAIL_FIRST_ARG_FUNC( COND )(__VA_ARGS__)
+
+/// internal macros for GEOS_DETAIL_LAST_ARG
+#define GEOS_DETAIL_REST_ARGS_false( FIRST )
+#define GEOS_DETAIL_REST_ARGS_true( FIRST, ... ) __VA_ARGS__
+#define GEOS_DETAIL_REST_ARGS_FUNC( COND ) GEOS_DETAIL_REST_ARGS_ ## COND
+#define GEOS_DETAIL_REST_ARGS_DISPATCH( COND, ... ) GEOS_DETAIL_REST_ARGS_FUNC( COND )(__VA_ARGS__)
+
+/// internal macros for GEOS_DETAIL_LAST_ARG_PREP
+#define GEOS_DETAIL_REST_PREP_ARGS_false( FIRST )
+#define GEOS_DETAIL_REST_PREP_ARGS_true( FIRST, ... ) , __VA_ARGS__
+#define GEOS_DETAIL_REST_PREP_ARGS_FUNC( COND ) GEOS_DETAIL_REST_PREP_ARGS_ ## COND
+#define GEOS_DETAIL_REST_PREP_ARGS_DISPATCH( COND, ... ) GEOS_DETAIL_REST_PREP_ARGS_FUNC( COND )(__VA_ARGS__)
+
+/// @endcond
+
+/**
+ * @return Return the first parameter of the variadic parameters (__VA_ARGS__).
+ * @note Undefined behaviour if variadic argument has more that 16 elements.
+ */
+#define GEOS_DETAIL_FIRST_ARG( ... ) GEOS_DETAIL_FIRST_ARG_DISPATCH( GEOS_DETAIL_MORE_THAN_ONE_ARG( __VA_ARGS__ ), \
+                                                                     __VA_ARGS__ )
+
+/**
+ * @return Return the parameters following the first of the variadic parameters (__VA_ARGS__).
+ * @note Undefined behaviour if variadic argument has more that 16 elements.
+ */
+#define GEOS_DETAIL_REST_ARGS( ... ) GEOS_DETAIL_REST_ARGS_DISPATCH( GEOS_DETAIL_MORE_THAN_ONE_ARG( __VA_ARGS__ ), \
+                                                                     __VA_ARGS__ )
+
+/**
+ * @return Return the parameters following the first of the variadic parameters (__VA_ARGS__),
+ *         prepended with a comma when not empty.
+ * @note Undefined behaviour if variadic argument has more that 16 elements.
+ */
+#define GEOS_DETAIL_REST_PREP_ARGS( ... ) GEOS_DETAIL_REST_PREP_ARGS_DISPATCH( GEOS_DETAIL_MORE_THAN_ONE_ARG( __VA_ARGS__ ), \
+                                                                               __VA_ARGS__ )
+
+///@}
+
 #endif // GEOS_COMMON_GEOSXMACROS_HPP_

src/coreComponents/common/initializeEnvironment.cpp

@@ -20,6 +20,8 @@
 #include "LvArray/src/system.hpp"
 #include "common/LifoStorageCommon.hpp"
 #include "common/MemoryInfos.hpp"
+#include "logger/ErrorHandling.hpp"
+#include "logger/ExternalErrorHandler.hpp"
 #include <umpire/TypedAllocator.hpp>
 // TPL includes
 #include <umpire/ResourceManager.hpp>
@@ -66,6 +68,88 @@ void setupLogger()
 #else
   logger::InitializeLogger();
 #endif
+
+  { // setup error handling (using LvArray helper system functions)
+    using ErrorContext = ErrorLogger::ErrorContext;
+
+    ///// set Post-Handled Error behaviour /////
+    LvArray::system::setErrorHandler( []()
+    {
+  #if defined( GEOS_USE_MPI )
+      int mpi = 0;
+      MPI_Initialized( &mpi );
+      if( mpi )
+      {
+        MPI_Abort( MPI_COMM_WORLD, EXIT_FAILURE );
+      }
+  #endif
+      std::abort();
+    } );
+
+    ///// set external error handling behaviour /////
+    ExternalErrorHandler::instance().setErrorHandling( []( string_view errorMsg,
+                                                           string_view detectionLocation )
+    {
+      std::string const stackHistory = LvArray::system::stackTrace( true );
+
+      GEOS_LOG( GEOS_FMT( "***** ERROR\n"
+                          "***** LOCATION: (external error, detected {})\n"
+                          "{}\n{}",
+                          detectionLocation, errorMsg, stackHistory ) );
+      if( ErrorLogger::global().isOutputFileEnabled() )
+      {
+        ErrorLogger::ErrorMsg error;
+        error.setType( ErrorLogger::MsgType::Error );
+        error.addToMsg( errorMsg );
+        error.setRank( ::geos::logger::internal::rank() );
+        error.addCallStackInfo( stackHistory );
+        error.addContextInfo(
+          ErrorContext{ { { ErrorContext::Attribute::DetectionLoc, string( detectionLocation ) } } } );
+
+        ErrorLogger::global().flushErrorMsg( error );
+      }
+
+      // we do not terminate the program as 1. the error could be non-fatal, 2. there may be more messages to output.
+    } );
+    ExternalErrorHandler::instance().enableStderrPipe( true );
+
+    ///// set signal handling behaviour /////
+    LvArray::system::setSignalHandling( []( int const signal )
+    {
+      // Disable signal handling to prevent catching exit signal (infinite loop)
+      LvArray::system::setSignalHandling( nullptr );
+
+      // first of all, external error can await to be output, we must output them
+      ExternalErrorHandler::instance().flush( "before signal error output" );
+
+      // error message output
+      std::string const stackHistory = LvArray::system::stackTrace( true );
+      ErrorLogger::ErrorMsg error;
+      error.addSignalToMsg( signal );
+
+      GEOS_LOG( GEOS_FMT( "***** ERROR\n"
+                          "***** SIGNAL: {}\n"
+                          "***** LOCATION: (external error, captured by signal handler)\n"
+                          "{}\n{}",
+                          signal, error.m_msg, stackHistory ) );
+
+      if( ErrorLogger::global().isOutputFileEnabled() )
+      {
+        error.setType( ErrorLogger::MsgType::Error );
+        error.setRank( ::geos::logger::internal::rank() );
+        error.addCallStackInfo( stackHistory );
+        error.addContextInfo(
+          ErrorContext{ { { ErrorContext::Attribute::Signal, std::to_string( signal ) } }, 1 },
+          ErrorContext{ { { ErrorContext::Attribute::DetectionLoc, string( "signal handler" ) } }, 0 } );
+
+        ErrorLogger::global().flushErrorMsg( error );
+      }
+
+      // call program termination
+      LvArray::system::callErrorHandler();
+    } );
+
+  }
 }
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -77,21 +161,6 @@ void finalizeLogger()
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 void setupLvArray()
 {
-  LvArray::system::setErrorHandler( []()
-  {
-  #if defined( GEOS_USE_MPI )
-    int mpi = 0;
-    MPI_Initialized( &mpi );
-    if( mpi )
-    {
-      MPI_Abort( MPI_COMM_WORLD, EXIT_FAILURE );
-    }
-  #endif
-    std::abort();
-  } );
-
-  LvArray::system::setSignalHandling( []( int const signal ) { LvArray::system::stackTraceHandler( signal, true ); } );
-
 #if defined(GEOS_USE_FPE)
   LvArray::system::setFPE();
 #else