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 #include "mc_private.h"
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc,
19 "Logging specific to mc_checkpoint");
21 char *libsimgrid_path;
23 static void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
24 static void MC_get_plt_section(mc_object_info_t info);
26 /************************************ Free functions **************************************/
27 /*****************************************************************************************/
29 static void MC_snapshot_stack_free(mc_snapshot_stack_t s){
31 xbt_dynar_free(&(s->local_variables));
36 static void MC_snapshot_stack_free_voidp(void *s){
37 MC_snapshot_stack_free((mc_snapshot_stack_t) * (void **) s);
40 static void local_variable_free(local_variable_t v){
47 static void local_variable_free_voidp(void *v){
48 local_variable_free((local_variable_t) * (void **) v);
51 static void MC_region_destroy(mc_mem_region_t reg)
57 void MC_free_snapshot(mc_snapshot_t snapshot){
59 for(i=0; i < NB_REGIONS; i++)
60 MC_region_destroy(snapshot->regions[i]);
62 xbt_free(snapshot->stack_sizes);
63 xbt_dynar_free(&(snapshot->stacks));
64 xbt_dynar_free(&(snapshot->to_ignore));
69 /******************************* Snapshot regions ********************************/
70 /*********************************************************************************/
72 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size)
74 mc_mem_region_t new_reg = xbt_new0(s_mc_mem_region_t, 1);
75 new_reg->start_addr = start_addr;
77 new_reg->data = xbt_malloc0(size);
78 memcpy(new_reg->data, start_addr, size);
80 XBT_DEBUG("New region : type : %d, data : %p (real addr %p), size : %zu", type, new_reg->data, start_addr, size);
85 static void MC_region_restore(mc_mem_region_t reg)
87 /*FIXME: check if start_addr is still mapped, if it is not, then map it
88 before copying the data */
90 memcpy(reg->start_addr, reg->data, reg->size);
94 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size)
96 mc_mem_region_t new_reg = MC_region_new(type, start_addr, size);
97 snapshot->regions[type] = new_reg;
101 static void MC_get_memory_regions(mc_snapshot_t snapshot){
108 char *lfields[6] = {0}, *tok;
109 void *start_addr, *start_addr1, *end_addr;
113 fp = fopen("/proc/self/maps", "r");
116 "Cannot open /proc/self/maps to investigate the memory map of the process. Please report this bug.");
120 while((read = xbt_getline(&line, &n, fp)) != -1){
122 /* Wipeout the new line character */
123 line[read - 1] = '\0';
125 /* Tokenize the line using spaces as delimiters and store each token */
126 lfields[0] = strtok(line, " ");
128 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
129 lfields[i] = strtok(NULL, " ");
132 /* First get the permissions flags, need write permission */
133 if(lfields[1][1] == 'w'){
135 /* Get the start address of the map */
136 tok = strtok(lfields[0], "-");
137 start_addr = (void *)strtoul(tok, NULL, 16);
139 if(start_addr == std_heap){ /* Std_heap ? */
140 tok = strtok(NULL, "-");
141 end_addr = (void *)strtoul(tok, NULL, 16);
142 MC_snapshot_add_region(snapshot, 0, start_addr, (char*)end_addr - (char*)start_addr);
143 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
144 }else{ /* map name == libsimgrid || binary_name ? */
145 if(lfields[5] != NULL){
146 if(!memcmp(basename(lfields[5]), "libsimgrid", 10)){
147 tok = strtok(NULL, "-");
148 end_addr = (void *)strtoul(tok, NULL, 16);
149 size = (char*)end_addr - (char*)start_addr;
150 /* BSS and data segments may be separated according to the OS */
151 if((read = xbt_getline(&line, &n, fp)) != -1){
152 line[read - 1] = '\0';
153 lfields[0] = strtok(line, " ");
154 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
155 lfields[i] = strtok(NULL, " ");
157 if(lfields[1][1] == 'w' && lfields[5] == NULL){
158 tok = strtok(lfields[0], "-");
159 start_addr1 = (void *)strtoul(tok, NULL, 16);
160 tok = strtok(NULL, "-");
161 size += (char *)(void *)strtoul(tok, NULL, 16) - (char*)start_addr1;
164 MC_snapshot_add_region(snapshot, 1, start_addr, size);
165 }else if(!memcmp(basename(lfields[5]), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
166 tok = strtok(NULL, "-");
167 end_addr = (void *)strtoul(tok, NULL, 16);
168 size = (char*)end_addr - (char*)start_addr;
169 /* BSS and data segments may be separated according to the OS */
170 if((read = xbt_getline(&line, &n, fp)) != -1){
171 line[read - 1] = '\0';
172 lfields[0] = strtok(line, " ");
173 for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
174 lfields[i] = strtok(NULL, " ");
176 tok = strtok(lfields[0], "-");
177 start_addr1 = (void *)strtoul(tok, NULL, 16);
178 if(lfields[1][1] == 'w'){
179 if(start_addr1 == std_heap){ /* Std_heap ? */
180 tok = strtok(NULL, "-");
181 end_addr = (void *)strtoul(tok, NULL, 16);
182 MC_snapshot_add_region(snapshot, 0, start_addr1, (char*)end_addr - (char*)start_addr1);
183 snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
184 }else if(start_addr1 != raw_heap){
185 tok = strtok(NULL, "-");
186 size += (char *)(void *)strtoul(tok, NULL, 16) - (char *)start_addr1;
190 MC_snapshot_add_region(snapshot, 2, start_addr, size);
191 }else if (!memcmp(lfields[5], "[stack]", 7)){
192 maestro_stack_start = start_addr;
193 tok = strtok(NULL, "-");
194 maestro_stack_end = (void *)strtoul(tok, NULL, 16);
207 /** @brief Finds the range of the different memory segments and binary paths */
208 void MC_init_memory_map_info(){
212 memory_map_t maps = MC_get_memory_map();
214 maestro_stack_start = NULL;
215 maestro_stack_end = NULL;
216 libsimgrid_path = NULL;
218 while (i < maps->mapsize) {
219 reg = maps->regions[i];
220 if (maps->regions[i].pathname == NULL) {
223 else if ((reg.prot & PROT_WRITE) && !memcmp(maps->regions[i].pathname, "[stack]", 7)){
224 maestro_stack_start = reg.start_addr;
225 maestro_stack_end = reg.end_addr;
226 } else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC) && !memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
227 if(libsimgrid_path == NULL)
228 libsimgrid_path = strdup(maps->regions[i].pathname);
233 xbt_assert(maestro_stack_start, "maestro_stack_start");
234 xbt_assert(maestro_stack_end, "maestro_stack_end");
235 xbt_assert(libsimgrid_path, "libsimgrid_path&");
237 MC_free_memory_map(maps);
241 /** \brief Finds informations about a given shared object/executable */
242 mc_object_info_t MC_find_object_info(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;
247 result->start_plt = NULL;
248 result->end_plt = NULL;
249 result->start_got_plt = NULL;
250 result->end_got_plt = NULL;
251 MC_find_object_address(maps, result);
252 MC_get_plt_section(result);
253 result->location_list = MC_dwarf_get_location_list(result->file_name);
254 MC_dwarf_get_variables(result);
258 /** \brief Fills the position of the .bss and .data sections. */
259 static void MC_find_object_address(memory_map_t maps, mc_object_info_t result) {
262 const char* name = basename(result->file_name);
263 while (i < maps->mapsize) {
264 reg = maps->regions[i];
265 if (maps->regions[i].pathname == NULL || strcmp(basename(maps->regions[i].pathname), name)) {
268 else if ((reg.prot & PROT_WRITE)){
269 result->start_data = reg.start_addr;
270 } else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC)){
271 result->start_text = reg.start_addr;
276 xbt_assert(result->file_name);
277 xbt_assert(result->start_data);
278 xbt_assert(result->start_text);
280 MC_get_plt_section(result);
283 /** \brief Fills the position of the .plt and .got.plt sections. */
284 static void MC_get_plt_section(mc_object_info_t info){
287 char *line = NULL; /* Temporal storage for each line that is readed */
288 ssize_t read; /* Number of bytes readed */
289 size_t n = 0; /* Amount of bytes to read by xbt_getline */
292 int i, plt_found = 0;
293 unsigned long int size, offset;
295 char *command = bprintf("LANG=C objdump --section-headers %s", info->file_name);
297 fp = popen(command, "r");
300 perror("popen failed");
304 while ((read = xbt_getline(&line, &n, fp)) != -1 && plt_found != 2) {
309 /* Wipeout the new line character */
310 line[read - 1] = '\0';
312 lfields[0] = strtok(line, " ");
314 if(lfields[0] == NULL)
317 if(strcmp(lfields[0], "Sections:") == 0 || strcmp(lfields[0], "Idx") == 0 || strncmp(lfields[0], info->file_name, strlen(info->file_name)) == 0)
320 for (i = 1; i < 7 && lfields[i - 1] != NULL; i++) {
321 lfields[i] = strtok(NULL, " ");
325 if(strcmp(lfields[1], ".plt") == 0){
326 size = strtoul(lfields[2], NULL, 16);
327 offset = strtoul(lfields[5], NULL, 16);
328 info->start_plt = (char *) info->start_text + offset;
329 info->end_plt = (char *) info->start_plt + size;
331 }else if(strcmp(lfields[1], ".got.plt") == 0){
332 size = strtoul(lfields[2], NULL, 16);
333 offset = strtoul(lfields[5], NULL, 16);
334 info->start_got_plt = (char *) info->start_text + offset;
335 info->end_got_plt = (char *) info->start_plt + size;
349 /************************************* Take Snapshot ************************************/
350 /****************************************************************************************/
352 static void MC_get_hash_global(char *snapshot_hash, void *data1, void *data2){
354 /* unsigned int cursor = 0; */
356 /* global_variable_t current_var; */
357 /* void *addr_pointed = NULL; */
358 /* void *res = NULL; */
360 /* xbt_strbuff_t clear = xbt_strbuff_new(); */
362 /* xbt_dynar_foreach(mc_global_variables, cursor, current_var){ */
363 /* if(current_var->address < start_data_libsimgrid){ /\* binary *\/ */
364 /* offset = (char *)current_var->address - (char *)start_data_binary; */
365 /* addr_pointed = *((void **)((char *)data2 + offset)); */
366 /* if(((addr_pointed >= start_plt_binary && addr_pointed <= end_plt_binary)) || ((addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE ))) */
368 /* res = xbt_malloc0(current_var->size + 1); */
369 /* memset(res, 0, current_var->size + 1); */
370 /* memcpy(res, (char*)data2 + offset, current_var->size); */
371 /* }else{ /\* libsimgrid *\/ */
372 /* offset = (char *)current_var->address - (char *)start_data_libsimgrid; */
373 /* addr_pointed = *((void **)((char *)data1 + offset)); */
374 /* if((addr_pointed >= start_plt_libsimgrid && addr_pointed <= end_plt_libsimgrid) || (addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE )) */
376 /* res = xbt_malloc0(current_var->size + 1); */
377 /* memset(res, 0, current_var->size + 1); */
378 /* memcpy(res, (char*)data1 + offset, current_var->size); */
380 /* if(res != NULL){ */
381 /* xbt_strbuff_append(clear, (const char*)res); */
387 /* xbt_sha(clear->data, snapshot_hash); */
389 /* xbt_strbuff_free(clear); */
393 static void MC_get_hash_local(char *snapshot_hash, xbt_dynar_t stacks){
395 /* xbt_dynar_t tokens = NULL, s_tokens = NULL; */
396 /* unsigned int cursor1 = 0, cursor2 = 0; */
397 /* mc_snapshot_stack_t current_stack; */
398 /* char *frame_name = NULL; */
401 /* xbt_strbuff_t clear = xbt_strbuff_new(); */
403 /* while(cursor1 < xbt_dynar_length(stacks)){ */
404 /* current_stack = xbt_dynar_get_as(stacks, cursor1, mc_snapshot_stack_t); */
405 /* tokens = xbt_str_split(current_stack->local_variables->data, NULL); */
407 /* while(cursor2 < xbt_dynar_length(tokens)){ */
408 /* s_tokens = xbt_str_split(xbt_dynar_get_as(tokens, cursor2, char *), "="); */
409 /* if(xbt_dynar_length(s_tokens) > 1){ */
410 /* if(strcmp(xbt_dynar_get_as(s_tokens, 0, char *), "frame_name") == 0){ */
411 /* xbt_free(frame_name); */
412 /* frame_name = xbt_strdup(xbt_dynar_get_as(s_tokens, 1, char *)); */
413 /* xbt_strbuff_append(clear, (const char*)xbt_dynar_get_as(tokens, cursor2, char *)); */
415 /* xbt_dynar_free(&s_tokens); */
418 /* addr = (void *) strtoul(xbt_dynar_get_as(s_tokens, 1, char *), NULL, 16); */
419 /* if(addr > std_heap && (char *)addr <= (char *)std_heap + STD_HEAP_SIZE){ */
421 /* xbt_dynar_free(&s_tokens); */
424 /* if(is_stack_ignore_variable(frame_name, xbt_dynar_get_as(s_tokens, 0, char *))){ */
426 /* xbt_dynar_free(&s_tokens); */
429 /* xbt_strbuff_append(clear, (const char *)xbt_dynar_get_as(tokens, cursor2, char *)); */
431 /* xbt_dynar_free(&s_tokens); */
434 /* xbt_dynar_free(&tokens); */
438 /* xbt_free(frame_name); */
440 /* xbt_sha(clear->data, snapshot_hash); */
442 /* xbt_strbuff_free(clear); */
448 static xbt_dynar_t MC_get_local_variables_values(void *stack_context){
453 char frame_name[256];
455 ret = unw_init_local(&c, (unw_context_t *)stack_context);
457 XBT_INFO("unw_init_local failed");
461 unw_word_t ip, sp, off;
464 unsigned int cursor = 0;
465 dw_variable_t current_variable;
466 dw_location_entry_t entry = NULL;
467 int frame_found = 0, region_type;
468 void *frame_pointer_address = NULL;
472 xbt_dynar_t variables = xbt_dynar_new(sizeof(local_variable_t), local_variable_free_voidp);
474 while(ret >= 0 && !stop){
476 unw_get_reg(&c, UNW_REG_IP, &ip);
477 unw_get_reg(&c, UNW_REG_SP, &sp);
479 unw_get_proc_name(&c, frame_name, sizeof (frame_name), &off);
481 if(!strcmp(frame_name, "smx_ctx_sysv_wrapper")) /* Stop before context switch with maestro */
484 if((long)ip > (long) mc_libsimgrid_info->start_text)
485 frame = xbt_dict_get_or_null(mc_libsimgrid_info->local_variables, frame_name);
487 frame = xbt_dict_get_or_null(mc_binary_info->local_variables, frame_name);
494 true_ip = (long)frame->low_pc + (long)off;
495 frame_pointer_address = NULL;
497 /* Get frame pointer */
498 switch(frame->frame_base->type){
501 while(cursor < xbt_dynar_length(frame->frame_base->location.loclist) && !frame_found){
502 entry = xbt_dynar_get_as(frame->frame_base->location.loclist, cursor, dw_location_entry_t);
503 if((true_ip >= entry->lowpc) && (true_ip < entry->highpc)){
505 frame_pointer_address = (void*) MC_dwarf_resolve_location(&c, entry->location, NULL);
511 frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled)*/
518 xbt_dynar_foreach(frame->variables, cursor, current_variable){
520 if((long)ip > (long)mc_libsimgrid_info->start_text)
525 local_variable_t new_var = xbt_new0(s_local_variable_t, 1);
526 new_var->frame = xbt_strdup(frame_name);
527 new_var->ip = (unsigned long)ip;
528 new_var->name = xbt_strdup(current_variable->name);
529 new_var->type = strdup(current_variable->type_origin);
530 new_var->region= region_type;
532 if(current_variable->address.location != NULL){
533 new_var->address = (void*) MC_dwarf_resolve_location(&c, current_variable->address.location, frame_pointer_address);
536 xbt_dynar_push(variables, &new_var);
549 static void *MC_get_stack_pointer(void *stack_context, void *heap){
555 ret = unw_init_local(&c, (unw_context_t *)stack_context);
557 XBT_INFO("unw_init_local failed");
561 unw_get_reg(&c, UNW_REG_SP, &sp);
563 return ((char *)heap + (size_t)(((char *)((long)sp) - (char*)std_heap)));
567 static xbt_dynar_t MC_take_snapshot_stacks(mc_snapshot_t *snapshot, void *heap){
569 xbt_dynar_t res = xbt_dynar_new(sizeof(s_mc_snapshot_stack_t), MC_snapshot_stack_free_voidp);
571 unsigned int cursor = 0;
572 stack_region_t current_stack;
574 xbt_dynar_foreach(stacks_areas, cursor, current_stack){
575 mc_snapshot_stack_t st = xbt_new(s_mc_snapshot_stack_t, 1);
576 st->local_variables = MC_get_local_variables_values(current_stack->context);
577 st->stack_pointer = MC_get_stack_pointer(current_stack->context, heap);
578 st->real_address = current_stack->address;
579 xbt_dynar_push(res, &st);
580 (*snapshot)->stack_sizes = xbt_realloc((*snapshot)->stack_sizes, (cursor + 1) * sizeof(size_t));
581 (*snapshot)->stack_sizes[cursor] = current_stack->size - ((char *)st->stack_pointer - (char *)((char *)heap + ((char *)current_stack->address - (char *)std_heap)));
588 static xbt_dynar_t MC_take_snapshot_ignore(){
590 if(mc_heap_comparison_ignore == NULL)
593 xbt_dynar_t cpy = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
595 unsigned int cursor = 0;
596 mc_heap_ignore_region_t current_region;
598 xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, current_region){
599 mc_heap_ignore_region_t new_region = NULL;
600 new_region = xbt_new0(s_mc_heap_ignore_region_t, 1);
601 new_region->address = current_region->address;
602 new_region->size = current_region->size;
603 new_region->block = current_region->block;
604 new_region->fragment = current_region->fragment;
605 xbt_dynar_push(cpy, &new_region);
612 static void MC_dump_checkpoint_ignore(mc_snapshot_t snapshot){
614 unsigned int cursor = 0;
615 mc_checkpoint_ignore_region_t region;
618 xbt_dynar_foreach(mc_checkpoint_ignore, cursor, region){
619 if(region->addr > snapshot->regions[0]->start_addr && (char *)(region->addr) < (char *)snapshot->regions[0]->start_addr + STD_HEAP_SIZE){
620 offset = (char *)region->addr - (char *)snapshot->regions[0]->start_addr;
621 memset((char *)snapshot->regions[0]->data + offset, 0, region->size);
622 }else if(region->addr > snapshot->regions[2]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[2]->start_addr + snapshot->regions[2]->size){
623 offset = (char *)region->addr - (char *)snapshot->regions[2]->start_addr;
624 memset((char *)snapshot->regions[2]->data + offset, 0, region->size);
625 }else if(region->addr > snapshot->regions[1]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[1]->start_addr + snapshot->regions[1]->size){
626 offset = (char *)region->addr - (char *)snapshot->regions[1]->start_addr;
627 memset((char *)snapshot->regions[1]->data + offset, 0, region->size);
634 mc_snapshot_t MC_take_snapshot(int num_state){
636 mc_snapshot_t snapshot = xbt_new0(s_mc_snapshot_t, 1);
637 snapshot->nb_processes = xbt_swag_size(simix_global->process_list);
639 /* Save the std heap and the writable mapped pages of libsimgrid and binary */
640 MC_get_memory_regions(snapshot);
642 snapshot->to_ignore = MC_take_snapshot_ignore();
644 if(_sg_mc_visited > 0 || strcmp(_sg_mc_property_file,"")){
645 snapshot->stacks = MC_take_snapshot_stacks(&snapshot, snapshot->regions[0]->data);
646 //MC_get_hash_global(snapshot->hash_global, snapshot->regions[1]->data, snapshot->regions[2]->data);
647 //MC_get_hash_local(snapshot->hash_local, snapshot->stacks);
651 MC_dump_checkpoint_ignore(snapshot);
657 void MC_restore_snapshot(mc_snapshot_t snapshot){
659 for(i=0; i < NB_REGIONS; i++){
660 MC_region_restore(snapshot->regions[i]);
665 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall){
666 return MC_take_snapshot(1);
669 void *MC_snapshot(void){
670 return simcall_mc_snapshot();