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