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 "mc_private.h"
13 #include "xbt/mmalloc.h"
14 #include "xbt/mmalloc/mmprivate.h"
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, mc,
17 "Logging specific to mc_compare");
19 typedef struct s_pointers_pair {
22 bool operator==(s_pointers_pair const& x) const {
23 return this->p1 == x.p1 && this->p2 == x.p2;
25 bool operator<(s_pointers_pair const& x) const {
26 return this->p1 < x.p1 || (this->p1 == x.p1 && this->p2 < x.p2);
28 } s_pointers_pair_t, *pointers_pair_t;
32 struct hash<s_pointers_pair> {
33 typedef uintptr_t result_type;
34 result_type operator()(s_pointers_pair const& x) const {
35 return (result_type) x.p1 ^
36 ((result_type) x.p2 << 8 | (result_type) x.p2 >> (8*sizeof(uintptr_t) - 8));
41 struct mc_compare_state {
42 boost::unordered_set<s_pointers_pair> compared_pointers;
47 /************************** Free functions ****************************/
48 /********************************************************************/
50 static void stack_region_free(stack_region_t s)
53 xbt_free(s->process_name);
58 static void stack_region_free_voidp(void *s)
60 stack_region_free((stack_region_t) * (void **) s);
63 static void pointers_pair_free(pointers_pair_t p)
68 static void pointers_pair_free_voidp(void *p)
70 pointers_pair_free((pointers_pair_t) * (void **) p);
73 /************************** Snapshot comparison *******************************/
74 /******************************************************************************/
76 /** \brief Try to add a pair a compared pointers to the set of compared pointers
78 * \result !=0 if the pointers were added (they were not in the set),
79 * 0 otherwise (they were already in the set)
81 static int add_compared_pointers(mc_compare_state& state, void *p1, void *p2)
83 s_pointers_pair_t new_pair;
86 return state.compared_pointers.insert(new_pair).second ? 1 : 0;
89 static int compare_areas_with_type(struct mc_compare_state& state,
90 void* real_area1, mc_snapshot_t snapshot1, mc_mem_region_t region1,
91 void* real_area2, mc_snapshot_t snapshot2, mc_mem_region_t region2,
92 dw_type_t type, int pointer_level)
94 unsigned int cursor = 0;
95 dw_type_t member, subtype, subsubtype;
100 case DW_TAG_unspecified_type:
103 case DW_TAG_base_type:
104 case DW_TAG_enumeration_type:
105 case DW_TAG_union_type:
108 mc_snapshot_read_region(real_area1, region1, alloca(type->byte_size), type->byte_size);
110 mc_snapshot_read_region(real_area2, region2, alloca(type->byte_size), type->byte_size);
111 return (memcmp(data1, data2, type->byte_size) != 0);
115 case DW_TAG_volatile_type:
116 case DW_TAG_const_type:
118 type = type->subtype;
120 case DW_TAG_array_type:
121 subtype = type->subtype;
122 switch (subtype->type) {
123 case DW_TAG_unspecified_type:
126 case DW_TAG_base_type:
127 case DW_TAG_enumeration_type:
128 case DW_TAG_pointer_type:
129 case DW_TAG_reference_type:
130 case DW_TAG_rvalue_reference_type:
131 case DW_TAG_structure_type:
132 case DW_TAG_class_type:
133 case DW_TAG_union_type:
134 if (subtype->full_type)
135 subtype = subtype->full_type;
136 elm_size = subtype->byte_size;
138 case DW_TAG_const_type:
140 case DW_TAG_volatile_type:
141 subsubtype = subtype->subtype;
142 if (subsubtype->full_type)
143 subsubtype = subsubtype->full_type;
144 elm_size = subsubtype->byte_size;
150 for (i = 0; i < type->element_count; i++) {
151 size_t off = i * elm_size;
152 res = compare_areas_with_type(state,
153 (char*) real_area1 + off, snapshot1, region1,
154 (char*) real_area2 + off, snapshot2, region2,
155 type->subtype, pointer_level);
160 case DW_TAG_pointer_type:
161 case DW_TAG_reference_type:
162 case DW_TAG_rvalue_reference_type:
165 void* addr_pointed1 = *(void**) mc_snapshot_read_region(real_area1, region1, &temp, sizeof(void**));
166 void* addr_pointed2 = *(void**) mc_snapshot_read_region(real_area2, region2, &temp, sizeof(void**));
168 if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
169 return (addr_pointed1 != addr_pointed2);
172 if (addr_pointed1 == NULL && addr_pointed2 == NULL)
174 if (addr_pointed1 == NULL || addr_pointed2 == NULL)
176 if (!add_compared_pointers(state, addr_pointed1, addr_pointed2))
181 // Some cases are not handled here:
182 // * the pointers lead to different areas (one to the heap, the other to the RW segment ...);
183 // * a pointer leads to the read-only segment of the current object;
184 // * a pointer lead to a different ELF object.
186 if (addr_pointed1 > std_heap
187 && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)) {
189 (addr_pointed2 > std_heap
190 && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
192 // The pointers are both in the heap:
193 return compare_heap_area(addr_pointed1, addr_pointed2, snapshot1,
194 snapshot2, NULL, type->subtype, pointer_level);
196 // The pointers are both in the current object R/W segment:
197 else if (addr_pointed1 > region1->start_addr
198 && (char *) addr_pointed1 <= (char *) region1->start_addr + region1->size) {
200 (addr_pointed2 > region2->start_addr
201 && (char *) addr_pointed2 <= (char *) region2->start_addr + region2->size))
203 if (type->dw_type_id == NULL)
204 return (addr_pointed1 != addr_pointed2);
206 return compare_areas_with_type(state,
207 addr_pointed1, snapshot1, region1,
208 addr_pointed2, snapshot2, region2,
209 type->subtype, pointer_level);
214 return (addr_pointed1 != addr_pointed2);
219 case DW_TAG_structure_type:
220 case DW_TAG_class_type:
221 xbt_dynar_foreach(type->members, cursor, member) {
223 mc_member_resolve(real_area1, type, member, snapshot1);
225 mc_member_resolve(real_area2, type, member, snapshot2);
226 mc_mem_region_t subregion1 = mc_get_region_hinted(member1, snapshot1, region1);
227 mc_mem_region_t subregion2 = mc_get_region_hinted(member2, snapshot2, region2);
229 compare_areas_with_type(state,
230 member1, snapshot1, subregion1,
231 member2, snapshot2, subregion2,
232 member->subtype, pointer_level);
237 case DW_TAG_subroutine_type:
241 XBT_VERB("Unknown case : %d", type->type);
248 static int compare_global_variables(int region_type, mc_mem_region_t r1,
249 mc_mem_region_t r2, mc_snapshot_t snapshot1,
250 mc_snapshot_t snapshot2)
252 xbt_assert(r1 && r2, "Missing region.");
253 struct mc_compare_state state;
255 xbt_dynar_t variables;
257 unsigned int cursor = 0;
258 dw_variable_t current_var;
260 mc_object_info_t object_info = NULL;
261 if (region_type == 2) {
262 object_info = mc_binary_info;
264 object_info = mc_libsimgrid_info;
266 variables = object_info->global_variables;
268 xbt_dynar_foreach(variables, cursor, current_var) {
270 // If the variable is not in this object, skip it:
271 // We do not expect to find a pointer to something which is not reachable
272 // by the global variables.
273 if ((char *) current_var->address < (char *) object_info->start_rw
274 || (char *) current_var->address > (char *) object_info->end_rw)
277 dw_type_t bvariable_type = current_var->type;
279 compare_areas_with_type(state,
280 (char *) current_var->address, snapshot1, r1,
281 (char *) current_var->address, snapshot2, r2,
284 XBT_VERB("Global variable %s (%p) is different between snapshots",
285 current_var->name, (char *) current_var->address);
295 static int compare_local_variables(mc_snapshot_t snapshot1,
296 mc_snapshot_t snapshot2,
297 mc_snapshot_stack_t stack1,
298 mc_snapshot_stack_t stack2)
300 struct mc_compare_state state;
302 if (xbt_dynar_length(stack1->local_variables) !=
303 xbt_dynar_length(stack2->local_variables)) {
304 XBT_VERB("Different number of local variables");
307 unsigned int cursor = 0;
308 local_variable_t current_var1, current_var2;
310 while (cursor < xbt_dynar_length(stack1->local_variables)) {
312 (local_variable_t) xbt_dynar_get_as(stack1->local_variables, cursor,
315 (local_variable_t) xbt_dynar_get_as(stack2->local_variables, cursor,
317 if (strcmp(current_var1->name, current_var2->name) != 0
318 || current_var1->subprogram != current_var1->subprogram
319 || current_var1->ip != current_var2->ip) {
320 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
322 ("Different name of variable (%s - %s) or frame (%s - %s) or ip (%lu - %lu)",
323 current_var1->name, current_var2->name,
324 current_var1->subprogram->name, current_var2->subprogram->name,
325 current_var1->ip, current_var2->ip);
328 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
330 dw_type_t subtype = current_var1->type;
332 compare_areas_with_type(state,
333 current_var1->address, snapshot1, mc_get_snapshot_region(current_var1->address, snapshot1),
334 current_var2->address, snapshot2, mc_get_snapshot_region(current_var2->address, snapshot2),
338 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
340 ("Local variable %s (%p - %p) in frame %s is different between snapshots",
341 current_var1->name, current_var1->address, current_var2->address,
342 current_var1->subprogram->name);
351 int snapshot_compare(void *state1, void *state2)
354 mc_snapshot_t s1, s2;
357 if (_sg_mc_liveness) { /* Liveness MC */
358 s1 = ((mc_visited_pair_t) state1)->graph_state->system_state;
359 s2 = ((mc_visited_pair_t) state2)->graph_state->system_state;
360 num1 = ((mc_visited_pair_t) state1)->num;
361 num2 = ((mc_visited_pair_t) state2)->num;
362 } else { /* Safety or comm determinism MC */
363 s1 = ((mc_visited_state_t) state1)->system_state;
364 s2 = ((mc_visited_state_t) state2)->system_state;
365 num1 = ((mc_visited_state_t) state1)->num;
366 num2 = ((mc_visited_state_t) state2)->num;
372 xbt_os_timer_t global_timer = xbt_os_timer_new();
373 xbt_os_timer_t timer = xbt_os_timer_new();
375 xbt_os_walltimer_start(global_timer);
378 xbt_os_walltimer_start(timer);
383 hash_result = (s1->hash != s2->hash);
385 XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1,
386 num2, s1->hash, s2->hash);
391 XBT_VERB("(%d - %d) Same hash : 0x%" PRIx64, num1, num2, s1->hash);
395 /* Compare enabled processes */
398 xbt_dynar_foreach(s1->enabled_processes, cursor, pid){
399 if(!xbt_dynar_member(s2->enabled_processes, &pid))
400 XBT_VERB("(%d - %d) Different enabled processes", num1, num2);
404 size_t size_used1, size_used2;
407 /* Compare size of stacks */
408 while (i < xbt_dynar_length(s1->stacks)) {
409 size_used1 = s1->stack_sizes[i];
410 size_used2 = s2->stack_sizes[i];
411 if (size_used1 != size_used2) {
414 xbt_os_walltimer_stop(timer);
415 mc_comp_times->stacks_sizes_comparison_time =
416 xbt_os_timer_elapsed(timer);
418 XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1,
419 num2, size_used1, size_used2);
424 XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1,
425 num2, size_used1, size_used2);
428 xbt_os_walltimer_stop(timer);
429 xbt_os_timer_free(timer);
430 xbt_os_walltimer_stop(global_timer);
431 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
432 xbt_os_timer_free(global_timer);
442 xbt_os_walltimer_stop(timer);
443 xbt_os_walltimer_start(timer);
446 /* Init heap information used in heap comparison algorithm */
447 xbt_mheap_t heap1 = (xbt_mheap_t) mc_snapshot_read(std_heap, s1,
448 alloca(sizeof(struct mdesc)), sizeof(struct mdesc));
449 xbt_mheap_t heap2 = (xbt_mheap_t) mc_snapshot_read(std_heap, s2,
450 alloca(sizeof(struct mdesc)), sizeof(struct mdesc));
451 res_init = init_heap_information(heap1, heap2, s1->to_ignore, s2->to_ignore);
452 if (res_init == -1) {
454 XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
458 XBT_VERB("(%d - %d) Different heap information", num1, num2);
461 xbt_os_walltimer_stop(global_timer);
462 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
463 xbt_os_timer_free(global_timer);
469 xbt_os_walltimer_start(timer);
472 /* Stacks comparison */
478 mc_snapshot_stack_t stack1, stack2;
480 while (cursor < xbt_dynar_length(s1->stacks)) {
482 (mc_snapshot_stack_t) xbt_dynar_get_as(s1->stacks, cursor,
483 mc_snapshot_stack_t);
485 (mc_snapshot_stack_t) xbt_dynar_get_as(s2->stacks, cursor,
486 mc_snapshot_stack_t);
488 compare_local_variables(s1, s2, stack1, stack2);
489 if (diff_local > 0) {
492 xbt_os_walltimer_stop(timer);
493 mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
495 XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1,
502 XBT_VERB("(%d - %d) Different local variables between stacks %d", num1,
506 reset_heap_information();
507 xbt_os_walltimer_stop(timer);
508 xbt_os_timer_free(timer);
509 xbt_os_walltimer_stop(global_timer);
510 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
511 xbt_os_timer_free(global_timer);
521 const char *names[3] = { "?", "libsimgrid", "binary" };
525 &mc_comp_times->libsimgrid_global_variables_comparison_time,
526 &mc_comp_times->binary_global_variables_comparison_time
531 for (k = 2; k != 0; --k) {
534 xbt_os_walltimer_stop(timer);
535 xbt_os_walltimer_start(timer);
538 /* Compare global variables */
540 compare_global_variables(k, s1->regions[k], s2->regions[k], s1, s2);
543 xbt_os_walltimer_stop(timer);
544 *times[k] = xbt_os_timer_elapsed(timer);
545 XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2,
550 XBT_VERB("(%d - %d) Different global variables in %s", num1, num2,
554 reset_heap_information();
555 xbt_os_walltimer_stop(timer);
556 xbt_os_timer_free(timer);
557 xbt_os_walltimer_stop(global_timer);
558 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
559 xbt_os_timer_free(global_timer);
567 xbt_os_walltimer_start(timer);
571 if (mmalloc_compare_heap(s1, s2) > 0) {
574 xbt_os_walltimer_stop(timer);
575 mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
576 XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
581 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
584 reset_heap_information();
585 xbt_os_walltimer_stop(timer);
586 xbt_os_timer_free(timer);
587 xbt_os_walltimer_stop(global_timer);
588 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
589 xbt_os_timer_free(global_timer);
595 xbt_os_walltimer_stop(timer);
599 reset_heap_information();
601 xbt_os_walltimer_stop(timer);
602 xbt_os_timer_free(timer);
605 xbt_os_walltimer_stop(global_timer);
606 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
609 xbt_os_timer_free(global_timer);
612 print_comparison_times();
616 if (errors || hash_result)
617 XBT_VERB("(%d - %d) Difference found", num1, num2);
619 XBT_VERB("(%d - %d) No difference found", num1, num2);
622 #if defined(MC_DEBUG) && defined(MC_VERBOSE)
624 // * false positive SHOULD be avoided.
625 // * There MUST not be any false negative.
627 XBT_VERB("(%d - %d) State equality hash test is %s %s", num1, num2,
628 (hash_result != 0) == (errors != 0) ? "true" : "false",
629 !hash_result ? "positive" : "negative");
633 return errors > 0 || hash_result;
637 /***************************** Statistics *****************************/
638 /*******************************************************************/
640 void print_comparison_times()
642 XBT_DEBUG("*** Comparison times ***");
643 XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
644 XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
645 XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
646 XBT_DEBUG("- Binary global variables : %f",
647 mc_comp_times->binary_global_variables_comparison_time);
648 XBT_DEBUG("- Libsimgrid global variables : %f",
649 mc_comp_times->libsimgrid_global_variables_comparison_time);
650 XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
651 XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
654 /**************************** MC snapshot compare simcall **************************/
655 /***********************************************************************************/
657 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
658 mc_snapshot_t s1, mc_snapshot_t s2)
660 return snapshot_compare(s1, s2);
663 int MC_compare_snapshots(void *s1, void *s2)
666 return simcall_mc_compare_snapshots(s1, s2);