src/gromacs/utility/errorcodes.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 "gromacs/utility/errorcodes.h"
  43
  44 #include <cstdlib>
  45
  46 #include "gromacs/legacyheaders/thread_mpi/mutex.h"
  47
  48 #include "errorformat.h"
  49
  50 namespace gmx
  51 {
  52
  53 namespace
  54 {
  55
  56 /*! \brief
  57  * Strings corresponding to gmx::ErrorCode values.
  58  *
  59  * This has to match the enum in errorcodes.h!
  60  */
  61 const char *const error_names[] =
  62 {
  63     "No error",
  64     "Out of memory",
  65     "File not found",
  66     "System I/O error",
  67     "Error in user input",
  68     "Inconsistency in user input",
  69     "Simulation instability detected",
  70
  71     "Feature not implemented",
  72     "Invalid value (bug)",
  73     "Invalid call (bug)",
  74     "Internal error (bug)",
  75     "API error (bug)",
  76     "Range checking error (possible bug)",
  77     "Communication error (possible bug)",
  78
  79     "Unknown error",
  80 };
  81
  82 /*! \brief
  83  * The default error handler if setFatalErrorHandler() is not called.
  84  */
  85 void standardErrorHandler(int retcode, const char *msg,
  86                           const char *file, int line)
  87 {
  88     const char *title = getErrorCodeString(retcode);
  89     internal::printFatalErrorHeader(stderr, title, NULL, file, line);
  90     internal::printFatalErrorMessageLine(stderr, msg, 0);
  91     internal::printFatalErrorFooter(stderr);
  92     std::exit(1);
  93 }
  94
  95 //! Global error handler set with setFatalErrorHandler().
  96 ErrorHandlerFunc g_errorHandler = standardErrorHandler;
  97 //! Mutex for protecting access to g_errorHandler.
  98 tMPI::mutex      handler_mutex;
  99
 100 }   // namespace
 101
 102 const char *getErrorCodeString(int errorcode)
 103 {
 104     if (errorcode < 0 || errorcode >= eeUnknownError)
 105     {
 106         errorcode = eeUnknownError;
 107     }
 108     return error_names[errorcode];
 109 }
 110
 111 ErrorHandlerFunc setFatalErrorHandler(ErrorHandlerFunc handler)
 112 {
 113     tMPI::lock_guard<tMPI::mutex> lock(handler_mutex);
 114     ErrorHandlerFunc              oldHandler = g_errorHandler;
 115     g_errorHandler = handler;
 116     return oldHandler;
 117 }
 118
 119 /*! \cond internal */
 120 namespace internal
 121 {
 122
 123 void fatalError(int retcode, const char *msg, const char *file, int line)
 124 {
 125     ErrorHandlerFunc handler = NULL;
 126     {
 127         tMPI::lock_guard<tMPI::mutex> lock(handler_mutex);
 128         handler = g_errorHandler;
 129     }
 130     if (handler != NULL)
 131     {
 132         handler(retcode, msg, file, line);
 133     }
 134 }
 135
 136 }   // namespace internal
 137 //! \endcond
 138
 139 } // namespace gmx