1 /* Copyright (c) 2014-2020. The SimGrid Team. All rights reserved. */
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. */
6 #define _FILE_OFFSET_BITS 64 /* needed for pread_whole to work as expected on 32bits */
8 #include "src/mc/remote/RemoteSimulation.hpp"
10 #include "src/mc/mc_smx.hpp"
11 #include "src/mc/sosp/Snapshot.hpp"
12 #include "xbt/file.hpp"
16 #include <libunwind-ptrace.h>
17 #include <sys/mman.h> // PROT_*
21 using simgrid::mc::remote;
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_process, mc, "MC process information");
30 // List of library which memory segments are not considered:
31 static const std::vector<std::string> filtered_libraries = {
34 #elif defined __FreeBSD__
37 "libkvm", /* kernel data access library */
38 "libprocstat", /* process and file information retrieval */
39 "libthr", /* thread library */
42 "libargp", /* workarounds for glibc-less systems */
43 "libasan", /* gcc sanitizers */
46 "libboost_context-mt",
47 "libboost_stacktrace_addr2line",
48 "libboost_stacktrace_backtrace",
83 "libkrb5support", /*odd behaviour on fedora rawhide ... remove these when fixed*/
109 "libtsan", /* gcc sanitizers */
110 "libubsan", /* gcc sanitizers */
119 static bool is_simgrid_lib(const std::string& libname)
121 return libname == "libsimgrid";
124 static bool is_filtered_lib(const std::string& libname)
126 return std::find(begin(filtered_libraries), end(filtered_libraries), libname) != end(filtered_libraries);
129 static std::string get_lib_name(const std::string& pathname)
131 std::string map_basename = simgrid::xbt::Path(pathname).get_base_name();
134 size_t pos = map_basename.rfind(".so");
135 if (pos != std::string::npos) {
136 // strip the extension (matching regex "\.so.*$")
137 libname.assign(map_basename, 0, pos);
139 // strip the version suffix (matching regex "-[.0-9-]*$")
141 pos = libname.rfind('-');
142 if (pos == std::string::npos || libname.find_first_not_of(".0123456789", pos + 1) != std::string::npos)
151 static ssize_t pread_whole(int fd, void* buf, size_t count, off_t offset)
153 auto* buffer = static_cast<char*>(buf);
154 ssize_t real_count = count;
156 ssize_t res = pread(fd, buffer, count, offset);
163 else if (errno != EINTR) {
164 perror("pread_whole");
171 static ssize_t pwrite_whole(int fd, const void* buf, size_t count, off_t offset)
173 const auto* buffer = static_cast<const char*>(buf);
174 ssize_t real_count = count;
176 ssize_t res = pwrite(fd, buffer, count, offset);
183 else if (errno != EINTR)
189 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
190 static const void* zero_buffer;
191 static const size_t zero_buffer_size = 10 * 4096;
193 static void zero_buffer_init()
195 int fd = open("/dev/zero", O_RDONLY);
197 xbt_die("Could not open /dev/zero");
198 zero_buffer = mmap(nullptr, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
199 if (zero_buffer == MAP_FAILED)
200 xbt_die("Could not map the zero buffer");
204 int open_vm(pid_t pid, int flags)
206 const size_t buffer_size = 30;
207 char buffer[buffer_size];
208 int res = snprintf(buffer, buffer_size, "/proc/%lli/mem", (long long)pid);
209 if (res < 0 || (size_t)res >= buffer_size) {
210 errno = ENAMETOOLONG;
213 return open(buffer, flags);
216 // ***** RemoteSimulation
218 RemoteSimulation::RemoteSimulation(pid_t pid) : AddressSpace(this), pid_(pid), running_(true) {}
220 void RemoteSimulation::init()
222 this->memory_map_ = simgrid::xbt::get_memory_map(this->pid_);
223 this->init_memory_map_info();
225 int fd = open_vm(this->pid_, O_RDWR);
226 xbt_assert(fd >= 0, "Could not open file for process virtual address space");
227 this->memory_file = fd;
229 // Read std_heap (is a struct mdesc*):
230 const simgrid::mc::Variable* std_heap_var = this->find_variable("__mmalloc_default_mdp");
231 xbt_assert(std_heap_var, "No heap information in the target process");
232 xbt_assert(std_heap_var->address, "No constant address for this variable");
233 this->read_bytes(&this->heap_address, sizeof(mdesc*), remote(std_heap_var->address));
235 this->smx_actors_infos.clear();
236 this->smx_dead_actors_infos.clear();
237 this->unw_addr_space = simgrid::mc::UnwindContext::createUnwindAddressSpace();
238 this->unw_underlying_addr_space = simgrid::unw::create_addr_space();
239 this->unw_underlying_context = simgrid::unw::create_context(this->unw_underlying_addr_space, this->pid_);
242 RemoteSimulation::~RemoteSimulation()
244 if (this->memory_file >= 0)
245 close(this->memory_file);
247 if (this->unw_underlying_addr_space != unw_local_addr_space) {
248 if (this->unw_underlying_addr_space)
249 unw_destroy_addr_space(this->unw_underlying_addr_space);
250 if (this->unw_underlying_context)
251 _UPT_destroy(this->unw_underlying_context);
254 unw_destroy_addr_space(this->unw_addr_space);
257 /** Refresh the information about the process
259 * Do not use directly, this is used by the getters when appropriate
260 * in order to have fresh data.
262 void RemoteSimulation::refresh_heap()
264 // Read/dereference/refresh the std_heap pointer:
266 this->heap = std::make_unique<s_xbt_mheap_t>();
267 this->read_bytes(this->heap.get(), sizeof(mdesc), remote(this->heap_address));
268 this->cache_flags_ |= RemoteSimulation::cache_heap;
271 /** Refresh the information about the process
273 * Do not use directly, this is used by the getters when appropriate
274 * in order to have fresh data.
276 void RemoteSimulation::refresh_malloc_info()
278 // Refresh process->heapinfo:
279 if (this->cache_flags_ & RemoteSimulation::cache_malloc)
281 size_t count = this->heap->heaplimit + 1;
282 if (this->heap_info.size() < count)
283 this->heap_info.resize(count);
284 this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info), remote(this->heap->heapinfo));
285 this->cache_flags_ |= RemoteSimulation::cache_malloc;
288 /** @brief Finds the range of the different memory segments and binary paths */
289 void RemoteSimulation::init_memory_map_info()
291 XBT_DEBUG("Get debug information ...");
292 this->maestro_stack_start_ = nullptr;
293 this->maestro_stack_end_ = nullptr;
294 this->object_infos.resize(0);
295 this->binary_info = nullptr;
296 this->libsimgrid_info = nullptr;
298 std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
300 const char* current_name = nullptr;
302 this->object_infos.clear();
304 for (size_t i = 0; i < maps.size(); i++) {
305 simgrid::xbt::VmMap const& reg = maps[i];
306 const char* pathname = maps[i].pathname.c_str();
309 if (maps[i].pathname.empty()) {
310 current_name = nullptr;
314 // [stack], [vvar], [vsyscall], [vdso] ...
315 if (pathname[0] == '[') {
316 if ((reg.prot & PROT_WRITE) && not memcmp(pathname, "[stack]", 7)) {
317 this->maestro_stack_start_ = remote(reg.start_addr);
318 this->maestro_stack_end_ = remote(reg.end_addr);
320 current_name = nullptr;
324 if (current_name && strcmp(current_name, pathname) == 0)
327 current_name = pathname;
328 if (not(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
331 const bool is_executable = not i;
333 if (not is_executable) {
334 libname = get_lib_name(pathname);
335 if (is_filtered_lib(libname)) {
340 std::shared_ptr<simgrid::mc::ObjectInformation> info =
341 simgrid::mc::createObjectInformation(this->memory_map_, pathname);
342 this->object_infos.push_back(info);
344 this->binary_info = info;
345 else if (is_simgrid_lib(libname))
346 this->libsimgrid_info = info;
349 // Resolve time (including across different objects):
350 for (auto const& object_info : this->object_infos)
351 postProcessObjectInformation(this, object_info.get());
353 xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
354 xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
356 XBT_DEBUG("Get debug information done !");
359 std::shared_ptr<simgrid::mc::ObjectInformation> RemoteSimulation::find_object_info(RemotePtr<void> addr) const
361 for (auto const& object_info : this->object_infos)
362 if (addr.address() >= (std::uint64_t)object_info->start && addr.address() <= (std::uint64_t)object_info->end)
367 std::shared_ptr<ObjectInformation> RemoteSimulation::find_object_info_exec(RemotePtr<void> addr) const
369 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
370 if (addr.address() >= (std::uint64_t)info->start_exec && addr.address() <= (std::uint64_t)info->end_exec)
375 std::shared_ptr<ObjectInformation> RemoteSimulation::find_object_info_rw(RemotePtr<void> addr) const
377 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
378 if (addr.address() >= (std::uint64_t)info->start_rw && addr.address() <= (std::uint64_t)info->end_rw)
383 simgrid::mc::Frame* RemoteSimulation::find_function(RemotePtr<void> ip) const
385 std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
386 return info ? info->find_function((void*)ip.address()) : nullptr;
389 /** Find (one occurrence of) the named variable definition
391 const simgrid::mc::Variable* RemoteSimulation::find_variable(const char* name) const
393 // First lookup the variable in the executable shared object.
394 // A global variable used directly by the executable code from a library
395 // is reinstantiated in the executable memory .data/.bss.
396 // We need to look up the variable in the executable first.
397 if (this->binary_info) {
398 std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
399 const simgrid::mc::Variable* var = info->find_variable(name);
404 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
405 const simgrid::mc::Variable* var = info->find_variable(name);
413 void RemoteSimulation::read_variable(const char* name, void* target, size_t size) const
415 const simgrid::mc::Variable* var = this->find_variable(name);
416 xbt_assert(var, "Variable %s not found", name);
417 xbt_assert(var->address, "No simple location for this variable");
418 xbt_assert(var->type->full_type, "Partial type for %s, cannot check size", name);
419 xbt_assert((size_t)var->type->full_type->byte_size == size, "Unexpected size for %s (expected %zu, was %zu)", name,
420 size, (size_t)var->type->full_type->byte_size);
421 this->read_bytes(target, size, remote(var->address));
424 std::string RemoteSimulation::read_string(RemotePtr<char> address) const
429 std::vector<char> res(128);
433 ssize_t c = pread(this->memory_file, res.data() + off, res.size() - off, (off_t)address.address() + off);
434 if (c == -1 && errno == EINTR)
436 xbt_assert(c > 0, "Could not read string from remote process");
438 const void* p = memchr(res.data() + off, '\0', c);
440 return std::string(res.data());
443 if (off == (off_t)res.size())
444 res.resize(res.size() * 2);
448 void* RemoteSimulation::read_bytes(void* buffer, std::size_t size, RemotePtr<void> address,
449 ReadOptions /*options*/) const
451 if (pread_whole(this->memory_file, buffer, size, (size_t)address.address()) < 0)
452 xbt_die("Read at %p from process %lli failed", (void*)address.address(), (long long)this->pid_);
456 /** Write data to a process memory
458 * @param buffer local memory address (source)
459 * @param len data size
460 * @param address target process memory address (target)
462 void RemoteSimulation::write_bytes(const void* buffer, size_t len, RemotePtr<void> address) const
464 if (pwrite_whole(this->memory_file, buffer, len, (size_t)address.address()) < 0)
465 xbt_die("Write to process %lli failed", (long long)this->pid_);
468 void RemoteSimulation::clear_bytes(RemotePtr<void> address, size_t len) const
470 pthread_once(&zero_buffer_flag, zero_buffer_init);
472 size_t s = len > zero_buffer_size ? zero_buffer_size : len;
473 this->write_bytes(zero_buffer, s, address);
474 address = remote((char*)address.address() + s);
479 void RemoteSimulation::ignore_region(std::uint64_t addr, std::size_t size)
481 IgnoredRegion region;
485 if (ignored_regions_.empty()) {
486 ignored_regions_.push_back(region);
490 unsigned int cursor = 0;
491 const IgnoredRegion* current_region = nullptr;
494 int end = ignored_regions_.size() - 1;
495 while (start <= end) {
496 cursor = (start + end) / 2;
497 current_region = &ignored_regions_[cursor];
498 if (current_region->addr == addr) {
499 if (current_region->size == size)
501 else if (current_region->size < size)
505 } else if (current_region->addr < addr)
511 std::size_t position;
512 if (current_region->addr == addr) {
513 if (current_region->size < size)
514 position = cursor + 1;
517 } else if (current_region->addr < addr)
518 position = cursor + 1;
521 ignored_regions_.insert(ignored_regions_.begin() + position, region);
524 void RemoteSimulation::ignore_heap(IgnoredHeapRegion const& region)
526 if (ignored_heap_.empty()) {
527 ignored_heap_.push_back(std::move(region));
531 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
534 size_type end = ignored_heap_.size() - 1;
536 // Binary search the position of insertion:
538 while (start <= end) {
539 cursor = start + (end - start) / 2;
540 auto const& current_region = ignored_heap_[cursor];
541 if (current_region.address == region.address)
543 else if (current_region.address < region.address)
545 else if (cursor != 0)
552 // Insert it mc_heap_ignore_region_t:
553 if (ignored_heap_[cursor].address < region.address)
555 ignored_heap_.insert(ignored_heap_.begin() + cursor, region);
558 void RemoteSimulation::unignore_heap(void* address, size_t size)
560 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
563 size_type end = ignored_heap_.size() - 1;
567 while (start <= end) {
568 cursor = (start + end) / 2;
569 auto const& region = ignored_heap_[cursor];
570 if (region.address < address)
572 else if ((char*)region.address <= ((char*)address + size)) {
573 ignored_heap_.erase(ignored_heap_.begin() + cursor);
575 } else if (cursor != 0)
583 void RemoteSimulation::ignore_local_variable(const char* var_name, const char* frame_name) const
585 if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
586 frame_name = nullptr;
587 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos)
588 info->remove_local_variable(var_name, frame_name);
591 std::vector<simgrid::mc::ActorInformation>& RemoteSimulation::actors()
593 this->refresh_simix();
594 return smx_actors_infos;
597 std::vector<simgrid::mc::ActorInformation>& RemoteSimulation::dead_actors()
599 this->refresh_simix();
600 return smx_dead_actors_infos;
603 void RemoteSimulation::dump_stack() const
605 unw_addr_space_t as = unw_create_addr_space(&_UPT_accessors, BYTE_ORDER);
607 XBT_ERROR("Could not initialize ptrace address space");
611 void* context = _UPT_create(this->pid_);
612 if (context == nullptr) {
613 unw_destroy_addr_space(as);
614 XBT_ERROR("Could not initialize ptrace context");
619 if (unw_init_remote(&cursor, as, context) != 0) {
620 _UPT_destroy(context);
621 unw_destroy_addr_space(as);
622 XBT_ERROR("Could not initialiez ptrace cursor");
626 simgrid::mc::dumpStack(stderr, &cursor);
628 _UPT_destroy(context);
629 unw_destroy_addr_space(as);
632 } // namespace simgrid