11 #include <sys/mman.h> // PROT_*
17 #include <libunwind.h>
18 #include <libunwind-ptrace.h>
20 #include <xbt/mmalloc.h>
22 #include "mc_process.h"
23 #include "mc_object_info.h"
24 #include "mc_address_space.h"
26 #include "mc_snapshot.h"
27 #include "mc_ignore.h"
29 #include "mc_server.h"
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_process, mc,
32 "MC process information");
34 static void MC_process_init_memory_map_info(mc_process_t process);
35 static void MC_process_open_memory_file(mc_process_t process);
37 // ***** Destructor callbacks
39 // ***** mc_address_space methods for mc_process
41 static mc_process_t MC_process_get_process(mc_process_t p) {
45 static const s_mc_address_space_class_t mc_process_class = {
46 .read = (void*) &MC_process_read,
47 .get_process = (void*) MC_process_get_process
50 bool MC_is_process(mc_address_space_t p)
52 return p->address_space_class == &mc_process_class;
57 void MC_process_init(mc_process_t process, pid_t pid, int sockfd)
59 process->address_space.address_space_class = &mc_process_class;
60 process->process_flags = MC_PROCESS_NO_FLAG;
61 process->socket = sockfd;
64 process->process_flags |= MC_PROCESS_SELF_FLAG;
65 process->running = true;
67 process->memory_map = MC_get_memory_map(pid);
68 process->memory_file = -1;
69 process->cache_flags = 0;
71 process->heap_info = NULL;
72 MC_process_init_memory_map_info(process);
73 MC_process_open_memory_file(process);
75 // Read std_heap (is a struct mdesc*):
76 dw_variable_t std_heap_var = MC_process_find_variable_by_name(process, "std_heap");
78 xbt_die("No heap information in the target process");
79 if(!std_heap_var->address)
80 xbt_die("No constant address for this variable");
81 MC_process_read(process, MC_ADDRESS_SPACE_READ_FLAGS_NONE,
82 &process->heap_address, std_heap_var->address, sizeof(struct mdesc*),
83 MC_PROCESS_INDEX_DISABLED);
85 process->smx_process_infos = MC_smx_process_info_list_new();
86 process->smx_old_process_infos = MC_smx_process_info_list_new();
88 process->checkpoint_ignore = MC_checkpoint_ignore_new();
90 process->unw_addr_space = unw_create_addr_space(&mc_unw_accessors , __BYTE_ORDER);
91 if (process->process_flags & MC_PROCESS_SELF_FLAG) {
92 process->unw_underlying_addr_space = unw_local_addr_space;
93 process->unw_underlying_context = NULL;
95 process->unw_underlying_addr_space = unw_create_addr_space(&mc_unw_vmread_accessors, __BYTE_ORDER);
96 process->unw_underlying_context = _UPT_create(pid);
100 void MC_process_clear(mc_process_t process)
102 process->address_space.address_space_class = NULL;
103 process->process_flags = MC_PROCESS_NO_FLAG;
106 MC_free_memory_map(process->memory_map);
107 process->memory_map = NULL;
109 process->maestro_stack_start = NULL;
110 process->maestro_stack_end = NULL;
112 xbt_dynar_free(&process->checkpoint_ignore);
114 xbt_dynar_free(&process->smx_process_infos);
115 xbt_dynar_free(&process->smx_old_process_infos);
118 for (i=0; i!=process->object_infos_size; ++i) {
119 MC_free_object_info(&process->object_infos[i]);
121 free(process->object_infos);
122 process->object_infos = NULL;
123 process->object_infos_size = 0;
124 if (process->memory_file >= 0) {
125 close(process->memory_file);
128 if (process->unw_underlying_addr_space != unw_local_addr_space) {
129 unw_destroy_addr_space(process->unw_underlying_addr_space);
130 _UPT_destroy(process->unw_underlying_context);
132 process->unw_underlying_context = NULL;
133 process->unw_underlying_addr_space = NULL;
135 unw_destroy_addr_space(process->unw_addr_space);
136 process->unw_addr_space = NULL;
138 process->cache_flags = 0;
141 process->heap = NULL;
143 free(process->heap_info);
144 process->heap_info = NULL;
147 void MC_process_refresh_heap(mc_process_t process)
149 assert(!MC_process_is_self(process));
150 // Read/dereference/refresh the std_heap pointer:
151 if (!process->heap) {
152 xbt_mheap_t oldheap = mmalloc_set_current_heap(mc_heap);
153 process->heap = malloc(sizeof(struct mdesc));
154 mmalloc_set_current_heap(oldheap);
156 MC_process_read(process, MC_ADDRESS_SPACE_READ_FLAGS_NONE,
157 process->heap, process->heap_address, sizeof(struct mdesc),
158 MC_PROCESS_INDEX_DISABLED
162 void MC_process_refresh_malloc_info(mc_process_t process)
164 assert(!MC_process_is_self(process));
165 if (!(process->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
166 MC_process_refresh_heap(process);
167 // Refresh process->heapinfo:
168 size_t malloc_info_bytesize =
169 (process->heap->heaplimit + 1) * sizeof(malloc_info);
171 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
172 process->heap_info = realloc(process->heap_info, malloc_info_bytesize);
173 mmalloc_set_current_heap(heap);
175 MC_process_read(process, MC_ADDRESS_SPACE_READ_FLAGS_NONE,
177 process->heap->heapinfo, malloc_info_bytesize,
178 MC_PROCESS_INDEX_DISABLED);
181 #define SO_RE "\\.so[\\.0-9]*$"
182 #define VERSION_RE "-[\\.0-9]*$"
184 const char* FILTERED_LIBS[] = {
206 static bool MC_is_simgrid_lib(const char* libname)
208 return !strcmp(libname, "libsimgrid");
211 static bool MC_is_filtered_lib(const char* libname)
213 const size_t n = sizeof(FILTERED_LIBS) / sizeof(const char*);
216 if (strcmp(libname, FILTERED_LIBS[i])==0)
221 struct s_mc_memory_map_re {
226 static char* MC_get_lib_name(const char* pathname, struct s_mc_memory_map_re* res) {
227 const char* map_basename = basename((char*) pathname);
230 if(regexec(&res->so_re, map_basename, 1, &match, 0))
233 char* libname = strndup(map_basename, match.rm_so);
235 // Strip the version suffix:
236 if(libname && !regexec(&res->version_re, libname, 1, &match, 0)) {
237 char* temp = libname;
238 libname = strndup(temp, match.rm_so);
245 /** @brief Finds the range of the different memory segments and binary paths */
246 static void MC_process_init_memory_map_info(mc_process_t process)
248 XBT_DEBUG("Get debug information ...");
249 process->maestro_stack_start = NULL;
250 process->maestro_stack_end = NULL;
251 process->object_infos = NULL;
252 process->object_infos_size = 0;
253 process->binary_info = NULL;
254 process->libsimgrid_info = NULL;
256 struct s_mc_memory_map_re res;
258 if(regcomp(&res.so_re, SO_RE, 0) || regcomp(&res.version_re, VERSION_RE, 0))
259 xbt_die(".so regexp did not compile");
261 memory_map_t maps = process->memory_map;
263 const char* current_name = NULL;
266 for (i=0; i < maps->mapsize; i++) {
267 map_region_t reg = &(maps->regions[i]);
268 const char* pathname = maps->regions[i].pathname;
271 if (maps->regions[i].pathname == NULL) {
276 // [stack], [vvar], [vsyscall], [vdso] ...
277 if (pathname[0] == '[') {
278 if ((reg->prot & PROT_WRITE) && !memcmp(pathname, "[stack]", 7)) {
279 process->maestro_stack_start = reg->start_addr;
280 process->maestro_stack_end = reg->end_addr;
286 if (current_name && strcmp(current_name, pathname)==0)
289 current_name = pathname;
290 if (!(reg->prot & PROT_READ) && (reg->prot & PROT_EXEC))
293 const bool is_executable = !i;
294 char* libname = NULL;
295 if (!is_executable) {
296 libname = MC_get_lib_name(pathname, &res);
299 if (MC_is_filtered_lib(libname)) {
305 mc_object_info_t info =
306 MC_find_object_info(process->memory_map, pathname, is_executable);
307 process->object_infos = (mc_object_info_t*) realloc(process->object_infos,
308 (process->object_infos_size+1) * sizeof(mc_object_info_t*));
309 process->object_infos[process->object_infos_size] = info;
310 process->object_infos_size++;
312 process->binary_info = info;
313 else if (libname && MC_is_simgrid_lib(libname))
314 process->libsimgrid_info = info;
319 regfree(&res.version_re);
321 // Resolve time (including accress differents objects):
322 for (i=0; i!=process->object_infos_size; ++i)
323 MC_post_process_object_info(process, process->object_infos[i]);
325 xbt_assert(process->maestro_stack_start, "Did not find maestro_stack_start");
326 xbt_assert(process->maestro_stack_end, "Did not find maestro_stack_end");
328 XBT_DEBUG("Get debug information done !");
331 mc_object_info_t MC_process_find_object_info(mc_process_t process, const void *addr)
334 for (i = 0; i != process->object_infos_size; ++i) {
335 if (addr >= (void *) process->object_infos[i]->start
336 && addr <= (void *) process->object_infos[i]->end) {
337 return process->object_infos[i];
343 mc_object_info_t MC_process_find_object_info_exec(mc_process_t process, const void *addr)
346 for (i = 0; i != process->object_infos_size; ++i) {
347 if (addr >= (void *) process->object_infos[i]->start_exec
348 && addr <= (void *) process->object_infos[i]->end_exec) {
349 return process->object_infos[i];
355 mc_object_info_t MC_process_find_object_info_rw(mc_process_t process, const void *addr)
358 for (i = 0; i != process->object_infos_size; ++i) {
359 if (addr >= (void *) process->object_infos[i]->start_rw
360 && addr <= (void *) process->object_infos[i]->end_rw) {
361 return process->object_infos[i];
367 // Functions, variables…
369 dw_frame_t MC_process_find_function(mc_process_t process, const void *ip)
371 mc_object_info_t info = MC_process_find_object_info_exec(process, ip);
375 return MC_file_object_info_find_function(info, ip);
378 dw_variable_t MC_process_find_variable_by_name(mc_process_t process, const char* name)
380 const size_t n = process->object_infos_size;
383 // First lookup the variable in the executable shared object.
384 // A global variable used directly by the executable code from a library
385 // is reinstanciated in the executable memory .data/.bss.
386 // We need to look up the variable in the execvutable first.
387 if (process->binary_info) {
388 mc_object_info_t info = process->binary_info;
389 dw_variable_t var = MC_file_object_info_find_variable_by_name(info, name);
394 for (i=0; i!=n; ++i) {
395 mc_object_info_t info =process->object_infos[i];
396 dw_variable_t var = MC_file_object_info_find_variable_by_name(info, name);
404 void MC_process_read_variable(mc_process_t process, const char* name, void* target, size_t size)
406 dw_variable_t var = MC_process_find_variable_by_name(process, name);
408 xbt_die("No simple location for this variable");
409 if (!var->type->full_type)
410 xbt_die("Partial type for %s, cannot check size", name);
411 if (var->type->full_type->byte_size != size)
412 xbt_die("Unexpected size for %s (expected %zi, was %zi)",
413 name, size, (size_t) var->type->full_type->byte_size);
414 MC_process_read(process, MC_PROCESS_NO_FLAG, target, var->address, size,
415 MC_PROCESS_INDEX_ANY);
418 char* MC_process_read_string(mc_process_t process, void* address)
422 if (MC_process_is_self(process))
423 return strdup((char*) address);
426 char* res = malloc(len);
430 ssize_t c = pread(process->memory_file, res + off, len - off, (off_t) address + off);
435 xbt_die("Could not read from from remote process");
438 xbt_die("Could not read string from remote process");
440 void* p = memchr(res + off, '\0', c);
447 res = realloc(res, len);
452 // ***** Memory access
454 int MC_process_vm_open(pid_t pid, int flags)
456 const size_t buffer_size = 30;
457 char buffer[buffer_size];
458 int res = snprintf(buffer, buffer_size, "/proc/%lli/mem", (long long) pid);
459 if (res < 0 || res >= buffer_size) {
460 errno = ENAMETOOLONG;
463 return open(buffer, flags);
466 static void MC_process_open_memory_file(mc_process_t process)
468 if (MC_process_is_self(process) || process->memory_file >= 0)
471 int fd = MC_process_vm_open(process->pid, O_RDWR);
473 xbt_die("Could not open file for process virtual address space");
474 process->memory_file = fd;
477 static ssize_t pread_whole(int fd, void *buf, size_t count, off_t offset)
479 char* buffer = (char*) buf;
480 ssize_t real_count = count;
482 ssize_t res = pread(fd, buffer, count, offset);
489 } else if (errno != EINTR) {
496 static ssize_t pwrite_whole(int fd, const void *buf, size_t count, off_t offset)
498 const char* buffer = (const char*) buf;
499 ssize_t real_count = count;
501 ssize_t res = pwrite(fd, buffer, count, offset);
508 } else if (errno != EINTR) {
515 const void* MC_process_read(mc_process_t process, e_adress_space_read_flags_t flags,
516 void* local, const void* remote, size_t len,
519 if (process_index != MC_PROCESS_INDEX_DISABLED) {
520 mc_object_info_t info = MC_process_find_object_info_rw(process, remote);
521 // Segment overlap is not handled.
522 if (MC_object_info_is_privatized(info)) {
523 if (process_index < 0)
524 xbt_die("Missing process index");
525 // Address translation in the privaization segment:
526 size_t offset = (const char*) remote - info->start_rw;
527 remote = (const char*) remote - offset;
531 if (MC_process_is_self(process)) {
532 if (flags & MC_ADDRESS_SPACE_READ_FLAGS_LAZY)
535 memcpy(local, remote, len);
539 if (pread_whole(process->memory_file, local, len, (off_t) remote) < 0)
540 xbt_die("Read from process %lli failed", (long long) process->pid);
545 const void* MC_process_read_simple(mc_process_t process,
546 void* local, const void* remote, size_t len)
548 e_adress_space_read_flags_t flags = MC_PROCESS_NO_FLAG;
549 int index = MC_PROCESS_INDEX_ANY;
550 MC_process_read(process, flags, local, remote, len, index);
554 const void* MC_process_read_dynar_element(mc_process_t process,
555 void* local, const void* remote_dynar, size_t i, size_t len)
558 MC_process_read_simple(process, &d, remote_dynar, sizeof(d));
560 xbt_die("Out of bound index %zi/%zi", i, d.used);
561 if (len != d.elmsize)
562 xbt_die("Bad size in MC_process_read_dynar_element");
563 MC_process_read_simple(process, local, xbt_dynar_get_ptr(&d, i), len);
567 void MC_process_write(mc_process_t process, const void* local, void* remote, size_t len)
569 if (MC_process_is_self(process)) {
570 memcpy(remote, local, len);
572 if (pwrite_whole(process->memory_file, local, len, (off_t) remote) < 0)
573 xbt_die("Write to process %lli failed", (long long) process->pid);
577 unsigned long MC_process_read_dynar_length(mc_process_t process, const void* remote_dynar)
582 MC_process_read_simple(process, &res,
583 &((xbt_dynar_t)remote_dynar)->used, sizeof(res));
587 static pthread_once_t zero_buffer_flag = PTHREAD_ONCE_INIT;
588 static const void* zero_buffer;
589 static const int zero_buffer_size = 10 * 4096;
591 static void MC_zero_buffer_init(void)
593 int fd = open("/dev/zero", O_RDONLY);
595 xbt_die("Could not open /dev/zero");
596 zero_buffer = mmap(NULL, zero_buffer_size, PROT_READ, MAP_SHARED, fd, 0);
597 if (zero_buffer == MAP_FAILED)
598 xbt_die("Could not map the zero buffer");
602 void MC_process_clear_memory(mc_process_t process, void* remote, size_t len)
604 if (MC_process_is_self(process)) {
605 memset(remote, 0, len);
607 pthread_once(&zero_buffer_flag, MC_zero_buffer_init);
609 size_t s = len > zero_buffer_size ? zero_buffer_size : len;
610 MC_process_write(process, zero_buffer, remote, s);
611 remote = (char*) remote + s;
617 void MC_simcall_handle(smx_simcall_t req, int value)
619 if (MC_process_is_self(&mc_model_checker->process)) {
620 SIMIX_simcall_handle(req, value);
625 mc_smx_process_info_t pi = NULL;
627 xbt_dynar_foreach_ptr(mc_model_checker->process.smx_process_infos, i, pi) {
628 if (req == &pi->copy.simcall) {
629 MC_server_simcall_handle(&mc_model_checker->process, pi->copy.pid, value);
634 xbt_die("Could not find the request");