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