Use addr2line as a fallback for stacktraces when backtrace is not available

[simgrid.git] / src / xbt / backtrace.cpp

diff --git a/src/xbt/backtrace.cpp b/src/xbt/backtrace.cpp
index db93b54..a7c8585 100644 (file)
--- a/src/xbt/backtrace.cpp
+++ b/src/xbt/backtrace.cpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2005-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2005-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -26,48 +26,37 @@
 #include <cxxabi.h>
 #endif
 
-#if HAVE_BOOST_STACKTRACE
+#if HAVE_BOOST_STACKTRACE_BACKTRACE
 #define BOOST_STACKTRACE_USE_BACKTRACE
 #include <boost/stacktrace.hpp>
+#elif HAVE_BOOST_STACKTRACE_ADDR2LINE
+#define BOOST_STACKTRACE_USE_ADDR2LINE
+#include <boost/stacktrace.hpp>
 #endif
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_backtrace, xbt, "Backtrace");
 
-void xbt_backtrace_display(const simgrid::xbt::Backtrace& bt)
-{
-  std::string backtrace = simgrid::xbt::resolve_backtrace(bt);
-  if (backtrace.empty()) {
-    fprintf(stderr, "(backtrace not set -- did you install Boost.Stacktrace?)\n");
-    return;
-  }
-  fprintf(stderr, "Backtrace (displayed in actor %s):\n", SIMIX_process_self_get_name());
-  std::fprintf(stderr, "%s\n", backtrace.c_str());
-}
-
 /** @brief show the backtrace of the current point (lovely while debugging) */
 void xbt_backtrace_display_current()
 {
-  simgrid::xbt::Backtrace bt = simgrid::xbt::Backtrace();
-  xbt_backtrace_display(bt);
+  simgrid::xbt::Backtrace().display();
 }
 
 namespace simgrid {
 namespace xbt {
 
-std::unique_ptr<char, void(*)(void*)> demangle(const char* name)
+std::unique_ptr<char, std::function<void(char*)>> demangle(const char* name)
 {
 #ifdef __GXX_ABI_VERSION
   int status;
-  auto res = std::unique_ptr<char, void(*)(void*)>(
-    abi::__cxa_demangle(name, nullptr, nullptr, &status),
-    std::free
-  );
+  std::unique_ptr<char, std::function<void(char*)>> res(abi::__cxa_demangle(name, nullptr, nullptr, &status),
+                                                        &std::free);
   if (res != nullptr)
     return res;
   // We did not manage to resolve this. Probably because this is not a mangled symbol:
 #endif
   // Return the symbol:
-  return std::unique_ptr<char, void(*)(void*)>(xbt_strdup(name), std::free);
+  return std::unique_ptr<char, std::function<void(char*)>>(xbt_strdup(name), &xbt_free_f);
 }
 
 class BacktraceImpl {
@@ -78,16 +67,21 @@ public:
   bool unref()
   {
     refcount_--;
-    return refcount_ == 0;
+    if (refcount_ == 0) {
+      delete this;
+      return true;
+    } else {
+      return false;
+    }
   }
-#if HAVE_BOOST_STACKTRACE
+#if HAVE_BOOST_STACKTRACE_BACKTRACE || HAVE_BOOST_STACKTRACE_ADDR2LINE
   boost::stacktrace::stacktrace st;
 #endif
 };
 
 Backtrace::Backtrace()
 {
-#if HAVE_BOOST_STACKTRACE
+#if HAVE_BOOST_STACKTRACE_BACKTRACE || HAVE_BOOST_STACKTRACE_ADDR2LINE
   impl_     = new BacktraceImpl();
   impl_->st = boost::stacktrace::stacktrace();
 #endif
@@ -99,29 +93,63 @@ Backtrace::Backtrace(const Backtrace& bt)
     impl_->ref();
 }
 
-Backtrace::~Backtrace()
+Backtrace::Backtrace(Backtrace&& bt)
+{
+  impl_    = bt.impl_;
+  bt.impl_ = nullptr;
+}
+
+Backtrace& Backtrace::operator=(const Backtrace& rhs)
 {
-  if (impl_ != nullptr && impl_->unref()) {
-    delete impl_;
+  if (this != &rhs) {
+    if (impl_)
+      impl_->unref();
+    impl_ = rhs.impl_;
+    if (impl_)
+      impl_->ref();
   }
+  return *this;
 }
-} // namespace xbt
-} // namespace simgrid
 
-namespace simgrid {
-namespace xbt {
+Backtrace& Backtrace::operator=(Backtrace&& rhs)
+{
+  if (this != &rhs) {
+    if (impl_)
+      impl_->unref();
+    impl_     = rhs.impl_;
+    rhs.impl_ = nullptr;
+  }
+  return *this;
+}
 
-std::string resolve_backtrace(const Backtrace& bt)
+Backtrace::~Backtrace()
+{
+  if (impl_)
+    impl_->unref();
+}
+
+std::string const Backtrace::resolve() const
 {
   std::string result("");
 
-#if HAVE_BOOST_STACKTRACE
+#if HAVE_BOOST_STACKTRACE_BACKTRACE || HAVE_BOOST_STACKTRACE_ADDR2LINE
   std::stringstream ss;
-  ss << bt.impl_->st;
+  ss << impl_->st;
   result.append(ss.str());
 #endif
   return result;
 }
 
+void Backtrace::display() const
+{
+  std::string backtrace = resolve();
+  if (backtrace.empty()) {
+    fprintf(stderr, "(backtrace not set -- did you install Boost.Stacktrace?)\n");
+    return;
+  }
+  fprintf(stderr, "Backtrace (displayed in actor %s):\n", SIMIX_process_self_get_name());
+  std::fprintf(stderr, "%s\n", backtrace.c_str());
+}
+
 } // namespace xbt
 } // namespace simgrid