X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/166ad11130482e81d2c3e860ab6c61e972a4cdf6..c4c82977e0a105cdf7b04010ddd21bbf15dced4d:/src/xbt/backtrace.cpp

diff --git a/src/xbt/backtrace.cpp b/src/xbt/backtrace.cpp
index 022ae52a55..b719eaf696 100644
--- a/src/xbt/backtrace.cpp
+++ b/src/xbt/backtrace.cpp
@@ -1,102 +1,101 @@
-/* Copyright (c) 2005-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2005-2023. 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 <cstddef>
-#include <cstdlib>
-#include <cstring>
-
-#include <vector>
-
-// Try to detect and use the C++ intanium ABI for name demangling:
-#ifdef __GXX_ABI_VERSION
-#include <cxxabi.h>
-#endif
+#include "src/internal_config.h"
 
-#include "simgrid/simix.h" /* SIMIX_process_self_get_name() */
-#include <xbt/backtrace.h>
+#include <simgrid/actor.h>
+#include <simgrid/s4u/Actor.hpp>
 #include <xbt/backtrace.hpp>
-#include <xbt/log.h>
+#include <xbt/string.hpp>
 #include <xbt/sysdep.h>
 
-#include "src/internal_config.h"
-
-extern "C" {
-
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_backtrace, xbt, "Backtrace");
-
-}
-
-static bool startWith(std::string str, const char* prefix)
-{
-  return strncmp(str.c_str(), prefix, strlen(prefix)) == 0;
-}
-
-void xbt_backtrace_display(xbt_backtrace_location_t* loc, std::size_t count)
-{
-#ifdef HAVE_BACKTRACE
-  std::vector<std::string> backtrace = simgrid::xbt::resolveBacktrace(loc, count);
-  if (backtrace.empty()) {
-    fprintf(stderr, "(backtrace not set)\n");
-    return;
-  }
-  fprintf(stderr, "Backtrace (displayed in process %s):\n", SIMIX_process_self_get_name());
-  for (std::string const& s : backtrace) {
-    if (startWith(s, "xbt_backtrace_display_current"))
-      continue;
-
-    std::fprintf(stderr, "---> '%s'\n", s.c_str());
-    if (startWith(s, "SIMIX_simcall_handle") ||
-        startWith(s, "simgrid::xbt::MainFunction") /* main used with thread factory */)
-      break;
-  }
-#else
-  XBT_ERROR("Cannot display backtrace when compiled without libunwind.");
+#include <cstdio>
+#include <cstdlib>
+#include <sstream>
+
+#if HAVE_BOOST_STACKTRACE_BACKTRACE
+#define BOOST_STACKTRACE_USE_BACKTRACE
+#include <boost/stacktrace.hpp>
+#include <boost/stacktrace/detail/frame_decl.hpp>
+#elif HAVE_BOOST_STACKTRACE_ADDR2LINE
+#define BOOST_STACKTRACE_USE_ADDR2LINE
+#include <boost/stacktrace.hpp>
+#include <boost/stacktrace/detail/frame_decl.hpp>
 #endif
-}
 
 /** @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 {
+namespace simgrid::xbt {
+
+class BacktraceImpl {
+#if HAVE_BOOST_STACKTRACE_BACKTRACE || HAVE_BOOST_STACKTRACE_ADDR2LINE
+  const boost::stacktrace::stacktrace st;
+
+public:
+  std::string resolve() const
+  {
+    std::stringstream ss;
+
+    int frame_count = 0;
+    bool print      = false;
+
+    for (boost::stacktrace::frame const& frame : st) {
+      const std::string frame_name = frame.name();
+      if (print) {
+        if (frame_name.rfind("simgrid::xbt::MainFunction", 0) == 0 ||
+            frame_name.rfind("simgrid::kernel::context::Context::operator()()", 0) == 0 ||
+            frame_name.rfind("auto sthread_create::{lambda") == 0)
+          break;
+        ss << "  ->  #" << frame_count++ << " ";
+        if (xbt_log_no_loc) // Don't display file source and line if so
+          ss << (frame_name.empty() ? "(debug info not found and log:no_loc activated)" : frame_name) << "\n";
+        else
+          ss << frame << "\n";
+        // If we are displaying the user side of a simcall, remove the crude details of context switching
+        if (frame_name.find("simgrid::kernel::actor::simcall_answered") != std::string::npos ||
+            frame_name.find("simgrid::kernel::actor::simcall_blocking") != std::string::npos ||
+            frame_name.find("simcall_run_answered") != std::string::npos ||
+            frame_name.find("simcall_run_blocking") != std::string::npos) {
+          frame_count = 0;
+          ss.str(""); // This is how you clear a stringstream in C++. clear() is something else :'(
+        }
+        if (frame_name == "main")
+          break;
+      } else {
+        if (frame_name == "simgrid::xbt::Backtrace::Backtrace()")
+          print = true;
+      }
+    }
+
+    return ss.str();
+  }
+#else
 
-std::unique_ptr<char, void(*)(void*)> 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
-  );
-  if (res != nullptr)
-    return res;
-  // We did not manage to resolve this. Probably because this is not a mangled symbol:
+public:
+  std::string resolve() const { return ""; } // fallback value
 #endif
-  // Return the symbol:
-  return std::unique_ptr<char, void(*)(void*)>(xbt_strdup(name), std::free);
-}
+};
 
-std::vector<xbt_backtrace_location_t> backtrace()
+Backtrace::Backtrace() : impl_(std::make_shared<BacktraceImpl>()) {}
+
+std::string Backtrace::resolve() const
 {
-  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);
+  return impl_->resolve();
 }
 
-}
+void Backtrace::display() const
+{
+  std::string backtrace = resolve();
+  std::fprintf(stderr, "Backtrace (displayed in actor %s%s):\n%s\n",
+               simgrid::s4u::Actor::is_maestro() ? "maestro" : sg_actor_self_get_name(),
+               (xbt_log_no_loc ? " -- short trace because of --log=no_loc" : ""),
+               backtrace.empty() ? "(backtrace not set -- did you install Boost.Stacktrace?)" : backtrace.c_str());
 }
 
-#if HAVE_BACKTRACE && HAVE_EXECINFO_H && HAVE_POPEN && defined(ADDR2LINE)
-# include "src/xbt/backtrace_linux.cpp"
-#else
-# include "src/xbt/backtrace_dummy.cpp"
-#endif
+} // namespace simgrid::xbt