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