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 const char* map_basename = xbt_basename((char*) pathname);
113 if(regexec(&res->so_re, map_basename, 1, &match, 0))
116 char* libname = strndup(map_basename, match.rm_so);
118 // Strip the version suffix:
119 if(libname && !regexec(&res->version_re, libname, 1, &match, 0)) {
120 char* temp = libname;
121 libname = strndup(temp, match.rm_so);
128 static ssize_t pread_whole(int fd, void *buf, size_t count, std::uint64_t offset)
130 char* buffer = (char*) buf;
131 ssize_t real_count = count;
133 ssize_t res = pread(fd, buffer, count, (std::int64_t) offset);
140 else if (errno != EINTR) {
141 perror("pread_whole");
148 static ssize_t pwrite_whole(int fd, const void *buf, size_t count, off_t offset)
150 const char* buffer = (const char*) buf;
151 ssize_t real_count = count;
153 ssize_t res = pwrite(fd, buffer, count, offset);
160 else if (errno != EINTR)
166 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
167 static const void* zero_buffer;
168 static const size_t zero_buffer_size = 10 * 4096;
170 static void zero_buffer_init(void)
172 int fd = open("/dev/zero", O_RDONLY);
174 xbt_die("Could not open /dev/zero");
175 zero_buffer = mmap(nullptr, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
176 if (zero_buffer == MAP_FAILED)
177 xbt_die("Could not map the zero buffer");
182 int open_process_file(pid_t pid, const char* file, int flags)
185 snprintf(buff, sizeof(buff), "/proc/%li/%s", (long) pid, file);
186 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);
203 Process::Process(pid_t pid, int sockfd) :
204 AddressSpace(this),pid_(pid), socket_(sockfd), running_(true)
209 this->memory_map_ = simgrid::xbt::get_memory_map(this->pid_);
210 this->init_memory_map_info();
212 int fd = open_vm(this->pid_, O_RDWR);
214 xbt_die("Could not open file for process virtual address space");
215 this->memory_file = fd;
217 // Read std_heap (is a struct mdesc*):
218 simgrid::mc::Variable* std_heap_var = this->find_variable("__mmalloc_default_mdp");
220 xbt_die("No heap information in the target process");
221 if(!std_heap_var->address)
222 xbt_die("No constant address for this variable");
223 this->read_bytes(&this->heap_address, sizeof(struct mdesc*),
224 remote(std_heap_var->address),
225 simgrid::mc::ProcessIndexDisabled);
227 this->smx_process_infos.clear();
228 this->smx_old_process_infos.clear();
229 this->unw_addr_space = unw_create_addr_space(&mc_unw_accessors , __BYTE_ORDER);
230 this->unw_underlying_addr_space = unw_create_addr_space(&mc_unw_vmread_accessors, __BYTE_ORDER);
231 this->unw_underlying_context = _UPT_create(this->pid_);
236 if (this->socket_ >= 0 && close(this->socket_) < 0)
237 xbt_die("Could not close communication socket");
239 this->maestro_stack_start_ = nullptr;
240 this->maestro_stack_end_ = nullptr;
242 if (this->memory_file >= 0)
243 close(this->memory_file);
245 if (this->unw_underlying_addr_space != unw_local_addr_space) {
246 unw_destroy_addr_space(this->unw_underlying_addr_space);
247 _UPT_destroy(this->unw_underlying_context);
249 this->unw_underlying_context = nullptr;
250 this->unw_underlying_addr_space = nullptr;
252 unw_destroy_addr_space(this->unw_addr_space);
253 this->unw_addr_space = nullptr;
255 this->cache_flags = MC_PROCESS_CACHE_FLAG_NONE;
257 if (this->clear_refs_fd_ >= 0)
258 close(this->clear_refs_fd_);
259 if (this->pagemap_fd_ >= 0)
260 close(this->pagemap_fd_);
263 /** Refresh the information about the process
265 * Do not use direclty, this is used by the getters when appropriate
266 * in order to have fresh data.
268 void Process::refresh_heap()
270 xbt_assert(mc_mode == MC_MODE_SERVER);
271 // Read/dereference/refresh the std_heap pointer:
273 this->heap = std::unique_ptr<s_xbt_mheap_t>(new s_xbt_mheap_t());
274 this->read_bytes(this->heap.get(), sizeof(struct mdesc),
275 remote(this->heap_address), simgrid::mc::ProcessIndexDisabled);
276 this->cache_flags |= MC_PROCESS_CACHE_FLAG_HEAP;
279 /** Refresh the information about the process
281 * Do not use direclty, this is used by the getters when appropriate
282 * in order to have fresh data.
284 void Process::refresh_malloc_info()
286 xbt_assert(mc_mode == MC_MODE_SERVER);
287 if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
288 this->refresh_heap();
289 // Refresh process->heapinfo:
290 size_t count = this->heap->heaplimit + 1;
291 if (this->heap_info.size() < count)
292 this->heap_info.resize(count);
293 this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info),
294 remote(this->heap->heapinfo), simgrid::mc::ProcessIndexDisabled);
295 this->cache_flags |= MC_PROCESS_CACHE_FLAG_MALLOC_INFO;
298 /** @brief Finds the range of the different memory segments and binary paths */
299 void Process::init_memory_map_info()
301 XBT_DEBUG("Get debug information ...");
302 this->maestro_stack_start_ = nullptr;
303 this->maestro_stack_end_ = nullptr;
304 this->object_infos.resize(0);
305 this->binary_info = nullptr;
306 this->libsimgrid_info = nullptr;
308 struct s_mc_memory_map_re res;
310 if(regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
311 xbt_die(".so regexp did not compile");
313 std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
315 const char* current_name = nullptr;
317 this->object_infos.resize(0);
319 for (size_t i=0; i < maps.size(); i++) {
320 simgrid::xbt::VmMap const& reg = maps[i];
321 const char* pathname = maps[i].pathname.c_str();
324 if (maps[i].pathname.empty()) {
325 current_name = nullptr;
329 // [stack], [vvar], [vsyscall], [vdso] ...
330 if (pathname[0] == '[') {
331 if ((reg.prot & PROT_WRITE) && !memcmp(pathname, "[stack]", 7)) {
332 this->maestro_stack_start_ = remote(reg.start_addr);
333 this->maestro_stack_end_ = remote(reg.end_addr);
335 current_name = nullptr;
339 if (current_name && strcmp(current_name, pathname)==0)
342 current_name = pathname;
343 if (!(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
346 const bool is_executable = !i;
347 char* libname = nullptr;
348 if (!is_executable) {
349 libname = get_lib_name(pathname, &res);
352 if (is_filtered_lib(libname)) {
358 std::shared_ptr<simgrid::mc::ObjectInformation> info =
359 simgrid::mc::createObjectInformation(this->memory_map_, pathname);
360 this->object_infos.push_back(info);
362 this->binary_info = info;
363 else if (libname && is_simgrid_lib(libname))
364 this->libsimgrid_info = info;
369 regfree(&res.version_re);
371 // Resolve time (including accross differents objects):
372 for (auto const& object_info : this->object_infos)
373 postProcessObjectInformation(this, object_info.get());
375 xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
376 xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
378 XBT_DEBUG("Get debug information done !");
381 std::shared_ptr<simgrid::mc::ObjectInformation> Process::find_object_info(RemotePtr<void> addr) const
383 for (auto const& object_info : this->object_infos)
384 if (addr.address() >= (std::uint64_t)object_info->start
385 && addr.address() <= (std::uint64_t)object_info->end)
390 std::shared_ptr<ObjectInformation> Process::find_object_info_exec(RemotePtr<void> addr) const
392 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
393 if (addr.address() >= (std::uint64_t) info->start_exec
394 && addr.address() <= (std::uint64_t) info->end_exec)
399 std::shared_ptr<ObjectInformation> Process::find_object_info_rw(RemotePtr<void> addr) const
401 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
402 if (addr.address() >= (std::uint64_t)info->start_rw
403 && addr.address() <= (std::uint64_t)info->end_rw)
408 simgrid::mc::Frame* Process::find_function(RemotePtr<void> ip) const
410 std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
411 return info ? info->find_function((void*) ip.address()) : nullptr;
414 /** Find (one occurence of) the named variable definition
416 simgrid::mc::Variable* Process::find_variable(const char* name) const
418 // First lookup the variable in the executable shared object.
419 // A global variable used directly by the executable code from a library
420 // is reinstanciated in the executable memory .data/.bss.
421 // We need to look up the variable in the execvutable first.
422 if (this->binary_info) {
423 std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
424 simgrid::mc::Variable* var = info->find_variable(name);
429 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
430 simgrid::mc::Variable* var = info->find_variable(name);
438 void Process::read_variable(const char* name, void* target, size_t size) const
440 simgrid::mc::Variable* var = this->find_variable(name);
442 xbt_die("No simple location for this variable");
443 if (!var->type->full_type)
444 xbt_die("Partial type for %s, cannot check size", name);
445 if ((size_t) var->type->full_type->byte_size != size)
446 xbt_die("Unexpected size for %s (expected %zi, was %zi)",
447 name, size, (size_t) var->type->full_type->byte_size);
448 this->read_bytes(target, size, remote(var->address));
451 char* Process::read_string(RemotePtr<void> address) const
457 char* res = (char*) malloc(len);
461 ssize_t c = pread(this->memory_file, res + off, len - off, (off_t) address.address() + off);
466 xbt_die("Could not read from from remote process");
469 xbt_die("Could not read string from remote process");
471 void* p = memchr(res + off, '\0', c);
478 res = (char*) realloc(res, len);
483 const void *Process::read_bytes(void* buffer, std::size_t size,
484 RemotePtr<void> address, int process_index,
485 ReadOptions options) const
487 if (process_index != simgrid::mc::ProcessIndexDisabled) {
488 std::shared_ptr<simgrid::mc::ObjectInformation> const& info =
489 this->find_object_info_rw((void*)address.address());
490 // Segment overlap is not handled.
492 if (info.get() && this->privatized(*info)) {
493 if (process_index < 0)
494 xbt_die("Missing process index");
495 if (process_index >= (int) MC_smpi_process_count())
496 xbt_die("Invalid process index");
498 // Read smpi_privatisation_regions from MCed:
499 smpi_privatisation_region_t remote_smpi_privatisation_regions =
500 mc_model_checker->process().read_variable<smpi_privatisation_region_t>(
501 "smpi_privatisation_regions");
503 s_smpi_privatisation_region_t privatisation_region =
504 mc_model_checker->process().read<s_smpi_privatisation_region_t>(
505 remote(remote_smpi_privatisation_regions + process_index));
507 // Address translation in the privaization segment:
508 size_t offset = address.address() - (std::uint64_t)info->start_rw;
509 address = remote((char*)privatisation_region.address + offset);
514 if (pread_whole(this->memory_file, buffer, size, address.address()) < 0)
515 xbt_die("Read from process %lli failed", (long long) this->pid_);
519 /** Write data to a process memory
521 * @param process the process
522 * @param local local memory address (source)
523 * @param remote target process memory address (target)
524 * @param len data size
526 void Process::write_bytes(const void* buffer, size_t len, RemotePtr<void> address)
528 if (pwrite_whole(this->memory_file, buffer, len, address.address()) < 0)
529 xbt_die("Write to process %lli failed", (long long) this->pid_);
532 void Process::clear_bytes(RemotePtr<void> address, size_t len)
534 pthread_once(&zero_buffer_flag, zero_buffer_init);
536 size_t s = len > zero_buffer_size ? zero_buffer_size : len;
537 this->write_bytes(zero_buffer, s, address);
538 address = remote((char*) address.address() + s);
543 void Process::ignore_region(std::uint64_t addr, std::size_t size)
545 IgnoredRegion region;
549 if (ignored_regions_.empty()) {
550 ignored_regions_.push_back(region);
554 unsigned int cursor = 0;
555 IgnoredRegion* current_region = nullptr;
558 int end = ignored_regions_.size() - 1;
559 while (start <= end) {
560 cursor = (start + end) / 2;
561 current_region = &ignored_regions_[cursor];
562 if (current_region->addr == addr) {
563 if (current_region->size == size)
565 else if (current_region->size < size)
569 } else if (current_region->addr < addr)
575 std::size_t position;
576 if (current_region->addr == addr) {
577 if (current_region->size < size)
578 position = cursor + 1;
581 } else if (current_region->addr < addr)
582 position = cursor + 1;
585 ignored_regions_.insert(
586 ignored_regions_.begin() + position, region);
589 void Process::reset_soft_dirty()
591 if (this->clear_refs_fd_ < 0) {
592 this->clear_refs_fd_ = open_process_file(pid_, "clear_refs", O_WRONLY|O_CLOEXEC);
593 if (this->clear_refs_fd_ < 0)
594 xbt_die("Could not open clear_refs file for soft-dirty tracking. Run as root?");
596 if(::write(this->clear_refs_fd_, "4\n", 2) != 2)
597 xbt_die("Could not reset softdirty bits");
600 void Process::read_pagemap(uint64_t* pagemap, size_t page_start, size_t page_count)
602 if (pagemap_fd_ < 0) {
603 pagemap_fd_ = open_process_file(pid_, "pagemap", O_RDONLY|O_CLOEXEC);
605 xbt_die("Could not open pagemap file for soft-dirty tracking. Run as root?");
607 ssize_t bytesize = sizeof(uint64_t) * page_count;
608 off_t offset = sizeof(uint64_t) * page_start;
609 if (pread_whole(pagemap_fd_, pagemap, bytesize, offset) != bytesize)
610 xbt_die("Could not read pagemap");
613 void Process::ignore_heap(IgnoredHeapRegion const& region)
615 if (ignored_heap_.empty()) {
616 ignored_heap_.push_back(std::move(region));
620 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
623 size_type end = ignored_heap_.size() - 1;
625 // Binary search the position of insertion:
627 while (start <= end) {
628 cursor = start + (end - start) / 2;
629 auto& current_region = ignored_heap_[cursor];
630 if (current_region.address == region.address)
632 else if (current_region.address < region.address)
634 else if (cursor != 0)
641 // Insert it mc_heap_ignore_region_t:
642 if (ignored_heap_[cursor].address < region.address)
644 ignored_heap_.insert( ignored_heap_.begin() + cursor, region);
647 void Process::unignore_heap(void *address, size_t size)
649 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
652 size_type end = ignored_heap_.size() - 1;
656 while (start <= end) {
657 cursor = (start + end) / 2;
658 auto& region = ignored_heap_[cursor];
659 if (region.address == address) {
660 ignored_heap_.erase(ignored_heap_.begin() + cursor);
662 } else if (region.address < address)
664 else if ((char *) region.address <= ((char *) address + size)) {
665 ignored_heap_.erase(ignored_heap_.begin() + cursor);
667 } else if (cursor != 0)
675 void Process::ignore_local_variable(const char *var_name, const char *frame_name)
677 if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
678 frame_name = nullptr;
679 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
681 info->remove_local_variable(var_name, frame_name);
684 std::vector<simgrid::mc::SimixProcessInformation>& Process::simix_processes()
686 xbt_assert(mc_mode != MC_MODE_CLIENT);
687 MC_process_smx_refresh(&mc_model_checker->process());
688 return smx_process_infos;