src/xbt/backtrace_linux.c

   1 /* backtrace_linux - backtrace displaying on linux platform                 */
   2 /* This file is included by ex.c on need (have execinfo.h, popen & addrline)*/
   3
   4 /* Copyright (c) 2008-2015. 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 <unistd.h>
  11 #include <execinfo.h>
  12 #include <sys/stat.h>
  13
  14 /* This file is to be included in ex.c, so the following headers are not mandatory, but it's to make sure that eclipse see them too */
  15 #include "xbt/ex.h"
  16 #include "xbt/log.h"
  17 #include "xbt/str.h"
  18 #include "xbt/module.h"         /* xbt_binary_name */
  19 #include "src/xbt_modinter.h"       /* backtrace initialization headers */
  20 #if HAVE_MC
  21 #define UNW_LOCAL_ONLY
  22 #include <libunwind.h>
  23 #endif
  24 /* end of "useless" inclusions */
  25
  26 extern char **environ;          /* the environment, as specified by the opengroup */
  27
  28 /* Module creation/destruction: nothing to do on linux */
  29 void xbt_backtrace_preinit(void)
  30 {
  31 }
  32
  33 void xbt_backtrace_postexit(void)
  34 {
  35 }
  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 = 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] = NULL;
  73
  74   struct trace_arg arg = { .array = array, .size = size, .cnt = -1 };
  75
  76   if (size >= 1)
  77     _Unwind_Backtrace(backtrace_helper, &arg);
  78
  79   /* _Unwind_Backtrace on IA-64 seems to put NULL address above
  80      _start.  Fix it up here.  */
  81   if (arg.cnt > 1 && arg.array[arg.cnt - 1] == NULL)
  82     --arg.cnt;
  83   return arg.cnt != -1 ? arg.cnt : 0;
  84 }
  85
  86 void xbt_backtrace_current(xbt_ex_t * e)
  87 {
  88   e->used = backtrace((void **) e->bt, XBT_BACKTRACE_SIZE);
  89   if (e->used == 0) {
  90     fprintf(stderr, "The backtrace() function failed, which probably means that the memory is exhausted. Here is a crude dump of the exception that I was trying to build:");
  91     fprintf(stderr, "%s(%d) [%s:%d] %s",
  92             e->procname, e->pid, e->file, e->line, e->msg);
  93     fprintf(stderr, "Bailing out now since there is nothing I can do without a decent amount of memory. Please go fix the memleaks\n");
  94     exit(1);
  95   }
  96 }
  97
  98 void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly improved/simplifyied with http://cairo.sourcearchive.com/documentation/1.9.4/backtrace-symbols_8c-source.html
  99 {
 100   int i;
 101
 102   /* to get the backtrace from the libc */
 103   char **backtrace_syms;
 104
 105   /* To build the commandline of addr2line */
 106   char *cmd, *curr;
 107
 108   /* to extract the addresses from the backtrace */
 109   char **addrs;
 110   char buff[256];
 111
 112   /* To read the output of addr2line */
 113   FILE *pipe;
 114   char line_func[1024], line_pos[1024];
 115
 116   /* size (in char) of pointers on this arch */
 117   int addr_len = 0;
 118
 119   /* To search for the right executable path when not trivial */
 120   struct stat stat_buf;
 121   char *binary_name = NULL;
 122
 123   xbt_assert(e, "Backtrace not setup yet, cannot set it up for display");
 124
 125   e->bt_strings = NULL;
 126
 127   if (xbt_binary_name == NULL) /* no binary name, nothing to do */
 128     return;
 129
 130   if (e->used <= 1)
 131     return;
 132
 133   /* ignore first one, which is xbt_backtrace_current() */
 134   e->used--;
 135   memmove(e->bt, e->bt + 1, (sizeof *e->bt) * e->used);
 136
 137   backtrace_syms = backtrace_symbols(e->bt, e->used);
 138
 139   /* build the commandline */
 140   if (stat(xbt_binary_name, &stat_buf)) {
 141     /* Damn. binary not in current dir. We'll have to dig the PATH to find it */
 142     for (i = 0; environ[i]; i++) {
 143       if (!strncmp("PATH=", environ[i], 5)) {
 144         xbt_dynar_t path = xbt_str_split(environ[i] + 5, ":");
 145         unsigned int cpt;
 146         char *data;
 147
 148         xbt_dynar_foreach(path, cpt, data) {
 149           free(binary_name);
 150           binary_name = bprintf("%s/%s", data, xbt_binary_name);
 151           if (!stat(binary_name, &stat_buf)) {
 152             /* Found. */
 153             XBT_DEBUG("Looked in the PATH for the binary. Found %s", binary_name);
 154             break;
 155           }
 156         }
 157         xbt_dynar_free(&path);
 158         if (stat(binary_name, &stat_buf)) {
 159           /* not found */
 160           e->used = 1;
 161           e->bt_strings = xbt_new(char *, 1);
 162
 163           e->bt_strings[0] = bprintf("(binary '%s' not found in the PATH)", xbt_binary_name);
 164           free(backtrace_syms);
 165           return;
 166         }
 167         break;
 168       }
 169     }
 170   } else {
 171     binary_name = xbt_strdup(xbt_binary_name);
 172   }
 173   cmd = curr = xbt_new(char, strlen(ADDR2LINE) + 25 + strlen(binary_name) + 32 * e->used);
 174
 175   curr += sprintf(curr, "%s -f -e %s ", ADDR2LINE, binary_name);
 176   free(binary_name);
 177
 178   addrs = xbt_new(char *, e->used);
 179   for (i = 0; i < e->used; i++) {
 180     char *p;
 181     /* retrieve this address */
 182     XBT_DEBUG("Retrieving address number %d from '%s'", i, backtrace_syms[i]);
 183     snprintf(buff, 256, "%s", strchr(backtrace_syms[i], '[') + 1);
 184     p = strchr(buff, ']');
 185     *p = '\0';
 186     if (strcmp(buff, "(nil)"))
 187       addrs[i] = xbt_strdup(buff);
 188     else
 189       addrs[i] = xbt_strdup("0x0");
 190     XBT_DEBUG("Set up a new address: %d, '%s'(%p)", i, addrs[i], addrs[i]);
 191
 192     /* Add it to the command line args */
 193     curr += sprintf(curr, "%s ", addrs[i]);
 194   }
 195   addr_len = strlen(addrs[0]);
 196
 197   /* parse the output and build a new backtrace */
 198   e->bt_strings = xbt_new(char *, e->used);
 199
 200   XBT_VERB("Fire a first command: '%s'", cmd);
 201   pipe = popen(cmd, "r");
 202   if (!pipe) {
 203     xbt_die("Cannot fork addr2line to display the backtrace");
 204   }
 205
 206   for (i = 0; i < e->used; i++) {
 207     XBT_DEBUG("Looking for symbol %d, addr = '%s'", i, addrs[i]);
 208     if (fgets(line_func, 1024, pipe)) {
 209       line_func[strlen(line_func) - 1] = '\0';
 210     } else {
 211       XBT_VERB("Cannot run fgets to look for symbol %d, addr %s", i, addrs[i]);
 212       strcpy(line_func, "???");
 213     }
 214     if (fgets(line_pos, 1024, pipe)) {
 215       line_pos[strlen(line_pos) - 1] = '\0';
 216     } else {
 217       XBT_VERB("Cannot run fgets to look for symbol %d, addr %s", i, addrs[i]);
 218       strcpy(line_pos, backtrace_syms[i]);
 219     }
 220
 221     if (strcmp("??", line_func) != 0) {
 222       XBT_DEBUG("Found static symbol %s() at %s", line_func, line_pos);
 223       e->bt_strings[i] =
 224           bprintf("**   In %s() at %s", line_func, line_pos);
 225     } else {
 226       /* Damn. The symbol is in a dynamic library. Let's get wild */
 227       char *maps_name;
 228       FILE *maps;
 229       char maps_buff[512];
 230
 231       long int addr, offset = 0;
 232       char *p, *p2;
 233
 234       char *subcmd;
 235       FILE *subpipe;
 236       int found = 0;
 237
 238       /* let's look for the offset of this library in our addressing space */
 239       maps_name = bprintf("/proc/%d/maps", (int) getpid());
 240       maps = fopen(maps_name, "r");
 241
 242       addr = strtol(addrs[i], &p, 16);
 243       if (*p != '\0') {
 244         XBT_CRITICAL("Cannot parse backtrace address '%s' (addr=%#lx)", addrs[i], addr);
 245       }
 246       XBT_DEBUG("addr=%s (as string) =%#lx (as number)", addrs[i], addr);
 247
 248       while (!found) {
 249         long int first, last;
 250
 251         if (fgets(maps_buff, 512, maps) == NULL)
 252           break;
 253         if (i == 0) {
 254           maps_buff[strlen(maps_buff) - 1] = '\0';
 255           XBT_DEBUG("map line: %s", maps_buff);
 256         }
 257         sscanf(maps_buff, "%lx", &first);
 258         p = strchr(maps_buff, '-') + 1;
 259         sscanf(p, "%lx", &last);
 260         if (first < addr && addr < last) {
 261           offset = first;
 262           found = 1;
 263         }
 264         if (found) {
 265           XBT_DEBUG("%#lx in [%#lx-%#lx]", addr, first, last);
 266           XBT_DEBUG("Symbol found, map lines not further displayed (even if looking for next ones)");
 267         }
 268       }
 269       fclose(maps);
 270       free(maps_name);
 271       free(addrs[i]);
 272
 273       if (!found) {
 274         XBT_VERB("Problem while reading the maps file. Following backtrace will be mangled.");
 275         XBT_DEBUG("No dynamic. Static symbol: %s", backtrace_syms[i]);
 276         e->bt_strings[i] = bprintf("**   In ?? (%s)", backtrace_syms[i]);
 277         continue;
 278       }
 279
 280       /* Ok, Found the offset of the maps line containing the searched symbol.
 281          We now need to substract this from the address we got from backtrace.
 282        */
 283
 284       addrs[i] = bprintf("0x%0*lx", addr_len - 2, addr - offset);
 285       XBT_DEBUG("offset=%#lx new addr=%s", offset, addrs[i]);
 286
 287       /* Got it. We have our new address. Let's get the library path and we are set */
 288       p = xbt_strdup(backtrace_syms[i]);
 289       if (p[0] == '[') {
 290         /* library path not displayed in the map file either... */
 291         free(p);
 292         sprintf(line_func, "??");
 293       } else {
 294         p2 = strrchr(p, '(');
 295         if (p2)
 296           *p2 = '\0';
 297         p2 = strrchr(p, ' ');
 298         if (p2)
 299           *p2 = '\0';
 300
 301         /* Here we go, fire an addr2line up */
 302         subcmd = bprintf("%s -f -e %s %s", ADDR2LINE, p, addrs[i]);
 303         free(p);
 304         XBT_VERB("Fire a new command: '%s'", subcmd);
 305         subpipe = popen(subcmd, "r");
 306         if (!subpipe) {
 307           xbt_die("Cannot fork addr2line to display the backtrace");
 308         }
 309         if (fgets(line_func, 1024, subpipe)) {
 310           line_func[strlen(line_func) - 1] = '\0';
 311         } else {
 312           XBT_VERB("Cannot read result of subcommand %s", subcmd);
 313           strcpy(line_func, "???");
 314         }
 315         if (fgets(line_pos, 1024, subpipe)) {
 316           line_pos[strlen(line_pos) - 1] = '\0';
 317         } else {
 318           XBT_VERB("Cannot read result of subcommand %s", subcmd);
 319           strcpy(line_pos, backtrace_syms[i]);
 320         }
 321         pclose(subpipe);
 322         free(subcmd);
 323       }
 324
 325       /* check whether the trick worked */
 326       if (strcmp("??", line_func)) {
 327         XBT_DEBUG("Found dynamic symbol %s() at %s", line_func, line_pos);
 328         e->bt_strings[i] = bprintf("**   In %s() at %s", line_func, line_pos);
 329       } else {
 330         /* damn, nothing to do here. Let's print the raw address */
 331         XBT_DEBUG("Dynamic symbol not found. Raw address = %s", backtrace_syms[i]);
 332         e->bt_strings[i] = bprintf("**   In ?? at %s", backtrace_syms[i]);
 333       }
 334     }
 335     free(addrs[i]);
 336
 337     /* Mask the bottom of the stack */
 338     if (!strncmp("main", line_func, strlen("main")) ||
 339         !strncmp("xbt_thread_context_wrapper", line_func, strlen("xbt_thread_context_wrapper"))
 340         || !strncmp("smx_ctx_sysv_wrapper", line_func, strlen("smx_ctx_sysv_wrapper"))) {
 341       int j;
 342
 343       for (j = i + 1; j < e->used; j++)
 344         free(addrs[j]);
 345       e->used = i + 1;
 346
 347       if (!strncmp
 348           ("xbt_thread_context_wrapper", line_func, strlen("xbt_thread_context_wrapper"))) {
 349         free(e->bt_strings[i]);
 350         e->bt_strings[i] = xbt_strdup("**   (in a separate thread)");
 351       }
 352     }
 353   }
 354   pclose(pipe);
 355   free(addrs);
 356   free(backtrace_syms);
 357   free(cmd);
 358 }
 359
 360 #if HAVE_MC
 361 int xbt_libunwind_backtrace(void* bt[XBT_BACKTRACE_SIZE], int size){
 362   int i = 0;
 363   for(i=0; i < size; i++)
 364     bt[i] = NULL;
 365
 366   i=0;
 367
 368   unw_cursor_t c;
 369   unw_context_t uc;
 370
 371   unw_getcontext (&uc);
 372   unw_init_local (&c, &uc);
 373
 374   unw_word_t ip;
 375
 376   unw_step(&c);
 377
 378   while(unw_step(&c) >= 0 && i < size){
 379     unw_get_reg(&c, UNW_REG_IP, &ip);
 380     bt[i] = (void*)(long)ip;
 381     i++;
 382   }
 383
 384   return i;
 385 }
 386 #endif