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"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, mc,
14 "Logging specific to mc_compare");
16 typedef struct s_pointers_pair{
19 }s_pointers_pair_t, *pointers_pair_t;
21 __thread xbt_dynar_t compared_pointers;
23 /************************** Free functions ****************************/
24 /********************************************************************/
26 static void stack_region_free(stack_region_t s){
28 xbt_free(s->process_name);
33 static void stack_region_free_voidp(void *s){
34 stack_region_free((stack_region_t) * (void **) s);
37 static void pointers_pair_free(pointers_pair_t p){
41 static void pointers_pair_free_voidp(void *p){
42 pointers_pair_free((pointers_pair_t) * (void **)p);
45 /************************** Snapshot comparison *******************************/
46 /******************************************************************************/
48 /** \brief Try to add a pair a compared pointers to the set of compared pointers
50 * \result !=0 if the pointers were added (they were not in the set),
51 * 0 otherwise (they were already in the set)
53 static int add_compared_pointers(void *p1, void *p2){
55 pointers_pair_t new_pair = xbt_new0(s_pointers_pair_t, 1);
59 if(xbt_dynar_is_empty(compared_pointers)){
60 xbt_dynar_push(compared_pointers, &new_pair);
64 unsigned int cursor = 0;
66 int end = xbt_dynar_length(compared_pointers) - 1;
67 pointers_pair_t pair = NULL;
69 pointers_pair_t* p = (pointers_pair_t*) xbt_dynar_get_ptr(compared_pointers, 0);
72 cursor = (start + end) / 2;
76 } else if(pair->p1 > p1) {
78 } else if(pair->p2 < p2){
80 } else if(pair->p2 > p2) {
83 pointers_pair_free(new_pair);
89 xbt_dynar_insert_at(compared_pointers, cursor + 1, &new_pair);
90 else if(pair->p1 > p1)
91 xbt_dynar_insert_at(compared_pointers, cursor, &new_pair);
92 else if(pair->p2 < p2)
93 xbt_dynar_insert_at(compared_pointers, cursor + 1, &new_pair);
94 else if(pair->p2 > p2)
95 xbt_dynar_insert_at(compared_pointers, cursor, &new_pair);
97 xbt_die("Unrecheable");
102 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){
104 unsigned int cursor = 0;
105 dw_type_t member, subtype, subsubtype;
106 int elm_size, i, res;
107 void *addr_pointed1, *addr_pointed2;
110 case DW_TAG_unspecified_type:
113 case DW_TAG_base_type:
114 case DW_TAG_enumeration_type:
115 case DW_TAG_union_type:
116 return (memcmp(area1, area2, type->byte_size) != 0);
119 case DW_TAG_volatile_type:
120 case DW_TAG_const_type:
121 return compare_areas_with_type(area1, area2, snapshot1, snapshot2, type->subtype, region_size, region_type, start_data, pointer_level);
123 case DW_TAG_array_type:
124 subtype = type->subtype;
125 switch(subtype->type){
126 case DW_TAG_unspecified_type:
129 case DW_TAG_base_type:
130 case DW_TAG_enumeration_type:
131 case DW_TAG_pointer_type:
132 case DW_TAG_reference_type:
133 case DW_TAG_rvalue_reference_type:
134 case DW_TAG_structure_type:
135 case DW_TAG_class_type:
136 case DW_TAG_union_type:
137 if(subtype->full_type)
138 subtype = subtype->full_type;
139 elm_size = subtype->byte_size;
141 case DW_TAG_const_type:
143 case DW_TAG_volatile_type:
144 subsubtype = subtype->subtype;
145 if(subsubtype->full_type)
146 subsubtype = subsubtype->full_type;
147 elm_size = subsubtype->byte_size;
153 for(i=0; i<type->element_count; i++){
154 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);
159 case DW_TAG_pointer_type:
160 case DW_TAG_reference_type:
161 case DW_TAG_rvalue_reference_type:
163 addr_pointed1 = *((void **)(area1));
164 addr_pointed2 = *((void **)(area2));
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(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 // The pointers are both in the heap:
183 if(addr_pointed1 > std_heap && (char *)addr_pointed1 < (char*) std_heap + STD_HEAP_SIZE){
184 if(!(addr_pointed2 > std_heap && (char *)addr_pointed2 < (char*) std_heap + STD_HEAP_SIZE))
186 return compare_heap_area(addr_pointed1, addr_pointed2, snapshot1, snapshot2, NULL, type->subtype, pointer_level);
189 // The pointers are both in the current object R/W segment:
190 else if(addr_pointed1 > start_data && (char*)addr_pointed1 <= (char *)start_data + region_size){
191 if(!(addr_pointed2 > start_data && (char*)addr_pointed2 <= (char *)start_data + region_size))
193 if(type->dw_type_id == NULL)
194 return (addr_pointed1 != addr_pointed2);
196 void* translated_addr_pointer1 = mc_translate_address((uintptr_t)addr_pointed1, snapshot1);
197 void* translated_addr_pointer2 = mc_translate_address((uintptr_t)addr_pointed2, snapshot2);
198 return compare_areas_with_type(
199 translated_addr_pointer1, translated_addr_pointer2, snapshot1, snapshot2, type->subtype, region_size, region_type, start_data, pointer_level);
204 return (addr_pointed1 != addr_pointed2);
208 case DW_TAG_structure_type:
209 case DW_TAG_class_type:
210 xbt_dynar_foreach(type->members, cursor, member){
211 XBT_DEBUG("Compare member %s", member->name);
212 void* member1 = mc_member_snapshot_resolve(area1, type, member, snapshot1);
213 void* member2 = mc_member_snapshot_resolve(area2, type, member, snapshot2);
214 res = compare_areas_with_type(member1, member2, snapshot1, snapshot2, member->subtype, region_size, region_type, start_data, pointer_level);
219 case DW_TAG_subroutine_type:
223 XBT_VERB("Unknown case : %d", type->type);
230 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){
232 if(!compared_pointers){
233 compared_pointers = xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
235 xbt_dynar_reset(compared_pointers);
238 xbt_dynar_t variables;
240 unsigned int cursor = 0;
241 dw_variable_t current_var;
244 void* start_data_binary = mc_binary_info->start_rw;
245 void* start_data_libsimgrid = mc_libsimgrid_info->start_rw;
247 mc_object_info_t object_info = NULL;
248 if(region_type == 2){
249 object_info = mc_binary_info;
250 start_data = start_data_binary;
252 object_info = mc_libsimgrid_info;
253 start_data = start_data_libsimgrid;
255 variables = object_info->global_variables;
257 xbt_dynar_foreach(variables, cursor, current_var){
259 // If the variable is not in this object, skip it:
260 // We do not expect to find a pointer to something which is not reachable
261 // by the global variables.
262 if((char*) current_var->address < (char*) object_info->start_rw
263 || (char*) current_var->address > (char*) object_info->end_rw)
266 offset = (char *)current_var->address - (char *)object_info->start_rw;
268 dw_type_t bvariable_type = current_var->type;
269 res = compare_areas_with_type((char *)r1->data + offset, (char *)r2->data + offset, snapshot1, snapshot2, bvariable_type, r1->size, region_type, start_data, 0);
271 XBT_VERB("Global variable %s (%p - %p) is different between snapshots", current_var->name, (char *)r1->data + offset, (char *)r2->data + offset);
272 xbt_dynar_free(&compared_pointers);
273 compared_pointers = NULL;
279 xbt_dynar_free(&compared_pointers);
280 compared_pointers = NULL;
286 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){
287 void* start_data_binary = mc_binary_info->start_rw;
288 void* start_data_libsimgrid = mc_libsimgrid_info->start_rw;
290 if(!compared_pointers){
291 compared_pointers = xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
293 xbt_dynar_reset(compared_pointers);
296 if(xbt_dynar_length(stack1->local_variables) != xbt_dynar_length(stack2->local_variables)){
297 XBT_VERB("Different number of local variables");
298 xbt_dynar_free(&compared_pointers);
299 compared_pointers = NULL;
302 unsigned int cursor = 0;
303 local_variable_t current_var1, current_var2;
304 int offset1, offset2, res;
305 while(cursor < xbt_dynar_length(stack1->local_variables)){
306 current_var1 = (local_variable_t)xbt_dynar_get_as(stack1->local_variables, cursor, local_variable_t);
307 current_var2 = (local_variable_t)xbt_dynar_get_as(stack2->local_variables, cursor, local_variable_t);
308 if(strcmp(current_var1->name, current_var2->name) != 0 || current_var1->subprogram != current_var1->subprogram || current_var1->ip != current_var2->ip){
309 xbt_dynar_free(&compared_pointers);
310 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
311 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);
314 offset1 = (char *)current_var1->address - (char *)std_heap;
315 offset2 = (char *)current_var2->address - (char *)std_heap;
316 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
317 XBT_DEBUG("Compare local variable %s of frame %s", current_var1->subprogram->name, current_var1->subprogram->name);
320 if(current_var1->region == 1) {
321 dw_type_t subtype = current_var1->type;
322 res = compare_areas_with_type( (char *)heap1 + offset1, (char *)heap2 + offset2, snapshot1, snapshot2, subtype, 0, 1, start_data_libsimgrid, 0);
324 dw_type_t subtype = current_var2->type;
325 res = compare_areas_with_type( (char *)heap1 + offset1, (char *)heap2 + offset2, snapshot1, snapshot2, subtype, 0, 2, start_data_binary, 0);
328 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
329 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);
330 xbt_dynar_free(&compared_pointers);
331 compared_pointers = NULL;
336 xbt_dynar_free(&compared_pointers);
337 compared_pointers = NULL;
342 int snapshot_compare(void *state1, void *state2){
344 mc_snapshot_t s1, s2;
347 if(_sg_mc_property_file && _sg_mc_property_file[0] != '\0'){ /* Liveness MC */
348 s1 = ((mc_visited_pair_t)state1)->graph_state->system_state;
349 s2 = ((mc_visited_pair_t)state2)->graph_state->system_state;
350 num1 = ((mc_visited_pair_t)state1)->num;
351 num2 = ((mc_visited_pair_t)state2)->num;
352 /* Firstly compare automaton state */
353 /*if(xbt_automaton_state_compare(((mc_pair_t)state1)->automaton_state, ((mc_pair_t)state2)->automaton_state) != 0)
355 if(xbt_automaton_propositional_symbols_compare_value(((mc_pair_t)state1)->atomic_propositions, ((mc_pair_t)state2)->atomic_propositions) != 0)
357 }else{ /* Safety MC */
358 s1 = ((mc_visited_state_t)state1)->system_state;
359 s2 = ((mc_visited_state_t)state2)->system_state;
360 num1 = ((mc_visited_state_t)state1)->num;
361 num2 = ((mc_visited_state_t)state2)->num;
367 xbt_os_timer_t global_timer = xbt_os_timer_new();
368 xbt_os_timer_t timer = xbt_os_timer_new();
370 xbt_os_walltimer_start(global_timer);
373 xbt_os_walltimer_start(timer);
378 hash_result = (s1->hash != s2->hash);
380 XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1, num2, s1->hash, s2->hash);
385 XBT_VERB("(%d - %d) Same hash : 0x%" PRIx64, num1, num2, s1->hash);
390 size_t size_used1, size_used2;
394 /* Compare size of stacks */
395 while(i < xbt_dynar_length(s1->stacks)){
396 size_used1 = s1->stack_sizes[i];
397 size_used2 = s2->stack_sizes[i];
398 if(size_used1 != size_used2){
401 xbt_os_walltimer_stop(timer);
402 mc_comp_times->stacks_sizes_comparison_time = xbt_os_timer_elapsed(timer);
404 XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1, num2, size_used1, size_used2);
409 XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1, num2, size_used1, size_used2);
412 xbt_os_walltimer_stop(timer);
413 xbt_os_timer_free(timer);
414 xbt_os_walltimer_stop(global_timer);
415 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
416 xbt_os_timer_free(global_timer);
426 xbt_os_walltimer_stop(timer);
427 xbt_os_walltimer_start(timer);
430 /* Init heap information used in heap comparison algorithm */
431 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);
434 XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
438 XBT_VERB("(%d - %d) Different heap information", num1, num2);
441 xbt_os_walltimer_stop(global_timer);
442 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
443 xbt_os_timer_free(global_timer);
450 xbt_os_walltimer_start(timer);
453 /* Stacks comparison */
454 unsigned int cursor = 0;
459 mc_snapshot_stack_t stack1, stack2;
461 while(cursor < xbt_dynar_length(s1->stacks)){
462 stack1 = (mc_snapshot_stack_t)xbt_dynar_get_as(s1->stacks, cursor, mc_snapshot_stack_t);
463 stack2 = (mc_snapshot_stack_t)xbt_dynar_get_as(s2->stacks, cursor, mc_snapshot_stack_t);
464 diff_local = compare_local_variables(s1, s2, stack1, stack2, s1->regions[0]->data, s2->regions[0]->data);
468 xbt_os_walltimer_stop(timer);
469 mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
471 XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1, num2, cursor + 1);
477 XBT_VERB("(%d - %d) Different local variables between stacks %d", num1, num2, cursor + 1);
480 reset_heap_information();
481 xbt_os_walltimer_stop(timer);
482 xbt_os_timer_free(timer);
483 xbt_os_walltimer_stop(global_timer);
484 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
485 xbt_os_timer_free(global_timer);
495 const char* names[3] = { "?", "libsimgrid", "binary" };
499 &mc_comp_times->libsimgrid_global_variables_comparison_time,
500 &mc_comp_times->binary_global_variables_comparison_time
505 for(k=2; k!=0; --k) {
508 xbt_os_walltimer_stop(timer);
509 xbt_os_walltimer_start(timer);
512 /* Compare global variables */
513 is_diff = compare_global_variables(k, s1->regions[k], s2->regions[k], s1, s2);
516 xbt_os_walltimer_stop(timer);
517 *times[k] = xbt_os_timer_elapsed(timer);
518 XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2, names[k]);
522 XBT_VERB("(%d - %d) Different global variables in %s", num1, num2, names[k]);
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);
538 xbt_os_walltimer_start(timer);
542 if(mmalloc_compare_heap(s1, s2, (xbt_mheap_t)s1->regions[0]->data,
543 (xbt_mheap_t)s2->regions[0]->data) > 0){
546 xbt_os_walltimer_stop(timer);
547 mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
548 XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
553 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
556 reset_heap_information();
557 xbt_os_walltimer_stop(timer);
558 xbt_os_timer_free(timer);
559 xbt_os_walltimer_stop(global_timer);
560 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
561 xbt_os_timer_free(global_timer);
567 xbt_os_walltimer_stop(timer);
571 reset_heap_information();
573 xbt_os_walltimer_stop(timer);
574 xbt_os_timer_free(timer);
577 xbt_os_walltimer_stop(global_timer);
578 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
581 xbt_os_timer_free(global_timer);
584 print_comparison_times();
588 if(errors || hash_result)
589 XBT_VERB("(%d - %d) Difference found", num1, num2);
591 XBT_VERB("(%d - %d) No difference found", num1, num2);
594 #if defined(MC_DEBUG) && defined(MC_VERBOSE)
596 // * false positive SHOULD be avoided.
597 // * There MUST not be any false negative.
599 XBT_VERB("(%d - %d) State equality hash test is %s %s", num1, num2,
600 (hash_result!=0) == (errors!=0) ? "true" : "false",
601 !hash_result ? "positive" : "negative");
605 return errors > 0 || hash_result;
609 /***************************** Statistics *****************************/
610 /*******************************************************************/
612 void print_comparison_times(){
613 XBT_DEBUG("*** Comparison times ***");
614 XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
615 XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
616 XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
617 XBT_DEBUG("- Binary global variables : %f", mc_comp_times->binary_global_variables_comparison_time);
618 XBT_DEBUG("- Libsimgrid global variables : %f", mc_comp_times->libsimgrid_global_variables_comparison_time);
619 XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
620 XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
623 /**************************** MC snapshot compare simcall **************************/
624 /***********************************************************************************/
626 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
627 mc_snapshot_t s1, mc_snapshot_t s2){
628 return snapshot_compare(s1, s2);
631 int MC_compare_snapshots(void *s1, void *s2){
633 return simcall_mc_compare_snapshots(s1, s2);