Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
In FreeBSD map backend, mark stack same as in Linux
[simgrid.git] / src / xbt / memory_map.cpp
index 29640c0..fed4b2c 100644 (file)
 #include <sys/types.h>
 #ifdef __linux__
 # include <sys/mman.h>
+#elif defined __FreeBSD__
+# include <sys/types.h>
+# include <sys/mman.h>
+# include <sys/param.h>
+# include <sys/queue.h>
+# include <sys/socket.h>
+# include <sys/sysctl.h>
+# include <sys/user.h>
+# include <libprocstat.h>
 #endif
 
 #include <xbt/sysdep.h>
 #include "memory_map.hpp"
 
 extern "C" {
-
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_memory_map, xbt,
-                                "Logging specific to algorithms for memory_map");
-
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_memory_map, xbt, "Logging specific to algorithms for memory_map");
 }
 
 namespace simgrid {
 namespace xbt {
 
+/**
+ * \todo This function contains many cases that do not allow for a
+ *       recovery. Currently, xbt_abort() is called but we should
+ *       much rather die with the specific reason so that it's easier
+ *       to find out what's going on.
+ */
 XBT_PRIVATE std::vector<VmMap> get_memory_map(pid_t pid)
 {
+  std::vector<VmMap> ret;
 #ifdef __linux__
   /* Open the actual process's proc maps file and create the memory_map_t */
   /* to be returned. */
   char* path = bprintf("/proc/%i/maps", (int) pid);
   FILE *fp = std::fopen(path, "r");
-  if(fp == NULL)
+  if (fp == nullptr) {
     std::perror("fopen failed");
-  xbt_assert(fp,
-    "Cannot open %s to investigate the memory map of the process.", path);
+    xbt_die("Cannot open %s to investigate the memory map of the process.", path);
+  }
   free(path);
-  setbuf(fp, NULL);
-
-  std::vector<VmMap> ret;
+  setbuf(fp, nullptr);
 
   /* Read one line at the time, parse it and add it to the memory map to be returned */
   ssize_t read; /* Number of bytes readed */
-  char* line = NULL;
+  char* line = nullptr;
   std::size_t n = 0; /* Amount of bytes to read by xbt_getline */
   while ((read = xbt_getline(&line, &n, fp)) != -1) {
+    /**
+     * The lines that we read have this format: (This is just an example)
+     * 00602000-00603000 rw-p 00002000 00:28 1837264                            <complete-path-to-file>
+     */
 
     //fprintf(stderr,"%s", line);
 
     /* Wipeout the new line character */
     line[read - 1] = '\0';
 
-    /* Tokenize the line using spaces as delimiters and store each token */
-    /* in lfields array. We expect 5 tokens/fields */
+    /* Tokenize the line using spaces as delimiters and store each token in lfields array. We expect 5 tokens for 6 fields */
     char* lfields[6];
     lfields[0] = strtok(line, " ");
 
     int i;
-    for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
-      lfields[i] = std::strtok(NULL, " ");
+    for (i = 1; i < 6 && lfields[i - 1] != nullptr; i++) {
+      lfields[i] = std::strtok(nullptr, " ");
     }
 
     /* Check to see if we got the expected amount of columns */
     if (i < 6)
-      xbt_abort();
+      xbt_die("The memory map apparently only supplied less than 6 columns. Recovery impossible.");
 
     /* Ok we are good enough to try to get the info we need */
     /* First get the start and the end address of the map   */
     char *tok = std::strtok(lfields[0], "-");
-    if (tok == NULL)
-      xbt_abort();
+    if (tok == nullptr)
+      xbt_die("Start and end address of the map are not concatenated by a hyphen (-). Recovery impossible.");
 
     VmMap memreg;
     char *endptr;
@@ -84,8 +98,8 @@ XBT_PRIVATE std::vector<VmMap> get_memory_map(pid_t pid)
     if (*endptr != '\0')
       xbt_abort();
 
-    tok = std::strtok(NULL, "-");
-    if (tok == NULL)
+    tok = std::strtok(nullptr, "-");
+    if (tok == nullptr)
       xbt_abort();
 
     memreg.end_addr = std::strtoull(tok, &endptr, 16);
@@ -117,11 +131,14 @@ XBT_PRIVATE std::vector<VmMap> get_memory_map(pid_t pid)
     if (memreg.prot == 0)
       memreg.prot |= PROT_NONE;
 
-    if (lfields[1][4] == 'p')
+    if (lfields[1][3] == 'p') {
       memreg.flags |= MAP_PRIVATE;
-
-    else if (lfields[1][4] == 's')
+    } else {
       memreg.flags |= MAP_SHARED;
+      if (lfields[1][3] != 's')
+       XBT_WARN("The protection is neither 'p' (private) nor 's' (shared) but '%s'. Let's assume shared, as on b0rken win-ubuntu systems.\nFull line: %s\n",
+                lfields[1], line);
+    }
 
     /* Get the offset value */
     memreg.offset = std::strtoull(lfields[2], &endptr, 16);
@@ -131,7 +148,7 @@ XBT_PRIVATE std::vector<VmMap> get_memory_map(pid_t pid)
 
     /* Get the device major:minor bytes */
     tok = std::strtok(lfields[3], ":");
-    if (tok == NULL)
+    if (tok == nullptr)
       xbt_abort();
 
     memreg.dev_major = (char) strtoul(tok, &endptr, 16);
@@ -139,8 +156,8 @@ XBT_PRIVATE std::vector<VmMap> get_memory_map(pid_t pid)
     if (*endptr != '\0')
       xbt_abort();
 
-    tok = std::strtok(NULL, ":");
-    if (tok == NULL)
+    tok = std::strtok(nullptr, ":");
+    if (tok == nullptr)
       xbt_abort();
 
     memreg.dev_minor = (char) std::strtoul(tok, &endptr, 16);
@@ -159,20 +176,89 @@ XBT_PRIVATE std::vector<VmMap> get_memory_map(pid_t pid)
 
     /* Create space for a new map region in the region's array and copy the */
     /* parsed stuff from the temporal memreg variable */
-    XBT_DEBUG("Found region for %s",
-      !memreg.pathname.empty() ? memreg.pathname.c_str() : "(null)");
+    XBT_DEBUG("Found region for %s", !memreg.pathname.empty() ? memreg.pathname.c_str() : "(null)");
 
     ret.push_back(std::move(memreg));
   }
 
   std::free(line);
   std::fclose(fp);
-  return std::move(ret);
+#elif defined __FreeBSD__
+  struct procstat *prstat;
+  struct kinfo_proc *proc;
+  struct kinfo_vmentry *vmentries;
+  unsigned int cnt;
+
+  if ((prstat = procstat_open_sysctl()) == NULL) {
+    std::perror("procstat_open_sysctl failed");
+    xbt_die("Cannot access kernel state information");
+  }
+  if ((proc = procstat_getprocs(prstat, KERN_PROC_PID, pid, &cnt)) == NULL) {
+    std::perror("procstat_open_sysctl failed");
+    xbt_die("Cannot access process information");
+  }
+  if ((vmentries = procstat_getvmmap(prstat, proc, &cnt)) == NULL) {
+    std::perror("procstat_getvmmap failed");
+    xbt_die("Cannot access process memory mappings");
+  }
+  for (unsigned int i = 0; i < cnt; i++) {
+    VmMap memreg;
+
+    /* Addresses */
+    memreg.start_addr = vmentries[i].kve_start;
+    memreg.end_addr = vmentries[i].kve_end;
+
+    /* Permissions */
+    memreg.prot = 0;
+    if (vmentries[i].kve_protection & KVME_PROT_READ)
+      memreg.prot |= PROT_READ;
+    if (vmentries[i].kve_protection & KVME_PROT_WRITE)
+      memreg.prot |= PROT_WRITE;
+    if (vmentries[i].kve_protection & KVME_PROT_EXEC)
+      memreg.prot |= PROT_EXEC;
+    if (memreg.prot == 0)
+      memreg.prot |= PROT_NONE;
+
+    /* Private (copy-on-write) or shared? */
+    if (vmentries[i].kve_flags & KVME_FLAG_COW)
+      memreg.flags |= MAP_PRIVATE;
+    else
+      memreg.flags |= MAP_SHARED;
+
+    /* Offset */
+    memreg.offset = vmentries[i].kve_offset;
+
+    /* Device : not sure this can be mapped to something outside of Linux? */
+    memreg.dev_major = 0;
+    memreg.dev_minor = 0;
+
+    /* Inode */
+    memreg.inode = vmentries[i].kve_vn_fileid;
+
+     /*
+      * Path. Linuxize result by giving an anonymous mapping a path from
+      * the previous mapping, provided previous is vnode and has a path,
+      * and mark the stack.
+      */
+    if (vmentries[i].kve_path[0] != '\0')
+      memreg.pathname = vmentries[i].kve_path;
+    else if (vmentries[i].kve_type == KVME_TYPE_DEFAULT
+           && vmentries[i-1].kve_type == KVME_TYPE_VNODE
+        && vmentries[i-1].kve_path[0] != '\0')
+      memreg.pathname = vmentries[i-1].kve_path;
+    else if (vmentries[i].kve_type == KVME_TYPE_DEFAULT
+        && vmentries[i].kve_flags & KVME_FLAG_GROWS_DOWN)
+      memreg.pathname = "[stack]";
+
+    ret.push_back(std::move(memreg));
+  }
+  procstat_freevmmap(prstat, vmentries);
+  procstat_freeprocs(prstat, proc);
+  procstat_close(prstat);
 #else
-  /* On FreeBSD, kinfo_getvmmap() could be used but mmap() support is disabled
-     anyway. */
   xbt_die("Could not get memory map from process %lli", (long long int) pid);
 #endif
+  return ret;
 }
 
 }