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 void *start_text_libsimgrid;
19 void *start_plt_libsimgrid, *end_plt_libsimgrid;
20 void *start_got_plt_libsimgrid, *end_got_plt_libsimgrid;
21 void *start_plt_binary, *end_plt_binary;
22 void *start_got_plt_binary, *end_got_plt_binary;
23 char *libsimgrid_path;
25 static void MC_get_plt_section(mc_object_info_t info);
27 /************************************ Free functions **************************************/
28 /*****************************************************************************************/
30 static void MC_snapshot_stack_free(mc_snapshot_stack_t s){
32 xbt_dynar_free(&(s->local_variables));
37 static void MC_snapshot_stack_free_voidp(void *s){
38 MC_snapshot_stack_free((mc_snapshot_stack_t) * (void **) s);
41 static void local_variable_free(local_variable_t v){
48 static void local_variable_free_voidp(void *v){
49 local_variable_free((local_variable_t) * (void **) v);
52 static void MC_region_destroy(mc_mem_region_t reg)
58 void MC_free_snapshot(mc_snapshot_t snapshot){
60 for(i=0; i < NB_REGIONS; i++)
61 MC_region_destroy(snapshot->regions[i]);
63 xbt_free(snapshot->stack_sizes);
64 xbt_dynar_free(&(snapshot->stacks));
65 xbt_dynar_free(&(snapshot->to_ignore));
70 /******************************* Snapshot regions ********************************/
71 /*********************************************************************************/
73 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size)
75 mc_mem_region_t new_reg = xbt_new0(s_mc_mem_region_t, 1);
76 new_reg->start_addr = start_addr;
78 new_reg->data = xbt_malloc0(size);
79 memcpy(new_reg->data, start_addr, size);
81 XBT_DEBUG("New region : type : %d, data : %p (real addr %p), size : %zu", type, new_reg->data, start_addr, size);
86 static void MC_region_restore(mc_mem_region_t reg)
88 /*FIXME: check if start_addr is still mapped, if it is not, then map it
89 before copying the data */
91 memcpy(reg->start_addr, reg->data, reg->size);
95 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size)
97 mc_mem_region_t new_reg = MC_region_new(type, start_addr, size);
98 snapshot->regions[type] = new_reg;
102 static void MC_get_memory_regions(mc_snapshot_t snapshot){
109 char *lfields[6] = {0}, *tok;
110 void *start_addr, *start_addr1, *end_addr;
114 fp = fopen("/proc/self/maps", "r");
117 "Cannot open /proc/self/maps to investigate the memory map of the process. Please report this bug.");
121 while((read = xbt_getline(&line, &n, fp)) != -1){
123 /* Wipeout the new line character */
124 line[read - 1] = '\0';
126 /* Tokenize the line using spaces as delimiters and store each token */
127 lfields[0] = strtok(line, " ");
129 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
130 lfields[i] = strtok(NULL, " ");
133 /* First get the permissions flags, need write permission */
134 if(lfields[1][1] == 'w'){
136 /* Get the start address of the map */
137 tok = strtok(lfields[0], "-");
138 start_addr = (void *)strtoul(tok, NULL, 16);
140 if(start_addr == std_heap){ /* Std_heap ? */
141 tok = strtok(NULL, "-");
142 end_addr = (void *)strtoul(tok, NULL, 16);
143 MC_snapshot_add_region(snapshot, 0, start_addr, (char*)end_addr - (char*)start_addr);
144 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
145 }else{ /* map name == libsimgrid || binary_name ? */
146 if(lfields[5] != NULL){
147 if(!memcmp(basename(lfields[5]), "libsimgrid", 10)){
148 tok = strtok(NULL, "-");
149 end_addr = (void *)strtoul(tok, NULL, 16);
150 size = (char*)end_addr - (char*)start_addr;
151 /* BSS and data segments may be separated according to the OS */
152 if((read = xbt_getline(&line, &n, fp)) != -1){
153 line[read - 1] = '\0';
154 lfields[0] = strtok(line, " ");
155 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
156 lfields[i] = strtok(NULL, " ");
158 if(lfields[1][1] == 'w' && lfields[5] == NULL){
159 tok = strtok(lfields[0], "-");
160 start_addr1 = (void *)strtoul(tok, NULL, 16);
161 tok = strtok(NULL, "-");
162 size += (char *)(void *)strtoul(tok, NULL, 16) - (char*)start_addr1;
165 MC_snapshot_add_region(snapshot, 1, start_addr, size);
166 }else if(!memcmp(basename(lfields[5]), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
167 tok = strtok(NULL, "-");
168 end_addr = (void *)strtoul(tok, NULL, 16);
169 size = (char*)end_addr - (char*)start_addr;
170 /* BSS and data segments may be separated according to the OS */
171 if((read = xbt_getline(&line, &n, fp)) != -1){
172 line[read - 1] = '\0';
173 lfields[0] = strtok(line, " ");
174 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
175 lfields[i] = strtok(NULL, " ");
177 tok = strtok(lfields[0], "-");
178 start_addr1 = (void *)strtoul(tok, NULL, 16);
179 if(lfields[1][1] == 'w'){
180 if(start_addr1 == std_heap){ /* Std_heap ? */
181 tok = strtok(NULL, "-");
182 end_addr = (void *)strtoul(tok, NULL, 16);
183 MC_snapshot_add_region(snapshot, 0, start_addr1, (char*)end_addr - (char*)start_addr1);
184 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
185 }else if(start_addr1 != raw_heap){
186 tok = strtok(NULL, "-");
187 size += (char *)(void *)strtoul(tok, NULL, 16) - (char *)start_addr1;
191 MC_snapshot_add_region(snapshot, 2, start_addr, size);
192 }else if (!memcmp(lfields[5], "[stack]", 7)){
193 maestro_stack_start = start_addr;
194 tok = strtok(NULL, "-");
195 maestro_stack_end = (void *)strtoul(tok, NULL, 16);
208 /** @brief Find the range of the different memory segments and binary paths */
209 void MC_init_memory_map_info(){
213 memory_map_t maps = MC_get_memory_map();
215 maestro_stack_start = NULL;
216 maestro_stack_end = NULL;
217 libsimgrid_path = NULL;
219 while (i < maps->mapsize) {
220 reg = maps->regions[i];
221 if (maps->regions[i].pathname == NULL) {
224 else if ((reg.prot & PROT_WRITE) && !memcmp(maps->regions[i].pathname, "[stack]", 7)){
225 maestro_stack_start = reg.start_addr;
226 maestro_stack_end = reg.end_addr;
227 }else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC) && !memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
228 if(libsimgrid_path == NULL)
229 libsimgrid_path = strdup(maps->regions[i].pathname);
234 xbt_assert(maestro_stack_start, "maestro_stack_start");
235 xbt_assert(maestro_stack_end, "maestro_stack_end");
236 xbt_assert(libsimgrid_path, "libsimgrid_path&");
238 MC_free_memory_map(maps);
242 mc_object_info_t MC_find_object_address(memory_map_t maps, char* name) {
243 mc_object_info_t result = MC_new_object_info();
244 result->file_name = xbt_strdup(name);
245 result->start_data = NULL;
246 result->start_text = NULL;
250 int len = strlen(basename(name));
251 while (i < maps->mapsize) {
252 reg = maps->regions[i];
253 if (maps->regions[i].pathname == NULL || memcmp(basename(maps->regions[i].pathname), basename(name), len)){
256 else if ((reg.prot & PROT_WRITE)){
257 result->start_data = reg.start_addr;
259 reg = maps->regions[i];
260 }else if (reg.prot & PROT_READ) {
261 result->start_text = reg.start_addr;
266 xbt_assert(result->file_name);
267 xbt_assert(result->start_data);
268 xbt_assert(result->start_text);
270 MC_get_plt_section(result);
274 static void MC_get_plt_section(mc_object_info_t info){
277 char *line = NULL; /* Temporal storage for each line that is readed */
278 ssize_t read; /* Number of bytes readed */
279 size_t n = 0; /* Amount of bytes to read by xbt_getline */
282 int i, plt_found = 0;
283 unsigned long int size, offset;
285 char *command = bprintf("LANG=C objdump --section-headers %s", info->file_name);
287 fp = popen(command, "r");
290 perror("popen failed");
294 while ((read = xbt_getline(&line, &n, fp)) != -1 && plt_found != 2) {
299 /* Wipeout the new line character */
300 line[read - 1] = '\0';
302 lfields[0] = strtok(line, " ");
304 if(lfields[0] == NULL)
307 if(strcmp(lfields[0], "Sections:") == 0 || strcmp(lfields[0], "Idx") == 0 || strncmp(lfields[0], info->file_name, strlen(info->file_name)) == 0)
310 for (i = 1; i < 7 && lfields[i - 1] != NULL; i++) {
311 lfields[i] = strtok(NULL, " ");
315 if(strcmp(lfields[1], ".plt") == 0){
316 size = strtoul(lfields[2], NULL, 16);
317 offset = strtoul(lfields[5], NULL, 16);
318 info->start_plt = (char *) info->start_text + offset;
319 info->end_plt = (char *) info->start_plt + size;
321 }else if(strcmp(lfields[1], ".got.plt") == 0){
322 size = strtoul(lfields[2], NULL, 16);
323 offset = strtoul(lfields[5], NULL, 16);
324 info->start_got_plt = (char *) info->start_text + offset;
325 info->end_got_plt = (char *) info->start_plt + size;
339 /************************************* Take Snapshot ************************************/
340 /****************************************************************************************/
342 static void MC_get_hash_global(char *snapshot_hash, void *data1, void *data2){
344 /* unsigned int cursor = 0; */
346 /* global_variable_t current_var; */
347 /* void *addr_pointed = NULL; */
348 /* void *res = NULL; */
350 /* xbt_strbuff_t clear = xbt_strbuff_new(); */
352 /* xbt_dynar_foreach(mc_global_variables, cursor, current_var){ */
353 /* if(current_var->address < start_data_libsimgrid){ /\* binary *\/ */
354 /* offset = (char *)current_var->address - (char *)start_data_binary; */
355 /* addr_pointed = *((void **)((char *)data2 + offset)); */
356 /* if(((addr_pointed >= start_plt_binary && addr_pointed <= end_plt_binary)) || ((addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE ))) */
358 /* res = xbt_malloc0(current_var->size + 1); */
359 /* memset(res, 0, current_var->size + 1); */
360 /* memcpy(res, (char*)data2 + offset, current_var->size); */
361 /* }else{ /\* libsimgrid *\/ */
362 /* offset = (char *)current_var->address - (char *)start_data_libsimgrid; */
363 /* addr_pointed = *((void **)((char *)data1 + offset)); */
364 /* if((addr_pointed >= start_plt_libsimgrid && addr_pointed <= end_plt_libsimgrid) || (addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE )) */
366 /* res = xbt_malloc0(current_var->size + 1); */
367 /* memset(res, 0, current_var->size + 1); */
368 /* memcpy(res, (char*)data1 + offset, current_var->size); */
370 /* if(res != NULL){ */
371 /* xbt_strbuff_append(clear, (const char*)res); */
377 /* xbt_sha(clear->data, snapshot_hash); */
379 /* xbt_strbuff_free(clear); */
383 static void MC_get_hash_local(char *snapshot_hash, xbt_dynar_t stacks){
385 /* xbt_dynar_t tokens = NULL, s_tokens = NULL; */
386 /* unsigned int cursor1 = 0, cursor2 = 0; */
387 /* mc_snapshot_stack_t current_stack; */
388 /* char *frame_name = NULL; */
391 /* xbt_strbuff_t clear = xbt_strbuff_new(); */
393 /* while(cursor1 < xbt_dynar_length(stacks)){ */
394 /* current_stack = xbt_dynar_get_as(stacks, cursor1, mc_snapshot_stack_t); */
395 /* tokens = xbt_str_split(current_stack->local_variables->data, NULL); */
397 /* while(cursor2 < xbt_dynar_length(tokens)){ */
398 /* s_tokens = xbt_str_split(xbt_dynar_get_as(tokens, cursor2, char *), "="); */
399 /* if(xbt_dynar_length(s_tokens) > 1){ */
400 /* if(strcmp(xbt_dynar_get_as(s_tokens, 0, char *), "frame_name") == 0){ */
401 /* xbt_free(frame_name); */
402 /* frame_name = xbt_strdup(xbt_dynar_get_as(s_tokens, 1, char *)); */
403 /* xbt_strbuff_append(clear, (const char*)xbt_dynar_get_as(tokens, cursor2, char *)); */
405 /* xbt_dynar_free(&s_tokens); */
408 /* addr = (void *) strtoul(xbt_dynar_get_as(s_tokens, 1, char *), NULL, 16); */
409 /* if(addr > std_heap && (char *)addr <= (char *)std_heap + STD_HEAP_SIZE){ */
411 /* xbt_dynar_free(&s_tokens); */
414 /* if(is_stack_ignore_variable(frame_name, xbt_dynar_get_as(s_tokens, 0, char *))){ */
416 /* xbt_dynar_free(&s_tokens); */
419 /* xbt_strbuff_append(clear, (const char *)xbt_dynar_get_as(tokens, cursor2, char *)); */
421 /* xbt_dynar_free(&s_tokens); */
424 /* xbt_dynar_free(&tokens); */
428 /* xbt_free(frame_name); */
430 /* xbt_sha(clear->data, snapshot_hash); */
432 /* xbt_strbuff_free(clear); */
436 static xbt_dynar_t MC_get_local_variables_values(void *stack_context){
441 char frame_name[256];
443 ret = unw_init_local(&c, (unw_context_t *)stack_context);
445 XBT_INFO("unw_init_local failed");
449 unw_word_t ip, sp, off;
452 unsigned int cursor = 0;
453 dw_variable_t current_variable;
454 dw_location_entry_t entry = NULL;
455 dw_location_t location_entry = NULL;
457 int frame_found = 0, region_type;
458 void *frame_pointer_address = NULL;
462 xbt_dynar_t variables = xbt_dynar_new(sizeof(local_variable_t), local_variable_free_voidp);
464 while(ret >= 0 && !stop){
466 unw_get_reg(&c, UNW_REG_IP, &ip);
467 unw_get_reg(&c, UNW_REG_SP, &sp);
469 unw_get_proc_name(&c, frame_name, sizeof (frame_name), &off);
471 if(!strcmp(frame_name, "smx_ctx_sysv_wrapper")) /* Stop before context switch with maestro */
474 if((long)ip > (long) mc_libsimgrid_info->start_text)
475 frame = xbt_dict_get_or_null(mc_libsimgrid_info->local_variables, frame_name);
477 frame = xbt_dict_get_or_null(mc_binary_info->local_variables, frame_name);
484 true_ip = (long)frame->low_pc + (long)off;
485 frame_pointer_address = NULL;
487 /* Get frame pointer */
488 switch(frame->frame_base->type){
491 while(cursor < xbt_dynar_length(frame->frame_base->location.loclist) && !frame_found){
492 entry = xbt_dynar_get_as(frame->frame_base->location.loclist, cursor, dw_location_entry_t);
493 if((true_ip >= entry->lowpc) && (true_ip < entry->highpc)){
495 switch(entry->location->type){
497 if(xbt_dynar_length(entry->location->location.compose) > 1){
498 frame_pointer_address = NULL; /* TODO : location list with optimizations enabled */
500 location_entry = xbt_dynar_get_as(entry->location->location.compose, 0, dw_location_t);
501 switch(location_entry->type){
503 unw_get_reg(&c, location_entry->location.reg, &res);
504 frame_pointer_address = (void*)(long)res;
506 case e_dw_bregister_op:
507 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
508 frame_pointer_address = (void*)((long)res + location_entry->location.breg_op.offset);
511 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled) */
517 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled) */
525 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled)*/
532 xbt_dynar_foreach(frame->variables, cursor, current_variable){
534 if((long)ip > (long)mc_libsimgrid_info->start_text)
539 local_variable_t new_var = xbt_new0(s_local_variable_t, 1);
540 new_var->frame = xbt_strdup(frame_name);
541 new_var->ip = (unsigned long)ip;
542 new_var->name = xbt_strdup(current_variable->name);
543 new_var->type = strdup(current_variable->type_origin);
544 new_var->region= region_type;
546 if(current_variable->address.location != NULL){
547 switch(current_variable->address.location->type){
549 if(xbt_dynar_length(current_variable->address.location->location.compose) > 1){
550 /* TODO : location list with optimizations enabled */
552 location_entry = xbt_dynar_get_as(current_variable->address.location->location.compose, 0, dw_location_t);
554 switch(location_entry->type){
556 unw_get_reg(&c, location_entry->location.reg, &res);
559 case e_dw_bregister_op:
560 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
561 value = (long)res + location_entry->location.breg_op.offset;
563 case e_dw_fbregister_op:
564 if(frame_pointer_address != NULL)
565 value = (long)((char *)frame_pointer_address + location_entry->location.fbreg_op);
570 value = 0; /* FIXME : implement other cases (with optimizations enabled)*/
575 new_var->address = (void *)value;
577 new_var->address = NULL;
585 xbt_dynar_push(variables, &new_var);
598 static void *MC_get_stack_pointer(void *stack_context, void *heap){
604 ret = unw_init_local(&c, (unw_context_t *)stack_context);
606 XBT_INFO("unw_init_local failed");
610 unw_get_reg(&c, UNW_REG_SP, &sp);
612 return ((char *)heap + (size_t)(((char *)((long)sp) - (char*)std_heap)));
616 static xbt_dynar_t MC_take_snapshot_stacks(mc_snapshot_t *snapshot, void *heap){
618 xbt_dynar_t res = xbt_dynar_new(sizeof(s_mc_snapshot_stack_t), MC_snapshot_stack_free_voidp);
620 unsigned int cursor = 0;
621 stack_region_t current_stack;
623 xbt_dynar_foreach(stacks_areas, cursor, current_stack){
624 mc_snapshot_stack_t st = xbt_new(s_mc_snapshot_stack_t, 1);
625 st->local_variables = MC_get_local_variables_values(current_stack->context);
626 st->stack_pointer = MC_get_stack_pointer(current_stack->context, heap);
627 st->real_address = current_stack->address;
628 xbt_dynar_push(res, &st);
629 (*snapshot)->stack_sizes = xbt_realloc((*snapshot)->stack_sizes, (cursor + 1) * sizeof(size_t));
630 (*snapshot)->stack_sizes[cursor] = current_stack->size - ((char *)st->stack_pointer - (char *)((char *)heap + ((char *)current_stack->address - (char *)std_heap)));
637 static xbt_dynar_t MC_take_snapshot_ignore(){
639 if(mc_heap_comparison_ignore == NULL)
642 xbt_dynar_t cpy = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
644 unsigned int cursor = 0;
645 mc_heap_ignore_region_t current_region;
647 xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, current_region){
648 mc_heap_ignore_region_t new_region = NULL;
649 new_region = xbt_new0(s_mc_heap_ignore_region_t, 1);
650 new_region->address = current_region->address;
651 new_region->size = current_region->size;
652 new_region->block = current_region->block;
653 new_region->fragment = current_region->fragment;
654 xbt_dynar_push(cpy, &new_region);
661 static void MC_dump_checkpoint_ignore(mc_snapshot_t snapshot){
663 unsigned int cursor = 0;
664 mc_checkpoint_ignore_region_t region;
667 xbt_dynar_foreach(mc_checkpoint_ignore, cursor, region){
668 if(region->addr > snapshot->regions[0]->start_addr && (char *)(region->addr) < (char *)snapshot->regions[0]->start_addr + STD_HEAP_SIZE){
669 offset = (char *)region->addr - (char *)snapshot->regions[0]->start_addr;
670 memset((char *)snapshot->regions[0]->data + offset, 0, region->size);
671 }else if(region->addr > snapshot->regions[2]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[2]->start_addr + snapshot->regions[2]->size){
672 offset = (char *)region->addr - (char *)snapshot->regions[2]->start_addr;
673 memset((char *)snapshot->regions[2]->data + offset, 0, region->size);
674 }else if(region->addr > snapshot->regions[1]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[1]->start_addr + snapshot->regions[1]->size){
675 offset = (char *)region->addr - (char *)snapshot->regions[1]->start_addr;
676 memset((char *)snapshot->regions[1]->data + offset, 0, region->size);
683 mc_snapshot_t MC_take_snapshot(int num_state){
685 mc_snapshot_t snapshot = xbt_new0(s_mc_snapshot_t, 1);
686 snapshot->nb_processes = xbt_swag_size(simix_global->process_list);
688 /* Save the std heap and the writable mapped pages of libsimgrid and binary */
689 MC_get_memory_regions(snapshot);
691 snapshot->to_ignore = MC_take_snapshot_ignore();
693 if(_sg_mc_visited > 0 || strcmp(_sg_mc_property_file,"")){
694 snapshot->stacks = MC_take_snapshot_stacks(&snapshot, snapshot->regions[0]->data);
695 //MC_get_hash_global(snapshot->hash_global, snapshot->regions[1]->data, snapshot->regions[2]->data);
696 //MC_get_hash_local(snapshot->hash_local, snapshot->stacks);
700 MC_dump_checkpoint_ignore(snapshot);
706 void MC_restore_snapshot(mc_snapshot_t snapshot){
708 for(i=0; i < NB_REGIONS; i++){
709 MC_region_restore(snapshot->regions[i]);
714 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall){
715 return MC_take_snapshot(1);
718 void *MC_snapshot(void){
719 return simcall_mc_snapshot();