src/xbt/backtrace_linux.cpp

   1 /* backtrace_linux - backtrace displaying on linux platform                 */
   2 /* This file is included by ex.cpp on need (have execinfo.h, popen & addrline)*/
   3
   4 /* Copyright (c) 2008-2018. The SimGrid Team. All rights reserved.          */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include <cerrno>
  10 #include <cstring>
  11 #include <fstream>
  12 #include <sstream>
  13 #include <string>
  14 #include <vector>
  15
  16 #include <boost/algorithm/string.hpp>
  17
  18 #include <unistd.h>
  19 #include <execinfo.h>
  20 #include <sys/stat.h>
  21
  22 /* 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 */
  23 #include <xbt/string.hpp>
  24 #include <xbt/backtrace.hpp>
  25 #include "xbt/ex.h"
  26 #include "xbt/log.h"
  27 #include "xbt/module.h"         /* xbt_binary_name */
  28 #include "src/xbt_modinter.h"       /* backtrace initialization headers */
  29 #if SIMGRID_HAVE_MC
  30 #define UNW_LOCAL_ONLY
  31 #include <libunwind.h>
  32 #endif
  33 /* end of "useless" inclusions */
  34
  35 extern char **environ;          /* the environment, as specified by the opengroup */
  36
  37 #include <unwind.h>
  38 struct trace_arg {
  39   void** array;
  40   int cnt;
  41   int size;
  42 };
  43
  44 static _Unwind_Reason_Code backtrace_helper(_Unwind_Context* ctx, void* a)
  45 {
  46   trace_arg* arg = static_cast<trace_arg*>(a);
  47
  48   /* We are first called with address in the __backtrace function.
  49      Skip it.  */
  50   if (arg->cnt != -1)
  51     {
  52       arg->array[arg->cnt] = (void *) _Unwind_GetIP(ctx);
  53
  54       /* Check whether we make any progress.  */
  55       if (arg->cnt > 0 && arg->array[arg->cnt - 1] == arg->array[arg->cnt])
  56         return _URC_END_OF_STACK;
  57     }
  58   if (++arg->cnt == arg->size)
  59     return _URC_END_OF_STACK;
  60   return _URC_NO_REASON;
  61 }
  62
  63 /** @brief reimplementation of glibc backtrace based directly on gcc library, without implicit malloc
  64  *
  65  * See http://people.irisa.fr/Martin.Quinson/blog/2012/0208/system_programming_fun_in_SimGrid/
  66  * for the motivation behind this function
  67  * */
  68
  69 int xbt_backtrace_no_malloc(void **array, int size) {
  70   int i = 0;
  71   for(i=0; i < size; i++)
  72     array[i] = nullptr;
  73
  74   struct trace_arg arg;
  75   arg .array = array;
  76   arg.size = size;
  77   arg.cnt = -1;
  78
  79   if (size >= 1)
  80     _Unwind_Backtrace(backtrace_helper, &arg);
  81
  82   /* _Unwind_Backtrace on IA-64 seems to put nullptr address above
  83      _start.  Fix it up here.  */
  84   if (arg.cnt > 1 && arg.array[arg.cnt - 1] == nullptr)
  85     --arg.cnt;
  86   return arg.cnt != -1 ? arg.cnt : 0;
  87 }
  88
  89 size_t xbt_backtrace_current(xbt_backtrace_location_t* loc, std::size_t count)
  90 {
  91   std::size_t used = backtrace(loc, count);
  92   if (used == 0) {
  93     std::fprintf(stderr, "The backtrace() function failed, which probably means that the memory is exhausted\n.");
  94     std::fprintf(stderr, "Bailing out now since there is nothing I can do without a decent amount of memory\n.");
  95     std::fprintf(stderr, "Please go fix the memleaks\n");
  96     std::exit(1);
  97   }
  98   return used;
  99 }
 100
 101 namespace simgrid {
 102 namespace xbt {
 103
 104 /** Find the path of the binary file from the name found in argv */
 105 static std::string get_binary_path()
 106 {
 107   struct stat stat_buf;
 108
 109   if (xbt_binary_name == nullptr)
 110     return "";
 111
 112   // We found it, we are happy:
 113   if (stat(xbt_binary_name, &stat_buf) == 0)
 114     return xbt_binary_name;
 115
 116   // Not found, look in the PATH:
 117   char* path = getenv("PATH");
 118   if (path == nullptr)
 119     return "";
 120   XBT_DEBUG("Looking in the PATH: %s\n", path);
 121   std::vector<std::string> path_list;
 122   // TODO, on Windows, this is ";"
 123   boost::split(path_list, path, boost::is_any_of(":"));
 124   for (std::string const& path_item : path_list) {
 125     std::string binary_name = simgrid::xbt::string_printf(
 126       "%s/%s", path_item.c_str(), xbt_binary_name);
 127     bool found = (stat(binary_name.c_str(), &stat_buf) == 0);
 128     XBT_DEBUG("Looked in the PATH for the binary. %s %s",
 129       found ? "Found" : "Not found",
 130       binary_name.c_str());
 131     if (found)
 132       return binary_name;
 133   }
 134
 135   // Not found at all:
 136   return "";
 137 }
 138
 139 std::vector<std::string> resolveBacktrace(xbt_backtrace_location_t const* loc, std::size_t count) // deprecated
 140 {
 141   return resolve_backtrace(loc, count);
 142 }
 143
 144 //FIXME: This code could be greatly improved/simplifyied with
 145 //   http://cairo.sourcearchive.com/documentation/1.9.4/backtrace-symbols_8c-source.html
 146 std::vector<std::string> resolve_backtrace(xbt_backtrace_location_t const* loc, std::size_t count)
 147 {
 148   std::vector<std::string> result;
 149
 150   if (count == 0)
 151     return result;
 152
 153   if (xbt_binary_name == nullptr)
 154     XBT_WARN("XBT not initialized, the backtrace will not be resolved.");
 155
 156   // Drop the first one:
 157   loc++; count--;
 158
 159   char** backtrace_syms = backtrace_symbols(loc, count);
 160   std::string binary_name = get_binary_path();
 161
 162   if (binary_name.empty()) {
 163     for (std::size_t i = 0; i < count; i++)
 164       result.push_back(simgrid::xbt::string_printf("%p", loc[i]));
 165     return result;
 166   }
 167
 168   // Create the system command for add2line:
 169   std::ostringstream stream;
 170   stream << ADDR2LINE << " -f -e " << binary_name << ' ';
 171   std::vector<std::string> addrs(count);
 172   for (std::size_t i = 0; i < count; i++) {
 173     /* retrieve this address */
 174     XBT_DEBUG("Retrieving address number %zu from '%s'", i, backtrace_syms[i]);
 175     char buff[256];
 176     snprintf(buff, 256, "%s", strchr(backtrace_syms[i], '[') + 1);
 177     char* p = strchr(buff, ']');
 178     *p = '\0';
 179     if (strcmp(buff, "(nil)"))
 180       addrs[i] = buff;
 181     else
 182       addrs[i] = "0x0";
 183     XBT_DEBUG("Set up a new address: %zu, '%s'", i, addrs[i].c_str());
 184     /* Add it to the command line args */
 185     stream << addrs[i] << ' ';
 186   }
 187   std::string cmd = stream.str();
 188
 189   /* size (in char) of pointers on this arch */
 190   int addr_len = addrs[0].size();
 191
 192   XBT_VERB("Fire a first command: '%s'", cmd.c_str());
 193   FILE* pipe = popen(cmd.c_str(), "r");
 194   if (not pipe) {
 195     xbt_die("Cannot fork addr2line to display the backtrace");
 196   }
 197
 198   /* To read the output of addr2line */
 199   char line_func[1024];
 200   char line_pos[1024];
 201   for (std::size_t i = 0; i < count; i++) {
 202     XBT_DEBUG("Looking for symbol %zu, addr = '%s'", i, addrs[i].c_str());
 203     if (fgets(line_func, 1024, pipe)) {
 204       line_func[strlen(line_func) - 1] = '\0';
 205     } else {
 206       XBT_VERB("Cannot run fgets to look for symbol %zu, addr %s", i, addrs[i].c_str());
 207       strncpy(line_func, "???", 4);
 208     }
 209     if (fgets(line_pos, 1024, pipe)) {
 210       line_pos[strlen(line_pos) - 1] = '\0';
 211     } else {
 212       XBT_VERB("Cannot run fgets to look for symbol %zu, addr %s", i, addrs[i].c_str());
 213       strncpy(line_pos, backtrace_syms[i],1024);
 214     }
 215
 216     if (strcmp("??", line_func) != 0) {
 217       auto name = simgrid::xbt::demangle(line_func);
 218       XBT_DEBUG("Found static symbol %s at %s", name.get(), line_pos);
 219       result.push_back(simgrid::xbt::string_printf(
 220         "%s at %s, %p", name.get(), line_pos, loc[i]
 221       ));
 222     } else {
 223       /* Damn. The symbol is in a dynamic library. Let's get wild */
 224
 225       unsigned long int offset = 0;
 226       int found = 0;
 227
 228       /* let's look for the offset of this library in our addressing space */
 229       std::string maps_name = std::string("/proc/") + std::to_string(getpid()) + "/maps";
 230       std::ifstream maps(maps_name);
 231       if (not maps) {
 232         XBT_CRITICAL("open(\"%s\") failed: %s", maps_name.c_str(), strerror(errno));
 233         continue;
 234       }
 235       size_t pos;
 236       unsigned long int addr = std::stoul(addrs[i], &pos, 16);
 237       if (pos != addrs[i].length()) {
 238         XBT_CRITICAL("Cannot parse backtrace address '%s' (addr=%#lx)", addrs[i].c_str(), addr);
 239       }
 240       XBT_DEBUG("addr=%s (as string) =%#lx (as number)", addrs[i].c_str(), addr);
 241
 242       while (not found) {
 243         unsigned long int first;
 244         unsigned long int last;
 245
 246         std::string maps_buff;
 247         if (not std::getline(maps, maps_buff))
 248           break;
 249         if (i == 0) {
 250           XBT_DEBUG("map line: %s", maps_buff.c_str());
 251         }
 252         first = std::stoul(maps_buff, &pos, 16);
 253         maps_buff.erase(0, pos + 1);
 254         last = std::stoul(maps_buff, nullptr, 16);
 255         if (first < addr && addr < last) {
 256           offset = first;
 257           found = 1;
 258         }
 259         if (found) {
 260           XBT_DEBUG("%#lx in [%#lx-%#lx]", addr, first, last);
 261           XBT_DEBUG("Symbol found, map lines not further displayed (even if looking for next ones)");
 262         }
 263       }
 264       maps.close();
 265       addrs[i].clear();
 266
 267       if (not found) {
 268         XBT_VERB("Problem while reading the maps file. Following backtrace will be mangled.");
 269         XBT_DEBUG("No dynamic. Static symbol: %s", backtrace_syms[i]);
 270         result.push_back(simgrid::xbt::string_printf("?? (%s)", backtrace_syms[i]));
 271         continue;
 272       }
 273
 274       /* Ok, Found the offset of the maps line containing the searched symbol.
 275          We now need to substract this from the address we got from backtrace.
 276        */
 277
 278       addrs[i] = simgrid::xbt::string_printf("0x%0*lx", addr_len - 2, addr - offset);
 279       XBT_DEBUG("offset=%#lx new addr=%s", offset, addrs[i].c_str());
 280
 281       /* Got it. We have our new address. Let's get the library path and we are set */
 282       std::string p(backtrace_syms[i]);
 283       if (p[0] == '[') {
 284         /* library path not displayed in the map file either... */
 285         snprintf(line_func, 3, "??");
 286       } else {
 287         size_t p2 = p.find_first_of("( ");
 288         if (p2 != std::string::npos)
 289           p.erase(p2);
 290
 291         /* Here we go, fire an addr2line up */
 292         std::string subcmd = std::string(ADDR2LINE) + " -f -e " + p + " " + addrs[i];
 293         XBT_VERB("Fire a new command: '%s'", subcmd.c_str());
 294         FILE* subpipe = popen(subcmd.c_str(), "r");
 295         if (not subpipe) {
 296           xbt_die("Cannot fork addr2line to display the backtrace");
 297         }
 298         if (fgets(line_func, 1024, subpipe)) {
 299           line_func[strlen(line_func) - 1] = '\0';
 300         } else {
 301           XBT_VERB("Cannot read result of subcommand %s", subcmd.c_str());
 302           strncpy(line_func, "???", 4);
 303         }
 304         if (fgets(line_pos, 1024, subpipe)) {
 305           line_pos[strlen(line_pos) - 1] = '\0';
 306         } else {
 307           XBT_VERB("Cannot read result of subcommand %s", subcmd.c_str());
 308           strncpy(line_pos, backtrace_syms[i],1024);
 309         }
 310         pclose(subpipe);
 311       }
 312
 313       /* check whether the trick worked */
 314       if (strcmp("??", line_func)) {
 315         auto name = simgrid::xbt::demangle(line_func);
 316         XBT_DEBUG("Found dynamic symbol %s at %s", name.get(), line_pos);
 317         result.push_back(simgrid::xbt::string_printf(
 318           "%s at %s, %p", name.get(), line_pos, loc[i]));
 319       } else {
 320         /* damn, nothing to do here. Let's print the raw address */
 321         XBT_DEBUG("Dynamic symbol not found. Raw address = %s", backtrace_syms[i]);
 322         result.push_back(simgrid::xbt::string_printf(
 323           "?? at %s", backtrace_syms[i]));
 324       }
 325     }
 326     addrs[i].clear();
 327
 328     /* Mask the bottom of the stack */
 329     const char* const breakers[] = {
 330         "main",
 331         "_ZN7simgrid6kernel7context13ThreadContext7wrapperE", // simgrid::kernel::context::ThreadContext::wrapper
 332         "_ZN7simgrid6kernel7context8UContext7wrapperE"        // simgrid::kernel::context::UContext::wrapper
 333     };
 334     bool do_break = false;
 335     for (const char* b : breakers) {
 336       if (strncmp(b, line_func, strlen(b)) == 0) {
 337         do_break = true;
 338         break;
 339       }
 340     }
 341     if (do_break)
 342       break;
 343   }
 344   pclose(pipe);
 345   free(backtrace_syms);
 346   return result;
 347 }
 348
 349 }
 350 }
 351
 352 #if SIMGRID_HAVE_MC
 353 int xbt_libunwind_backtrace(void** bt, int size){
 354   for (int i = 0; i < size; i++)
 355     bt[i] = nullptr;
 356
 357   unw_cursor_t c;
 358   unw_context_t uc;
 359
 360   unw_getcontext (&uc);
 361   unw_init_local (&c, &uc);
 362
 363   unw_step(&c);
 364
 365   int i;
 366   for (i = 0; unw_step(&c) >= 0 && i < size; i++) {
 367     unw_word_t ip;
 368     unw_get_reg(&c, UNW_REG_IP, &ip);
 369     bt[i] = (void*)(long)ip;
 370   }
 371
 372   return i;
 373 }
 374 #endif