Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Getting rid of C exceptions
[simgrid.git] / src / xbt / backtrace_linux.c
index 06621d9..741c28f 100644 (file)
@@ -1,17 +1,26 @@
 /* backtrace_linux - backtrace displaying on linux platform                 */
-/* This file is included by ex.c on need (have execinfo.h, popen & addrline)*/
+/* This file is included by ex.cpp 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. */
 
-/* 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 <unistd.h>
+#include <execinfo.h>
+#include <sys/stat.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/ex.h"
+#include "xbt/log.h"
 #include "xbt/str.h"
 #include "xbt/module.h"         /* xbt_binary_name */
-#include "xbt_modinter.h"       /* backtrace initialization headers */
+#include "src/xbt_modinter.h"       /* backtrace initialization headers */
+#if HAVE_MC
+#define UNW_LOCAL_ONLY
+#include <libunwind.h>
+#endif
 /* end of "useless" inclusions */
 
 extern char **environ;          /* the environment, as specified by the opengroup */
@@ -34,7 +43,7 @@ struct trace_arg {
 static _Unwind_Reason_Code
 backtrace_helper (struct _Unwind_Context *ctx, void *a)
 {
-  struct trace_arg *arg = a;
+  struct trace_arg *arg = (struct trace_arg *) a;
 
   /* We are first called with address in the __backtrace function.
      Skip it.  */
@@ -58,12 +67,14 @@ backtrace_helper (struct _Unwind_Context *ctx, void *a)
  * */
 
 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 };
+  struct trace_arg arg;
+  arg .array = array;
+  arg.size = size;
+  arg.cnt = -1;
 
   if (size >= 1)
     _Unwind_Backtrace(backtrace_helper, &arg);
@@ -77,20 +88,20 @@ int xbt_backtrace_no_malloc(void **array, int size) {
 
 void xbt_backtrace_current(xbt_ex_t * e)
 {
-  e->used = backtrace((void **) e->bt, XBT_BACKTRACE_SIZE);
-  if (e->used == 0) {
+  void* bt[XBT_BACKTRACE_SIZE];
+  std::size_t used = backtrace((void **) bt, XBT_BACKTRACE_SIZE);
+  e->bt.assign(bt, bt + used);
+  if (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:%s(%d) [%s:%d] %s", e->host,e->procname,e->pid, e->file,e->line,e->msg);
+    fprintf(stderr, "%s(%d) [%s:%d] %s",
+            e->procname.c_str(), e->pid, e->file, e->line, e->what());
     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) //FIXME: This code could be greatly improved/simplifyied with http://cairo.sourcearchive.com/documentation/1.9.4/backtrace-symbols_8c-source.html
 {
-  int i;
-
   /* to get the backtrace from the libc */
   char **backtrace_syms;
 
@@ -114,24 +125,23 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
 
   xbt_assert(e, "Backtrace not setup yet, cannot set it up for display");
 
-  e->bt_strings = NULL;
+  e->bt_strings.clear();
 
-  if (!xbt_binary_name) /* no binary name, nothing to do */
+  if (xbt_binary_name == NULL) /* no binary name, nothing to do */
     return;
 
-  if (e->used <= 1)
+  if (e->bt.empty())
     return;
 
   /* ignore first one, which is xbt_backtrace_current() */
-  e->used--;
-  memmove(e->bt, e->bt + 1, (sizeof *e->bt) * e->used);
+  e->bt.erase(e->bt.begin());
 
-  backtrace_syms = backtrace_symbols(e->bt, e->used);
+  backtrace_syms = backtrace_symbols(e->bt.data(), e->bt.size());
 
   /* 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 (i = 0; environ[i]; i++) {
+    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;
@@ -142,19 +152,16 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
           binary_name = bprintf("%s/%s", data, xbt_binary_name);
           if (!stat(binary_name, &stat_buf)) {
             /* Found. */
-            XBT_DEBUG("Looked in the PATH for the binary. Found %s",
-                   binary_name);
+            XBT_DEBUG("Looked in the PATH for the binary. Found %s", binary_name);
             break;
           }
         }
         xbt_dynar_free(&path);
         if (stat(binary_name, &stat_buf)) {
           /* not found */
-          e->used = 1;
-          e->bt_strings = xbt_new(char *, 1);
-
-          e->bt_strings[0] =
-              bprintf("(binary '%s' not found the path)", xbt_binary_name);
+          char* str = bprintf("(binary '%s' not found in the PATH)", xbt_binary_name);
+          e->bt_strings = {  str };
+          free(str);
           free(backtrace_syms);
           return;
         }
@@ -164,18 +171,17 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
   } else {
     binary_name = xbt_strdup(xbt_binary_name);
   }
-  cmd = curr =
-      xbt_new(char,
-              strlen(ADDR2LINE) + 25 + strlen(binary_name) + 32 * e->used);
+  int strsize = strlen(ADDR2LINE) + 25 + strlen(binary_name) + 32 * e->bt_strings.size();
+  cmd = curr = xbt_new(char, strsize);
 
-  curr += sprintf(curr, "%s -f -e %s ", ADDR2LINE, binary_name);
+  curr += snprintf(curr,strsize, "%s -f -e %s ", ADDR2LINE, binary_name);
   free(binary_name);
 
-  addrs = xbt_new(char *, e->used);
-  for (i = 0; i < e->used; i++) {
+  addrs = xbt_new(char *, e->bt.size());
+  for (std::size_t i = 0; i < e->bt.size(); i++) {
     char *p;
     /* retrieve this address */
-    XBT_DEBUG("Retrieving address number %d from '%s'", i, backtrace_syms[i]);
+    XBT_DEBUG("Retrieving address number %zd from '%s'", i, backtrace_syms[i]);
     snprintf(buff, 256, "%s", strchr(backtrace_syms[i], '[') + 1);
     p = strchr(buff, ']');
     *p = '\0';
@@ -183,15 +189,15 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
       addrs[i] = xbt_strdup(buff);
     else
       addrs[i] = xbt_strdup("0x0");
-    XBT_DEBUG("Set up a new address: %d, '%s'(%p)", i, addrs[i], addrs[i]);
+    XBT_DEBUG("Set up a new address: %zd, '%s'(%p)", i, addrs[i], addrs[i]);
 
     /* Add it to the command line args */
-    curr += sprintf(curr, "%s ", addrs[i]);
+    curr += snprintf(curr,strsize, "%s ", addrs[i]);
   }
   addr_len = strlen(addrs[0]);
 
   /* parse the output and build a new backtrace */
-  e->bt_strings = xbt_new(char *, e->used);
+  e->bt_strings.resize(e->bt.size());
 
   XBT_VERB("Fire a first command: '%s'", cmd);
   pipe = popen(cmd, "r");
@@ -199,26 +205,26 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
     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)) {
+  for (std::size_t i = 0; i < e->bt.size(); i++) {
+    XBT_DEBUG("Looking for symbol %zd, addr = '%s'", i, addrs[i]);
+    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]);
+      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]);
+      strncpy(line_pos, backtrace_syms[i],1024);
+    }
+
+    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);
+      char* s = bprintf("**   In %s() at %s", line_func, line_pos);
+      e->bt_strings[i] = s;
+      free(s);
     } else {
       /* Damn. The symbol is in a dynamic library. Let's get wild */
       char *maps_name;
@@ -238,8 +244,7 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
 
       addr = strtol(addrs[i], &p, 16);
       if (*p != '\0') {
-        XBT_CRITICAL("Cannot parse backtrace address '%s' (addr=%#lx)",
-                  addrs[i], addr);
+        XBT_CRITICAL("Cannot parse backtrace address '%s' (addr=%#lx)", addrs[i], addr);
       }
       XBT_DEBUG("addr=%s (as string) =%#lx (as number)", addrs[i], addr);
 
@@ -261,8 +266,7 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
         }
         if (found) {
           XBT_DEBUG("%#lx in [%#lx-%#lx]", addr, first, last);
-          XBT_DEBUG
-              ("Symbol found, map lines not further displayed (even if looking for next ones)");
+          XBT_DEBUG("Symbol found, map lines not further displayed (even if looking for next ones)");
         }
       }
       fclose(maps);
