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* real_area1, mc_snapshot_t snapshot1, mc_mem_region_t region1,
110 void* real_area2, mc_snapshot_t snapshot2, mc_mem_region_t region2,
111 dw_type_t type, int pointer_level)
113 unsigned int cursor = 0;
114 dw_type_t member, subtype, subsubtype;
115 int elm_size, i, res;
118 switch (type->type) {
119 case DW_TAG_unspecified_type:
122 case DW_TAG_base_type:
123 case DW_TAG_enumeration_type:
124 case DW_TAG_union_type:
127 mc_snapshot_read_region(real_area1, region1, alloca(type->byte_size), type->byte_size);
129 mc_snapshot_read_region(real_area2, region1, alloca(type->byte_size), type->byte_size);
130 return (memcmp(data1, data2, type->byte_size) != 0);
134 case DW_TAG_volatile_type:
135 case DW_TAG_const_type:
137 type = type->subtype;
139 case DW_TAG_array_type:
140 subtype = type->subtype;
141 switch (subtype->type) {
142 case DW_TAG_unspecified_type:
145 case DW_TAG_base_type:
146 case DW_TAG_enumeration_type:
147 case DW_TAG_pointer_type:
148 case DW_TAG_reference_type:
149 case DW_TAG_rvalue_reference_type:
150 case DW_TAG_structure_type:
151 case DW_TAG_class_type:
152 case DW_TAG_union_type:
153 if (subtype->full_type)
154 subtype = subtype->full_type;
155 elm_size = subtype->byte_size;
157 case DW_TAG_const_type:
159 case DW_TAG_volatile_type:
160 subsubtype = subtype->subtype;
161 if (subsubtype->full_type)
162 subsubtype = subsubtype->full_type;
163 elm_size = subsubtype->byte_size;
169 for (i = 0; i < type->element_count; i++) {
170 size_t off = i * elm_size;
171 res = compare_areas_with_type(
172 (char*) real_area1 + off, snapshot1, region1,
173 (char*) real_area2 + off, snapshot2, region2,
174 type->subtype, pointer_level);
179 case DW_TAG_pointer_type:
180 case DW_TAG_reference_type:
181 case DW_TAG_rvalue_reference_type:
184 void* addr_pointed1 = *(void**) mc_snapshot_read_region(real_area1, region1, &temp, sizeof(void**));
185 void* addr_pointed2 = *(void**) mc_snapshot_read_region(real_area2, region2, &temp, sizeof(void**));
187 if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
188 return (addr_pointed1 != addr_pointed2);
191 if (addr_pointed1 == NULL && addr_pointed2 == NULL)
193 if (!add_compared_pointers(addr_pointed1, addr_pointed2))
198 // Some cases are not handled here:
199 // * the pointers lead to different areas (one to the heap, the other to the RW segment ...);
200 // * a pointer leads to the read-only segment of the current object;
201 // * a pointer lead to a different ELF object.
203 if (addr_pointed1 > std_heap
204 && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)) {
206 (addr_pointed2 > std_heap
207 && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
209 // The pointers are both in the heap:
210 return compare_heap_area(addr_pointed1, addr_pointed2, snapshot1,
211 snapshot2, NULL, type->subtype, pointer_level);
213 // The pointers are both in the current object R/W segment:
214 else if (addr_pointed1 > region1->start_addr
215 && (char *) addr_pointed1 <= (char *) region1->start_addr + region1->size) {
217 (addr_pointed2 > region2->start_addr
218 && (char *) addr_pointed2 <= (char *) region2->start_addr + region2->size))
220 if (type->dw_type_id == NULL)
221 return (addr_pointed1 != addr_pointed2);
223 return compare_areas_with_type(addr_pointed1, snapshot1, region1,
224 addr_pointed2, snapshot2, region2,
225 type->subtype, pointer_level);
230 return (addr_pointed1 != addr_pointed2);
235 case DW_TAG_structure_type:
236 case DW_TAG_class_type:
237 xbt_dynar_foreach(type->members, cursor, member) {
239 mc_member_resolve(real_area1, type, member, snapshot1);
241 mc_member_resolve(real_area2, type, member, snapshot2);
242 mc_mem_region_t subregion1 = mc_get_region_hinted(member1, snapshot1, region1);
243 mc_mem_region_t subregion2 = mc_get_region_hinted(member2, snapshot2, region2);
245 compare_areas_with_type(member1, snapshot1, subregion1,
246 member2, snapshot2, subregion2,
247 member->subtype, pointer_level);
252 case DW_TAG_subroutine_type:
256 XBT_VERB("Unknown case : %d", type->type);
263 static int compare_global_variables(int region_type, mc_mem_region_t r1,
264 mc_mem_region_t r2, mc_snapshot_t snapshot1,
265 mc_snapshot_t snapshot2)
268 if (!compared_pointers) {
270 xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
272 xbt_dynar_reset(compared_pointers);
275 xbt_dynar_t variables;
277 unsigned int cursor = 0;
278 dw_variable_t current_var;
280 mc_object_info_t object_info = NULL;
281 if (region_type == 2) {
282 object_info = mc_binary_info;
284 object_info = mc_libsimgrid_info;
286 variables = object_info->global_variables;
288 xbt_dynar_foreach(variables, cursor, current_var) {
290 // If the variable is not in this object, skip it:
291 // We do not expect to find a pointer to something which is not reachable
292 // by the global variables.
293 if ((char *) current_var->address < (char *) object_info->start_rw
294 || (char *) current_var->address > (char *) object_info->end_rw)
297 dw_type_t bvariable_type = current_var->type;
299 compare_areas_with_type((char *) current_var->address, snapshot1, r1,
300 (char *) current_var->address, snapshot2, r2,
303 XBT_VERB("Global variable %s (%p) is different between snapshots",
304 current_var->name, (char *) current_var->address);
305 xbt_dynar_free(&compared_pointers);
306 compared_pointers = NULL;
312 xbt_dynar_free(&compared_pointers);
313 compared_pointers = NULL;
319 static int compare_local_variables(mc_snapshot_t snapshot1,
320 mc_snapshot_t snapshot2,
321 mc_snapshot_stack_t stack1,
322 mc_snapshot_stack_t stack2)
324 if (!compared_pointers) {
326 xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
328 xbt_dynar_reset(compared_pointers);
331 if (xbt_dynar_length(stack1->local_variables) !=
332 xbt_dynar_length(stack2->local_variables)) {
333 XBT_VERB("Different number of local variables");
334 xbt_dynar_free(&compared_pointers);
335 compared_pointers = NULL;
338 unsigned int cursor = 0;
339 local_variable_t current_var1, current_var2;
340 int offset1, offset2, res;
341 while (cursor < xbt_dynar_length(stack1->local_variables)) {
343 (local_variable_t) xbt_dynar_get_as(stack1->local_variables, cursor,
346 (local_variable_t) xbt_dynar_get_as(stack2->local_variables, cursor,
348 if (strcmp(current_var1->name, current_var2->name) != 0
349 || current_var1->subprogram != current_var1->subprogram
350 || current_var1->ip != current_var2->ip) {
351 xbt_dynar_free(&compared_pointers);
352 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
354 ("Different name of variable (%s - %s) or frame (%s - %s) or ip (%lu - %lu)",
355 current_var1->name, current_var2->name,
356 current_var1->subprogram->name, current_var2->subprogram->name,
357 current_var1->ip, current_var2->ip);
360 offset1 = (char *) current_var1->address - (char *) std_heap;
361 offset2 = (char *) current_var2->address - (char *) std_heap;
362 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
365 dw_type_t subtype = current_var1->type;
367 compare_areas_with_type(current_var1->address, snapshot1, mc_get_snapshot_region(current_var1->address, snapshot1),
368 current_var2->address, snapshot2, mc_get_snapshot_region(current_var2->address, snapshot2),
372 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
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);
377 xbt_dynar_free(&compared_pointers);
378 compared_pointers = NULL;
383 xbt_dynar_free(&compared_pointers);
384 compared_pointers = NULL;
389 int snapshot_compare(void *state1, void *state2)
392 mc_snapshot_t s1, s2;
395 if (_sg_mc_liveness) { /* Liveness MC */
396 s1 = ((mc_visited_pair_t) state1)->graph_state->system_state;
397 s2 = ((mc_visited_pair_t) state2)->graph_state->system_state;
398 num1 = ((mc_visited_pair_t) state1)->num;
399 num2 = ((mc_visited_pair_t) state2)->num;
400 } else { /* Safety or comm determinism MC */
401 s1 = ((mc_visited_state_t) state1)->system_state;
402 s2 = ((mc_visited_state_t) state2)->system_state;
403 num1 = ((mc_visited_state_t) state1)->num;
404 num2 = ((mc_visited_state_t) state2)->num;
410 xbt_os_timer_t global_timer = xbt_os_timer_new();
411 xbt_os_timer_t timer = xbt_os_timer_new();
413 xbt_os_walltimer_start(global_timer);
416 xbt_os_walltimer_start(timer);
421 hash_result = (s1->hash != s2->hash);
423 XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1,
424 num2, s1->hash, s2->hash);
429 XBT_VERB("(%d - %d) Same hash : 0x%" PRIx64, num1, num2, s1->hash);
433 /* Compare enabled processes */
436 xbt_dynar_foreach(s1->enabled_processes, cursor, pid){
437 if(!xbt_dynar_member(s2->enabled_processes, &pid))
438 XBT_VERB("(%d - %d) Different enabled processes", num1, num2);
442 size_t size_used1, size_used2;
445 /* Compare size of stacks */
446 while (i < xbt_dynar_length(s1->stacks)) {
447 size_used1 = s1->stack_sizes[i];
448 size_used2 = s2->stack_sizes[i];
449 if (size_used1 != size_used2) {
452 xbt_os_walltimer_stop(timer);
453 mc_comp_times->stacks_sizes_comparison_time =
454 xbt_os_timer_elapsed(timer);
456 XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1,
457 num2, size_used1, size_used2);
462 XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1,
463 num2, size_used1, size_used2);
466 xbt_os_walltimer_stop(timer);
467 xbt_os_timer_free(timer);
468 xbt_os_walltimer_stop(global_timer);
469 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
470 xbt_os_timer_free(global_timer);
480 xbt_os_walltimer_stop(timer);
481 xbt_os_walltimer_start(timer);
484 /* Init heap information used in heap comparison algorithm */
486 init_heap_information((xbt_mheap_t) s1->regions[0]->data,
487 (xbt_mheap_t) s2->regions[0]->data, s1->to_ignore,
489 if (res_init == -1) {
491 XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
495 XBT_VERB("(%d - %d) Different heap information", num1, num2);
498 xbt_os_walltimer_stop(global_timer);
499 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
500 xbt_os_timer_free(global_timer);
506 xbt_os_walltimer_start(timer);
509 /* Stacks comparison */
515 mc_snapshot_stack_t stack1, stack2;
517 while (cursor < xbt_dynar_length(s1->stacks)) {
519 (mc_snapshot_stack_t) xbt_dynar_get_as(s1->stacks, cursor,
520 mc_snapshot_stack_t);
522 (mc_snapshot_stack_t) xbt_dynar_get_as(s2->stacks, cursor,
523 mc_snapshot_stack_t);
525 compare_local_variables(s1, s2, stack1, stack2);
526 if (diff_local > 0) {
529 xbt_os_walltimer_stop(timer);
530 mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
532 XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1,
539 XBT_VERB("(%d - %d) Different local variables between stacks %d", num1,
543 reset_heap_information();
544 xbt_os_walltimer_stop(timer);
545 xbt_os_timer_free(timer);
546 xbt_os_walltimer_stop(global_timer);
547 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
548 xbt_os_timer_free(global_timer);
558 const char *names[3] = { "?", "libsimgrid", "binary" };
562 &mc_comp_times->libsimgrid_global_variables_comparison_time,
563 &mc_comp_times->binary_global_variables_comparison_time
568 for (k = 2; k != 0; --k) {
571 xbt_os_walltimer_stop(timer);
572 xbt_os_walltimer_start(timer);
575 /* Compare global variables */
577 compare_global_variables(k, s1->regions[k], s2->regions[k], s1, s2);
580 xbt_os_walltimer_stop(timer);
581 *times[k] = xbt_os_timer_elapsed(timer);
582 XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2,
587 XBT_VERB("(%d - %d) Different global variables in %s", num1, num2,
591 reset_heap_information();
592 xbt_os_walltimer_stop(timer);
593 xbt_os_timer_free(timer);
594 xbt_os_walltimer_stop(global_timer);
595 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
596 xbt_os_timer_free(global_timer);
604 xbt_os_walltimer_start(timer);
608 if (mmalloc_compare_heap(s1, s2) > 0) {
611 xbt_os_walltimer_stop(timer);
612 mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
613 XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
618 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
621 reset_heap_information();
622 xbt_os_walltimer_stop(timer);
623 xbt_os_timer_free(timer);
624 xbt_os_walltimer_stop(global_timer);
625 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
626 xbt_os_timer_free(global_timer);
632 xbt_os_walltimer_stop(timer);
636 reset_heap_information();
638 xbt_os_walltimer_stop(timer);
639 xbt_os_timer_free(timer);
642 xbt_os_walltimer_stop(global_timer);
643 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
646 xbt_os_timer_free(global_timer);
649 print_comparison_times();
653 if (errors || hash_result)
654 XBT_VERB("(%d - %d) Difference found", num1, num2);
656 XBT_VERB("(%d - %d) No difference found", num1, num2);
659 #if defined(MC_DEBUG) && defined(MC_VERBOSE)
661 // * false positive SHOULD be avoided.
662 // * There MUST not be any false negative.
664 XBT_VERB("(%d - %d) State equality hash test is %s %s", num1, num2,
665 (hash_result != 0) == (errors != 0) ? "true" : "false",
666 !hash_result ? "positive" : "negative");
670 return errors > 0 || hash_result;
674 /***************************** Statistics *****************************/
675 /*******************************************************************/
677 void print_comparison_times()
679 XBT_DEBUG("*** Comparison times ***");
680 XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
681 XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
682 XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
683 XBT_DEBUG("- Binary global variables : %f",
684 mc_comp_times->binary_global_variables_comparison_time);
685 XBT_DEBUG("- Libsimgrid global variables : %f",
686 mc_comp_times->libsimgrid_global_variables_comparison_time);
687 XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
688 XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
691 /**************************** MC snapshot compare simcall **************************/
692 /***********************************************************************************/
694 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
695 mc_snapshot_t s1, mc_snapshot_t s2)
697 return snapshot_compare(s1, s2);
700 int MC_compare_snapshots(void *s1, void *s2)
703 return simcall_mc_compare_snapshots(s1, s2);