src/xbt/backtrace.cpp

   1 /* Copyright (c) 2005-2019. 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 "src/internal_config.h"
   7
   8 #include "simgrid/simix.h" /* SIMIX_process_self_get_name() */
   9 #include <xbt/backtrace.hpp>
  10 #include <xbt/log.h>
  11 #include <xbt/string.hpp>
  12 #include <xbt/sysdep.h>
  13
  14 #include <cstddef>
  15 #include <cstdlib>
  16 #include <cstring>
  17 #include <fstream>
  18 #include <sstream>
  19 #include <sys/stat.h>
  20 #include <vector>
  21
  22 #include <boost/algorithm/string.hpp>
  23
  24 // Try to detect and use the C++ itanium ABI for name demangling:
  25 #ifdef __GXX_ABI_VERSION
  26 #include <cxxabi.h>
  27 #endif
  28
  29 #if HAVE_BOOST_STACKTRACE
  30 #define BOOST_STACKTRACE_USE_BACKTRACE
  31 #include <boost/stacktrace.hpp>
  32 #endif
  33
  34 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_backtrace, xbt, "Backtrace");
  35
  36 /** @brief show the backtrace of the current point (lovely while debugging) */
  37 void xbt_backtrace_display_current()
  38 {
  39   simgrid::xbt::Backtrace().display();
  40 }
  41
  42 namespace simgrid {
  43 namespace xbt {
  44
  45 std::unique_ptr<char, void(*)(void*)> demangle(const char* name)
  46 {
  47 #ifdef __GXX_ABI_VERSION
  48   int status;
  49   auto res = std::unique_ptr<char, void (*)(void*)>(abi::__cxa_demangle(name, nullptr, nullptr, &status), &std::free);
  50   if (res != nullptr)
  51     return res;
  52   // We did not manage to resolve this. Probably because this is not a mangled symbol:
  53 #endif
  54   // Return the symbol:
  55   return std::unique_ptr<char, void (*)(void*)>(xbt_strdup(name), &std::free);
  56 }
  57
  58 class BacktraceImpl {
  59   short refcount_ = 1;
  60
  61 public:
  62   void ref() { refcount_++; }
  63   bool unref()
  64   {
  65     refcount_--;
  66     if (refcount_ == 0) {
  67       delete this;
  68       return true;
  69     } else {
  70       return false;
  71     }
  72   }
  73 #if HAVE_BOOST_STACKTRACE
  74   boost::stacktrace::stacktrace st;
  75 #endif
  76 };
  77
  78 Backtrace::Backtrace()
  79 {
  80 #if HAVE_BOOST_STACKTRACE
  81   impl_     = new BacktraceImpl();
  82   impl_->st = boost::stacktrace::stacktrace();
  83 #endif
  84 }
  85 Backtrace::Backtrace(const Backtrace& bt)
  86 {
  87   impl_ = bt.impl_;
  88   if (impl_)
  89     impl_->ref();
  90 }
  91
  92 Backtrace::Backtrace(Backtrace&& bt)
  93 {
  94   impl_    = bt.impl_;
  95   bt.impl_ = nullptr;
  96 }
  97
  98 Backtrace& Backtrace::operator=(const Backtrace& rhs)
  99 {
 100   if (this != &rhs) {
 101     if (impl_)
 102       impl_->unref();
 103     impl_ = rhs.impl_;
 104     if (impl_)
 105       impl_->ref();
 106   }
 107   return *this;
 108 }
 109
 110 Backtrace& Backtrace::operator=(Backtrace&& rhs)
 111 {
 112   if (this != &rhs) {
 113     if (impl_)
 114       impl_->unref();
 115     impl_     = rhs.impl_;
 116     rhs.impl_ = nullptr;
 117   }
 118   return *this;
 119 }
 120
 121 Backtrace::~Backtrace()
 122 {
 123   if (impl_)
 124     impl_->unref();
 125 }
 126
 127 std::string const Backtrace::resolve() const
 128 {
 129   std::string result("");
 130
 131 #if HAVE_BOOST_STACKTRACE
 132   std::stringstream ss;
 133   ss << impl_->st;
 134   result.append(ss.str());
 135 #endif
 136   return result;
 137 }
 138
 139 void Backtrace::display() const
 140 {
 141   std::string backtrace = resolve();
 142   if (backtrace.empty()) {
 143     fprintf(stderr, "(backtrace not set -- did you install Boost.Stacktrace?)\n");
 144     return;
 145   }
 146   fprintf(stderr, "Backtrace (displayed in actor %s):\n", SIMIX_process_self_get_name());
 147   std::fprintf(stderr, "%s\n", backtrace.c_str());
 148 }
 149
 150 } // namespace xbt
 151 } // namespace simgrid