src/gromacs/utility/exceptions.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   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 classes and functions in exceptions.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "exceptions.h"
  43
  44 #ifdef HAVE_CONFIG_H
  45 #include "config.h"
  46 #endif
  47
  48 #include <cstring>
  49
  50 #include <new>
  51 #include <stdexcept>
  52 #include <typeinfo>
  53
  54 #include <boost/exception/get_error_info.hpp>
  55 #include <boost/shared_ptr.hpp>
  56
  57 #include "thread_mpi/system_error.h"
  58
  59 #include "gromacs/utility/basenetwork.h"
  60 #include "gromacs/utility/errorcodes.h"
  61 #include "gromacs/utility/gmxassert.h"
  62 #include "gromacs/utility/stringutil.h"
  63
  64 #include "errorformat.h"
  65
  66 namespace gmx
  67 {
  68
  69 namespace
  70 {
  71
  72 /********************************************************************
  73  * ErrorMessage
  74  */
  75
  76 /*! \brief
  77  * Error message or error context text item.
  78  *
  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.
  82  *
  83  * \ingroup module_utility
  84  */
  85 class ErrorMessage
  86 {
  87     public:
  88         /*! \brief
  89          * Creates an error message object with the specified text.
  90          *
  91          * \param[in] text  Text for the message.
  92          */
  93         explicit ErrorMessage(const std::string &text);
  94
  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_; }
  99         /*! \brief
 100          * Returns the child object for a context object.
 101          *
 102          * Must not be called if isContext() returns false.
 103          */
 104         const ErrorMessage &child() const
 105         {
 106             GMX_ASSERT(isContext(),
 107                        "Attempting to access nonexistent message object");
 108             return *child_;
 109         }
 110
 111         /*! \brief
 112          * Creates a new message object with context prepended.
 113          *
 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.
 118          */
 119         ErrorMessage prependContext(const std::string &context) const;
 120
 121     private:
 122         std::string                     text_;
 123         boost::shared_ptr<ErrorMessage> child_;
 124 };
 125
 126 /*! \internal \brief
 127  * Stores a reason or the top-most context string of an exception.
 128  *
 129  * \ingroup module_utility
 130  */
 131 typedef boost::error_info<struct errinfo_message_, ErrorMessage>
 132     errinfo_message;
 133
 134 ErrorMessage::ErrorMessage(const std::string &text)
 135     : text_(text)
 136 {
 137     size_t length = text_.find_last_not_of(" \n");
 138     if (length == std::string::npos)
 139     {
 140         length = text_.length() - 1;
 141     }
 142     text_.resize(length + 1);
 143 }
 144
 145 ErrorMessage
 146 ErrorMessage::prependContext(const std::string &context) const
 147 {
 148     ErrorMessage newMessage(context);
 149     newMessage.child_.reset(new ErrorMessage(*this));
 150     return newMessage;
 151 }
 152
 153 /*! \brief
 154  * Stores list of nested exceptions for Gromacs exceptions.
 155  *
 156  * \ingroup module_utility
 157  */
 158 typedef boost::error_info<struct errinfo_message_, internal::NestedExceptionList>
 159     errinfo_nested_exceptions;
 160
 161 }   // namespace
 162
 163 /********************************************************************
 164  * GromacsException
 165  */
 166
 167 GromacsException::GromacsException(const ExceptionInitializer &details)
 168 {
 169     *this << errinfo_message(ErrorMessage(details.reason_));
 170     if (details.hasNestedExceptions())
 171     {
 172         *this << errinfo_nested_exceptions(details.nested_);
 173     }
 174 }
 175
 176 const char *GromacsException::what() const throw()
 177 {
 178     const ErrorMessage *msg = boost::get_error_info<errinfo_message>(*this);
 179     while (msg != NULL && msg->isContext())
 180     {
 181         msg = &msg->child();
 182     }
 183     return msg != NULL ? msg->text().c_str() : "No reason provided";
 184 }
 185
 186 void GromacsException::prependContext(const std::string &context)
 187 {
 188     const ErrorMessage *msg = boost::get_error_info<errinfo_message>(*this);
 189     GMX_RELEASE_ASSERT(msg != NULL, "Message should always be set");
 190     *this << errinfo_message(msg->prependContext(context));
 191 }
 192
 193 /********************************************************************
 194  * Derived exception classes
 195  */
 196
 197 int FileIOError::errorCode() const
 198 {
 199     return eeFileIO;
 200 }
 201
 202 int InvalidInputError::errorCode() const
 203 {
 204     return eeInvalidInput;
 205 }
 206
 207 int InconsistentInputError::errorCode() const
 208 {
 209     return eeInconsistentInput;
 210 }
 211
 212 int SimulationInstabilityError::errorCode() const
 213 {
 214     return eeInstability;
 215 }
 216
 217 int InternalError::errorCode() const
 218 {
 219     return eeInternalError;
 220 }
 221
 222 int APIError::errorCode() const
 223 {
 224     return eeAPIError;
 225 }
 226
 227 int NotImplementedError::errorCode() const
 228 {
 229     return eeNotImplemented;
 230 }
 231
 232
 233 /********************************************************************
 234  * Global functions
 235  */
 236
 237 namespace
 238 {
 239
 240 //! \addtogroup module_utility
 241 //! \{
 242
 243 /*! \brief
 244  * Abstracts actual output from the other logic in exception formatting.
 245  *
 246  * Object that implements this interface is passed to
 247  * formatExceptionMessageInternal(), and is responsible for composing the
 248  * output.  This allows using the same implementation of interpreting the
 249  * exceptions while still supporting output to different formats (e.g., to a
 250  * string or to \c stderr).
 251  */
 252 class MessageWriterInterface
 253 {
 254     public:
 255         virtual ~MessageWriterInterface() {}
 256
 257         /*! \brief
 258          * Writes a single line of text into the output.
 259          *
 260          * \param[in] text    Text to write on the line.
 261          * \param[in] indent  Suggested number of spaces to indent the line.
 262          */
 263         virtual void writeLine(const char *text, int indent) = 0;
 264         /*! \brief
 265          * Writes information about a system error (errno-based).
 266          *
 267          * \param[in] errorNumber  errno value
 268          * \param[in] funcName     Name of the system call (can be NULL).
 269          * \param[in] indent       Suggested number of spaces to indent the output.
 270          */
 271         virtual void writeErrNoInfo(int errorNumber, const char *funcName,
 272                                     int indent) = 0;
 273 };
 274
 275 /*! \brief
 276  * Exception information writer for cases where exceptions should be avoided.
 277  *
 278  * Formats the messages into the provided FILE handle without checking for
 279  * errors in std::fprintf() calls.
 280  */
 281 class MessageWriterFileNoThrow : public MessageWriterInterface
 282 {
 283     public:
 284         //! Initializes a writer that writes to the given file handle.
 285         explicit MessageWriterFileNoThrow(FILE *fp) : fp_(fp) {}
 286
 287         virtual void writeLine(const char *text, int indent)
 288         {
 289             internal::printFatalErrorMessageLine(fp_, text, indent);
 290         }
 291         virtual void writeErrNoInfo(int errorNumber, const char *funcName,
 292                                     int indent)
 293         {
 294             std::fprintf(fp_, "%*sReason: %s\n", indent, "",
 295                          std::strerror(errorNumber));
 296             if (funcName != NULL)
 297             {
 298                 std::fprintf(fp_, "%*s(call to %s() returned error code %d)\n",
 299                              indent, "", funcName, errorNumber);
 300             }
 301         }
 302
 303     private:
 304         FILE                   *fp_;
 305 };
 306
 307 /*! \brief
 308  * Exception information writer to format into an std::string.
 309  */
 310 class MessageWriterString : public MessageWriterInterface
 311 {
 312     public:
 313         //! Post-processes the output string to not end in a line feed.
 314         void removeTerminatingLineFeed()
 315         {
 316             if (result_.size() > 0U)
 317             {
 318                 result_.erase(result_.size() - 1);
 319             }
 320         }
 321         //! Returns the constructed string.
 322         const std::string &result() const { return result_; }
 323
 324         virtual void writeLine(const char *text, int indent)
 325         {
 326             result_.append(indent, ' ');
 327             result_.append(text);
 328             result_.append("\n");
 329         }
 330         virtual void writeErrNoInfo(int errorNumber, const char *funcName,
 331                                     int indent)
 332         {
 333             writeLine(formatString("Reason: %s", std::strerror(errorNumber)).c_str(),
 334                       indent);
 335             if (funcName != NULL)
 336             {
 337                 writeLine(formatString("(call to %s() returned error code %d)",
 338                                        funcName, errorNumber).c_str(),
 339                           indent);
 340             }
 341         }
 342
 343     private:
 344         std::string             result_;
 345 };
 346
 347 /*! \brief
 348  * Prints error information for an exception object.
 349  *
 350  * \param[in] writer  Writer to write out the information.
 351  * \param[in] ex      Exception object to print.
 352  * \param[in] indent  Indentation for the information.
 353  *
 354  * If the exception contains nested exceptions, information from them is
 355  * recursively printed.
 356  *
 357  * Does not throw unless the writer throws.
 358  */
 359 void formatExceptionMessageInternal(MessageWriterInterface *writer,
 360                                     const std::exception &ex, int indent)
 361 {
 362     const boost::exception *boostEx = dynamic_cast<const boost::exception *>(&ex);
 363     if (boostEx != NULL)
 364     {
 365         // TODO: Add an option to print this information for the tests
 366         // const char *const *funcPtr =
 367         //     boost::get_error_info<boost::throw_function>(*boostEx);
 368         // const char *const *filePtr =
 369         //     boost::get_error_info<boost::throw_file>(*boostEx);
 370         // const int         *linePtr =
 371         //     boost::get_error_info<boost::throw_line>(*boostEx);
 372
 373         // std::string        result;
 374         // if (filePtr != NULL && linePtr != NULL)
 375         // {
 376         //     result = formatString("%s:%d: %s\n", *filePtr, *linePtr,
 377         //                           funcPtr != NULL ? *funcPtr : "");
 378         // }
 379
 380         // TODO: Remove duplicate context if present in multiple nested exceptions.
 381         const ErrorMessage *msg = boost::get_error_info<errinfo_message>(*boostEx);
 382         if (msg != NULL)
 383         {
 384             while (msg != NULL && msg->isContext())
 385             {
 386                 writer->writeLine(msg->text().c_str(), indent*2);
 387                 ++indent;
 388                 msg = &msg->child();
 389             }
 390             if (msg != NULL && !msg->text().empty())
 391             {
 392                 writer->writeLine(msg->text().c_str(), indent*2);
 393             }
 394         }
 395         else
 396         {
 397             writer->writeLine(ex.what(), indent*2);
 398         }
 399
 400         const int *errorNumber
 401             = boost::get_error_info<boost::errinfo_errno>(*boostEx);
 402         if (errorNumber != NULL)
 403         {
 404             const char * const *funcName
 405                 = boost::get_error_info<boost::errinfo_api_function>(*boostEx);
 406             writer->writeErrNoInfo(*errorNumber,
 407                                    funcName != NULL ? *funcName : NULL,
 408                                    (indent+1)*2);
 409         }
 410
 411         // TODO: Treat also boost::nested_exception (not currently used, though)
 412
 413         const internal::NestedExceptionList *nested
 414             = boost::get_error_info<errinfo_nested_exceptions>(*boostEx);
 415         if (nested != NULL)
 416         {
 417             internal::NestedExceptionList::const_iterator ni;
 418             for (ni = nested->begin(); ni != nested->end(); ++ni)
 419             {
 420                 try
 421                 {
 422                     rethrow_exception(*ni);
 423                 }
 424                 catch (const std::exception &nestedEx)
 425                 {
 426                     formatExceptionMessageInternal(writer, nestedEx, indent + 1);
 427                 }
 428             }
 429         }
 430     }
 431     else
 432     {
 433         writer->writeLine(ex.what(), indent*2);
 434     }
 435 }
 436
 437 //! \}
 438
 439 }   // namespace
 440
 441 void printFatalErrorMessage(FILE *fp, const std::exception &ex)
 442 {
 443     const char             *title      = "Unknown exception";
 444     bool                    bPrintType = false;
 445     const GromacsException *gmxEx      = dynamic_cast<const GromacsException *>(&ex);
 446     // TODO: Treat more of the standard exceptions
 447     if (gmxEx != NULL)
 448     {
 449         title = getErrorCodeString(gmxEx->errorCode());
 450     }
 451     else if (dynamic_cast<const tMPI::system_error *>(&ex) != NULL)
 452     {
 453         title = "System error in thread synchronization";
 454     }
 455     else if (dynamic_cast<const std::bad_alloc *>(&ex) != NULL)
 456     {
 457         title = "Memory allocation failed";
 458     }
 459     else if (dynamic_cast<const std::logic_error *>(&ex) != NULL)
 460     {
 461         title      = "Standard library logic error (bug)";
 462         bPrintType = true;
 463     }
 464     else if (dynamic_cast<const std::runtime_error *>(&ex) != NULL)
 465     {
 466         title      = "Standard library runtime error (possible bug)";
 467         bPrintType = true;
 468     }
 469     else
 470     {
 471         bPrintType = true;
 472     }
 473     // We can't call get_error_info directly on ex since our internal boost
 474     // needs to be compiled with BOOST_NO_RTTI. So we do the dynamic_cast
 475     // here instead.
 476     const char *const      *funcPtr = NULL;
 477     const char *const      *filePtr = NULL;
 478     const int              *linePtr = NULL;
 479     const boost::exception *boostEx = dynamic_cast<const boost::exception *>(&ex);
 480     if (boostEx != NULL)
 481     {
 482         funcPtr = boost::get_error_info<boost::throw_function>(*boostEx);
 483         filePtr = boost::get_error_info<boost::throw_file>(*boostEx);
 484         linePtr = boost::get_error_info<boost::throw_line>(*boostEx);
 485     }
 486     internal::printFatalErrorHeader(fp, title,
 487                                     funcPtr != NULL ? *funcPtr : NULL,
 488                                     filePtr != NULL ? *filePtr : NULL,
 489                                     linePtr != NULL ? *linePtr : 0);
 490     if (bPrintType)
 491     {
 492         std::fprintf(fp, "(exception type: %s)\n", typeid(ex).name());
 493     }
 494     MessageWriterFileNoThrow writer(fp);
 495     formatExceptionMessageInternal(&writer, ex, 0);
 496     internal::printFatalErrorFooter(fp);
 497 }
 498
 499 std::string formatExceptionMessageToString(const std::exception &ex)
 500 {
 501     MessageWriterString writer;
 502     formatExceptionMessageInternal(&writer, ex, 0);
 503     writer.removeTerminatingLineFeed();
 504     return writer.result();
 505 }
 506
 507 void formatExceptionMessageToFile(FILE *fp, const std::exception &ex)
 508 {
 509     MessageWriterFileNoThrow writer(fp);
 510     formatExceptionMessageInternal(&writer, ex, 0);
 511 }
 512
 513 int processExceptionAtExit(const std::exception & /*ex*/)
 514 {
 515     int returnCode = 1;
 516 #ifdef GMX_LIB_MPI
 517     // TODO: Consider moving the output done in gmx_abort() into the message
 518     // printing routine above, so that this could become a simple MPI_Abort().
 519     gmx_abort(returnCode);
 520 #endif
 521     return returnCode;
 522 }
 523
 524 } // namespace gmx