src/mc/sosp/RemoteProcessMemory.cpp

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