src/gromacs/utility/errorcodes.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements functions in errorcodes.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "gromacs/utility/errorcodes.h"
  45
  46 #include <cstdlib>
  47
  48 #include "thread_mpi/mutex.h"
  49
  50 #include "errorformat.h"
  51
  52 namespace gmx
  53 {
  54
  55 namespace
  56 {
  57
  58 //! \addtogroup module_utility
  59 //! \{
  60
  61 /*! \brief
  62  * Strings corresponding to gmx::ErrorCode values.
  63  *
  64  * This has to match the enum in errorcodes.h!
  65  */
  66 const char *const error_names[] =
  67 {
  68     "No error",
  69     "Out of memory",
  70     "File not found",
  71     "System I/O error",
  72     "Error in user input",
  73     "Inconsistency in user input",
  74     "Simulation instability detected",
  75
  76     "Feature not implemented",
  77     "Invalid value (bug)",
  78     "Invalid call (bug)",
  79     "Internal error (bug)",
  80     "API error (bug)",
  81     "Range checking error (possible bug)",
  82     "Communication error (possible bug)",
  83
  84     "Unknown error",
  85 };
  86
  87 /*! \brief
  88  * The default error handler if setFatalErrorHandler() is not called.
  89  */
  90 void standardErrorHandler(int retcode, const char *msg,
  91                           const char *file, int line)
  92 {
  93     const char *title = getErrorCodeString(retcode);
  94     internal::printFatalErrorHeader(stderr, title, NULL, file, line);
  95     internal::printFatalErrorMessageLine(stderr, msg, 0);
  96     internal::printFatalErrorFooter(stderr);
  97     std::exit(1);
  98 }
  99
 100 //! Global error handler set with setFatalErrorHandler().
 101 ErrorHandlerFunc g_errorHandler = standardErrorHandler;
 102 //! Mutex for protecting access to ::g_errorHandler.
 103 tMPI::mutex      handler_mutex;
 104
 105 //! \}
 106
 107 }   // namespace
 108
 109 const char *getErrorCodeString(int errorcode)
 110 {
 111     if (errorcode < 0 || errorcode >= eeUnknownError)
 112     {
 113         errorcode = eeUnknownError;
 114     }
 115     return error_names[errorcode];
 116 }
 117
 118 ErrorHandlerFunc setFatalErrorHandler(ErrorHandlerFunc handler)
 119 {
 120     tMPI::lock_guard<tMPI::mutex> lock(handler_mutex);
 121     ErrorHandlerFunc              oldHandler = g_errorHandler;
 122     g_errorHandler = handler;
 123     return oldHandler;
 124 }
 125
 126 /*! \cond internal */
 127 namespace internal
 128 {
 129
 130 void fatalError(int retcode, const char *msg, const char *file, int line)
 131 {
 132     ErrorHandlerFunc handler = NULL;
 133     {
 134         tMPI::lock_guard<tMPI::mutex> lock(handler_mutex);
 135         handler = g_errorHandler;
 136     }
 137     if (handler != NULL)
 138     {
 139         handler(retcode, msg, file, line);
 140     }
 141 }
 142
 143 }   // namespace internal
 144 //! \endcond
 145
 146 } // namespace gmx