1 /* Copyright (c) 2012-2014. 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. */
7 #define __STDC_FORMAT_MACROS
9 #include <boost/unordered_set.hpp>
11 #include "internal_config.h"
12 #include "mc_object_info.h"
13 #include "mc_safety.h"
14 #include "mc_liveness.h"
15 #include "mc_private.h"
18 #include "smpi/private.h"
21 #include "xbt/mmalloc.h"
22 #include "xbt/mmalloc/mmprivate.h"
24 #include <xbt/probes.h>
26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, mc,
27 "Logging specific to mc_compare");
29 typedef struct s_pointers_pair {
32 bool operator==(s_pointers_pair const& x) const {
33 return this->p1 == x.p1 && this->p2 == x.p2;
35 bool operator<(s_pointers_pair const& x) const {
36 return this->p1 < x.p1 || (this->p1 == x.p1 && this->p2 < x.p2);
38 } s_pointers_pair_t, *pointers_pair_t;
42 struct hash<s_pointers_pair> {
43 typedef uintptr_t result_type;
44 result_type operator()(s_pointers_pair const& x) const {
45 return (result_type) x.p1 ^
46 ((result_type) x.p2 << 8 | (result_type) x.p2 >> (8*sizeof(uintptr_t) - 8));
51 struct mc_compare_state {
52 boost::unordered_set<s_pointers_pair> compared_pointers;
57 /************************** Free functions ****************************/
58 /********************************************************************/
60 static void stack_region_free(stack_region_t s)
67 static void stack_region_free_voidp(void *s)
69 stack_region_free((stack_region_t) * (void **) s);
72 static void pointers_pair_free(pointers_pair_t p)
77 static void pointers_pair_free_voidp(void *p)
79 pointers_pair_free((pointers_pair_t) * (void **) p);
82 /************************** Snapshot comparison *******************************/
83 /******************************************************************************/
85 /** \brief Try to add a pair a compared pointers to the set of compared pointers
87 * \result !=0 if the pointers were added (they were not in the set),
88 * 0 otherwise (they were already in the set)
90 static int add_compared_pointers(mc_compare_state& state, void *p1, void *p2)
92 s_pointers_pair_t new_pair;
95 return state.compared_pointers.insert(new_pair).second ? 1 : 0;
98 static int compare_areas_with_type(struct mc_compare_state& state,
100 void* real_area1, mc_snapshot_t snapshot1, mc_mem_region_t region1,
101 void* real_area2, mc_snapshot_t snapshot2, mc_mem_region_t region2,
102 dw_type_t type, int pointer_level)
104 mc_process_t process = &mc_model_checker->process;
106 unsigned int cursor = 0;
107 dw_type_t member, subtype, subsubtype;
108 int elm_size, i, res;
111 switch (type->type) {
112 case DW_TAG_unspecified_type:
115 case DW_TAG_base_type:
116 case DW_TAG_enumeration_type:
117 case DW_TAG_union_type:
119 return MC_snapshot_region_memcmp(
120 real_area1, region1, real_area2, region2,
121 type->byte_size) != 0;
124 case DW_TAG_volatile_type:
125 case DW_TAG_const_type:
127 type = type->subtype;
129 case DW_TAG_array_type:
130 subtype = type->subtype;
131 switch (subtype->type) {
132 case DW_TAG_unspecified_type:
135 case DW_TAG_base_type:
136 case DW_TAG_enumeration_type:
137 case DW_TAG_pointer_type:
138 case DW_TAG_reference_type:
139 case DW_TAG_rvalue_reference_type:
140 case DW_TAG_structure_type:
141 case DW_TAG_class_type:
142 case DW_TAG_union_type:
143 if (subtype->full_type)
144 subtype = subtype->full_type;
145 elm_size = subtype->byte_size;
147 case DW_TAG_const_type:
149 case DW_TAG_volatile_type:
150 subsubtype = subtype->subtype;
151 if (subsubtype->full_type)
152 subsubtype = subsubtype->full_type;
153 elm_size = subsubtype->byte_size;
159 for (i = 0; i < type->element_count; i++) {
160 size_t off = i * elm_size;
161 res = compare_areas_with_type(state, process_index,
162 (char*) real_area1 + off, snapshot1, region1,
163 (char*) real_area2 + off, snapshot2, region2,
164 type->subtype, pointer_level);
169 case DW_TAG_pointer_type:
170 case DW_TAG_reference_type:
171 case DW_TAG_rvalue_reference_type:
173 void* addr_pointed1 = MC_region_read_pointer(region1, real_area1);
174 void* addr_pointed2 = MC_region_read_pointer(region2, real_area2);
176 if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
177 return (addr_pointed1 != addr_pointed2);
180 if (addr_pointed1 == NULL && addr_pointed2 == NULL)
182 if (addr_pointed1 == NULL || addr_pointed2 == NULL)
184 if (!add_compared_pointers(state, addr_pointed1, addr_pointed2))
189 // Some cases are not handled here:
190 // * the pointers lead to different areas (one to the heap, the other to the RW segment ...);
191 // * a pointer leads to the read-only segment of the current object;
192 // * a pointer lead to a different ELF object.
194 if (addr_pointed1 > process->heap_address
195 && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)) {
197 (addr_pointed2 > process->heap_address
198 && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
200 // The pointers are both in the heap:
201 return compare_heap_area(process_index, addr_pointed1, addr_pointed2, snapshot1,
202 snapshot2, NULL, type->subtype, pointer_level);
205 // The pointers are both in the current object R/W segment:
206 else if (mc_region_contain(region1, addr_pointed1)) {
207 if (!mc_region_contain(region2, addr_pointed2))
209 if (type->dw_type_id == NULL)
210 return (addr_pointed1 != addr_pointed2);
212 return compare_areas_with_type(state, process_index,
213 addr_pointed1, snapshot1, region1,
214 addr_pointed2, snapshot2, region2,
215 type->subtype, pointer_level);
219 // TODO, We do not handle very well the case where
220 // it belongs to a different (non-heap) region from the current one.
223 return (addr_pointed1 != addr_pointed2);
228 case DW_TAG_structure_type:
229 case DW_TAG_class_type:
230 xbt_dynar_foreach(type->members, cursor, member) {
232 mc_member_resolve(real_area1, type, member, (mc_address_space_t) snapshot1, process_index);
234 mc_member_resolve(real_area2, type, member, (mc_address_space_t) snapshot2, process_index);
235 mc_mem_region_t subregion1 = mc_get_region_hinted(member1, snapshot1, process_index, region1);
236 mc_mem_region_t subregion2 = mc_get_region_hinted(member2, snapshot2, process_index, region2);
238 compare_areas_with_type(state, process_index,
239 member1, snapshot1, subregion1,
240 member2, snapshot2, subregion2,
241 member->subtype, pointer_level);
246 case DW_TAG_subroutine_type:
250 XBT_VERB("Unknown case : %d", type->type);
257 static int compare_global_variables(mc_object_info_t object_info,
260 mc_mem_region_t r2, mc_snapshot_t snapshot1,
261 mc_snapshot_t snapshot2)
263 xbt_assert(r1 && r2, "Missing region.");
266 if (r1->storage_type == MC_REGION_STORAGE_TYPE_PRIVATIZED) {
267 xbt_assert(process_index >= 0);
268 if (r2->storage_type != MC_REGION_STORAGE_TYPE_PRIVATIZED) {
272 size_t process_count = smpi_process_count();
273 xbt_assert(process_count == r1->privatized.regions_count
274 && process_count == r2->privatized.regions_count);
276 // Compare the global variables separately for each simulates process:
277 for (size_t process_index = 0; process_index < process_count; process_index++) {
278 int is_diff = compare_global_variables(object_info, process_index,
279 r1->privatized.regions[process_index], r2->privatized.regions[process_index],
280 snapshot1, snapshot2);
281 if (is_diff) return 1;
286 xbt_assert(r1->storage_type != MC_REGION_STORAGE_TYPE_PRIVATIZED);
288 xbt_assert(r2->storage_type != MC_REGION_STORAGE_TYPE_PRIVATIZED);
290 struct mc_compare_state state;
292 xbt_dynar_t variables;
294 unsigned int cursor = 0;
295 dw_variable_t current_var;
297 variables = object_info->global_variables;
299 xbt_dynar_foreach(variables, cursor, current_var) {
301 // If the variable is not in this object, skip it:
302 // We do not expect to find a pointer to something which is not reachable
303 // by the global variables.
304 if ((char *) current_var->address < (char *) object_info->start_rw
305 || (char *) current_var->address > (char *) object_info->end_rw)
308 dw_type_t bvariable_type = current_var->type;
310 compare_areas_with_type(state, process_index,
311 (char *) current_var->address, snapshot1, r1,
312 (char *) current_var->address, snapshot2, r2,
315 XBT_TRACE3(mc, global_diff, -1, -1, current_var->name);
316 XBT_VERB("Global variable %s (%p) is different between snapshots",
317 current_var->name, (char *) current_var->address);
327 static int compare_local_variables(int process_index,
328 mc_snapshot_t snapshot1,
329 mc_snapshot_t snapshot2,
330 mc_snapshot_stack_t stack1,
331 mc_snapshot_stack_t stack2)
333 struct mc_compare_state state;
335 if (xbt_dynar_length(stack1->local_variables) !=
336 xbt_dynar_length(stack2->local_variables)) {
337 XBT_VERB("Different number of local variables");
340 unsigned int cursor = 0;
341 local_variable_t current_var1, current_var2;
343 while (cursor < xbt_dynar_length(stack1->local_variables)) {
345 (local_variable_t) xbt_dynar_get_as(stack1->local_variables, cursor,
348 (local_variable_t) xbt_dynar_get_as(stack2->local_variables, cursor,
350 if (strcmp(current_var1->name, current_var2->name) != 0
351 || current_var1->subprogram != current_var1->subprogram
352 || current_var1->ip != current_var2->ip) {
353 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
355 ("Different name of variable (%s - %s) or frame (%s - %s) or ip (%lu - %lu)",
356 current_var1->name, current_var2->name,
357 current_var1->subprogram->name, current_var2->subprogram->name,
358 current_var1->ip, current_var2->ip);
361 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
363 dw_type_t subtype = current_var1->type;
365 compare_areas_with_type(state, process_index,
366 current_var1->address, snapshot1, mc_get_snapshot_region(current_var1->address, snapshot1, process_index),
367 current_var2->address, snapshot2, mc_get_snapshot_region(current_var2->address, snapshot2, process_index),
371 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
372 XBT_TRACE3(mc, local_diff, -1, -1, current_var1->name);
374 ("Local variable %s (%p - %p) in frame %s is different between snapshots",
375 current_var1->name, current_var1->address, current_var2->address,
376 current_var1->subprogram->name);
385 int snapshot_compare(void *state1, void *state2)
387 mc_process_t process = &mc_model_checker->process;
389 mc_snapshot_t s1, s2;
392 if (_sg_mc_liveness) { /* Liveness MC */
393 s1 = ((mc_visited_pair_t) state1)->graph_state->system_state;
394 s2 = ((mc_visited_pair_t) state2)->graph_state->system_state;
395 num1 = ((mc_visited_pair_t) state1)->num;
396 num2 = ((mc_visited_pair_t) state2)->num;
397 } else { /* Safety or comm determinism MC */
398 s1 = ((mc_visited_state_t) state1)->system_state;
399 s2 = ((mc_visited_state_t) state2)->system_state;
400 num1 = ((mc_visited_state_t) state1)->num;
401 num2 = ((mc_visited_state_t) state2)->num;
407 xbt_os_timer_t global_timer = xbt_os_timer_new();
408 xbt_os_timer_t timer = xbt_os_timer_new();
410 xbt_os_walltimer_start(global_timer);
413 xbt_os_walltimer_start(timer);
418 hash_result = (s1->hash != s2->hash);
420 XBT_TRACE2(mc, hash_diff, num1, num2);
421 XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1,
422 num2, s1->hash, s2->hash);
427 XBT_VERB("(%d - %d) Same hash : 0x%" PRIx64, num1, num2, s1->hash);
431 /* Compare enabled processes */
434 xbt_dynar_foreach(s1->enabled_processes, cursor, pid){
435 if(!xbt_dynar_member(s2->enabled_processes, &pid)) {
436 //XBT_TRACE3(mc, state_diff, num1, num2, "Different enabled processes");
437 XBT_VERB("(%d - %d) Different enabled processes", num1, num2);
443 size_t size_used1, size_used2;
446 /* Compare size of stacks */
447 while (i < xbt_dynar_length(s1->stacks)) {
448 size_used1 = s1->stack_sizes[i];
449 size_used2 = s2->stack_sizes[i];
450 if (size_used1 != size_used2) {
453 xbt_os_walltimer_stop(timer);
454 mc_comp_times->stacks_sizes_comparison_time =
455 xbt_os_timer_elapsed(timer);
457 XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1,
458 num2, size_used1, size_used2);
463 XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1,
464 num2, size_used1, size_used2);
466 XBT_TRACE3(mc, state_diff, num1, num2, "Different stack size");
468 xbt_os_walltimer_stop(timer);
469 xbt_os_timer_free(timer);
470 xbt_os_walltimer_stop(global_timer);
471 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
472 xbt_os_timer_free(global_timer);
482 xbt_os_walltimer_stop(timer);
483 xbt_os_walltimer_start(timer);
486 /* Init heap information used in heap comparison algorithm */
487 xbt_mheap_t heap1 = (xbt_mheap_t) MC_snapshot_read(
488 s1, MC_ADDRESS_SPACE_READ_FLAGS_LAZY,
489 alloca(sizeof(struct mdesc)), process->heap_address, sizeof(struct mdesc),
490 MC_PROCESS_INDEX_MISSING);
491 xbt_mheap_t heap2 = (xbt_mheap_t) MC_snapshot_read(
492 s2, MC_ADDRESS_SPACE_READ_FLAGS_LAZY,
493 alloca(sizeof(struct mdesc)), process->heap_address, sizeof(struct mdesc),
494 MC_PROCESS_INDEX_MISSING);
495 res_init = init_heap_information(heap1, heap2, s1->to_ignore, s2->to_ignore);
496 if (res_init == -1) {
498 XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
502 XBT_TRACE3(mc, state_diff, num1, num2, "Different heap information");
503 XBT_VERB("(%d - %d) Different heap information", num1, num2);
506 xbt_os_walltimer_stop(global_timer);
507 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
508 xbt_os_timer_free(global_timer);
514 xbt_os_walltimer_start(timer);
517 /* Stacks comparison */
523 mc_snapshot_stack_t stack1, stack2;
524 while (cursor < xbt_dynar_length(s1->stacks)) {
526 (mc_snapshot_stack_t) xbt_dynar_get_as(s1->stacks, cursor,
527 mc_snapshot_stack_t);
529 (mc_snapshot_stack_t) xbt_dynar_get_as(s2->stacks, cursor,
530 mc_snapshot_stack_t);
532 if (stack1->process_index != stack2->process_index) {
534 XBT_DEBUG("(%d - %d) Stacks with different process index (%i vs %i)", num1, num2,
535 stack1->process_index, stack2->process_index);
538 compare_local_variables(stack1->process_index, s1, s2, stack1, stack2);
539 if (diff_local > 0) {
540 XBT_TRACE3(mc, state_diff, num1, num2, "Different local variables");
543 xbt_os_walltimer_stop(timer);
544 mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
546 XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1,
553 XBT_VERB("(%d - %d) Different local variables between stacks %d", num1,
557 reset_heap_information();
558 xbt_os_walltimer_stop(timer);
559 xbt_os_timer_free(timer);
560 xbt_os_walltimer_stop(global_timer);
561 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
562 xbt_os_timer_free(global_timer);
570 size_t regions_count = s1->snapshot_regions_count;
571 // TODO, raise a difference instead?
572 xbt_assert(regions_count == s2->snapshot_regions_count);
574 mc_comp_times->global_variables_comparison_time = 0;
576 for (size_t k = 0; k != regions_count; ++k) {
577 mc_mem_region_t region1 = s1->snapshot_regions[k];
578 mc_mem_region_t region2 = s2->snapshot_regions[k];
581 if (region1->region_type != MC_REGION_TYPE_DATA)
584 xbt_assert(region1->region_type == region2->region_type);
585 xbt_assert(region1->object_info == region2->object_info);
587 xbt_assert(region1->object_info);
589 const char* name = region1->object_info->file_name;
593 xbt_os_walltimer_stop(timer);
594 xbt_os_walltimer_start(timer);
597 /* Compare global variables */
599 compare_global_variables(region1->object_info, MC_ADDRESS_SPACE_READ_FLAGS_NONE,
604 XBT_TRACE3(mc, state_diff, num1, num2, "Different global variables");
606 xbt_os_walltimer_stop(timer);
607 mc_comp_times->global_variables_comparison_time
608 += xbt_os_timer_elapsed(timer);
609 XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2,
614 XBT_VERB("(%d - %d) Different global variables in %s", num1, num2,
618 reset_heap_information();
619 xbt_os_walltimer_stop(timer);
620 xbt_os_timer_free(timer);
621 xbt_os_walltimer_stop(global_timer);
622 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
623 xbt_os_timer_free(global_timer);
631 xbt_os_walltimer_start(timer);
635 if (mmalloc_compare_heap(s1, s2) > 0) {
636 XBT_TRACE3(mc, state_diff, num1, num2, "Different heap");
639 xbt_os_walltimer_stop(timer);
640 mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
641 XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
646 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
649 reset_heap_information();
650 xbt_os_walltimer_stop(timer);
651 xbt_os_timer_free(timer);
652 xbt_os_walltimer_stop(global_timer);
653 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
654 xbt_os_timer_free(global_timer);
660 xbt_os_walltimer_stop(timer);
664 reset_heap_information();
666 xbt_os_walltimer_stop(timer);
667 xbt_os_timer_free(timer);
670 xbt_os_walltimer_stop(global_timer);
671 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
674 xbt_os_timer_free(global_timer);
677 print_comparison_times();
681 if (errors || hash_result)
682 XBT_VERB("(%d - %d) Difference found", num1, num2);
684 XBT_VERB("(%d - %d) No difference found", num1, num2);
687 #if defined(MC_DEBUG) && defined(MC_VERBOSE)
689 // * false positive SHOULD be avoided.
690 // * There MUST not be any false negative.
692 XBT_VERB("(%d - %d) State equality hash test is %s %s", num1, num2,
693 (hash_result != 0) == (errors != 0) ? "true" : "false",
694 !hash_result ? "positive" : "negative");
698 return errors > 0 || hash_result;
702 /***************************** Statistics *****************************/
703 /*******************************************************************/
705 void print_comparison_times()
707 XBT_DEBUG("*** Comparison times ***");
708 XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
709 XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
710 XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
711 XBT_DEBUG("- GLobal variables : %f", mc_comp_times->global_variables_comparison_time);
712 XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
713 XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);