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. */
13 #include <sys/types.h>
17 #include <sys/mman.h> // PROT_*
23 #include <libunwind.h>
24 #include <libunwind-ptrace.h>
26 #include <xbt/mmalloc.h>
28 #include "mc_process.h"
29 #include "mc_object_info.h"
30 #include "AddressSpace.hpp"
32 #include "mc_snapshot.h"
33 #include "mc_ignore.h"
35 #include "mc_server.h"
37 using simgrid::mc::remote;
41 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_process, mc,
42 "MC process information");
46 #define SO_RE "\\.so[\\.0-9]*$"
47 #define VERSION_RE "-[\\.0-9]*$"
49 static const char *const FILTERED_LIBS[] = {
71 static bool MC_is_simgrid_lib(const char* libname)
73 return !strcmp(libname, "libsimgrid");
76 static bool MC_is_filtered_lib(const char* libname)
78 for (const char* filtered_lib : FILTERED_LIBS)
79 if (strcmp(libname, filtered_lib)==0)
84 struct s_mc_memory_map_re {
89 static char* MC_get_lib_name(const char* pathname, struct s_mc_memory_map_re* res)
91 const char* map_basename = basename((char*) pathname);
94 if(regexec(&res->so_re, map_basename, 1, &match, 0))
97 char* libname = strndup(map_basename, match.rm_so);
99 // Strip the version suffix:
100 if(libname && !regexec(&res->version_re, libname, 1, &match, 0)) {
101 char* temp = libname;
102 libname = strndup(temp, match.rm_so);
109 static ssize_t pread_whole(int fd, void *buf, size_t count, off_t offset)
111 char* buffer = (char*) buf;
112 ssize_t real_count = count;
114 ssize_t res = pread(fd, buffer, count, offset);
121 } else if (errno != EINTR) {
128 static ssize_t pwrite_whole(int fd, const void *buf, size_t count, off_t offset)
130 const char* buffer = (const char*) buf;
131 ssize_t real_count = count;
133 ssize_t res = pwrite(fd, buffer, count, offset);
140 } else if (errno != EINTR) {
147 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
148 static const void* zero_buffer;
149 static const size_t zero_buffer_size = 10 * 4096;
151 static void MC_zero_buffer_init(void)
153 int fd = open("/dev/zero", O_RDONLY);
155 xbt_die("Could not open /dev/zero");
156 zero_buffer = mmap(NULL, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
157 if (zero_buffer == MAP_FAILED)
158 xbt_die("Could not map the zero buffer");
167 int open_vm(pid_t pid, int flags)
169 const size_t buffer_size = 30;
170 char buffer[buffer_size];
171 int res = snprintf(buffer, buffer_size, "/proc/%lli/mem", (long long) pid);
172 if (res < 0 || (size_t) res >= buffer_size) {
173 errno = ENAMETOOLONG;
176 return open(buffer, flags);
188 Process::Process(pid_t pid, int sockfd)
190 Process* process = this;
192 process->process_flags = MC_PROCESS_NO_FLAG;
193 process->socket_ = sockfd;
196 process->process_flags |= MC_PROCESS_SELF_FLAG;
197 process->running_ = true;
198 process->status_ = 0;
199 process->memory_map_ = get_memory_map(pid);
200 process->cache_flags = MC_PROCESS_CACHE_FLAG_NONE;
201 process->heap = NULL;
202 process->heap_info = NULL;
203 process->init_memory_map_info();
205 // Open the memory file
206 if (process->is_self())
207 process->memory_file = -1;
209 int fd = open_vm(process->pid_, O_RDWR);
211 xbt_die("Could not open file for process virtual address space");
212 process->memory_file = fd;
215 // Read std_heap (is a struct mdesc*):
216 dw_variable_t std_heap_var = process->find_variable("__mmalloc_default_mdp");
218 xbt_die("No heap information in the target process");
219 if(!std_heap_var->address)
220 xbt_die("No constant address for this variable");
221 process->read_bytes(&process->heap_address, sizeof(struct mdesc*),
222 remote(std_heap_var->address),
223 simgrid::mc::ProcessIndexDisabled);
225 process->smx_process_infos = MC_smx_process_info_list_new();
226 process->smx_old_process_infos = MC_smx_process_info_list_new();
228 process->unw_addr_space = unw_create_addr_space(&mc_unw_accessors , __BYTE_ORDER);
229 if (process->process_flags & MC_PROCESS_SELF_FLAG) {
230 process->unw_underlying_addr_space = unw_local_addr_space;
231 process->unw_underlying_context = NULL;
233 process->unw_underlying_addr_space = unw_create_addr_space(&mc_unw_vmread_accessors, __BYTE_ORDER);
234 process->unw_underlying_context = _UPT_create(pid);
240 Process* process = this;
242 if (this->socket_ >= 0 && close(this->socket_) < 0)
243 xbt_die("Could not close communication socket");
245 process->process_flags = MC_PROCESS_NO_FLAG;
248 process->maestro_stack_start_ = nullptr;
249 process->maestro_stack_end_ = nullptr;
251 xbt_dynar_free(&process->smx_process_infos);
252 xbt_dynar_free(&process->smx_old_process_infos);
255 for (i=0; i!=process->object_infos_size; ++i) {
256 MC_free_object_info(&process->object_infos[i]);
258 free(process->object_infos);
259 process->object_infos = NULL;
260 process->object_infos_size = 0;
261 if (process->memory_file >= 0) {
262 close(process->memory_file);
265 if (process->unw_underlying_addr_space != unw_local_addr_space) {
266 unw_destroy_addr_space(process->unw_underlying_addr_space);
267 _UPT_destroy(process->unw_underlying_context);
269 process->unw_underlying_context = NULL;
270 process->unw_underlying_addr_space = NULL;
272 unw_destroy_addr_space(process->unw_addr_space);
273 process->unw_addr_space = NULL;
275 process->cache_flags = MC_PROCESS_CACHE_FLAG_NONE;
278 process->heap = NULL;
280 free(process->heap_info);
281 process->heap_info = NULL;
284 /** Refresh the information about the process
286 * Do not use direclty, this is used by the getters when appropriate
287 * in order to have fresh data.
289 void Process::refresh_heap()
291 xbt_assert(mc_mode == MC_MODE_SERVER);
292 xbt_assert(!this->is_self());
293 // Read/dereference/refresh the std_heap pointer:
295 this->heap = (struct mdesc*) malloc(sizeof(struct mdesc));
297 this->read_bytes(this->heap, sizeof(struct mdesc), remote(this->heap_address),
298 simgrid::mc::ProcessIndexDisabled);
299 this->cache_flags |= MC_PROCESS_CACHE_FLAG_HEAP;
302 /** Refresh the information about the process
304 * Do not use direclty, this is used by the getters when appropriate
305 * in order to have fresh data.
307 void Process::refresh_malloc_info()
309 xbt_assert(mc_mode == MC_MODE_SERVER);
310 xbt_assert(!this->is_self());
311 if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
312 this->refresh_heap();
313 // Refresh process->heapinfo:
314 size_t malloc_info_bytesize =
315 (this->heap->heaplimit + 1) * sizeof(malloc_info);
316 this->heap_info = (malloc_info*) realloc(this->heap_info, malloc_info_bytesize);
317 this->read_bytes(this->heap_info, malloc_info_bytesize,
318 remote(this->heap->heapinfo), simgrid::mc::ProcessIndexDisabled);
319 this->cache_flags |= MC_PROCESS_CACHE_FLAG_MALLOC_INFO;
322 /** @brief Finds the range of the different memory segments and binary paths */
323 void Process::init_memory_map_info()
325 XBT_DEBUG("Get debug information ...");
326 this->maestro_stack_start_ = nullptr;
327 this->maestro_stack_end_ = nullptr;
328 this->object_infos = NULL;
329 this->object_infos_size = 0;
330 this->binary_info = NULL;
331 this->libsimgrid_info = NULL;
333 struct s_mc_memory_map_re res;
335 if(regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
336 xbt_die(".so regexp did not compile");
338 std::vector<simgrid::mc::VmMap> const& maps = this->memory_map_;
340 const char* current_name = NULL;
342 for (size_t i=0; i < maps.size(); i++) {
343 simgrid::mc::VmMap const& reg = maps[i];
344 const char* pathname = maps[i].pathname.c_str();
347 if (maps[i].pathname.empty()) {
352 // [stack], [vvar], [vsyscall], [vdso] ...
353 if (pathname[0] == '[') {
354 if ((reg.prot & PROT_WRITE) && !memcmp(pathname, "[stack]", 7)) {
355 this->maestro_stack_start_ = remote(reg.start_addr);
356 this->maestro_stack_end_ = remote(reg.end_addr);
362 if (current_name && strcmp(current_name, pathname)==0)
365 current_name = pathname;
366 if (!(reg.prot & PROT_READ) && (reg.prot & PROT_EXEC))
369 const bool is_executable = !i;
370 char* libname = NULL;
371 if (!is_executable) {
372 libname = MC_get_lib_name(pathname, &res);
375 if (MC_is_filtered_lib(libname)) {
381 mc_object_info_t info =
382 MC_find_object_info(this->memory_map_, pathname, is_executable);
383 this->object_infos = (mc_object_info_t*) realloc(this->object_infos,
384 (this->object_infos_size+1) * sizeof(mc_object_info_t*));
385 this->object_infos[this->object_infos_size] = info;
386 this->object_infos_size++;
388 this->binary_info = info;
389 else if (libname && MC_is_simgrid_lib(libname))
390 this->libsimgrid_info = info;
395 regfree(&res.version_re);
397 // Resolve time (including accross differents objects):
398 for (size_t i=0; i!=this->object_infos_size; ++i)
399 MC_post_process_object_info(this, this->object_infos[i]);
401 xbt_assert(this->maestro_stack_start_, "Did not find maestro_stack_start");
402 xbt_assert(this->maestro_stack_end_, "Did not find maestro_stack_end");
404 XBT_DEBUG("Get debug information done !");
407 mc_object_info_t Process::find_object_info(remote_ptr<void> addr) const
410 for (i = 0; i != this->object_infos_size; ++i) {
411 if (addr.address() >= (std::uint64_t)this->object_infos[i]->start
412 && addr.address() <= (std::uint64_t)this->object_infos[i]->end) {
413 return this->object_infos[i];
419 mc_object_info_t Process::find_object_info_exec(remote_ptr<void> addr) const
422 for (i = 0; i != this->object_infos_size; ++i) {
423 if (addr.address() >= (std::uint64_t)this->object_infos[i]->start_exec
424 && addr.address() <= (std::uint64_t)this->object_infos[i]->end_exec) {
425 return this->object_infos[i];
431 mc_object_info_t Process::find_object_info_rw(remote_ptr<void> addr) const
434 for (i = 0; i != this->object_infos_size; ++i) {
435 if (addr.address() >= (std::uint64_t)this->object_infos[i]->start_rw
436 && addr.address() <= (std::uint64_t)this->object_infos[i]->end_rw) {
437 return this->object_infos[i];
443 dw_frame_t Process::find_function(remote_ptr<void> ip) const
445 mc_object_info_t info = this->find_object_info_exec(ip);
449 return MC_file_object_info_find_function(info, (void*) ip.address());
452 /** Find (one occurence of) the named variable definition
454 dw_variable_t Process::find_variable(const char* name) const
456 const size_t n = this->object_infos_size;
459 // First lookup the variable in the executable shared object.
460 // A global variable used directly by the executable code from a library
461 // is reinstanciated in the executable memory .data/.bss.
462 // We need to look up the variable in the execvutable first.
463 if (this->binary_info) {
464 mc_object_info_t info = this->binary_info;
465 dw_variable_t var = MC_file_object_info_find_variable_by_name(info, name);
470 for (i=0; i!=n; ++i) {
471 mc_object_info_t info = this->object_infos[i];
472 dw_variable_t var = MC_file_object_info_find_variable_by_name(info, name);
480 void Process::read_variable(const char* name, void* target, size_t size) const
482 dw_variable_t var = this->find_variable(name);
484 xbt_die("No simple location for this variable");
485 if (!var->type->full_type)
486 xbt_die("Partial type for %s, cannot check size", name);
487 if ((size_t) var->type->full_type->byte_size != size)
488 xbt_die("Unexpected size for %s (expected %zi, was %zi)",
489 name, size, (size_t) var->type->full_type->byte_size);
490 this->read_bytes(target, size, remote(var->address));
493 char* Process::read_string(remote_ptr<void> address) const
498 return strdup((char*) address.address());
501 char* res = (char*) malloc(len);
505 ssize_t c = pread(this->memory_file, res + off, len - off, (off_t) address.address() + off);
510 xbt_die("Could not read from from remote process");
513 xbt_die("Could not read string from remote process");
515 void* p = memchr(res + off, '\0', c);
522 res = (char*) realloc(res, len);
527 const void *Process::read_bytes(void* buffer, std::size_t size,
528 remote_ptr<void> address, int process_index,
529 AddressSpace::ReadMode mode) const
531 if (process_index != simgrid::mc::ProcessIndexDisabled) {
532 mc_object_info_t info = this->find_object_info_rw((void*)address.address());
533 // Segment overlap is not handled.
534 if (MC_object_info_is_privatized(info)) {
535 if (process_index < 0)
536 xbt_die("Missing process index");
537 if (process_index >= (int) MC_smpi_process_count())
538 xbt_die("Invalid process index");
540 // Read smpi_privatisation_regions from MCed:
541 smpi_privatisation_region_t remote_smpi_privatisation_regions =
542 mc_model_checker->process().read_variable<smpi_privatisation_region_t>(
543 "smpi_privatisation_regions");
545 s_smpi_privatisation_region_t privatisation_region =
546 mc_model_checker->process().read<s_smpi_privatisation_region_t>(
547 remote(remote_smpi_privatisation_regions + process_index));
549 // Address translation in the privaization segment:
550 size_t offset = address.address() - (std::uint64_t)info->start_rw;
551 address = remote((char*)privatisation_region.address + offset);
555 if (this->is_self()) {
556 if (mode == simgrid::mc::AddressSpace::Lazy)
557 return (void*)address.address();
559 memcpy(buffer, (void*)address.address(), size);
563 if (pread_whole(this->memory_file, buffer, size, (off_t) address.address()) < 0)
564 xbt_die("Read from process %lli failed", (long long) this->pid_);
569 /** Write data to a process memory
571 * @param process the process
572 * @param local local memory address (source)
573 * @param remote target process memory address (target)
574 * @param len data size
576 void Process::write_bytes(const void* buffer, size_t len, remote_ptr<void> address)
578 if (this->is_self()) {
579 memcpy((void*)address.address(), buffer, len);
581 if (pwrite_whole(this->memory_file, buffer, len, address.address()) < 0)
582 xbt_die("Write to process %lli failed", (long long) this->pid_);
586 void Process::clear_bytes(remote_ptr<void> address, size_t len)
588 if (this->is_self()) {
589 memset((void*)address.address(), 0, len);
591 pthread_once(&zero_buffer_flag, MC_zero_buffer_init);
593 size_t s = len > zero_buffer_size ? zero_buffer_size : len;
594 this->write_bytes(zero_buffer, s, address);
595 address = remote((char*) address.address() + s);
601 void Process::ignore_region(std::uint64_t addr, std::size_t size)
603 IgnoredRegion region;
607 if (ignored_regions_.empty()) {
608 ignored_regions_.push_back(region);
612 unsigned int cursor = 0;
613 IgnoredRegion* current_region = nullptr;
616 int end = ignored_regions_.size() - 1;
617 while (start <= end) {
618 cursor = (start + end) / 2;
619 current_region = &ignored_regions_[cursor];
620 if (current_region->addr == addr) {
621 if (current_region->size == size)
623 else if (current_region->size < size)
627 } else if (current_region->addr < addr)
633 std::size_t position;
634 if (current_region->addr == addr) {
635 if (current_region->size < size) {
636 position = cursor + 1;
640 } else if (current_region->addr < addr) {
641 position = cursor + 1;
645 ignored_regions_.insert(
646 ignored_regions_.begin() + position, region);