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)
63 xbt_free(s->process_name);
68 static void stack_region_free_voidp(void *s)
70 stack_region_free((stack_region_t) * (void **) s);
73 static void pointers_pair_free(pointers_pair_t p)
78 static void pointers_pair_free_voidp(void *p)
80 pointers_pair_free((pointers_pair_t) * (void **) p);
83 /************************** Snapshot comparison *******************************/
84 /******************************************************************************/
86 /** \brief Try to add a pair a compared pointers to the set of compared pointers
88 * \result !=0 if the pointers were added (they were not in the set),
89 * 0 otherwise (they were already in the set)
91 static int add_compared_pointers(mc_compare_state& state, void *p1, void *p2)
93 s_pointers_pair_t new_pair;
96 return state.compared_pointers.insert(new_pair).second ? 1 : 0;
99 static int compare_areas_with_type(struct mc_compare_state& state,
101 void* real_area1, mc_snapshot_t snapshot1, mc_mem_region_t region1,
102 void* real_area2, mc_snapshot_t snapshot2, mc_mem_region_t region2,
103 dw_type_t type, int pointer_level)
105 unsigned int cursor = 0;
106 dw_type_t member, subtype, subsubtype;
107 int elm_size, i, res;
110 switch (type->type) {
111 case DW_TAG_unspecified_type:
114 case DW_TAG_base_type:
115 case DW_TAG_enumeration_type:
116 case DW_TAG_union_type:
118 return mc_snapshot_region_memcmp(
119 real_area1, region1, real_area2, region2,
120 type->byte_size) != 0;
123 case DW_TAG_volatile_type:
124 case DW_TAG_const_type:
126 type = type->subtype;
128 case DW_TAG_array_type:
129 subtype = type->subtype;
130 switch (subtype->type) {
131 case DW_TAG_unspecified_type:
134 case DW_TAG_base_type:
135 case DW_TAG_enumeration_type:
136 case DW_TAG_pointer_type:
137 case DW_TAG_reference_type:
138 case DW_TAG_rvalue_reference_type:
139 case DW_TAG_structure_type:
140 case DW_TAG_class_type:
141 case DW_TAG_union_type:
142 if (subtype->full_type)
143 subtype = subtype->full_type;
144 elm_size = subtype->byte_size;
146 case DW_TAG_const_type:
148 case DW_TAG_volatile_type:
149 subsubtype = subtype->subtype;
150 if (subsubtype->full_type)
151 subsubtype = subsubtype->full_type;
152 elm_size = subsubtype->byte_size;
158 for (i = 0; i < type->element_count; i++) {
159 size_t off = i * elm_size;
160 res = compare_areas_with_type(state, process_index,
161 (char*) real_area1 + off, snapshot1, region1,
162 (char*) real_area2 + off, snapshot2, region2,
163 type->subtype, pointer_level);
168 case DW_TAG_pointer_type:
169 case DW_TAG_reference_type:
170 case DW_TAG_rvalue_reference_type:
172 void* addr_pointed1 = mc_snapshot_read_pointer_region(real_area1, region1);
173 void* addr_pointed2 = mc_snapshot_read_pointer_region(real_area2, region2);
175 if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
176 return (addr_pointed1 != addr_pointed2);
179 if (addr_pointed1 == NULL && addr_pointed2 == NULL)
181 if (addr_pointed1 == NULL || addr_pointed2 == NULL)
183 if (!add_compared_pointers(state, addr_pointed1, addr_pointed2))
188 // Some cases are not handled here:
189 // * the pointers lead to different areas (one to the heap, the other to the RW segment ...);
190 // * a pointer leads to the read-only segment of the current object;
191 // * a pointer lead to a different ELF object.
193 if (addr_pointed1 > std_heap
194 && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)) {
196 (addr_pointed2 > std_heap
197 && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
199 // The pointers are both in the heap:
200 return compare_heap_area(process_index, addr_pointed1, addr_pointed2, snapshot1,
201 snapshot2, NULL, type->subtype, pointer_level);
204 // The pointers are both in the current object R/W segment:
205 else if (mc_region_contain(region1, addr_pointed1)) {
206 if (!mc_region_contain(region2, addr_pointed2))
208 if (type->dw_type_id == NULL)
209 return (addr_pointed1 != addr_pointed2);
211 return compare_areas_with_type(state, process_index,
212 addr_pointed1, snapshot1, region1,
213 addr_pointed2, snapshot2, region2,
214 type->subtype, pointer_level);
218 // TODO, We do not handle very well the case where
219 // it belongs to a different (non-heap) region from the current one.
222 return (addr_pointed1 != addr_pointed2);
227 case DW_TAG_structure_type:
228 case DW_TAG_class_type:
229 xbt_dynar_foreach(type->members, cursor, member) {
231 mc_member_resolve(real_area1, type, member, snapshot1, process_index);
233 mc_member_resolve(real_area2, type, member, snapshot2, process_index);
234 mc_mem_region_t subregion1 = mc_get_region_hinted(member1, snapshot1, process_index, region1);
235 mc_mem_region_t subregion2 = mc_get_region_hinted(member2, snapshot2, process_index, region2);
237 compare_areas_with_type(state, process_index,
238 member1, snapshot1, subregion1,
239 member2, snapshot2, subregion2,
240 member->subtype, pointer_level);
245 case DW_TAG_subroutine_type:
249 XBT_VERB("Unknown case : %d", type->type);
256 static int compare_global_variables(mc_object_info_t object_info,
259 mc_mem_region_t r2, mc_snapshot_t snapshot1,
260 mc_snapshot_t snapshot2)
262 xbt_assert(r1 && r2, "Missing region.");
263 struct mc_compare_state state;
265 xbt_dynar_t variables;
267 unsigned int cursor = 0;
268 dw_variable_t current_var;
270 variables = object_info->global_variables;
272 xbt_dynar_foreach(variables, cursor, current_var) {
274 // If the variable is not in this object, skip it:
275 // We do not expect to find a pointer to something which is not reachable
276 // by the global variables.
277 if ((char *) current_var->address < (char *) object_info->start_rw
278 || (char *) current_var->address > (char *) object_info->end_rw)
281 dw_type_t bvariable_type = current_var->type;
283 compare_areas_with_type(state, process_index,
284 (char *) current_var->address, snapshot1, r1,
285 (char *) current_var->address, snapshot2, r2,
288 XBT_TRACE3(mc, global_diff, -1, -1, current_var->name);
289 XBT_VERB("Global variable %s (%p) is different between snapshots",
290 current_var->name, (char *) current_var->address);
300 static int compare_local_variables(int process_index,
301 mc_snapshot_t snapshot1,
302 mc_snapshot_t snapshot2,
303 mc_snapshot_stack_t stack1,
304 mc_snapshot_stack_t stack2)
306 struct mc_compare_state state;
308 if (xbt_dynar_length(stack1->local_variables) !=
309 xbt_dynar_length(stack2->local_variables)) {
310 XBT_VERB("Different number of local variables");
313 unsigned int cursor = 0;
314 local_variable_t current_var1, current_var2;
316 while (cursor < xbt_dynar_length(stack1->local_variables)) {
318 (local_variable_t) xbt_dynar_get_as(stack1->local_variables, cursor,
321 (local_variable_t) xbt_dynar_get_as(stack2->local_variables, cursor,
323 if (strcmp(current_var1->name, current_var2->name) != 0
324 || current_var1->subprogram != current_var1->subprogram
325 || current_var1->ip != current_var2->ip) {
326 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
328 ("Different name of variable (%s - %s) or frame (%s - %s) or ip (%lu - %lu)",
329 current_var1->name, current_var2->name,
330 current_var1->subprogram->name, current_var2->subprogram->name,
331 current_var1->ip, current_var2->ip);
334 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
336 dw_type_t subtype = current_var1->type;
338 compare_areas_with_type(state, process_index,
339 current_var1->address, snapshot1, mc_get_snapshot_region(current_var1->address, snapshot1, process_index),
340 current_var2->address, snapshot2, mc_get_snapshot_region(current_var2->address, snapshot2, process_index),
344 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
345 XBT_TRACE3(mc, local_diff, -1, -1, current_var1->name);
347 ("Local variable %s (%p - %p) in frame %s is different between snapshots",
348 current_var1->name, current_var1->address, current_var2->address,
349 current_var1->subprogram->name);
358 int snapshot_compare(void *state1, void *state2)
361 mc_snapshot_t s1, s2;
364 if (_sg_mc_liveness) { /* Liveness MC */
365 s1 = ((mc_visited_pair_t) state1)->graph_state->system_state;
366 s2 = ((mc_visited_pair_t) state2)->graph_state->system_state;
367 num1 = ((mc_visited_pair_t) state1)->num;
368 num2 = ((mc_visited_pair_t) state2)->num;
369 } else { /* Safety or comm determinism MC */
370 s1 = ((mc_visited_state_t) state1)->system_state;
371 s2 = ((mc_visited_state_t) state2)->system_state;
372 num1 = ((mc_visited_state_t) state1)->num;
373 num2 = ((mc_visited_state_t) state2)->num;
379 xbt_os_timer_t global_timer = xbt_os_timer_new();
380 xbt_os_timer_t timer = xbt_os_timer_new();
382 xbt_os_walltimer_start(global_timer);
385 xbt_os_walltimer_start(timer);
390 hash_result = (s1->hash != s2->hash);
392 XBT_TRACE2(mc, hash_diff, num1, num2);
393 XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1,
394 num2, s1->hash, s2->hash);
399 XBT_VERB("(%d - %d) Same hash : 0x%" PRIx64, num1, num2, s1->hash);
403 /* Compare enabled processes */
406 xbt_dynar_foreach(s1->enabled_processes, cursor, pid){
407 if(!xbt_dynar_member(s2->enabled_processes, &pid)) {
408 //XBT_TRACE3(mc, state_diff, num1, num2, "Different enabled processes");
409 XBT_VERB("(%d - %d) Different enabled processes", num1, num2);
415 size_t size_used1, size_used2;
418 /* Compare size of stacks */
419 while (i < xbt_dynar_length(s1->stacks)) {
420 size_used1 = s1->stack_sizes[i];
421 size_used2 = s2->stack_sizes[i];
422 if (size_used1 != size_used2) {
425 xbt_os_walltimer_stop(timer);
426 mc_comp_times->stacks_sizes_comparison_time =
427 xbt_os_timer_elapsed(timer);
429 XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1,
430 num2, size_used1, size_used2);
435 XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1,
436 num2, size_used1, size_used2);
438 XBT_TRACE3(mc, state_diff, num1, num2, "Different stack size");
440 xbt_os_walltimer_stop(timer);
441 xbt_os_timer_free(timer);
442 xbt_os_walltimer_stop(global_timer);
443 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
444 xbt_os_timer_free(global_timer);
454 xbt_os_walltimer_stop(timer);
455 xbt_os_walltimer_start(timer);
458 /* Init heap information used in heap comparison algorithm */
459 xbt_mheap_t heap1 = (xbt_mheap_t) mc_snapshot_read(std_heap, s1, MC_NO_PROCESS_INDEX,
460 alloca(sizeof(struct mdesc)), sizeof(struct mdesc));
461 xbt_mheap_t heap2 = (xbt_mheap_t) mc_snapshot_read(std_heap, s2, MC_NO_PROCESS_INDEX,
462 alloca(sizeof(struct mdesc)), sizeof(struct mdesc));
463 res_init = init_heap_information(heap1, heap2, s1->to_ignore, s2->to_ignore);
464 if (res_init == -1) {
466 XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
470 XBT_TRACE3(mc, state_diff, num1, num2, "Different heap information");
471 XBT_VERB("(%d - %d) Different heap information", num1, num2);
474 xbt_os_walltimer_stop(global_timer);
475 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
476 xbt_os_timer_free(global_timer);
482 xbt_os_walltimer_start(timer);
485 /* Stacks comparison */
491 mc_snapshot_stack_t stack1, stack2;
492 while (cursor < xbt_dynar_length(s1->stacks)) {
494 (mc_snapshot_stack_t) xbt_dynar_get_as(s1->stacks, cursor,
495 mc_snapshot_stack_t);
497 (mc_snapshot_stack_t) xbt_dynar_get_as(s2->stacks, cursor,
498 mc_snapshot_stack_t);
500 if (stack1->process_index != stack2->process_index) {
502 XBT_DEBUG("(%d - %d) Stacks with different process index (%i vs %i)", num1, num2,
503 stack1->process_index, stack2->process_index);
506 compare_local_variables(stack1->process_index, s1, s2, stack1, stack2);
507 if (diff_local > 0) {
508 XBT_TRACE3(mc, state_diff, num1, num2, "Different local variables");
511 xbt_os_walltimer_stop(timer);
512 mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
514 XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1,
521 XBT_VERB("(%d - %d) Different local variables between stacks %d", num1,
525 reset_heap_information();
526 xbt_os_walltimer_stop(timer);
527 xbt_os_timer_free(timer);
528 xbt_os_walltimer_stop(global_timer);
529 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
530 xbt_os_timer_free(global_timer);
540 const char *names[3] = { "?", "libsimgrid", "binary" };
544 &mc_comp_times->libsimgrid_global_variables_comparison_time,
545 &mc_comp_times->binary_global_variables_comparison_time
549 mc_object_info_t object_infos[] = { NULL, mc_libsimgrid_info, mc_binary_info };
552 for (k = 2; k != 0; --k) {
555 xbt_os_walltimer_stop(timer);
556 xbt_os_walltimer_start(timer);
559 /* Compare global variables */
561 if (object_infos[k] == mc_binary_info && smpi_privatize_global_variables) {
562 // Compare the global variables separately for each simulates process:
563 for (int process_index = 0; process_index < smpi_process_count(); process_index++) {
565 compare_global_variables(object_infos[k], process_index,
566 s1->privatization_regions[process_index], s2->privatization_regions[process_index], s1, s2);
573 compare_global_variables(object_infos[k], MC_NO_PROCESS_INDEX, s1->regions[k], s2->regions[k], s1, s2);
576 XBT_TRACE3(mc, state_diff, num1, num2, "Different global variables");
578 xbt_os_walltimer_stop(timer);
579 *times[k] = xbt_os_timer_elapsed(timer);
580 XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2,
585 XBT_VERB("(%d - %d) Different global variables in %s", num1, num2,
589 reset_heap_information();
590 xbt_os_walltimer_stop(timer);
591 xbt_os_timer_free(timer);
592 xbt_os_walltimer_stop(global_timer);
593 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
594 xbt_os_timer_free(global_timer);
602 xbt_os_walltimer_start(timer);
606 if (mmalloc_compare_heap(s1, s2) > 0) {
607 XBT_TRACE3(mc, state_diff, num1, num2, "Different heap");
610 xbt_os_walltimer_stop(timer);
611 mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
612 XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
617 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
620 reset_heap_information();
621 xbt_os_walltimer_stop(timer);
622 xbt_os_timer_free(timer);
623 xbt_os_walltimer_stop(global_timer);
624 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
625 xbt_os_timer_free(global_timer);
631 xbt_os_walltimer_stop(timer);
635 reset_heap_information();
637 xbt_os_walltimer_stop(timer);
638 xbt_os_timer_free(timer);
641 xbt_os_walltimer_stop(global_timer);
642 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
645 xbt_os_timer_free(global_timer);
648 print_comparison_times();
652 if (errors || hash_result)
653 XBT_VERB("(%d - %d) Difference found", num1, num2);
655 XBT_VERB("(%d - %d) No difference found", num1, num2);
658 #if defined(MC_DEBUG) && defined(MC_VERBOSE)
660 // * false positive SHOULD be avoided.
661 // * There MUST not be any false negative.
663 XBT_VERB("(%d - %d) State equality hash test is %s %s", num1, num2,
664 (hash_result != 0) == (errors != 0) ? "true" : "false",
665 !hash_result ? "positive" : "negative");
669 return errors > 0 || hash_result;
673 /***************************** Statistics *****************************/
674 /*******************************************************************/
676 void print_comparison_times()
678 XBT_DEBUG("*** Comparison times ***");
679 XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
680 XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
681 XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
682 XBT_DEBUG("- Binary global variables : %f",
683 mc_comp_times->binary_global_variables_comparison_time);
684 XBT_DEBUG("- Libsimgrid global variables : %f",
685 mc_comp_times->libsimgrid_global_variables_comparison_time);
686 XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
687 XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
690 /**************************** MC snapshot compare simcall **************************/
691 /***********************************************************************************/
693 int simcall_HANDLER_mc_compare_snapshots(smx_simcall_t simcall,
694 mc_snapshot_t s1, mc_snapshot_t s2)
696 return snapshot_compare(s1, s2);
699 int MC_compare_snapshots(void *s1, void *s2)
702 return simcall_mc_compare_snapshots(s1, s2);