Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright notices
[simgrid.git] / src / xbt / backtrace_linux.c
index e57e486..82a3c66 100644 (file)
@@ -1,17 +1,25 @@
 /* backtrace_linux - backtrace displaying on linux platform                 */
 /* This file is included by ex.c on need (have execinfo.h, popen & addrline)*/
 
-/* Copyright (c) 2008, 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2008-2015. 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 <execinfo.h>
+#include <sys/stat.h>
+
 /* 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 */
 #include "xbt/ex.h"
+#include "xbt/log.h"
 #include "xbt/str.h"
 #include "xbt/module.h"         /* xbt_binary_name */
 #include "xbt_modinter.h"       /* backtrace initialization headers */
+#ifdef HAVE_MC
+#define UNW_LOCAL_ONLY
+#include <libunwind.h>
+#endif
 /* end of "useless" inclusions */
 
 extern char **environ;          /* the environment, as specified by the opengroup */
@@ -25,13 +33,70 @@ void xbt_backtrace_postexit(void)
 {
 }
 
+#include <unwind.h>
+struct trace_arg {
+  void **array;
+  int cnt, size;
+};
+
+static _Unwind_Reason_Code
+backtrace_helper (struct _Unwind_Context *ctx, void *a)
+{
+  struct trace_arg *arg = a;
+
+  /* We are first called with address in the __backtrace function.
+     Skip it.  */
+  if (arg->cnt != -1)
+    {
+      arg->array[arg->cnt] = (void *) _Unwind_GetIP(ctx);
+
+      /* Check whether we make any progress.  */
+      if (arg->cnt > 0 && arg->array[arg->cnt - 1] == arg->array[arg->cnt])
+        return _URC_END_OF_STACK;
+    }
+  if (++arg->cnt == arg->size)
+    return _URC_END_OF_STACK;
+  return _URC_NO_REASON;
+}
+
+/** @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/
+ * 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;
+
+  struct trace_arg arg = { .array = array, .size = size, .cnt = -1 };
+
+  if (size >= 1)
+    _Unwind_Backtrace(backtrace_helper, &arg);
+
+  /* _Unwind_Backtrace on IA-64 seems to put NULL address above
+     _start.  Fix it up here.  */
+  if (arg.cnt > 1 && arg.array[arg.cnt - 1] == NULL)
+    --arg.cnt;
+  return arg.cnt != -1 ? arg.cnt : 0;
+}
+
 void xbt_backtrace_current(xbt_ex_t * e)
 {
   e->used = backtrace((void **) e->bt, XBT_BACKTRACE_SIZE);
+  if (e->used == 0) {
+    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:");
+    fprintf(stderr, "%s(%d) [%s:%d] %s",
+            e->procname, e->pid, e->file, e->line, e->msg);
+    fprintf(stderr, "Bailing out now since there is nothing I can do without a decent amount of memory. Please go fix the memleaks\n");
+    exit(1);
+  }
 }
 
 
-void xbt_ex_setup_backtrace(xbt_ex_t * e)
+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
 {
   int i;
 
@@ -43,7 +108,7 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e)
 
   /* to extract the addresses from the backtrace */
   char **addrs;
-  char buff[256], *p;
+  char buff[256];
 
   /* To read the output of addr2line */
   FILE *pipe;
@@ -56,29 +121,25 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e)
   struct stat stat_buf;
   char *binary_name = NULL;
 
-  xbt_assert(e
-              && e->used,
-              "Backtrace not setup yet, cannot set it up for display");
+  xbt_assert(e, "Backtrace not setup yet, cannot set it up for display");
+
+  e->bt_strings = NULL;
 
-  if (!xbt_binary_name) /* no binary name, nothing to do */
+  if (xbt_binary_name == NULL) /* no binary name, nothing to do */
     return;
 
-  backtrace_syms = backtrace_symbols(e->bt, e->used);
-  /* ignore first one, which is this xbt_backtrace_current() */
-  e->used--;
-  memmove(backtrace_syms, backtrace_syms + 1, sizeof(char *) * e->used);
+  if (e->used <= 1)
+    return;
 
-  e->bt_strings = NULL;
+  /* ignore first one, which is xbt_backtrace_current() */
+  e->used--;
+  memmove(e->bt, e->bt + 1, (sizeof *e->bt) * e->used);
 
-  /* Some arches only have stubs of backtrace, no implementation (hppa comes to mind) */
-  if (!e->used)
-    return;
+  backtrace_syms = backtrace_symbols(e->bt, e->used);
 
   /* 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 */