@@ -270,10 +274,11 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
       free(addrs[i]);
 
       if (!found) {
-        XBT_VERB
-            ("Problem while reading the maps file. Following backtrace will be mangled.");
+        XBT_VERB("Problem while reading the maps file. Following backtrace will be mangled.");
         XBT_DEBUG("No dynamic. Static symbol: %s", backtrace_syms[i]);
-        e->bt_strings[i] = bprintf("**   In ?? (%s)", backtrace_syms[i]);
+        char* s = bprintf("**   In ?? (%s)", backtrace_syms[i]);
+        e->bt_strings[i] = s;
+        free(s);
         continue;
       }
 
@@ -284,13 +289,12 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
       addrs[i] = bprintf("0x%0*lx", addr_len - 2, addr - offset);
       XBT_DEBUG("offset=%#lx new addr=%s", offset, addrs[i]);
 
-      /* Got it. We have our new address. Let's get the library path and we
-         are set */
+      /* Got it. We have our new address. Let's get the library path and we are set */
       p = xbt_strdup(backtrace_syms[i]);
       if (p[0] == '[') {
         /* library path not displayed in the map file either... */
         free(p);
-        sprintf(line_func, "??");
+        snprintf(line_func,3, "??");
       } else {
         p2 = strrchr(p, '(');
         if (p2)
@@ -307,16 +311,18 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
         if (!subpipe) {
           xbt_die("Cannot fork addr2line to display the backtrace");
         }
-        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';
+        if (fgets(line_func, 1024, subpipe)) {
+          line_func[strlen(line_func) - 1] = '\0';
+        } else {
+          XBT_VERB("Cannot read result of subcommand %s", subcmd);
+          strncpy(line_func, "???",3);
+        }
+        if (fgets(line_pos, 1024, subpipe)) {
+          line_pos[strlen(line_pos) - 1] = '\0';
+        } else {
+          XBT_VERB("Cannot read result of subcommand %s", subcmd);
+          strncpy(line_pos, backtrace_syms[i],1024);
+        }
         pclose(subpipe);
         free(subcmd);
       }
