src/xbt/backtrace.cpp

   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 #include <cstddef>
   7 #include <cstdlib>
   8 #include <cstring>
   9
  10 #include <vector>
  11
  12 // Try to detect and use the C++ intanium ABI for name demangling:
  13 #ifdef __GXX_ABI_VERSION
  14 #include <cxxabi.h>
  15 #endif
  16
  17 #include "simgrid/simix.h" /* SIMIX_process_self_get_name() */
  18 #include <xbt/backtrace.h>
  19 #include <xbt/backtrace.hpp>
  20 #include <xbt/log.h>
  21 #include <xbt/sysdep.h>
  22
  23 #include "src/internal_config.h"
  24
  25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_backtrace, xbt, "Backtrace");
  26
  27 static bool startWith(std::string str, const char* prefix)
  28 {
  29   return strncmp(str.c_str(), prefix, strlen(prefix)) == 0;
  30 }
  31
  32 void xbt_backtrace_display(xbt_backtrace_location_t* loc, std::size_t count)
  33 {
  34 #ifdef HAVE_BACKTRACE
  35   std::vector<std::string> backtrace = simgrid::xbt::resolve_backtrace(loc, count);
  36   if (backtrace.empty()) {
  37     fprintf(stderr, "(backtrace not set)\n");
  38     return;
  39   }
  40   fprintf(stderr, "Backtrace (displayed in process %s):\n", SIMIX_process_self_get_name());
  41   for (std::string const& s : backtrace) {
  42     if (startWith(s, "xbt_backtrace_display_current"))
  43       continue;
  44
  45     std::fprintf(stderr, "---> '%s'\n", s.c_str());
  46     if (startWith(s, "SIMIX_simcall_handle") ||
  47         startWith(s, "simgrid::xbt::MainFunction") /* main used with thread factory */)
  48       break;
  49   }
  50 #else
  51   XBT_ERROR("Cannot display backtrace when compiled without libunwind.");
  52 #endif
  53 }
  54
  55 /** @brief show the backtrace of the current point (lovely while debugging) */
  56 void xbt_backtrace_display_current()
  57 {
  58   const std::size_t size = 10;
  59   xbt_backtrace_location_t bt[size];
  60   size_t used = xbt_backtrace_current(bt, size);
  61   xbt_backtrace_display(bt, used);
  62 }
  63
  64 namespace simgrid {
  65 namespace xbt {
  66
  67 std::unique_ptr<char, void(*)(void*)> demangle(const char* name)
  68 {
  69 #ifdef __GXX_ABI_VERSION
  70   int status;
  71   auto res = std::unique_ptr<char, void(*)(void*)>(
  72     abi::__cxa_demangle(name, nullptr, nullptr, &status),
  73     std::free
  74   );
  75   if (res != nullptr)
  76     return res;
  77   // We did not manage to resolve this. Probably because this is not a mangled symbol:
  78 #endif
  79   // Return the symbol:
  80   return std::unique_ptr<char, void(*)(void*)>(xbt_strdup(name), std::free);
  81 }
  82
  83 std::vector<xbt_backtrace_location_t> backtrace()
  84 {
  85   const std::size_t size = 10;
  86   xbt_backtrace_location_t loc[size];
  87   size_t used = xbt_backtrace_current(loc, size);
  88   return std::vector<xbt_backtrace_location_t>(loc, loc + used);
  89 }
  90
  91 }
  92 }
  93
  94 #if HAVE_BACKTRACE && HAVE_EXECINFO_H && HAVE_POPEN && defined(ADDR2LINE)
  95 # include "src/xbt/backtrace_linux.cpp"
  96 #else
  97 # include "src/xbt/backtrace_dummy.cpp"
  98 #endif