include/xbt/backtrace.hpp

   1 /* Copyright (c) 2005-2020. 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_BACKTRACE_HPP
   7 #define SIMGRID_XBT_BACKTRACE_HPP
   8
   9 #include <xbt/base.h>
  10
  11 #include <functional>
  12 #include <memory>
  13 #include <string>
  14
  15 SG_BEGIN_DECL
  16 /** @brief Shows a backtrace of the current location */
  17 XBT_PUBLIC void xbt_backtrace_display_current();
  18 SG_END_DECL
  19
  20 namespace simgrid {
  21 namespace xbt {
  22
  23 /** Try to demangle a C++ name
  24  *
  25  *  Return the origin string if this fails.
  26  */
  27 XBT_PUBLIC std::unique_ptr<char, std::function<void(char*)>> demangle(const char* name);
  28
  29 class BacktraceImpl;
  30 /** A backtrace
  31  *
  32  *  This is used (among other things) in exceptions to store the associated
  33  *  backtrace.
  34  *
  35  *  @ingroup XBT_ex
  36  */
  37 class Backtrace {
  38 public:
  39   std::shared_ptr<BacktraceImpl> impl_;
  40   Backtrace();
  41   /** @brief Translate the backtrace in a human friendly form, unmangled with source code locations. */
  42   std::string resolve() const;
  43   /** @brief Display the resolved backtrace on stderr */
  44   void display() const;
  45 };
  46
  47 }
  48 }
  49 #endif