-    int i;
-
     for (i = 0; environ[i]; i++) {
       if (!strncmp("PATH=", environ[i], 5)) {
         xbt_dynar_t path = xbt_str_split(environ[i] + 5, ":");
@@ -86,8 +147,7 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e)
         char *data;
 
         xbt_dynar_foreach(path, cpt, data) {
-          if (binary_name)
-            free(binary_name);
+          free(binary_name);
           binary_name = bprintf("%s/%s", data, xbt_binary_name);
           if (!stat(binary_name, &stat_buf)) {
             /* Found. */
@@ -103,7 +163,7 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e)
           e->bt_strings = xbt_new(char *, 1);
 
           e->bt_strings[0] =
-              bprintf("(binary '%s' not found the path)", xbt_binary_name);
+              bprintf("(binary '%s' not found in the PATH)", xbt_binary_name);
           free(backtrace_syms);
           return;
         }
@@ -122,6 +182,7 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e)
 
   addrs = xbt_new(char *, e->used);
   for (i = 0; i < e->used; i++) {
+    char *p;
     /* retrieve this address */
     XBT_DEBUG("Retrieving address number %d from '%s'", i, backtrace_syms[i]);
     snprintf(buff, 256, "%s", strchr(backtrace_syms[i], '[') + 1);
@@ -144,27 +205,25 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e)
   XBT_VERB("Fire a first command: '%s'", cmd);
   pipe = popen(cmd, "r");
   if (!pipe) {
-    XBT_CRITICAL("Cannot fork addr2line to display the backtrace");
-    abort();
+    xbt_die("Cannot fork addr2line to display the backtrace");
   }
 
   for (i = 0; i < e->used; i++) {
-    char *fgets_res;
     XBT_DEBUG("Looking for symbol %d, addr = '%s'", i, addrs[i]);
-    fgets_res = fgets(line_func, 1024, pipe);
-    if (fgets_res == NULL)
-      THROWF(system_error, 0,
-             "Cannot run fgets to look for symbol %d, addr %s", i,
-             addrs[i]);
-    line_func[strlen(line_func) - 1] = '\0';
-    fgets_res = fgets(line_pos, 1024, pipe);
-    if (fgets_res == NULL)
-      THROWF(system_error, 0,
-             "Cannot run fgets to look for symbol %d, addr %s", i,
-             addrs[i]);
-    line_pos[strlen(line_pos) - 1] = '\0';
-
-    if (strcmp("??", line_func)) {
+    if (fgets(line_func, 1024, pipe)) {
+      line_func[strlen(line_func) - 1] = '\0';
+    } else {
+      XBT_VERB("Cannot run fgets to look for symbol %d, addr %s", i, addrs[i]);
+      strcpy(line_func, "???");
+    }
+    if (fgets(line_pos, 1024, pipe)) {
+      line_pos[strlen(line_pos) - 1] = '\0';
+    } else {
+      XBT_VERB("Cannot run fgets to look for symbol %d, addr %s", i, addrs[i]);
+      strcpy(line_pos, backtrace_syms[i]);
+    }
+
+    if (strcmp("??", line_func) != 0) {
       XBT_DEBUG("Found static symbol %s() at %s", line_func, line_pos);
       e->bt_strings[i] =
           bprintf("**   In %s() at %s", line_func, line_pos);
@@ -254,19 +313,20 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e)
         XBT_VERB("Fire a new command: '%s'", subcmd);
         subpipe = popen(subcmd, "r");
         if (!subpipe) {
-          XBT_CRITICAL("Cannot fork addr2line to display the backtrace");
-          abort();
+          xbt_die("Cannot fork addr2line to display the backtrace");
+        }
+        if (fgets(line_func, 1024, subpipe)) {
+          line_func[strlen(line_func) - 1] = '\0';
+        } else {
+          XBT_VERB("Cannot read result of subcommand %s", subcmd);
+          strcpy(line_func, "???");
+        }
+        if (fgets(line_pos, 1024, subpipe)) {
+          line_pos[strlen(line_pos) - 1] = '\0';
+        } else {
+          XBT_VERB("Cannot read result of subcommand %s", subcmd);
+          strcpy(line_pos, backtrace_syms[i]);
         }
-        fgets_res = fgets(line_func, 1024, subpipe);
-        if (fgets_res == NULL)
-          THROWF(system_error, 0, "Cannot read result of subcommand %s",
-                 subcmd);
-        line_func[strlen(line_func) - 1] = '\0';
-        fgets_res = fgets(line_pos, 1024, subpipe);
-        if (fgets_res == NULL)
-          THROWF(system_error, 0, "Cannot read result of subcommand %s",
-                 subcmd);
-        line_pos[strlen(line_pos) - 1] = '\0';
         pclose(subpipe);
         free(subcmd);
       }
@@ -313,3 +373,37 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e)
   free(backtrace_syms);
   free(cmd);
 }
+
+#ifdef HAVE_MC
+
+int xbt_libunwind_backtrace(void* bt[XBT_BACKTRACE_SIZE], int size){
+  
+  int i = 0;
+  for(i=0; i < size; i++)
+    bt[i] = NULL;
+
+  i=0;
+
+  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){
+
+    unw_get_reg(&c, UNW_REG_IP, &ip);
+    bt[i] = (void*)(long)ip;
+    i++;
+
+  }
+
+  return i;
+  
+}
+
+#endif