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