1 /* Copyright (c) 2014-2018. 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 */
16 #include <sys/ptrace.h>
21 #include <sys/mman.h> // PROT_*
22 #include <sys/types.h>
29 #include <libunwind-ptrace.h>
30 #include <libunwind.h>
33 #include "xbt/file.hpp"
35 #include <xbt/mmalloc.h>
37 #include "src/mc/mc_smx.hpp"
38 #include "src/mc/mc_unw.hpp"
39 #include "src/mc/sosp/mc_snapshot.hpp"
41 #include "src/mc/AddressSpace.hpp"
42 #include "src/mc/ObjectInformation.hpp"
43 #include "src/mc/Variable.hpp"
44 #include "src/mc/remote/RemoteClient.hpp"
46 using simgrid::mc::remote;
48 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_process, mc, "MC process information");
55 // List of library which memory segments are not considered:
56 static const std::vector<std::string> filtered_libraries = {
59 #elif defined __FreeBSD__
62 "libkvm", /* kernel data access library */
63 "libprocstat", /* process and file information retrieval */
64 "libthr", /* thread library */
67 "libargp", /* workarounds for glibc-less systems */
68 "libasan", /* gcc sanitizers */
71 "libboost_context-mt",
72 "libboost_stacktrace_backtrace",
76 "libboost_unit_test_framework",
108 "libtsan", /* gcc sanitizers */
109 "libubsan", /* gcc sanitizers */
116 static bool is_simgrid_lib(const std::string& libname)
118 return libname == "libsimgrid";
121 static bool is_filtered_lib(const std::string& libname)
123 return std::find(begin(filtered_libraries), end(filtered_libraries), libname) != end(filtered_libraries);
126 static std::string get_lib_name(const std::string& pathname)
128 std::string map_basename = simgrid::xbt::Path(pathname).get_base_name();
131 size_t pos = map_basename.rfind(".so");
132 if (pos != std::string::npos) {
133 // strip the extension (matching regex "\.so.*$")
134 libname.assign(map_basename, 0, pos);
136 // strip the version suffix (matching regex "-[.0-9-]*$")
138 pos = libname.rfind('-');
139 if (pos == std::string::npos || libname.find_first_not_of(".0123456789", pos + 1) != std::string::npos)
148 static ssize_t pread_whole(int fd, void* buf, size_t count, off_t offset)
150 char* buffer = (char*)buf;
151 ssize_t real_count = count;
153 ssize_t res = pread(fd, buffer, count, offset);
160 else if (errno != EINTR) {
161 perror("pread_whole");
168 static ssize_t pwrite_whole(int fd, const void* buf, size_t count, off_t offset)
170 const char* buffer = (const char*)buf;
171 ssize_t real_count = count;
173 ssize_t res = pwrite(fd, buffer, count, offset);
180 else if (errno != EINTR)
186 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
187 static const void* zero_buffer;
188 static const size_t zero_buffer_size = 10 * 4096;
190 static void zero_buffer_init()
192 int fd = open("/dev/zero", O_RDONLY);
194 xbt_die("Could not open /dev/zero");
195 zero_buffer = mmap(nullptr, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
196 if (zero_buffer == MAP_FAILED)
197 xbt_die("Could not map the zero buffer");
201 int open_vm(pid_t pid, int flags)
203 const size_t buffer_size = 30;
204 char buffer[buffer_size];
205 int res = snprintf(buffer, buffer_size, "/proc/%lli/mem", (long long)pid);
206 if (res < 0 || (size_t)res >= buffer_size) {
207 errno = ENAMETOOLONG;
210 return open(buffer, flags);
215 RemoteClient::RemoteClient(pid_t pid, int sockfd) : AddressSpace(this), pid_(pid), channel_(sockfd), running_(true)
219 void RemoteClient::init()
221 this->memory_map_ = simgrid::xbt::get_memory_map(this->pid_);
222 this->init_memory_map_info();
224 int fd = open_vm(this->pid_, O_RDWR);
226 xbt_die("Could not open file for process virtual address space");
227 this->memory_file = fd;
229 // Read std_heap (is a struct mdesc*):
230 simgrid::mc::Variable* std_heap_var = this->find_variable("__mmalloc_default_mdp");
231 if (not std_heap_var)
232 xbt_die("No heap information in the target process");
233 if (not std_heap_var->address)
234 xbt_die("No constant address for this variable");
235 this->read_bytes(&this->heap_address, sizeof(mdesc*), remote(std_heap_var->address),
236 simgrid::mc::ProcessIndexDisabled);
238 this->smx_actors_infos.clear();
239 this->smx_dead_actors_infos.clear();
240 this->unw_addr_space = simgrid::mc::UnwindContext::createUnwindAddressSpace();
241 this->unw_underlying_addr_space = simgrid::unw::create_addr_space();
242 this->unw_underlying_context = simgrid::unw::create_context(this->unw_underlying_addr_space, this->pid_);
245 RemoteClient::~RemoteClient()
247 if (this->memory_file >= 0)
248 close(this->memory_file);
250 if (this->unw_underlying_addr_space != unw_local_addr_space) {
251 if (this->unw_underlying_addr_space)
252 unw_destroy_addr_space(this->unw_underlying_addr_space);
253 if (this->unw_underlying_context)
254 _UPT_destroy(this->unw_underlying_context);
257 unw_destroy_addr_space(this->unw_addr_space);
260 /** Refresh the information about the process
262 * Do not use directly, this is used by the getters when appropriate
263 * in order to have fresh data.
265 void RemoteClient::refresh_heap()
267 // Read/dereference/refresh the std_heap pointer:
269 this->heap = std::unique_ptr<s_xbt_mheap_t>(new s_xbt_mheap_t());
270 this->read_bytes(this->heap.get(), sizeof(mdesc), remote(this->heap_address), simgrid::mc::ProcessIndexDisabled);
271 this->cache_flags_ |= RemoteClient::cache_heap;
274 /** Refresh the information about the process
276 * Do not use direclty, this is used by the getters when appropriate
277 * in order to have fresh data.
279 void RemoteClient::refresh_malloc_info()
281 // Refresh process->heapinfo:
282 if (this->cache_flags_ & RemoteClient::cache_malloc)
284 size_t count = this->heap->heaplimit + 1;
285 if (this->heap_info.size() < count)
286 this->heap_info.resize(count);
287 this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info), remote(this->heap->heapinfo),
288 simgrid::mc::ProcessIndexDisabled);
289 this->cache_flags_ |= RemoteClient::cache_malloc;
292 /** @brief Finds the range of the different memory segments and binary paths */
293 void RemoteClient::init_memory_map_info()
295 XBT_DEBUG("Get debug information ...");
296 this->maestro_stack_start_ = nullptr;
297 this->maestro_stack_end_ = nullptr;
298 this->object_infos.resize(0);
299 this->binary_info = nullptr;
300 this->libsimgrid_info = nullptr;
302 std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
304 const char* current_name = nullptr;
306 this->object_infos.clear();
308 for (size_t i = 0; i < maps.size(); i++) {
309 simgrid::xbt::VmMap const& reg = maps[i];
310 const char* pathname = maps[i].pathname.c_str();
313 if (maps[i].pathname.empty()) {
314 current_name = nullptr;
318 // [stack], [vvar], [vsyscall], [vdso] ...
319 if (pathname[0] == '[') {
320 if ((reg.prot & PROT_WRITE) && not memcmp(pathname, "[stack]", 7)) {
321 this->maestro_stack_start_ = remote(reg.start_addr);
322 this->maestro_stack_end_ = remote(reg.end_addr);
324 current_name = nullptr;
328 if (current_name && strcmp(current_name, pathname) == 0)
331 current_name = pathname;
332 if (not(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
335 const bool is_executable = not i;
337 if (not is_executable) {
338 libname = get_lib_name(pathname);
339 if (is_filtered_lib(libname)) {
344 std::shared_ptr<simgrid::mc::ObjectInformation> info =
345 simgrid::mc::createObjectInformation(this->memory_map_, pathname);
346 this->object_infos.push_back(info);
348 this->binary_info = info;
349 else if (is_simgrid_lib(libname))
350 this->libsimgrid_info = info;
353 // Resolve time (including across different objects):
354 for (auto const& object_info : this->object_infos)
355 postProcessObjectInformation(this, object_info.get());
357 xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
358 xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
360 XBT_DEBUG("Get debug information done !");
363 std::shared_ptr<simgrid::mc::ObjectInformation> RemoteClient::find_object_info(RemotePtr<void> addr) const
365 for (auto const& object_info : this->object_infos)
366 if (addr.address() >= (std::uint64_t)object_info->start && addr.address() <= (std::uint64_t)object_info->end)
371 std::shared_ptr<ObjectInformation> RemoteClient::find_object_info_exec(RemotePtr<void> addr) const
373 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
374 if (addr.address() >= (std::uint64_t)info->start_exec && addr.address() <= (std::uint64_t)info->end_exec)
379 std::shared_ptr<ObjectInformation> RemoteClient::find_object_info_rw(RemotePtr<void> addr) const
381 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
382 if (addr.address() >= (std::uint64_t)info->start_rw && addr.address() <= (std::uint64_t)info->end_rw)
387 simgrid::mc::Frame* RemoteClient::find_function(RemotePtr<void> ip) const
389 std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
390 return info ? info->find_function((void*)ip.address()) : nullptr;
393 /** Find (one occurrence of) the named variable definition
395 simgrid::mc::Variable* RemoteClient::find_variable(const char* name) const
397 // First lookup the variable in the executable shared object.
398 // A global variable used directly by the executable code from a library
399 // is reinstanciated in the executable memory .data/.bss.
400 // We need to look up the variable in the executable first.
401 if (this->binary_info) {
402 std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
403 simgrid::mc::Variable* var = info->find_variable(name);
408 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
409 simgrid::mc::Variable* var = info->find_variable(name);
417 void RemoteClient::read_variable(const char* name, void* target, size_t size) const
419 simgrid::mc::Variable* var = this->find_variable(name);
420 xbt_assert(var->address, "No simple location for this variable");
421 xbt_assert(var->type->full_type, "Partial type for %s, cannot check size", name);
422 xbt_assert((size_t)var->type->full_type->byte_size == size, "Unexpected size for %s (expected %zu, was %zu)", name,
423 size, (size_t)var->type->full_type->byte_size);
424 this->read_bytes(target, size, remote(var->address));
427 std::string RemoteClient::read_string(RemotePtr<char> address) const
432 std::vector<char> res(128);
436 ssize_t c = pread(this->memory_file, res.data() + off, res.size() - off, (off_t)address.address() + off);
441 xbt_die("Could not read from from remote process");
444 xbt_die("Could not read string from remote process");
446 void* p = memchr(res.data() + off, '\0', c);
448 return std::string(res.data());
451 if (off == (off_t)res.size())
452 res.resize(res.size() * 2);
456 const void* RemoteClient::read_bytes(void* buffer, std::size_t size, RemotePtr<void> address, int process_index,
457 ReadOptions options) const
460 if (process_index != simgrid::mc::ProcessIndexDisabled) {
461 std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->find_object_info_rw(address);
462 // Segment overlap is not handled.
463 if (info.get() && this->privatized(*info)) {
464 if (process_index < 0)
465 xbt_die("Missing process index");
466 if (process_index >= (int)MC_smpi_process_count())
467 xbt_die("Invalid process index");
469 // Read smpi_privatization_regions from MCed:
470 smpi_privatization_region_t remote_smpi_privatization_regions =
471 mc_model_checker->process().read_variable<smpi_privatization_region_t>("smpi_privatization_regions");
473 s_smpi_privatization_region_t privatization_region =
474 mc_model_checker->process().read<s_smpi_privatization_region_t>(
475 remote(remote_smpi_privatization_regions + process_index));
477 // Address translation in the privatization segment:
478 size_t offset = address.address() - (std::uint64_t)info->start_rw;
479 address = remote((char*)privatization_region.address + offset);
483 if (pread_whole(this->memory_file, buffer, size, (size_t)address.address()) < 0)
484 xbt_die("Read at %p from process %lli failed", (void*)address.address(), (long long)this->pid_);
488 /** Write data to a process memory
490 * @param buffer local memory address (source)
491 * @param len data size
492 * @param address target process memory address (target)
494 void RemoteClient::write_bytes(const void* buffer, size_t len, RemotePtr<void> address)
496 if (pwrite_whole(this->memory_file, buffer, len, (size_t)address.address()) < 0)
497 xbt_die("Write to process %lli failed", (long long)this->pid_);
500 void RemoteClient::clear_bytes(RemotePtr<void> address, size_t len)
502 pthread_once(&zero_buffer_flag, zero_buffer_init);
504 size_t s = len > zero_buffer_size ? zero_buffer_size : len;
505 this->write_bytes(zero_buffer, s, address);
506 address = remote((char*)address.address() + s);
511 void RemoteClient::ignore_region(std::uint64_t addr, std::size_t size)
513 IgnoredRegion region;
517 if (ignored_regions_.empty()) {
518 ignored_regions_.push_back(region);
522 unsigned int cursor = 0;
523 IgnoredRegion* current_region = nullptr;
526 int end = ignored_regions_.size() - 1;
527 while (start <= end) {
528 cursor = (start + end) / 2;
529 current_region = &ignored_regions_[cursor];
530 if (current_region->addr == addr) {
531 if (current_region->size == size)
533 else if (current_region->size < size)
537 } else if (current_region->addr < addr)
543 std::size_t position;
544 if (current_region->addr == addr) {
545 if (current_region->size < size)
546 position = cursor + 1;
549 } else if (current_region->addr < addr)
550 position = cursor + 1;
553 ignored_regions_.insert(ignored_regions_.begin() + position, region);
556 void RemoteClient::ignore_heap(IgnoredHeapRegion const& region)
558 if (ignored_heap_.empty()) {
559 ignored_heap_.push_back(std::move(region));
563 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
566 size_type end = ignored_heap_.size() - 1;
568 // Binary search the position of insertion:
570 while (start <= end) {
571 cursor = start + (end - start) / 2;
572 auto& current_region = ignored_heap_[cursor];
573 if (current_region.address == region.address)
575 else if (current_region.address < region.address)
577 else if (cursor != 0)
584 // Insert it mc_heap_ignore_region_t:
585 if (ignored_heap_[cursor].address < region.address)
587 ignored_heap_.insert(ignored_heap_.begin() + cursor, region);
590 void RemoteClient::unignore_heap(void* address, size_t size)
592 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
595 size_type end = ignored_heap_.size() - 1;
599 while (start <= end) {
600 cursor = (start + end) / 2;
601 auto& region = ignored_heap_[cursor];
602 if (region.address < address)
604 else if ((char*)region.address <= ((char*)address + size)) {
605 ignored_heap_.erase(ignored_heap_.begin() + cursor);
607 } else if (cursor != 0)
615 void RemoteClient::ignore_local_variable(const char* var_name, const char* frame_name)
617 if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
618 frame_name = nullptr;
619 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos)
620 info->remove_local_variable(var_name, frame_name);
623 std::vector<simgrid::mc::ActorInformation>& RemoteClient::actors()
625 this->refresh_simix();
626 return smx_actors_infos;
629 std::vector<simgrid::mc::ActorInformation>& RemoteClient::dead_actors()
631 this->refresh_simix();
632 return smx_dead_actors_infos;
635 void RemoteClient::dumpStack()
637 unw_addr_space_t as = unw_create_addr_space(&_UPT_accessors, BYTE_ORDER);
639 XBT_ERROR("Could not initialize ptrace address space");
643 void* context = _UPT_create(this->pid_);
644 if (context == nullptr) {
645 unw_destroy_addr_space(as);
646 XBT_ERROR("Could not initialize ptrace context");
651 if (unw_init_remote(&cursor, as, context) != 0) {
652 _UPT_destroy(context);
653 unw_destroy_addr_space(as);
654 XBT_ERROR("Could not initialiez ptrace cursor");
658 simgrid::mc::dumpStack(stderr, cursor);
660 _UPT_destroy(context);
661 unw_destroy_addr_space(as);
664 bool RemoteClient::actor_is_enabled(aid_t pid)
666 s_mc_message_actor_enabled_t msg{MC_MESSAGE_ACTOR_ENABLED, pid};
667 process()->getChannel().send(msg);
668 char buff[MC_MESSAGE_LENGTH];
669 ssize_t received = process()->getChannel().receive(buff, MC_MESSAGE_LENGTH, true);
670 xbt_assert(received == sizeof(s_mc_message_int_t), "Unexpected size in answer to ACTOR_ENABLED");
671 return ((s_mc_message_int_t*)buff)->value;