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