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