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>
29 #include <xbt/mmalloc.h>
31 #include "src/mc/mc_unw.h"
32 #include "src/mc/mc_snapshot.h"
33 #include "src/mc/mc_ignore.h"
34 #include "src/mc/mc_smx.h"
36 #include "src/mc/Process.hpp"
37 #include "src/mc/AddressSpace.hpp"
38 #include "src/mc/ObjectInformation.hpp"
39 #include "src/mc/Variable.hpp"
41 using simgrid::mc::remote;
43 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_process, mc,
44 "MC process information");
51 #define SO_RE "\\.so[\\.0-9]*$"
52 #define VERSION_RE "-[\\.0-9-]*$"
54 // In lexicographic order (but this is currently not used in the code):
55 static const char *const filtered_libraries[] = {
85 static bool is_simgrid_lib(const char* libname)
87 return !strcmp(libname, "libsimgrid");
90 static bool is_filtered_lib(const char* libname)
92 for (const char* filtered_lib : filtered_libraries)
93 if (strcmp(libname, filtered_lib)==0)
98 struct s_mc_memory_map_re {
103 static char* get_lib_name(const char* pathname, struct s_mc_memory_map_re* res)
105 char* map_basename = xbt_basename(pathname);
108 if(regexec(&res->so_re, map_basename, 1, &match, 0)) {
113 char* libname = strndup(map_basename, match.rm_so);
115 map_basename = nullptr;
117 // Strip the version suffix:
118 if(libname && !regexec(&res->version_re, libname, 1, &match, 0)) {
119 char* temp = libname;
120 libname = strndup(temp, match.rm_so);
127 static ssize_t pread_whole(int fd, void *buf, size_t count, std::uint64_t offset)
129 char* buffer = (char*) buf;
130 ssize_t real_count = count;
132 ssize_t res = pread(fd, buffer, count, (std::int64_t) offset);
139 else if (errno != EINTR) {
140 perror("pread_whole");
147 static ssize_t pwrite_whole(int fd, const void *buf, size_t count, off_t offset)
149 const char* buffer = (const char*) buf;
150 ssize_t real_count = count;
152 ssize_t res = pwrite(fd, buffer, count, offset);
159 else if (errno != EINTR)
165 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
166 static const void* zero_buffer;
167 static const size_t zero_buffer_size = 10 * 4096;
169 static void zero_buffer_init(void)
171 int fd = open("/dev/zero", O_RDONLY);
173 xbt_die("Could not open /dev/zero");
174 zero_buffer = mmap(nullptr, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
175 if (zero_buffer == MAP_FAILED)
176 xbt_die("Could not map the zero buffer");
181 int open_process_file(pid_t pid, const char* file, int flags)
184 snprintf(buff, sizeof(buff), "/proc/%li/%s", (long) pid, file);
185 return open(buff, flags);
188 int open_vm(pid_t pid, int flags)
190 const size_t buffer_size = 30;
191 char buffer[buffer_size];
192 int res = snprintf(buffer, buffer_size, "/proc/%lli/mem", (long long) pid);
193 if (res < 0 || (size_t) res >= buffer_size) {
194 errno = ENAMETOOLONG;
197 return open(buffer, flags);
202 Process::Process(pid_t pid, int sockfd) :
203 AddressSpace(this), pid_(pid), channel_(sockfd), running_(true)
208 this->memory_map_ = simgrid::xbt::get_memory_map(this->pid_);
209 this->init_memory_map_info();
211 int fd = open_vm(this->pid_, O_RDWR);
213 xbt_die("Could not open file for process virtual address space");
214 this->memory_file = fd;
216 // Read std_heap (is a struct mdesc*):
217 simgrid::mc::Variable* std_heap_var = this->find_variable("__mmalloc_default_mdp");
219 xbt_die("No heap information in the target process");
220 if(!std_heap_var->address)
221 xbt_die("No constant address for this variable");
222 this->read_bytes(&this->heap_address, sizeof(struct mdesc*),
223 remote(std_heap_var->address),
224 simgrid::mc::ProcessIndexDisabled);
226 this->smx_process_infos.clear();
227 this->smx_old_process_infos.clear();
228 this->unw_addr_space = simgrid::mc::UnwindContext::createUnwindAddressSpace();
229 this->unw_underlying_addr_space = simgrid::unw::create_addr_space();
230 this->unw_underlying_context = simgrid::unw::create_context(
231 this->unw_underlying_addr_space, this->pid_);
236 if (this->memory_file >= 0)
237 close(this->memory_file);
239 if (this->unw_underlying_addr_space != unw_local_addr_space) {
240 unw_destroy_addr_space(this->unw_underlying_addr_space);
241 _UPT_destroy(this->unw_underlying_context);
244 unw_destroy_addr_space(this->unw_addr_space);
246 if (this->clear_refs_fd_ >= 0)
247 close(this->clear_refs_fd_);
248 if (this->pagemap_fd_ >= 0)
249 close(this->pagemap_fd_);
252 /** Refresh the information about the process
254 * Do not use direclty, this is used by the getters when appropriate
255 * in order to have fresh data.
257 void Process::refresh_heap()
259 // Read/dereference/refresh the std_heap pointer:
261 this->heap = std::unique_ptr<s_xbt_mheap_t>(new s_xbt_mheap_t());
262 this->read_bytes(this->heap.get(), sizeof(struct mdesc),
263 remote(this->heap_address), simgrid::mc::ProcessIndexDisabled);
264 this->cache_flags_ |= Process::cache_heap;
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_malloc_info()
274 // Refresh process->heapinfo:
275 if (this->cache_flags_ & Process::cache_malloc)
277 size_t count = this->heap->heaplimit + 1;
278 if (this->heap_info.size() < count)
279 this->heap_info.resize(count);
280 this->read_bytes(this->heap_info.data(), count * sizeof(malloc_info),
281 remote(this->heap->heapinfo), simgrid::mc::ProcessIndexDisabled);
282 this->cache_flags_ |= Process::cache_malloc;
285 /** @brief Finds the range of the different memory segments and binary paths */
286 void Process::init_memory_map_info()
288 XBT_DEBUG("Get debug information ...");
289 this->maestro_stack_start_ = nullptr;
290 this->maestro_stack_end_ = nullptr;
291 this->object_infos.resize(0);
292 this->binary_info = nullptr;
293 this->libsimgrid_info = nullptr;
295 struct s_mc_memory_map_re res;
297 if(regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
298 xbt_die(".so regexp did not compile");
300 std::vector<simgrid::xbt::VmMap> const& maps = this->memory_map_;
302 const char* current_name = nullptr;
304 this->object_infos.clear();
306 for (size_t i=0; i < maps.size(); i++) {
307 simgrid::xbt::VmMap const& reg = maps[i];
308 const char* pathname = maps[i].pathname.c_str();
311 if (maps[i].pathname.empty()) {
312 current_name = nullptr;
316 // [stack], [vvar], [vsyscall], [vdso] ...
317 if (pathname[0] == '[') {
318 if ((reg.prot & PROT_WRITE) && !memcmp(pathname, "[stack]", 7)) {
319 this->maestro_stack_start_ = remote(reg.start_addr);
320 this->maestro_stack_end_ = remote(reg.end_addr);
322 current_name = nullptr;
326 if (current_name && strcmp(current_name, pathname)==0)
329 current_name = pathname;
330 if (!(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
333 const bool is_executable = !i;
334 char* libname = nullptr;
335 if (!is_executable) {
336 libname = get_lib_name(pathname, &res);
339 if (is_filtered_lib(libname)) {
345 std::shared_ptr<simgrid::mc::ObjectInformation> info =
346 simgrid::mc::createObjectInformation(this->memory_map_, pathname);
347 this->object_infos.push_back(info);
349 this->binary_info = info;
350 else if (libname && is_simgrid_lib(libname))
351 this->libsimgrid_info = info;
356 regfree(&res.version_re);
358 // Resolve time (including accross differents objects):
359 for (auto const& object_info : this->object_infos)
360 postProcessObjectInformation(this, object_info.get());
362 xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
363 xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
365 XBT_DEBUG("Get debug information done !");
368 std::shared_ptr<simgrid::mc::ObjectInformation> Process::find_object_info(RemotePtr<void> addr) const
370 for (auto const& object_info : this->object_infos)
371 if (addr.address() >= (std::uint64_t)object_info->start
372 && addr.address() <= (std::uint64_t)object_info->end)
377 std::shared_ptr<ObjectInformation> Process::find_object_info_exec(RemotePtr<void> addr) const
379 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
380 if (addr.address() >= (std::uint64_t) info->start_exec
381 && addr.address() <= (std::uint64_t) info->end_exec)
386 std::shared_ptr<ObjectInformation> Process::find_object_info_rw(RemotePtr<void> addr) const
388 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
389 if (addr.address() >= (std::uint64_t)info->start_rw
390 && addr.address() <= (std::uint64_t)info->end_rw)
395 simgrid::mc::Frame* Process::find_function(RemotePtr<void> ip) const
397 std::shared_ptr<simgrid::mc::ObjectInformation> info = this->find_object_info_exec(ip);
398 return info ? info->find_function((void*) ip.address()) : nullptr;
401 /** Find (one occurence of) the named variable definition
403 simgrid::mc::Variable* Process::find_variable(const char* name) const
405 // First lookup the variable in the executable shared object.
406 // A global variable used directly by the executable code from a library
407 // is reinstanciated in the executable memory .data/.bss.
408 // We need to look up the variable in the execvutable first.
409 if (this->binary_info) {
410 std::shared_ptr<simgrid::mc::ObjectInformation> const& info = this->binary_info;
411 simgrid::mc::Variable* var = info->find_variable(name);
416 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info : this->object_infos) {
417 simgrid::mc::Variable* var = info->find_variable(name);
425 void Process::read_variable(const char* name, void* target, size_t size) const
427 simgrid::mc::Variable* var = this->find_variable(name);
429 xbt_die("No simple location for this variable");
430 if (!var->type->full_type)
431 xbt_die("Partial type for %s, cannot check size", name);
432 if ((size_t) var->type->full_type->byte_size != size)
433 xbt_die("Unexpected size for %s (expected %zi, was %zi)",
434 name, size, (size_t) var->type->full_type->byte_size);
435 this->read_bytes(target, size, remote(var->address));
438 char* Process::read_string(RemotePtr<void> address) const
444 char* res = (char*) malloc(len);
448 ssize_t c = pread(this->memory_file, res + off, len - off, (off_t) address.address() + off);
453 xbt_die("Could not read from from remote process");
456 xbt_die("Could not read string from remote process");
458 void* p = memchr(res + off, '\0', c);
465 res = (char*) realloc(res, len);
470 const void *Process::read_bytes(void* buffer, std::size_t size,
471 RemotePtr<void> address, int process_index,
472 ReadOptions options) const
474 if (process_index != simgrid::mc::ProcessIndexDisabled) {
475 std::shared_ptr<simgrid::mc::ObjectInformation> const& info =
476 this->find_object_info_rw((void*)address.address());
477 // Segment overlap is not handled.
479 if (info.get() && this->privatized(*info)) {
480 if (process_index < 0)
481 xbt_die("Missing process index");
482 if (process_index >= (int) MC_smpi_process_count())
483 xbt_die("Invalid process index");
485 // Read smpi_privatisation_regions from MCed:
486 smpi_privatisation_region_t remote_smpi_privatisation_regions =
487 mc_model_checker->process().read_variable<smpi_privatisation_region_t>(
488 "smpi_privatisation_regions");
490 s_smpi_privatisation_region_t privatisation_region =
491 mc_model_checker->process().read<s_smpi_privatisation_region_t>(
492 remote(remote_smpi_privatisation_regions + process_index));
494 // Address translation in the privaization segment:
495 size_t offset = address.address() - (std::uint64_t)info->start_rw;
496 address = remote((char*)privatisation_region.address + offset);
501 if (pread_whole(this->memory_file, buffer, size, address.address()) < 0)
502 xbt_die("Read from process %lli failed", (long long) this->pid_);
506 /** Write data to a process memory
508 * @param process the process
509 * @param local local memory address (source)
510 * @param remote target process memory address (target)
511 * @param len data size
513 void Process::write_bytes(const void* buffer, size_t len, RemotePtr<void> address)
515 if (pwrite_whole(this->memory_file, buffer, len, address.address()) < 0)
516 xbt_die("Write to process %lli failed", (long long) this->pid_);
519 void Process::clear_bytes(RemotePtr<void> address, size_t len)
521 pthread_once(&zero_buffer_flag, zero_buffer_init);
523 size_t s = len > zero_buffer_size ? zero_buffer_size : len;
524 this->write_bytes(zero_buffer, s, address);
525 address = remote((char*) address.address() + s);
530 void Process::ignore_region(std::uint64_t addr, std::size_t size)
532 IgnoredRegion region;
536 if (ignored_regions_.empty()) {
537 ignored_regions_.push_back(region);
541 unsigned int cursor = 0;
542 IgnoredRegion* current_region = nullptr;
545 int end = ignored_regions_.size() - 1;
546 while (start <= end) {
547 cursor = (start + end) / 2;
548 current_region = &ignored_regions_[cursor];
549 if (current_region->addr == addr) {
550 if (current_region->size == size)
552 else if (current_region->size < size)
556 } else if (current_region->addr < addr)
562 std::size_t position;
563 if (current_region->addr == addr) {
564 if (current_region->size < size)
565 position = cursor + 1;
568 } else if (current_region->addr < addr)
569 position = cursor + 1;
572 ignored_regions_.insert(
573 ignored_regions_.begin() + position, region);
576 void Process::reset_soft_dirty()
578 if (this->clear_refs_fd_ < 0) {
579 this->clear_refs_fd_ = open_process_file(pid_, "clear_refs", O_WRONLY|O_CLOEXEC);
580 if (this->clear_refs_fd_ < 0)
581 xbt_die("Could not open clear_refs file for soft-dirty tracking. Run as root?");
583 if(::write(this->clear_refs_fd_, "4\n", 2) != 2)
584 xbt_die("Could not reset softdirty bits");
587 void Process::read_pagemap(uint64_t* pagemap, size_t page_start, size_t page_count)
589 if (pagemap_fd_ < 0) {
590 pagemap_fd_ = open_process_file(pid_, "pagemap", O_RDONLY|O_CLOEXEC);
592 xbt_die("Could not open pagemap file for soft-dirty tracking. Run as root?");
594 ssize_t bytesize = sizeof(uint64_t) * page_count;
595 off_t offset = sizeof(uint64_t) * page_start;
596 if (pread_whole(pagemap_fd_, pagemap, bytesize, offset) != bytesize)
597 xbt_die("Could not read pagemap");
600 void Process::ignore_heap(IgnoredHeapRegion const& region)
602 if (ignored_heap_.empty()) {
603 ignored_heap_.push_back(std::move(region));
607 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
610 size_type end = ignored_heap_.size() - 1;
612 // Binary search the position of insertion:
614 while (start <= end) {
615 cursor = start + (end - start) / 2;
616 auto& current_region = ignored_heap_[cursor];
617 if (current_region.address == region.address)
619 else if (current_region.address < region.address)
621 else if (cursor != 0)
628 // Insert it mc_heap_ignore_region_t:
629 if (ignored_heap_[cursor].address < region.address)
631 ignored_heap_.insert( ignored_heap_.begin() + cursor, region);
634 void Process::unignore_heap(void *address, size_t size)
636 typedef std::vector<IgnoredHeapRegion>::size_type size_type;
639 size_type end = ignored_heap_.size() - 1;
643 while (start <= end) {
644 cursor = (start + end) / 2;
645 auto& region = ignored_heap_[cursor];
646 if (region.address == address) {
647 ignored_heap_.erase(ignored_heap_.begin() + cursor);
649 } else if (region.address < address)
651 else if ((char *) region.address <= ((char *) address + size)) {
652 ignored_heap_.erase(ignored_heap_.begin() + cursor);
654 } else if (cursor != 0)
662 void Process::ignore_local_variable(const char *var_name, const char *frame_name)
664 if (frame_name != nullptr && strcmp(frame_name, "*") == 0)
665 frame_name = nullptr;
666 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
668 info->remove_local_variable(var_name, frame_name);
671 std::vector<simgrid::mc::SimixProcessInformation>& Process::simix_processes()
673 this->refresh_simix();
674 return smx_process_infos;
677 std::vector<simgrid::mc::SimixProcessInformation>& Process::old_simix_processes()
679 this->refresh_simix();
680 return smx_old_process_infos;