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