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