1 /* Copyright (c) 2008-2013. 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. */
9 #include "mc_private.h"
10 #include "xbt/module.h"
12 #include "../simix/smx_private.h"
14 #include <libunwind.h>
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc,
17 "Logging specific to mc_checkpoint");
19 char *libsimgrid_path;
21 static void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
22 static void MC_get_plt_section(mc_object_info_t info);
24 /************************************ Free functions **************************************/
25 /*****************************************************************************************/
27 static void MC_snapshot_stack_free(mc_snapshot_stack_t s){
29 xbt_dynar_free(&(s->local_variables));
34 static void MC_snapshot_stack_free_voidp(void *s){
35 MC_snapshot_stack_free((mc_snapshot_stack_t) * (void **) s);
38 static void local_variable_free(local_variable_t v){
45 static void local_variable_free_voidp(void *v){
46 local_variable_free((local_variable_t) * (void **) v);
49 static void MC_region_destroy(mc_mem_region_t reg)
55 void MC_free_snapshot(mc_snapshot_t snapshot){
57 for(i=0; i < NB_REGIONS; i++)
58 MC_region_destroy(snapshot->regions[i]);
60 xbt_free(snapshot->stack_sizes);
61 xbt_dynar_free(&(snapshot->stacks));
62 xbt_dynar_free(&(snapshot->to_ignore));
67 /******************************* Snapshot regions ********************************/
68 /*********************************************************************************/
70 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size)
72 mc_mem_region_t new_reg = xbt_new0(s_mc_mem_region_t, 1);
73 new_reg->start_addr = start_addr;
75 new_reg->data = xbt_malloc0(size);
76 memcpy(new_reg->data, start_addr, size);
78 XBT_DEBUG("New region : type : %d, data : %p (real addr %p), size : %zu", type, new_reg->data, start_addr, size);
83 static void MC_region_restore(mc_mem_region_t reg)
85 /*FIXME: check if start_addr is still mapped, if it is not, then map it
86 before copying the data */
88 memcpy(reg->start_addr, reg->data, reg->size);
92 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size)
94 mc_mem_region_t new_reg = MC_region_new(type, start_addr, size);
95 snapshot->regions[type] = new_reg;
99 static void MC_get_memory_regions(mc_snapshot_t snapshot){
106 char *lfields[6] = {0}, *tok;
107 void *start_addr, *start_addr1, *end_addr;
111 fp = fopen("/proc/self/maps", "r");
114 "Cannot open /proc/self/maps to investigate the memory map of the process. Please report this bug.");
118 while((read = xbt_getline(&line, &n, fp)) != -1){
120 /* Wipeout the new line character */
121 line[read - 1] = '\0';
123 /* Tokenize the line using spaces as delimiters and store each token */
124 lfields[0] = strtok(line, " ");
126 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
127 lfields[i] = strtok(NULL, " ");
130 /* First get the permissions flags, need write permission */
131 if(lfields[1][1] == 'w'){
133 /* Get the start address of the map */
134 tok = strtok(lfields[0], "-");
135 start_addr = (void *)strtoul(tok, NULL, 16);
137 if(start_addr == std_heap){ /* Std_heap ? */
138 tok = strtok(NULL, "-");
139 end_addr = (void *)strtoul(tok, NULL, 16);
140 MC_snapshot_add_region(snapshot, 0, start_addr, (char*)end_addr - (char*)start_addr);
141 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
142 }else{ /* map name == libsimgrid || binary_name ? */
143 if(lfields[5] != NULL){
144 if(!memcmp(basename(lfields[5]), "libsimgrid", 10)){
145 tok = strtok(NULL, "-");
146 end_addr = (void *)strtoul(tok, NULL, 16);
147 size = (char*)end_addr - (char*)start_addr;
148 /* BSS and data segments may be separated according to the OS */
149 if((read = xbt_getline(&line, &n, fp)) != -1){
150 line[read - 1] = '\0';
151 lfields[0] = strtok(line, " ");
152 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
153 lfields[i] = strtok(NULL, " ");
155 if(lfields[1][1] == 'w' && lfields[5] == NULL){
156 tok = strtok(lfields[0], "-");
157 start_addr1 = (void *)strtoul(tok, NULL, 16);
158 tok = strtok(NULL, "-");
159 size += (char *)(void *)strtoul(tok, NULL, 16) - (char*)start_addr1;
162 MC_snapshot_add_region(snapshot, 1, start_addr, size);
163 }else if(!memcmp(basename(lfields[5]), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
164 tok = strtok(NULL, "-");
165 end_addr = (void *)strtoul(tok, NULL, 16);
166 size = (char*)end_addr - (char*)start_addr;
167 /* BSS and data segments may be separated according to the OS */
168 if((read = xbt_getline(&line, &n, fp)) != -1){
169 line[read - 1] = '\0';
170 lfields[0] = strtok(line, " ");
171 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
172 lfields[i] = strtok(NULL, " ");
174 tok = strtok(lfields[0], "-");
175 start_addr1 = (void *)strtoul(tok, NULL, 16);
176 if(lfields[1][1] == 'w'){
177 if(start_addr1 == std_heap){ /* Std_heap ? */
178 tok = strtok(NULL, "-");
179 end_addr = (void *)strtoul(tok, NULL, 16);
180 MC_snapshot_add_region(snapshot, 0, start_addr1, (char*)end_addr - (char*)start_addr1);
181 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
182 }else if(start_addr1 != raw_heap){
183 tok = strtok(NULL, "-");
184 size += (char *)(void *)strtoul(tok, NULL, 16) - (char *)start_addr1;
188 MC_snapshot_add_region(snapshot, 2, start_addr, size);
189 }else if (!memcmp(lfields[5], "[stack]", 7)){
190 maestro_stack_start = start_addr;
191 tok = strtok(NULL, "-");
192 maestro_stack_end = (void *)strtoul(tok, NULL, 16);
205 /** @brief Finds the range of the different memory segments and binary paths */
206 void MC_init_memory_map_info(){
210 memory_map_t maps = MC_get_memory_map();
212 maestro_stack_start = NULL;
213 maestro_stack_end = NULL;
214 libsimgrid_path = NULL;
216 while (i < maps->mapsize) {
217 reg = maps->regions[i];
218 if (maps->regions[i].pathname == NULL) {
221 else if ((reg.prot & PROT_WRITE) && !memcmp(maps->regions[i].pathname, "[stack]", 7)){
222 maestro_stack_start = reg.start_addr;
223 maestro_stack_end = reg.end_addr;
224 } else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC) && !memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
225 if(libsimgrid_path == NULL)
226 libsimgrid_path = strdup(maps->regions[i].pathname);
231 xbt_assert(maestro_stack_start, "maestro_stack_start");
232 xbt_assert(maestro_stack_end, "maestro_stack_end");
233 xbt_assert(libsimgrid_path, "libsimgrid_path&");
235 MC_free_memory_map(maps);
239 /** \brief Finds informations about a given shared object/executable */
240 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name) {
241 mc_object_info_t result = MC_new_object_info();
242 result->file_name = xbt_strdup(name);
243 result->start_data = NULL;
244 result->start_text = NULL;
245 result->start_plt = NULL;
246 result->end_plt = NULL;
247 result->start_got_plt = NULL;
248 result->end_got_plt = NULL;
249 MC_find_object_address(maps, result);
250 MC_get_plt_section(result);
251 MC_dwarf_get_variables(result);
255 /** \brief Fills the position of the .bss and .data sections. */
256 static void MC_find_object_address(memory_map_t maps, mc_object_info_t result) {
259 const char* name = basename(result->file_name);
260 while (i < maps->mapsize) {
261 reg = maps->regions[i];
262 if (maps->regions[i].pathname == NULL || strcmp(basename(maps->regions[i].pathname), name)) {
265 else if ((reg.prot & PROT_WRITE)){
266 result->start_data = reg.start_addr;
267 } else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC)){
268 result->start_text = reg.start_addr;
273 xbt_assert(result->file_name);
274 xbt_assert(result->start_data);
275 xbt_assert(result->start_text);
277 MC_get_plt_section(result);
280 /** \brief Fills the position of the .plt and .got.plt sections. */
281 static void MC_get_plt_section(mc_object_info_t info){
284 char *line = NULL; /* Temporal storage for each line that is readed */
285 ssize_t read; /* Number of bytes readed */
286 size_t n = 0; /* Amount of bytes to read by xbt_getline */
289 int i, plt_found = 0;
290 unsigned long int size, offset;
292 char *command = bprintf("LANG=C objdump --section-headers %s", info->file_name);
294 fp = popen(command, "r");
297 perror("popen failed");
301 while ((read = xbt_getline(&line, &n, fp)) != -1 && plt_found != 2) {
306 /* Wipeout the new line character */
307 line[read - 1] = '\0';
309 lfields[0] = strtok(line, " ");
311 if(lfields[0] == NULL)
314 if(strcmp(lfields[0], "Sections:") == 0 || strcmp(lfields[0], "Idx") == 0 || strncmp(lfields[0], info->file_name, strlen(info->file_name)) == 0)
317 for (i = 1; i < 7 && lfields[i - 1] != NULL; i++) {
318 lfields[i] = strtok(NULL, " ");
322 if(strcmp(lfields[1], ".plt") == 0){
323 size = strtoul(lfields[2], NULL, 16);
324 offset = strtoul(lfields[5], NULL, 16);
325 info->start_plt = (char *) info->start_text + offset;
326 info->end_plt = (char *) info->start_plt + size;
328 }else if(strcmp(lfields[1], ".got.plt") == 0){
329 size = strtoul(lfields[2], NULL, 16);
330 offset = strtoul(lfields[5], NULL, 16);
331 info->start_got_plt = (char *) info->start_text + offset;
332 info->end_got_plt = (char *) info->start_plt + size;
346 /************************************* Take Snapshot ************************************/
347 /****************************************************************************************/
349 static void MC_get_hash_global(char *snapshot_hash, void *data1, void *data2){
351 /* unsigned int cursor = 0; */
353 /* global_variable_t current_var; */
354 /* void *addr_pointed = NULL; */
355 /* void *res = NULL; */
357 /* xbt_strbuff_t clear = xbt_strbuff_new(); */
359 /* xbt_dynar_foreach(mc_global_variables, cursor, current_var){ */
360 /* if(current_var->address < start_data_libsimgrid){ /\* binary *\/ */
361 /* offset = (char *)current_var->address - (char *)start_data_binary; */
362 /* addr_pointed = *((void **)((char *)data2 + offset)); */
363 /* if(((addr_pointed >= start_plt_binary && addr_pointed <= end_plt_binary)) || ((addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE ))) */
365 /* res = xbt_malloc0(current_var->size + 1); */
366 /* memset(res, 0, current_var->size + 1); */
367 /* memcpy(res, (char*)data2 + offset, current_var->size); */
368 /* }else{ /\* libsimgrid *\/ */
369 /* offset = (char *)current_var->address - (char *)start_data_libsimgrid; */
370 /* addr_pointed = *((void **)((char *)data1 + offset)); */
371 /* if((addr_pointed >= start_plt_libsimgrid && addr_pointed <= end_plt_libsimgrid) || (addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE )) */
373 /* res = xbt_malloc0(current_var->size + 1); */
374 /* memset(res, 0, current_var->size + 1); */
375 /* memcpy(res, (char*)data1 + offset, current_var->size); */
377 /* if(res != NULL){ */
378 /* xbt_strbuff_append(clear, (const char*)res); */
384 /* xbt_sha(clear->data, snapshot_hash); */
386 /* xbt_strbuff_free(clear); */
390 static void MC_get_hash_local(char *snapshot_hash, xbt_dynar_t stacks){
392 /* xbt_dynar_t tokens = NULL, s_tokens = NULL; */
393 /* unsigned int cursor1 = 0, cursor2 = 0; */
394 /* mc_snapshot_stack_t current_stack; */
395 /* char *frame_name = NULL; */
398 /* xbt_strbuff_t clear = xbt_strbuff_new(); */
400 /* while(cursor1 < xbt_dynar_length(stacks)){ */
401 /* current_stack = xbt_dynar_get_as(stacks, cursor1, mc_snapshot_stack_t); */
402 /* tokens = xbt_str_split(current_stack->local_variables->data, NULL); */
404 /* while(cursor2 < xbt_dynar_length(tokens)){ */
405 /* s_tokens = xbt_str_split(xbt_dynar_get_as(tokens, cursor2, char *), "="); */
406 /* if(xbt_dynar_length(s_tokens) > 1){ */
407 /* if(strcmp(xbt_dynar_get_as(s_tokens, 0, char *), "frame_name") == 0){ */
408 /* xbt_free(frame_name); */
409 /* frame_name = xbt_strdup(xbt_dynar_get_as(s_tokens, 1, char *)); */
410 /* xbt_strbuff_append(clear, (const char*)xbt_dynar_get_as(tokens, cursor2, char *)); */
412 /* xbt_dynar_free(&s_tokens); */
415 /* addr = (void *) strtoul(xbt_dynar_get_as(s_tokens, 1, char *), NULL, 16); */
416 /* if(addr > std_heap && (char *)addr <= (char *)std_heap + STD_HEAP_SIZE){ */
418 /* xbt_dynar_free(&s_tokens); */
421 /* if(is_stack_ignore_variable(frame_name, xbt_dynar_get_as(s_tokens, 0, char *))){ */
423 /* xbt_dynar_free(&s_tokens); */
426 /* xbt_strbuff_append(clear, (const char *)xbt_dynar_get_as(tokens, cursor2, char *)); */
428 /* xbt_dynar_free(&s_tokens); */
431 /* xbt_dynar_free(&tokens); */
435 /* xbt_free(frame_name); */
437 /* xbt_sha(clear->data, snapshot_hash); */
439 /* xbt_strbuff_free(clear); */
443 static xbt_dynar_t MC_get_local_variables_values(void *stack_context){
448 char frame_name[256];
450 ret = unw_init_local(&c, (unw_context_t *)stack_context);
452 XBT_INFO("unw_init_local failed");
456 unw_word_t ip, sp, off;
459 unsigned int cursor = 0;
460 dw_variable_t current_variable;
461 dw_location_entry_t entry = NULL;
462 dw_location_t location_entry = NULL;
464 int frame_found = 0, region_type;
465 void *frame_pointer_address = NULL;
469 xbt_dynar_t variables = xbt_dynar_new(sizeof(local_variable_t), local_variable_free_voidp);
471 while(ret >= 0 && !stop){
473 unw_get_reg(&c, UNW_REG_IP, &ip);
474 unw_get_reg(&c, UNW_REG_SP, &sp);
476 unw_get_proc_name(&c, frame_name, sizeof (frame_name), &off);
478 if(!strcmp(frame_name, "smx_ctx_sysv_wrapper")) /* Stop before context switch with maestro */
481 if((long)ip > (long) mc_libsimgrid_info->start_text)
482 frame = xbt_dict_get_or_null(mc_libsimgrid_info->local_variables, frame_name);
484 frame = xbt_dict_get_or_null(mc_binary_info->local_variables, frame_name);
491 true_ip = (long)frame->low_pc + (long)off;
492 frame_pointer_address = NULL;
494 /* Get frame pointer */
495 switch(frame->frame_base->type){
498 while(cursor < xbt_dynar_length(frame->frame_base->location.loclist) && !frame_found){
499 entry = xbt_dynar_get_as(frame->frame_base->location.loclist, cursor, dw_location_entry_t);
500 if((true_ip >= entry->lowpc) && (true_ip < entry->highpc)){
502 switch(entry->location->type){
504 if(xbt_dynar_length(entry->location->location.compose) > 1){
505 frame_pointer_address = NULL; /* TODO : location list with optimizations enabled */
507 location_entry = xbt_dynar_get_as(entry->location->location.compose, 0, dw_location_t);
508 switch(location_entry->type){
510 unw_get_reg(&c, location_entry->location.reg, &res);
511 frame_pointer_address = (void*)(long)res;
513 case e_dw_bregister_op:
514 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
515 frame_pointer_address = (void*)((long)res + location_entry->location.breg_op.offset);
518 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled) */
524 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled) */
532 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled)*/
539 xbt_dynar_foreach(frame->variables, cursor, current_variable){
541 if((long)ip > (long)mc_libsimgrid_info->start_text)
546 local_variable_t new_var = xbt_new0(s_local_variable_t, 1);
547 new_var->frame = xbt_strdup(frame_name);
548 new_var->ip = (unsigned long)ip;
549 new_var->name = xbt_strdup(current_variable->name);
550 new_var->type = strdup(current_variable->type_origin);
551 new_var->region= region_type;
553 if(current_variable->address.location != NULL){
554 switch(current_variable->address.location->type){
556 if(xbt_dynar_length(current_variable->address.location->location.compose) > 1){
557 /* TODO : location list with optimizations enabled */
559 location_entry = xbt_dynar_get_as(current_variable->address.location->location.compose, 0, dw_location_t);
561 switch(location_entry->type){
563 unw_get_reg(&c, location_entry->location.reg, &res);
566 case e_dw_bregister_op:
567 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
568 value = (long)res + location_entry->location.breg_op.offset;
570 case e_dw_fbregister_op:
571 if(frame_pointer_address != NULL)
572 value = (long)((char *)frame_pointer_address + location_entry->location.fbreg_op);
577 value = 0; /* FIXME : implement other cases (with optimizations enabled)*/
582 new_var->address = (void *)value;
584 new_var->address = NULL;
592 xbt_dynar_push(variables, &new_var);
605 static void *MC_get_stack_pointer(void *stack_context, void *heap){
611 ret = unw_init_local(&c, (unw_context_t *)stack_context);
613 XBT_INFO("unw_init_local failed");
617 unw_get_reg(&c, UNW_REG_SP, &sp);
619 return ((char *)heap + (size_t)(((char *)((long)sp) - (char*)std_heap)));
623 static xbt_dynar_t MC_take_snapshot_stacks(mc_snapshot_t *snapshot, void *heap){
625 xbt_dynar_t res = xbt_dynar_new(sizeof(s_mc_snapshot_stack_t), MC_snapshot_stack_free_voidp);
627 unsigned int cursor = 0;
628 stack_region_t current_stack;
630 xbt_dynar_foreach(stacks_areas, cursor, current_stack){
631 mc_snapshot_stack_t st = xbt_new(s_mc_snapshot_stack_t, 1);
632 st->local_variables = MC_get_local_variables_values(current_stack->context);
633 st->stack_pointer = MC_get_stack_pointer(current_stack->context, heap);
634 st->real_address = current_stack->address;
635 xbt_dynar_push(res, &st);
636 (*snapshot)->stack_sizes = xbt_realloc((*snapshot)->stack_sizes, (cursor + 1) * sizeof(size_t));
637 (*snapshot)->stack_sizes[cursor] = current_stack->size - ((char *)st->stack_pointer - (char *)((char *)heap + ((char *)current_stack->address - (char *)std_heap)));
644 static xbt_dynar_t MC_take_snapshot_ignore(){
646 if(mc_heap_comparison_ignore == NULL)
649 xbt_dynar_t cpy = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
651 unsigned int cursor = 0;
652 mc_heap_ignore_region_t current_region;
654 xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, current_region){
655 mc_heap_ignore_region_t new_region = NULL;
656 new_region = xbt_new0(s_mc_heap_ignore_region_t, 1);
657 new_region->address = current_region->address;
658 new_region->size = current_region->size;
659 new_region->block = current_region->block;
660 new_region->fragment = current_region->fragment;
661 xbt_dynar_push(cpy, &new_region);
668 static void MC_dump_checkpoint_ignore(mc_snapshot_t snapshot){
670 unsigned int cursor = 0;
671 mc_checkpoint_ignore_region_t region;
674 xbt_dynar_foreach(mc_checkpoint_ignore, cursor, region){
675 if(region->addr > snapshot->regions[0]->start_addr && (char *)(region->addr) < (char *)snapshot->regions[0]->start_addr + STD_HEAP_SIZE){
676 offset = (char *)region->addr - (char *)snapshot->regions[0]->start_addr;
677 memset((char *)snapshot->regions[0]->data + offset, 0, region->size);
678 }else if(region->addr > snapshot->regions[2]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[2]->start_addr + snapshot->regions[2]->size){
679 offset = (char *)region->addr - (char *)snapshot->regions[2]->start_addr;
680 memset((char *)snapshot->regions[2]->data + offset, 0, region->size);
681 }else if(region->addr > snapshot->regions[1]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[1]->start_addr + snapshot->regions[1]->size){
682 offset = (char *)region->addr - (char *)snapshot->regions[1]->start_addr;
683 memset((char *)snapshot->regions[1]->data + offset, 0, region->size);
690 mc_snapshot_t MC_take_snapshot(int num_state){
692 mc_snapshot_t snapshot = xbt_new0(s_mc_snapshot_t, 1);
693 snapshot->nb_processes = xbt_swag_size(simix_global->process_list);
695 /* Save the std heap and the writable mapped pages of libsimgrid and binary */
696 MC_get_memory_regions(snapshot);
698 snapshot->to_ignore = MC_take_snapshot_ignore();
700 if(_sg_mc_visited > 0 || strcmp(_sg_mc_property_file,"")){
701 snapshot->stacks = MC_take_snapshot_stacks(&snapshot, snapshot->regions[0]->data);
702 //MC_get_hash_global(snapshot->hash_global, snapshot->regions[1]->data, snapshot->regions[2]->data);
703 //MC_get_hash_local(snapshot->hash_local, snapshot->stacks);
707 MC_dump_checkpoint_ignore(snapshot);
713 void MC_restore_snapshot(mc_snapshot_t snapshot){
715 for(i=0; i < NB_REGIONS; i++){
716 MC_region_restore(snapshot->regions[i]);
721 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall){
722 return MC_take_snapshot(1);
725 void *MC_snapshot(void){
726 return simcall_mc_snapshot();