1 /* Copyright (c) 2005-2023. The SimGrid Team. All rights reserved. */
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. */
6 #include "src/internal_config.h"
8 #include <simgrid/actor.h>
9 #include <simgrid/s4u/Actor.hpp>
10 #include <xbt/backtrace.hpp>
11 #include <xbt/string.hpp>
12 #include <xbt/sysdep.h>
18 #if HAVE_BOOST_STACKTRACE_BACKTRACE
19 #define BOOST_STACKTRACE_USE_BACKTRACE
20 #include <boost/stacktrace.hpp>
21 #include <boost/stacktrace/detail/frame_decl.hpp>
22 #elif HAVE_BOOST_STACKTRACE_ADDR2LINE
23 #define BOOST_STACKTRACE_USE_ADDR2LINE
24 #include <boost/stacktrace.hpp>
25 #include <boost/stacktrace/detail/frame_decl.hpp>
28 /** @brief show the backtrace of the current point (lovely while debugging) */
29 void xbt_backtrace_display_current()
31 simgrid::xbt::Backtrace().display();
34 namespace simgrid::xbt {
37 #if HAVE_BOOST_STACKTRACE_BACKTRACE || HAVE_BOOST_STACKTRACE_ADDR2LINE
38 const boost::stacktrace::stacktrace st;
41 std::string resolve() const
48 for (boost::stacktrace::frame const& frame : st) {
49 const std::string frame_name = frame.name();
51 if (frame_name.rfind("simgrid::xbt::MainFunction", 0) == 0 ||
52 frame_name.rfind("simgrid::kernel::context::Context::operator()()", 0) == 0)
54 ss << " -> #" << frame_count++ << " ";
55 if (xbt_log_no_loc) // Don't display file source and line if so
56 ss << (frame_name.empty() ? "(debug info not found and log:no_loc activated)" : frame_name) << "\n";
59 // If we are displaying the user side of a simcall, remove the crude details of context switching
60 if (frame_name.find("simgrid::kernel::actor::simcall_answered") != std::string::npos ||
61 frame_name.find("simgrid::kernel::actor::simcall_blocking") != std::string::npos ||
62 frame_name.find("simcall_run_answered") != std::string::npos ||
63 frame_name.find("simcall_run_blocking") != std::string::npos) {
65 ss.str(""); // This is how you clear a stringstream in C++. clear() is something else :'(
67 if (frame_name == "main")
70 if (frame_name == "simgrid::xbt::Backtrace::Backtrace()")
80 std::string resolve() const { return ""; } // fallback value
84 Backtrace::Backtrace() : impl_(std::make_shared<BacktraceImpl>()) {}
86 std::string Backtrace::resolve() const
88 return impl_->resolve();
91 void Backtrace::display() const
93 std::string backtrace = resolve();
94 std::fprintf(stderr, "Backtrace (displayed in actor %s%s):\n%s\n",
95 simgrid::s4u::Actor::is_maestro() ? "maestro" : sg_actor_self_get_name(),
96 (xbt_log_no_loc ? " -- short trace because of --log=no_loc" : ""),
97 backtrace.empty() ? "(backtrace not set -- did you install Boost.Stacktrace?)" : backtrace.c_str());
100 } // namespace simgrid::xbt