Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move collective algorithms to separate folders
[simgrid.git] / src / xbt / backtrace_linux.cpp
index 97665f5..cb8ef6d 100644 (file)
@@ -1,13 +1,16 @@
 /* backtrace_linux - backtrace displaying on linux platform                 */
 /* This file is included by ex.cpp on need (have execinfo.h, popen & addrline)*/
 
-/* Copyright (c) 2008-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2008-2017. 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 <sstream>
+#include <string>
+#include <vector>
+
+#include <boost/algorithm/string.hpp>
 
 #include <unistd.h>
 #include <execinfo.h>
@@ -15,8 +18,8 @@
 
 /* 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/string.hpp>
+#include <xbt/backtrace.hpp>
 #include "xbt/ex.h"
-#include "src/xbt/ex_interface.h"
 #include "xbt/log.h"
 #include "xbt/str.h"
 #include "xbt/module.h"         /* xbt_binary_name */
 
 extern char **environ;          /* the environment, as specified by the opengroup */
 
-/* Module creation/destruction: nothing to do on linux */
-void xbt_backtrace_preinit(void)
-{
-}
-
-void xbt_backtrace_postexit(void)
-{
-}
-
 #include <unwind.h>
 struct trace_arg {
   void **array;
@@ -66,14 +60,14 @@ backtrace_helper (struct _Unwind_Context *ctx, void *a)
 
 /** @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/
+ * See http://people.irisa.fr/Martin.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;
+    array[i] = nullptr;
 
   struct trace_arg arg;
   arg .array = array;
@@ -83,9 +77,9 @@ int xbt_backtrace_no_malloc(void **array, int size) {
   if (size >= 1)
     _Unwind_Backtrace(backtrace_helper, &arg);
 
-  /* _Unwind_Backtrace on IA-64 seems to put NULL address above
+  /* _Unwind_Backtrace on IA-64 seems to put nullptr address above
      _start.  Fix it up here.  */
-  if (arg.cnt > 1 && arg.array[arg.cnt - 1] == NULL)
+  if (arg.cnt > 1 && arg.array[arg.cnt - 1] == nullptr)
     --arg.cnt;
   return arg.cnt != -1 ? arg.cnt : 0;
 }
