Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use addr2line as a fallback for stacktraces when backtrace is not available
[simgrid.git] / src / xbt / backtrace.cpp
index 669856a..a7c8585 100644 (file)
-/* Copyright (c) 2005-2016. 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. */
 
+#include "src/internal_config.h"
+
+#include "simgrid/simix.h" /* SIMIX_process_self_get_name() */
+#include <xbt/backtrace.hpp>
+#include <xbt/log.h>
+#include <xbt/string.hpp>
+#include <xbt/sysdep.h>
+
 #include <cstddef>
 #include <cstdlib>
-
+#include <cstring>
+#include <fstream>
+#include <sstream>
+#include <sys/stat.h>
 #include <vector>
 
-// Try to detect and use the C++ intanium ABI for name demangling:
+#include <boost/algorithm/string.hpp>
+
+// Try to detect and use the C++ itanium ABI for name demangling:
 #ifdef __GXX_ABI_VERSION
 #include <cxxabi.h>
 #endif
 
-#include <xbt/backtrace.h>
-#include <xbt/backtrace.hpp>
-#include <xbt/log.h>
-#include <xbt/sysdep.h>
-
-#include "src/internal_config.h"
-
-extern "C" {
+#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");
 
-}
-
-/** @brief show the backtrace of the current point (lovely while debuging) */
-void xbt_backtrace_display_current(void)
+/** @brief show the backtrace of the current point (lovely while debugging) */
+void xbt_backtrace_display_current()
 {
-  const std::size_t size = 10;
-  xbt_backtrace_location_t bt[size];
-  size_t used = xbt_backtrace_current(bt, size);
-  xbt_backtrace_display(bt, used);
+  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, NULL, NULL, &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:
+  // 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);
 }
 
-std::vector<xbt_backtrace_location_t> backtrace()
+class BacktraceImpl {
+  short refcount_ = 1;
+
+public:
+  void ref() { refcount_++; }
+  bool unref()
+  {
+    refcount_--;
+    if (refcount_ == 0) {
+      delete this;
+      return true;
+    } else {
+      return false;
+    }
+  }
+#if HAVE_BOOST_STACKTRACE_BACKTRACE || HAVE_BOOST_STACKTRACE_ADDR2LINE
+  boost::stacktrace::stacktrace st;
+#endif
+};
+
+Backtrace::Backtrace()
 {
-  const std::size_t size = 10;
-  xbt_backtrace_location_t loc[size];
-  size_t used = xbt_backtrace_current(loc, size);
-  return std::vector<xbt_backtrace_location_t>(loc, loc + used);
+#if HAVE_BOOST_STACKTRACE_BACKTRACE || HAVE_BOOST_STACKTRACE_ADDR2LINE
+  impl_     = new BacktraceImpl();
+  impl_->st = boost::stacktrace::stacktrace();
+#endif
+}
+Backtrace::Backtrace(const Backtrace& bt)
+{
+  impl_ = bt.impl_;
+  if (impl_)
+    impl_->ref();
+}
+
+Backtrace::Backtrace(Backtrace&& bt)
+{
+  impl_    = bt.impl_;
+  bt.impl_ = nullptr;
 }
 
+Backtrace& Backtrace::operator=(const Backtrace& rhs)
+{
+  if (this != &rhs) {
+    if (impl_)
+      impl_->unref();
+    impl_ = rhs.impl_;
+    if (impl_)
+      impl_->ref();
+  }
+  return *this;
 }
+
+Backtrace& Backtrace::operator=(Backtrace&& rhs)
+{
+  if (this != &rhs) {
+    if (impl_)
+      impl_->unref();
+    impl_     = rhs.impl_;
+    rhs.impl_ = nullptr;
+  }
+  return *this;
 }
 
-#if HAVE_BACKTRACE && HAVE_EXECINFO_H && HAVE_POPEN && defined(ADDR2LINE)
-# include "src/xbt/backtrace_linux.cpp"
-#else
-# include "src/xbt/backtrace_dummy.cpp"
+Backtrace::~Backtrace()
+{
+  if (impl_)
+    impl_->unref();
+}
+
+std::string const Backtrace::resolve() const
+{
+  std::string result("");
+
+#if HAVE_BOOST_STACKTRACE_BACKTRACE || HAVE_BOOST_STACKTRACE_ADDR2LINE
+  std::stringstream ss;
+  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