2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012,2013, 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.
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.
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.
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.
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.
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.
37 * Implements functions in errorcodes.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_utility
42 #include "gromacs/utility/errorcodes.h"
46 #include "gromacs/legacyheaders/thread_mpi/mutex.h"
48 #include "errorformat.h"
56 //! \addtogroup module_utility
60 * Strings corresponding to gmx::ErrorCode values.
62 * This has to match the enum in errorcodes.h!
64 const char *const error_names[] =
70 "Error in user input",
71 "Inconsistency in user input",
72 "Simulation instability detected",
74 "Feature not implemented",
75 "Invalid value (bug)",
77 "Internal error (bug)",
79 "Range checking error (possible bug)",
80 "Communication error (possible bug)",
86 * The default error handler if setFatalErrorHandler() is not called.
88 void standardErrorHandler(int retcode, const char *msg,
89 const char *file, int line)
91 const char *title = getErrorCodeString(retcode);
92 internal::printFatalErrorHeader(stderr, title, NULL, file, line);
93 internal::printFatalErrorMessageLine(stderr, msg, 0);
94 internal::printFatalErrorFooter(stderr);
98 //! Global error handler set with setFatalErrorHandler().
99 ErrorHandlerFunc g_errorHandler = standardErrorHandler;
100 //! Mutex for protecting access to ::g_errorHandler.
101 tMPI::mutex handler_mutex;
107 const char *getErrorCodeString(int errorcode)
109 if (errorcode < 0 || errorcode >= eeUnknownError)
111 errorcode = eeUnknownError;
113 return error_names[errorcode];
116 ErrorHandlerFunc setFatalErrorHandler(ErrorHandlerFunc handler)
118 tMPI::lock_guard<tMPI::mutex> lock(handler_mutex);
119 ErrorHandlerFunc oldHandler = g_errorHandler;
120 g_errorHandler = handler;
124 /*! \cond internal */
128 void fatalError(int retcode, const char *msg, const char *file, int line)
130 ErrorHandlerFunc handler = NULL;
132 tMPI::lock_guard<tMPI::mutex> lock(handler_mutex);
133 handler = g_errorHandler;
137 handler(retcode, msg, file, line);
141 } // namespace internal