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. */
9 #include "mc_private.h"
11 #include "xbt/mmalloc.h"
12 #include "xbt/mmalloc/mmprivate.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, mc,
15 "Logging specific to mc_compare");
17 typedef struct s_pointers_pair {
20 } s_pointers_pair_t, *pointers_pair_t;
22 __thread xbt_dynar_t compared_pointers;
24 /************************** Free functions ****************************/
25 /********************************************************************/
27 static void stack_region_free(stack_region_t s)
30 xbt_free(s->process_name);
35 static void stack_region_free_voidp(void *s)
37 stack_region_free((stack_region_t) * (void **) s);
40 static void pointers_pair_free(pointers_pair_t p)
45 static void pointers_pair_free_voidp(void *p)
47 pointers_pair_free((pointers_pair_t) * (void **) p);
50 /************************** Snapshot comparison *******************************/
51 /******************************************************************************/
53 /** \brief Try to add a pair a compared pointers to the set of compared pointers
55 * \result !=0 if the pointers were added (they were not in the set),
56 * 0 otherwise (they were already in the set)
58 static int add_compared_pointers(void *p1, void *p2)
61 pointers_pair_t new_pair = xbt_new0(s_pointers_pair_t, 1);
65 if (xbt_dynar_is_empty(compared_pointers)) {
66 xbt_dynar_push(compared_pointers, &new_pair);
70 unsigned int cursor = 0;
72 int end = xbt_dynar_length(compared_pointers) - 1;
73 pointers_pair_t pair = NULL;
76 (pointers_pair_t *) xbt_dynar_get_ptr(compared_pointers, 0);
78 while (start <= end) {
79 cursor = (start + end) / 2;
83 } else if (pair->p1 > p1) {
85 } else if (pair->p2 < p2) {
87 } else if (pair->p2 > p2) {
90 pointers_pair_free(new_pair);
96 xbt_dynar_insert_at(compared_pointers, cursor + 1, &new_pair);
97 else if (pair->p1 > p1)
98 xbt_dynar_insert_at(compared_pointers, cursor, &new_pair);
99 else if (pair->p2 < p2)
100 xbt_dynar_insert_at(compared_pointers, cursor + 1, &new_pair);
101 else if (pair->p2 > p2)
102 xbt_dynar_insert_at(compared_pointers, cursor, &new_pair);
104 xbt_die("Unrecheable");
109 static int compare_areas_with_type(void *area1, void *area2,
110 mc_snapshot_t snapshot1,
111 mc_snapshot_t snapshot2, dw_type_t type,
112 int region_size, int region_type,
113 void *start_data, int pointer_level)
116 unsigned int cursor = 0;
117 dw_type_t member, subtype, subsubtype;
118 int elm_size, i, res;
119 void *addr_pointed1, *addr_pointed2;
121 switch (type->type) {
122 case DW_TAG_unspecified_type:
125 case DW_TAG_base_type:
126 case DW_TAG_enumeration_type:
127 case DW_TAG_union_type:
128 return (memcmp(area1, area2, type->byte_size) != 0);
131 case DW_TAG_volatile_type:
132 case DW_TAG_const_type:
133 return compare_areas_with_type(area1, area2, snapshot1, snapshot2,
134 type->subtype, region_size, region_type,
135 start_data, pointer_level);
137 case DW_TAG_array_type:
138 subtype = type->subtype;
139 switch (subtype->type) {
140 case DW_TAG_unspecified_type:
143 case DW_TAG_base_type:
144 case DW_TAG_enumeration_type:
145 case DW_TAG_pointer_type:
146 case DW_TAG_reference_type:
147 case DW_TAG_rvalue_reference_type:
148 case DW_TAG_structure_type:
149 case DW_TAG_class_type:
150 case DW_TAG_union_type:
151 if (subtype->full_type)
152 subtype = subtype->full_type;
153 elm_size = subtype->byte_size;
155 case DW_TAG_const_type:
157 case DW_TAG_volatile_type:
158 subsubtype = subtype->subtype;
159 if (subsubtype->full_type)
160 subsubtype = subsubtype->full_type;
161 elm_size = subsubtype->byte_size;
167 for (i = 0; i < type->element_count; i++) {
169 compare_areas_with_type((char *) area1 + (i * elm_size),
170 (char *) area2 + (i * elm_size), snapshot1,
171 snapshot2, type->subtype, region_size,
172 region_type, start_data, pointer_level);
177 case DW_TAG_pointer_type:
178 case DW_TAG_reference_type:
179 case DW_TAG_rvalue_reference_type:
181 addr_pointed1 = *((void **) (area1));
182 addr_pointed2 = *((void **) (area2));
184 if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
185 return (addr_pointed1 != addr_pointed2);
188 if (addr_pointed1 == NULL && addr_pointed2 == NULL)
190 if (!add_compared_pointers(addr_pointed1, addr_pointed2))
195 // Some cases are not handled here:
196 // * the pointers lead to different areas (one to the heap, the other to the RW segment ...);
197 // * a pointer leads to the read-only segment of the current object;
198 // * a pointer lead to a different ELF object.
200 if (addr_pointed1 > std_heap
201 && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)) {
203 (addr_pointed2 > std_heap
204 && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
206 // The pointers are both in the heap:
207 return compare_heap_area(addr_pointed1, addr_pointed2, snapshot1,
208 snapshot2, NULL, type->subtype, pointer_level);
210 // The pointers are both in the current object R/W segment:
211 else if (addr_pointed1 > start_data
212 && (char *) addr_pointed1 <= (char *) start_data + region_size) {
214 (addr_pointed2 > start_data
215 && (char *) addr_pointed2 <= (char *) start_data + region_size))
217 if (type->dw_type_id == NULL)
218 return (addr_pointed1 != addr_pointed2);
220 void *translated_addr_pointer1 =
221 mc_translate_address((uintptr_t) addr_pointed1, snapshot1);
222 void *translated_addr_pointer2 =
223 mc_translate_address((uintptr_t) addr_pointed2, snapshot2);
224 return compare_areas_with_type(translated_addr_pointer1,
225 translated_addr_pointer2, snapshot1,
226 snapshot2, type->subtype, region_size,
227 region_type, start_data,
233 return (addr_pointed1 != addr_pointed2);
237 case DW_TAG_structure_type:
238 case DW_TAG_class_type:
239 xbt_dynar_foreach(type->members, cursor, member) {
240 XBT_DEBUG("Compare member %s", member->name);
242 mc_member_snapshot_resolve(area1, type, member, snapshot1);
244 mc_member_snapshot_resolve(area2, type, member, snapshot2);
246 compare_areas_with_type(member1, member2, snapshot1, snapshot2,
247 member->subtype, region_size, region_type,
248 start_data, pointer_level);
253 case DW_TAG_subroutine_type:
257 XBT_VERB("Unknown case : %d", type->type);
264 static int compare_global_variables(int region_type, mc_mem_region_t r1,
265 mc_mem_region_t r2, mc_snapshot_t snapshot1,
266 mc_snapshot_t snapshot2)
269 if (!compared_pointers) {
271 xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
273 xbt_dynar_reset(compared_pointers);
276 xbt_dynar_t variables;
278 unsigned int cursor = 0;
279 dw_variable_t current_var;
282 void *start_data_binary = mc_binary_info->start_rw;
283 void *start_data_libsimgrid = mc_libsimgrid_info->start_rw;
285 mc_object_info_t object_info = NULL;
286 if (region_type == 2) {
287 object_info = mc_binary_info;
288 start_data = start_data_binary;
290 object_info = mc_libsimgrid_info;
291 start_data = start_data_libsimgrid;
293 variables = object_info->global_variables;
295 xbt_dynar_foreach(variables, cursor, current_var) {
297 // If the variable is not in this object, skip it:
298 // We do not expect to find a pointer to something which is not reachable
299 // by the global variables.
300 if ((char *) current_var->address < (char *) object_info->start_rw
301 || (char *) current_var->address > (char *) object_info->end_rw)
304 offset = (char *) current_var->address - (char *) object_info->start_rw;
306 dw_type_t bvariable_type = current_var->type;
308 compare_areas_with_type((char *) r1->data + offset,
309 (char *) r2->data + offset, snapshot1,
310 snapshot2, bvariable_type, r1->size,
311 region_type, start_data, 0);
313 XBT_VERB("Global variable %s (%p - %p) is different between snapshots",
314 current_var->name, (char *) r1->data + offset,
315 (char *) r2->data + offset);
316 xbt_dynar_free(&compared_pointers);
317 compared_pointers = NULL;
323 xbt_dynar_free(&compared_pointers);
324 compared_pointers = NULL;
330 static int compare_local_variables(mc_snapshot_t snapshot1,
331 mc_snapshot_t snapshot2,
332 mc_snapshot_stack_t stack1,
333 mc_snapshot_stack_t stack2, void *heap1,
336 void *start_data_binary = mc_binary_info->start_rw;
337 void *start_data_libsimgrid = mc_libsimgrid_info->start_rw;
339 if (!compared_pointers) {
341 xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
343 xbt_dynar_reset(compared_pointers);
346 if (xbt_dynar_length(stack1->local_variables) !=
347 xbt_dynar_length(stack2->local_variables)) {
348 XBT_VERB("Different number of local variables");
349 xbt_dynar_free(&compared_pointers);
350 compared_pointers = NULL;
353 unsigned int cursor = 0;
354 local_variable_t current_var1, current_var2;
355 int offset1, offset2, res;
356 while (cursor < xbt_dynar_length(stack1->local_variables)) {
358 (local_variable_t) xbt_dynar_get_as(stack1->local_variables, cursor,
361 (local_variable_t) xbt_dynar_get_as(stack2->local_variables, cursor,
363 if (strcmp(current_var1->name, current_var2->name) != 0
364 || current_var1->subprogram != current_var1->subprogram
365 || current_var1->ip != current_var2->ip) {
366 xbt_dynar_free(&compared_pointers);
367 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
369 ("Different name of variable (%s - %s) or frame (%s - %s) or ip (%lu - %lu)",
370 current_var1->name, current_var2->name,
371 current_var1->subprogram->name, current_var2->subprogram->name,
372 current_var1->ip, current_var2->ip);
375 offset1 = (char *) current_var1->address - (char *) std_heap;
376 offset2 = (char *) current_var2->address - (char *) std_heap;
377 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
378 XBT_DEBUG("Compare local variable %s of frame %s",
379 current_var1->subprogram->name, current_var1->subprogram->name);
382 if (current_var1->region == 1) {
383 dw_type_t subtype = current_var1->type;
385 compare_areas_with_type((char *) heap1 + offset1,
386 (char *) heap2 + offset2, snapshot1,
387 snapshot2, subtype, 0, 1,
388 start_data_libsimgrid, 0);
390 dw_type_t subtype = current_var2->type;
392 compare_areas_with_type((char *) heap1 + offset1,
393 (char *) heap2 + offset2, snapshot1,
394 snapshot2, subtype, 0, 2, start_data_binary,
398 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
400 ("Local variable %s (%p - %p) in frame %s is different between snapshots",
401 current_var1->name, (char *) heap1 + offset1,
402 (char *) heap2 + offset2, current_var1->subprogram->name);
403 xbt_dynar_free(&compared_pointers);
404 compared_pointers = NULL;
409 xbt_dynar_free(&compared_pointers);
410 compared_pointers = NULL;
415 int snapshot_compare(void *state1, void *state2)
418 mc_snapshot_t s1, s2;
421 if (_sg_mc_property_file && _sg_mc_property_file[0] != '\0') { /* Liveness MC */
422 s1 = ((mc_visited_pair_t) state1)->graph_state->system_state;
423 s2 = ((mc_visited_pair_t) state2)->graph_state->system_state;
424 num1 = ((mc_visited_pair_t) state1)->num;
425 num2 = ((mc_visited_pair_t) state2)->num;
426 /* Firstly compare automaton state */
427 /*if(xbt_automaton_state_compare(((mc_pair_t)state1)->automaton_state, ((mc_pair_t)state2)->automaton_state) != 0)
429 if(xbt_automaton_propositional_symbols_compare_value(((mc_pair_t)state1)->atomic_propositions, ((mc_pair_t)state2)->atomic_propositions) != 0)
431 } else { /* Safety MC */
432 s1 = ((mc_visited_state_t) state1)->system_state;
433 s2 = ((mc_visited_state_t) state2)->system_state;
434 num1 = ((mc_visited_state_t) state1)->num;
435 num2 = ((mc_visited_state_t) state2)->num;
441 xbt_os_timer_t global_timer = xbt_os_timer_new();
442 xbt_os_timer_t timer = xbt_os_timer_new();
444 xbt_os_walltimer_start(global_timer);
447 xbt_os_walltimer_start(timer);
452 hash_result = (s1->hash != s2->hash);
454 XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1,
455 num2, s1->hash, s2->hash);
460 XBT_VERB("(%d - %d) Same hash : 0x%" PRIx64, num1, num2, s1->hash);
464 /* Compare enabled processes */
467 xbt_dynar_foreach(s1->enabled_processes, cursor, pid){
468 if(!xbt_dynar_member(s2->enabled_processes, &pid))
469 XBT_VERB("(%d - %d) Different enabled processes", num1, num2);
473 size_t size_used1, size_used2;
476 /* Compare size of stacks */
477 while (i < xbt_dynar_length(s1->stacks)) {
478 size_used1 = s1->stack_sizes[i];
479 size_used2 = s2->stack_sizes[i];
480 if (size_used1 != size_used2) {
483 xbt_os_walltimer_stop(timer);
484 mc_comp_times->stacks_sizes_comparison_time =
485 xbt_os_timer_elapsed(timer);
487 XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1,
488 num2, size_used1, size_used2);
493 XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1,
494 num2, size_used1, size_used2);
497 xbt_os_walltimer_stop(timer);
498 xbt_os_timer_free(timer);
499 xbt_os_walltimer_stop(global_timer);
500 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
501 xbt_os_timer_free(global_timer);
511 xbt_os_walltimer_stop(timer);
512 xbt_os_walltimer_start(timer);
515 /* Init heap information used in heap comparison algorithm */
517 init_heap_information((xbt_mheap_t) s1->regions[0]->data,
518 (xbt_mheap_t) s2->regions[0]->data, s1->to_ignore,
520 if (res_init == -1) {
522 XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
526 XBT_VERB("(%d - %d) Different heap information", num1, num2);
529 xbt_os_walltimer_stop(global_timer);
530 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
531 xbt_os_timer_free(global_timer);
537 xbt_os_walltimer_start(timer);
540 /* Stacks comparison */
546 mc_snapshot_stack_t stack1, stack2;
548 while (cursor < xbt_dynar_length(s1->stacks)) {
550 (mc_snapshot_stack_t) xbt_dynar_get_as(s1->stacks, cursor,
551 mc_snapshot_stack_t);
553 (mc_snapshot_stack_t) xbt_dynar_get_as(s2->stacks, cursor,
554 mc_snapshot_stack_t);
556 compare_local_variables(s1, s2, stack1, stack2, s1->regions[0]->data,
557 s2->regions[0]->data);
558 if (diff_local > 0) {
561 xbt_os_walltimer_stop(timer);
562 mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
564 XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1,
571 XBT_VERB("(%d - %d) Different local variables between stacks %d", num1,
575 reset_heap_information();
576 xbt_os_walltimer_stop(timer);
577 xbt_os_timer_free(timer);
578 xbt_os_walltimer_stop(global_timer);
579 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
580 xbt_os_timer_free(global_timer);
590 const char *names[3] = { "?", "libsimgrid", "binary" };
594 &mc_comp_times->libsimgrid_global_variables_comparison_time,
595 &mc_comp_times->binary_global_variables_comparison_time
600 for (k = 2; k != 0; --k) {
603 xbt_os_walltimer_stop(timer);
604 xbt_os_walltimer_start(timer);
607 /* Compare global variables */
609 compare_global_variables(k, s1->regions[k], s2->regions[k], s1, s2);
612 xbt_os_walltimer_stop(timer);
613 *times[k] = xbt_os_timer_elapsed(timer);
614 XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2,
619 XBT_VERB("(%d - %d) Different global variables in %s", num1, num2,
623 reset_heap_information();
624 xbt_os_walltimer_stop(timer);
625 xbt_os_timer_free(timer);
626 xbt_os_walltimer_stop(global_timer);
627 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
628 xbt_os_timer_free(global_timer);
636 xbt_os_walltimer_start(timer);
640 if (mmalloc_compare_heap(s1, s2, (xbt_mheap_t) s1->regions[0]->data,
641 (xbt_mheap_t) s2->regions[0]->data) > 0) {
644 xbt_os_walltimer_stop(timer);
645 mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
646 XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
651 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
654 reset_heap_information();
655 xbt_os_walltimer_stop(timer);
656 xbt_os_timer_free(timer);
657 xbt_os_walltimer_stop(global_timer);
658 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
659 xbt_os_timer_free(global_timer);
665 xbt_os_walltimer_stop(timer);
669 reset_heap_information();
671 xbt_os_walltimer_stop(timer);
672 xbt_os_timer_free(timer);
675 xbt_os_walltimer_stop(global_timer);
676 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
679 xbt_os_timer_free(global_timer);
682 print_comparison_times();
686 if (errors || hash_result)
687 XBT_VERB("(%d - %d) Difference found", num1, num2);
689 XBT_VERB("(%d - %d) No difference found", num1, num2);
692 #if defined(MC_DEBUG) && defined(MC_VERBOSE)
694 // * false positive SHOULD be avoided.
695 // * There MUST not be any false negative.
697 XBT_VERB("(%d - %d) State equality hash test is %s %s", num1, num2,
698 (hash_result != 0) == (errors != 0) ? "true" : "false",
699 !hash_result ? "positive" : "negative");
703 return errors > 0 || hash_result;
707 /***************************** Statistics *****************************/
708 /*******************************************************************/
710 void print_comparison_times()
712 XBT_DEBUG("*** Comparison times ***");
713 XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
714 XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
715 XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
716 XBT_DEBUG("- Binary global variables : %f",
717 mc_comp_times->binary_global_variables_comparison_time);
718 XBT_DEBUG("- Libsimgrid global variables : %f",
719 mc_comp_times->libsimgrid_global_variables_comparison_time);
720 XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
721 XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
724 /**************************** MC snapshot compare simcall **************************/
725 /***********************************************************************************/
727 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
728 mc_snapshot_t s1, mc_snapshot_t s2)
730 return snapshot_compare(s1, s2);
733 int MC_compare_snapshots(void *s1, void *s2)
736 return simcall_mc_compare_snapshots(s1, s2);