src/mc/remote/RemoteProcess.cpp

   1 /* Copyright (c) 2014-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #define _FILE_OFFSET_BITS 64 /* needed for pread_whole to work as expected on 32bits */
   7
   8 #include "src/mc/remote/RemoteProcess.hpp"
   9
  10 #include "src/mc/sosp/Snapshot.hpp"
  11 #include "xbt/file.hpp"
  12 #include "xbt/log.h"
  13
  14 #include <fcntl.h>
  15 #include <libunwind-ptrace.h>
  16 #include <sys/mman.h> // PROT_*
  17
  18 #include <algorithm>
  19 #include <cerrno>
  20 #include <cstring>
  21 #include <memory>
  22 #include <mutex>
  23 #include <string>
  24
  25 using simgrid::mc::remote;
  26
  27 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_process, mc, "MC process information");
  28
  29 namespace simgrid {
  30 namespace mc {
  31
  32 // ***** Helper stuff
  33
  34 static bool is_filtered_lib(const std::string& libname)
  35 {
  36   return libname != "libsimgrid";
  37 }
  38
  39 static std::string get_lib_name(const std::string& pathname)
  40 {
  41   std::string map_basename = simgrid::xbt::Path(pathname).get_base_name();
  42   std::string libname;
  43
  44   size_t pos = map_basename.rfind(".so");
  45   if (pos != std::string::npos) {
  46     // strip the extension (matching regex "\.so.*$")
  47     libname.assign(map_basename, 0, pos);
  48
  49     // strip the version suffix (matching regex "-[.0-9-]*$")
  50     while (true) {
  51       pos = libname.rfind('-');
  52       if (pos == std::string::npos || libname.find_first_not_of(".0123456789", pos + 1) != std::string::npos)
  53         break;
  54       libname.erase(pos);
  55     }
  56   }
  57
  58   return libname;
  59 }
  60
  61 static ssize_t pread_whole(int fd, void* buf, size_t count, off_t offset)
  62 {
  63   auto* buffer       = static_cast<char*>(buf);
  64   ssize_t real_count = count;
  65   while (count) {
  66     ssize_t res = pread(fd, buffer, count, offset);
  67     if (res > 0) {
  68       count -= res;
  69       buffer += res;
  70       offset += res;
  71     } else if (res == 0)
  72       return -1;
  73     else if (errno != EINTR) {
  74       XBT_ERROR("pread_whole: %s", strerror(errno));
  75       return -1;
  76     }
  77   }
  78   return real_count;
  79 }
  80
  81 static ssize_t pwrite_whole(int fd, const void* buf, size_t count, off_t offset)
  82 {
  83   const auto* buffer = static_cast<const char*>(buf);
  84   ssize_t real_count = count;
  85   while (count) {
  86     ssize_t res = pwrite(fd, buffer, count, offset);
  87     if (res > 0) {
  88       count -= res;
  89       buffer += res;
  90       offset += res;
  91     } else if (res == 0)
  92       return -1;
  93     else if (errno != EINTR) {
  94       XBT_ERROR("pwrite_whole: %s", strerror(errno));
  95       return -1;
  96     }
  97   }
  98   return real_count;
  99 }
 100
 101 int open_vm(pid_t pid, int flags)
 102 {
 103   std::string buffer = "/proc/" + std::to_string(pid) + "/mem";
 104   return open(buffer.c_str(), flags);
 105 }
 106
 107 // ***** RemoteProcess
 108
 109 RemoteProcess::RemoteProcess(pid_t pid) : AddressSpace(this), pid_(pid), running_(true) {}
 110
 111 void RemoteProcess::init(xbt_mheap_t mmalloc_default_mdp, unsigned long* maxpid, xbt_dynar_t actors,
 112                          xbt_dynar_t dead_actors)
 113 {
 114   this->heap_address      = remote(mmalloc_default_mdp);
 115   this->maxpid_addr_      = remote(maxpid);
 116   this->actors_addr_      = remote(actors);
 117   this->dead_actors_addr_ = remote(dead_actors);
 118
 119   this->memory_map_ = simgrid::xbt::get_memory_map(this->pid_);
 120   this->init_memory_map_info();
 121
 122   int fd = open_vm(this->pid_, O_RDWR);
 123   xbt_assert(fd >= 0, "Could not open file for process virtual address space");
 124   this->memory_file = fd;
 125
 126   this->smx_actors_infos.clear();
 127   this->smx_dead_actors_infos.clear();
 128   this->unw_addr_space            = simgrid::mc::UnwindContext::createUnwindAddressSpace();
 129   this->unw_underlying_addr_space = simgrid::unw::create_addr_space();
 130   this->unw_underlying_context    = simgrid::unw::create_context(this->unw_underlying_addr_space, this->pid_);
 131 }
 132
 133 RemoteProcess::~RemoteProcess()
 134 {
 135   if (this->memory_file >= 0)
 136     close(this->memory_file);
 137
 138   if (this->unw_underlying_addr_space != unw_local_addr_space) {
 139     if (this->unw_underlying_addr_space)
 140       unw_destroy_addr_space(this->unw_underlying_addr_space);
 141     if (this->unw_underlying_context)
 142       _UPT_destroy(this->unw_underlying_context);
 143   }
 144
 145   unw_destroy_addr_space(this->unw_addr_space);
 146 }
 147
 148 /** Refresh the information about the process
 149  *
 150  *  Do not use directly, this is used by the getters when appropriate
 151  *  in order to have fresh data.
 152  */
 153 void RemoteProcess::refresh_heap()
 154 {
 155   // Read/dereference/refresh the std_heap pointer:
 156   if (not this->heap)
 157     this->heap = std::make_unique<s_xbt_mheap_t>();
 158   this->read(this->heap.get(), this->heap_address);
 159   this->cache_flags_ |= RemoteProcess::cache_heap;
 160 }
 161
 162 /** Refresh the information about the process
 163  *
 164  *  Do not use directly, this is used by the getters when appropriate
 165  *  in order to have fresh data.
 166  * */
 167 void RemoteProcess::refresh_malloc_info()
 168 {
 169   // Refresh process->heapinfo:
 170   if (this->cache_flags_ & RemoteProcess::cache_malloc)
 171     return;
 172   size_t count = this->heap->heaplimit + 1;
 173   if (this->heap_info.size() < count)
 174     this->heap_info.resize(count);
 175   this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info), remote(this->heap->heapinfo));
 176   this->cache_flags_ |= RemoteProcess::cache_malloc;
 177 }
 178
 179 /** @brief Finds the range of the different memory segments and binary paths */
 180 void RemoteProcess::init_memory_map_info()
 181 {
 182   XBT_DEBUG("Get debug information ...");
 183   this->maestro_stack_start_ = nullptr;
 184   this->maestro_stack_end_   = nullptr;
 185   this->object_infos.clear();
 186   this->binary_info = nullptr;
 187
 188   std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
 189
 190   const char* current_name = nullptr;
 191
 192   for (size_t i = 0; i < maps.size(); i++) {
 193     simgrid::xbt::VmMap const& reg = maps[i];
 194     const char* pathname           = maps[i].pathname.c_str();
 195
 196     // Nothing to do
 197     if (maps[i].pathname.empty()) {
 198       current_name = nullptr;
 199       continue;
 200     }
 201
 202     // [stack], [vvar], [vsyscall], [vdso] ...
 203     if (pathname[0] == '[') {
 204       if ((reg.prot & PROT_WRITE) && not memcmp(pathname, "[stack]", 7)) {
 205         this->maestro_stack_start_ = remote(reg.start_addr);
 206         this->maestro_stack_end_   = remote(reg.end_addr);
 207       }
 208       current_name = nullptr;
 209       continue;
 210     }
 211
 212     if (current_name && strcmp(current_name, pathname) == 0)
 213       continue;
 214
 215     current_name = pathname;
 216     if (not(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
 217       continue;
 218
 219     const bool is_executable = not i;
 220     std::string libname;
 221     if (not is_executable) {
 222       libname = get_lib_name(pathname);
 223       if (is_filtered_lib(libname)) {
 224         continue;
 225       }
 226     }
 227
 228     std::shared_ptr<simgrid::mc::ObjectInformation> info =
 229         simgrid::mc::createObjectInformation(this->memory_map_, pathname);
 230     this->object_infos.push_back(info);
 231     if (is_executable)
 232       this->binary_info = info;
 233   }
 234
 235   xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
 236   xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
 237
 238   XBT_DEBUG("Get debug information done !");
 239 }
 240
 241 std::shared_ptr<simgrid::mc::ObjectInformation> RemoteProcess::find_object_info(RemotePtr<void> addr) const
 242 {
 243   for (auto const& object_info : this->object_infos)
 244     if (addr.address() >= (std::uint64_t)object_info->start && addr.address() <= (std::uint64_t)object_info->end)
 245       return object_info;
 246   return nullptr;
 247 }
 248
 249 std::shared_ptr<ObjectInformation> RemoteProcess::find_object_info_exec(RemotePtr<void> addr) const
 250 {
 251   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
 252     if (addr.address() >= (std::uint64_t)info->start_exec && addr.address() <= (std::uint64_t)info->end_exec)
 253       return info;
 254   return nullptr;
 255 }
 256
 257 std::shared_ptr<ObjectInformation> RemoteProcess::find_object_info_rw(RemotePtr<void> addr) const
 258 {
 259   for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
 260     if (addr.address() >= (std::uint64_t)info->start_rw && addr.address() <= (std::uint64_t)info->end_rw)
 261       return info;
 262   return nullptr;
 263 }
 264
 265 simgrid::mc::Frame* RemoteProcess::find_function(RemotePtr<void> ip) const
 266 {
 267   std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
 268   return info ? info->find_function((void*)ip.address()) : nullptr;
 269 }
 270
 271 /** Find (one occurrence of) the named variable definition
 272  */
 273 const simgrid::mc::Variable* RemoteProcess::find_variable(const char* name) const
 274 {
 275   // First lookup the variable in the executable shared object.
 276   // A global variable used directly by the executable code from a library
 277   // is reinstantiated in the executable memory .data/.bss.
 278   // We need to look up the variable in the executable first.
 279   if (this->binary_info) {
 280     std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
 281     const simgrid::mc::Variable* var                            = info->find_variable(name);
 282     if (var)
 283       return var;
 284   }
 285
 286   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
 287     const simgrid::mc::Variable* var = info->find_variable(name);
 288     if (var)
 289       return var;
 290   }
 291
 292   return nullptr;
 293 }
 294
 295 void RemoteProcess::read_variable(const char* name, void* target, size_t size) const
 296 {
 297   const simgrid::mc::Variable* var = this->find_variable(name);
 298   xbt_assert(var, "Variable %s not found", name);
 299   xbt_assert(var->address, "No simple location for this variable");
 300
 301   if (not var->type->full_type) // Try to resolve this type. The needed ObjectInfo was maybe (lazily) loaded recently
 302     for (auto const& object_info : this->object_infos)
 303       postProcessObjectInformation(this, object_info.get());
 304   xbt_assert(var->type->full_type, "Partial type for %s (even after re-resolving types), cannot retrieve its size.",
 305              name);
 306   xbt_assert((size_t)var->type->full_type->byte_size == size, "Unexpected size for %s (expected %zu, received %zu).",
 307              name, size, (size_t)var->type->full_type->byte_size);
 308   this->read_bytes(target, size, remote(var->address));
 309 }
 310
 311 std::string RemoteProcess::read_string(RemotePtr<char> address) const
 312 {
 313   if (not address)
 314     return {};
 315
 316   std::vector<char> res(128);
 317   off_t off = 0;
 318
 319   while (true) {
 320     ssize_t c = pread(this->memory_file, res.data() + off, res.size() - off, (off_t)address.address() + off);
 321     if (c == -1 && errno == EINTR)
 322       continue;
 323     xbt_assert(c > 0, "Could not read string from remote process");
 324
 325     const void* p = memchr(res.data() + off, '\0', c);
 326     if (p)
 327       return std::string(res.data());
 328
 329     off += c;
 330     if (off == (off_t)res.size())
 331       res.resize(res.size() * 2);
 332   }
 333 }
 334
 335 void* RemoteProcess::read_bytes(void* buffer, std::size_t size, RemotePtr<void> address, ReadOptions /*options*/) const
 336 {
 337   xbt_assert(pread_whole(this->memory_file, buffer, size, (size_t)address.address()) != -1,
 338              "Read at %p from process %lli failed", (void*)address.address(), (long long)this->pid_);
 339   return buffer;
 340 }
 341
 342 /** Write data to a process memory
 343  *
 344  *  @param buffer   local memory address (source)
 345  *  @param len      data size
 346  *  @param address  target process memory address (target)
 347  */
 348 void RemoteProcess::write_bytes(const void* buffer, size_t len, RemotePtr<void> address) const
 349 {
 350   xbt_assert(pwrite_whole(this->memory_file, buffer, len, (size_t)address.address()) != -1,
 351              "Write to process %lli failed", (long long)this->pid_);
 352 }
 353
 354 static void zero_buffer_init(const void** zero_buffer, size_t zero_buffer_size)
 355 {
 356   int fd = open("/dev/zero", O_RDONLY);
 357   xbt_assert(fd >= 0, "Could not open /dev/zero");
 358   *zero_buffer = mmap(nullptr, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
 359   xbt_assert(*zero_buffer != MAP_FAILED, "Could not map the zero buffer");
 360   close(fd);
 361 }
 362
 363 void RemoteProcess::clear_bytes(RemotePtr<void> address, size_t len) const
 364 {
 365   static constexpr size_t zero_buffer_size = 10 * 4096;
 366   static const void* zero_buffer;
 367   static std::once_flag zero_buffer_flag;
 368
 369   std::call_once(zero_buffer_flag, zero_buffer_init, &zero_buffer, zero_buffer_size);
 370   while (len) {
 371     size_t s = len > zero_buffer_size ? zero_buffer_size : len;
 372     this->write_bytes(zero_buffer, s, address);
 373     address = remote((char*)address.address() + s);
 374     len -= s;
 375   }
 376 }
 377
 378 void RemoteProcess::ignore_region(std::uint64_t addr, std::size_t size)
 379 {
 380   IgnoredRegion region;
 381   region.addr = addr;
 382   region.size = size;
 383
 384   auto pos = std::lower_bound(ignored_regions_.begin(), ignored_regions_.end(), region,
 385                               [](auto const& reg1, auto const& reg2) {
 386                                 return reg1.addr < reg2.addr || (reg1.addr == reg2.addr && reg1.size < reg2.size);
 387                               });
 388   if (pos == ignored_regions_.end() || pos->addr != addr || pos->size != size)
 389     ignored_regions_.insert(pos, region);
 390 }
 391
 392 void RemoteProcess::ignore_heap(IgnoredHeapRegion const& region)
 393 {
 394   // Binary search the position of insertion:
 395   auto pos = std::lower_bound(ignored_heap_.begin(), ignored_heap_.end(), region.address,
 396                               [](auto const& reg, auto const* addr) { return reg.address < addr; });
 397   if (pos == ignored_heap_.end() || pos->address != region.address) {
 398     // Insert it:
 399     ignored_heap_.insert(pos, region);
 400   }
 401 }
 402
 403 void RemoteProcess::unignore_heap(void* address, size_t size)
 404 {
 405   // Binary search:
 406   auto pos = std::lower_bound(ignored_heap_.begin(), ignored_heap_.end(), address,
 407                               [](auto const& reg, auto const* addr) { return reg.address < addr; });
 408   if (pos != ignored_heap_.end() && static_cast<char*>(pos->address) <= static_cast<char*>(address) + size)
 409     ignored_heap_.erase(pos);
 410 }
 411
 412 void RemoteProcess::ignore_local_variable(const char* var_name, const char* frame_name) const
 413 {
 414   if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
 415     frame_name = nullptr;
 416   for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos)
 417     info->remove_local_variable(var_name, frame_name);
 418 }
 419
 420 std::vector<simgrid::mc::ActorInformation>& RemoteProcess::actors()
 421 {
 422   this->refresh_simix();
 423   return smx_actors_infos;
 424 }
 425
 426 std::vector<simgrid::mc::ActorInformation>& RemoteProcess::dead_actors()
 427 {
 428   this->refresh_simix();
 429   return smx_dead_actors_infos;
 430 }
 431
 432 void RemoteProcess::dump_stack() const
 433 {
 434   unw_addr_space_t as = unw_create_addr_space(&_UPT_accessors, BYTE_ORDER);
 435   if (as == nullptr) {
 436     XBT_ERROR("Could not initialize ptrace address space");
 437     return;
 438   }
 439
 440   void* context = _UPT_create(this->pid_);
 441   if (context == nullptr) {
 442     unw_destroy_addr_space(as);
 443     XBT_ERROR("Could not initialize ptrace context");
 444     return;
 445   }
 446
 447   unw_cursor_t cursor;
 448   if (unw_init_remote(&cursor, as, context) != 0) {
 449     _UPT_destroy(context);
 450     unw_destroy_addr_space(as);
 451     XBT_ERROR("Could not initialize ptrace cursor");
 452     return;
 453   }
 454
 455   simgrid::mc::dumpStack(stderr, &cursor);
 456
 457   _UPT_destroy(context);
 458   unw_destroy_addr_space(as);
 459 }
 460 } // namespace mc
 461 } // namespace simgrid