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 typedef void* xbt_backtrace_location_t;
  22
  23 namespace simgrid {
  24 namespace xbt {
  25
  26 /** A backtrace
  27  *
  28  *  This is used (among other things) in exceptions to store the associated
  29  *  backtrace.
  30  *
  31  *  @ingroup XBT_ex
  32  */
  33 typedef std::vector<xbt_backtrace_location_t> Backtrace;
  34
  35 /** Try to demangle a C++ name
  36  *
  37  *  Return the origin string if this fails.
  38  */
  39 XBT_PUBLIC std::unique_ptr<char, void (*)(void*)> demangle(const char* name);
  40
  41 /** Get the current backtrace */
  42 XBT_PUBLIC Backtrace backtrace();
  43
  44 /* Translate the backtrace in a human friendly form
  45  *
  46  *  Try resolve symbols and source code location.
  47  */
  48 XBT_PUBLIC std::vector<std::string> resolve_backtrace(xbt_backtrace_location_t const* loc, std::size_t count);
  49 }
  50 }
  51
  52 /** @brief Captures a backtrace for further use */
  53 XBT_PUBLIC size_t xbt_backtrace_current(xbt_backtrace_location_t* loc, size_t count);
  54
  55 /** @brief Display a previously captured backtrace */
  56 XBT_PUBLIC void xbt_backtrace_display(xbt_backtrace_location_t* loc, size_t count);
  57
  58 #endif