Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
1e8e29f3c18377989c7fcd4fb188d48f9988494a
[simgrid.git] / src / mc / mc_checkpoint.c
1 /* Copyright (c) 2008-2012 Da SimGrid Team. All rights reserved.            */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include <libgen.h>
7 #include "mc_private.h"
8 #include "xbt/module.h"
9
10 #include "../simix/smx_private.h"
11
12 #include <libunwind.h>
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc,
15                                 "Logging specific to mc_checkpoint");
16
17 void *start_text_libsimgrid;
18 void *start_plt_libsimgrid, *end_plt_libsimgrid;
19 void *start_got_plt_libsimgrid, *end_got_plt_libsimgrid;
20 void *start_plt_binary, *end_plt_binary;
21 void *start_got_plt_binary, *end_got_plt_binary;
22 char *libsimgrid_path;
23 void *start_data_libsimgrid, *start_bss_libsimgrid;
24 void *start_data_binary, *start_bss_binary;
25 void *start_text_binary;
26 void *end_raw_heap;
27
28 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size);
29 static void MC_region_restore(mc_mem_region_t reg);
30 static void MC_region_destroy(mc_mem_region_t reg);
31
32 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size);
33
34 static void add_value(xbt_dynar_t *list, const char *type, unsigned long int val);
35 static xbt_dynar_t take_snapshot_stacks(mc_snapshot_t *s, void *heap);
36 static xbt_strbuff_t get_local_variables_values(void *stack_context, void *heap);
37 static void print_local_variables_values(xbt_dynar_t all_variables);
38 static void *get_stack_pointer(void *stack_context, void *heap);
39
40 static void snapshot_stack_free(mc_snapshot_stack_t s);
41
42 static mc_mem_region_t MC_region_new(int type, void *start_addr, size_t size)
43 {
44   mc_mem_region_t new_reg = xbt_new0(s_mc_mem_region_t, 1);
45   new_reg->type = type;
46   new_reg->start_addr = start_addr;
47   new_reg->size = size;
48   new_reg->data = xbt_malloc0(size);
49   memcpy(new_reg->data, start_addr, size);
50
51   XBT_DEBUG("New region : type : %d, data : %p (real addr %p), size : %zu", type, new_reg->data, start_addr, size);
52   
53   return new_reg;
54 }
55
56 static void MC_region_restore(mc_mem_region_t reg)
57 {
58   /*FIXME: check if start_addr is still mapped, if it is not, then map it
59     before copying the data */
60  
61   memcpy(reg->start_addr, reg->data, reg->size);
62  
63   return;
64 }
65
66 static void MC_region_destroy(mc_mem_region_t reg)
67 {
68   xbt_free(reg->data);
69   xbt_free(reg);
70 }
71
72 static void MC_snapshot_add_region(mc_snapshot_t snapshot, int type, void *start_addr, size_t size)
73 {
74   mc_mem_region_t new_reg = MC_region_new(type, start_addr, size);
75   snapshot->regions = xbt_realloc(snapshot->regions, (snapshot->num_reg + 1) * sizeof(mc_mem_region_t));
76   snapshot->regions[snapshot->num_reg] = new_reg;
77   snapshot->region_type[snapshot->num_reg] = type;
78   snapshot->num_reg++;
79   return;
80
81
82 void MC_init_memory_map_info(){
83
84   int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
85
86   MC_SET_RAW_MEM;
87   
88   unsigned int i = 0;
89   s_map_region_t reg;
90   memory_map_t maps = get_memory_map();
91
92   while (i < maps->mapsize) {
93     reg = maps->regions[i];
94     if ((reg.prot & PROT_WRITE)){
95       if (maps->regions[i].pathname != NULL){
96         if (!memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
97           start_data_libsimgrid = reg.start_addr;
98           i++;
99           reg = maps->regions[i];
100           if(reg.pathname == NULL && (reg.prot & PROT_WRITE) && i < maps->mapsize)
101             start_bss_libsimgrid = reg.start_addr;
102         }else if (!memcmp(basename(maps->regions[i].pathname), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
103           start_data_binary = reg.start_addr;
104           i++;
105           reg = maps->regions[i];
106           if(reg.pathname == NULL && (reg.prot & PROT_WRITE) && reg.start_addr != std_heap && reg.start_addr != raw_heap && i < maps->mapsize){
107             start_bss_binary = reg.start_addr;
108             i++;
109           }
110         }else if(!memcmp(maps->regions[i].pathname, "[heap]", 6)){
111           end_raw_heap = reg.end_addr;
112           i++;
113         }
114       }
115     }else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC)){
116       if (maps->regions[i].pathname != NULL){
117         if (!memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
118           start_text_libsimgrid = reg.start_addr;
119           libsimgrid_path = strdup(maps->regions[i].pathname);
120         }else if (!memcmp(basename(maps->regions[i].pathname), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
121           start_text_binary = reg.start_addr;
122         }
123       }
124     }
125     i++;
126   }
127   
128   free_memory_map(maps);
129
130   MC_UNSET_RAW_MEM;
131
132   if(raw_mem_set)
133     MC_SET_RAW_MEM;
134
135 }
136
137 mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall){
138   return MC_take_snapshot();
139 }
140
141 mc_snapshot_t MC_take_snapshot()
142 {
143   int raw_mem = (mmalloc_get_current_heap() == raw_heap);
144   
145   MC_SET_RAW_MEM;
146
147   mc_snapshot_t snapshot = xbt_new0(s_mc_snapshot_t, 1);
148   snapshot->nb_processes = xbt_swag_size(simix_global->process_list);
149
150   unsigned int i = 0;
151   s_map_region_t reg;
152   memory_map_t maps = get_memory_map();
153   void *heap = NULL;
154   size_t size = 0;
155   void *start = NULL;
156
157   /* Save the std heap and the writable mapped pages of libsimgrid */
158   while (i < maps->mapsize) {
159     reg = maps->regions[i];
160     if ((reg.prot & PROT_WRITE)){
161       if (maps->regions[i].pathname == NULL){
162         if (reg.start_addr == std_heap){ // only save the std heap (and not the raw one)
163           MC_snapshot_add_region(snapshot, 0, reg.start_addr, (char*)reg.end_addr - (char*)reg.start_addr);
164           snapshot->heap_bytes_used = mmalloc_get_bytes_used(std_heap);
165           heap = snapshot->regions[snapshot->num_reg - 1]->data;
166         }
167         i++;
168       } else{ 
169         if (!memcmp(basename(maps->regions[i].pathname), "libsimgrid", 10)){
170           size = (char*)reg.end_addr - (char*)reg.start_addr;
171           start = reg.start_addr;
172           i++;
173           reg = maps->regions[i];
174           if(reg.pathname == NULL && (reg.prot & PROT_WRITE) && i < maps->mapsize){
175             size += (char*)reg.end_addr - (char*)reg.start_addr;
176             reg = maps->regions[i];
177             i++;
178           }
179           MC_snapshot_add_region(snapshot, 1, start, size);
180         }else if(!memcmp(maps->regions[i].pathname, "[heap]", 6)){
181           end_raw_heap = reg.end_addr;
182           i++;
183         } else if (!memcmp(basename(maps->regions[i].pathname), basename(xbt_binary_name), strlen(basename(xbt_binary_name)))){
184           size = (char*)reg.end_addr - (char*)reg.start_addr;
185           start = reg.start_addr;
186           i++;
187           reg = maps->regions[i];
188           if(reg.pathname == NULL && (reg.prot & PROT_WRITE) && reg.start_addr != std_heap && reg.start_addr != raw_heap && i < maps->mapsize){
189             size += (char*)reg.end_addr - (char*)reg.start_addr;
190             reg = maps->regions[i];
191             i++;
192           }
193           MC_snapshot_add_region(snapshot, 2, start, size);
194         }else{
195           i++;
196         }
197       }
198     }else{
199       i++;
200     }
201   }
202
203   if(_sg_mc_visited > 0 || strcmp(_sg_mc_property_file,""))
204     snapshot->stacks = take_snapshot_stacks(&snapshot, heap);
205   
206   free_memory_map(maps);
207
208   MC_UNSET_RAW_MEM;
209
210   if(raw_mem)
211     MC_SET_RAW_MEM;
212
213   return snapshot;
214
215 }
216
217 void MC_restore_snapshot(mc_snapshot_t snapshot)
218 {
219   unsigned int i;
220   for(i=0; i < snapshot->num_reg; i++){
221     MC_region_restore(snapshot->regions[i]);
222   }
223
224 }
225
226 void MC_free_snapshot(mc_snapshot_t snapshot)
227 {
228   unsigned int i;
229   for(i=0; i < snapshot->num_reg; i++)
230     MC_region_destroy(snapshot->regions[i]);
231
232   xbt_free(snapshot->regions);
233   xbt_dynar_free(&(snapshot->stacks));
234   xbt_free(snapshot);
235 }
236
237
238 void get_libsimgrid_plt_section(){
239
240   FILE *fp;
241   char *line = NULL;            /* Temporal storage for each line that is readed */
242   ssize_t read;                 /* Number of bytes readed */
243   size_t n = 0;                 /* Amount of bytes to read by getline */
244
245   char *lfields[7];
246   int i, plt_found = 0;
247   unsigned long int size, offset;
248
249   char *command = bprintf("objdump --section-headers %s", libsimgrid_path);
250
251   fp = popen(command, "r");
252
253   if(fp == NULL){
254     perror("popen failed");
255     xbt_abort();
256   }
257
258   while ((read = getline(&line, &n, fp)) != -1 && plt_found != 2) {
259
260     if(n == 0)
261       continue;
262
263     /* Wipeout the new line character */
264     line[read - 1] = '\0';
265
266     lfields[0] = strtok(line, " ");
267
268     if(lfields[0] == NULL)
269       continue;
270
271     if(strcmp(lfields[0], "Sections:") == 0 || strcmp(lfields[0], "Idx") == 0 || strncmp(lfields[0], libsimgrid_path, strlen(libsimgrid_path)) == 0)
272       continue;
273
274     for (i = 1; i < 7 && lfields[i - 1] != NULL; i++) {
275       lfields[i] = strtok(NULL, " ");
276     }
277
278     if(i>=6){
279       if(strcmp(lfields[1], ".plt") == 0){
280         size = strtoul(lfields[2], NULL, 16);
281         offset = strtoul(lfields[5], NULL, 16);
282         start_plt_libsimgrid = (char *)start_text_libsimgrid + offset;
283         end_plt_libsimgrid = (char *)start_plt_libsimgrid + size;
284         plt_found++;
285       }else if(strcmp(lfields[1], ".got.plt") == 0){
286         size = strtoul(lfields[2], NULL, 16);
287         offset = strtoul(lfields[5], NULL, 16);
288         start_got_plt_libsimgrid = (char *)start_text_libsimgrid + offset;
289         end_got_plt_libsimgrid = (char *)start_got_plt_libsimgrid + size;
290         plt_found++;
291        }
292
293     }
294     
295   }
296
297   xbt_free(command);
298   xbt_free(line);
299   pclose(fp);
300
301 }
302
303 void get_binary_plt_section(){
304
305   FILE *fp;
306   char *line = NULL;            /* Temporal storage for each line that is readed */
307   ssize_t read;                 /* Number of bytes readed */
308   size_t n = 0;                 /* Amount of bytes to read by getline */
309
310   char *lfields[7];
311   int i, plt_found = 0;
312   unsigned long int size;
313
314   char *command = bprintf( "objdump --section-headers %s", xbt_binary_name);
315
316   fp = popen(command, "r");
317
318   if(fp == NULL){
319     perror("popen failed");
320     xbt_abort();
321   }
322
323   while ((read = getline(&line, &n, fp)) != -1 && plt_found != 2) {
324
325     if(n == 0)
326       continue;
327
328     /* Wipeout the new line character */
329     line[read - 1] = '\0';
330
331     lfields[0] = strtok(line, " ");
332
333     if(lfields[0] == NULL)
334       continue;
335
336     if(strcmp(lfields[0], "Sections:") == 0 || strcmp(lfields[0], "Idx") == 0 || strncmp(lfields[0], basename(xbt_binary_name), strlen(xbt_binary_name)) == 0)
337       continue;
338
339     for (i = 1; i < 7 && lfields[i - 1] != NULL; i++) {
340       lfields[i] = strtok(NULL, " ");
341     }
342
343     if(i>=6){
344       if(strcmp(lfields[1], ".plt") == 0){
345         size = strtoul(lfields[2], NULL, 16);
346         start_plt_binary = (void *)strtoul(lfields[3], NULL, 16);
347         end_plt_binary = (char *)start_plt_binary + size;
348         plt_found++;
349       }else if(strcmp(lfields[1], ".got.plt") == 0){
350         size = strtoul(lfields[2], NULL, 16);
351         start_got_plt_binary = (char *)strtoul(lfields[3], NULL, 16);
352         end_got_plt_binary = (char *)start_got_plt_binary + size;
353         plt_found++;
354        }
355     }
356     
357     
358   }
359
360   xbt_free(command);
361   xbt_free(line);
362   pclose(fp);
363
364 }
365
366 static void add_value(xbt_dynar_t *list, const char *type, unsigned long int val){
367   variable_value_t value = xbt_new0(s_variable_value_t, 1);
368   value->type = strdup(type);
369   if(strcmp(type, "value") == 0){
370     value->value.res = val;
371   }else{
372     value->value.address = (void *)val;
373   }
374   xbt_dynar_push(*list, &value);
375 }
376
377 static xbt_dynar_t take_snapshot_stacks(mc_snapshot_t *snapshot, void *heap){
378
379   xbt_dynar_t res = xbt_dynar_new(sizeof(s_mc_snapshot_stack_t), snapshot_stack_free_voidp);
380
381   unsigned int cursor = 0;
382   stack_region_t current_stack;
383   
384   xbt_dynar_foreach(stacks_areas, cursor, current_stack){
385     mc_snapshot_stack_t st = xbt_new(s_mc_snapshot_stack_t, 1);
386     st->local_variables = get_local_variables_values(current_stack->context, heap);
387     st->stack_pointer = get_stack_pointer(current_stack->context, heap);
388     xbt_dynar_push(res, &st);
389     (*snapshot)->stack_sizes = xbt_realloc((*snapshot)->stack_sizes, (cursor + 1) * sizeof(size_t));
390     (*snapshot)->stack_sizes[cursor] = current_stack->size - ((char *)st->stack_pointer - (char *)((char *)heap + ((char *)current_stack->address - (char *)std_heap)));
391   }
392
393   return res;
394
395 }
396
397 static void *get_stack_pointer(void *stack_context, void *heap){
398
399   unw_cursor_t c;
400   int ret;
401   unw_word_t sp;
402
403   ret = unw_init_local(&c, (unw_context_t *)stack_context);
404   if(ret < 0){
405     XBT_INFO("unw_init_local failed");
406     xbt_abort();
407   }
408
409   unw_get_reg(&c, UNW_REG_SP, &sp);
410
411   return ((char *)heap + (size_t)(((char *)((long)sp) - (char*)std_heap)));
412
413 }
414
415 static xbt_strbuff_t get_local_variables_values(void *stack_context, void *heap){
416   
417   unw_cursor_t c;
418   int ret;
419
420   char frame_name[256];
421   
422   ret = unw_init_local(&c, (unw_context_t *)stack_context);
423   if(ret < 0){
424     XBT_INFO("unw_init_local failed");
425     xbt_abort();
426   }
427
428   unw_word_t ip, sp, off;
429   dw_frame_t frame;
430  
431   xbt_dynar_t compose = xbt_dynar_new(sizeof(variable_value_t), variable_value_free_voidp);
432
433   xbt_strbuff_t variables = xbt_strbuff_new();
434   xbt_dict_cursor_t dict_cursor;
435   char *variable_name;
436   dw_local_variable_t current_variable;
437   unsigned int cursor = 0, cursor2 = 0;
438   dw_location_entry_t entry = NULL;
439   dw_location_t location_entry = NULL;
440   unw_word_t res;
441   int frame_found = 0;
442   void *frame_pointer_address = NULL;
443   long true_ip;
444   char *to_append;
445
446   while(ret >= 0){
447
448     unw_get_reg(&c, UNW_REG_IP, &ip);
449     unw_get_reg(&c, UNW_REG_SP, &sp);
450
451     unw_get_proc_name(&c, frame_name, sizeof (frame_name), &off);
452
453     frame = xbt_dict_get_or_null(mc_local_variables, frame_name);
454
455     if(frame == NULL){
456       xbt_dynar_free(&compose);
457       xbt_dict_cursor_free(&dict_cursor);
458       return variables;
459     }
460
461     to_append = bprintf("ip=%s\n", frame_name);
462     xbt_strbuff_append(variables, to_append);
463     xbt_free(to_append);
464
465     true_ip = (long)frame->low_pc + (long)off;
466
467     /* Get frame pointer */
468     switch(frame->frame_base->type){
469     case e_dw_loclist:
470       while((cursor < xbt_dynar_length(frame->frame_base->location.loclist)) && frame_found == 0){
471         entry = xbt_dynar_get_as(frame->frame_base->location.loclist, cursor, dw_location_entry_t);
472         if((true_ip >= entry->lowpc) && (true_ip < entry->highpc)){
473           frame_found = 1;
474           switch(entry->location->type){
475           case e_dw_compose:
476             xbt_dynar_reset(compose);
477             cursor2 = 0;
478             while(cursor2 < xbt_dynar_length(entry->location->location.compose)){
479               location_entry = xbt_dynar_get_as(entry->location->location.compose, cursor2, dw_location_t);
480               switch(location_entry->type){
481               case e_dw_register:
482                 unw_get_reg(&c, location_entry->location.reg, &res);
483                 add_value(&compose, "address", (long)res);
484                 break;
485               case e_dw_bregister_op:
486                 unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
487                 add_value(&compose, "address", (long)res + location_entry->location.breg_op.offset);
488                 break;
489               default:
490                 xbt_dynar_reset(compose);
491                 break;
492               }
493               cursor2++;
494             }
495
496             if(xbt_dynar_length(compose) > 0){
497               frame_pointer_address = xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1, variable_value_t)->value.address ; 
498             }
499             break;
500           default :
501             frame_pointer_address = NULL;
502             break;
503           }
504         }
505         cursor++;
506       }
507       break;
508     default :
509       frame_pointer_address = NULL;
510       break;
511     }
512
513     frame_found = 0;
514     cursor = 0;
515
516     xbt_dict_foreach(frame->variables, dict_cursor, variable_name, current_variable){
517       if(current_variable->location != NULL){
518         switch(current_variable->location->type){
519         case e_dw_compose:
520           xbt_dynar_reset(compose);
521           cursor = 0;
522           while(cursor < xbt_dynar_length(current_variable->location->location.compose)){
523             location_entry = xbt_dynar_get_as(current_variable->location->location.compose, cursor, dw_location_t);
524             switch(location_entry->type){
525             case e_dw_register:
526               unw_get_reg(&c, location_entry->location.reg, &res);
527               add_value(&compose, "value", (long)res);
528               break;
529             case e_dw_bregister_op:
530               unw_get_reg(&c, location_entry->location.breg_op.reg, &res);
531               add_value(&compose, "address", (long)res + location_entry->location.breg_op.offset);
532               break;
533             case e_dw_fbregister_op:
534               if(frame_pointer_address != NULL)
535                 add_value(&compose, "address", (long)((char *)frame_pointer_address + location_entry->location.fbreg_op));
536               break;
537             default:
538               xbt_dynar_reset(compose);
539               break;
540             }
541             cursor++;
542           }
543           
544           if(xbt_dynar_length(compose) > 0){
545             if(strcmp(xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1, variable_value_t)->type, "value") == 0){
546               to_append = bprintf("%s=%lx\n", current_variable->name, xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1, variable_value_t)->value.res);
547               xbt_strbuff_append(variables, to_append);
548               xbt_free(to_append);
549             }else{
550               if((long)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1,variable_value_t)->value.address < 0 || *((void**)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1,variable_value_t)->value.address) == NULL){
551                 to_append = bprintf("%s=NULL\n", current_variable->name);
552                 xbt_strbuff_append(variables, to_append);
553                 xbt_free(to_append);
554               }else if(((long)*((void**)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1,variable_value_t)->value.address) > 0xffffffff) || ((long)*((void**)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1,variable_value_t)->value.address) < (long)start_text_binary)){
555                 to_append = bprintf("%s=%u\n", current_variable->name, (unsigned int)(long)*((void**)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1, variable_value_t)->value.address));
556                 xbt_strbuff_append(variables, to_append);
557                 xbt_free(to_append);
558               }else{ 
559                 to_append = bprintf("%s=%p\n", current_variable->name, *((void**)xbt_dynar_get_as(compose, xbt_dynar_length(compose) - 1, variable_value_t)->value.address));
560                 xbt_strbuff_append(variables, to_append);
561                 xbt_free(to_append);
562               }
563             }
564           }else{
565             to_append = bprintf("%s=undefined\n", current_variable->name);
566             xbt_strbuff_append(variables, to_append);
567             xbt_free(to_append);
568           }
569           break;
570         default :
571           break;
572         }
573       }else{
574         to_append = bprintf("%s=undefined\n", current_variable->name);
575         xbt_strbuff_append(variables, to_append);
576         xbt_free(to_append);
577       }
578     }    
579  
580     ret = unw_step(&c);
581      
582   }
583
584   xbt_dynar_free(&compose);
585   xbt_dict_cursor_free(&dict_cursor);
586
587   return variables;
588
589 }
590
591 static void print_local_variables_values(xbt_dynar_t all_variables){
592
593   unsigned cursor = 0;
594   mc_snapshot_stack_t stack;
595
596   xbt_dynar_foreach(all_variables, cursor, stack){
597     XBT_INFO("%s", stack->local_variables->data);
598   }
599 }
600
601
602 static void snapshot_stack_free(mc_snapshot_stack_t s){
603   if(s){
604     xbt_free(s->local_variables->data);
605     xbt_free(s->local_variables);
606     xbt_free(s);
607   }
608 }
609
610 void snapshot_stack_free_voidp(void *s){
611   snapshot_stack_free((mc_snapshot_stack_t) * (void **) s);
612 }
613
614 void *MC_snapshot(void){
615
616   return simcall_mc_snapshot();
617   
618 }
619
620 void variable_value_free(variable_value_t v){
621   if(v){
622     xbt_free(v->type);
623     xbt_free(v);
624   }
625 }
626
627 void variable_value_free_voidp(void* v){
628   variable_value_free((variable_value_t) * (void **)v);
629 }
630