@@ -105,60 +99,64 @@ size_t xbt_backtrace_current(xbt_backtrace_location_t* loc, std::size_t count)
 namespace simgrid {
 namespace xbt {
 
+/** Find the path of the binary file from the name found in argv */
+static std::string get_binary_path()
+{
+  struct stat stat_buf;
+
+  if (xbt_binary_name == nullptr)
+    return "";
+
+  // We found it, we are happy:
+  if (stat(xbt_binary_name, &stat_buf) == 0)
+    return xbt_binary_name;
+
+  // Not found, look in the PATH:
+  char* path = getenv("PATH");
+  if (path == nullptr)
+    return "";
+  XBT_DEBUG("Looking in the PATH: %s\n", path);
+  std::vector<std::string> path_list;
+  // TODO, on Windows, this is ";"
+  boost::split(path_list, path, boost::is_any_of(":"));
+  for (std::string const& path_item : path_list) {
+    std::string binary_name = simgrid::xbt::string_printf(
+      "%s/%s", path_item.c_str(), xbt_binary_name);
+    bool found = (stat(binary_name.c_str(), &stat_buf) == 0);
+    XBT_DEBUG("Looked in the PATH for the binary. %s %s",
+      found ? "Found" : "Not found",
+      binary_name.c_str());
+    if (found)
+      return binary_name;
+  }
+
+  // Not found at all:
+  return "";
+}
+
 //FIXME: This code could be greatly improved/simplifyied with
 //   http://cairo.sourcearchive.com/documentation/1.9.4/backtrace-symbols_8c-source.html
 std::vector<std::string> resolveBacktrace(
-  xbt_backtrace_location_t* loc, std::size_t count)
+  xbt_backtrace_location_t const* loc, std::size_t count)
 {
   std::vector<std::string> result;
 
-  /* To search for the right executable path when not trivial */
-  struct stat stat_buf;
-
-  /* no binary name, nothing to do */
-  if (xbt_binary_name == NULL)
-    return result;
-
   if (count == 0)
     return result;
 
+  if (xbt_binary_name == nullptr)
+    XBT_WARN("XBT not initialized, the backtrace will not be resolved.");
+
   // Drop the first one:
   loc++; count--;
 
   char** backtrace_syms = backtrace_symbols(loc, count);
+  std::string binary_name = get_binary_path();
 
-  // Find the binary name:
-  std::string binary_name;
-  /* 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 (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;
-        char *data;
-
-        xbt_dynar_foreach(path, cpt, data) {
-          binary_name = simgrid::xbt::string_printf("%s/%s", data, xbt_binary_name);
-          if (!stat(binary_name.c_str(), &stat_buf)) {
-            /* Found. */
-            XBT_DEBUG("Looked in the PATH for the binary. Found %s", binary_name.c_str());
-            break;
-          }
-        }
-        xbt_dynar_free(&path);
-        if (stat(binary_name.c_str(), &stat_buf)) {
-          /* not found */
-          result =  { simgrid::xbt::string_printf(
-            "(binary '%s' not found in the PATH)", xbt_binary_name) };
-          free(backtrace_syms);
-          return result;
-        }
-        break;
-      }
-    }
-  } else {
-    binary_name = xbt_binary_name;
+  if (binary_name.empty()) {
+    for (std::size_t i = 0; i < count; i++)
+      result.push_back(simgrid::xbt::string_printf("%p", loc[i]));
+    return result;
   }
 
   // Create the system command for add2line:
@@ -180,7 +178,6 @@ std::vector<std::string> resolveBacktrace(
     /* Add it to the command line args */
     stream << addrs[i] << ' ';
   }
-  binary_name.clear();
   std::string cmd = stream.str();
 
   /* size (in char) of pointers on this arch */
@@ -210,9 +207,10 @@ std::vector<std::string> resolveBacktrace(
     }
 
     if (strcmp("??", line_func) != 0) {
-      XBT_DEBUG("Found static symbol %s() at %s", line_func, line_pos);
+      auto name = simgrid::xbt::demangle(line_func);
+      XBT_DEBUG("Found static symbol %s at %s", name.get(), line_pos);
       result.push_back(simgrid::xbt::string_printf(
-        "%s() at %s", line_func, line_pos
+        "%s at %s, %p", name.get(), line_pos, loc[i]
       ));
     } else {
       /* Damn. The symbol is in a dynamic library. Let's get wild */
@@ -237,7 +235,7 @@ std::vector<std::string> resolveBacktrace(
       while (!found) {
         long int first, last;
 
-        if (fgets(maps_buff, 512, maps) == NULL)
+        if (fgets(maps_buff, 512, maps) == nullptr)
           break;
         if (i == 0) {
           maps_buff[strlen(maps_buff) - 1] = '\0';
@@ -313,9 +311,10 @@ std::vector<std::string> resolveBacktrace(
 
       /* check whether the trick worked */
       if (strcmp("??", line_func)) {
-        XBT_DEBUG("Found dynamic symbol %s() at %s", line_func, line_pos);
+        auto name = simgrid::xbt::demangle(line_func);
+        XBT_DEBUG("Found dynamic symbol %s at %s", name.get(), line_pos);
         result.push_back(simgrid::xbt::string_printf(
-          "%s() at %s", line_func, line_pos));
+          "%s at %s, %p", name.get(), line_pos, loc[i]));
       } else {
         /* damn, nothing to do here. Let's print the raw address */
         XBT_DEBUG("Dynamic symbol not found. Raw address = %s", backtrace_syms[i]);
@@ -341,11 +340,8 @@ std::vector<std::string> resolveBacktrace(
 
 #if HAVE_MC
 int xbt_libunwind_backtrace(void** bt, int size){
-  int i = 0;
-  for(i=0; i < size; i++)
-    bt[i] = NULL;
-
-  i=0;
+  for (int i = 0; i < size; i++)
+    bt[i] = nullptr;
 
   unw_cursor_t c;
   unw_context_t uc;
@@ -353,14 +349,13 @@ int xbt_libunwind_backtrace(void** bt, int size){
   unw_getcontext (&uc);
   unw_init_local (&c, &uc);
 
-  unw_word_t ip;
-
   unw_step(&c);
 
-  while(unw_step(&c) >= 0 && i < size){
+  int i;
+  for (i = 0; unw_step(&c) >= 0 && i < size; i++) {
+    unw_word_t ip;
     unw_get_reg(&c, UNW_REG_IP, &ip);
     bt[i] = (void*)(long)ip;
-    i++;
   }
 
   return i;