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-2016. The SimGrid Team.
   5  * All rights reserved.                                                     */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #include <sstream>
  11 #include <string>
  12 #include <vector>
  13
  14 #include <boost/algorithm/string.hpp>
  15
  16 #include <unistd.h>
  17 #include <execinfo.h>
  18 #include <sys/stat.h>
  19
  20 /* 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 */
  21 #include <xbt/string.hpp>
  22 #include <xbt/backtrace.hpp>
  23 #include "xbt/ex.h"
  24 #include "src/xbt/ex_interface.h"
  25 #include "xbt/log.h"
  26 #include "xbt/str.h"
  27 #include "xbt/module.h"         /* xbt_binary_name */
  28 #include "src/xbt_modinter.h"       /* backtrace initialization headers */
  29 #if 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, size;
  41 };
  42
  43 static _Unwind_Reason_Code
  44 backtrace_helper (struct _Unwind_Context *ctx, void *a)
  45 {
  46   struct trace_arg *arg = (struct 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://webloria.loria.fr/~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 //FIXME: This code could be greatly improved/simplifyied with
 140 //   http://cairo.sourcearchive.com/documentation/1.9.4/backtrace-symbols_8c-source.html
 141 std::vector<std::string> resolveBacktrace(
 142   xbt_backtrace_location_t const* loc, std::size_t count)
 143 {
 144   std::vector<std::string> result;
 145
 146   if (count == 0)
 147     return result;
 148
 149   if (xbt_binary_name == nullptr)
 150     XBT_WARN("XBT not initialized, the backtrace will not be resolved.");
 151
 152   // Drop the first one:
 153   loc++; count--;
 154
 155   char** backtrace_syms = backtrace_symbols(loc, count);
 156   std::string binary_name = get_binary_path();
 157
 158   if (binary_name.empty()) {
 159     for (std::size_t i = 0; i < count; i++)
 160       result.push_back(simgrid::xbt::string_printf("%p", loc[i]));
 161     return result;
 162   }
 163
 164   // Create the system command for add2line:
 165   std::ostringstream stream;
 166   stream << ADDR2LINE << " -f -e " << binary_name << ' ';
 167   std::vector<std::string> addrs(count);
 168   for (std::size_t i = 0; i < count; i++) {
 169     /* retrieve this address */
 170     XBT_DEBUG("Retrieving address number %zd from '%s'", i, backtrace_syms[i]);
 171     char buff[256];
 172     snprintf(buff, 256, "%s", strchr(backtrace_syms[i], '[') + 1);
 173     char* p = strchr(buff, ']');
 174     *p = '\0';
 175     if (strcmp(buff, "(nil)"))
 176       addrs[i] = buff;
 177     else
 178       addrs[i] = "0x0";
 179     XBT_DEBUG("Set up a new address: %zd, '%s'", i, addrs[i].c_str());
 180     /* Add it to the command line args */
 181     stream << addrs[i] << ' ';
 182   }
 183   std::string cmd = stream.str();
 184
 185   /* size (in char) of pointers on this arch */
 186   int addr_len = addrs[0].size();
 187
 188   XBT_VERB("Fire a first command: '%s'", cmd.c_str());
 189   FILE* pipe = popen(cmd.c_str(), "r");
 190   if (!pipe) {
 191     xbt_die("Cannot fork addr2line to display the backtrace");
 192   }
 193
 194   /* To read the output of addr2line */
 195   char line_func[1024], line_pos[1024];
 196   for (std::size_t i = 0; i < count; i++) {
 197     XBT_DEBUG("Looking for symbol %zd, addr = '%s'", i, addrs[i].c_str());
 198     if (fgets(line_func, 1024, pipe)) {
 199       line_func[strlen(line_func) - 1] = '\0';
 200     } else {
 201       XBT_VERB("Cannot run fgets to look for symbol %zd, addr %s", i, addrs[i].c_str());
 202       strncpy(line_func, "???",3);
 203     }
 204     if (fgets(line_pos, 1024, pipe)) {
 205       line_pos[strlen(line_pos) - 1] = '\0';
 206     } else {
 207       XBT_VERB("Cannot run fgets to look for symbol %zd, addr %s", i, addrs[i].c_str());
 208       strncpy(line_pos, backtrace_syms[i],1024);
 209     }
 210
 211     if (strcmp("??", line_func) != 0) {
 212       auto name = simgrid::xbt::demangle(line_func);
 213       XBT_DEBUG("Found static symbol %s at %s", name.get(), line_pos);
 214       result.push_back(simgrid::xbt::string_printf(
 215         "%s at %s, %p", name.get(), line_pos, loc[i]
 216       ));
 217     } else {
 218       /* Damn. The symbol is in a dynamic library. Let's get wild */
 219
 220       char maps_buff[512];
 221       long int offset = 0;
 222       char *p, *p2;
 223       int found = 0;
 224
 225       /* let's look for the offset of this library in our addressing space */
 226       char* maps_name = bprintf("/proc/%d/maps", (int) getpid());
 227       FILE* maps = fopen(maps_name, "r");
 228
 229       long int addr = strtol(addrs[i].c_str(), &p, 16);
 230       if (*p != '\0') {
 231         XBT_CRITICAL("Cannot parse backtrace address '%s' (addr=%#lx)",
 232           addrs[i].c_str(), addr);
 233       }
 234       XBT_DEBUG("addr=%s (as string) =%#lx (as number)",
 235         addrs[i].c_str(), addr);
 236
 237       while (!found) {
 238         long int first, last;
 239
 240         if (fgets(maps_buff, 512, maps) == nullptr)
 241           break;
 242         if (i == 0) {
 243           maps_buff[strlen(maps_buff) - 1] = '\0';
 244           XBT_DEBUG("map line: %s", maps_buff);
 245         }
 246         sscanf(maps_buff, "%lx", &first);
 247         p = strchr(maps_buff, '-') + 1;
 248         sscanf(p, "%lx", &last);
 249         if (first < addr && addr < last) {
 250           offset = first;
 251           found = 1;
 252         }
 253         if (found) {
 254           XBT_DEBUG("%#lx in [%#lx-%#lx]", addr, first, last);
 255           XBT_DEBUG("Symbol found, map lines not further displayed (even if looking for next ones)");
 256         }
 257       }
 258       fclose(maps);
 259       free(maps_name);
 260       addrs[i].clear();
 261
 262       if (!found) {
 263         XBT_VERB("Problem while reading the maps file. Following backtrace will be mangled.");
 264         XBT_DEBUG("No dynamic. Static symbol: %s", backtrace_syms[i]);
 265         result.push_back(simgrid::xbt::string_printf("?? (%s)", backtrace_syms[i]));
 266         continue;
 267       }
 268
 269       /* Ok, Found the offset of the maps line containing the searched symbol.
 270          We now need to substract this from the address we got from backtrace.
 271        */
 272
 273       addrs[i] = simgrid::xbt::string_printf("0x%0*lx", addr_len - 2, addr - offset);
 274       XBT_DEBUG("offset=%#lx new addr=%s", offset, addrs[i].c_str());
 275
 276       /* Got it. We have our new address. Let's get the library path and we are set */
 277       p = xbt_strdup(backtrace_syms[i]);
 278       if (p[0] == '[') {
 279         /* library path not displayed in the map file either... */
 280         free(p);
 281         snprintf(line_func,3, "??");
 282       } else {
 283         p2 = strrchr(p, '(');
 284         if (p2)
 285           *p2 = '\0';
 286         p2 = strrchr(p, ' ');
 287         if (p2)
 288           *p2 = '\0';
 289
 290         /* Here we go, fire an addr2line up */
 291         char* subcmd = bprintf("%s -f -e %s %s", ADDR2LINE, p, addrs[i].c_str());
 292         free(p);
 293         XBT_VERB("Fire a new command: '%s'", subcmd);
 294         FILE* subpipe = popen(subcmd, "r");
 295         if (!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);
 302           strncpy(line_func, "???",3);
 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);
 308           strncpy(line_pos, backtrace_syms[i],1024);
 309         }
 310         pclose(subpipe);
 311         free(subcmd);
 312       }
 313
 314       /* check whether the trick worked */
 315       if (strcmp("??", line_func)) {
 316         auto name = simgrid::xbt::demangle(line_func);
 317         XBT_DEBUG("Found dynamic symbol %s at %s", name.get(), line_pos);
 318         result.push_back(simgrid::xbt::string_printf(
 319           "%s at %s, %p", name.get(), line_pos, loc[i]));
 320       } else {
 321         /* damn, nothing to do here. Let's print the raw address */
 322         XBT_DEBUG("Dynamic symbol not found. Raw address = %s", backtrace_syms[i]);
 323         result.push_back(simgrid::xbt::string_printf(
 324           "?? at %s", backtrace_syms[i]));
 325       }
 326     }
 327     addrs[i].clear();
 328
 329     /* Mask the bottom of the stack */
 330     if (!strncmp("main", line_func, strlen("main")) ||
 331         !strncmp("xbt_thread_context_wrapper", line_func, strlen("xbt_thread_context_wrapper"))
 332         || !strncmp("smx_ctx_sysv_wrapper", line_func, strlen("smx_ctx_sysv_wrapper")))
 333       break;
 334   }
 335   pclose(pipe);
 336   free(backtrace_syms);
 337   return result;
 338 }
 339
 340 }
 341 }
 342
 343 #if HAVE_MC
 344 int xbt_libunwind_backtrace(void** bt, int size){
 345   for (int i = 0; i < size; i++)
 346     bt[i] = nullptr;
 347
 348   unw_cursor_t c;
 349   unw_context_t uc;
 350
 351   unw_getcontext (&uc);
 352   unw_init_local (&c, &uc);
 353
 354   unw_step(&c);
 355
 356   int i;
 357   for (i = 0; unw_step(&c) >= 0 && i < size; i++) {
 358     unw_word_t ip;
 359     unw_get_reg(&c, UNW_REG_IP, &ip);
 360     bt[i] = (void*)(long)ip;
 361   }
 362
 363   return i;
 364 }
 365 #endif