include/xbt/exception.hpp

   1 /* Copyright (c) 2005-2018. The SimGrid Team.All rights reserved. */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_XBT_EXCEPTION_HPP
   7 #define SIMGRID_XBT_EXCEPTION_HPP
   8
   9 #include <string>
  10 #include <type_traits>
  11 #include <vector>
  12
  13 #include <xbt/base.h>
  14 #include <xbt/backtrace.h>
  15 #include <xbt/backtrace.hpp>
  16 #include <xbt/log.h>
  17 #include <xbt/misc.h>  // xbt_procname
  18 #include <xbt/virtu.h> // xbt_getpid
  19
  20 /** @addtogroup XBT_ex
  21  *  @brief Exceptions support
  22  */
  23
  24 namespace simgrid {
  25 namespace xbt {
  26
  27 /** A backtrace
  28  *
  29  *  This is used (among other things) in exceptions to store the associated
  30  *  backtrace.
  31  *
  32  *  @ingroup XBT_ex
  33  */
  34 typedef std::vector<xbt_backtrace_location_t> Backtrace;
  35
  36 /** The location of where an exception has been thrown
  37  *
  38  *  This is a tuple (__FILE__, __LINE__, __func__) and can be created with
  39  *  @ref XBT_THROW_POINT.
  40  *
  41  *  @ingroup XBT_ex
  42  */
  43 class ThrowPoint {
  44  public:
  45   ThrowPoint() = default;
  46   explicit ThrowPoint(const char* file, int line, const char* function) : file_(file), line_(line), function_(function)
  47   {
  48   }
  49   const char* file_     = nullptr;
  50   int line_             = 0;
  51   const char* function_ = nullptr;
  52 };
  53
  54 /** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */
  55 #define XBT_THROW_POINT ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__)
  56
  57 /** A base class for exceptions with context
  58  *
  59  *  This is a base class for exceptions which store additional contextual
  60  *  information: backtrace, throw point, simulated process name, PID, etc.
  61  */
  62 class XBT_PUBLIC ContextedException {
  63 public:
  64   ContextedException() :
  65     backtrace_(simgrid::xbt::backtrace()),
  66     procname_(xbt_procname()),
  67     pid_(xbt_getpid())
  68   {}
  69   explicit ContextedException(Backtrace bt) : backtrace_(std::move(bt)), procname_(xbt_procname()), pid_(xbt_getpid())
  70   {}
  71   explicit ContextedException(ThrowPoint throwpoint, Backtrace bt)
  72       : backtrace_(std::move(bt)), procname_(xbt_procname()), pid_(xbt_getpid()), throwpoint_(throwpoint)
  73   {}
  74   virtual ~ContextedException();
  75   Backtrace const& backtrace() const
  76   {
  77     return backtrace_;
  78   }
  79   int pid() const { return pid_; }
  80   std::string const& process_name() const { return procname_; }
  81   ThrowPoint& throw_point() { return throwpoint_; }
  82
  83   // deprecated
  84   XBT_ATTRIB_DEPRECATED_v323("Please use WithContextException::process_name()") std::string const& processName() const
  85   {
  86     return process_name();
  87   }
  88   XBT_ATTRIB_DEPRECATED_v323("Please use WithContextException::throw_point()") ThrowPoint& throwPoint()
  89   {
  90     return throw_point();
  91   }
  92
  93 private:
  94   Backtrace backtrace_;
  95   std::string procname_; /**< Name of the process who thrown this */
  96   int pid_;              /**< PID of the process who thrown this */
  97   ThrowPoint throwpoint_;
  98 };
  99 }
 100 }
 101
 102 #endif