src/gromacs/utility/errorcodes.cpp

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13  *
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Implements functions in errorcodes.h.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_utility
  37  */
  38 #include "gromacs/utility/errorcodes.h"
  39
  40 #include <cstdlib>
  41
  42 #include "gromacs/legacyheaders/thread_mpi/mutex.h"
  43
  44 #include "errorformat.h"
  45
  46 namespace gmx
  47 {
  48
  49 namespace
  50 {
  51
  52 /*! \brief
  53  * Strings corresponding to gmx::ErrorCode values.
  54  *
  55  * This has to match the enum in errorcodes.h!
  56  */
  57 const char *const error_names[] =
  58 {
  59     "No error",
  60     "Out of memory",
  61     "File not found",
  62     "System I/O error",
  63     "Error in user input",
  64     "Inconsistency in user input",
  65     "Simulation instability detected",
  66
  67     "Feature not implemented",
  68     "Invalid value (bug)",
  69     "Invalid call (bug)",
  70     "Internal error (bug)",
  71     "API error (bug)",
  72     "Range checking error (possible bug)",
  73     "Communication error (possible bug)",
  74
  75     "Unknown error",
  76 };
  77
  78 /*! \brief
  79  * The default error handler if setFatalErrorHandler() is not called.
  80  */
  81 void standardErrorHandler(int retcode, const char *msg,
  82                           const char *file, int line)
  83 {
  84     const char *title = getErrorCodeString(retcode);
  85     internal::printFatalErrorHeader(stderr, title, NULL, file, line);
  86     internal::printFatalErrorMessageLine(stderr, msg, 0);
  87     internal::printFatalErrorFooter(stderr);
  88     std::exit(1);
  89 }
  90
  91 //! Global error handler set with setFatalErrorHandler().
  92 ErrorHandlerFunc g_errorHandler = standardErrorHandler;
  93 //! Mutex for protecting access to g_errorHandler.
  94 tMPI::mutex handler_mutex;
  95
  96 } // namespace
  97
  98 const char *getErrorCodeString(int errorcode)
  99 {
 100     if (errorcode < 0 || errorcode >= eeUnknownError)
 101     {
 102         errorcode = eeUnknownError;
 103     }
 104     return error_names[errorcode];
 105 }
 106
 107 ErrorHandlerFunc setFatalErrorHandler(ErrorHandlerFunc handler)
 108 {
 109     tMPI::lock_guard<tMPI::mutex> lock(handler_mutex);
 110     ErrorHandlerFunc oldHandler = g_errorHandler;
 111     g_errorHandler = handler;
 112     return oldHandler;
 113 }
 114
 115 /*! \cond internal */
 116 namespace internal
 117 {
 118
 119 void fatalError(int retcode, const char *msg, const char *file, int line)
 120 {
 121     ErrorHandlerFunc handler = NULL;
 122     {
 123         tMPI::lock_guard<tMPI::mutex> lock(handler_mutex);
 124         handler = g_errorHandler;
 125     }
 126     if (handler != NULL)
 127     {
 128         handler(retcode, msg, file, line);
 129     }
 130 }
 131
 132 } // namespace internal
 133 //! \endcond
 134
 135 } // namespace gmx