Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Change the signature of mc_restore_page_snapshot_region
[simgrid.git] / src / mc / mc_compare.cpp
1 /* Copyright (c) 2012-2014. 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 #include <inttypes.h>
8 #include <boost/unordered_set.hpp>
9
10 #include "mc_private.h"
11
12 #include "xbt/mmalloc.h"
13 #include "xbt/mmalloc/mmprivate.h"
14
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, mc,
16                                 "Logging specific to mc_compare");
17
18 typedef struct s_pointers_pair {
19   void *p1;
20   void *p2;
21   bool operator==(s_pointers_pair const& x) const {
22     return this->p1 == x.p1 && this->p2 == x.p2;
23   }
24   bool operator<(s_pointers_pair const& x) const {
25     return this->p1 < x.p1 || (this->p1 == x.p1 && this->p2 < x.p2);
26   }
27 } s_pointers_pair_t, *pointers_pair_t;
28
29 namespace boost {
30   template<>
31   struct hash<s_pointers_pair> {
32     typedef uintptr_t result_type;
33     result_type operator()(s_pointers_pair const& x) const {
34       return (result_type) x.p1 ^
35         ((result_type) x.p2 << 8 | (result_type) x.p2 >> (8*sizeof(uintptr_t) - 8));
36     }
37   };
38 }
39
40 struct mc_compare_state {
41   boost::unordered_set<s_pointers_pair> compared_pointers;
42 };
43
44 extern "C" {
45
46 /************************** Free functions ****************************/
47 /********************************************************************/
48
49 static void stack_region_free(stack_region_t s)
50 {
51   if (s) {
52     xbt_free(s->process_name);
53     xbt_free(s);
54   }
55 }
56
57 static void stack_region_free_voidp(void *s)
58 {
59   stack_region_free((stack_region_t) * (void **) s);
60 }
61
62 static void pointers_pair_free(pointers_pair_t p)
63 {
64   xbt_free(p);
65 }
66
67 static void pointers_pair_free_voidp(void *p)
68 {
69   pointers_pair_free((pointers_pair_t) * (void **) p);
70 }
71
72 /************************** Snapshot comparison *******************************/
73 /******************************************************************************/
74
75 /** \brief Try to add a pair a compared pointers to the set of compared pointers
76  *
77  *  \result !=0 if the pointers were added (they were not in the set),
78  *      0 otherwise (they were already in the set)
79  */
80 static int add_compared_pointers(mc_compare_state& state, void *p1, void *p2)
81 {
82   s_pointers_pair_t new_pair;
83   new_pair.p1 = p1;
84   new_pair.p2 = p2;
85   return state.compared_pointers.insert(new_pair).second ? 1 : 0;
86 }
87
88 static int compare_areas_with_type(struct mc_compare_state& state,
89                                    void* real_area1, mc_snapshot_t snapshot1, mc_mem_region_t region1,
90                                    void* real_area2, mc_snapshot_t snapshot2, mc_mem_region_t region2,
91                                    dw_type_t type, int pointer_level)
92 {
93   unsigned int cursor = 0;
94   dw_type_t member, subtype, subsubtype;
95   int elm_size, i, res;
96
97   top:
98   switch (type->type) {
99   case DW_TAG_unspecified_type:
100     return 1;
101
102   case DW_TAG_base_type:
103   case DW_TAG_enumeration_type:
104   case DW_TAG_union_type:
105   {
106     return mc_snapshot_region_memcmp(
107       real_area1, region1, real_area2, region2,
108       type->byte_size) != 0;
109   }
110   case DW_TAG_typedef:
111   case DW_TAG_volatile_type:
112   case DW_TAG_const_type:
113     // Poor man's TCO:
114     type = type->subtype;
115     goto top;
116   case DW_TAG_array_type:
117     subtype = type->subtype;
118     switch (subtype->type) {
119     case DW_TAG_unspecified_type:
120       return 1;
121
122     case DW_TAG_base_type:
123     case DW_TAG_enumeration_type:
124     case DW_TAG_pointer_type:
125     case DW_TAG_reference_type:
126     case DW_TAG_rvalue_reference_type:
127     case DW_TAG_structure_type:
128     case DW_TAG_class_type:
129     case DW_TAG_union_type:
130       if (subtype->full_type)
131         subtype = subtype->full_type;
132       elm_size = subtype->byte_size;
133       break;
134     case DW_TAG_const_type:
135     case DW_TAG_typedef:
136     case DW_TAG_volatile_type:
137       subsubtype = subtype->subtype;
138       if (subsubtype->full_type)
139         subsubtype = subsubtype->full_type;
140       elm_size = subsubtype->byte_size;
141       break;
142     default:
143       return 0;
144       break;
145     }
146     for (i = 0; i < type->element_count; i++) {
147       size_t off = i * elm_size;
148       res = compare_areas_with_type(state,
149             (char*) real_area1 + off, snapshot1, region1,
150             (char*) real_area2 + off, snapshot2, region2,
151             type->subtype, pointer_level);
152       if (res == 1)
153         return res;
154     }
155     break;
156   case DW_TAG_pointer_type:
157   case DW_TAG_reference_type:
158   case DW_TAG_rvalue_reference_type:
159   {
160     void* addr_pointed1 = mc_snapshot_read_pointer_region(real_area1, region1);
161     void* addr_pointed2 = mc_snapshot_read_pointer_region(real_area2, region2);
162
163     if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
164       return (addr_pointed1 != addr_pointed2);
165     } else {
166
167       if (addr_pointed1 == NULL && addr_pointed2 == NULL)
168         return 0;
169       if (!add_compared_pointers(state, addr_pointed1, addr_pointed2))
170         return 0;
171
172       pointer_level++;
173
174       // Some cases are not handled here:
175       // * the pointers lead to different areas (one to the heap, the other to the RW segment ...);
176       // * a pointer leads to the read-only segment of the current object;
177       // * a pointer lead to a different ELF object.
178
179       if (addr_pointed1 > std_heap
180           && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)) {
181         if (!
182             (addr_pointed2 > std_heap
183              && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
184           return 1;
185         // The pointers are both in the heap:
186         return compare_heap_area(addr_pointed1, addr_pointed2, snapshot1,
187                                  snapshot2, NULL, type->subtype, pointer_level);
188       }
189
190       // The pointers are both in the current object R/W segment:
191       else if (mc_region_contain(region1, addr_pointed1)) {
192         if (!mc_region_contain(region2, addr_pointed2))
193           return 1;
194         if (type->dw_type_id == NULL)
195           return (addr_pointed1 != addr_pointed2);
196         else {
197           return compare_areas_with_type(state,
198                                          addr_pointed1, snapshot1, region1,
199                                          addr_pointed2, snapshot2, region2,
200                                          type->subtype, pointer_level);
201         }
202       }
203
204       // TODO, We do not handle very well the case where
205       // it belongs to a different (non-heap) region from the current one.
206
207       else {
208         return (addr_pointed1 != addr_pointed2);
209       }
210     }
211     break;
212   }
213   case DW_TAG_structure_type:
214   case DW_TAG_class_type:
215     xbt_dynar_foreach(type->members, cursor, member) {
216       void *member1 =
217         mc_member_resolve(real_area1, type, member, snapshot1);
218       void *member2 =
219         mc_member_resolve(real_area2, type, member, snapshot2);
220       mc_mem_region_t subregion1 = mc_get_region_hinted(member1, snapshot1, region1);
221       mc_mem_region_t subregion2 = mc_get_region_hinted(member2, snapshot2, region2);
222       res =
223           compare_areas_with_type(state,
224                                   member1, snapshot1, subregion1,
225                                   member2, snapshot2, subregion2,
226                                   member->subtype, pointer_level);
227       if (res == 1)
228         return res;
229     }
230     break;
231   case DW_TAG_subroutine_type:
232     return -1;
233     break;
234   default:
235     XBT_VERB("Unknown case : %d", type->type);
236     break;
237   }
238
239   return 0;
240 }
241
242 static int compare_global_variables(int region_type, mc_mem_region_t r1,
243                                     mc_mem_region_t r2, mc_snapshot_t snapshot1,
244                                     mc_snapshot_t snapshot2)
245 {
246   xbt_assert(r1 && r2,
247     "Missing region. Did you enable SMPI privatisation? It is not compatible with state comparison.");
248   struct mc_compare_state state;
249
250   xbt_dynar_t variables;
251   int res;
252   unsigned int cursor = 0;
253   dw_variable_t current_var;
254
255   mc_object_info_t object_info = NULL;
256   if (region_type == 2) {
257     object_info = mc_binary_info;
258   } else {
259     object_info = mc_libsimgrid_info;
260   }
261   variables = object_info->global_variables;
262
263   xbt_dynar_foreach(variables, cursor, current_var) {
264
265     // If the variable is not in this object, skip it:
266     // We do not expect to find a pointer to something which is not reachable
267     // by the global variables.
268     if ((char *) current_var->address < (char *) object_info->start_rw
269         || (char *) current_var->address > (char *) object_info->end_rw)
270       continue;
271
272     dw_type_t bvariable_type = current_var->type;
273     res =
274         compare_areas_with_type(state,
275                                 (char *) current_var->address, snapshot1, r1,
276                                 (char *) current_var->address, snapshot2, r2,
277                                 bvariable_type, 0);
278     if (res == 1) {
279       XBT_VERB("Global variable %s (%p) is different between snapshots",
280                current_var->name, (char *) current_var->address);
281       return 1;
282     }
283
284   }
285
286   return 0;
287
288 }
289
290 static int compare_local_variables(mc_snapshot_t snapshot1,
291                                    mc_snapshot_t snapshot2,
292                                    mc_snapshot_stack_t stack1,
293                                    mc_snapshot_stack_t stack2)
294 {
295   struct mc_compare_state state;
296
297   if (xbt_dynar_length(stack1->local_variables) !=
298       xbt_dynar_length(stack2->local_variables)) {
299     XBT_VERB("Different number of local variables");
300     return 1;
301   } else {
302     unsigned int cursor = 0;
303     local_variable_t current_var1, current_var2;
304     int res;
305     while (cursor < xbt_dynar_length(stack1->local_variables)) {
306       current_var1 =
307           (local_variable_t) xbt_dynar_get_as(stack1->local_variables, cursor,
308                                               local_variable_t);
309       current_var2 =
310           (local_variable_t) xbt_dynar_get_as(stack2->local_variables, cursor,
311                                               local_variable_t);
312       if (strcmp(current_var1->name, current_var2->name) != 0
313           || current_var1->subprogram != current_var1->subprogram
314           || current_var1->ip != current_var2->ip) {
315         // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
316         XBT_VERB
317             ("Different name of variable (%s - %s) or frame (%s - %s) or ip (%lu - %lu)",
318              current_var1->name, current_var2->name,
319              current_var1->subprogram->name, current_var2->subprogram->name,
320              current_var1->ip, current_var2->ip);
321         return 1;
322       }
323       // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
324
325         dw_type_t subtype = current_var1->type;
326         res =
327             compare_areas_with_type(state,
328                                     current_var1->address, snapshot1, mc_get_snapshot_region(current_var1->address, snapshot1),
329                                     current_var2->address, snapshot2, mc_get_snapshot_region(current_var2->address, snapshot2),
330                                     subtype, 0);
331
332       if (res == 1) {
333         // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
334         XBT_VERB
335             ("Local variable %s (%p - %p) in frame %s  is different between snapshots",
336              current_var1->name, current_var1->address, current_var2->address,
337              current_var1->subprogram->name);
338         return res;
339       }
340       cursor++;
341     }
342     return 0;
343   }
344 }
345
346 int snapshot_compare(void *state1, void *state2)
347 {
348
349   mc_snapshot_t s1, s2;
350   int num1, num2;
351
352   if (_sg_mc_liveness) {        /* Liveness MC */
353     s1 = ((mc_visited_pair_t) state1)->graph_state->system_state;
354     s2 = ((mc_visited_pair_t) state2)->graph_state->system_state;
355     num1 = ((mc_visited_pair_t) state1)->num;
356     num2 = ((mc_visited_pair_t) state2)->num;
357   } else {                      /* Safety or comm determinism MC */
358     s1 = ((mc_visited_state_t) state1)->system_state;
359     s2 = ((mc_visited_state_t) state2)->system_state;
360     num1 = ((mc_visited_state_t) state1)->num;
361     num2 = ((mc_visited_state_t) state2)->num;
362   }
363
364   int errors = 0;
365   int res_init;
366
367   xbt_os_timer_t global_timer = xbt_os_timer_new();
368   xbt_os_timer_t timer = xbt_os_timer_new();
369
370   xbt_os_walltimer_start(global_timer);
371
372 #ifdef MC_DEBUG
373   xbt_os_walltimer_start(timer);
374 #endif
375
376   int hash_result = 0;
377   if (_sg_mc_hash) {
378     hash_result = (s1->hash != s2->hash);
379     if (hash_result) {
380       XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1,
381                num2, s1->hash, s2->hash);
382 #ifndef MC_DEBUG
383       return 1;
384 #endif
385     } else {
386       XBT_VERB("(%d - %d) Same hash : 0x%" PRIx64, num1, num2, s1->hash);
387     }
388   }
389
390   /* Compare enabled processes */
391   unsigned int cursor;
392   int pid;
393   xbt_dynar_foreach(s1->enabled_processes, cursor, pid){
394     if(!xbt_dynar_member(s2->enabled_processes, &pid))
395       XBT_VERB("(%d - %d) Different enabled processes", num1, num2);
396   }
397
398   unsigned long i = 0;
399   size_t size_used1, size_used2;
400   int is_diff = 0;
401
402   /* Compare size of stacks */
403   while (i < xbt_dynar_length(s1->stacks)) {
404     size_used1 = s1->stack_sizes[i];
405     size_used2 = s2->stack_sizes[i];
406     if (size_used1 != size_used2) {
407 #ifdef MC_DEBUG
408       if (is_diff == 0) {
409         xbt_os_walltimer_stop(timer);
410         mc_comp_times->stacks_sizes_comparison_time =
411             xbt_os_timer_elapsed(timer);
412       }
413       XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1,
414                 num2, size_used1, size_used2);
415       errors++;
416       is_diff = 1;
417 #else
418 #ifdef MC_VERBOSE
419       XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1,
420                num2, size_used1, size_used2);
421 #endif
422
423       xbt_os_walltimer_stop(timer);
424       xbt_os_timer_free(timer);
425       xbt_os_walltimer_stop(global_timer);
426       mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
427       xbt_os_timer_free(global_timer);
428
429       return 1;
430 #endif
431     }
432     i++;
433   }
434
435 #ifdef MC_DEBUG
436   if (is_diff == 0)
437     xbt_os_walltimer_stop(timer);
438   xbt_os_walltimer_start(timer);
439 #endif
440
441   /* Init heap information used in heap comparison algorithm */
442   xbt_mheap_t heap1 = (xbt_mheap_t) mc_snapshot_read(std_heap, s1,
443     alloca(sizeof(struct mdesc)), sizeof(struct mdesc));
444   xbt_mheap_t heap2 = (xbt_mheap_t) mc_snapshot_read(std_heap, s2,
445     alloca(sizeof(struct mdesc)), sizeof(struct mdesc));
446   res_init = init_heap_information(heap1, heap2, s1->to_ignore, s2->to_ignore);
447   if (res_init == -1) {
448 #ifdef MC_DEBUG
449     XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
450     errors++;
451 #else
452 #ifdef MC_VERBOSE
453     XBT_VERB("(%d - %d) Different heap information", num1, num2);
454 #endif
455
456     xbt_os_walltimer_stop(global_timer);
457     mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
458     xbt_os_timer_free(global_timer);
459
460     return 1;
461 #endif
462   }
463 #ifdef MC_DEBUG
464   xbt_os_walltimer_start(timer);
465 #endif
466
467   /* Stacks comparison */
468   cursor = 0;
469   int diff_local = 0;
470 #ifdef MC_DEBUG
471   is_diff = 0;
472 #endif
473   mc_snapshot_stack_t stack1, stack2;
474
475   while (cursor < xbt_dynar_length(s1->stacks)) {
476     stack1 =
477         (mc_snapshot_stack_t) xbt_dynar_get_as(s1->stacks, cursor,
478                                                mc_snapshot_stack_t);
479     stack2 =
480         (mc_snapshot_stack_t) xbt_dynar_get_as(s2->stacks, cursor,
481                                                mc_snapshot_stack_t);
482     diff_local =
483         compare_local_variables(s1, s2, stack1, stack2);
484     if (diff_local > 0) {
485 #ifdef MC_DEBUG
486       if (is_diff == 0) {
487         xbt_os_walltimer_stop(timer);
488         mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
489       }
490       XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1,
491                 num2, cursor + 1);
492       errors++;
493       is_diff = 1;
494 #else
495
496 #ifdef MC_VERBOSE
497       XBT_VERB("(%d - %d) Different local variables between stacks %d", num1,
498                num2, cursor + 1);
499 #endif
500
501       reset_heap_information();
502       xbt_os_walltimer_stop(timer);
503       xbt_os_timer_free(timer);
504       xbt_os_walltimer_stop(global_timer);
505       mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
506       xbt_os_timer_free(global_timer);
507
508       return 1;
509 #endif
510     }
511     cursor++;
512   }
513
514
515
516   const char *names[3] = { "?", "libsimgrid", "binary" };
517 #ifdef MC_DEBUG
518   double *times[3] = {
519     NULL,
520     &mc_comp_times->libsimgrid_global_variables_comparison_time,
521     &mc_comp_times->binary_global_variables_comparison_time
522   };
523 #endif
524
525   int k = 0;
526   for (k = 2; k != 0; --k) {
527 #ifdef MC_DEBUG
528     if (is_diff == 0)
529       xbt_os_walltimer_stop(timer);
530     xbt_os_walltimer_start(timer);
531 #endif
532
533     /* Compare global variables */
534     is_diff =
535         compare_global_variables(k, s1->regions[k], s2->regions[k], s1, s2);
536     if (is_diff != 0) {
537 #ifdef MC_DEBUG
538       xbt_os_walltimer_stop(timer);
539       *times[k] = xbt_os_timer_elapsed(timer);
540       XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2,
541                 names[k]);
542       errors++;
543 #else
544 #ifdef MC_VERBOSE
545       XBT_VERB("(%d - %d) Different global variables in %s", num1, num2,
546                names[k]);
547 #endif
548
549       reset_heap_information();
550       xbt_os_walltimer_stop(timer);
551       xbt_os_timer_free(timer);
552       xbt_os_walltimer_stop(global_timer);
553       mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
554       xbt_os_timer_free(global_timer);
555
556       return 1;
557 #endif
558     }
559   }
560
561 #ifdef MC_DEBUG
562   xbt_os_walltimer_start(timer);
563 #endif
564
565   /* Compare heap */
566   if (mmalloc_compare_heap(s1, s2) > 0) {
567
568 #ifdef MC_DEBUG
569     xbt_os_walltimer_stop(timer);
570     mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
571     XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
572     errors++;
573 #else
574
575 #ifdef MC_VERBOSE
576     XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
577 #endif
578
579     reset_heap_information();
580     xbt_os_walltimer_stop(timer);
581     xbt_os_timer_free(timer);
582     xbt_os_walltimer_stop(global_timer);
583     mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
584     xbt_os_timer_free(global_timer);
585
586     return 1;
587 #endif
588   } else {
589 #ifdef MC_DEBUG
590     xbt_os_walltimer_stop(timer);
591 #endif
592   }
593
594   reset_heap_information();
595
596   xbt_os_walltimer_stop(timer);
597   xbt_os_timer_free(timer);
598
599 #ifdef MC_VERBOSE
600   xbt_os_walltimer_stop(global_timer);
601   mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
602 #endif
603
604   xbt_os_timer_free(global_timer);
605
606 #ifdef MC_DEBUG
607   print_comparison_times();
608 #endif
609
610 #ifdef MC_VERBOSE
611   if (errors || hash_result)
612     XBT_VERB("(%d - %d) Difference found", num1, num2);
613   else
614     XBT_VERB("(%d - %d) No difference found", num1, num2);
615 #endif
616
617 #if defined(MC_DEBUG) && defined(MC_VERBOSE)
618   if (_sg_mc_hash) {
619     // * false positive SHOULD be avoided.
620     // * There MUST not be any false negative.
621
622     XBT_VERB("(%d - %d) State equality hash test is %s %s", num1, num2,
623              (hash_result != 0) == (errors != 0) ? "true" : "false",
624              !hash_result ? "positive" : "negative");
625   }
626 #endif
627
628   return errors > 0 || hash_result;
629
630 }
631
632 /***************************** Statistics *****************************/
633 /*******************************************************************/
634
635 void print_comparison_times()
636 {
637   XBT_DEBUG("*** Comparison times ***");
638   XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
639   XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
640   XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
641   XBT_DEBUG("- Binary global variables : %f",
642             mc_comp_times->binary_global_variables_comparison_time);
643   XBT_DEBUG("- Libsimgrid global variables : %f",
644             mc_comp_times->libsimgrid_global_variables_comparison_time);
645   XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
646   XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
647 }
648
649 /**************************** MC snapshot compare simcall **************************/
650 /***********************************************************************************/
651
652 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
653                                    mc_snapshot_t s1, mc_snapshot_t s2)
654 {
655   return snapshot_compare(s1, s2);
656 }
657
658 int MC_compare_snapshots(void *s1, void *s2)
659 {
660
661   return simcall_mc_compare_snapshots(s1, s2);
662
663 }
664
665 }