src/xbt/memory_map.cpp

   1 /* Copyright (c) 2008-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include <cstdio>
   7 #include <cstdlib>
   8 #include <cstring>
   9 #include <fstream>
  10 #include <iostream>
  11 #include <string>
  12
  13 #include <sys/types.h>
  14
  15 #if defined __APPLE__
  16 # include <dlfcn.h>
  17 # include <mach/mach_init.h>
  18 # include <mach/mach_traps.h>
  19 # include <mach/mach_port.h>
  20 # include <mach/mach_vm.h>
  21 # include <sys/mman.h>
  22 # include <sys/param.h>
  23 # if __MAC_OS_X_VERSION_MIN_REQUIRED < 1050
  24 #  define mach_vm_address_t vm_address_t
  25 #  define mach_vm_size_t vm_size_t
  26 #  if defined __ppc64__ || defined __x86_64__
  27 #    define mach_vm_region vm_region64
  28 #  else
  29 #    define mach_vm_region vm_region
  30 #  endif
  31 # endif
  32 #endif
  33
  34 #if defined __linux__
  35 # include <sys/mman.h>
  36 #endif
  37
  38 #if defined __FreeBSD__
  39 # include <sys/types.h>
  40 # include <sys/mman.h>
  41 # include <sys/param.h>
  42 # include <sys/queue.h>
  43 # include <sys/socket.h>
  44 # include <sys/sysctl.h>
  45 # include <sys/user.h>
  46 # include <libprocstat.h>
  47 #endif
  48
  49 #include <cinttypes>
  50 #include <xbt/base.h>
  51 #include <xbt/log.h>
  52 #include <xbt/sysdep.h>
  53
  54 #include "memory_map.hpp"
  55
  56 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_memory_map, xbt, "Logging specific to algorithms for memory_map");
  57
  58 namespace simgrid {
  59 namespace xbt {
  60
  61 /**
  62  * \todo This function contains many cases that do not allow for a
  63  *       recovery. Currently, xbt_abort() is called but we should
  64  *       much rather die with the specific reason so that it's easier
  65  *       to find out what's going on.
  66  */
  67 XBT_PRIVATE std::vector<VmMap> get_memory_map(pid_t pid)
  68 {
  69   std::vector<VmMap> ret;
  70 #if defined __APPLE__
  71   vm_map_t map;
  72
  73   /* Request authorization to read mappings */
  74   if (task_for_pid(mach_task_self(), pid, &map) != KERN_SUCCESS) {
  75     std::perror("task_for_pid failed");
  76     xbt_die("Cannot request authorization for kernel information access");
  77   }
  78
  79   /*
  80    * Darwin do not give us the number of mappings, so we read entries until
  81    * we get an KERN_INVALID_ADDRESS return.
  82    */
  83   mach_vm_address_t address = VM_MIN_ADDRESS;
  84   while (true) {
  85     kern_return_t kr;
  86     memory_object_name_t object;
  87     mach_vm_size_t size;
  88 #if defined __ppc64__ || defined __x86_64__
  89     vm_region_flavor_t flavor = VM_REGION_BASIC_INFO_64;
  90     struct vm_region_basic_info_64 info;
  91     mach_msg_type_number_t info_count = VM_REGION_BASIC_INFO_COUNT_64;
  92 #else
  93     vm_region_flavor_t flavor = VM_REGION_BASIC_INFO;
  94     struct vm_region_basic_info info;
  95     mach_msg_type_number_t info_count = VM_REGION_BASIC_INFO_COUNT;
  96 #endif
  97
  98     kr =
  99       mach_vm_region(
 100           map,
 101           &address,
 102           &size,
 103           flavor,
 104           (vm_region_info_t)&info,
 105           &info_count,
 106           &object);
 107     if (kr == KERN_INVALID_ADDRESS) {
 108       break;
 109     }
 110     else if (kr != KERN_SUCCESS) {
 111       std::perror("mach_vm_region failed");
 112       xbt_die("Cannot request authorization for kernel information access");
 113     }
 114
 115     VmMap memreg;
 116
 117     /* Addresses */
 118     memreg.start_addr = address;
 119     memreg.end_addr = address + size;
 120
 121     /* Permissions */
 122     memreg.prot = PROT_NONE;
 123     if (info.protection & VM_PROT_READ)
 124       memreg.prot |= PROT_READ;
 125     if (info.protection & VM_PROT_WRITE)
 126       memreg.prot |= PROT_WRITE;
 127     if (info.protection & VM_PROT_EXECUTE)
 128       memreg.prot |= PROT_EXEC;
 129
 130     /* Private (copy-on-write) or shared? */
 131     memreg.flags = 0;
 132     if (info.shared)
 133       memreg.flags |= MAP_SHARED;
 134     else
 135       memreg.flags |= MAP_PRIVATE;
 136
 137     /* Offset */
 138     memreg.offset = info.offset;
 139
 140     /* Device : not sure this can be mapped to something outside of Linux? */
 141     memreg.dev_major = 0;
 142     memreg.dev_minor = 0;
 143
 144     /* Inode */
 145     memreg.inode = 0;
 146
 147     /* Path */
 148     Dl_info dlinfo;
 149     if (dladdr(reinterpret_cast<void*>(address), &dlinfo))
 150       memreg.pathname = dlinfo.dli_fname;
 151
 152     XBT_DEBUG("Region: %016" PRIx64 "-%016" PRIx64 " | %c%c%c | %s", memreg.start_addr, memreg.end_addr,
 153               (memreg.prot & PROT_READ) ? 'r' : '-', (memreg.prot & PROT_WRITE) ? 'w' : '-',
 154               (memreg.prot & PROT_EXEC) ? 'x' : '-', memreg.pathname.c_str());
 155
 156     ret.push_back(std::move(memreg));
 157     address += size;
 158   }
 159
 160   mach_port_deallocate(mach_task_self(), map);
 161 #elif defined __linux__
 162   /* Open the actual process's proc maps file and create the memory_map_t */
 163   /* to be returned. */
 164   std::string path = std::string("/proc/") + std::to_string(pid) + "/maps";
 165   std::ifstream fp;
 166   fp.rdbuf()->pubsetbuf(0, 0);
 167   fp.open(path);
 168   if (not fp) {
 169     std::perror("open failed");
 170     xbt_die("Cannot open %s to investigate the memory map of the process.", path.c_str());
 171   }
 172
 173   /* Read one line at the time, parse it and add it to the memory map to be returned */
 174   std::string sline;
 175   while (std::getline(fp, sline)) {
 176     /**
 177      * The lines that we read have this format: (This is just an example)
 178      * 00602000-00603000 rw-p 00002000 00:28 1837264                            <complete-path-to-file>
 179      */
 180     char* line = &sline[0];
 181
 182     /* Tokenize the line using spaces as delimiters and store each token in lfields array. We expect 5 tokens for 6 fields */
 183     char* saveptr = nullptr; // for strtok_r()
 184     char* lfields[6];
 185     lfields[0] = strtok_r(line, " ", &saveptr);
 186
 187     int i;
 188     for (i = 1; i < 6 && lfields[i - 1] != nullptr; i++) {
 189       lfields[i] = strtok_r(nullptr, " ", &saveptr);
 190     }
 191
 192     /* Check to see if we got the expected amount of columns */
 193     if (i < 6)
 194       xbt_die("The memory map apparently only supplied less than 6 columns. Recovery impossible.");
 195
 196     /* Ok we are good enough to try to get the info we need */
 197     /* First get the start and the end address of the map   */
 198     char* tok = strtok_r(lfields[0], "-", &saveptr);
 199     if (tok == nullptr)
 200       xbt_die("Start and end address of the map are not concatenated by a hyphen (-). Recovery impossible.");
 201
 202     VmMap memreg;
 203     char *endptr;
 204     memreg.start_addr = std::strtoull(tok, &endptr, 16);
 205     /* Make sure that the entire string was an hex number */
 206     if (*endptr != '\0')
 207       xbt_abort();
 208
 209     tok = strtok_r(nullptr, "-", &saveptr);
 210     if (tok == nullptr)
 211       xbt_abort();
 212
 213     memreg.end_addr = std::strtoull(tok, &endptr, 16);
 214     /* Make sure that the entire string was an hex number */
 215     if (*endptr != '\0')
 216       xbt_abort();
 217
 218     /* Get the permissions flags */
 219     if (std::strlen(lfields[1]) < 4)
 220       xbt_abort();
 221
 222     memreg.prot = 0;
 223     for (i = 0; i < 3; i++){
 224       switch(lfields[1][i]){
 225         case 'r':
 226           memreg.prot |= PROT_READ;
 227           break;
 228         case 'w':
 229           memreg.prot |= PROT_WRITE;
 230           break;
 231         case 'x':
 232           memreg.prot |= PROT_EXEC;
 233           break;
 234         default:
 235           break;
 236       }
 237     }
 238     if (memreg.prot == 0)
 239       memreg.prot |= PROT_NONE;
 240
 241     memreg.flags = 0;
 242     if (lfields[1][3] == 'p') {
 243       memreg.flags |= MAP_PRIVATE;
 244     } else {
 245       memreg.flags |= MAP_SHARED;
 246       if (lfields[1][3] != 's')
 247         XBT_WARN("The protection is neither 'p' (private) nor 's' (shared) but '%s'. Let's assume shared, as on b0rken "
 248                  "win-ubuntu systems.\nFull line: %s\n",
 249                  lfields[1], line);
 250     }
 251
 252     /* Get the offset value */
 253     memreg.offset = std::strtoull(lfields[2], &endptr, 16);
 254     /* Make sure that the entire string was an hex number */
 255     if (*endptr != '\0')
 256       xbt_abort();
 257
 258     /* Get the device major:minor bytes */
 259     tok = strtok_r(lfields[3], ":", &saveptr);
 260     if (tok == nullptr)
 261       xbt_abort();
 262
 263     memreg.dev_major = (char) strtoul(tok, &endptr, 16);
 264     /* Make sure that the entire string was an hex number */
 265     if (*endptr != '\0')
 266       xbt_abort();
 267
 268     tok = strtok_r(nullptr, ":", &saveptr);
 269     if (tok == nullptr)
 270       xbt_abort();
 271
 272     memreg.dev_minor = (char) std::strtoul(tok, &endptr, 16);
 273     /* Make sure that the entire string was an hex number */
 274     if (*endptr != '\0')
 275       xbt_abort();
 276
 277     /* Get the inode number and make sure that the entire string was a long int */
 278     memreg.inode = strtoul(lfields[4], &endptr, 10);
 279     if (*endptr != '\0')
 280       xbt_abort();
 281
 282     /* And finally get the pathname */
 283     if (lfields[5])
 284       memreg.pathname = lfields[5];
 285
 286     /* Create space for a new map region in the region's array and copy the */
 287     /* parsed stuff from the temporal memreg variable */
 288     XBT_DEBUG("Found region for %s", not memreg.pathname.empty() ? memreg.pathname.c_str() : "(null)");
 289
 290     ret.push_back(std::move(memreg));
 291   }
 292
 293   fp.close();
 294 #elif defined __FreeBSD__
 295   struct procstat *prstat;
 296   struct kinfo_proc *proc;
 297   struct kinfo_vmentry *vmentries;
 298   unsigned int cnt;
 299
 300   if ((prstat = procstat_open_sysctl()) == NULL) {
 301     std::perror("procstat_open_sysctl failed");
 302     xbt_die("Cannot access kernel state information");
 303   }
 304   if ((proc = procstat_getprocs(prstat, KERN_PROC_PID, pid, &cnt)) == NULL) {
 305     std::perror("procstat_open_sysctl failed");
 306     xbt_die("Cannot access process information");
 307   }
 308   if ((vmentries = procstat_getvmmap(prstat, proc, &cnt)) == NULL) {
 309     std::perror("procstat_getvmmap failed");
 310     xbt_die("Cannot access process memory mappings");
 311   }
 312   for (unsigned int i = 0; i < cnt; i++) {
 313     VmMap memreg;
 314
 315     /* Addresses */
 316     memreg.start_addr = vmentries[i].kve_start;
 317     memreg.end_addr = vmentries[i].kve_end;
 318
 319     /* Permissions */
 320     memreg.prot = PROT_NONE;
 321     if (vmentries[i].kve_protection & KVME_PROT_READ)
 322       memreg.prot |= PROT_READ;
 323     if (vmentries[i].kve_protection & KVME_PROT_WRITE)
 324       memreg.prot |= PROT_WRITE;
 325     if (vmentries[i].kve_protection & KVME_PROT_EXEC)
 326       memreg.prot |= PROT_EXEC;
 327
 328     /* Private (copy-on-write) or shared? */
 329     memreg.flags = 0;
 330     if (vmentries[i].kve_flags & KVME_FLAG_COW)
 331       memreg.flags |= MAP_PRIVATE;
 332     else
 333       memreg.flags |= MAP_SHARED;
 334
 335     /* Offset */
 336     memreg.offset = vmentries[i].kve_offset;
 337
 338     /* Device : not sure this can be mapped to something outside of Linux? */
 339     memreg.dev_major = 0;
 340     memreg.dev_minor = 0;
 341
 342     /* Inode */
 343     memreg.inode = vmentries[i].kve_vn_fileid;
 344
 345      /*
 346       * Path. Linuxize result by giving an anonymous mapping a path from
 347       * the previous mapping, provided previous is vnode and has a path,
 348       * and mark the stack.
 349       */
 350     if (vmentries[i].kve_path[0] != '\0')
 351       memreg.pathname = vmentries[i].kve_path;
 352     else if (vmentries[i].kve_type == KVME_TYPE_DEFAULT && vmentries[i - 1].kve_type == KVME_TYPE_VNODE &&
 353              vmentries[i - 1].kve_path[0] != '\0')
 354       memreg.pathname = vmentries[i-1].kve_path;
 355     else if (vmentries[i].kve_type == KVME_TYPE_DEFAULT
 356         && vmentries[i].kve_flags & KVME_FLAG_GROWS_DOWN)
 357       memreg.pathname = "[stack]";
 358
 359     /*
 360      * One last dirty modification: remove write permission from shared
 361      * libraries private clean pages. This is necessary because simgrid
 362      * later identifies mappings based on the permissions that are expected
 363      * when running the Linux kernel.
 364      */
 365     if (vmentries[i].kve_type == KVME_TYPE_VNODE && not(vmentries[i].kve_flags & KVME_FLAG_NEEDS_COPY))
 366       memreg.prot &= ~PROT_WRITE;
 367
 368     ret.push_back(std::move(memreg));
 369   }
 370   procstat_freevmmap(prstat, vmentries);
 371   procstat_freeprocs(prstat, proc);
 372   procstat_close(prstat);
 373 #else
 374   xbt_die("Could not get memory map from process %lli", (long long int) pid);
 375 #endif
 376   return ret;
 377 }
 378
 379 }
 380 }