@@ -324,42 +330,66 @@ void xbt_ex_setup_backtrace(xbt_ex_t * e) //FIXME: This code could be greatly im
       /* check whether the trick worked */
       if (strcmp("??", line_func)) {
         XBT_DEBUG("Found dynamic symbol %s() at %s", line_func, line_pos);
-        e->bt_strings[i] =
-            bprintf("**   In %s() at %s", line_func, line_pos);
+        char* s = bprintf("**   In %s() at %s", line_func, line_pos);
+        e->bt_strings[i] = s;
+        free(s);
       } else {
         /* damn, nothing to do here. Let's print the raw address */
-        XBT_DEBUG("Dynamic symbol not found. Raw address = %s",
-               backtrace_syms[i]);
-        e->bt_strings[i] = bprintf("**   In ?? at %s", backtrace_syms[i]);
+        XBT_DEBUG("Dynamic symbol not found. Raw address = %s", backtrace_syms[i]);
+        char* s = bprintf("**   In ?? at %s", backtrace_syms[i]);
+        e->bt_strings[i] = s;
+        free(s);
       }
-
     }
     free(addrs[i]);
 
     /* 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"))) {
-      int j;
+        !strncmp("xbt_thread_context_wrapper", line_func, strlen("xbt_thread_context_wrapper"))
+        || !strncmp("smx_ctx_sysv_wrapper", line_func, strlen("smx_ctx_sysv_wrapper"))) {
 
-      for (j = i + 1; j < e->used; j++)
+      for (std::size_t j = i + 1; j < e->bt.size(); j++)
         free(addrs[j]);
-      e->used = i + 1;
 
       if (!strncmp
-          ("xbt_thread_context_wrapper", line_func,
-           strlen("xbt_thread_context_wrapper"))) {
-        free(e->bt_strings[i]);
-        e->bt_strings[i] = xbt_strdup("**   (in a separate thread)");
+          ("xbt_thread_context_wrapper", line_func, strlen("xbt_thread_context_wrapper"))) {
+        e->bt_strings.push_back("**   (in a separate thread)");
+      } else {
+        e->bt_strings.push_back("");
       }
-    }
-
 
+    }
   }
   pclose(pipe);
   free(addrs);
   free(backtrace_syms);
   free(cmd);
 }
+
+#if 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