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 not 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 && not 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, off_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, 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()
 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 (not std_heap_var)
 230     xbt_die("No heap information in the target process");
 231   if (not 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     if (this->unw_underlying_addr_space)
 252       unw_destroy_addr_space(this->unw_underlying_addr_space);
 253     if (this->unw_underlying_context)
 254       _UPT_destroy(this->unw_underlying_context);
 255   }
 256
 257   unw_destroy_addr_space(this->unw_addr_space);
 258 }
 259
 260 /** Refresh the information about the process
 261  *
 262  *  Do not use directly, this is used by the getters when appropriate
 263  *  in order to have fresh data.
 264  */
 265 void Process::refresh_heap()
 266 {
 267   // Read/dereference/refresh the std_heap pointer:
 268   if (not this->heap)
 269     this->heap = std::unique_ptr<s_xbt_mheap_t>(new s_xbt_mheap_t());
 270   this->read_bytes(this->heap.get(), sizeof(struct mdesc),
 271     remote(this->heap_address), simgrid::mc::ProcessIndexDisabled);
 272   this->cache_flags_ |= Process::cache_heap;
 273 }
 274
 275 /** Refresh the information about the process
 276  *
 277  *  Do not use direclty, this is used by the getters when appropriate
 278  *  in order to have fresh data.
 279  * */
 280 void Process::refresh_malloc_info()
 281 {
 282   // Refresh process->heapinfo:
 283   if (this->cache_flags_ & Process::cache_malloc)
 284     return;
 285   size_t count = this->heap->heaplimit + 1;
 286   if (this->heap_info.size() < count)
 287     this->heap_info.resize(count);
 288   this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info),
 289     remote(this->heap->heapinfo), simgrid::mc::ProcessIndexDisabled);
 290   this->cache_flags_ |= Process::cache_malloc;
 291 }
 292
 293 /** @brief Finds the range of the different memory segments and binary paths */
 294 void Process::init_memory_map_info()
 295 {
 296   XBT_DEBUG("Get debug information ...");
 297   this->maestro_stack_start_ = nullptr;
 298   this->maestro_stack_end_ = nullptr;
 299   this->object_infos.resize(0);
 300   this->binary_info = nullptr;
 301   this->libsimgrid_info = nullptr;
 302
 303   struct s_mc_memory_map_re res;
 304
 305   if(regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
 306     xbt_die(".so regexp did not compile");
 307
 308   std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
 309
 310   const char* current_name = nullptr;
 311
 312   this->object_infos.clear();
 313
 314   for (size_t i=0; i < maps.size(); i++) {
 315     simgrid::xbt::VmMap const& reg = maps[i];
 316     const char* pathname = maps[i].pathname.c_str();
 317
 318     // Nothing to do
 319     if (maps[i].pathname.empty()) {
 320       current_name = nullptr;
 321       continue;
 322     }
 323
 324     // [stack], [vvar], [vsyscall], [vdso] ...
 325     if (pathname[0] == '[') {
 326       if ((reg.prot & PROT_WRITE) && not memcmp(pathname, "[stack]", 7)) {
 327         this->maestro_stack_start_ = remote(reg.start_addr);
 328         this->maestro_stack_end_ = remote(reg.end_addr);
 329       }
 330       current_name = nullptr;
 331       continue;
 332     }
 333
 334     if (current_name && strcmp(current_name, pathname)==0)
 335       continue;
 336
 337     current_name = pathname;
 338     if (!(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
 339       continue;
 340
 341     const bool is_executable = not i;
 342     char* libname = nullptr;
 343     if (not is_executable) {
 344       libname = get_lib_name(pathname, &res);
 345       if (not libname)
 346         continue;
 347       if (is_filtered_lib(libname)) {
 348         free(libname);
 349         continue;
 350       }
 351     }
 352
 353     std::shared_ptr<simgrid::mc::ObjectInformation> info =
 354       simgrid::mc::createObjectInformation(this->memory_map_, pathname);
 355     this->object_infos.push_back(info);
 356     if (is_executable)
 357       this->binary_info = info;
 358     else if (libname && is_simgrid_lib(libname))
 359       this->libsimgrid_info = info;
 360     free(libname);
 361   }
 362
 363   regfree(&res.so_re);
 364   regfree(&res.version_re);
 365
 366   // Resolve time (including across different objects):
 367   for (auto const& object_info : this->object_infos)
 368     postProcessObjectInformation(this, object_info.get());
 369
 370   xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
 371   xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
 372
 373   XBT_DEBUG("Get debug information done !");
 374 }
 375
 376 std::shared_ptr<simgrid::mc::ObjectInformation> Process::find_object_info(RemotePtr<void> addr) const
 377 {
 378   for (auto const& object_info : this->object_infos)
 379     if (addr.address() >= (std::uint64_t)object_info->start
 380         && addr.address() <= (std::uint64_t)object_info->end)
 381       return object_info;
 382   return nullptr;
 383 }
 384
 385 std::shared_ptr<ObjectInformation> Process::find_object_info_exec(RemotePtr<void> addr) const
 386 {
 387   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
 388     if (addr.address() >= (std::uint64_t) info->start_exec
 389         && addr.address() <= (std::uint64_t) info->end_exec)
 390       return info;
 391   return nullptr;
 392 }
 393
 394 std::shared_ptr<ObjectInformation> Process::find_object_info_rw(RemotePtr<void> addr) const
 395 {
 396   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
 397     if (addr.address() >= (std::uint64_t)info->start_rw
 398         && addr.address() <= (std::uint64_t)info->end_rw)
 399       return info;
 400   return nullptr;
 401 }
 402
 403 simgrid::mc::Frame* Process::find_function(RemotePtr<void> ip) const
 404 {
 405   std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
 406   return info ? info->find_function((void*) ip.address()) : nullptr;
 407 }
 408
 409 /** Find (one occurrence of) the named variable definition
 410  */
 411 simgrid::mc::Variable* Process::find_variable(const char* name) const
 412 {
 413   // First lookup the variable in the executable shared object.
 414   // A global variable used directly by the executable code from a library
 415   // is reinstanciated in the executable memory .data/.bss.
 416   // We need to look up the variable in the executable first.
 417   if (this->binary_info) {
 418     std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
 419     simgrid::mc::Variable* var = info->find_variable(name);
 420     if (var)
 421       return var;
 422   }
 423
 424   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
 425     simgrid::mc::Variable* var = info->find_variable(name);
 426     if (var)
 427       return var;
 428   }
 429
 430   return nullptr;
 431 }
 432
 433 void Process::read_variable(const char* name, void* target, size_t size) const
 434 {
 435   simgrid::mc::Variable* var = this->find_variable(name);
 436   xbt_assert(var->address, "No simple location for this variable");
 437   xbt_assert(var->type->full_type, "Partial type for %s, cannot check size", name);
 438   xbt_assert((size_t)var->type->full_type->byte_size == size, "Unexpected size for %s (expected %zi, was %zi)", name,
 439              size, (size_t)var->type->full_type->byte_size);
 440   this->read_bytes(target, size, remote(var->address));
 441 }
 442
 443 std::string Process::read_string(RemotePtr<char> address) const
 444 {
 445   if (not address)
 446     return {};
 447
 448   // TODO, use std::vector with .data() in C++17 to avoid useless copies
 449   std::vector<char> res(128);
 450   off_t off = 0;
 451
 452   while (1) {
 453     ssize_t c = pread(this->memory_file, res.data() + off, res.size() - off, (off_t) address.address() + off);
 454     if (c == -1) {
 455       if (errno == EINTR)
 456         continue;
 457       else
 458         xbt_die("Could not read from from remote process");
 459     }
 460     if (c==0)
 461       xbt_die("Could not read string from remote process");
 462
 463     void* p = memchr(res.data() + off, '\0', c);
 464     if (p)
 465       return std::string(res.data());
 466
 467     off += c;
 468     if (off == (off_t) res.size())
 469       res.resize(res.size() * 2);
 470   }
 471 }
 472
 473 const void *Process::read_bytes(void* buffer, std::size_t size,
 474   RemotePtr<void> address, int process_index,
 475   ReadOptions options) const
 476 {
 477   if (process_index != simgrid::mc::ProcessIndexDisabled) {
 478     std::shared_ptr<simgrid::mc::ObjectInformation> const& info =
 479       this->find_object_info_rw((void*)address.address());
 480     // Segment overlap is not handled.
 481 #if HAVE_SMPI
 482     if (info.get() && this->privatized(*info)) {
 483       if (process_index < 0)
 484         xbt_die("Missing process index");
 485       if (process_index >= (int) MC_smpi_process_count())
 486         xbt_die("Invalid process index");
 487
 488       // Read smpi_privatisation_regions from MCed:
 489       smpi_privatisation_region_t remote_smpi_privatisation_regions =
 490         mc_model_checker->process().read_variable<smpi_privatisation_region_t>(
 491           "smpi_privatisation_regions");
 492
 493       s_smpi_privatisation_region_t privatisation_region =
 494         mc_model_checker->process().read<s_smpi_privatisation_region_t>(
 495           remote(remote_smpi_privatisation_regions + process_index));
 496
 497       // Address translation in the privatization segment:
 498       size_t offset = address.address() - (std::uint64_t)info->start_rw;
 499       address = remote((char*)privatisation_region.address + offset);
 500     }
 501 #endif
 502   }
 503   if (pread_whole(this->memory_file, buffer, size, (size_t) address.address()) < 0)
 504     xbt_die("Read at %p from process %lli failed", (void*)address.address(), (long long)this->pid_);
 505   return buffer;
 506 }
 507
 508 /** Write data to a process memory
 509  *
 510  *  @param buffer   local memory address (source)
 511  *  @param len      data size
 512  *  @param address  target process memory address (target)
 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,  (size_t)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::ignore_heap(IgnoredHeapRegion const& region)
 578 {
 579   if (ignored_heap_.empty()) {
 580     ignored_heap_.push_back(std::move(region));
 581     return;
 582   }
 583
 584   typedef std::vector<IgnoredHeapRegion>::size_type size_type;
 585
 586   size_type start = 0;
 587   size_type end = ignored_heap_.size() - 1;
 588
 589   // Binary search the position of insertion:
 590   size_type cursor;
 591   while (start <= end) {
 592     cursor = start + (end - start) / 2;
 593     auto& current_region = ignored_heap_[cursor];
 594     if (current_region.address == region.address)
 595       return;
 596     else if (current_region.address < region.address)
 597       start = cursor + 1;
 598     else if (cursor != 0)
 599       end = cursor - 1;
 600     // Avoid underflow:
 601     else
 602       break;
 603   }
 604
 605   // Insert it mc_heap_ignore_region_t:
 606   if (ignored_heap_[cursor].address < region.address)
 607     ++cursor;
 608   ignored_heap_.insert( ignored_heap_.begin() + cursor, region);
 609 }
 610
 611 void Process::unignore_heap(void *address, size_t size)
 612 {
 613   typedef std::vector<IgnoredHeapRegion>::size_type size_type;
 614
 615   size_type start = 0;
 616   size_type end = ignored_heap_.size() - 1;
 617
 618   // Binary search:
 619   size_type cursor;
 620   while (start <= end) {
 621     cursor = (start + end) / 2;
 622     auto& region = ignored_heap_[cursor];
 623     if (region.address == address) {
 624       ignored_heap_.erase(ignored_heap_.begin() + cursor);
 625       return;
 626     } else if (region.address < address)
 627       start = cursor + 1;
 628     else if ((char *) region.address <= ((char *) address + size)) {
 629       ignored_heap_.erase(ignored_heap_.begin() + cursor);
 630       return;
 631     } else if (cursor != 0)
 632       end = cursor - 1;
 633     // Avoid underflow:
 634     else
 635       break;
 636   }
 637 }
 638
 639 void Process::ignore_local_variable(const char *var_name, const char *frame_name)
 640 {
 641   if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
 642     frame_name = nullptr;
 643   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
 644       this->object_infos)
 645     info->remove_local_variable(var_name, frame_name);
 646 }
 647
 648 std::vector<simgrid::mc::ActorInformation>& Process::actors()
 649 {
 650   this->refresh_simix();
 651   return smx_actors_infos;
 652 }
 653
 654 std::vector<simgrid::mc::ActorInformation>& Process::dead_actors()
 655 {
 656   this->refresh_simix();
 657   return smx_dead_actors_infos;
 658 }
 659
 660 void Process::dumpStack()
 661 {
 662   unw_addr_space_t as = unw_create_addr_space(&_UPT_accessors, BYTE_ORDER);
 663   if (as == nullptr) {
 664     XBT_ERROR("Could not initialize ptrace address space");
 665     return;
 666   }
 667
 668   void* context = _UPT_create(this->pid_);
 669   if (context == nullptr) {
 670     unw_destroy_addr_space(as);
 671     XBT_ERROR("Could not initialize ptrace context");
 672     return;
 673   }
 674
 675   unw_cursor_t cursor;
 676   if (unw_init_remote(&cursor, as, context) != 0) {
 677     _UPT_destroy(context);
 678     unw_destroy_addr_space(as);
 679     XBT_ERROR("Could not initialiez ptrace cursor");
 680     return;
 681   }
 682
 683   simgrid::mc::dumpStack(stderr, cursor);
 684
 685   _UPT_destroy(context);
 686   unw_destroy_addr_space(as);
 687   return;
 688 }
 689
 690 }
 691 }