2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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.
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
44 #include "exceptions.h"
54 #include <boost/shared_ptr.hpp>
55 #include <boost/exception/get_error_info.hpp>
57 #include "thread_mpi/system_error.h"
59 #include "gromacs/utility/basenetwork.h"
60 #include "gromacs/utility/errorcodes.h"
61 #include "gromacs/utility/gmxassert.h"
62 #include "gromacs/utility/stringutil.h"
64 #include "errorformat.h"
72 /********************************************************************
77 * Error message or error context text item.
79 * Error messages for an exception are represented as a chain of ErrorMessage
80 * objects: the elements at the bottom of the chain (with no children) is the
81 * error message, and other elements are the context strings added.
83 * \ingroup module_utility
89 * Creates an error message object with the specified text.
91 * \param[in] text Text for the message.
93 explicit ErrorMessage(const std::string &text);
95 //! Whether this object is a context string.
96 bool isContext() const { return static_cast<bool>(child_); }
97 //! Returns the text for this object.
98 const std::string &text() const { return text_; }
100 * Returns the child object for a context object.
102 * Must not be called if isContext() returns false.
104 const ErrorMessage &child() const
106 GMX_ASSERT(isContext(),
107 "Attempting to access nonexistent message object");
112 * Creates a new message object with context prepended.
114 * \param[in] context Context string to add.
115 * \returns New error message object that has \p context as its text
116 * and \c this as its child.
117 * \throws std::bad_alloc if out of memory.
119 ErrorMessage prependContext(const std::string &context) const;
123 boost::shared_ptr<ErrorMessage> child_;
127 * Stores a reason or the top-most context string of an exception.
129 * \ingroup module_utility
131 typedef boost::error_info<struct errinfo_message_, ErrorMessage>
134 ErrorMessage::ErrorMessage(const std::string &text)
137 size_t length = text_.find_last_not_of(" \n");
138 if (length == std::string::npos)
140 length = text_.length() - 1;
142 text_.resize(length + 1);
146 ErrorMessage::prependContext(const std::string &context) const
148 ErrorMessage newMessage(context);
149 newMessage.child_.reset(new ErrorMessage(*this));
154 * Stores list of nested exceptions for Gromacs exceptions.
156 * \ingroup module_utility
158 typedef boost::error_info<struct errinfo_message_, internal::NestedExceptionList>
159 errinfo_nested_exceptions;
163 /********************************************************************
167 GromacsException::GromacsException(const ExceptionInitializer &details)
169 *this << errinfo_message(ErrorMessage(details.reason_));
170 if (details.hasNestedExceptions())
172 *this << errinfo_nested_exceptions(details.nested_);
176 const char *GromacsException::what() const throw()
178 const ErrorMessage *msg = boost::get_error_info<errinfo_message>(*this);
181 return "No reason provided";
183 while (msg->isContext())
187 return msg->text().c_str();
190 void GromacsException::prependContext(const std::string &context)
192 const ErrorMessage *msg = boost::get_error_info<errinfo_message>(*this);
193 GMX_RELEASE_ASSERT(msg != NULL, "Message should always be set");
194 *this << errinfo_message(msg->prependContext(context));
197 /********************************************************************
198 * Derived exception classes
201 int FileIOError::errorCode() const
206 int InvalidInputError::errorCode() const
208 return eeInvalidInput;
211 int InconsistentInputError::errorCode() const
213 return eeInconsistentInput;
216 int SimulationInstabilityError::errorCode() const
218 return eeInstability;
221 int InternalError::errorCode() const
223 return eeInternalError;
226 int APIError::errorCode() const
231 int NotImplementedError::errorCode() const
233 return eeNotImplemented;
237 /********************************************************************
244 //! \addtogroup module_utility
248 * Abstracts actual output from the other logic in exception formatting.
250 * Object that implements this interface is passed to
251 * formatExceptionMessageInternal(), and is responsible for composing the
252 * output. This allows using the same implementation of interpreting the
253 * exceptions while still supporting output to different formats (e.g., to a
254 * string or to \c stderr).
256 class MessageWriterInterface
259 virtual ~MessageWriterInterface() {}
262 * Writes a single line of text into the output.
264 * \param[in] text Text to write on the line.
265 * \param[in] indent Suggested number of spaces to indent the line.
267 virtual void writeLine(const char *text, int indent) = 0;
269 * Writes information about a system error (errno-based).
271 * \param[in] errorNumber errno value
272 * \param[in] funcName Name of the system call (can be NULL).
273 * \param[in] indent Suggested number of spaces to indent the output.
275 virtual void writeErrNoInfo(int errorNumber, const char *funcName,
280 * Exception information writer for cases where exceptions should be avoided.
282 * Formats the messages into the provided FILE handle without checking for
283 * errors in std::fprintf() calls.
285 class MessageWriterFileNoThrow : public MessageWriterInterface
288 //! Initializes a writer that writes to the given file handle.
289 explicit MessageWriterFileNoThrow(FILE *fp) : fp_(fp) {}
291 virtual void writeLine(const char *text, int indent)
293 internal::printFatalErrorMessageLine(fp_, text, indent);
295 virtual void writeErrNoInfo(int errorNumber, const char *funcName,
298 std::fprintf(fp_, "%*sReason: %s\n", indent, "",
299 std::strerror(errorNumber));
300 if (funcName != NULL)
302 std::fprintf(fp_, "%*s(call to %s() returned error code %d)\n",
303 indent, "", funcName, errorNumber);
312 * Exception information writer to format into an std::string.
314 class MessageWriterString : public MessageWriterInterface
317 //! Post-processes the output string to not end in a line feed.
318 void removeTerminatingLineFeed()
320 if (result_.size() > 0U)
322 result_.erase(result_.size() - 1);
325 //! Returns the constructed string.
326 const std::string &result() const { return result_; }
328 virtual void writeLine(const char *text, int indent)
330 result_.append(indent, ' ');
331 result_.append(text);
332 result_.append("\n");
334 virtual void writeErrNoInfo(int errorNumber, const char *funcName,
337 writeLine(formatString("Reason: %s", std::strerror(errorNumber)).c_str(),
339 if (funcName != NULL)
341 writeLine(formatString("(call to %s() returned error code %d)",
342 funcName, errorNumber).c_str(),
352 * Prints error information for an exception object.
354 * \param[in] writer Writer to write out the information.
355 * \param[in] ex Exception object to print.
356 * \param[in] indent Indentation for the information.
358 * If the exception contains nested exceptions, information from them is
359 * recursively printed.
361 * Does not throw unless the writer throws.
363 void formatExceptionMessageInternal(MessageWriterInterface *writer,
364 const std::exception &ex, int indent)
366 const boost::exception *boostEx = dynamic_cast<const boost::exception *>(&ex);
369 // TODO: Add an option to print this information for the tests
370 // const char *const *funcPtr =
371 // boost::get_error_info<boost::throw_function>(*boostEx);
372 // const char *const *filePtr =
373 // boost::get_error_info<boost::throw_file>(*boostEx);
374 // const int *linePtr =
375 // boost::get_error_info<boost::throw_line>(*boostEx);
377 // std::string result;
378 // if (filePtr != NULL && linePtr != NULL)
380 // result = formatString("%s:%d: %s\n", *filePtr, *linePtr,
381 // funcPtr != NULL ? *funcPtr : "");
384 // TODO: Remove duplicate context if present in multiple nested exceptions.
385 const ErrorMessage *msg = boost::get_error_info<errinfo_message>(*boostEx);
388 while (msg != NULL && msg->isContext())
390 writer->writeLine(msg->text().c_str(), indent*2);
394 if (msg != NULL && !msg->text().empty())
396 writer->writeLine(msg->text().c_str(), indent*2);
401 writer->writeLine(ex.what(), indent*2);
404 const int *errorNumber
405 = boost::get_error_info<boost::errinfo_errno>(*boostEx);
406 if (errorNumber != NULL)
408 const char * const *funcName
409 = boost::get_error_info<boost::errinfo_api_function>(*boostEx);
410 writer->writeErrNoInfo(*errorNumber,
411 funcName != NULL ? *funcName : NULL,
415 // TODO: Treat also boost::nested_exception (not currently used, though)
417 const internal::NestedExceptionList *nested
418 = boost::get_error_info<errinfo_nested_exceptions>(*boostEx);
421 internal::NestedExceptionList::const_iterator ni;
422 for (ni = nested->begin(); ni != nested->end(); ++ni)
426 rethrow_exception(*ni);
428 catch (const std::exception &nestedEx)
430 formatExceptionMessageInternal(writer, nestedEx, indent + 1);
437 writer->writeLine(ex.what(), indent*2);
445 void printFatalErrorMessage(FILE *fp, const std::exception &ex)
447 const char *title = "Unknown exception";
448 bool bPrintType = false;
449 const GromacsException *gmxEx = dynamic_cast<const GromacsException *>(&ex);
450 // TODO: Treat more of the standard exceptions
453 title = getErrorCodeString(gmxEx->errorCode());
455 else if (dynamic_cast<const tMPI::system_error *>(&ex) != NULL)
457 title = "System error in thread synchronization";
459 else if (dynamic_cast<const std::bad_alloc *>(&ex) != NULL)
461 title = "Memory allocation failed";
463 else if (dynamic_cast<const std::logic_error *>(&ex) != NULL)
465 title = "Standard library logic error (bug)";
468 else if (dynamic_cast<const std::runtime_error *>(&ex) != NULL)
470 title = "Standard library runtime error (possible bug)";
477 // We can't call get_error_info directly on ex since our internal boost
478 // needs to be compiled with BOOST_NO_RTTI. So we do the dynamic_cast
480 const char *const *funcPtr = NULL;
481 const char *const *filePtr = NULL;
482 const int *linePtr = NULL;
483 const boost::exception *boostEx = dynamic_cast<const boost::exception *>(&ex);
486 funcPtr = boost::get_error_info<boost::throw_function>(*boostEx);
487 filePtr = boost::get_error_info<boost::throw_file>(*boostEx);
488 linePtr = boost::get_error_info<boost::throw_line>(*boostEx);
490 internal::printFatalErrorHeader(fp, title,
491 funcPtr != NULL ? *funcPtr : NULL,
492 filePtr != NULL ? *filePtr : NULL,
493 linePtr != NULL ? *linePtr : 0);
496 std::fprintf(fp, "(exception type: %s)\n", typeid(ex).name());
498 MessageWriterFileNoThrow writer(fp);
499 formatExceptionMessageInternal(&writer, ex, 0);
500 internal::printFatalErrorFooter(fp);
503 std::string formatExceptionMessageToString(const std::exception &ex)
505 MessageWriterString writer;
506 formatExceptionMessageInternal(&writer, ex, 0);
507 writer.removeTerminatingLineFeed();
508 return writer.result();
511 void formatExceptionMessageToFile(FILE *fp, const std::exception &ex)
513 MessageWriterFileNoThrow writer(fp);
514 formatExceptionMessageInternal(&writer, ex, 0);
517 int processExceptionAtExit(const std::exception & /*ex*/)
521 // TODO: Consider moving the output done in gmx_abort() into the message
522 // printing routine above, so that this could become a simple MPI_Abort().
523 gmx_abort(returnCode);