ErrorHandling.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef INITIALIZATION_ERROR_LOGGER_HPP
#define INITIALIZATION_ERROR_LOGGER_HPP
 
#include "common/DataTypes.hpp"
 
namespace geos
{
 
class ErrorLogger
{
 
public:
  enum class MsgType
  {
    Error,
    Warning,
    Exception,
    Undefined
  };
 
  struct ErrorContext
  {
 
    enum class Attribute
    {
      InputFile,
      InputLine,
      DataPath,
      DetectionLoc,
      Signal,
    };
 
    map< Attribute, std::string > m_attributes;
 
    integer m_priority = 0;
 
    ErrorContext & setPriority( integer priority )
    { m_priority = priority; return *this; }
 
    static std::string attributeToString( Attribute attribute );
  };
 
  struct ErrorMsg
  {
    MsgType m_type = ErrorLogger::MsgType::Undefined;
    std::string m_msg;
    std::string m_cause;
    std::set< int > m_ranksInfo;
    std::string m_file;
    integer m_line = 0;
    std::vector< ErrorContext > m_contextsInfo;
    std::vector< std::string > m_sourceCallStack;
 
    ErrorMsg()
    {}
 
    ErrorMsg( MsgType msgType,
              std::string_view msgContent,
              integer rank,
              std::string_view msgFile,
              integer msgLine )
      : m_type( msgType ), m_msg( msgContent ), m_ranksInfo( {rank} ), m_file( msgFile ), m_line( msgLine ) {}
 
    ErrorMsg & addToMsg( std::exception const & e, bool toEnd = false );
 
    ErrorMsg & addToMsg( std::string_view msg, bool toEnd = false );
 
    ErrorMsg & addSignalToMsg( int signal, bool toEnd = false );
 
    ErrorMsg & setCodeLocation( std::string_view msgFile, integer msgLine );
 
    ErrorMsg & setType( MsgType msgType );
 
    ErrorMsg & setCause( std::string_view cause );
 
    ErrorMsg & addRank( int rank );
 
    ErrorMsg & addCallStackInfo( std::string_view ossStackTrace );
 
    template< typename ... Args >
    ErrorMsg & addContextInfo( Args && ... args );
 
    bool isValidStackTrace() const
    { return m_isValidStackTrace; }
 
private:
    void addContextInfoImpl( ErrorContext && ctxInfo );
 
    bool m_isValidStackTrace = false;
  };
 
  GEOS_HOST static ErrorLogger & global();
 
  bool isOutputFileEnabled() const
  { return m_writeYaml; }
 
  void enableFileOutput( bool value )
  { m_writeYaml = value; }
 
  void setOutputFilename( std::string_view filename )
  { m_filename = filename; }
 
  std::string_view getOutputFilename()
  { return m_filename; }
 
  ErrorMsg & currentErrorMsg()
  { return m_currentErrorMsg; }
 
  void createFile();
 
  static std::string toString( MsgType type );
 
  void flushErrorMsg( ErrorMsg & errorMsg );
 
private:
  ErrorMsg m_currentErrorMsg;
  bool m_writeYaml = false;
  std::string_view m_filename = "errors.yaml";
 
  void streamMultilineYamlAttribute( std::string_view msg, std::ofstream & yamlFile,
                                     std::string_view indent );
};
 
 
template< typename ... Args >
ErrorLogger::ErrorMsg & ErrorLogger::ErrorMsg::addContextInfo( Args && ... args )
{
  ( this->addContextInfoImpl( ErrorContext( args ) ), ... );
  return *this;
}
 
 
} /* namespace geos */
 
#endif