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_find_object_address(memory_map_t maps, mc_object_info_t result);
21 static void MC_get_plt_section(mc_object_info_t info);
23 /************************************ Free functions **************************************/
24 /*****************************************************************************************/
26 static void MC_snapshot_stack_free(mc_snapshot_stack_t s){
28 xbt_dynar_free(&(s->local_variables));
33 static void MC_snapshot_stack_free_voidp(void *s){
34 MC_snapshot_stack_free((mc_snapshot_stack_t) * (void **) s);
37 static void local_variable_free(local_variable_t v){
44 static void local_variable_free_voidp(void *v){
45 local_variable_free((local_variable_t) * (void **) v);
48 static void MC_region_destroy(mc_mem_region_t reg)
54 void MC_free_snapshot(mc_snapshot_t snapshot){
56 for(i=0; i < NB_REGIONS; i++)
57 MC_region_destroy(snapshot->regions[i]);
59 xbt_free(snapshot->stack_sizes);
60 xbt_dynar_free(&(snapshot->stacks));
61 xbt_dynar_free(&(snapshot->to_ignore));
66 /******************************* Snapshot regions ********************************/
67 /*********************************************************************************/
69 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size)
71 mc_mem_region_t new_reg = xbt_new0(s_mc_mem_region_t, 1);
72 new_reg->start_addr = start_addr;
74 new_reg->data = xbt_malloc0(size);
75 memcpy(new_reg->data, start_addr, size);
77 XBT_DEBUG("New region : type : %d, data : %p (real addr %p), size : %zu", type, new_reg->data, start_addr, size);
82 static void MC_region_restore(mc_mem_region_t reg)
84 /*FIXME: check if start_addr is still mapped, if it is not, then map it
85 before copying the data */
87 memcpy(reg->start_addr, reg->data, reg->size);
91 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size)
93 mc_mem_region_t new_reg = MC_region_new(type, start_addr, size);
94 snapshot->regions[type] = new_reg;
98 static void MC_get_memory_regions(mc_snapshot_t snapshot){
105 char *lfields[6] = {0}, *tok;
106 void *start_addr, *start_addr1, *end_addr;
110 fp = fopen("/proc/self/maps", "r");
113 "Cannot open /proc/self/maps to investigate the memory map of the process. Please report this bug.");
117 while((read = xbt_getline(&line, &n, fp)) != -1){
119 /* Wipeout the new line character */
120 line[read - 1] = '\0';
122 /* Tokenize the line using spaces as delimiters and store each token */
123 lfields[0] = strtok(line, " ");
125 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
126 lfields[i] = strtok(NULL, " ");
129 /* First get the permissions flags, need write permission */
130 if(lfields[1][1] == 'w'){
132 /* Get the start address of the map */
133 tok = strtok(lfields[0], "-");
134 start_addr = (void *)strtoul(tok, NULL, 16);
136 if(start_addr == std_heap){ /* Std_heap ? */
137 tok = strtok(NULL, "-");
138 end_addr = (void *)strtoul(tok, NULL, 16);
139 MC_snapshot_add_region(snapshot, 0, start_addr, (char*)end_addr - (char*)start_addr);
140 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
141 }else{ /* map name == libsimgrid || binary_name ? */
142 if(lfields[5] != NULL){
143 if(!memcmp(basename(lfields[5]), "libsimgrid", 10)){
144 tok = strtok(NULL, "-");
145 end_addr = (void *)strtoul(tok, NULL, 16);
146 size = (char*)end_addr - (char*)start_addr;
147 /* BSS and data segments may be separated according to the OS */
148 if((read = xbt_getline(&line, &n, fp)) != -1){
149 line[read - 1] = '\0';
150 lfields[0] = strtok(line, " ");
151 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
152 lfields[i] = strtok(NULL, " ");
154 if(lfields[1][1] == 'w' && lfields[5] == NULL){
155 tok = strtok(lfields[0], "-");
156 start_addr1 = (void *)strtoul(tok, NULL, 16);
157 tok = strtok(NULL, "-");
158 size += (char *)(void *)strtoul(tok, NULL, 16) - (char*)start_addr1;
161 MC_snapshot_add_region(snapshot, 1, start_addr, size);
162 }else if(!memcmp(basename(lfields[5]), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
163 tok = strtok(NULL, "-");
164 end_addr = (void *)strtoul(tok, NULL, 16);
165 size = (char*)end_addr - (char*)start_addr;
166 /* BSS and data segments may be separated according to the OS */
167 if((read = xbt_getline(&line, &n, fp)) != -1){
168 line[read - 1] = '\0';
169 lfields[0] = strtok(line, " ");
170 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
171 lfields[i] = strtok(NULL, " ");
173 tok = strtok(lfields[0], "-");
174 start_addr1 = (void *)strtoul(tok, NULL, 16);
175 if(lfields[1][1] == 'w'){
176 if(start_addr1 == std_heap){ /* Std_heap ? */
177 tok = strtok(NULL, "-");
178 end_addr = (void *)strtoul(tok, NULL, 16);
179 MC_snapshot_add_region(snapshot, 0, start_addr1, (char*)end_addr - (char*)start_addr1);
180 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
181 }else if(start_addr1 != raw_heap){
182 tok = strtok(NULL, "-");
183 size += (char *)(void *)strtoul(tok, NULL, 16) - (char *)start_addr1;
187 MC_snapshot_add_region(snapshot, 2, start_addr, size);
188 }else if (!memcmp(lfields[5], "[stack]", 7)){
189 maestro_stack_start = start_addr;
190 tok = strtok(NULL, "-");
191 maestro_stack_end = (void *)strtoul(tok, NULL, 16);
204 /** @brief Finds the range of the different memory segments and binary paths */
205 void MC_init_memory_map_info(){
209 memory_map_t maps = MC_get_memory_map();
211 maestro_stack_start = NULL;
212 maestro_stack_end = NULL;
213 libsimgrid_path = NULL;
215 while (i < maps->mapsize) {
216 reg = maps->regions[i];
217 if (maps->regions[i].pathname == NULL) {
220 else if ((reg.prot & PROT_WRITE) && !memcmp(maps->regions[i].pathname, "[stack]", 7)){
221 maestro_stack_start = reg.start_addr;
222 maestro_stack_end = reg.end_addr;
223 }else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC) && !memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
224 if(libsimgrid_path == NULL)
225 libsimgrid_path = strdup(maps->regions[i].pathname);
230 xbt_assert(maestro_stack_start, "maestro_stack_start");
231 xbt_assert(maestro_stack_end, "maestro_stack_end");
232 xbt_assert(libsimgrid_path, "libsimgrid_path&");
234 MC_free_memory_map(maps);
238 /** \brief Finds informations about a given shared object/executable */
239 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name) {
240 mc_object_info_t result = MC_new_object_info();
241 result->file_name = xbt_strdup(name);
242 result->start_data = NULL;
243 result->start_text = NULL;
244 MC_find_object_address(maps, result);
245 MC_get_plt_section(result);
246 MC_dwarf_get_variables(result);
250 /** \brief Fills the position of the .bss and .data sections. */
251 static void MC_find_object_address(memory_map_t maps, mc_object_info_t result) {
254 const char* name = result->file_name;
255 int len = strlen(basename(result->file_name));
256 while (i < maps->mapsize) {
257 reg = maps->regions[i];
258 if (maps->regions[i].pathname == NULL || memcmp(basename(maps->regions[i].pathname), basename(name), len)){
261 else if ((reg.prot & PROT_WRITE)){
262 result->start_data = reg.start_addr;
264 reg = maps->regions[i];
265 }else if (reg.prot & PROT_READ) {
266 result->start_text = reg.start_addr;
271 xbt_assert(result->file_name);
272 xbt_assert(result->start_data);
273 xbt_assert(result->start_text);
275 MC_get_plt_section(result);
278 /** \brief Fills the position of the .plt and .got.plt sections. */
279 static void MC_get_plt_section(mc_object_info_t info){
282 char *line = NULL; /* Temporal storage for each line that is readed */
283 ssize_t read; /* Number of bytes readed */
284 size_t n = 0; /* Amount of bytes to read by xbt_getline */
287 int i, plt_found = 0;
288 unsigned long int size, offset;
290 char *command = bprintf("LANG=C objdump --section-headers %s", info->file_name);
292 fp = popen(command, "r");
295 perror("popen failed");
299 while ((read = xbt_getline(&line, &n, fp)) != -1 && plt_found != 2) {
304 /* Wipeout the new line character */
305 line[read - 1] = '\0';
307 lfields[0] = strtok(line, " ");
309 if(lfields[0] == NULL)
312 if(strcmp(lfields[0], "Sections:") == 0 || strcmp(lfields[0], "Idx") == 0 || strncmp(lfields[0], info->file_name, strlen(info->file_name)) == 0)
315 for (i = 1; i < 7 && lfields[i - 1] != NULL; i++) {
316 lfields[i] = strtok(NULL, " ");
320 if(strcmp(lfields[1], ".plt") == 0){
321 size = strtoul(lfields[2], NULL, 16);
322 offset = strtoul(lfields[5], NULL, 16);
323 info->start_plt = (char *) info->start_text + offset;
324 info->end_plt = (char *) info->start_plt + size;
326 }else if(strcmp(lfields[1], ".got.plt") == 0){
327 size = strtoul(lfields[2], NULL, 16);
328 offset = strtoul(lfields[5], NULL, 16);
329 info->start_got_plt = (char *) info->start_text + offset;
330 info->end_got_plt = (char *) info->start_plt + size;
344 /************************************* Take Snapshot ************************************/
345 /****************************************************************************************/
347 static void MC_get_hash_global(char *snapshot_hash, void *data1, void *data2){
349 /* unsigned int cursor = 0; */
351 /* global_variable_t current_var; */
352 /* void *addr_pointed = NULL; */
353 /* void *res = NULL; */
355 /* xbt_strbuff_t clear = xbt_strbuff_new(); */
357 /* xbt_dynar_foreach(mc_global_variables, cursor, current_var){ */
358 /* if(current_var->address < start_data_libsimgrid){ /\* binary *\/ */
359 /* offset = (char *)current_var->address - (char *)start_data_binary; */
360 /* addr_pointed = *((void **)((char *)data2 + offset)); */
361 /* if(((addr_pointed >= start_plt_binary && addr_pointed <= end_plt_binary)) || ((addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE ))) */
363 /* res = xbt_malloc0(current_var->size + 1); */
364 /* memset(res, 0, current_var->size + 1); */
365 /* memcpy(res, (char*)data2 + offset, current_var->size); */
366 /* }else{ /\* libsimgrid *\/ */
367 /* offset = (char *)current_var->address - (char *)start_data_libsimgrid; */
368 /* addr_pointed = *((void **)((char *)data1 + offset)); */
369 /* if((addr_pointed >= start_plt_libsimgrid && addr_pointed <= end_plt_libsimgrid) || (addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE )) */
371 /* res = xbt_malloc0(current_var->size + 1); */
372 /* memset(res, 0, current_var->size + 1); */
373 /* memcpy(res, (char*)data1 + offset, current_var->size); */
375 /* if(res != NULL){ */
376 /* xbt_strbuff_append(clear, (const char*)res); */
382 /* xbt_sha(clear->data, snapshot_hash); */
384 /* xbt_strbuff_free(clear); */
388 static void MC_get_hash_local(char *snapshot_hash, xbt_dynar_t stacks){
390 /* xbt_dynar_t tokens = NULL, s_tokens = NULL; */
391 /* unsigned int cursor1 = 0, cursor2 = 0; */
392 /* mc_snapshot_stack_t current_stack; */
393 /* char *frame_name = NULL; */
396 /* xbt_strbuff_t clear = xbt_strbuff_new(); */
398 /* while(cursor1 < xbt_dynar_length(stacks)){ */
399 /* current_stack = xbt_dynar_get_as(stacks, cursor1, mc_snapshot_stack_t); */
400 /* tokens = xbt_str_split(current_stack->local_variables->data, NULL); */
402 /* while(cursor2 < xbt_dynar_length(tokens)){ */
403 /* s_tokens = xbt_str_split(xbt_dynar_get_as(tokens, cursor2, char *), "="); */
404 /* if(xbt_dynar_length(s_tokens) > 1){ */
405 /* if(strcmp(xbt_dynar_get_as(s_tokens, 0, char *), "frame_name") == 0){ */
406 /* xbt_free(frame_name); */
407 /* frame_name = xbt_strdup(xbt_dynar_get_as(s_tokens, 1, char *)); */
408 /* xbt_strbuff_append(clear, (const char*)xbt_dynar_get_as(tokens, cursor2, char *)); */
410 /* xbt_dynar_free(&s_tokens); */
413 /* addr = (void *) strtoul(xbt_dynar_get_as(s_tokens, 1, char *), NULL, 16); */
414 /* if(addr > std_heap && (char *)addr <= (char *)std_heap + STD_HEAP_SIZE){ */
416 /* xbt_dynar_free(&s_tokens); */
419 /* if(is_stack_ignore_variable(frame_name, xbt_dynar_get_as(s_tokens, 0, char *))){ */
421 /* xbt_dynar_free(&s_tokens); */
424 /* xbt_strbuff_append(clear, (const char *)xbt_dynar_get_as(tokens, cursor2, char *)); */
426 /* xbt_dynar_free(&s_tokens); */
429 /* xbt_dynar_free(&tokens); */
433 /* xbt_free(frame_name); */
435 /* xbt_sha(clear->data, snapshot_hash); */
437 /* xbt_strbuff_free(clear); */
441 static xbt_dynar_t MC_get_local_variables_values(void *stack_context){
446 char frame_name[256];
448 ret = unw_init_local(&c, (unw_context_t *)stack_context);
450 XBT_INFO("unw_init_local failed");
454 unw_word_t ip, sp, off;
457 unsigned int cursor = 0;
458 dw_variable_t current_variable;
459 dw_location_entry_t entry = NULL;
460 dw_location_t location_entry = NULL;
462 int frame_found = 0, region_type;
463 void *frame_pointer_address = NULL;
467 xbt_dynar_t variables = xbt_dynar_new(sizeof(local_variable_t), local_variable_free_voidp);
469 while(ret >= 0 && !stop){
471 unw_get_reg(&c, UNW_REG_IP, &ip);
472 unw_get_reg(&c, UNW_REG_SP, &sp);
474 unw_get_proc_name(&c, frame_name, sizeof (frame_name), &off);
476 if(!strcmp(frame_name, "smx_ctx_sysv_wrapper")) /* Stop before context switch with maestro */
479 if((long)ip > (long) mc_libsimgrid_info->start_text)
480 frame = xbt_dict_get_or_null(mc_libsimgrid_info->local_variables, frame_name);
482 frame = xbt_dict_get_or_null(mc_binary_info->local_variables, frame_name);
489 true_ip = (long)frame->low_pc + (long)off;
490 frame_pointer_address = NULL;
492 /* Get frame pointer */
493 switch(frame->frame_base->type){
496 while(cursor < xbt_dynar_length(frame->frame_base->location.loclist) && !frame_found){
497 entry = xbt_dynar_get_as(frame->frame_base->location.loclist, cursor, dw_location_entry_t);
498 if((true_ip >= entry->lowpc) && (true_ip < entry->highpc)){
500 switch(entry->location->type){
502 if(xbt_dynar_length(entry->location->location.compose) > 1){
503 frame_pointer_address = NULL; /* TODO : location list with optimizations enabled */
505 location_entry = xbt_dynar_get_as(entry->location->location.compose, 0, dw_location_t);
506 switch(location_entry->type){
508 unw_get_reg(&c, location_entry->location.reg, &res);
509 frame_pointer_address = (void*)(long)res;
511 case e_dw_bregister_op:
512 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
513 frame_pointer_address = (void*)((long)res + location_entry->location.breg_op.offset);
516 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled) */
522 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled) */
530 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled)*/
537 xbt_dynar_foreach(frame->variables, cursor, current_variable){
539 if((long)ip > (long)mc_libsimgrid_info->start_text)
544 local_variable_t new_var = xbt_new0(s_local_variable_t, 1);
545 new_var->frame = xbt_strdup(frame_name);
546 new_var->ip = (unsigned long)ip;
547 new_var->name = xbt_strdup(current_variable->name);
548 new_var->type = strdup(current_variable->type_origin);
549 new_var->region= region_type;
551 if(current_variable->address.location != NULL){
552 switch(current_variable->address.location->type){
554 if(xbt_dynar_length(current_variable->address.location->location.compose) > 1){
555 /* TODO : location list with optimizations enabled */
557 location_entry = xbt_dynar_get_as(current_variable->address.location->location.compose, 0, dw_location_t);
559 switch(location_entry->type){
561 unw_get_reg(&c, location_entry->location.reg, &res);
564 case e_dw_bregister_op:
565 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
566 value = (long)res + location_entry->location.breg_op.offset;
568 case e_dw_fbregister_op:
569 if(frame_pointer_address != NULL)
570 value = (long)((char *)frame_pointer_address + location_entry->location.fbreg_op);
575 value = 0; /* FIXME : implement other cases (with optimizations enabled)*/
580 new_var->address = (void *)value;
582 new_var->address = NULL;
590 xbt_dynar_push(variables, &new_var);
603 static void *MC_get_stack_pointer(void *stack_context, void *heap){
609 ret = unw_init_local(&c, (unw_context_t *)stack_context);
611 XBT_INFO("unw_init_local failed");
615 unw_get_reg(&c, UNW_REG_SP, &sp);
617 return ((char *)heap + (size_t)(((char *)((long)sp) - (char*)std_heap)));
621 static xbt_dynar_t MC_take_snapshot_stacks(mc_snapshot_t *snapshot, void *heap){
623 xbt_dynar_t res = xbt_dynar_new(sizeof(s_mc_snapshot_stack_t), MC_snapshot_stack_free_voidp);
625 unsigned int cursor = 0;
626 stack_region_t current_stack;
628 xbt_dynar_foreach(stacks_areas, cursor, current_stack){
629 mc_snapshot_stack_t st = xbt_new(s_mc_snapshot_stack_t, 1);
630 st->local_variables = MC_get_local_variables_values(current_stack->context);
631 st->stack_pointer = MC_get_stack_pointer(current_stack->context, heap);
632 st->real_address = current_stack->address;
633 xbt_dynar_push(res, &st);
634 (*snapshot)->stack_sizes = xbt_realloc((*snapshot)->stack_sizes, (cursor + 1) * sizeof(size_t));
635 (*snapshot)->stack_sizes[cursor] = current_stack->size - ((char *)st->stack_pointer - (char *)((char *)heap + ((char *)current_stack->address - (char *)std_heap)));
642 static xbt_dynar_t MC_take_snapshot_ignore(){
644 if(mc_heap_comparison_ignore == NULL)
647 xbt_dynar_t cpy = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
649 unsigned int cursor = 0;
650 mc_heap_ignore_region_t current_region;
652 xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, current_region){
653 mc_heap_ignore_region_t new_region = NULL;
654 new_region = xbt_new0(s_mc_heap_ignore_region_t, 1);
655 new_region->address = current_region->address;
656 new_region->size = current_region->size;
657 new_region->block = current_region->block;
658 new_region->fragment = current_region->fragment;
659 xbt_dynar_push(cpy, &new_region);
666 static void MC_dump_checkpoint_ignore(mc_snapshot_t snapshot){
668 unsigned int cursor = 0;
669 mc_checkpoint_ignore_region_t region;
672 xbt_dynar_foreach(mc_checkpoint_ignore, cursor, region){
673 if(region->addr > snapshot->regions[0]->start_addr && (char *)(region->addr) < (char *)snapshot->regions[0]->start_addr + STD_HEAP_SIZE){
674 offset = (char *)region->addr - (char *)snapshot->regions[0]->start_addr;
675 memset((char *)snapshot->regions[0]->data + offset, 0, region->size);
676 }else if(region->addr > snapshot->regions[2]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[2]->start_addr + snapshot->regions[2]->size){
677 offset = (char *)region->addr - (char *)snapshot->regions[2]->start_addr;
678 memset((char *)snapshot->regions[2]->data + offset, 0, region->size);
679 }else if(region->addr > snapshot->regions[1]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[1]->start_addr + snapshot->regions[1]->size){
680 offset = (char *)region->addr - (char *)snapshot->regions[1]->start_addr;
681 memset((char *)snapshot->regions[1]->data + offset, 0, region->size);
688 mc_snapshot_t MC_take_snapshot(int num_state){
690 mc_snapshot_t snapshot = xbt_new0(s_mc_snapshot_t, 1);
691 snapshot->nb_processes = xbt_swag_size(simix_global->process_list);
693 /* Save the std heap and the writable mapped pages of libsimgrid and binary */
694 MC_get_memory_regions(snapshot);
696 snapshot->to_ignore = MC_take_snapshot_ignore();
698 if(_sg_mc_visited > 0 || strcmp(_sg_mc_property_file,"")){
699 snapshot->stacks = MC_take_snapshot_stacks(&snapshot, snapshot->regions[0]->data);
700 //MC_get_hash_global(snapshot->hash_global, snapshot->regions[1]->data, snapshot->regions[2]->data);
701 //MC_get_hash_local(snapshot->hash_local, snapshot->stacks);
705 MC_dump_checkpoint_ignore(snapshot);
711 void MC_restore_snapshot(mc_snapshot_t snapshot){
713 for(i=0; i < NB_REGIONS; i++){
714 MC_region_restore(snapshot->regions[i]);
719 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall){
720 return MC_take_snapshot(1);
723 void *MC_snapshot(void){
724 return simcall_mc_snapshot();