error_handling.hh

Go to the documentation of this file.

/* Copyright (C) 2014, 2015, 2016, 2018, 2019, 2021, 2023 PISM Authors
 *
 * This file is part of PISM.
 *
 * PISM is free software; you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * PISM is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with PISM; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef PISM_ERROR_HANDLING_H
#define PISM_ERROR_HANDLING_H
 
#include <mpi.h>                // MPI_Comm
#include <stdexcept>
#include <string>
#include <vector>
 
#include "pism/pism_config.hh"  // Pism_DEBUG
 
namespace pism {
 
class ErrorLocation {
public:
  ErrorLocation();
  ErrorLocation(const char *filename, int line);
  const char *filename;
  int line_number;
};
 
#if (Pism_DEBUG==1)
#define PISM_ERROR_LOCATION pism::ErrorLocation(__FILE__, __LINE__)
#else
#define PISM_ERROR_LOCATION pism::ErrorLocation()
#endif
 
class RuntimeError : public std::runtime_error {
public:
  RuntimeError(const ErrorLocation &location, const std::string &message);
  ~RuntimeError() throw();
 
  typedef void (*Hook)(RuntimeError*);
 
  //! @brief build a RuntimeError with a formatted message
  static RuntimeError formatted(const ErrorLocation &location, const char format[], ...) __attribute__((format(printf, 2, 3)));
 
  static void set_hook(Hook new_hook);
 
  //! @brief Add a message providing some context. This way we can (sort of)
  //! get a stack trace even though C++ exceptions do not provide one.
  void add_context(const std::string &message);
  void add_context(const char format[], ...) __attribute__((format(printf, 2, 3)));
  void print(MPI_Comm com);
  protected:
  std::vector<std::string> m_context;
  static Hook sm_hook;
  ErrorLocation m_location;
};
 
class ParallelSection {
public:
  ParallelSection(MPI_Comm com);
  ~ParallelSection() = default;
  void check();
  void failed();
  void reset();
private:
  bool m_failed;
  MPI_Comm m_com;
};
 
void handle_fatal_errors(MPI_Comm com);
 
void check_c_call(int errcode, int success, const char* function_name,
                  const char *file, int line);
 
void check_petsc_call(int errcode, const char* function_name,
                      const char *file, int line);
 
#define PISM_C_CHK(errcode,success,name) do { pism::check_c_call(errcode, success, name, __FILE__, __LINE__); } while (0)
#define PISM_CHK(errcode,name) do { pism::check_petsc_call(errcode, name, __FILE__, __LINE__); } while (0)
 
} // end of namespace pism
 
#endif /* PISM_ERROR_HANDLING_H */