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. */
8 #include <boost/unordered_set.hpp>
10 #include "mc_private.h"
12 #include "xbt/mmalloc.h"
13 #include "xbt/mmalloc/mmprivate.h"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, mc,
16 "Logging specific to mc_compare");
18 typedef struct s_pointers_pair {
21 bool operator==(s_pointers_pair const& x) const {
22 return this->p1 == x.p1 && this->p2 == x.p2;
24 bool operator<(s_pointers_pair const& x) const {
25 return this->p1 < x.p1 || (this->p1 == x.p1 && this->p2 < x.p2);
27 } s_pointers_pair_t, *pointers_pair_t;
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));
40 struct mc_compare_state {
41 boost::unordered_set<s_pointers_pair> compared_pointers;
46 /************************** Free functions ****************************/
47 /********************************************************************/
49 static void stack_region_free(stack_region_t s)
52 xbt_free(s->process_name);
57 static void stack_region_free_voidp(void *s)
59 stack_region_free((stack_region_t) * (void **) s);
62 static void pointers_pair_free(pointers_pair_t p)
67 static void pointers_pair_free_voidp(void *p)
69 pointers_pair_free((pointers_pair_t) * (void **) p);
72 /************************** Snapshot comparison *******************************/
73 /******************************************************************************/
75 /** \brief Try to add a pair a compared pointers to the set of compared pointers
77 * \result !=0 if the pointers were added (they were not in the set),
78 * 0 otherwise (they were already in the set)
80 static int add_compared_pointers(mc_compare_state& state, void *p1, void *p2)
82 s_pointers_pair_t new_pair;
85 return state.compared_pointers.insert(new_pair).second ? 1 : 0;
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)
93 unsigned int cursor = 0;
94 dw_type_t member, subtype, subsubtype;
99 case DW_TAG_unspecified_type:
102 case DW_TAG_base_type:
103 case DW_TAG_enumeration_type:
104 case DW_TAG_union_type:
107 mc_snapshot_read_region(real_area1, region1, alloca(type->byte_size), type->byte_size);
109 mc_snapshot_read_region(real_area2, region2, alloca(type->byte_size), type->byte_size);
110 return (memcmp(data1, data2, type->byte_size) != 0);
114 case DW_TAG_volatile_type:
115 case DW_TAG_const_type:
117 type = type->subtype;
119 case DW_TAG_array_type:
120 subtype = type->subtype;
121 switch (subtype->type) {
122 case DW_TAG_unspecified_type:
125 case DW_TAG_base_type:
126 case DW_TAG_enumeration_type:
127 case DW_TAG_pointer_type:
128 case DW_TAG_reference_type:
129 case DW_TAG_rvalue_reference_type:
130 case DW_TAG_structure_type:
131 case DW_TAG_class_type:
132 case DW_TAG_union_type:
133 if (subtype->full_type)
134 subtype = subtype->full_type;
135 elm_size = subtype->byte_size;
137 case DW_TAG_const_type:
139 case DW_TAG_volatile_type:
140 subsubtype = subtype->subtype;
141 if (subsubtype->full_type)
142 subsubtype = subsubtype->full_type;
143 elm_size = subsubtype->byte_size;
149 for (i = 0; i < type->element_count; i++) {
150 size_t off = i * elm_size;
151 res = compare_areas_with_type(state,
152 (char*) real_area1 + off, snapshot1, region1,
153 (char*) real_area2 + off, snapshot2, region2,
154 type->subtype, pointer_level);
159 case DW_TAG_pointer_type:
160 case DW_TAG_reference_type:
161 case DW_TAG_rvalue_reference_type:
163 void* addr_pointed1 = mc_snapshot_read_pointer_region(real_area1, region1);
164 void* addr_pointed2 = mc_snapshot_read_pointer_region(real_area2, region2);
166 if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
167 return (addr_pointed1 != addr_pointed2);
170 if (addr_pointed1 == NULL && addr_pointed2 == NULL)
172 if (!add_compared_pointers(state, addr_pointed1, addr_pointed2))
177 // Some cases are not handled here:
178 // * the pointers lead to different areas (one to the heap, the other to the RW segment ...);
179 // * a pointer leads to the read-only segment of the current object;
180 // * a pointer lead to a different ELF object.
182 if (addr_pointed1 > std_heap
183 && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)) {
185 (addr_pointed2 > std_heap
186 && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
188 // The pointers are both in the heap:
189 return compare_heap_area(addr_pointed1, addr_pointed2, snapshot1,
190 snapshot2, NULL, type->subtype, pointer_level);
192 // The pointers are both in the current object R/W segment:
193 else if (addr_pointed1 > region1->start_addr
194 && (char *) addr_pointed1 <= (char *) region1->start_addr + region1->size) {
196 (addr_pointed2 > region2->start_addr
197 && (char *) addr_pointed2 <= (char *) region2->start_addr + region2->size))
199 if (type->dw_type_id == NULL)
200 return (addr_pointed1 != addr_pointed2);
202 return compare_areas_with_type(state,
203 addr_pointed1, snapshot1, region1,
204 addr_pointed2, snapshot2, region2,
205 type->subtype, pointer_level);
210 return (addr_pointed1 != addr_pointed2);
215 case DW_TAG_structure_type:
216 case DW_TAG_class_type:
217 xbt_dynar_foreach(type->members, cursor, member) {
219 mc_member_resolve(real_area1, type, member, snapshot1);
221 mc_member_resolve(real_area2, type, member, snapshot2);
222 mc_mem_region_t subregion1 = mc_get_region_hinted(member1, snapshot1, region1);
223 mc_mem_region_t subregion2 = mc_get_region_hinted(member2, snapshot2, region2);
225 compare_areas_with_type(state,
226 member1, snapshot1, subregion1,
227 member2, snapshot2, subregion2,
228 member->subtype, pointer_level);
233 case DW_TAG_subroutine_type:
237 XBT_VERB("Unknown case : %d", type->type);
244 static int compare_global_variables(int region_type, mc_mem_region_t r1,
245 mc_mem_region_t r2, mc_snapshot_t snapshot1,
246 mc_snapshot_t snapshot2)
249 "Missing region. Did you enable SMPI privatisation? It is not compatible with state comparison.");
250 struct mc_compare_state state;
252 xbt_dynar_t variables;
254 unsigned int cursor = 0;
255 dw_variable_t current_var;
257 mc_object_info_t object_info = NULL;
258 if (region_type == 2) {
259 object_info = mc_binary_info;
261 object_info = mc_libsimgrid_info;
263 variables = object_info->global_variables;
265 xbt_dynar_foreach(variables, cursor, current_var) {
267 // If the variable is not in this object, skip it:
268 // We do not expect to find a pointer to something which is not reachable
269 // by the global variables.
270 if ((char *) current_var->address < (char *) object_info->start_rw
271 || (char *) current_var->address > (char *) object_info->end_rw)
274 dw_type_t bvariable_type = current_var->type;
276 compare_areas_with_type(state,
277 (char *) current_var->address, snapshot1, r1,
278 (char *) current_var->address, snapshot2, r2,
281 XBT_VERB("Global variable %s (%p) is different between snapshots",
282 current_var->name, (char *) current_var->address);
292 static int compare_local_variables(mc_snapshot_t snapshot1,
293 mc_snapshot_t snapshot2,
294 mc_snapshot_stack_t stack1,
295 mc_snapshot_stack_t stack2)
297 struct mc_compare_state state;
299 if (xbt_dynar_length(stack1->local_variables) !=
300 xbt_dynar_length(stack2->local_variables)) {
301 XBT_VERB("Different number of local variables");
304 unsigned int cursor = 0;
305 local_variable_t current_var1, current_var2;
307 while (cursor < xbt_dynar_length(stack1->local_variables)) {
309 (local_variable_t) xbt_dynar_get_as(stack1->local_variables, cursor,
312 (local_variable_t) xbt_dynar_get_as(stack2->local_variables, cursor,
314 if (strcmp(current_var1->name, current_var2->name) != 0
315 || current_var1->subprogram != current_var1->subprogram
316 || current_var1->ip != current_var2->ip) {
317 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
319 ("Different name of variable (%s - %s) or frame (%s - %s) or ip (%lu - %lu)",
320 current_var1->name, current_var2->name,
321 current_var1->subprogram->name, current_var2->subprogram->name,
322 current_var1->ip, current_var2->ip);
325 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
327 dw_type_t subtype = current_var1->type;
329 compare_areas_with_type(state,
330 current_var1->address, snapshot1, mc_get_snapshot_region(current_var1->address, snapshot1),
331 current_var2->address, snapshot2, mc_get_snapshot_region(current_var2->address, snapshot2),
335 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
337 ("Local variable %s (%p - %p) in frame %s is different between snapshots",
338 current_var1->name, current_var1->address, current_var2->address,
339 current_var1->subprogram->name);
348 int snapshot_compare(void *state1, void *state2)
351 mc_snapshot_t s1, s2;
354 if (_sg_mc_liveness) { /* Liveness MC */
355 s1 = ((mc_visited_pair_t) state1)->graph_state->system_state;
356 s2 = ((mc_visited_pair_t) state2)->graph_state->system_state;
357 num1 = ((mc_visited_pair_t) state1)->num;
358 num2 = ((mc_visited_pair_t) state2)->num;
359 } else { /* Safety or comm determinism MC */
360 s1 = ((mc_visited_state_t) state1)->system_state;
361 s2 = ((mc_visited_state_t) state2)->system_state;
362 num1 = ((mc_visited_state_t) state1)->num;
363 num2 = ((mc_visited_state_t) state2)->num;
369 xbt_os_timer_t global_timer = xbt_os_timer_new();
370 xbt_os_timer_t timer = xbt_os_timer_new();
372 xbt_os_walltimer_start(global_timer);
375 xbt_os_walltimer_start(timer);
380 hash_result = (s1->hash != s2->hash);
382 XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1,
383 num2, s1->hash, s2->hash);
388 XBT_VERB("(%d - %d) Same hash : 0x%" PRIx64, num1, num2, s1->hash);
392 /* Compare enabled processes */
395 xbt_dynar_foreach(s1->enabled_processes, cursor, pid){
396 if(!xbt_dynar_member(s2->enabled_processes, &pid))
397 XBT_VERB("(%d - %d) Different enabled processes", num1, num2);
401 size_t size_used1, size_used2;
404 /* Compare size of stacks */
405 while (i < xbt_dynar_length(s1->stacks)) {
406 size_used1 = s1->stack_sizes[i];
407 size_used2 = s2->stack_sizes[i];
408 if (size_used1 != size_used2) {
411 xbt_os_walltimer_stop(timer);
412 mc_comp_times->stacks_sizes_comparison_time =
413 xbt_os_timer_elapsed(timer);
415 XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1,
416 num2, size_used1, size_used2);
421 XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1,
422 num2, size_used1, size_used2);
425 xbt_os_walltimer_stop(timer);
426 xbt_os_timer_free(timer);
427 xbt_os_walltimer_stop(global_timer);
428 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
429 xbt_os_timer_free(global_timer);
439 xbt_os_walltimer_stop(timer);
440 xbt_os_walltimer_start(timer);
443 /* Init heap information used in heap comparison algorithm */
444 xbt_mheap_t heap1 = (xbt_mheap_t) mc_snapshot_read(std_heap, s1,
445 alloca(sizeof(struct mdesc)), sizeof(struct mdesc));
446 xbt_mheap_t heap2 = (xbt_mheap_t) mc_snapshot_read(std_heap, s2,
447 alloca(sizeof(struct mdesc)), sizeof(struct mdesc));
448 res_init = init_heap_information(heap1, heap2, s1->to_ignore, s2->to_ignore);
449 if (res_init == -1) {
451 XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
455 XBT_VERB("(%d - %d) Different heap information", num1, num2);
458 xbt_os_walltimer_stop(global_timer);
459 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
460 xbt_os_timer_free(global_timer);
466 xbt_os_walltimer_start(timer);
469 /* Stacks comparison */
475 mc_snapshot_stack_t stack1, stack2;
477 while (cursor < xbt_dynar_length(s1->stacks)) {
479 (mc_snapshot_stack_t) xbt_dynar_get_as(s1->stacks, cursor,
480 mc_snapshot_stack_t);
482 (mc_snapshot_stack_t) xbt_dynar_get_as(s2->stacks, cursor,
483 mc_snapshot_stack_t);
485 compare_local_variables(s1, s2, stack1, stack2);
486 if (diff_local > 0) {
489 xbt_os_walltimer_stop(timer);
490 mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
492 XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1,
499 XBT_VERB("(%d - %d) Different local variables between stacks %d", num1,
503 reset_heap_information();
504 xbt_os_walltimer_stop(timer);
505 xbt_os_timer_free(timer);
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);
518 const char *names[3] = { "?", "libsimgrid", "binary" };
522 &mc_comp_times->libsimgrid_global_variables_comparison_time,
523 &mc_comp_times->binary_global_variables_comparison_time
528 for (k = 2; k != 0; --k) {
531 xbt_os_walltimer_stop(timer);
532 xbt_os_walltimer_start(timer);
535 /* Compare global variables */
537 compare_global_variables(k, s1->regions[k], s2->regions[k], s1, s2);
540 xbt_os_walltimer_stop(timer);
541 *times[k] = xbt_os_timer_elapsed(timer);
542 XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2,
547 XBT_VERB("(%d - %d) Different global variables in %s", num1, num2,
551 reset_heap_information();
552 xbt_os_walltimer_stop(timer);
553 xbt_os_timer_free(timer);
554 xbt_os_walltimer_stop(global_timer);
555 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
556 xbt_os_timer_free(global_timer);
564 xbt_os_walltimer_start(timer);
568 if (mmalloc_compare_heap(s1, s2) > 0) {
571 xbt_os_walltimer_stop(timer);
572 mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
573 XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
578 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
581 reset_heap_information();
582 xbt_os_walltimer_stop(timer);
583 xbt_os_timer_free(timer);
584 xbt_os_walltimer_stop(global_timer);
585 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
586 xbt_os_timer_free(global_timer);
592 xbt_os_walltimer_stop(timer);
596 reset_heap_information();
598 xbt_os_walltimer_stop(timer);
599 xbt_os_timer_free(timer);
602 xbt_os_walltimer_stop(global_timer);
603 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
606 xbt_os_timer_free(global_timer);
609 print_comparison_times();
613 if (errors || hash_result)
614 XBT_VERB("(%d - %d) Difference found", num1, num2);
616 XBT_VERB("(%d - %d) No difference found", num1, num2);
619 #if defined(MC_DEBUG) && defined(MC_VERBOSE)
621 // * false positive SHOULD be avoided.
622 // * There MUST not be any false negative.
624 XBT_VERB("(%d - %d) State equality hash test is %s %s", num1, num2,
625 (hash_result != 0) == (errors != 0) ? "true" : "false",
626 !hash_result ? "positive" : "negative");
630 return errors > 0 || hash_result;
634 /***************************** Statistics *****************************/
635 /*******************************************************************/
637 void print_comparison_times()
639 XBT_DEBUG("*** Comparison times ***");
640 XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
641 XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
642 XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
643 XBT_DEBUG("- Binary global variables : %f",
644 mc_comp_times->binary_global_variables_comparison_time);
645 XBT_DEBUG("- Libsimgrid global variables : %f",
646 mc_comp_times->libsimgrid_global_variables_comparison_time);
647 XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
648 XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
651 /**************************** MC snapshot compare simcall **************************/
652 /***********************************************************************************/
654 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
655 mc_snapshot_t s1, mc_snapshot_t s2)
657 return snapshot_compare(s1, s2);
660 int MC_compare_snapshots(void *s1, void *s2)
663 return simcall_mc_compare_snapshots(s1, s2);