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. */
8 #include "mc_private.h"
9 #include "xbt/module.h"
11 #include "../simix/smx_private.h"
13 #include <libunwind.h>
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc,
16 "Logging specific to mc_checkpoint");
18 char *libsimgrid_path;
20 static void MC_get_plt_section(mc_object_info_t info);
22 /************************************ Free functions **************************************/
23 /*****************************************************************************************/
25 static void MC_snapshot_stack_free(mc_snapshot_stack_t s){
27 xbt_dynar_free(&(s->local_variables));
32 static void MC_snapshot_stack_free_voidp(void *s){
33 MC_snapshot_stack_free((mc_snapshot_stack_t) * (void **) s);
36 static void local_variable_free(local_variable_t v){
43 static void local_variable_free_voidp(void *v){
44 local_variable_free((local_variable_t) * (void **) v);
47 static void MC_region_destroy(mc_mem_region_t reg)
53 void MC_free_snapshot(mc_snapshot_t snapshot){
55 for(i=0; i < NB_REGIONS; i++)
56 MC_region_destroy(snapshot->regions[i]);
58 xbt_free(snapshot->stack_sizes);
59 xbt_dynar_free(&(snapshot->stacks));
60 xbt_dynar_free(&(snapshot->to_ignore));
65 /******************************* Snapshot regions ********************************/
66 /*********************************************************************************/
68 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size)
70 mc_mem_region_t new_reg = xbt_new0(s_mc_mem_region_t, 1);
71 new_reg->start_addr = start_addr;
73 new_reg->data = xbt_malloc0(size);
74 memcpy(new_reg->data, start_addr, size);
76 XBT_DEBUG("New region : type : %d, data : %p (real addr %p), size : %zu", type, new_reg->data, start_addr, size);
81 static void MC_region_restore(mc_mem_region_t reg)
83 /*FIXME: check if start_addr is still mapped, if it is not, then map it
84 before copying the data */
86 memcpy(reg->start_addr, reg->data, reg->size);
90 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size)
92 mc_mem_region_t new_reg = MC_region_new(type, start_addr, size);
93 snapshot->regions[type] = new_reg;
97 static void MC_get_memory_regions(mc_snapshot_t snapshot){
104 char *lfields[6] = {0}, *tok;
105 void *start_addr, *start_addr1, *end_addr;
109 fp = fopen("/proc/self/maps", "r");
112 "Cannot open /proc/self/maps to investigate the memory map of the process. Please report this bug.");
116 while((read = xbt_getline(&line, &n, fp)) != -1){
118 /* Wipeout the new line character */
119 line[read - 1] = '\0';
121 /* Tokenize the line using spaces as delimiters and store each token */
122 lfields[0] = strtok(line, " ");
124 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
125 lfields[i] = strtok(NULL, " ");
128 /* First get the permissions flags, need write permission */
129 if(lfields[1][1] == 'w'){
131 /* Get the start address of the map */
132 tok = strtok(lfields[0], "-");
133 start_addr = (void *)strtoul(tok, NULL, 16);
135 if(start_addr == std_heap){ /* Std_heap ? */
136 tok = strtok(NULL, "-");
137 end_addr = (void *)strtoul(tok, NULL, 16);
138 MC_snapshot_add_region(snapshot, 0, start_addr, (char*)end_addr - (char*)start_addr);
139 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
140 }else{ /* map name == libsimgrid || binary_name ? */
141 if(lfields[5] != NULL){
142 if(!memcmp(basename(lfields[5]), "libsimgrid", 10)){
143 tok = strtok(NULL, "-");
144 end_addr = (void *)strtoul(tok, NULL, 16);
145 size = (char*)end_addr - (char*)start_addr;
146 /* BSS and data segments may be separated according to the OS */
147 if((read = xbt_getline(&line, &n, fp)) != -1){
148 line[read - 1] = '\0';
149 lfields[0] = strtok(line, " ");
150 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
151 lfields[i] = strtok(NULL, " ");
153 if(lfields[1][1] == 'w' && lfields[5] == NULL){
154 tok = strtok(lfields[0], "-");
155 start_addr1 = (void *)strtoul(tok, NULL, 16);
156 tok = strtok(NULL, "-");
157 size += (char *)(void *)strtoul(tok, NULL, 16) - (char*)start_addr1;
160 MC_snapshot_add_region(snapshot, 1, start_addr, size);
161 }else if(!memcmp(basename(lfields[5]), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
162 tok = strtok(NULL, "-");
163 end_addr = (void *)strtoul(tok, NULL, 16);
164 size = (char*)end_addr - (char*)start_addr;
165 /* BSS and data segments may be separated according to the OS */
166 if((read = xbt_getline(&line, &n, fp)) != -1){
167 line[read - 1] = '\0';
168 lfields[0] = strtok(line, " ");
169 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
170 lfields[i] = strtok(NULL, " ");
172 tok = strtok(lfields[0], "-");
173 start_addr1 = (void *)strtoul(tok, NULL, 16);
174 if(lfields[1][1] == 'w'){
175 if(start_addr1 == std_heap){ /* Std_heap ? */
176 tok = strtok(NULL, "-");
177 end_addr = (void *)strtoul(tok, NULL, 16);
178 MC_snapshot_add_region(snapshot, 0, start_addr1, (char*)end_addr - (char*)start_addr1);
179 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
180 }else if(start_addr1 != raw_heap){
181 tok = strtok(NULL, "-");
182 size += (char *)(void *)strtoul(tok, NULL, 16) - (char *)start_addr1;
186 MC_snapshot_add_region(snapshot, 2, start_addr, size);
187 }else if (!memcmp(lfields[5], "[stack]", 7)){
188 maestro_stack_start = start_addr;
189 tok = strtok(NULL, "-");
190 maestro_stack_end = (void *)strtoul(tok, NULL, 16);
203 /** @brief Find the range of the different memory segments and binary paths */
204 void MC_init_memory_map_info(){
208 memory_map_t maps = MC_get_memory_map();
210 maestro_stack_start = NULL;
211 maestro_stack_end = NULL;
212 libsimgrid_path = NULL;
214 while (i < maps->mapsize) {
215 reg = maps->regions[i];
216 if (maps->regions[i].pathname == NULL) {
219 else if ((reg.prot & PROT_WRITE) && !memcmp(maps->regions[i].pathname, "[stack]", 7)){
220 maestro_stack_start = reg.start_addr;
221 maestro_stack_end = reg.end_addr;
222 }else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC) && !memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
223 if(libsimgrid_path == NULL)
224 libsimgrid_path = strdup(maps->regions[i].pathname);
229 xbt_assert(maestro_stack_start, "maestro_stack_start");
230 xbt_assert(maestro_stack_end, "maestro_stack_end");
231 xbt_assert(libsimgrid_path, "libsimgrid_path&");
233 MC_free_memory_map(maps);
237 mc_object_info_t MC_find_object_address(memory_map_t maps, char* name) {
238 mc_object_info_t result = MC_new_object_info();
239 result->file_name = xbt_strdup(name);
240 result->start_data = NULL;
241 result->start_text = NULL;
245 int len = strlen(basename(name));
246 while (i < maps->mapsize) {
247 reg = maps->regions[i];
248 if (maps->regions[i].pathname == NULL || memcmp(basename(maps->regions[i].pathname), basename(name), len)){
251 else if ((reg.prot & PROT_WRITE)){
252 result->start_data = reg.start_addr;
254 reg = maps->regions[i];
255 }else if (reg.prot & PROT_READ) {
256 result->start_text = reg.start_addr;
261 xbt_assert(result->file_name);
262 xbt_assert(result->start_data);
263 xbt_assert(result->start_text);
265 MC_get_plt_section(result);
269 static void MC_get_plt_section(mc_object_info_t info){
272 char *line = NULL; /* Temporal storage for each line that is readed */
273 ssize_t read; /* Number of bytes readed */
274 size_t n = 0; /* Amount of bytes to read by xbt_getline */
277 int i, plt_found = 0;
278 unsigned long int size, offset;
280 char *command = bprintf("LANG=C objdump --section-headers %s", info->file_name);
282 fp = popen(command, "r");
285 perror("popen failed");
289 while ((read = xbt_getline(&line, &n, fp)) != -1 && plt_found != 2) {
294 /* Wipeout the new line character */
295 line[read - 1] = '\0';
297 lfields[0] = strtok(line, " ");
299 if(lfields[0] == NULL)
302 if(strcmp(lfields[0], "Sections:") == 0 || strcmp(lfields[0], "Idx") == 0 || strncmp(lfields[0], info->file_name, strlen(info->file_name)) == 0)
305 for (i = 1; i < 7 && lfields[i - 1] != NULL; i++) {
306 lfields[i] = strtok(NULL, " ");
310 if(strcmp(lfields[1], ".plt") == 0){
311 size = strtoul(lfields[2], NULL, 16);
312 offset = strtoul(lfields[5], NULL, 16);
313 info->start_plt = (char *) info->start_text + offset;
314 info->end_plt = (char *) info->start_plt + size;
316 }else if(strcmp(lfields[1], ".got.plt") == 0){
317 size = strtoul(lfields[2], NULL, 16);
318 offset = strtoul(lfields[5], NULL, 16);
319 info->start_got_plt = (char *) info->start_text + offset;
320 info->end_got_plt = (char *) info->start_plt + size;
334 /************************************* Take Snapshot ************************************/
335 /****************************************************************************************/
337 static void MC_get_hash_global(char *snapshot_hash, void *data1, void *data2){
339 /* unsigned int cursor = 0; */
341 /* global_variable_t current_var; */
342 /* void *addr_pointed = NULL; */
343 /* void *res = NULL; */
345 /* xbt_strbuff_t clear = xbt_strbuff_new(); */
347 /* xbt_dynar_foreach(mc_global_variables, cursor, current_var){ */
348 /* if(current_var->address < start_data_libsimgrid){ /\* binary *\/ */
349 /* offset = (char *)current_var->address - (char *)start_data_binary; */
350 /* addr_pointed = *((void **)((char *)data2 + offset)); */
351 /* if(((addr_pointed >= start_plt_binary && addr_pointed <= end_plt_binary)) || ((addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE ))) */
353 /* res = xbt_malloc0(current_var->size + 1); */
354 /* memset(res, 0, current_var->size + 1); */
355 /* memcpy(res, (char*)data2 + offset, current_var->size); */
356 /* }else{ /\* libsimgrid *\/ */
357 /* offset = (char *)current_var->address - (char *)start_data_libsimgrid; */
358 /* addr_pointed = *((void **)((char *)data1 + offset)); */
359 /* if((addr_pointed >= start_plt_libsimgrid && addr_pointed <= end_plt_libsimgrid) || (addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE )) */
361 /* res = xbt_malloc0(current_var->size + 1); */
362 /* memset(res, 0, current_var->size + 1); */
363 /* memcpy(res, (char*)data1 + offset, current_var->size); */
365 /* if(res != NULL){ */
366 /* xbt_strbuff_append(clear, (const char*)res); */
372 /* xbt_sha(clear->data, snapshot_hash); */
374 /* xbt_strbuff_free(clear); */
378 static void MC_get_hash_local(char *snapshot_hash, xbt_dynar_t stacks){
380 /* xbt_dynar_t tokens = NULL, s_tokens = NULL; */
381 /* unsigned int cursor1 = 0, cursor2 = 0; */
382 /* mc_snapshot_stack_t current_stack; */
383 /* char *frame_name = NULL; */
386 /* xbt_strbuff_t clear = xbt_strbuff_new(); */
388 /* while(cursor1 < xbt_dynar_length(stacks)){ */
389 /* current_stack = xbt_dynar_get_as(stacks, cursor1, mc_snapshot_stack_t); */
390 /* tokens = xbt_str_split(current_stack->local_variables->data, NULL); */
392 /* while(cursor2 < xbt_dynar_length(tokens)){ */
393 /* s_tokens = xbt_str_split(xbt_dynar_get_as(tokens, cursor2, char *), "="); */
394 /* if(xbt_dynar_length(s_tokens) > 1){ */
395 /* if(strcmp(xbt_dynar_get_as(s_tokens, 0, char *), "frame_name") == 0){ */
396 /* xbt_free(frame_name); */
397 /* frame_name = xbt_strdup(xbt_dynar_get_as(s_tokens, 1, char *)); */
398 /* xbt_strbuff_append(clear, (const char*)xbt_dynar_get_as(tokens, cursor2, char *)); */
400 /* xbt_dynar_free(&s_tokens); */
403 /* addr = (void *) strtoul(xbt_dynar_get_as(s_tokens, 1, char *), NULL, 16); */
404 /* if(addr > std_heap && (char *)addr <= (char *)std_heap + STD_HEAP_SIZE){ */
406 /* xbt_dynar_free(&s_tokens); */
409 /* if(is_stack_ignore_variable(frame_name, xbt_dynar_get_as(s_tokens, 0, char *))){ */
411 /* xbt_dynar_free(&s_tokens); */
414 /* xbt_strbuff_append(clear, (const char *)xbt_dynar_get_as(tokens, cursor2, char *)); */
416 /* xbt_dynar_free(&s_tokens); */
419 /* xbt_dynar_free(&tokens); */
423 /* xbt_free(frame_name); */
425 /* xbt_sha(clear->data, snapshot_hash); */
427 /* xbt_strbuff_free(clear); */
431 static xbt_dynar_t MC_get_local_variables_values(void *stack_context){
436 char frame_name[256];
438 ret = unw_init_local(&c, (unw_context_t *)stack_context);
440 XBT_INFO("unw_init_local failed");
444 unw_word_t ip, sp, off;
447 unsigned int cursor = 0;
448 dw_variable_t current_variable;
449 dw_location_entry_t entry = NULL;
450 dw_location_t location_entry = NULL;
452 int frame_found = 0, region_type;
453 void *frame_pointer_address = NULL;
457 xbt_dynar_t variables = xbt_dynar_new(sizeof(local_variable_t), local_variable_free_voidp);
459 while(ret >= 0 && !stop){
461 unw_get_reg(&c, UNW_REG_IP, &ip);
462 unw_get_reg(&c, UNW_REG_SP, &sp);
464 unw_get_proc_name(&c, frame_name, sizeof (frame_name), &off);
466 if(!strcmp(frame_name, "smx_ctx_sysv_wrapper")) /* Stop before context switch with maestro */
469 if((long)ip > (long) mc_libsimgrid_info->start_text)
470 frame = xbt_dict_get_or_null(mc_libsimgrid_info->local_variables, frame_name);
472 frame = xbt_dict_get_or_null(mc_binary_info->local_variables, frame_name);
479 true_ip = (long)frame->low_pc + (long)off;
480 frame_pointer_address = NULL;
482 /* Get frame pointer */
483 switch(frame->frame_base->type){
486 while(cursor < xbt_dynar_length(frame->frame_base->location.loclist) && !frame_found){
487 entry = xbt_dynar_get_as(frame->frame_base->location.loclist, cursor, dw_location_entry_t);
488 if((true_ip >= entry->lowpc) && (true_ip < entry->highpc)){
490 switch(entry->location->type){
492 if(xbt_dynar_length(entry->location->location.compose) > 1){
493 frame_pointer_address = NULL; /* TODO : location list with optimizations enabled */
495 location_entry = xbt_dynar_get_as(entry->location->location.compose, 0, dw_location_t);
496 switch(location_entry->type){
498 unw_get_reg(&c, location_entry->location.reg, &res);
499 frame_pointer_address = (void*)(long)res;
501 case e_dw_bregister_op:
502 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
503 frame_pointer_address = (void*)((long)res + location_entry->location.breg_op.offset);
506 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled) */
512 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled) */
520 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled)*/
527 xbt_dynar_foreach(frame->variables, cursor, current_variable){
529 if((long)ip > (long)mc_libsimgrid_info->start_text)
534 local_variable_t new_var = xbt_new0(s_local_variable_t, 1);
535 new_var->frame = xbt_strdup(frame_name);
536 new_var->ip = (unsigned long)ip;
537 new_var->name = xbt_strdup(current_variable->name);
538 new_var->type = strdup(current_variable->type_origin);
539 new_var->region= region_type;
541 if(current_variable->address.location != NULL){
542 switch(current_variable->address.location->type){
544 if(xbt_dynar_length(current_variable->address.location->location.compose) > 1){
545 /* TODO : location list with optimizations enabled */
547 location_entry = xbt_dynar_get_as(current_variable->address.location->location.compose, 0, dw_location_t);
549 switch(location_entry->type){
551 unw_get_reg(&c, location_entry->location.reg, &res);
554 case e_dw_bregister_op:
555 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
556 value = (long)res + location_entry->location.breg_op.offset;
558 case e_dw_fbregister_op:
559 if(frame_pointer_address != NULL)
560 value = (long)((char *)frame_pointer_address + location_entry->location.fbreg_op);
565 value = 0; /* FIXME : implement other cases (with optimizations enabled)*/
570 new_var->address = (void *)value;
572 new_var->address = NULL;
580 xbt_dynar_push(variables, &new_var);
593 static void *MC_get_stack_pointer(void *stack_context, void *heap){
599 ret = unw_init_local(&c, (unw_context_t *)stack_context);
601 XBT_INFO("unw_init_local failed");
605 unw_get_reg(&c, UNW_REG_SP, &sp);
607 return ((char *)heap + (size_t)(((char *)((long)sp) - (char*)std_heap)));
611 static xbt_dynar_t MC_take_snapshot_stacks(mc_snapshot_t *snapshot, void *heap){
613 xbt_dynar_t res = xbt_dynar_new(sizeof(s_mc_snapshot_stack_t), MC_snapshot_stack_free_voidp);
615 unsigned int cursor = 0;
616 stack_region_t current_stack;
618 xbt_dynar_foreach(stacks_areas, cursor, current_stack){
619 mc_snapshot_stack_t st = xbt_new(s_mc_snapshot_stack_t, 1);
620 st->local_variables = MC_get_local_variables_values(current_stack->context);
621 st->stack_pointer = MC_get_stack_pointer(current_stack->context, heap);
622 st->real_address = current_stack->address;
623 xbt_dynar_push(res, &st);
624 (*snapshot)->stack_sizes = xbt_realloc((*snapshot)->stack_sizes, (cursor + 1) * sizeof(size_t));
625 (*snapshot)->stack_sizes[cursor] = current_stack->size - ((char *)st->stack_pointer - (char *)((char *)heap + ((char *)current_stack->address - (char *)std_heap)));
632 static xbt_dynar_t MC_take_snapshot_ignore(){
634 if(mc_heap_comparison_ignore == NULL)
637 xbt_dynar_t cpy = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
639 unsigned int cursor = 0;
640 mc_heap_ignore_region_t current_region;
642 xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, current_region){
643 mc_heap_ignore_region_t new_region = NULL;
644 new_region = xbt_new0(s_mc_heap_ignore_region_t, 1);
645 new_region->address = current_region->address;
646 new_region->size = current_region->size;
647 new_region->block = current_region->block;
648 new_region->fragment = current_region->fragment;
649 xbt_dynar_push(cpy, &new_region);
656 static void MC_dump_checkpoint_ignore(mc_snapshot_t snapshot){
658 unsigned int cursor = 0;
659 mc_checkpoint_ignore_region_t region;
662 xbt_dynar_foreach(mc_checkpoint_ignore, cursor, region){
663 if(region->addr > snapshot->regions[0]->start_addr && (char *)(region->addr) < (char *)snapshot->regions[0]->start_addr + STD_HEAP_SIZE){
664 offset = (char *)region->addr - (char *)snapshot->regions[0]->start_addr;
665 memset((char *)snapshot->regions[0]->data + offset, 0, region->size);
666 }else if(region->addr > snapshot->regions[2]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[2]->start_addr + snapshot->regions[2]->size){
667 offset = (char *)region->addr - (char *)snapshot->regions[2]->start_addr;
668 memset((char *)snapshot->regions[2]->data + offset, 0, region->size);
669 }else if(region->addr > snapshot->regions[1]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[1]->start_addr + snapshot->regions[1]->size){
670 offset = (char *)region->addr - (char *)snapshot->regions[1]->start_addr;
671 memset((char *)snapshot->regions[1]->data + offset, 0, region->size);
678 mc_snapshot_t MC_take_snapshot(int num_state){
680 mc_snapshot_t snapshot = xbt_new0(s_mc_snapshot_t, 1);
681 snapshot->nb_processes = xbt_swag_size(simix_global->process_list);
683 /* Save the std heap and the writable mapped pages of libsimgrid and binary */
684 MC_get_memory_regions(snapshot);
686 snapshot->to_ignore = MC_take_snapshot_ignore();
688 if(_sg_mc_visited > 0 || strcmp(_sg_mc_property_file,"")){
689 snapshot->stacks = MC_take_snapshot_stacks(&snapshot, snapshot->regions[0]->data);
690 //MC_get_hash_global(snapshot->hash_global, snapshot->regions[1]->data, snapshot->regions[2]->data);
691 //MC_get_hash_local(snapshot->hash_local, snapshot->stacks);
695 MC_dump_checkpoint_ignore(snapshot);
701 void MC_restore_snapshot(mc_snapshot_t snapshot){
703 for(i=0; i < NB_REGIONS; i++){
704 MC_region_restore(snapshot->regions[i]);
709 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall){
710 return MC_take_snapshot(1);
713 void *MC_snapshot(void){
714 return simcall_mc_snapshot();