Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
rename the plugins from the command line, and document it
[simgrid.git] / src / xbt / backtrace_linux.cpp
index 94dad3a..abedb81 100644 (file)
@@ -1,12 +1,14 @@
 /* backtrace_linux - backtrace displaying on linux platform                 */
 /* This file is included by ex.cpp on need (have execinfo.h, popen & addrline)*/
 
-/* Copyright (c) 2008-2016. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2008-2018. 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 <cerrno>
+#include <cstring>
+#include <fstream>
 #include <sstream>
 #include <string>
 #include <vector>
 #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 */
 #include "src/xbt_modinter.h"       /* backtrace initialization headers */
-#if HAVE_MC
+#if SIMGRID_HAVE_MC
 #define UNW_LOCAL_ONLY
 #include <libunwind.h>
 #endif
 
 extern char **environ;          /* the environment, as specified by the opengroup */
 
-/* Module creation/destruction: nothing to do on linux */
-void xbt_backtrace_preinit()
-{
-}
-
-void xbt_backtrace_postexit()
-{
-}
-
 #include <unwind.h>
 struct trace_arg {
-  void **array;
-  int cnt, size;
+  void** array;
+  int cnt;
+  int size;
 };
 
-static _Unwind_Reason_Code
-backtrace_helper (struct _Unwind_Context *ctx, void *a)
+static _Unwind_Reason_Code backtrace_helper(_Unwind_Context* ctx, void* a)
 {
-  struct trace_arg *arg = (struct trace_arg *) a;
+  trace_arg* arg = static_cast<trace_arg*>(a);
 
   /* We are first called with address in the __backtrace function.
      Skip it.  */
@@ -71,7 +62,7 @@ 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
  * */
 
@@ -167,7 +158,7 @@ std::vector<std::string> resolveBacktrace(
   if (binary_name.empty()) {
     for (std::size_t i = 0; i < count; i++)
       result.push_back(simgrid::xbt::string_printf("%p", loc[i]));
-    return std::move(result);
+    return result;
   }
 
   // Create the system command for add2line:
@@ -176,7 +167,7 @@ std::vector<std::string> resolveBacktrace(
   std::vector<std::string> addrs(count);
   for (std::size_t i = 0; i < count; i++) {
     /* retrieve this address */
-    XBT_DEBUG("Retrieving address number %zd from '%s'", i, backtrace_syms[i]);
+    XBT_DEBUG("Retrieving address number %zu from '%s'", i, backtrace_syms[i]);
     char buff[256];
     snprintf(buff, 256, "%s", strchr(backtrace_syms[i], '[') + 1);
     char* p = strchr(buff, ']');
@@ -185,7 +176,7 @@ std::vector<std::string> resolveBacktrace(
       addrs[i] = buff;
     else
       addrs[i] = "0x0";
-    XBT_DEBUG("Set up a new address: %zd, '%s'", i, addrs[i].c_str());
+    XBT_DEBUG("Set up a new address: %zu, '%s'", i, addrs[i].c_str());
     /* Add it to the command line args */
     stream << addrs[i] << ' ';
   }
@@ -196,24 +187,25 @@ std::vector<std::string> resolveBacktrace(
 
   XBT_VERB("Fire a first command: '%s'", cmd.c_str());
   FILE* pipe = popen(cmd.c_str(), "r");
-  if (!pipe) {
+  if (not pipe) {
     xbt_die("Cannot fork addr2line to display the backtrace");
   }
 
   /* To read the output of addr2line */
-  char line_func[1024], line_pos[1024];
+  char line_func[1024];
+  char line_pos[1024];
   for (std::size_t i = 0; i < count; i++) {
-    XBT_DEBUG("Looking for symbol %zd, addr = '%s'", i, addrs[i].c_str());
+    XBT_DEBUG("Looking for symbol %zu, addr = '%s'", i, addrs[i].c_str());
     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].c_str());
+      XBT_VERB("Cannot run fgets to look for symbol %zu, addr %s", i, addrs[i].c_str());
       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].c_str());
+      XBT_VERB("Cannot run fgets to look for symbol %zu, addr %s", i, addrs[i].c_str());
       strncpy(line_pos, backtrace_syms[i],1024);
     }
 
@@ -226,35 +218,36 @@ std::vector<std::string> resolveBacktrace(
     } else {
       /* Damn. The symbol is in a dynamic library. Let's get wild */
 
-      char maps_buff[512];
-      long int offset = 0;
-      char *p, *p2;
+      unsigned long int offset = 0;
       int found = 0;
 
       /* let's look for the offset of this library in our addressing space */
-      char* maps_name = bprintf("/proc/%d/maps", (int) getpid());
-      FILE* maps = fopen(maps_name, "r");
-
-      long int addr = strtol(addrs[i].c_str(), &p, 16);
-      if (*p != '\0') {
-        XBT_CRITICAL("Cannot parse backtrace address '%s' (addr=%#lx)",
-          addrs[i].c_str(), addr);
+      std::string maps_name = std::string("/proc/") + std::to_string(getpid()) + "/maps";
+      std::ifstream maps(maps_name);
+      if (not maps) {
+        XBT_CRITICAL("open(\"%s\") failed: %s", maps_name.c_str(), strerror(errno));
+        continue;
+      }
+      size_t pos;
+      unsigned long int addr = std::stoul(addrs[i], &pos, 16);
+      if (pos != addrs[i].length()) {
+        XBT_CRITICAL("Cannot parse backtrace address '%s' (addr=%#lx)", addrs[i].c_str(), addr);
       }
-      XBT_DEBUG("addr=%s (as string) =%#lx (as number)",
-        addrs[i].c_str(), addr);
+      XBT_DEBUG("addr=%s (as string) =%#lx (as number)", addrs[i].c_str(), addr);
 
-      while (!found) {
-        long int first, last;
+      while (not found) {
+        unsigned long int first;
+        unsigned long int last;
 
-        if (fgets(maps_buff, 512, maps) == nullptr)
+        std::string maps_buff;
+        if (not std::getline(maps, maps_buff))
           break;
         if (i == 0) {
-          maps_buff[strlen(maps_buff) - 1] = '\0';
-          XBT_DEBUG("map line: %s", maps_buff);
+          XBT_DEBUG("map line: %s", maps_buff.c_str());
         }
-        sscanf(maps_buff, "%lx", &first);
-        p = strchr(maps_buff, '-') + 1;
-        sscanf(p, "%lx", &last);
+        first = std::stoul(maps_buff, &pos, 16);
+        maps_buff.erase(0, pos + 1);
+        last = std::stoul(maps_buff, nullptr, 16);
         if (first < addr && addr < last) {
           offset = first;
           found = 1;
@@ -264,11 +257,10 @@ std::vector<std::string> resolveBacktrace(
           XBT_DEBUG("Symbol found, map lines not further displayed (even if looking for next ones)");
         }
       }
-      fclose(maps);
-      free(maps_name);
+      maps.close();
       addrs[i].clear();
 
-      if (!found) {
+      if (not found) {
         XBT_VERB("Problem while reading the maps file. Following backtrace will be mangled.");
         XBT_DEBUG("No dynamic. Static symbol: %s", backtrace_syms[i]);
         result.push_back(simgrid::xbt::string_printf("?? (%s)", backtrace_syms[i]));
@@ -283,41 +275,35 @@ std::vector<std::string> resolveBacktrace(
       XBT_DEBUG("offset=%#lx new addr=%s", offset, addrs[i].c_str());
 
       /* Got it. We have our new address. Let's get the library path and we are set */
-      p = xbt_strdup(backtrace_syms[i]);
+      std::string p(backtrace_syms[i]);
       if (p[0] == '[') {
         /* library path not displayed in the map file either... */
-        free(p);
-        snprintf(line_func,3, "??");
+        snprintf(line_func, 3, "??");
       } else {
-        p2 = strrchr(p, '(');
-        if (p2)
-          *p2 = '\0';
-        p2 = strrchr(p, ' ');
-        if (p2)
-          *p2 = '\0';
+        size_t p2 = p.find_first_of("( ");
+        if (p2 != std::string::npos)
+          p.erase(p2);
 
         /* Here we go, fire an addr2line up */
-        char* subcmd = bprintf("%s -f -e %s %s", ADDR2LINE, p, addrs[i].c_str());
-        free(p);
-        XBT_VERB("Fire a new command: '%s'", subcmd);
-        FILE* subpipe = popen(subcmd, "r");
-        if (!subpipe) {
+        std::string subcmd = std::string(ADDR2LINE) + " -f -e " + p + " " + addrs[i];
+        XBT_VERB("Fire a new command: '%s'", subcmd.c_str());
+        FILE* subpipe = popen(subcmd.c_str(), "r");
+        if (not subpipe) {
           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);
+          XBT_VERB("Cannot read result of subcommand %s", subcmd.c_str());
           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);
+          XBT_VERB("Cannot read result of subcommand %s", subcmd.c_str());
           strncpy(line_pos, backtrace_syms[i],1024);
         }
         pclose(subpipe);
-        free(subcmd);
       }
 
       /* check whether the trick worked */
@@ -336,9 +322,19 @@ std::vector<std::string> resolveBacktrace(
     addrs[i].clear();
 
     /* 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")))
+    const char* const breakers[] = {
+        "main",
+        "_ZN7simgrid6kernel7context13ThreadContext7wrapperE", // simgrid::kernel::context::ThreadContext::wrapper
+        "_ZN7simgrid6kernel7context8UContext7wrapperE"        // simgrid::kernel::context::UContext::wrapper
+    };
+    bool do_break = false;
+    for (const char* b : breakers) {
+      if (strncmp(b, line_func, strlen(b)) == 0) {
+        do_break = true;
+        break;
+      }
+    }
+    if (do_break)
       break;
   }
   pclose(pipe);
@@ -349,28 +345,24 @@ std::vector<std::string> resolveBacktrace(
 }
 }
 
-#if HAVE_MC
+#if SIMGRID_HAVE_MC
 int xbt_libunwind_backtrace(void** bt, int size){
-  int i = 0;
-  for(i=0; i < size; i++)
+  for (int i = 0; i < size; i++)
     bt[i] = nullptr;
 
-  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){
+  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;