1 /* Copyright (c) 2008-2013 Da SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "mc_private.h"
8 #include "xbt/module.h"
10 #include "../simix/smx_private.h"
12 #include <libunwind.h>
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc,
15 "Logging specific to mc_checkpoint");
17 void *start_text_libsimgrid;
18 void *start_plt_libsimgrid, *end_plt_libsimgrid;
19 void *start_got_plt_libsimgrid, *end_got_plt_libsimgrid;
20 void *start_plt_binary, *end_plt_binary;
21 void *start_got_plt_binary, *end_got_plt_binary;
22 char *libsimgrid_path;
23 void *start_data_libsimgrid, *start_bss_libsimgrid;
24 void *start_data_binary, *start_bss_binary;
25 void *start_text_binary;
27 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size);
28 static void MC_region_restore(mc_mem_region_t reg);
29 static void MC_region_destroy(mc_mem_region_t reg);
31 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size);
33 static void add_value(xbt_dynar_t *list, const char *type, unsigned long int val);
34 static xbt_dynar_t take_snapshot_stacks(mc_snapshot_t *s, void *heap);
35 static xbt_strbuff_t get_local_variables_values(void *stack_context, void *heap);
36 static void print_local_variables_values(xbt_dynar_t all_variables);
37 static void *get_stack_pointer(void *stack_context, void *heap);
39 static void snapshot_stack_free(mc_snapshot_stack_t s);
40 static xbt_dynar_t take_snapshot_ignore(void);
42 static void get_hash_global(char *snapshot_hash, void *data1, void *data2);
43 static void get_hash_local(char *snapshot_hash, xbt_dynar_t stacks);
45 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size)
47 mc_mem_region_t new_reg = xbt_new0(s_mc_mem_region_t, 1);
48 new_reg->start_addr = start_addr;
50 new_reg->data = xbt_malloc0(size);
51 memcpy(new_reg->data, start_addr, size);
53 XBT_DEBUG("New region : type : %d, data : %p (real addr %p), size : %zu", type, new_reg->data, start_addr, size);
58 static void MC_region_restore(mc_mem_region_t reg)
60 /*FIXME: check if start_addr is still mapped, if it is not, then map it
61 before copying the data */
63 memcpy(reg->start_addr, reg->data, reg->size);
68 static void MC_region_destroy(mc_mem_region_t reg)
74 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size)
76 mc_mem_region_t new_reg = MC_region_new(type, start_addr, size);
77 snapshot->regions[type] = new_reg;
81 void MC_init_memory_map_info(){
83 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
89 memory_map_t maps = get_memory_map();
91 while (i < maps->mapsize) {
92 reg = maps->regions[i];
93 if ((reg.prot & PROT_WRITE)){
94 if (maps->regions[i].pathname != NULL){
95 if (!memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
96 start_data_libsimgrid = reg.start_addr;
98 reg = maps->regions[i];
99 if(reg.pathname == NULL && (reg.prot & PROT_WRITE) && i < maps->mapsize)
100 start_bss_libsimgrid = reg.start_addr;
101 }else if (!memcmp(basename(maps->regions[i].pathname), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
102 start_data_binary = reg.start_addr;
104 reg = maps->regions[i];
105 if(reg.pathname == NULL && (reg.prot & PROT_WRITE) && reg.start_addr != std_heap && reg.start_addr != raw_heap && i < maps->mapsize){
106 start_bss_binary = reg.start_addr;
109 }else if(!memcmp(maps->regions[i].pathname, "[stack]", 7)){
110 maestro_stack_start = reg.start_addr;
111 maestro_stack_end = reg.end_addr;
115 }else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC)){
116 if (maps->regions[i].pathname != NULL){
117 if (!memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
118 start_text_libsimgrid = reg.start_addr;
119 libsimgrid_path = strdup(maps->regions[i].pathname);
120 }else if (!memcmp(basename(maps->regions[i].pathname), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
121 start_text_binary = reg.start_addr;
128 free_memory_map(maps);
137 mc_snapshot_t MC_take_snapshot()
139 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
143 mc_snapshot_t snapshot = xbt_new0(s_mc_snapshot_t, 1);
144 snapshot->nb_processes = xbt_swag_size(simix_global->process_list);
148 memory_map_t maps = get_memory_map();
153 /* Save the std heap and the writable mapped pages of libsimgrid */
154 while (i < maps->mapsize) {
155 reg = maps->regions[i];
156 if ((reg.prot & PROT_WRITE)){
157 if (maps->regions[i].pathname == NULL){
158 if (reg.start_addr == std_heap){ // only save the std heap (and not the raw one)
159 MC_snapshot_add_region(snapshot, 0, reg.start_addr, (char*)reg.end_addr - (char*)reg.start_addr);
160 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
161 heap = snapshot->regions[0]->data;
165 if (!memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
166 size = (char*)reg.end_addr - (char*)reg.start_addr;
167 start = reg.start_addr;
169 reg = maps->regions[i];
170 if(reg.pathname == NULL && (reg.prot & PROT_WRITE) && i < maps->mapsize){
171 size += (char*)reg.end_addr - (char*)reg.start_addr;
172 reg = maps->regions[i];
175 MC_snapshot_add_region(snapshot, 1, start, size);
176 }else if(!memcmp(maps->regions[i].pathname, "[stack]", 7)){
177 maestro_stack_start = reg.start_addr;
178 maestro_stack_end = reg.end_addr;
180 } else if (!memcmp(basename(maps->regions[i].pathname), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
181 size = (char*)reg.end_addr - (char*)reg.start_addr;
182 start = reg.start_addr;
184 reg = maps->regions[i];
185 if(reg.pathname == NULL && (reg.prot & PROT_WRITE) && reg.start_addr != std_heap && reg.start_addr != raw_heap && i < maps->mapsize){
186 size += (char*)reg.end_addr - (char*)reg.start_addr;
187 reg = maps->regions[i];
190 MC_snapshot_add_region(snapshot, 2, start, size);
200 snapshot->to_ignore = take_snapshot_ignore();
202 if(_sg_mc_visited > 0 || strcmp(_sg_mc_property_file,"")){
203 snapshot->stacks = take_snapshot_stacks(&snapshot, heap);
204 get_hash_global(snapshot->hash_global, snapshot->regions[1]->data, snapshot->regions[2]->data);
205 get_hash_local(snapshot->hash_local, snapshot->stacks);
208 free_memory_map(maps);
219 void MC_restore_snapshot(mc_snapshot_t snapshot)
222 for(i=0; i < NB_REGIONS; i++){
223 MC_region_restore(snapshot->regions[i]);
228 void MC_free_snapshot(mc_snapshot_t snapshot)
231 for(i=0; i < NB_REGIONS; i++)
232 MC_region_destroy(snapshot->regions[i]);
234 xbt_free(snapshot->stack_sizes);
235 xbt_dynar_free(&(snapshot->stacks));
236 xbt_dynar_free(&(snapshot->to_ignore));
241 void get_libsimgrid_plt_section(){
244 char *line = NULL; /* Temporal storage for each line that is readed */
245 ssize_t read; /* Number of bytes readed */
246 size_t n = 0; /* Amount of bytes to read by xbt_getline */
249 int i, plt_found = 0;
250 unsigned long int size, offset;
252 char *command = bprintf("objdump --section-headers %s", libsimgrid_path);
254 fp = popen(command, "r");
257 perror("popen failed");
261 while ((read = xbt_getline(&line, &n, fp)) != -1 && plt_found != 2) {
266 /* Wipeout the new line character */
267 line[read - 1] = '\0';
269 lfields[0] = strtok(line, " ");
271 if(lfields[0] == NULL)
274 if(strcmp(lfields[0], "Sections:") == 0 || strcmp(lfields[0], "Idx") == 0 || strncmp(lfields[0], libsimgrid_path, strlen(libsimgrid_path)) == 0)
277 for (i = 1; i < 7 && lfields[i - 1] != NULL; i++) {
278 lfields[i] = strtok(NULL, " ");
282 if(strcmp(lfields[1], ".plt") == 0){
283 size = strtoul(lfields[2], NULL, 16);
284 offset = strtoul(lfields[5], NULL, 16);
285 start_plt_libsimgrid = (char *)start_text_libsimgrid + offset;
286 end_plt_libsimgrid = (char *)start_plt_libsimgrid + size;
288 }else if(strcmp(lfields[1], ".got.plt") == 0){
289 size = strtoul(lfields[2], NULL, 16);
290 offset = strtoul(lfields[5], NULL, 16);
291 start_got_plt_libsimgrid = (char *)start_text_libsimgrid + offset;
292 end_got_plt_libsimgrid = (char *)start_got_plt_libsimgrid + size;
306 void get_binary_plt_section(){
309 char *line = NULL; /* Temporal storage for each line that is readed */
310 ssize_t read; /* Number of bytes readed */
311 size_t n = 0; /* Amount of bytes to read by xbt_getline */
314 int i, plt_found = 0;
315 unsigned long int size;
317 char *command = bprintf( "objdump --section-headers %s", xbt_binary_name);
319 fp = popen(command, "r");
322 perror("popen failed");
326 while ((read = xbt_getline(&line, &n, fp)) != -1 && plt_found != 2) {
331 /* Wipeout the new line character */
332 line[read - 1] = '\0';
334 lfields[0] = strtok(line, " ");
336 if(lfields[0] == NULL)
339 if(strcmp(lfields[0], "Sections:") == 0 || strcmp(lfields[0], "Idx") == 0 || strncmp(lfields[0], basename(xbt_binary_name), strlen(xbt_binary_name)) == 0)
342 for (i = 1; i < 7 && lfields[i - 1] != NULL; i++) {
343 lfields[i] = strtok(NULL, " ");
347 if(strcmp(lfields[1], ".plt") == 0){
348 size = strtoul(lfields[2], NULL, 16);
349 start_plt_binary = (void *)strtoul(lfields[3], NULL, 16);
350 end_plt_binary = (char *)start_plt_binary + size;
352 }else if(strcmp(lfields[1], ".got.plt") == 0){
353 size = strtoul(lfields[2], NULL, 16);
354 start_got_plt_binary = (char *)strtoul(lfields[3], NULL, 16);
355 end_got_plt_binary = (char *)start_got_plt_binary + size;
369 static void add_value(xbt_dynar_t *list, const char *type, unsigned long int val){
370 variable_value_t value = xbt_new0(s_variable_value_t, 1);
371 value->type = strdup(type);
372 if(strcmp(type, "value") == 0){
373 value->value.res = val;
375 value->value.address = (void *)val;
377 xbt_dynar_push(*list, &value);
380 static xbt_dynar_t take_snapshot_stacks(mc_snapshot_t *snapshot, void *heap){
382 xbt_dynar_t res = xbt_dynar_new(sizeof(s_mc_snapshot_stack_t), snapshot_stack_free_voidp);
384 unsigned int cursor = 0;
385 stack_region_t current_stack;
387 xbt_dynar_foreach(stacks_areas, cursor, current_stack){
388 mc_snapshot_stack_t st = xbt_new(s_mc_snapshot_stack_t, 1);
389 st->local_variables = get_local_variables_values(current_stack->context, heap);
390 st->stack_pointer = get_stack_pointer(current_stack->context, heap);
391 xbt_dynar_push(res, &st);
392 (*snapshot)->stack_sizes = xbt_realloc((*snapshot)->stack_sizes, (cursor + 1) * sizeof(size_t));
393 (*snapshot)->stack_sizes[cursor] = current_stack->size - ((char *)st->stack_pointer - (char *)((char *)heap + ((char *)current_stack->address - (char *)std_heap)));
400 static void *get_stack_pointer(void *stack_context, void *heap){
406 ret = unw_init_local(&c, (unw_context_t *)stack_context);
408 XBT_INFO("unw_init_local failed");
412 unw_get_reg(&c, UNW_REG_SP, &sp);
414 return ((char *)heap + (size_t)(((char *)((long)sp) - (char*)std_heap)));
418 static xbt_strbuff_t get_local_variables_values(void *stack_context, void *heap){
423 char frame_name[256];
425 ret = unw_init_local(&c, (unw_context_t *)stack_context);
427 XBT_INFO("unw_init_local failed");
431 unw_word_t ip, sp, off;
434 xbt_dynar_t compose = xbt_dynar_new(sizeof(variable_value_t), variable_value_free_voidp);
436 xbt_strbuff_t variables = xbt_strbuff_new();
437 xbt_dict_cursor_t dict_cursor;
439 dw_local_variable_t current_variable;
440 unsigned int cursor = 0, cursor2 = 0;
441 dw_location_entry_t entry = NULL;
442 dw_location_t location_entry = NULL;
445 void *frame_pointer_address = NULL;
451 unw_get_reg(&c, UNW_REG_IP, &ip);
452 unw_get_reg(&c, UNW_REG_SP, &sp);
454 unw_get_proc_name(&c, frame_name, sizeof (frame_name), &off);
456 frame = xbt_dict_get_or_null(mc_local_variables, frame_name);
459 xbt_dynar_free(&compose);
460 xbt_dict_cursor_free(&dict_cursor);
464 to_append = bprintf("frame_name=%s\n", frame_name);
465 xbt_strbuff_append(variables, to_append);
467 to_append = bprintf("ip=%lx\n", (unsigned long)ip);
468 xbt_strbuff_append(variables, to_append);
471 true_ip = (long)frame->low_pc + (long)off;
473 /* Get frame pointer */
474 switch(frame->frame_base->type){
476 while((cursor < xbt_dynar_length(frame->frame_base->location.loclist)) && frame_found == 0){
477 entry = xbt_dynar_get_as(frame->frame_base->location.loclist, cursor, dw_location_entry_t);
478 if((true_ip >= entry->lowpc) && (true_ip < entry->highpc)){
480 switch(entry->location->type){
482 xbt_dynar_reset(compose);
484 while(cursor2 < xbt_dynar_length(entry->location->location.compose)){
485 location_entry = xbt_dynar_get_as(entry->location->location.compose, cursor2, dw_location_t);
486 switch(location_entry->type){
488 unw_get_reg(&c, location_entry->location.reg, &res);
489 add_value(&compose, "address", (long)res);
491 case e_dw_bregister_op:
492 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
493 add_value(&compose, "address", (long)res + location_entry->location.breg_op.offset);
496 xbt_dynar_reset(compose);
502 if(!xbt_dynar_is_empty(compose)){
503 frame_pointer_address = xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1, variable_value_t)->value.address ;
504 xbt_dynar_reset(compose);
508 frame_pointer_address = NULL;
516 frame_pointer_address = NULL;
523 xbt_dict_foreach(frame->variables, dict_cursor, variable_name, current_variable){
524 if(current_variable->location != NULL){
525 switch(current_variable->location->type){
527 xbt_dynar_reset(compose);
529 while(cursor < xbt_dynar_length(current_variable->location->location.compose)){
530 location_entry = xbt_dynar_get_as(current_variable->location->location.compose, cursor, dw_location_t);
531 switch(location_entry->type){
533 unw_get_reg(&c, location_entry->location.reg, &res);
534 add_value(&compose, "value", (long)res);
536 case e_dw_bregister_op:
537 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
538 add_value(&compose, "address", (long)res + location_entry->location.breg_op.offset);
540 case e_dw_fbregister_op:
541 if(frame_pointer_address != NULL)
542 add_value(&compose, "address", (long)((char *)frame_pointer_address + location_entry->location.fbreg_op));
545 xbt_dynar_reset(compose);
551 if(!xbt_dynar_is_empty(compose)){
552 if(strcmp(xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1, variable_value_t)->type, "value") == 0){
553 to_append = bprintf("%s=%lx\n", current_variable->name, xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1, variable_value_t)->value.res);
554 xbt_strbuff_append(variables, to_append);
557 if((long)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1,variable_value_t)->value.address < 0 || *((void**)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1,variable_value_t)->value.address) == NULL){
558 to_append = bprintf("%s=NULL\n", current_variable->name);
559 xbt_strbuff_append(variables, to_append);
561 }else if(((long)*((void**)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1,variable_value_t)->value.address) > 0xffffffff) || ((long)*((void**)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1,variable_value_t)->value.address) < (long)start_text_binary)){
562 to_append = bprintf("%s=%u\n", current_variable->name, (unsigned int)(long)*((void**)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1, variable_value_t)->value.address));
563 xbt_strbuff_append(variables, to_append);
566 to_append = bprintf("%s=%p\n", current_variable->name, *((void**)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1, variable_value_t)->value.address));
567 xbt_strbuff_append(variables, to_append);
571 xbt_dynar_reset(compose);
573 to_append = bprintf("%s=undefined\n", current_variable->name);
574 xbt_strbuff_append(variables, to_append);
582 to_append = bprintf("%s=undefined\n", current_variable->name);
583 xbt_strbuff_append(variables, to_append);
592 xbt_dynar_free(&compose);
593 xbt_dict_cursor_free(&dict_cursor);
599 static void print_local_variables_values(xbt_dynar_t all_variables){
602 mc_snapshot_stack_t stack;
604 xbt_dynar_foreach(all_variables, cursor, stack){
605 XBT_INFO("%s", stack->local_variables->data);
610 static void snapshot_stack_free(mc_snapshot_stack_t s){
612 xbt_free(s->local_variables->data);
613 xbt_free(s->local_variables);
618 void snapshot_stack_free_voidp(void *s){
619 snapshot_stack_free((mc_snapshot_stack_t) * (void **) s);
622 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall){
623 return MC_take_snapshot();
626 void *MC_snapshot(void){
628 return simcall_mc_snapshot();
632 void variable_value_free(variable_value_t v){
639 void variable_value_free_voidp(void* v){
640 variable_value_free((variable_value_t) * (void **)v);
643 static void get_hash_global(char *snapshot_hash, void *data1, void *data2){
645 unsigned int cursor = 0;
647 global_variable_t current_var;
648 void *addr_pointed = NULL;
651 xbt_strbuff_t clear = xbt_strbuff_new();
653 xbt_dynar_foreach(mc_global_variables, cursor, current_var){
654 if(current_var->address < start_data_libsimgrid){ /* binary */
655 offset = (char *)current_var->address - (char *)start_data_binary;
656 addr_pointed = *((void **)((char *)data2 + offset));
657 if(((addr_pointed >= start_plt_binary && addr_pointed <= end_plt_binary)) || ((addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE )))
659 res = xbt_malloc0(current_var->size + 1);
660 memset(res, 0, current_var->size + 1);
661 memcpy(res, (char*)data2 + offset, current_var->size);
662 }else{ /* libsimgrid */
663 offset = (char *)current_var->address - (char *)start_data_libsimgrid;
664 addr_pointed = *((void **)((char *)data1 + offset));
665 if((addr_pointed >= start_plt_libsimgrid && addr_pointed <= end_plt_libsimgrid) || (addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE ))
667 res = xbt_malloc0(current_var->size + 1);
668 memset(res, 0, current_var->size + 1);
669 memcpy(res, (char*)data1 + offset, current_var->size);
672 xbt_strbuff_append(clear, (const char*)res);
678 xbt_sha(clear->data, snapshot_hash);
680 xbt_strbuff_free(clear);
684 static void get_hash_local(char *snapshot_hash, xbt_dynar_t stacks){
686 xbt_dynar_t tokens = NULL, s_tokens = NULL;
687 unsigned int cursor1 = 0, cursor2 = 0;
688 mc_snapshot_stack_t current_stack;
689 char *frame_name = NULL;
692 xbt_strbuff_t clear = xbt_strbuff_new();
694 while(cursor1 < xbt_dynar_length(stacks)){
695 current_stack = xbt_dynar_get_as(stacks, cursor1, mc_snapshot_stack_t);
696 tokens = xbt_str_split(current_stack->local_variables->data, NULL);
698 while(cursor2 < xbt_dynar_length(tokens)){
699 s_tokens = xbt_str_split(xbt_dynar_get_as(tokens, cursor2, char *), "=");
700 if(xbt_dynar_length(s_tokens) > 1){
701 if(strcmp(xbt_dynar_get_as(s_tokens, 0, char *), "frame_name") == 0){
702 xbt_free(frame_name);
703 frame_name = xbt_strdup(xbt_dynar_get_as(s_tokens, 1, char *));
704 xbt_strbuff_append(clear, (const char*)xbt_dynar_get_as(tokens, cursor2, char *));
706 xbt_dynar_free(&s_tokens);
709 addr = (void *) strtoul(xbt_dynar_get_as(s_tokens, 1, char *), NULL, 16);
710 if(addr > std_heap && (char *)addr <= (char *)std_heap + STD_HEAP_SIZE){
712 xbt_dynar_free(&s_tokens);
715 if(is_stack_ignore_variable(frame_name, xbt_dynar_get_as(s_tokens, 0, char *))){
717 xbt_dynar_free(&s_tokens);
720 xbt_strbuff_append(clear, (const char *)xbt_dynar_get_as(tokens, cursor2, char *));
722 xbt_dynar_free(&s_tokens);
725 xbt_dynar_free(&tokens);
729 xbt_free(frame_name);
731 xbt_sha(clear->data, snapshot_hash);
733 xbt_strbuff_free(clear);
738 static xbt_dynar_t take_snapshot_ignore(){
740 if(mc_heap_comparison_ignore == NULL)
743 xbt_dynar_t cpy = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
745 unsigned int cursor = 0;
746 mc_heap_ignore_region_t current_region;
748 xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, current_region){
749 mc_heap_ignore_region_t new_region = NULL;
750 new_region = xbt_new0(s_mc_heap_ignore_region_t, 1);
751 new_region->address = current_region->address;
752 new_region->size = current_region->size;
753 new_region->block = current_region->block;
754 new_region->fragment = current_region->fragment;
755 xbt_dynar_push(cpy, &new_region);