src/mc/Process.cpp

   1 /* Copyright (c) 2014-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #define _FILE_OFFSET_BITS 64
   8
   9 #include <assert.h>
  10 #include <stddef.h>
  11 #include <stdbool.h>
  12 #include <stdint.h>
  13 #include <errno.h>
  14
  15 #include <sys/types.h>
  16 #include <fcntl.h>
  17 #include <unistd.h>
  18 #include <regex.h>
  19 #include <sys/mman.h> // PROT_*
  20
  21 #include <pthread.h>
  22
  23 #include <libgen.h>
  24
  25 #include <libunwind.h>
  26 #include <libunwind-ptrace.h>
  27
  28 #include <xbt/mmalloc.h>
  29
  30 #include "mc_object_info.h"
  31 #include "mc_unw.h"
  32 #include "mc_snapshot.h"
  33 #include "mc_ignore.h"
  34 #include "mc_smx.h"
  35 #include "mc_server.h"
  36
  37 #include "src/mc/Process.hpp"
  38 #include "src/mc/AddressSpace.hpp"
  39 #include "src/mc/ObjectInformation.hpp"
  40 #include "src/mc/Variable.hpp"
  41
  42 using simgrid::mc::remote;
  43
  44 extern "C" {
  45
  46 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_process, mc,
  47                                 "MC process information");
  48
  49 // ***** Helper stuff
  50
  51 #define SO_RE "\\.so[\\.0-9]*$"
  52 #define VERSION_RE "-[\\.0-9-]*$"
  53
  54 static const char *const FILTERED_LIBS[] = {
  55   "ld",
  56   "libbz2",
  57   "libboost_chrono",
  58   "libboost_context",
  59   "libboost_system",
  60   "libboost_thread",
  61   "libc",
  62   "libc++",
  63   "libcdt",
  64   "libcgraph",
  65   "libdl",
  66   "libdw",
  67   "libelf",
  68   "libgcc_s",
  69   "liblua5.1",
  70   "liblua5.3",
  71   "liblzma",
  72   "libm",
  73   "libpthread",
  74   "librt",
  75   "libsigc",
  76   "libstdc++",
  77   "libunwind",
  78   "libunwind-x86_64",
  79   "libunwind-x86",
  80   "libunwind-ptrace",
  81   "libz"
  82 };
  83
  84 static bool MC_is_simgrid_lib(const char* libname)
  85 {
  86   return !strcmp(libname, "libsimgrid");
  87 }
  88
  89 static bool MC_is_filtered_lib(const char* libname)
  90 {
  91   for (const char* filtered_lib : FILTERED_LIBS)
  92     if (strcmp(libname, filtered_lib)==0)
  93       return true;
  94   return false;
  95 }
  96
  97 struct s_mc_memory_map_re {
  98   regex_t so_re;
  99   regex_t version_re;
 100 };
 101
 102 static char* MC_get_lib_name(const char* pathname, struct s_mc_memory_map_re* res)
 103 {
 104   const char* map_basename = basename((char*) pathname);
 105
 106   regmatch_t match;
 107   if(regexec(&res->so_re, map_basename, 1, &match, 0))
 108     return NULL;
 109
 110   char* libname = strndup(map_basename, match.rm_so);
 111
 112   // Strip the version suffix:
 113   if(libname && !regexec(&res->version_re, libname, 1, &match, 0)) {
 114     char* temp = libname;
 115     libname = strndup(temp, match.rm_so);
 116     free(temp);
 117   }
 118
 119   return libname;
 120 }
 121
 122 static ssize_t pread_whole(int fd, void *buf, size_t count, std::uint64_t offset)
 123 {
 124   char* buffer = (char*) buf;
 125   ssize_t real_count = count;
 126   while (count) {
 127     ssize_t res = pread(fd, buffer, count, (std::int64_t) offset);
 128     if (res > 0) {
 129       count  -= res;
 130       buffer += res;
 131       offset += res;
 132     } else if (res==0) {
 133       return -1;
 134     } else if (errno != EINTR) {
 135       perror("pread_whole");
 136       return -1;
 137     }
 138   }
 139   return real_count;
 140 }
 141
 142 static ssize_t pwrite_whole(int fd, const void *buf, size_t count, off_t offset)
 143 {
 144   const char* buffer = (const char*) buf;
 145   ssize_t real_count = count;
 146   while (count) {
 147     ssize_t res = pwrite(fd, buffer, count, offset);
 148     if (res > 0) {
 149       count  -= res;
 150       buffer += res;
 151       offset += res;
 152     } else if (res==0) {
 153       return -1;
 154     } else if (errno != EINTR) {
 155       return -1;
 156     }
 157   }
 158   return real_count;
 159 }
 160
 161 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
 162 static const void* zero_buffer;
 163 static const size_t zero_buffer_size = 10 * 4096;
 164
 165 static void MC_zero_buffer_init(void)
 166 {
 167   int fd = open("/dev/zero", O_RDONLY);
 168   if (fd<0)
 169     xbt_die("Could not open /dev/zero");
 170   zero_buffer = mmap(NULL, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
 171   if (zero_buffer == MAP_FAILED)
 172     xbt_die("Could not map the zero buffer");
 173   close(fd);
 174 }
 175
 176 static
 177 int open_process_file(pid_t pid, const char* file, int flags)
 178 {
 179   char buff[50];
 180   snprintf(buff, sizeof(buff), "/proc/%li/%s", (long) pid, file);
 181   return open(buff, flags);
 182 }
 183
 184 }
 185
 186 namespace simgrid {
 187 namespace mc {
 188
 189 int open_vm(pid_t pid, int flags)
 190 {
 191   const size_t buffer_size = 30;
 192   char buffer[buffer_size];
 193   int res = snprintf(buffer, buffer_size, "/proc/%lli/mem", (long long) pid);
 194   if (res < 0 || (size_t) res >= buffer_size) {
 195     errno = ENAMETOOLONG;
 196     return -1;
 197   }
 198   return open(buffer, flags);
 199 }
 200
 201
 202 }
 203 }
 204
 205 // ***** Process
 206
 207 namespace simgrid {
 208 namespace mc {
 209
 210 Process::Process(pid_t pid, int sockfd) : AddressSpace(this)
 211 {
 212   Process* process = this;
 213   process->socket_ = sockfd;
 214   process->pid_ = pid;
 215   process->running_ = true;
 216   process->status_ = 0;
 217   process->memory_map_ = get_memory_map(pid);
 218   process->cache_flags = MC_PROCESS_CACHE_FLAG_NONE;
 219   process->heap = NULL;
 220   process->heap_info = NULL;
 221   process->init_memory_map_info();
 222   process->clear_refs_fd_ = -1;
 223   process->pagemap_fd_ = -1;
 224
 225   int fd = open_vm(process->pid_, O_RDWR);
 226   if (fd<0)
 227     xbt_die("Could not open file for process virtual address space");
 228   process->memory_file = fd;
 229
 230   // Read std_heap (is a struct mdesc*):
 231   simgrid::mc::Variable* std_heap_var = process->find_variable("__mmalloc_default_mdp");
 232   if (!std_heap_var)
 233     xbt_die("No heap information in the target process");
 234   if(!std_heap_var->address)
 235     xbt_die("No constant address for this variable");
 236   process->read_bytes(&process->heap_address, sizeof(struct mdesc*),
 237     remote(std_heap_var->address),
 238     simgrid::mc::ProcessIndexDisabled);
 239
 240   process->smx_process_infos = MC_smx_process_info_list_new();
 241   process->smx_old_process_infos = MC_smx_process_info_list_new();
 242   process->unw_addr_space = unw_create_addr_space(&mc_unw_accessors  , __BYTE_ORDER);
 243   process->unw_underlying_addr_space = unw_create_addr_space(&mc_unw_vmread_accessors, __BYTE_ORDER);
 244   process->unw_underlying_context = _UPT_create(pid);
 245 }
 246
 247 Process::~Process()
 248 {
 249   Process* process = this;
 250
 251   if (this->socket_ >= 0 && close(this->socket_) < 0)
 252     xbt_die("Could not close communication socket");
 253
 254   process->pid_ = 0;
 255
 256   process->maestro_stack_start_ = nullptr;
 257   process->maestro_stack_end_ = nullptr;
 258
 259   xbt_dynar_free(&process->smx_process_infos);
 260   xbt_dynar_free(&process->smx_old_process_infos);
 261
 262   if (process->memory_file >= 0) {
 263     close(process->memory_file);
 264   }
 265
 266   if (process->unw_underlying_addr_space != unw_local_addr_space) {
 267     unw_destroy_addr_space(process->unw_underlying_addr_space);
 268     _UPT_destroy(process->unw_underlying_context);
 269   }
 270   process->unw_underlying_context = NULL;
 271   process->unw_underlying_addr_space = NULL;
 272
 273   unw_destroy_addr_space(process->unw_addr_space);
 274   process->unw_addr_space = NULL;
 275
 276   process->cache_flags = MC_PROCESS_CACHE_FLAG_NONE;
 277
 278   free(process->heap);
 279   process->heap = NULL;
 280
 281   free(process->heap_info);
 282   process->heap_info = NULL;
 283
 284   if (process->clear_refs_fd_ >= 0)
 285     close(process->clear_refs_fd_);
 286   if (process->pagemap_fd_ >= 0)
 287     close(process->pagemap_fd_);
 288 }
 289
 290 /** Refresh the information about the process
 291  *
 292  *  Do not use direclty, this is used by the getters when appropriate
 293  *  in order to have fresh data.
 294  */
 295 void Process::refresh_heap()
 296 {
 297   xbt_assert(mc_mode == MC_MODE_SERVER);
 298   // Read/dereference/refresh the std_heap pointer:
 299   if (!this->heap) {
 300     this->heap = (struct mdesc*) malloc(sizeof(struct mdesc));
 301   }
 302   this->read_bytes(this->heap, sizeof(struct mdesc), remote(this->heap_address),
 303     simgrid::mc::ProcessIndexDisabled);
 304   this->cache_flags |= MC_PROCESS_CACHE_FLAG_HEAP;
 305 }
 306
 307 /** Refresh the information about the process
 308  *
 309  *  Do not use direclty, this is used by the getters when appropriate
 310  *  in order to have fresh data.
 311  * */
 312 void Process::refresh_malloc_info()
 313 {
 314   xbt_assert(mc_mode == MC_MODE_SERVER);
 315   if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
 316     this->refresh_heap();
 317   // Refresh process->heapinfo:
 318   size_t malloc_info_bytesize =
 319     (this->heap->heaplimit + 1) * sizeof(malloc_info);
 320   this->heap_info = (malloc_info*) realloc(this->heap_info, malloc_info_bytesize);
 321   this->read_bytes(this->heap_info, malloc_info_bytesize,
 322     remote(this->heap->heapinfo), simgrid::mc::ProcessIndexDisabled);
 323   this->cache_flags |= MC_PROCESS_CACHE_FLAG_MALLOC_INFO;
 324 }
 325
 326 /** @brief Finds the range of the different memory segments and binary paths */
 327 void Process::init_memory_map_info()
 328 {
 329   XBT_DEBUG("Get debug information ...");
 330   this->maestro_stack_start_ = nullptr;
 331   this->maestro_stack_end_ = nullptr;
 332   this->object_infos.resize(0);
 333   this->binary_info = NULL;
 334   this->libsimgrid_info = NULL;
 335
 336   struct s_mc_memory_map_re res;
 337
 338   if(regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
 339     xbt_die(".so regexp did not compile");
 340
 341   std::vector<simgrid::mc::VmMap> const& maps = this->memory_map_;
 342
 343   const char* current_name = NULL;
 344
 345   this->object_infos.resize(0);
 346
 347   for (size_t i=0; i < maps.size(); i++) {
 348     simgrid::mc::VmMap const& reg = maps[i];
 349     const char* pathname = maps[i].pathname.c_str();
 350
 351     // Nothing to do
 352     if (maps[i].pathname.empty()) {
 353       current_name = NULL;
 354       continue;
 355     }
 356
 357     // [stack], [vvar], [vsyscall], [vdso] ...
 358     if (pathname[0] == '[') {
 359       if ((reg.prot & PROT_WRITE) && !memcmp(pathname, "[stack]", 7)) {
 360         this->maestro_stack_start_ = remote(reg.start_addr);
 361         this->maestro_stack_end_ = remote(reg.end_addr);
 362       }
 363       current_name = NULL;
 364       continue;
 365     }
 366
 367     if (current_name && strcmp(current_name, pathname)==0)
 368       continue;
 369
 370     current_name = pathname;
 371     if (!(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
 372       continue;
 373
 374     const bool is_executable = !i;
 375     char* libname = NULL;
 376     if (!is_executable) {
 377       libname = MC_get_lib_name(pathname, &res);
 378       if(!libname)
 379         continue;
 380       if (MC_is_filtered_lib(libname)) {
 381         free(libname);
 382         continue;
 383       }
 384     }
 385
 386     std::shared_ptr<simgrid::mc::ObjectInformation> info =
 387       MC_find_object_info(this->memory_map_, pathname);
 388     this->object_infos.push_back(info);
 389     if (is_executable)
 390       this->binary_info = info;
 391     else if (libname && MC_is_simgrid_lib(libname))
 392       this->libsimgrid_info = info;
 393     free(libname);
 394   }
 395
 396   regfree(&res.so_re);
 397   regfree(&res.version_re);
 398
 399   // Resolve time (including accross differents objects):
 400   for (auto const& object_info : this->object_infos)
 401     MC_post_process_object_info(this, object_info.get());
 402
 403   xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
 404   xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
 405
 406   XBT_DEBUG("Get debug information done !");
 407 }
 408
 409 std::shared_ptr<simgrid::mc::ObjectInformation> Process::find_object_info(remote_ptr<void> addr) const
 410 {
 411   for (auto const& object_info : this->object_infos) {
 412     if (addr.address() >= (std::uint64_t)object_info->start
 413         && addr.address() <= (std::uint64_t)object_info->end) {
 414       return object_info;
 415     }
 416   }
 417   return NULL;
 418 }
 419
 420 std::shared_ptr<ObjectInformation> Process::find_object_info_exec(remote_ptr<void> addr) const
 421 {
 422   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos) {
 423     if (addr.address() >= (std::uint64_t) info->start_exec
 424         && addr.address() <= (std::uint64_t) info->end_exec) {
 425       return info;
 426     }
 427   }
 428   return nullptr;
 429 }
 430
 431 std::shared_ptr<ObjectInformation> Process::find_object_info_rw(remote_ptr<void> addr) const
 432 {
 433   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos) {
 434     if (addr.address() >= (std::uint64_t)info->start_rw
 435         && addr.address() <= (std::uint64_t)info->end_rw) {
 436       return info;
 437     }
 438   }
 439   return nullptr;
 440 }
 441
 442 simgrid::mc::Frame* Process::find_function(remote_ptr<void> ip) const
 443 {
 444   std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
 445   return info ? info->find_function((void*) ip.address()) : nullptr;
 446 }
 447
 448 /** Find (one occurence of) the named variable definition
 449  */
 450 simgrid::mc::Variable* Process::find_variable(const char* name) const
 451 {
 452   // First lookup the variable in the executable shared object.
 453   // A global variable used directly by the executable code from a library
 454   // is reinstanciated in the executable memory .data/.bss.
 455   // We need to look up the variable in the execvutable first.
 456   if (this->binary_info) {
 457     std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
 458     simgrid::mc::Variable* var = info->find_variable(name);
 459     if (var)
 460       return var;
 461   }
 462
 463   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
 464     simgrid::mc::Variable* var = info->find_variable(name);
 465     if (var)
 466       return var;
 467   }
 468
 469   return NULL;
 470 }
 471
 472 void Process::read_variable(const char* name, void* target, size_t size) const
 473 {
 474   simgrid::mc::Variable* var = this->find_variable(name);
 475   if (!var->address)
 476     xbt_die("No simple location for this variable");
 477   if (!var->type->full_type)
 478     xbt_die("Partial type for %s, cannot check size", name);
 479   if ((size_t) var->type->full_type->byte_size != size)
 480     xbt_die("Unexpected size for %s (expected %zi, was %zi)",
 481       name, size, (size_t) var->type->full_type->byte_size);
 482   this->read_bytes(target, size, remote(var->address));
 483 }
 484
 485 char* Process::read_string(remote_ptr<void> address) const
 486 {
 487   if (!address)
 488     return NULL;
 489
 490   off_t len = 128;
 491   char* res = (char*) malloc(len);
 492   off_t off = 0;
 493
 494   while (1) {
 495     ssize_t c = pread(this->memory_file, res + off, len - off, (off_t) address.address() + off);
 496     if (c == -1) {
 497       if (errno == EINTR)
 498         continue;
 499       else
 500         xbt_die("Could not read from from remote process");
 501     }
 502     if (c==0)
 503       xbt_die("Could not read string from remote process");
 504
 505     void* p = memchr(res + off, '\0', c);
 506     if (p)
 507       return res;
 508
 509     off += c;
 510     if (off == len) {
 511       len *= 2;
 512       res = (char*) realloc(res, len);
 513     }
 514   }
 515 }
 516
 517 const void *Process::read_bytes(void* buffer, std::size_t size,
 518   remote_ptr<void> address, int process_index,
 519   AddressSpace::ReadMode mode) const
 520 {
 521   if (process_index != simgrid::mc::ProcessIndexDisabled) {
 522     std::shared_ptr<simgrid::mc::ObjectInformation> const& info =
 523       this->find_object_info_rw((void*)address.address());
 524     // Segment overlap is not handled.
 525 #ifdef HAVE_SMPI
 526     if (info.get() && info.get()->privatized()) {
 527       if (process_index < 0)
 528         xbt_die("Missing process index");
 529       if (process_index >= (int) MC_smpi_process_count())
 530         xbt_die("Invalid process index");
 531
 532       // Read smpi_privatisation_regions from MCed:
 533       smpi_privatisation_region_t remote_smpi_privatisation_regions =
 534         mc_model_checker->process().read_variable<smpi_privatisation_region_t>(
 535           "smpi_privatisation_regions");
 536
 537       s_smpi_privatisation_region_t privatisation_region =
 538         mc_model_checker->process().read<s_smpi_privatisation_region_t>(
 539           remote(remote_smpi_privatisation_regions + process_index));
 540
 541       // Address translation in the privaization segment:
 542       size_t offset = address.address() - (std::uint64_t)info->start_rw;
 543       address = remote((char*)privatisation_region.address + offset);
 544     }
 545 #endif
 546   }
 547
 548   if (pread_whole(this->memory_file, buffer, size, address.address()) < 0)
 549     xbt_die("Read from process %lli failed", (long long) this->pid_);
 550   return buffer;
 551 }
 552
 553 /** Write data to a process memory
 554  *
 555  *  @param process the process
 556  *  @param local   local memory address (source)
 557  *  @param remote  target process memory address (target)
 558  *  @param len     data size
 559  */
 560 void Process::write_bytes(const void* buffer, size_t len, remote_ptr<void> address)
 561 {
 562   if (pwrite_whole(this->memory_file, buffer, len, address.address()) < 0)
 563     xbt_die("Write to process %lli failed", (long long) this->pid_);
 564 }
 565
 566 void Process::clear_bytes(remote_ptr<void> address, size_t len)
 567 {
 568   pthread_once(&zero_buffer_flag, MC_zero_buffer_init);
 569   while (len) {
 570     size_t s = len > zero_buffer_size ? zero_buffer_size : len;
 571     this->write_bytes(zero_buffer, s, address);
 572     address = remote((char*) address.address() + s);
 573     len -= s;
 574   }
 575 }
 576
 577 void Process::ignore_region(std::uint64_t addr, std::size_t size)
 578 {
 579   IgnoredRegion region;
 580   region.addr = addr;
 581   region.size = size;
 582
 583   if (ignored_regions_.empty()) {
 584     ignored_regions_.push_back(region);
 585     return;
 586   }
 587
 588   unsigned int cursor = 0;
 589   IgnoredRegion* current_region = nullptr;
 590
 591   int start = 0;
 592   int end = ignored_regions_.size() - 1;
 593   while (start <= end) {
 594     cursor = (start + end) / 2;
 595     current_region = &ignored_regions_[cursor];
 596     if (current_region->addr == addr) {
 597       if (current_region->size == size)
 598         return;
 599       else if (current_region->size < size)
 600         start = cursor + 1;
 601       else
 602         end = cursor - 1;
 603     } else if (current_region->addr < addr)
 604       start = cursor + 1;
 605     else
 606       end = cursor - 1;
 607   }
 608
 609   std::size_t position;
 610   if (current_region->addr == addr) {
 611     if (current_region->size < size) {
 612       position = cursor + 1;
 613     } else {
 614       position = cursor;
 615     }
 616   } else if (current_region->addr < addr) {
 617     position = cursor + 1;
 618   } else {
 619     position = cursor;
 620   }
 621   ignored_regions_.insert(
 622     ignored_regions_.begin() + position, region);
 623 }
 624
 625 void Process::reset_soft_dirty()
 626 {
 627   if (this->clear_refs_fd_ < 0) {
 628     this->clear_refs_fd_ = open_process_file(pid_, "clear_refs", O_WRONLY|O_CLOEXEC);
 629     if (this->clear_refs_fd_ < 0)
 630       xbt_die("Could not open clear_refs file for soft-dirty tracking. Run as root?");
 631   }
 632   if(::write(this->clear_refs_fd_, "4\n", 2) != 2)
 633     xbt_die("Could not reset softdirty bits");
 634 }
 635
 636 void Process::read_pagemap(uint64_t* pagemap, size_t page_start, size_t page_count)
 637 {
 638   if (pagemap_fd_ < 0) {
 639     pagemap_fd_ = open_process_file(pid_, "pagemap", O_RDONLY|O_CLOEXEC);
 640     if (pagemap_fd_ < 0)
 641       xbt_die("Could not open pagemap file for soft-dirty tracking. Run as root?");
 642   }
 643   ssize_t bytesize = sizeof(uint64_t) * page_count;
 644   off_t offset = sizeof(uint64_t) * page_start;
 645   if (pread_whole(pagemap_fd_, pagemap, bytesize, offset) != bytesize)
 646     xbt_die("Could not read pagemap");
 647 }
 648
 649 }
 650 }