2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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 classes and functions in exceptions.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_utility
42 #include "exceptions.h"
54 #include <boost/exception/get_error_info.hpp>
55 #include <boost/shared_ptr.hpp>
57 #include "gromacs/legacyheaders/network.h"
58 #include "gromacs/legacyheaders/thread_mpi/system_error.h"
59 #include "gromacs/utility/errorcodes.h"
60 #include "gromacs/utility/gmxassert.h"
61 #include "gromacs/utility/stringutil.h"
63 #include "errorformat.h"
71 /********************************************************************
76 * Error message or error context text item.
78 * Error messages for an exception are represented as a chain of ErrorMessage
79 * objects: the elements at the bottom of the chain (with no children) is the
80 * error message, and other elements are the context strings added.
82 * \ingroup module_utility
88 * Creates an error message object with the specified text.
90 * \param[in] text Text for the message.
92 explicit ErrorMessage(const std::string &text);
94 //! Whether this object is a context string.
95 bool isContext() const { return static_cast<bool>(child_); }
96 //! Returns the text for this object.
97 const std::string &text() const { return text_; }
99 * Returns the child object for a context object.
101 * Must not be called if isContext() returns false.
103 const ErrorMessage &child() const
105 GMX_ASSERT(isContext(),
106 "Attempting to access nonexistent message object");
111 * Creates a new message object with context prepended.
113 * \param[in] context Context string to add.
114 * \returns New error message object that has \p context as its text
115 * and \c this as its child.
116 * \throws std::bad_alloc if out of memory.
118 ErrorMessage prependContext(const std::string &context) const;
122 boost::shared_ptr<ErrorMessage> child_;
126 * Stores a reason or the top-most context string of an exception.
128 * \ingroup module_utility
130 typedef boost::error_info<struct errinfo_message_, ErrorMessage>
133 ErrorMessage::ErrorMessage(const std::string &text)
136 size_t length = text_.find_last_not_of(" \n");
137 if (length == std::string::npos)
139 length = text_.length() - 1;
141 text_.resize(length + 1);
145 ErrorMessage::prependContext(const std::string &context) const
147 ErrorMessage newMessage(context);
148 newMessage.child_.reset(new ErrorMessage(*this));
153 * Stores list of nested exceptions for Gromacs exceptions.
155 * \ingroup module_utility
157 typedef boost::error_info<struct errinfo_message_, internal::NestedExceptionList>
158 errinfo_nested_exceptions;
162 /********************************************************************
166 GromacsException::GromacsException(const ExceptionInitializer &details)
168 *this << errinfo_message(ErrorMessage(details.reason_));
169 if (details.hasNestedExceptions())
171 *this << errinfo_nested_exceptions(details.nested_);
175 const char *GromacsException::what() const throw()
177 const ErrorMessage *msg = boost::get_error_info<errinfo_message>(*this);
178 while (msg != NULL && msg->isContext())
182 return msg != NULL ? msg->text().c_str() : "No reason provided";
185 void GromacsException::prependContext(const std::string &context)
187 const ErrorMessage *msg = boost::get_error_info<errinfo_message>(*this);
188 GMX_RELEASE_ASSERT(msg != NULL, "Message should always be set");
189 *this << errinfo_message(msg->prependContext(context));
192 /********************************************************************
193 * Derived exception classes
196 int FileIOError::errorCode() const
201 int InvalidInputError::errorCode() const
203 return eeInvalidInput;
206 int InconsistentInputError::errorCode() const
208 return eeInconsistentInput;
211 int SimulationInstabilityError::errorCode() const
213 return eeInstability;
216 int InternalError::errorCode() const
218 return eeInternalError;
221 int APIError::errorCode() const
226 int NotImplementedError::errorCode() const
228 return eeNotImplemented;
232 /********************************************************************
239 //! \addtogroup module_utility
243 * Abstracts actual output from the other logic in exception formatting.
245 * Object that implements this interface is passed to
246 * formatExceptionMessageInternal(), and is responsible for composing the
247 * output. This allows using the same implementation of interpreting the
248 * exceptions while still supporting output to different formats (e.g., to a
249 * string or to \c stderr).
251 class MessageWriterInterface
254 virtual ~MessageWriterInterface() {}
257 * Writes a single line of text into the output.
259 * \param[in] text Text to write on the line.
260 * \param[in] indent Suggested number of spaces to indent the line.
262 virtual void writeLine(const char *text, int indent) = 0;
264 * Writes information about a system error (errno-based).
266 * \param[in] errorNumber errno value
267 * \param[in] funcName Name of the system call (can be NULL).
268 * \param[in] indent Suggested number of spaces to indent the output.
270 virtual void writeErrNoInfo(int errorNumber, const char *funcName,
275 * Exception information writer for cases where exceptions should be avoided.
277 * Formats the messages into the provided FILE handle without checking for
278 * errors in std::fprintf() calls.
280 class MessageWriterFileNoThrow : public MessageWriterInterface
283 //! Initializes a writer that writes to the given file handle.
284 explicit MessageWriterFileNoThrow(FILE *fp) : fp_(fp) {}
286 virtual void writeLine(const char *text, int indent)
288 internal::printFatalErrorMessageLine(fp_, text, indent);
290 virtual void writeErrNoInfo(int errorNumber, const char *funcName,
293 std::fprintf(fp_, "%*sReason: %s\n", indent, "",
294 std::strerror(errorNumber));
295 if (funcName != NULL)
297 std::fprintf(fp_, "%*s(call to %s() returned error code %d)\n",
298 indent, "", funcName, errorNumber);
307 * Exception information writer to format into an std::string.
309 class MessageWriterString : public MessageWriterInterface
312 //! Post-processes the output string to not end in a line feed.
313 void removeTerminatingLineFeed()
315 if (result_.size() > 0U)
317 result_.erase(result_.size() - 1);
320 //! Returns the constructed string.
321 const std::string &result() const { return result_; }
323 virtual void writeLine(const char *text, int indent)
325 result_.append(indent, ' ');
326 result_.append(text);
327 result_.append("\n");
329 virtual void writeErrNoInfo(int errorNumber, const char *funcName,
332 writeLine(formatString("Reason: %s", std::strerror(errorNumber)).c_str(),
334 if (funcName != NULL)
336 writeLine(formatString("(call to %s() returned error code %d)",
337 funcName, errorNumber).c_str(),
347 * Prints error information for an exception object.
349 * \param[in] writer Writer to write out the information.
350 * \param[in] ex Exception object to print.
351 * \param[in] indent Indentation for the information.
353 * If the exception contains nested exceptions, information from them is
354 * recursively printed.
356 * Does not throw unless the writer throws.
358 void formatExceptionMessageInternal(MessageWriterInterface *writer,
359 const std::exception &ex, int indent)
361 const boost::exception *boostEx = dynamic_cast<const boost::exception *>(&ex);
364 // TODO: Add an option to print this information for the tests
365 // const char *const *funcPtr =
366 // boost::get_error_info<boost::throw_function>(*boostEx);
367 // const char *const *filePtr =
368 // boost::get_error_info<boost::throw_file>(*boostEx);
369 // const int *linePtr =
370 // boost::get_error_info<boost::throw_line>(*boostEx);
372 // std::string result;
373 // if (filePtr != NULL && linePtr != NULL)
375 // result = formatString("%s:%d: %s\n", *filePtr, *linePtr,
376 // funcPtr != NULL ? *funcPtr : "");
379 // TODO: Remove duplicate context if present in multiple nested exceptions.
380 const ErrorMessage *msg = boost::get_error_info<errinfo_message>(*boostEx);
383 while (msg != NULL && msg->isContext())
385 writer->writeLine(msg->text().c_str(), indent*2);
389 if (msg != NULL && !msg->text().empty())
391 writer->writeLine(msg->text().c_str(), indent*2);
396 writer->writeLine(ex.what(), indent*2);
399 const int *errorNumber
400 = boost::get_error_info<boost::errinfo_errno>(*boostEx);
401 if (errorNumber != NULL)
403 const char * const *funcName
404 = boost::get_error_info<boost::errinfo_api_function>(*boostEx);
405 writer->writeErrNoInfo(*errorNumber,
406 funcName != NULL ? *funcName : NULL,
410 // TODO: Treat also boost::nested_exception (not currently used, though)
412 const internal::NestedExceptionList *nested
413 = boost::get_error_info<errinfo_nested_exceptions>(*boostEx);
416 internal::NestedExceptionList::const_iterator ni;
417 for (ni = nested->begin(); ni != nested->end(); ++ni)
421 rethrow_exception(*ni);
423 catch (const std::exception &nestedEx)
425 formatExceptionMessageInternal(writer, nestedEx, indent + 1);
432 writer->writeLine(ex.what(), indent*2);
440 void printFatalErrorMessage(FILE *fp, const std::exception &ex)
442 const char *title = "Unknown exception";
443 bool bPrintType = false;
444 const GromacsException *gmxEx = dynamic_cast<const GromacsException *>(&ex);
445 // TODO: Treat more of the standard exceptions
448 title = getErrorCodeString(gmxEx->errorCode());
450 else if (dynamic_cast<const tMPI::system_error *>(&ex) != NULL)
452 title = "System error in thread synchronization";
454 else if (dynamic_cast<const std::bad_alloc *>(&ex) != NULL)
456 title = "Memory allocation failed";
458 else if (dynamic_cast<const std::logic_error *>(&ex) != NULL)
460 title = "Standard library logic error (bug)";
463 else if (dynamic_cast<const std::runtime_error *>(&ex) != NULL)
465 title = "Standard library runtime error (possible bug)";
472 // We can't call get_error_info directly on ex since our internal boost
473 // needs to be compiled with BOOST_NO_RTTI. So we do the dynamic_cast
475 const char *const *funcPtr = NULL;
476 const char *const *filePtr = NULL;
477 const int *linePtr = NULL;
478 const boost::exception *boostEx = dynamic_cast<const boost::exception *>(&ex);
481 funcPtr = boost::get_error_info<boost::throw_function>(*boostEx);
482 filePtr = boost::get_error_info<boost::throw_file>(*boostEx);
483 linePtr = boost::get_error_info<boost::throw_line>(*boostEx);
485 internal::printFatalErrorHeader(fp, title,
486 funcPtr != NULL ? *funcPtr : NULL,
487 filePtr != NULL ? *filePtr : NULL,
488 linePtr != NULL ? *linePtr : 0);
491 std::fprintf(fp, "(exception type: %s)\n", typeid(ex).name());
493 MessageWriterFileNoThrow writer(fp);
494 formatExceptionMessageInternal(&writer, ex, 0);
495 internal::printFatalErrorFooter(fp);
498 std::string formatExceptionMessageToString(const std::exception &ex)
500 MessageWriterString writer;
501 formatExceptionMessageInternal(&writer, ex, 0);
502 writer.removeTerminatingLineFeed();
503 return writer.result();
506 void formatExceptionMessageToFile(FILE *fp, const std::exception &ex)
508 MessageWriterFileNoThrow writer(fp);
509 formatExceptionMessageInternal(&writer, ex, 0);
512 int processExceptionAtExit(const std::exception & /*ex*/)
516 // TODO: Consider moving the output done in gmx_abort() into the message
517 // printing routine above, so that this could become a simple MPI_Abort().
518 gmx_abort(gmx_node_rank(), gmx_node_num(), returnCode);