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){
29 xbt_free(s->process_name);
34 static void stack_region_free_voidp(void *s){
35 stack_region_free((stack_region_t) * (void **) s);
38 static void pointers_pair_free(pointers_pair_t p){
42 static void pointers_pair_free_voidp(void *p){
43 pointers_pair_free((pointers_pair_t) * (void **)p);
46 /************************** Snapshot comparison *******************************/
47 /******************************************************************************/
49 /** \brief Try to add a pair a compared pointers to the set of compared pointers
51 * \result !=0 if the pointers were added (they were not in the set),
52 * 0 otherwise (they were already in the set)
54 static int add_compared_pointers(void *p1, void *p2){
56 pointers_pair_t new_pair = xbt_new0(s_pointers_pair_t, 1);
60 if(xbt_dynar_is_empty(compared_pointers)){
61 xbt_dynar_push(compared_pointers, &new_pair);
65 unsigned int cursor = 0;
67 int end = xbt_dynar_length(compared_pointers) - 1;
68 pointers_pair_t pair = NULL;
70 pointers_pair_t* p = (pointers_pair_t*) xbt_dynar_get_ptr(compared_pointers, 0);
73 cursor = (start + end) / 2;
77 } else if(pair->p1 > p1) {
79 } else if(pair->p2 < p2){
81 } else if(pair->p2 > p2) {
84 pointers_pair_free(new_pair);
90 xbt_dynar_insert_at(compared_pointers, cursor + 1, &new_pair);
91 else if(pair->p1 > p1)
92 xbt_dynar_insert_at(compared_pointers, cursor, &new_pair);
93 else if(pair->p2 < p2)
94 xbt_dynar_insert_at(compared_pointers, cursor + 1, &new_pair);
95 else if(pair->p2 > p2)
96 xbt_dynar_insert_at(compared_pointers, cursor, &new_pair);
98 xbt_die("Unrecheable");
103 static int compare_areas_with_type(void *area1, void *area2, mc_snapshot_t snapshot1, mc_snapshot_t snapshot2, dw_type_t type, int region_size, int region_type, void *start_data, int pointer_level){
105 unsigned int cursor = 0;
106 dw_type_t member, subtype, subsubtype;
107 int elm_size, i, res;
108 void *addr_pointed1, *addr_pointed2;
111 case DW_TAG_unspecified_type:
114 case DW_TAG_base_type:
115 case DW_TAG_enumeration_type:
116 case DW_TAG_union_type:
117 return (memcmp(area1, area2, type->byte_size) != 0);
120 case DW_TAG_volatile_type:
121 case DW_TAG_const_type:
122 return compare_areas_with_type(area1, area2, snapshot1, snapshot2, type->subtype, region_size, region_type, start_data, pointer_level);
124 case DW_TAG_array_type:
125 subtype = type->subtype;
126 switch(subtype->type){
127 case DW_TAG_unspecified_type:
130 case DW_TAG_base_type:
131 case DW_TAG_enumeration_type:
132 case DW_TAG_pointer_type:
133 case DW_TAG_reference_type:
134 case DW_TAG_rvalue_reference_type:
135 case DW_TAG_structure_type:
136 case DW_TAG_class_type:
137 case DW_TAG_union_type:
138 if(subtype->full_type)
139 subtype = subtype->full_type;
140 elm_size = subtype->byte_size;
142 case DW_TAG_const_type:
144 case DW_TAG_volatile_type:
145 subsubtype = subtype->subtype;
146 if(subsubtype->full_type)
147 subsubtype = subsubtype->full_type;
148 elm_size = subsubtype->byte_size;
154 for(i=0; i<type->element_count; i++){
155 res = compare_areas_with_type((char *)area1 + (i*elm_size), (char *)area2 + (i*elm_size), snapshot1, snapshot2, type->subtype, region_size, region_type, start_data, pointer_level);
160 case DW_TAG_pointer_type:
161 case DW_TAG_reference_type:
162 case DW_TAG_rvalue_reference_type:
164 addr_pointed1 = *((void **)(area1));
165 addr_pointed2 = *((void **)(area2));
167 if(type->subtype && type->subtype->type == DW_TAG_subroutine_type){
168 return (addr_pointed1 != addr_pointed2);
171 if(addr_pointed1 == NULL && addr_pointed2 == NULL)
173 if(!add_compared_pointers(addr_pointed1, addr_pointed2))
178 // Some cases are not handled here:
179 // * the pointers lead to different areas (one to the heap, the other to the RW segment ...);
180 // * a pointer leads to the read-only segment of the current object;
181 // * a pointer lead to a different ELF object.
183 if(addr_pointed1 > std_heap && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)){
184 if(!(addr_pointed2 > std_heap && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
186 // The pointers are both in the heap:
187 return compare_heap_area(addr_pointed1, addr_pointed2, snapshot1, snapshot2, NULL, type->subtype, pointer_level);
190 // The pointers are both in the current object R/W segment:
191 else if(addr_pointed1 > start_data && (char*)addr_pointed1 <= (char *)start_data + region_size){
192 if(!(addr_pointed2 > start_data && (char*)addr_pointed2 <= (char *)start_data + region_size))
194 if(type->dw_type_id == NULL)
195 return (addr_pointed1 != addr_pointed2);
197 void* translated_addr_pointer1 = mc_translate_address((uintptr_t)addr_pointed1, snapshot1);
198 void* translated_addr_pointer2 = mc_translate_address((uintptr_t)addr_pointed2, snapshot2);
199 return compare_areas_with_type(
200 translated_addr_pointer1, translated_addr_pointer2, snapshot1, snapshot2, type->subtype, region_size, region_type, start_data, pointer_level);
205 return (addr_pointed1 != addr_pointed2);
209 case DW_TAG_structure_type:
210 case DW_TAG_class_type:
211 xbt_dynar_foreach(type->members, cursor, member){
212 XBT_DEBUG("Compare member %s", member->name);
213 void* member1 = mc_member_snapshot_resolve(area1, type, member, snapshot1);
214 void* member2 = mc_member_snapshot_resolve(area2, type, member, snapshot2);
215 res = compare_areas_with_type(member1, member2, snapshot1, snapshot2, member->subtype, region_size, region_type, start_data, pointer_level);
220 case DW_TAG_subroutine_type:
224 XBT_VERB("Unknown case : %d", type->type);
231 static int compare_global_variables(int region_type, mc_mem_region_t r1, mc_mem_region_t r2, mc_snapshot_t snapshot1, mc_snapshot_t snapshot2){
233 if(!compared_pointers){
234 compared_pointers = xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
236 xbt_dynar_reset(compared_pointers);
239 xbt_dynar_t variables;
241 unsigned int cursor = 0;
242 dw_variable_t current_var;
245 void* start_data_binary = mc_binary_info->start_rw;
246 void* start_data_libsimgrid = mc_libsimgrid_info->start_rw;
248 mc_object_info_t object_info = NULL;
249 if(region_type == 2){
250 object_info = mc_binary_info;
251 start_data = start_data_binary;
253 object_info = mc_libsimgrid_info;
254 start_data = start_data_libsimgrid;
256 variables = object_info->global_variables;
258 xbt_dynar_foreach(variables, cursor, current_var){
260 // If the variable is not in this object, skip it:
261 // We do not expect to find a pointer to something which is not reachable
262 // by the global variables.
263 if((char*) current_var->address < (char*) object_info->start_rw
264 || (char*) current_var->address > (char*) object_info->end_rw)
267 offset = (char *)current_var->address - (char *)object_info->start_rw;
269 dw_type_t bvariable_type = current_var->type;
270 res = compare_areas_with_type((char *)r1->data + offset, (char *)r2->data + offset, snapshot1, snapshot2, bvariable_type, r1->size, region_type, start_data, 0);
272 XBT_VERB("Global variable %s (%p - %p) is different between snapshots", current_var->name, (char *)r1->data + offset, (char *)r2->data + offset);
273 xbt_dynar_free(&compared_pointers);
274 compared_pointers = NULL;
280 xbt_dynar_free(&compared_pointers);
281 compared_pointers = NULL;
287 static int compare_local_variables(mc_snapshot_t snapshot1, mc_snapshot_t snapshot2, mc_snapshot_stack_t stack1, mc_snapshot_stack_t stack2, void *heap1, void *heap2){
288 void* start_data_binary = mc_binary_info->start_rw;
289 void* start_data_libsimgrid = mc_libsimgrid_info->start_rw;
291 if(!compared_pointers){
292 compared_pointers = xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
294 xbt_dynar_reset(compared_pointers);
297 if(xbt_dynar_length(stack1->local_variables) != xbt_dynar_length(stack2->local_variables)){
298 XBT_VERB("Different number of local variables");
299 xbt_dynar_free(&compared_pointers);
300 compared_pointers = NULL;
303 unsigned int cursor = 0;
304 local_variable_t current_var1, current_var2;
305 int offset1, offset2, res;
306 while(cursor < xbt_dynar_length(stack1->local_variables)){
307 current_var1 = (local_variable_t)xbt_dynar_get_as(stack1->local_variables, cursor, local_variable_t);
308 current_var2 = (local_variable_t)xbt_dynar_get_as(stack2->local_variables, cursor, local_variable_t);
309 if(strcmp(current_var1->name, current_var2->name) != 0 || current_var1->subprogram != current_var1->subprogram || current_var1->ip != current_var2->ip){
310 xbt_dynar_free(&compared_pointers);
311 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
312 XBT_VERB("Different name of variable (%s - %s) or frame (%s - %s) or ip (%lu - %lu)", current_var1->name, current_var2->name, current_var1->subprogram->name, current_var2->subprogram->name, current_var1->ip, current_var2->ip);
315 offset1 = (char *)current_var1->address - (char *)std_heap;
316 offset2 = (char *)current_var2->address - (char *)std_heap;
317 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
318 XBT_DEBUG("Compare local variable %s of frame %s", current_var1->subprogram->name, current_var1->subprogram->name);
321 if(current_var1->region == 1) {
322 dw_type_t subtype = current_var1->type;
323 res = compare_areas_with_type( (char *)heap1 + offset1, (char *)heap2 + offset2, snapshot1, snapshot2, subtype, 0, 1, start_data_libsimgrid, 0);
325 dw_type_t subtype = current_var2->type;
326 res = compare_areas_with_type( (char *)heap1 + offset1, (char *)heap2 + offset2, snapshot1, snapshot2, subtype, 0, 2, start_data_binary, 0);
329 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
330 XBT_VERB("Local variable %s (%p - %p) in frame %s is different between snapshots", current_var1->name,(char *)heap1 + offset1, (char *)heap2 + offset2, current_var1->subprogram->name);
331 xbt_dynar_free(&compared_pointers);
332 compared_pointers = NULL;
337 xbt_dynar_free(&compared_pointers);
338 compared_pointers = NULL;
343 int snapshot_compare(void *state1, void *state2){
345 mc_snapshot_t s1, s2;
348 if(_sg_mc_property_file && _sg_mc_property_file[0] != '\0'){ /* Liveness MC */
349 s1 = ((mc_visited_pair_t)state1)->graph_state->system_state;
350 s2 = ((mc_visited_pair_t)state2)->graph_state->system_state;
351 num1 = ((mc_visited_pair_t)state1)->num;
352 num2 = ((mc_visited_pair_t)state2)->num;
353 /* Firstly compare automaton state */
354 /*if(xbt_automaton_state_compare(((mc_pair_t)state1)->automaton_state, ((mc_pair_t)state2)->automaton_state) != 0)
356 if(xbt_automaton_propositional_symbols_compare_value(((mc_pair_t)state1)->atomic_propositions, ((mc_pair_t)state2)->atomic_propositions) != 0)
358 }else{ /* Safety MC */
359 s1 = ((mc_visited_state_t)state1)->system_state;
360 s2 = ((mc_visited_state_t)state2)->system_state;
361 num1 = ((mc_visited_state_t)state1)->num;
362 num2 = ((mc_visited_state_t)state2)->num;
368 xbt_os_timer_t global_timer = xbt_os_timer_new();
369 xbt_os_timer_t timer = xbt_os_timer_new();
371 xbt_os_walltimer_start(global_timer);
374 xbt_os_walltimer_start(timer);
379 hash_result = (s1->hash != s2->hash);
381 XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1, num2, s1->hash, s2->hash);
386 XBT_VERB("(%d - %d) Same hash : 0x%" PRIx64, num1, num2, s1->hash);
391 size_t size_used1, size_used2;
395 /* Compare size of stacks */
396 while(i < xbt_dynar_length(s1->stacks)){
397 size_used1 = s1->stack_sizes[i];
398 size_used2 = s2->stack_sizes[i];
399 if(size_used1 != size_used2){
402 xbt_os_walltimer_stop(timer);
403 mc_comp_times->stacks_sizes_comparison_time = xbt_os_timer_elapsed(timer);
405 XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1, num2, size_used1, size_used2);
410 XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1, num2, size_used1, size_used2);
413 xbt_os_walltimer_stop(timer);
414 xbt_os_timer_free(timer);
415 xbt_os_walltimer_stop(global_timer);
416 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
417 xbt_os_timer_free(global_timer);
427 xbt_os_walltimer_stop(timer);
428 xbt_os_walltimer_start(timer);
431 /* Init heap information used in heap comparison algorithm */
432 res_init = init_heap_information((xbt_mheap_t)s1->regions[0]->data, (xbt_mheap_t)s2->regions[0]->data, s1->to_ignore, s2->to_ignore);
435 XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
439 XBT_VERB("(%d - %d) Different heap information", num1, num2);
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);
451 xbt_os_walltimer_start(timer);
454 /* Stacks comparison */
455 unsigned int cursor = 0;
458 mc_snapshot_stack_t stack1, stack2;
460 while(cursor < xbt_dynar_length(s1->stacks)){
461 stack1 = (mc_snapshot_stack_t)xbt_dynar_get_as(s1->stacks, cursor, mc_snapshot_stack_t);
462 stack2 = (mc_snapshot_stack_t)xbt_dynar_get_as(s2->stacks, cursor, mc_snapshot_stack_t);
463 diff_local = compare_local_variables(s1, s2, stack1, stack2, s1->regions[0]->data, s2->regions[0]->data);
467 xbt_os_walltimer_stop(timer);
468 mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
470 XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1, num2, cursor + 1);
476 XBT_VERB("(%d - %d) Different local variables between stacks %d", num1, num2, cursor + 1);
479 reset_heap_information();
480 xbt_os_walltimer_stop(timer);
481 xbt_os_timer_free(timer);
482 xbt_os_walltimer_stop(global_timer);
483 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
484 xbt_os_timer_free(global_timer);
494 const char* names[3] = { "?", "libsimgrid", "binary" };
498 &mc_comp_times->libsimgrid_global_variables_comparison_time,
499 &mc_comp_times->binary_global_variables_comparison_time
504 for(k=2; k!=0; --k) {
507 xbt_os_walltimer_stop(timer);
508 xbt_os_walltimer_start(timer);
511 /* Compare global variables */
512 is_diff = compare_global_variables(k, s1->regions[k], s2->regions[k], s1, s2);
515 xbt_os_walltimer_stop(timer);
516 *times[k] = xbt_os_timer_elapsed(timer);
517 XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2, names[k]);
521 XBT_VERB("(%d - %d) Different global variables in %s", num1, num2, names[k]);
524 reset_heap_information();
525 xbt_os_walltimer_stop(timer);
526 xbt_os_timer_free(timer);
527 xbt_os_walltimer_stop(global_timer);
528 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
529 xbt_os_timer_free(global_timer);
537 xbt_os_walltimer_start(timer);
541 if(mmalloc_compare_heap(s1, s2, (xbt_mheap_t)s1->regions[0]->data,
542 (xbt_mheap_t)s2->regions[0]->data) > 0){
545 xbt_os_walltimer_stop(timer);
546 mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
547 XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
552 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
555 reset_heap_information();
556 xbt_os_walltimer_stop(timer);
557 xbt_os_timer_free(timer);
558 xbt_os_walltimer_stop(global_timer);
559 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
560 xbt_os_timer_free(global_timer);
566 xbt_os_walltimer_stop(timer);
570 reset_heap_information();
572 xbt_os_walltimer_stop(timer);
573 xbt_os_timer_free(timer);
576 xbt_os_walltimer_stop(global_timer);
577 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
580 xbt_os_timer_free(global_timer);
583 print_comparison_times();
587 if(errors || hash_result)
588 XBT_VERB("(%d - %d) Difference found", num1, num2);
590 XBT_VERB("(%d - %d) No difference found", num1, num2);
593 #if defined(MC_DEBUG) && defined(MC_VERBOSE)
595 // * false positive SHOULD be avoided.
596 // * There MUST not be any false negative.
598 XBT_VERB("(%d - %d) State equality hash test is %s %s", num1, num2,
599 (hash_result!=0) == (errors!=0) ? "true" : "false",
600 !hash_result ? "positive" : "negative");
604 return errors > 0 || hash_result;
608 /***************************** Statistics *****************************/
609 /*******************************************************************/
611 void print_comparison_times(){
612 XBT_DEBUG("*** Comparison times ***");
613 XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
614 XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
615 XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
616 XBT_DEBUG("- Binary global variables : %f", mc_comp_times->binary_global_variables_comparison_time);
617 XBT_DEBUG("- Libsimgrid global variables : %f", mc_comp_times->libsimgrid_global_variables_comparison_time);
618 XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
619 XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
622 /**************************** MC snapshot compare simcall **************************/
623 /***********************************************************************************/
625 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
626 mc_snapshot_t s1, mc_snapshot_t s2){
627 return snapshot_compare(s1, s2);
630 int MC_compare_snapshots(void *s1, void *s2){
632 return simcall_mc_compare_snapshots(s1, s2);