1 /* Copyright (c) 2014-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #define _FILE_OFFSET_BITS 64
14 #include <sys/types.h>
18 #include <sys/mman.h> // PROT_*
24 #include <libunwind.h>
25 #include <libunwind-ptrace.h>
27 #include <xbt/dynar.h>
30 #include <xbt/mmalloc.h>
32 #include "src/mc/mc_object_info.h"
33 #include "src/mc/mc_unw.h"
34 #include "src/mc/mc_snapshot.h"
35 #include "src/mc/mc_ignore.h"
36 #include "src/mc/mc_smx.h"
38 #include "src/mc/Process.hpp"
39 #include "src/mc/AddressSpace.hpp"
40 #include "src/mc/ObjectInformation.hpp"
41 #include "src/mc/Variable.hpp"
43 using simgrid::mc::remote;
47 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_process, mc,
48 "MC process information");
52 #define SO_RE "\\.so[\\.0-9]*$"
53 #define VERSION_RE "-[\\.0-9-]*$"
55 static const char *const FILTERED_LIBS[] = {
85 static bool MC_is_simgrid_lib(const char* libname)
87 return !strcmp(libname, "libsimgrid");
90 static bool MC_is_filtered_lib(const char* libname)
92 for (const char* filtered_lib : FILTERED_LIBS)
93 if (strcmp(libname, filtered_lib)==0)
98 struct s_mc_memory_map_re {
103 static char* MC_get_lib_name(const char* pathname, struct s_mc_memory_map_re* res)
105 const char* map_basename = xbt_basename((char*) pathname);
108 if(regexec(&res->so_re, map_basename, 1, &match, 0))
111 char* libname = strndup(map_basename, match.rm_so);
113 // Strip the version suffix:
114 if(libname && !regexec(&res->version_re, libname, 1, &match, 0)) {
115 char* temp = libname;
116 libname = strndup(temp, match.rm_so);
123 static ssize_t pread_whole(int fd, void *buf, size_t count, std::uint64_t offset)
125 char* buffer = (char*) buf;
126 ssize_t real_count = count;
128 ssize_t res = pread(fd, buffer, count, (std::int64_t) offset);
135 else if (errno != EINTR) {
136 perror("pread_whole");
143 static ssize_t pwrite_whole(int fd, const void *buf, size_t count, off_t offset)
145 const char* buffer = (const char*) buf;
146 ssize_t real_count = count;
148 ssize_t res = pwrite(fd, buffer, count, offset);
155 else if (errno != EINTR)
161 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
162 static const void* zero_buffer;
163 static const size_t zero_buffer_size = 10 * 4096;
165 static void MC_zero_buffer_init(void)
167 int fd = open("/dev/zero", O_RDONLY);
169 xbt_die("Could not open /dev/zero");
170 zero_buffer = mmap(nullptr, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
171 if (zero_buffer == MAP_FAILED)
172 xbt_die("Could not map the zero buffer");
177 int open_process_file(pid_t pid, const char* file, int flags)
180 snprintf(buff, sizeof(buff), "/proc/%li/%s", (long) pid, file);
181 return open(buff, flags);
189 int open_vm(pid_t pid, int flags)
191 const size_t buffer_size = 30;
192 char buffer[buffer_size];
193 int res = snprintf(buffer, buffer_size, "/proc/%lli/mem", (long long) pid);
194 if (res < 0 || (size_t) res >= buffer_size) {
195 errno = ENAMETOOLONG;
198 return open(buffer, flags);
210 Process::Process(pid_t pid, int sockfd) :
211 AddressSpace(this),pid_(pid), socket_(sockfd), running_(true)
216 this->memory_map_ = simgrid::xbt::get_memory_map(this->pid_);
217 this->init_memory_map_info();
219 int fd = open_vm(this->pid_, O_RDWR);
221 xbt_die("Could not open file for process virtual address space");
222 this->memory_file = fd;
224 // Read std_heap (is a struct mdesc*):
225 simgrid::mc::Variable* std_heap_var = this->find_variable("__mmalloc_default_mdp");
227 xbt_die("No heap information in the target process");
228 if(!std_heap_var->address)
229 xbt_die("No constant address for this variable");
230 this->read_bytes(&this->heap_address, sizeof(struct mdesc*),
231 remote(std_heap_var->address),
232 simgrid::mc::ProcessIndexDisabled);
234 this->smx_process_infos.clear();
235 this->smx_old_process_infos.clear();
236 this->unw_addr_space = unw_create_addr_space(&mc_unw_accessors , __BYTE_ORDER);
237 this->unw_underlying_addr_space = unw_create_addr_space(&mc_unw_vmread_accessors, __BYTE_ORDER);
238 this->unw_underlying_context = _UPT_create(this->pid_);
243 if (this->socket_ >= 0 && close(this->socket_) < 0)
244 xbt_die("Could not close communication socket");
246 this->maestro_stack_start_ = nullptr;
247 this->maestro_stack_end_ = nullptr;
249 if (this->memory_file >= 0) {
250 close(this->memory_file);
253 if (this->unw_underlying_addr_space != unw_local_addr_space) {
254 unw_destroy_addr_space(this->unw_underlying_addr_space);
255 _UPT_destroy(this->unw_underlying_context);
257 this->unw_underlying_context = nullptr;
258 this->unw_underlying_addr_space = nullptr;
260 unw_destroy_addr_space(this->unw_addr_space);
261 this->unw_addr_space = nullptr;
263 this->cache_flags = MC_PROCESS_CACHE_FLAG_NONE;
265 if (this->clear_refs_fd_ >= 0)
266 close(this->clear_refs_fd_);
267 if (this->pagemap_fd_ >= 0)
268 close(this->pagemap_fd_);
271 /** Refresh the information about the process
273 * Do not use direclty, this is used by the getters when appropriate
274 * in order to have fresh data.
276 void Process::refresh_heap()
278 xbt_assert(mc_mode == MC_MODE_SERVER);
279 // Read/dereference/refresh the std_heap pointer:
281 this->heap = std::unique_ptr<s_xbt_mheap_t>(new s_xbt_mheap_t());
282 this->read_bytes(this->heap.get(), sizeof(struct mdesc),
283 remote(this->heap_address), simgrid::mc::ProcessIndexDisabled);
284 this->cache_flags |= MC_PROCESS_CACHE_FLAG_HEAP;
287 /** Refresh the information about the process
289 * Do not use direclty, this is used by the getters when appropriate
290 * in order to have fresh data.
292 void Process::refresh_malloc_info()
294 xbt_assert(mc_mode == MC_MODE_SERVER);
295 if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
296 this->refresh_heap();
297 // Refresh process->heapinfo:
298 size_t count = this->heap->heaplimit + 1;
299 if (this->heap_info.size() < count)
300 this->heap_info.resize(count);
301 this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info),
302 remote(this->heap->heapinfo), simgrid::mc::ProcessIndexDisabled);
303 this->cache_flags |= MC_PROCESS_CACHE_FLAG_MALLOC_INFO;
306 /** @brief Finds the range of the different memory segments and binary paths */
307 void Process::init_memory_map_info()
309 XBT_DEBUG("Get debug information ...");
310 this->maestro_stack_start_ = nullptr;
311 this->maestro_stack_end_ = nullptr;
312 this->object_infos.resize(0);
313 this->binary_info = nullptr;
314 this->libsimgrid_info = nullptr;
316 struct s_mc_memory_map_re res;
318 if(regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
319 xbt_die(".so regexp did not compile");
321 std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
323 const char* current_name = nullptr;
325 this->object_infos.resize(0);
327 for (size_t i=0; i < maps.size(); i++) {
328 simgrid::xbt::VmMap const& reg = maps[i];
329 const char* pathname = maps[i].pathname.c_str();
332 if (maps[i].pathname.empty()) {
333 current_name = nullptr;
337 // [stack], [vvar], [vsyscall], [vdso] ...
338 if (pathname[0] == '[') {
339 if ((reg.prot & PROT_WRITE) && !memcmp(pathname, "[stack]", 7)) {
340 this->maestro_stack_start_ = remote(reg.start_addr);
341 this->maestro_stack_end_ = remote(reg.end_addr);
343 current_name = nullptr;
347 if (current_name && strcmp(current_name, pathname)==0)
350 current_name = pathname;
351 if (!(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
354 const bool is_executable = !i;
355 char* libname = nullptr;
356 if (!is_executable) {
357 libname = MC_get_lib_name(pathname, &res);
360 if (MC_is_filtered_lib(libname)) {
366 std::shared_ptr<simgrid::mc::ObjectInformation> info =
367 MC_find_object_info(this->memory_map_, pathname);
368 this->object_infos.push_back(info);
370 this->binary_info = info;
371 else if (libname && MC_is_simgrid_lib(libname))
372 this->libsimgrid_info = info;
377 regfree(&res.version_re);
379 // Resolve time (including accross differents objects):
380 for (auto const& object_info : this->object_infos)
381 MC_post_process_object_info(this, object_info.get());
383 xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
384 xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
386 XBT_DEBUG("Get debug information done !");
389 std::shared_ptr<simgrid::mc::ObjectInformation> Process::find_object_info(RemotePtr<void> addr) const
391 for (auto const& object_info : this->object_infos)
392 if (addr.address() >= (std::uint64_t)object_info->start
393 && addr.address() <= (std::uint64_t)object_info->end)
398 std::shared_ptr<ObjectInformation> Process::find_object_info_exec(RemotePtr<void> addr) const
400 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
401 if (addr.address() >= (std::uint64_t) info->start_exec
402 && addr.address() <= (std::uint64_t) info->end_exec)
407 std::shared_ptr<ObjectInformation> Process::find_object_info_rw(RemotePtr<void> addr) const
409 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
410 if (addr.address() >= (std::uint64_t)info->start_rw
411 && addr.address() <= (std::uint64_t)info->end_rw)
416 simgrid::mc::Frame* Process::find_function(RemotePtr<void> ip) const
418 std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
419 return info ? info->find_function((void*) ip.address()) : nullptr;
422 /** Find (one occurence of) the named variable definition
424 simgrid::mc::Variable* Process::find_variable(const char* name) const
426 // First lookup the variable in the executable shared object.
427 // A global variable used directly by the executable code from a library
428 // is reinstanciated in the executable memory .data/.bss.
429 // We need to look up the variable in the execvutable first.
430 if (this->binary_info) {
431 std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
432 simgrid::mc::Variable* var = info->find_variable(name);
437 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
438 simgrid::mc::Variable* var = info->find_variable(name);
446 void Process::read_variable(const char* name, void* target, size_t size) const
448 simgrid::mc::Variable* var = this->find_variable(name);
450 xbt_die("No simple location for this variable");
451 if (!var->type->full_type)
452 xbt_die("Partial type for %s, cannot check size", name);
453 if ((size_t) var->type->full_type->byte_size != size)
454 xbt_die("Unexpected size for %s (expected %zi, was %zi)",
455 name, size, (size_t) var->type->full_type->byte_size);
456 this->read_bytes(target, size, remote(var->address));
459 char* Process::read_string(RemotePtr<void> address) const
465 char* res = (char*) malloc(len);
469 ssize_t c = pread(this->memory_file, res + off, len - off, (off_t) address.address() + off);
474 xbt_die("Could not read from from remote process");
477 xbt_die("Could not read string from remote process");
479 void* p = memchr(res + off, '\0', c);
486 res = (char*) realloc(res, len);
491 const void *Process::read_bytes(void* buffer, std::size_t size,
492 RemotePtr<void> address, int process_index,
493 ReadOptions options) const
495 if (process_index != simgrid::mc::ProcessIndexDisabled) {
496 std::shared_ptr<simgrid::mc::ObjectInformation> const& info =
497 this->find_object_info_rw((void*)address.address());
498 // Segment overlap is not handled.
500 if (info.get() && this->privatized(*info)) {
501 if (process_index < 0)
502 xbt_die("Missing process index");
503 if (process_index >= (int) MC_smpi_process_count())
504 xbt_die("Invalid process index");
506 // Read smpi_privatisation_regions from MCed:
507 smpi_privatisation_region_t remote_smpi_privatisation_regions =
508 mc_model_checker->process().read_variable<smpi_privatisation_region_t>(
509 "smpi_privatisation_regions");
511 s_smpi_privatisation_region_t privatisation_region =
512 mc_model_checker->process().read<s_smpi_privatisation_region_t>(
513 remote(remote_smpi_privatisation_regions + process_index));
515 // Address translation in the privaization segment:
516 size_t offset = address.address() - (std::uint64_t)info->start_rw;
517 address = remote((char*)privatisation_region.address + offset);
522 if (pread_whole(this->memory_file, buffer, size, address.address()) < 0)
523 xbt_die("Read from process %lli failed", (long long) this->pid_);
527 /** Write data to a process memory
529 * @param process the process
530 * @param local local memory address (source)
531 * @param remote target process memory address (target)
532 * @param len data size
534 void Process::write_bytes(const void* buffer, size_t len, RemotePtr<void> address)
536 if (pwrite_whole(this->memory_file, buffer, len, address.address()) < 0)
537 xbt_die("Write to process %lli failed", (long long) this->pid_);
540 void Process::clear_bytes(RemotePtr<void> address, size_t len)
542 pthread_once(&zero_buffer_flag, MC_zero_buffer_init);
544 size_t s = len > zero_buffer_size ? zero_buffer_size : len;
545 this->write_bytes(zero_buffer, s, address);
546 address = remote((char*) address.address() + s);
551 void Process::ignore_region(std::uint64_t addr, std::size_t size)
553 IgnoredRegion region;
557 if (ignored_regions_.empty()) {
558 ignored_regions_.push_back(region);
562 unsigned int cursor = 0;
563 IgnoredRegion* current_region = nullptr;
566 int end = ignored_regions_.size() - 1;
567 while (start <= end) {
568 cursor = (start + end) / 2;
569 current_region = &ignored_regions_[cursor];
570 if (current_region->addr == addr) {
571 if (current_region->size == size)
573 else if (current_region->size < size)
577 } else if (current_region->addr < addr)
583 std::size_t position;
584 if (current_region->addr == addr) {
585 if (current_region->size < size)
586 position = cursor + 1;
589 } else if (current_region->addr < addr)
590 position = cursor + 1;
593 ignored_regions_.insert(
594 ignored_regions_.begin() + position, region);
597 void Process::reset_soft_dirty()
599 if (this->clear_refs_fd_ < 0) {
600 this->clear_refs_fd_ = open_process_file(pid_, "clear_refs", O_WRONLY|O_CLOEXEC);
601 if (this->clear_refs_fd_ < 0)
602 xbt_die("Could not open clear_refs file for soft-dirty tracking. Run as root?");
604 if(::write(this->clear_refs_fd_, "4\n", 2) != 2)
605 xbt_die("Could not reset softdirty bits");
608 void Process::read_pagemap(uint64_t* pagemap, size_t page_start, size_t page_count)
610 if (pagemap_fd_ < 0) {
611 pagemap_fd_ = open_process_file(pid_, "pagemap", O_RDONLY|O_CLOEXEC);
613 xbt_die("Could not open pagemap file for soft-dirty tracking. Run as root?");
615 ssize_t bytesize = sizeof(uint64_t) * page_count;
616 off_t offset = sizeof(uint64_t) * page_start;
617 if (pread_whole(pagemap_fd_, pagemap, bytesize, offset) != bytesize)
618 xbt_die("Could not read pagemap");
621 void Process::ignore_heap(IgnoredHeapRegion const& region)
623 if (ignored_heap_.empty()) {
624 ignored_heap_.push_back(std::move(region));
628 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
631 size_type end = ignored_heap_.size() - 1;
633 // Binary search the position of insertion:
635 while (start <= end) {
636 cursor = start + (end - start) / 2;
637 auto& current_region = ignored_heap_[cursor];
638 if (current_region.address == region.address)
640 else if (current_region.address < region.address)
642 else if (cursor != 0)
649 // Insert it mc_heap_ignore_region_t:
650 if (ignored_heap_[cursor].address < region.address)
652 ignored_heap_.insert( ignored_heap_.begin() + cursor, region);
655 void Process::unignore_heap(void *address, size_t size)
657 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
660 size_type end = ignored_heap_.size() - 1;
664 while (start <= end) {
665 cursor = (start + end) / 2;
666 auto& region = ignored_heap_[cursor];
667 if (region.address == address) {
668 ignored_heap_.erase(ignored_heap_.begin() + cursor);
670 } else if (region.address < address)
672 else if ((char *) region.address <= ((char *) address + size)) {
673 ignored_heap_.erase(ignored_heap_.begin() + cursor);
675 } else if (cursor != 0)
683 void Process::ignore_local_variable(const char *var_name, const char *frame_name)
685 if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
686 frame_name = nullptr;
687 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
689 info->remove_local_variable(var_name, frame_name);
692 std::vector<simgrid::mc::SimixProcessInformation>& Process::simix_processes()
694 xbt_assert(mc_mode != MC_MODE_CLIENT);
695 MC_process_smx_refresh(&mc_model_checker->process());
696 return smx_process_infos;