/* backtrace_linux - backtrace displaying on linux platform */
/* This file is included by ex.cpp on need (have execinfo.h, popen & addrline)*/
-/* Copyright (c) 2008-2015. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2008-2017. 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 <sstream>
+#include <string>
+#include <vector>
+
+#include <boost/algorithm/string.hpp>
#include <unistd.h>
#include <execinfo.h>
/* This file is to be included in ex.cpp, so the following headers are not mandatory, but it's to make sure that eclipse see them too */
#include <xbt/string.hpp>
+#include <xbt/backtrace.hpp>
#include "xbt/ex.h"
-#include "src/xbt/ex_interface.h"
#include "xbt/log.h"
#include "xbt/str.h"
#include "xbt/module.h" /* xbt_binary_name */
#include "src/xbt_modinter.h" /* backtrace initialization headers */
-#if HAVE_MC
+#if SIMGRID_HAVE_MC
#define UNW_LOCAL_ONLY
#include <libunwind.h>
#endif
extern char **environ; /* the environment, as specified by the opengroup */
-/* Module creation/destruction: nothing to do on linux */
-void xbt_backtrace_preinit(void)
-{
-}
-
-void xbt_backtrace_postexit(void)
-{
-}
-
#include <unwind.h>
struct trace_arg {
- void **array;
- int cnt, size;
+ void** array;
+ int cnt;
+ int size;
};
static _Unwind_Reason_Code
/** @brief reimplementation of glibc backtrace based directly on gcc library, without implicit malloc
*
- * See http://webloria.loria.fr/~quinson/blog/2012/0208/system_programming_fun_in_SimGrid/
+ * See http://people.irisa.fr/Martin.Quinson/blog/2012/0208/system_programming_fun_in_SimGrid/
* for the motivation behind this function
* */
int xbt_backtrace_no_malloc(void **array, int size) {
int i = 0;
for(i=0; i < size; i++)
- array[i] = NULL;
+ array[i] = nullptr;
struct trace_arg arg;
arg .array = array;
if (size >= 1)
_Unwind_Backtrace(backtrace_helper, &arg);
- /* _Unwind_Backtrace on IA-64 seems to put NULL address above
+ /* _Unwind_Backtrace on IA-64 seems to put nullptr address above
_start. Fix it up here. */
- if (arg.cnt > 1 && arg.array[arg.cnt - 1] == NULL)
+ if (arg.cnt > 1 && arg.array[arg.cnt - 1] == nullptr)
--arg.cnt;
return arg.cnt != -1 ? arg.cnt : 0;
}
namespace simgrid {
namespace xbt {
+/** Find the path of the binary file from the name found in argv */
+static std::string get_binary_path()
+{
+ struct stat stat_buf;
+
+ if (xbt_binary_name == nullptr)
+ return "";
+
+ // We found it, we are happy:
+ if (stat(xbt_binary_name, &stat_buf) == 0)
+ return xbt_binary_name;
+
+ // Not found, look in the PATH:
+ char* path = getenv("PATH");
+ if (path == nullptr)
+ return "";
+ XBT_DEBUG("Looking in the PATH: %s\n", path);
+ std::vector<std::string> path_list;
+ // TODO, on Windows, this is ";"
+ boost::split(path_list, path, boost::is_any_of(":"));
+ for (std::string const& path_item : path_list) {
+ std::string binary_name = simgrid::xbt::string_printf(
+ "%s/%s", path_item.c_str(), xbt_binary_name);
+ bool found = (stat(binary_name.c_str(), &stat_buf) == 0);
+ XBT_DEBUG("Looked in the PATH for the binary. %s %s",
+ found ? "Found" : "Not found",
+ binary_name.c_str());
+ if (found)
+ return binary_name;
+ }
+
+ // Not found at all:
+ return "";
+}
+
//FIXME: This code could be greatly improved/simplifyied with
// http://cairo.sourcearchive.com/documentation/1.9.4/backtrace-symbols_8c-source.html
std::vector<std::string> resolveBacktrace(
- xbt_backtrace_location_t* loc, std::size_t count)
+ xbt_backtrace_location_t const* loc, std::size_t count)
{
std::vector<std::string> result;
- /* To search for the right executable path when not trivial */
- struct stat stat_buf;
-
- /* no binary name, nothing to do */
- if (xbt_binary_name == NULL)
- return result;
-
if (count == 0)
return result;
+ if (xbt_binary_name == nullptr)
+ XBT_WARN("XBT not initialized, the backtrace will not be resolved.");
+
// Drop the first one:
loc++; count--;
char** backtrace_syms = backtrace_symbols(loc, count);
+ std::string binary_name = get_binary_path();
- // Find the binary name:
- std::string binary_name;
- /* build the commandline */
- if (stat(xbt_binary_name, &stat_buf)) {
- /* Damn. binary not in current dir. We'll have to dig the PATH to find it */
- for (std::size_t i = 0; environ[i]; i++) {
- if (!strncmp("PATH=", environ[i], 5)) {
- xbt_dynar_t path = xbt_str_split(environ[i] + 5, ":");
- unsigned int cpt;
- char *data;
-
- xbt_dynar_foreach(path, cpt, data) {
- binary_name = simgrid::xbt::string_printf("%s/%s", data, xbt_binary_name);
- if (!stat(binary_name.c_str(), &stat_buf)) {
- /* Found. */
- XBT_DEBUG("Looked in the PATH for the binary. Found %s", binary_name.c_str());
- break;
- }
- }
- xbt_dynar_free(&path);
- if (stat(binary_name.c_str(), &stat_buf)) {
- /* not found */
- result = { simgrid::xbt::string_printf(
- "(binary '%s' not found in the PATH)", xbt_binary_name) };
- free(backtrace_syms);
- return result;
- }
- break;
- }
- }
- } else {
- binary_name = xbt_binary_name;
+ if (binary_name.empty()) {
+ for (std::size_t i = 0; i < count; i++)
+ result.push_back(simgrid::xbt::string_printf("%p", loc[i]));
+ return result;
}
// Create the system command for add2line:
std::vector<std::string> addrs(count);
for (std::size_t i = 0; i < count; i++) {
/* retrieve this address */
- XBT_DEBUG("Retrieving address number %zd from '%s'", i, backtrace_syms[i]);
+ XBT_DEBUG("Retrieving address number %zu from '%s'", i, backtrace_syms[i]);
char buff[256];
snprintf(buff, 256, "%s", strchr(backtrace_syms[i], '[') + 1);
char* p = strchr(buff, ']');
addrs[i] = buff;
else
addrs[i] = "0x0";
- XBT_DEBUG("Set up a new address: %zd, '%s'", i, addrs[i].c_str());
+ XBT_DEBUG("Set up a new address: %zu, '%s'", i, addrs[i].c_str());
/* Add it to the command line args */
stream << addrs[i] << ' ';
}
- binary_name.clear();
std::string cmd = stream.str();
/* size (in char) of pointers on this arch */
XBT_VERB("Fire a first command: '%s'", cmd.c_str());
FILE* pipe = popen(cmd.c_str(), "r");
- if (!pipe) {
+ if (not pipe) {
xbt_die("Cannot fork addr2line to display the backtrace");
}
/* To read the output of addr2line */
- char line_func[1024], line_pos[1024];
+ char line_func[1024];
+ char line_pos[1024];
for (std::size_t i = 0; i < count; i++) {
- XBT_DEBUG("Looking for symbol %zd, addr = '%s'", i, addrs[i].c_str());
+ XBT_DEBUG("Looking for symbol %zu, addr = '%s'", i, addrs[i].c_str());
if (fgets(line_func, 1024, pipe)) {
line_func[strlen(line_func) - 1] = '\0';
} else {
- XBT_VERB("Cannot run fgets to look for symbol %zd, addr %s", i, addrs[i].c_str());
+ XBT_VERB("Cannot run fgets to look for symbol %zu, addr %s", i, addrs[i].c_str());
strncpy(line_func, "???",3);
}
if (fgets(line_pos, 1024, pipe)) {
line_pos[strlen(line_pos) - 1] = '\0';
} else {
- XBT_VERB("Cannot run fgets to look for symbol %zd, addr %s", i, addrs[i].c_str());
+ XBT_VERB("Cannot run fgets to look for symbol %zu, addr %s", i, addrs[i].c_str());
strncpy(line_pos, backtrace_syms[i],1024);
}
if (strcmp("??", line_func) != 0) {
- XBT_DEBUG("Found static symbol %s() at %s", line_func, line_pos);
+ auto name = simgrid::xbt::demangle(line_func);
+ XBT_DEBUG("Found static symbol %s at %s", name.get(), line_pos);
result.push_back(simgrid::xbt::string_printf(
- "%s() at %s", line_func, line_pos
+ "%s at %s, %p", name.get(), line_pos, loc[i]
));
} else {
/* Damn. The symbol is in a dynamic library. Let's get wild */
char maps_buff[512];
- long int offset = 0;
- char *p, *p2;
+ unsigned long int offset = 0;
+ char* p;
int found = 0;
/* let's look for the offset of this library in our addressing space */
char* maps_name = bprintf("/proc/%d/maps", (int) getpid());
FILE* maps = fopen(maps_name, "r");
- long int addr = strtol(addrs[i].c_str(), &p, 16);
+ unsigned long int addr = strtoul(addrs[i].c_str(), &p, 16);
if (*p != '\0') {
- XBT_CRITICAL("Cannot parse backtrace address '%s' (addr=%#lx)",
- addrs[i].c_str(), addr);
+ XBT_CRITICAL("Cannot parse backtrace address '%s' (addr=%#lx)", addrs[i].c_str(), addr);
}
- XBT_DEBUG("addr=%s (as string) =%#lx (as number)",
- addrs[i].c_str(), addr);
+ XBT_DEBUG("addr=%s (as string) =%#lx (as number)", addrs[i].c_str(), addr);
- while (!found) {
- long int first, last;
+ while (not found) {
+ unsigned long int first;
+ unsigned long int last;
- if (fgets(maps_buff, 512, maps) == NULL)
+ if (fgets(maps_buff, 512, maps) == nullptr)
break;
if (i == 0) {
maps_buff[strlen(maps_buff) - 1] = '\0';
free(maps_name);
addrs[i].clear();
- if (!found) {
+ if (not found) {
XBT_VERB("Problem while reading the maps file. Following backtrace will be mangled.");
XBT_DEBUG("No dynamic. Static symbol: %s", backtrace_syms[i]);
result.push_back(simgrid::xbt::string_printf("?? (%s)", backtrace_syms[i]));
free(p);
snprintf(line_func,3, "??");
} else {
- p2 = strrchr(p, '(');
+ char* p2 = strrchr(p, '(');
if (p2)
*p2 = '\0';
p2 = strrchr(p, ' ');
free(p);
XBT_VERB("Fire a new command: '%s'", subcmd);
FILE* subpipe = popen(subcmd, "r");
- if (!subpipe) {
+ if (not subpipe) {
xbt_die("Cannot fork addr2line to display the backtrace");
}
if (fgets(line_func, 1024, subpipe)) {
/* check whether the trick worked */
if (strcmp("??", line_func)) {
- XBT_DEBUG("Found dynamic symbol %s() at %s", line_func, line_pos);
+ auto name = simgrid::xbt::demangle(line_func);
+ XBT_DEBUG("Found dynamic symbol %s at %s", name.get(), line_pos);
result.push_back(simgrid::xbt::string_printf(
- "%s() at %s", line_func, line_pos));
+ "%s at %s, %p", name.get(), line_pos, loc[i]));
} else {
/* damn, nothing to do here. Let's print the raw address */
XBT_DEBUG("Dynamic symbol not found. Raw address = %s", backtrace_syms[i]);
addrs[i].clear();
/* Mask the bottom of the stack */
- if (!strncmp("main", line_func, strlen("main")) ||
- !strncmp("xbt_thread_context_wrapper", line_func, strlen("xbt_thread_context_wrapper"))
- || !strncmp("smx_ctx_sysv_wrapper", line_func, strlen("smx_ctx_sysv_wrapper")))
+ if (not strncmp("main", line_func, strlen("main")) ||
+ not strncmp("xbt_thread_context_wrapper", line_func, strlen("xbt_thread_context_wrapper")) ||
+ not strncmp("smx_ctx_sysv_wrapper", line_func, strlen("smx_ctx_sysv_wrapper")))
break;
}
pclose(pipe);
}
}
-#if HAVE_MC
+#if SIMGRID_HAVE_MC
int xbt_libunwind_backtrace(void** bt, int size){
- int i = 0;
- for(i=0; i < size; i++)
- bt[i] = NULL;
-
- i=0;
+ for (int i = 0; i < size; i++)
+ bt[i] = nullptr;
unw_cursor_t c;
unw_context_t uc;
unw_getcontext (&uc);
unw_init_local (&c, &uc);
- unw_word_t ip;
-
unw_step(&c);
- while(unw_step(&c) >= 0 && i < size){
+ int i;
+ for (i = 0; unw_step(&c) >= 0 && i < size; i++) {
+ unw_word_t ip;
unw_get_reg(&c, UNW_REG_IP, &ip);
bt[i] = (void*)(long)ip;
- i++;
}
return i;
