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/initializeEnvironment.cpp

@@ -21,6 +21,7 @@
 #include "common/format/table/TableFormatter.hpp"
 #include "common/LifoStorageCommon.hpp"
 #include "common/MemoryInfos.hpp"
+#include "logger/ExternalErrorHandler.hpp"
 #include <umpire/TypedAllocator.hpp>
 // TPL includes
 #include <umpire/ResourceManager.hpp>
@@ -67,6 +68,79 @@ 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 );
+      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 ) } } } );
+
+      GEOS_LOG( GEOS_FMT( "***** ERROR\n"
+                          "***** LOCATION: (external error, detected {})\n"
+                          "{}\n{}",
+                          detectionLocation, error.m_msg, stackHistory ) );
+      g_errorLogger.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.setType( ErrorLogger::MsgType::Error );
+      error.addSignalToMsg( signal );
+      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 } );
+
+      GEOS_LOG( GEOS_FMT( "***** ERROR\n"
+                          "***** SIGNAL: {}\n"
+                          "***** LOCATION: (external error, captured by signal handler)\n"
+                          "{}\n{}",
+                          signal, error.m_msg, stackHistory ) );
+      g_errorLogger.flushErrorMsg( error );
+
+      // call program termination
+      LvArray::system::callErrorHandler();
+    } );
+
+  }
 }
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -78,21 +152,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