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