X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/528fa2ce6be027b5428d122666ffc37706155449..c4c82977e0a105cdf7b04010ddd21bbf15dced4d:/src/xbt/backtrace.cpp diff --git a/src/xbt/backtrace.cpp b/src/xbt/backtrace.cpp index e64eab1add..b719eaf696 100644 --- a/src/xbt/backtrace.cpp +++ b/src/xbt/backtrace.cpp @@ -1,69 +1,101 @@ -/* Copyright (c) 2005-2016. The SimGrid Team. - * All rights reserved. */ - -/* Copyright (c) 2002-2004 Ralf S. Engelschall */ -/* Copyright (c) 2002-2004 The OSSP Project */ -/* Copyright (c) 2002-2004 Cable & Wireless */ -/* All rights reserved. */ - -/* This code is inspirated from the OSSP version (as retrieved back in 2004)*/ -/* It was heavily modified to fit the SimGrid framework. */ - -/* The OSSP version has the following copyright notice: -** OSSP ex - Exception Handling -** Copyright (c) 2002-2004 Ralf S. Engelschall -** Copyright (c) 2002-2004 The OSSP Project -** Copyright (c) 2002-2004 Cable & Wireless -** -** This file is part of OSSP ex, an exception handling library -** which can be found at http://www.ossp.org/pkg/lib/ex/. -** -** Permission to use, copy, modify, and distribute this software for -** any purpose with or without fee is hereby granted, provided that -** the above copyright notice and this permission notice appear in all -** copies. -** -** THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED -** WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -** MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. -** IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR -** CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF -** USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND -** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT -** OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -** SUCH DAMAGE. - */ - -/* The extensions made for the SimGrid project can either be distributed */ -/* under the same license, or under the LGPL v2.1 */ - -#include - -#include -#include +/* 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 "src/internal_config.h" -extern "C" { +#include +#include +#include +#include +#include -XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_backtrace, xbt, "Backtrace"); +#include +#include +#include -} +#if HAVE_BOOST_STACKTRACE_BACKTRACE +#define BOOST_STACKTRACE_USE_BACKTRACE +#include +#include +#elif HAVE_BOOST_STACKTRACE_ADDR2LINE +#define BOOST_STACKTRACE_USE_ADDR2LINE +#include +#include +#endif -/** \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(); } -#if HAVE_BACKTRACE && HAVE_EXECINFO_H && HAVE_POPEN && defined(ADDR2LINE) -# include "src/xbt/backtrace_linux.cpp" +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 -# include "src/xbt/backtrace_dummy.cpp" + +public: + std::string resolve() const { return ""; } // fallback value #endif +}; + +Backtrace::Backtrace() : impl_(std::make_shared()) {} + +std::string Backtrace::resolve() const +{ + 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()); +} + +} // namespace simgrid::xbt