Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : minor fix
[simgrid.git] / src / mc / mc_checkpoint.c
1 /* Copyright (c) 2008-2013. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #define _GNU_SOURCE
8 #include <string.h>
9 #include <link.h>
10 #include "mc_private.h"
11 #include "xbt/module.h"
12
13 #include "../simix/smx_private.h"
14
15 #include <libunwind.h>
16 #include <libelf.h>
17
18 #include "mc_private.h"
19
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc,
21                                 "Logging specific to mc_checkpoint");
22
23 char *libsimgrid_path;
24
25 static void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
26
27 /************************************  Free functions **************************************/
28 /*****************************************************************************************/
29
30 static void MC_snapshot_stack_free(mc_snapshot_stack_t s){
31   if(s){
32     xbt_dynar_free(&(s->local_variables));
33     xbt_free(s);
34   }
35 }
36
37 static void MC_snapshot_stack_free_voidp(void *s){
38   MC_snapshot_stack_free((mc_snapshot_stack_t) * (void **) s);
39 }
40
41 static void local_variable_free(local_variable_t v){
42   xbt_free(v->frame);
43   xbt_free(v->name);
44   xbt_free(v->type);
45   xbt_free(v);
46 }
47
48 static void local_variable_free_voidp(void *v){
49   local_variable_free((local_variable_t) * (void **) v);
50 }
51
52 static void MC_region_destroy(mc_mem_region_t reg)
53 {
54   xbt_free(reg->data);
55   xbt_free(reg);
56 }
57
58 void MC_free_snapshot(mc_snapshot_t snapshot){
59   unsigned int i;
60   for(i=0; i < NB_REGIONS; i++)
61     MC_region_destroy(snapshot->regions[i]);
62
63   xbt_free(snapshot->stack_sizes);
64   xbt_dynar_free(&(snapshot->stacks));
65   xbt_dynar_free(&(snapshot->to_ignore));
66   xbt_free(snapshot);
67 }
68
69
70 /*******************************  Snapshot regions ********************************/
71 /*********************************************************************************/
72
73 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size)
74 {
75   mc_mem_region_t new_reg = xbt_new0(s_mc_mem_region_t, 1);
76   new_reg->start_addr = start_addr;
77   new_reg->size = size;
78   new_reg->data = xbt_malloc0(size);
79   memcpy(new_reg->data, start_addr, size);
80
81   XBT_DEBUG("New region : type : %d, data : %p (real addr %p), size : %zu", type, new_reg->data, start_addr, size);
82   
83   return new_reg;
84 }
85
86 static void MC_region_restore(mc_mem_region_t reg)
87 {
88   /*FIXME: check if start_addr is still mapped, if it is not, then map it
89     before copying the data */
90  
91   memcpy(reg->start_addr, reg->data, reg->size);
92   return;
93 }
94
95 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size)
96 {
97   mc_mem_region_t new_reg = MC_region_new(type, start_addr, size);
98   snapshot->regions[type] = new_reg;
99   return;
100
101
102 static void MC_get_memory_regions(mc_snapshot_t snapshot){
103
104   FILE *fp;
105   char *line = NULL;
106   ssize_t read;
107   size_t n = 0;
108   
109   char *lfields[6] = {0}, *tok;
110   void *start_addr, *start_addr1, *end_addr;
111   size_t size;
112   int i;
113
114   fp = fopen("/proc/self/maps", "r");
115   
116   xbt_assert(fp, 
117              "Cannot open /proc/self/maps to investigate the memory map of the process. Please report this bug.");
118
119   setbuf(fp, NULL);
120
121   while((read = xbt_getline(&line, &n, fp)) != -1){
122
123     /* Wipeout the new line character */
124     line[read - 1] = '\0';
125
126     /* Tokenize the line using spaces as delimiters and store each token */
127     lfields[0] = strtok(line, " ");
128
129     for (i = 1; i < 6 && lfields[i - 1] != NULL; i++) {
130       lfields[i] = strtok(NULL, " ");
131     }
132
133     /* First get the permissions flags, need write permission */
134     if(lfields[1][1] == 'w'){
135
136       /* Get the start address of the map */
137       tok = strtok(lfields[0], "-");
138       start_addr = (void *)strtoul(tok, NULL, 16);
139     
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, " ");
157               }
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;
163               }
164             }
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, " ");
176               }
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;
188                 }
189               }
190             }
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);
196           }
197         }
198       }
199     }
200     
201   }
202
203   free(line);
204   fclose(fp);
205
206 }
207
208 /** @brief Finds the range of the different memory segments and binary paths */
209 void MC_init_memory_map_info(){
210  
211   unsigned int i = 0;
212   s_map_region_t reg;
213   memory_map_t maps = MC_get_memory_map();
214
215   maestro_stack_start = NULL;
216   maestro_stack_end = NULL;
217   libsimgrid_path = NULL;
218
219   while (i < maps->mapsize) {
220     reg = maps->regions[i];
221     if (maps->regions[i].pathname == NULL) {
222       // Nothing to do
223     }
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);
230     }
231     i++;
232   }
233
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&");
237
238   MC_free_memory_map(maps);
239
240 }
241
242 /** \brief Finds informations about a given shared object/executable */
243 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name) {
244   mc_object_info_t result = MC_new_object_info();
245   result->file_name = xbt_strdup(name);
246   result->start_data = NULL;
247   result->start_text = NULL;
248   MC_find_object_address(maps, result);
249   MC_dwarf_get_variables(result);
250   return result;
251 }
252
253 /** \brief Fills the position of the .bss and .data sections. */
254 static void MC_find_object_address(memory_map_t maps, mc_object_info_t result) {
255
256   unsigned int i = 0;
257   s_map_region_t reg;
258   const char* name = basename(result->file_name);
259   while (i < maps->mapsize) {
260     reg = maps->regions[i];
261     if (maps->regions[i].pathname == NULL || strcmp(basename(maps->regions[i].pathname),  name)) {
262       // Nothing to do
263     }
264     else if ((reg.prot & PROT_WRITE)){
265           result->start_data = reg.start_addr;
266     } else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC)){
267           result->start_text = reg.start_addr;
268     }
269     i++;
270   }
271
272   xbt_assert(result->file_name);
273   xbt_assert(result->start_data);
274   xbt_assert(result->start_text);
275 }
276
277 /************************************* Take Snapshot ************************************/
278 /****************************************************************************************/
279
280 static void MC_get_hash_global(char *snapshot_hash, void *data1, void *data2){
281   
282   /* unsigned int cursor = 0; */
283   /* size_t offset;  */
284   /* global_variable_t current_var;  */
285   /* void *addr_pointed = NULL; */
286   /* void *res = NULL; */
287
288   /* xbt_strbuff_t clear = xbt_strbuff_new(); */
289   
290   /* xbt_dynar_foreach(mc_global_variables, cursor, current_var){ */
291   /*   if(current_var->address < start_data_libsimgrid){ /\* binary *\/ */
292   /*     offset = (char *)current_var->address - (char *)start_data_binary; */
293   /*     addr_pointed = *((void **)((char *)data2 + offset)); */
294   /*     if(((addr_pointed >= start_plt_binary && addr_pointed <= end_plt_binary)) || ((addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE ))) */
295   /*       continue; */
296   /*     res = xbt_malloc0(current_var->size + 1); */
297   /*     memset(res, 0, current_var->size + 1); */
298   /*     memcpy(res, (char*)data2 + offset, current_var->size); */
299   /*   }else{ /\* libsimgrid *\/ */
300   /*     offset = (char *)current_var->address - (char *)start_data_libsimgrid; */
301   /*     addr_pointed = *((void **)((char *)data1 + offset)); */
302   /*     if((addr_pointed >= start_plt_libsimgrid && addr_pointed <= end_plt_libsimgrid) || (addr_pointed >= std_heap && (char *)addr_pointed <= (char *)std_heap + STD_HEAP_SIZE )) */
303   /*       continue; */
304   /*     res = xbt_malloc0(current_var->size + 1); */
305   /*     memset(res, 0, current_var->size + 1); */
306   /*     memcpy(res, (char*)data1 + offset, current_var->size); */
307   /*   } */
308   /*   if(res != NULL){ */
309   /*     xbt_strbuff_append(clear, (const char*)res); */
310   /*     xbt_free(res); */
311   /*     res = NULL; */
312   /*   } */
313   /* } */
314
315   /* xbt_sha(clear->data, snapshot_hash); */
316
317   /* xbt_strbuff_free(clear); */
318
319 }
320
321 static void MC_get_hash_local(char *snapshot_hash, xbt_dynar_t stacks){
322
323   /* xbt_dynar_t tokens = NULL, s_tokens = NULL; */
324   /* unsigned int cursor1 = 0, cursor2 = 0; */
325   /* mc_snapshot_stack_t current_stack; */
326   /* char *frame_name = NULL; */
327   /* void *addr; */
328
329   /* xbt_strbuff_t clear = xbt_strbuff_new(); */
330
331   /* while(cursor1 < xbt_dynar_length(stacks)){ */
332   /*   current_stack = xbt_dynar_get_as(stacks, cursor1, mc_snapshot_stack_t); */
333   /*   tokens = xbt_str_split(current_stack->local_variables->data, NULL); */
334   /*   cursor2 = 0; */
335   /*   while(cursor2 < xbt_dynar_length(tokens)){ */
336   /*     s_tokens = xbt_str_split(xbt_dynar_get_as(tokens, cursor2, char *), "="); */
337   /*     if(xbt_dynar_length(s_tokens) > 1){ */
338   /*       if(strcmp(xbt_dynar_get_as(s_tokens, 0, char *), "frame_name") == 0){ */
339   /*         xbt_free(frame_name); */
340   /*         frame_name = xbt_strdup(xbt_dynar_get_as(s_tokens, 1, char *)); */
341   /*         xbt_strbuff_append(clear, (const char*)xbt_dynar_get_as(tokens, cursor2, char *)); */
342   /*         cursor2++; */
343   /*         xbt_dynar_free(&s_tokens); */
344   /*         continue; */
345   /*       } */
346   /*       addr = (void *) strtoul(xbt_dynar_get_as(s_tokens, 1, char *), NULL, 16); */
347   /*       if(addr > std_heap && (char *)addr <= (char *)std_heap + STD_HEAP_SIZE){ */
348   /*         cursor2++; */
349   /*         xbt_dynar_free(&s_tokens); */
350   /*         continue; */
351   /*       } */
352   /*       if(is_stack_ignore_variable(frame_name, xbt_dynar_get_as(s_tokens, 0, char *))){ */
353   /*         cursor2++; */
354   /*         xbt_dynar_free(&s_tokens); */
355   /*         continue; */
356   /*       } */
357   /*       xbt_strbuff_append(clear, (const char *)xbt_dynar_get_as(tokens, cursor2, char *)); */
358   /*     } */
359   /*     xbt_dynar_free(&s_tokens); */
360   /*     cursor2++; */
361   /*   } */
362   /*   xbt_dynar_free(&tokens); */
363   /*   cursor1++; */
364   /* } */
365
366   /* xbt_free(frame_name); */
367
368   /* xbt_sha(clear->data, snapshot_hash); */
369
370   /* xbt_strbuff_free(clear); */
371
372 }
373
374
375
376 static xbt_dynar_t MC_get_local_variables_values(void *stack_context){
377   
378   unw_cursor_t c;
379   int ret;
380
381   char frame_name[256];
382   
383   ret = unw_init_local(&c, (unw_context_t *)stack_context);
384   if(ret < 0){
385     XBT_INFO("unw_init_local failed");
386     xbt_abort();
387   }
388
389   unw_word_t ip, sp, off;
390   dw_frame_t frame;
391
392   unsigned int cursor = 0;
393   dw_variable_t current_variable;
394   dw_location_entry_t entry = NULL;
395   int frame_found = 0, region_type;
396   void *frame_pointer_address = NULL;
397   long true_ip;
398   int stop = 0;
399
400   xbt_dynar_t variables = xbt_dynar_new(sizeof(local_variable_t), local_variable_free_voidp);
401
402   while(ret >= 0 && !stop){
403
404     unw_get_reg(&c, UNW_REG_IP, &ip);
405     unw_get_reg(&c, UNW_REG_SP, &sp);
406
407     unw_get_proc_name(&c, frame_name, sizeof (frame_name), &off);
408
409     if(!strcmp(frame_name, "smx_ctx_sysv_wrapper")) /* Stop before context switch with maestro */
410       stop = 1;
411
412     if((long)ip > (long) mc_libsimgrid_info->start_text)
413       frame = xbt_dict_get_or_null(mc_libsimgrid_info->local_variables, frame_name);
414     else
415       frame = xbt_dict_get_or_null(mc_binary_info->local_variables, frame_name);
416
417     if(frame == NULL){
418       ret = unw_step(&c);
419       continue;
420     }
421     
422     true_ip = (long)frame->low_pc + (long)off;
423     frame_pointer_address = NULL;
424
425     /* Get frame pointer */
426     switch(frame->frame_base->type){
427     case e_dw_loclist:
428       cursor = 0;
429       while(cursor < xbt_dynar_length(frame->frame_base->location.loclist) && !frame_found){
430         entry = xbt_dynar_get_as(frame->frame_base->location.loclist, cursor, dw_location_entry_t);
431         if((true_ip >= entry->lowpc) && (true_ip < entry->highpc)){
432           frame_found = 1;
433           frame_pointer_address =  (void*) MC_dwarf_resolve_location(&c, entry->location, NULL);
434         }
435         cursor++;
436       }
437       break;
438     default :
439       frame_pointer_address = NULL; /* FIXME : implement other cases (with optimizations enabled)*/
440       break;
441     }
442
443     frame_found = 0;
444     cursor = 0;
445
446     xbt_dynar_foreach(frame->variables, cursor, current_variable){
447       
448       if((long)ip > (long)mc_libsimgrid_info->start_text)
449         region_type = 1;
450       else
451         region_type = 2;
452
453       local_variable_t new_var = xbt_new0(s_local_variable_t, 1);
454       new_var->frame = xbt_strdup(frame_name);
455       new_var->ip = (unsigned long)ip;
456       new_var->name = xbt_strdup(current_variable->name);
457       new_var->type = strdup(current_variable->type_origin);
458       new_var->region= region_type;
459       
460       if(current_variable->address.location != NULL){
461         new_var->address = (void*) MC_dwarf_resolve_location(&c, current_variable->address.location, frame_pointer_address);
462       }
463
464       xbt_dynar_push(variables, &new_var);
465
466     }
467
468     ret = unw_step(&c);
469      
470   }
471
472   return variables;
473
474 }
475
476
477 static void *MC_get_stack_pointer(void *stack_context, void *heap){
478
479   unw_cursor_t c;
480   int ret;
481   unw_word_t sp;
482
483   ret = unw_init_local(&c, (unw_context_t *)stack_context);
484   if(ret < 0){
485     XBT_INFO("unw_init_local failed");
486     xbt_abort();
487   }
488
489   unw_get_reg(&c, UNW_REG_SP, &sp);
490
491   return ((char *)heap + (size_t)(((char *)((long)sp) - (char*)std_heap)));
492
493 }
494
495 static xbt_dynar_t MC_take_snapshot_stacks(mc_snapshot_t *snapshot, void *heap){
496
497   xbt_dynar_t res = xbt_dynar_new(sizeof(s_mc_snapshot_stack_t), MC_snapshot_stack_free_voidp);
498
499   unsigned int cursor = 0;
500   stack_region_t current_stack;
501   
502   xbt_dynar_foreach(stacks_areas, cursor, current_stack){
503     mc_snapshot_stack_t st = xbt_new(s_mc_snapshot_stack_t, 1);
504     st->local_variables = MC_get_local_variables_values(current_stack->context);
505     st->stack_pointer = MC_get_stack_pointer(current_stack->context, heap);
506     st->real_address = current_stack->address;
507     xbt_dynar_push(res, &st);
508     (*snapshot)->stack_sizes = xbt_realloc((*snapshot)->stack_sizes, (cursor + 1) * sizeof(size_t));
509     (*snapshot)->stack_sizes[cursor] = current_stack->size - ((char *)st->stack_pointer - (char *)((char *)heap + ((char *)current_stack->address - (char *)std_heap)));
510   }
511
512   return res;
513
514 }
515
516 static xbt_dynar_t MC_take_snapshot_ignore(){
517   
518   if(mc_heap_comparison_ignore == NULL)
519     return NULL;
520
521   xbt_dynar_t cpy = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
522
523   unsigned int cursor = 0;
524   mc_heap_ignore_region_t current_region;
525
526   xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, current_region){
527     mc_heap_ignore_region_t new_region = NULL;
528     new_region = xbt_new0(s_mc_heap_ignore_region_t, 1);
529     new_region->address = current_region->address;
530     new_region->size = current_region->size;
531     new_region->block = current_region->block;
532     new_region->fragment = current_region->fragment;
533     xbt_dynar_push(cpy, &new_region);
534   }
535
536   return cpy;
537
538 }
539
540 static void MC_dump_checkpoint_ignore(mc_snapshot_t snapshot){
541   
542   unsigned int cursor = 0;
543   mc_checkpoint_ignore_region_t region;
544   size_t offset;
545   
546   xbt_dynar_foreach(mc_checkpoint_ignore, cursor, region){
547     if(region->addr > snapshot->regions[0]->start_addr && (char *)(region->addr) < (char *)snapshot->regions[0]->start_addr + STD_HEAP_SIZE){
548       offset = (char *)region->addr - (char *)snapshot->regions[0]->start_addr;
549       memset((char *)snapshot->regions[0]->data + offset, 0, region->size);
550     }else if(region->addr > snapshot->regions[2]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[2]->start_addr + snapshot->regions[2]->size){
551       offset = (char *)region->addr - (char *)snapshot->regions[2]->start_addr;
552       memset((char *)snapshot->regions[2]->data + offset, 0, region->size);
553     }else if(region->addr > snapshot->regions[1]->start_addr && (char *)(region->addr) < (char*)snapshot->regions[1]->start_addr + snapshot->regions[1]->size){
554       offset = (char *)region->addr - (char *)snapshot->regions[1]->start_addr;
555       memset((char *)snapshot->regions[1]->data + offset, 0, region->size);
556     }
557   }
558
559 }
560
561
562 mc_snapshot_t MC_take_snapshot(int num_state){
563
564   mc_snapshot_t snapshot = xbt_new0(s_mc_snapshot_t, 1);
565   snapshot->nb_processes = xbt_swag_size(simix_global->process_list);
566
567   /* Save the std heap and the writable mapped pages of libsimgrid and binary */
568   MC_get_memory_regions(snapshot);
569
570   snapshot->to_ignore = MC_take_snapshot_ignore();
571
572   if(_sg_mc_visited > 0 || strcmp(_sg_mc_property_file,"")){
573     snapshot->stacks = MC_take_snapshot_stacks(&snapshot, snapshot->regions[0]->data);
574     //MC_get_hash_global(snapshot->hash_global, snapshot->regions[1]->data, snapshot->regions[2]->data);
575     //MC_get_hash_local(snapshot->hash_local, snapshot->stacks);
576   }
577
578   if(num_state > 0)
579     MC_dump_checkpoint_ignore(snapshot);
580
581   return snapshot;
582
583 }
584
585 void MC_restore_snapshot(mc_snapshot_t snapshot){
586   unsigned int i;
587   for(i=0; i < NB_REGIONS; i++){
588     MC_region_restore(snapshot->regions[i]);
589   }
590
591 }
592
593 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall){
594   return MC_take_snapshot(1);
595 }
596
597 void *MC_snapshot(void){
598   return simcall_mc_snapshot();
599 }