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_unw.h"
33 #include "src/mc/mc_snapshot.h"
34 #include "src/mc/mc_ignore.h"
35 #include "src/mc/mc_smx.h"
37 #include "src/mc/Process.hpp"
38 #include "src/mc/AddressSpace.hpp"
39 #include "src/mc/ObjectInformation.hpp"
40 #include "src/mc/Variable.hpp"
42 using simgrid::mc::remote;
46 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_process, mc,
47 "MC process information");
56 #define SO_RE "\\.so[\\.0-9]*$"
57 #define VERSION_RE "-[\\.0-9-]*$"
59 // In lexicographic order (but this is currently not used in the code):
60 static const char *const filtered_libraries[] = {
90 static bool is_simgrid_lib(const char* libname)
92 return !strcmp(libname, "libsimgrid");
95 static bool is_filtered_lib(const char* libname)
97 for (const char* filtered_lib : filtered_libraries)
98 if (strcmp(libname, filtered_lib)==0)
103 struct s_mc_memory_map_re {
108 static char* get_lib_name(const char* pathname, struct s_mc_memory_map_re* res)
110 char* map_basename = xbt_basename(pathname);
113 if(regexec(&res->so_re, map_basename, 1, &match, 0)) {
118 char* libname = strndup(map_basename, match.rm_so);
120 map_basename = nullptr;
122 // Strip the version suffix:
123 if(libname && !regexec(&res->version_re, libname, 1, &match, 0)) {
124 char* temp = libname;
125 libname = strndup(temp, match.rm_so);
132 static ssize_t pread_whole(int fd, void *buf, size_t count, std::uint64_t offset)
134 char* buffer = (char*) buf;
135 ssize_t real_count = count;
137 ssize_t res = pread(fd, buffer, count, (std::int64_t) offset);
144 else if (errno != EINTR) {
145 perror("pread_whole");
152 static ssize_t pwrite_whole(int fd, const void *buf, size_t count, off_t offset)
154 const char* buffer = (const char*) buf;
155 ssize_t real_count = count;
157 ssize_t res = pwrite(fd, buffer, count, offset);
164 else if (errno != EINTR)
170 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
171 static const void* zero_buffer;
172 static const size_t zero_buffer_size = 10 * 4096;
174 static void zero_buffer_init(void)
176 int fd = open("/dev/zero", O_RDONLY);
178 xbt_die("Could not open /dev/zero");
179 zero_buffer = mmap(nullptr, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
180 if (zero_buffer == MAP_FAILED)
181 xbt_die("Could not map the zero buffer");
186 int open_process_file(pid_t pid, const char* file, int flags)
189 snprintf(buff, sizeof(buff), "/proc/%li/%s", (long) pid, file);
190 return open(buff, flags);
193 int open_vm(pid_t pid, int flags)
195 const size_t buffer_size = 30;
196 char buffer[buffer_size];
197 int res = snprintf(buffer, buffer_size, "/proc/%lli/mem", (long long) pid);
198 if (res < 0 || (size_t) res >= buffer_size) {
199 errno = ENAMETOOLONG;
202 return open(buffer, flags);
207 Process::Process(pid_t pid, int sockfd) :
208 AddressSpace(this),pid_(pid), socket_(sockfd), running_(true)
213 this->memory_map_ = simgrid::xbt::get_memory_map(this->pid_);
214 this->init_memory_map_info();
216 int fd = open_vm(this->pid_, O_RDWR);
218 xbt_die("Could not open file for process virtual address space");
219 this->memory_file = fd;
221 // Read std_heap (is a struct mdesc*):
222 simgrid::mc::Variable* std_heap_var = this->find_variable("__mmalloc_default_mdp");
224 xbt_die("No heap information in the target process");
225 if(!std_heap_var->address)
226 xbt_die("No constant address for this variable");
227 this->read_bytes(&this->heap_address, sizeof(struct mdesc*),
228 remote(std_heap_var->address),
229 simgrid::mc::ProcessIndexDisabled);
231 this->smx_process_infos.clear();
232 this->smx_old_process_infos.clear();
233 this->unw_addr_space = unw_create_addr_space(&mc_unw_accessors , __BYTE_ORDER);
234 this->unw_underlying_addr_space = unw_create_addr_space(&mc_unw_vmread_accessors, __BYTE_ORDER);
235 this->unw_underlying_context = _UPT_create(this->pid_);
240 if (this->socket_ >= 0 && close(this->socket_) < 0)
241 xbt_die("Could not close communication socket");
243 this->maestro_stack_start_ = nullptr;
244 this->maestro_stack_end_ = nullptr;
246 if (this->memory_file >= 0)
247 close(this->memory_file);
249 if (this->unw_underlying_addr_space != unw_local_addr_space) {
250 unw_destroy_addr_space(this->unw_underlying_addr_space);
251 _UPT_destroy(this->unw_underlying_context);
253 this->unw_underlying_context = nullptr;
254 this->unw_underlying_addr_space = nullptr;
256 unw_destroy_addr_space(this->unw_addr_space);
257 this->unw_addr_space = nullptr;
259 this->cache_flags = MC_PROCESS_CACHE_FLAG_NONE;
261 if (this->clear_refs_fd_ >= 0)
262 close(this->clear_refs_fd_);
263 if (this->pagemap_fd_ >= 0)
264 close(this->pagemap_fd_);
267 /** Refresh the information about the process
269 * Do not use direclty, this is used by the getters when appropriate
270 * in order to have fresh data.
272 void Process::refresh_heap()
274 xbt_assert(mc_mode == MC_MODE_SERVER);
275 // Read/dereference/refresh the std_heap pointer:
277 this->heap = std::unique_ptr<s_xbt_mheap_t>(new s_xbt_mheap_t());
278 this->read_bytes(this->heap.get(), sizeof(struct mdesc),
279 remote(this->heap_address), simgrid::mc::ProcessIndexDisabled);
280 this->cache_flags |= MC_PROCESS_CACHE_FLAG_HEAP;
283 /** Refresh the information about the process
285 * Do not use direclty, this is used by the getters when appropriate
286 * in order to have fresh data.
288 void Process::refresh_malloc_info()
290 xbt_assert(mc_mode == MC_MODE_SERVER);
291 if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
292 this->refresh_heap();
293 // Refresh process->heapinfo:
294 size_t count = this->heap->heaplimit + 1;
295 if (this->heap_info.size() < count)
296 this->heap_info.resize(count);
297 this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info),
298 remote(this->heap->heapinfo), simgrid::mc::ProcessIndexDisabled);
299 this->cache_flags |= MC_PROCESS_CACHE_FLAG_MALLOC_INFO;
302 /** @brief Finds the range of the different memory segments and binary paths */
303 void Process::init_memory_map_info()
305 XBT_DEBUG("Get debug information ...");
306 this->maestro_stack_start_ = nullptr;
307 this->maestro_stack_end_ = nullptr;
308 this->object_infos.resize(0);
309 this->binary_info = nullptr;
310 this->libsimgrid_info = nullptr;
312 struct s_mc_memory_map_re res;
314 if(regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
315 xbt_die(".so regexp did not compile");
317 std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
319 const char* current_name = nullptr;
321 this->object_infos.clear();
323 for (size_t i=0; i < maps.size(); i++) {
324 simgrid::xbt::VmMap const& reg = maps[i];
325 const char* pathname = maps[i].pathname.c_str();
328 if (maps[i].pathname.empty()) {
329 current_name = nullptr;
333 // [stack], [vvar], [vsyscall], [vdso] ...
334 if (pathname[0] == '[') {
335 if ((reg.prot & PROT_WRITE) && !memcmp(pathname, "[stack]", 7)) {
336 this->maestro_stack_start_ = remote(reg.start_addr);
337 this->maestro_stack_end_ = remote(reg.end_addr);
339 current_name = nullptr;
343 if (current_name && strcmp(current_name, pathname)==0)
346 current_name = pathname;
347 if (!(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
350 const bool is_executable = !i;
351 char* libname = nullptr;
352 if (!is_executable) {
353 libname = get_lib_name(pathname, &res);
356 if (is_filtered_lib(libname)) {
362 std::shared_ptr<simgrid::mc::ObjectInformation> info =
363 simgrid::mc::createObjectInformation(this->memory_map_, pathname);
364 this->object_infos.push_back(info);
366 this->binary_info = info;
367 else if (libname && is_simgrid_lib(libname))
368 this->libsimgrid_info = info;
373 regfree(&res.version_re);
375 // Resolve time (including accross differents objects):
376 for (auto const& object_info : this->object_infos)
377 postProcessObjectInformation(this, object_info.get());
379 xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
380 xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
382 XBT_DEBUG("Get debug information done !");
385 std::shared_ptr<simgrid::mc::ObjectInformation> Process::find_object_info(RemotePtr<void> addr) const
387 for (auto const& object_info : this->object_infos)
388 if (addr.address() >= (std::uint64_t)object_info->start
389 && addr.address() <= (std::uint64_t)object_info->end)
394 std::shared_ptr<ObjectInformation> Process::find_object_info_exec(RemotePtr<void> addr) const
396 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
397 if (addr.address() >= (std::uint64_t) info->start_exec
398 && addr.address() <= (std::uint64_t) info->end_exec)
403 std::shared_ptr<ObjectInformation> Process::find_object_info_rw(RemotePtr<void> addr) const
405 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
406 if (addr.address() >= (std::uint64_t)info->start_rw
407 && addr.address() <= (std::uint64_t)info->end_rw)
412 simgrid::mc::Frame* Process::find_function(RemotePtr<void> ip) const
414 std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
415 return info ? info->find_function((void*) ip.address()) : nullptr;
418 /** Find (one occurence of) the named variable definition
420 simgrid::mc::Variable* Process::find_variable(const char* name) const
422 // First lookup the variable in the executable shared object.
423 // A global variable used directly by the executable code from a library
424 // is reinstanciated in the executable memory .data/.bss.
425 // We need to look up the variable in the execvutable first.
426 if (this->binary_info) {
427 std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
428 simgrid::mc::Variable* var = info->find_variable(name);
433 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
434 simgrid::mc::Variable* var = info->find_variable(name);
442 void Process::read_variable(const char* name, void* target, size_t size) const
444 simgrid::mc::Variable* var = this->find_variable(name);
446 xbt_die("No simple location for this variable");
447 if (!var->type->full_type)
448 xbt_die("Partial type for %s, cannot check size", name);
449 if ((size_t) var->type->full_type->byte_size != size)
450 xbt_die("Unexpected size for %s (expected %zi, was %zi)",
451 name, size, (size_t) var->type->full_type->byte_size);
452 this->read_bytes(target, size, remote(var->address));
455 char* Process::read_string(RemotePtr<void> address) const
461 char* res = (char*) malloc(len);
465 ssize_t c = pread(this->memory_file, res + off, len - off, (off_t) address.address() + off);
470 xbt_die("Could not read from from remote process");
473 xbt_die("Could not read string from remote process");
475 void* p = memchr(res + off, '\0', c);
482 res = (char*) realloc(res, len);
487 const void *Process::read_bytes(void* buffer, std::size_t size,
488 RemotePtr<void> address, int process_index,
489 ReadOptions options) const
491 if (process_index != simgrid::mc::ProcessIndexDisabled) {
492 std::shared_ptr<simgrid::mc::ObjectInformation> const& info =
493 this->find_object_info_rw((void*)address.address());
494 // Segment overlap is not handled.
496 if (info.get() && this->privatized(*info)) {
497 if (process_index < 0)
498 xbt_die("Missing process index");
499 if (process_index >= (int) MC_smpi_process_count())
500 xbt_die("Invalid process index");
502 // Read smpi_privatisation_regions from MCed:
503 smpi_privatisation_region_t remote_smpi_privatisation_regions =
504 mc_model_checker->process().read_variable<smpi_privatisation_region_t>(
505 "smpi_privatisation_regions");
507 s_smpi_privatisation_region_t privatisation_region =
508 mc_model_checker->process().read<s_smpi_privatisation_region_t>(
509 remote(remote_smpi_privatisation_regions + process_index));
511 // Address translation in the privaization segment:
512 size_t offset = address.address() - (std::uint64_t)info->start_rw;
513 address = remote((char*)privatisation_region.address + offset);
518 if (pread_whole(this->memory_file, buffer, size, address.address()) < 0)
519 xbt_die("Read from process %lli failed", (long long) this->pid_);
523 /** Write data to a process memory
525 * @param process the process
526 * @param local local memory address (source)
527 * @param remote target process memory address (target)
528 * @param len data size
530 void Process::write_bytes(const void* buffer, size_t len, RemotePtr<void> address)
532 if (pwrite_whole(this->memory_file, buffer, len, address.address()) < 0)
533 xbt_die("Write to process %lli failed", (long long) this->pid_);
536 void Process::clear_bytes(RemotePtr<void> address, size_t len)
538 pthread_once(&zero_buffer_flag, zero_buffer_init);
540 size_t s = len > zero_buffer_size ? zero_buffer_size : len;
541 this->write_bytes(zero_buffer, s, address);
542 address = remote((char*) address.address() + s);
547 void Process::ignore_region(std::uint64_t addr, std::size_t size)
549 IgnoredRegion region;
553 if (ignored_regions_.empty()) {
554 ignored_regions_.push_back(region);
558 unsigned int cursor = 0;
559 IgnoredRegion* current_region = nullptr;
562 int end = ignored_regions_.size() - 1;
563 while (start <= end) {
564 cursor = (start + end) / 2;
565 current_region = &ignored_regions_[cursor];
566 if (current_region->addr == addr) {
567 if (current_region->size == size)
569 else if (current_region->size < size)
573 } else if (current_region->addr < addr)
579 std::size_t position;
580 if (current_region->addr == addr) {
581 if (current_region->size < size)
582 position = cursor + 1;
585 } else if (current_region->addr < addr)
586 position = cursor + 1;
589 ignored_regions_.insert(
590 ignored_regions_.begin() + position, region);
593 void Process::reset_soft_dirty()
595 if (this->clear_refs_fd_ < 0) {
596 this->clear_refs_fd_ = open_process_file(pid_, "clear_refs", O_WRONLY|O_CLOEXEC);
597 if (this->clear_refs_fd_ < 0)
598 xbt_die("Could not open clear_refs file for soft-dirty tracking. Run as root?");
600 if(::write(this->clear_refs_fd_, "4\n", 2) != 2)
601 xbt_die("Could not reset softdirty bits");
604 void Process::read_pagemap(uint64_t* pagemap, size_t page_start, size_t page_count)
606 if (pagemap_fd_ < 0) {
607 pagemap_fd_ = open_process_file(pid_, "pagemap", O_RDONLY|O_CLOEXEC);
609 xbt_die("Could not open pagemap file for soft-dirty tracking. Run as root?");
611 ssize_t bytesize = sizeof(uint64_t) * page_count;
612 off_t offset = sizeof(uint64_t) * page_start;
613 if (pread_whole(pagemap_fd_, pagemap, bytesize, offset) != bytesize)
614 xbt_die("Could not read pagemap");
617 void Process::ignore_heap(IgnoredHeapRegion const& region)
619 if (ignored_heap_.empty()) {
620 ignored_heap_.push_back(std::move(region));
624 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
627 size_type end = ignored_heap_.size() - 1;
629 // Binary search the position of insertion:
631 while (start <= end) {
632 cursor = start + (end - start) / 2;
633 auto& current_region = ignored_heap_[cursor];
634 if (current_region.address == region.address)
636 else if (current_region.address < region.address)
638 else if (cursor != 0)
645 // Insert it mc_heap_ignore_region_t:
646 if (ignored_heap_[cursor].address < region.address)
648 ignored_heap_.insert( ignored_heap_.begin() + cursor, region);
651 void Process::unignore_heap(void *address, size_t size)
653 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
656 size_type end = ignored_heap_.size() - 1;
660 while (start <= end) {
661 cursor = (start + end) / 2;
662 auto& region = ignored_heap_[cursor];
663 if (region.address == address) {
664 ignored_heap_.erase(ignored_heap_.begin() + cursor);
666 } else if (region.address < address)
668 else if ((char *) region.address <= ((char *) address + size)) {
669 ignored_heap_.erase(ignored_heap_.begin() + cursor);
671 } else if (cursor != 0)
679 void Process::ignore_local_variable(const char *var_name, const char *frame_name)
681 if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
682 frame_name = nullptr;
683 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
685 info->remove_local_variable(var_name, frame_name);
688 std::vector<simgrid::mc::SimixProcessInformation>& Process::simix_processes()
690 xbt_assert(mc_mode != MC_MODE_CLIENT);
691 this->refresh_simix();
692 return smx_process_infos;
695 std::vector<simgrid::mc::SimixProcessInformation>& Process::old_simix_processes()
697 xbt_assert(mc_mode != MC_MODE_CLIENT);
698 this->refresh_simix();
699 return smx_old_process_infos;