1 /* Copyright (c) 2012-2013. 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 static int already_compared_pointers(void *p1, void *p2){
50 if(xbt_dynar_is_empty(compared_pointers))
53 unsigned int cursor = 0;
55 int end = xbt_dynar_length(compared_pointers) - 1;
59 cursor = (start + end) / 2;
60 pair = (pointers_pair_t)xbt_dynar_get_as(compared_pointers, cursor, pointers_pair_t);
64 else if(pair->p2 < p2)
68 }else if(pair->p1 < p1){
79 static void add_compared_pointers(void *p1, void *p2){
81 pointers_pair_t new_pair = xbt_new0(s_pointers_pair_t, 1);
85 if(xbt_dynar_is_empty(compared_pointers)){
86 xbt_dynar_push(compared_pointers, &new_pair);
90 unsigned int cursor = 0;
92 int end = xbt_dynar_length(compared_pointers) - 1;
93 pointers_pair_t pair = NULL;
96 cursor = (start + end) / 2;
97 pair = (pointers_pair_t)xbt_dynar_get_as(compared_pointers, cursor, pointers_pair_t);
100 pointers_pair_free(new_pair);
102 }else if(pair->p2 < p2)
106 }else if(pair->p1 < p1){
115 xbt_dynar_insert_at(compared_pointers, cursor + 1, &new_pair);
117 xbt_dynar_insert_at(compared_pointers, cursor, &new_pair);
120 xbt_dynar_insert_at(compared_pointers, cursor + 1, &new_pair);
122 xbt_dynar_insert_at(compared_pointers, cursor, &new_pair);
127 static int compare_areas_with_type(void *area1, void *area2, mc_object_info_t info, mc_object_info_t other_info, dw_type_t type, int region_size, int region_type, void *start_data, int pointer_level){
129 unsigned int cursor = 0;
130 dw_type_t member, subtype, subsubtype;
131 int elm_size, i, res, switch_types = 0;
132 void *addr_pointed1, *addr_pointed2;
135 case DW_TAG_base_type:
136 case DW_TAG_enumeration_type:
137 case DW_TAG_union_type:
138 return (memcmp(area1, area2, type->byte_size) != 0);
141 case DW_TAG_volatile_type:
142 case DW_TAG_const_type:
143 return compare_areas_with_type(area1, area2, info, other_info, type->subtype, region_size, region_type, start_data, pointer_level);
145 case DW_TAG_array_type:
146 subtype = type->subtype;
147 switch(subtype->type){
148 case DW_TAG_base_type:
149 case DW_TAG_enumeration_type:
150 case DW_TAG_pointer_type:
151 case DW_TAG_structure_type:
152 case DW_TAG_union_type:
153 if(subtype->byte_size == 0){ /*declaration of the type, need the complete description */
154 dw_type_t full_type = xbt_dict_get_or_null(other_info->types_by_name, subtype->name);
158 subtype = xbt_dict_get_or_null(other_info->types_by_name, subtype->name);
162 elm_size = subtype->byte_size;
164 case DW_TAG_const_type:
166 case DW_TAG_volatile_type:
167 subsubtype = subtype->subtype;
168 if(subsubtype->byte_size == 0){ /*declaration of the type, need the complete description */
169 subsubtype = xbt_dict_get_or_null(other_info->types_by_name, subsubtype->name);
172 elm_size = subsubtype->byte_size;
178 for(i=0; i<type->element_count; i++){
180 res = compare_areas_with_type((char *)area1 + (i*elm_size), (char *)area2 + (i*elm_size), other_info, info, type->subtype, region_size, region_type, start_data, pointer_level);
182 res = compare_areas_with_type((char *)area1 + (i*elm_size), (char *)area2 + (i*elm_size), info, other_info, type->subtype, region_size, region_type, start_data, pointer_level);
187 case DW_TAG_pointer_type:
188 if(type->dw_type_id && ((dw_type_t)xbt_dict_get_or_null(info->types, type->dw_type_id))->type == DW_TAG_subroutine_type){
189 addr_pointed1 = *((void **)(area1));
190 addr_pointed2 = *((void **)(area2));
191 return (addr_pointed1 != addr_pointed2);
193 addr_pointed1 = *((void **)(area1));
194 addr_pointed2 = *((void **)(area2));
196 if(addr_pointed1 == NULL && addr_pointed2 == NULL)
198 if(already_compared_pointers(addr_pointed1, addr_pointed2) != -1)
200 add_compared_pointers(addr_pointed1, addr_pointed2);
204 // Some cases are not handled here:
205 // * the pointers lead to different areas (one to the heap, the other to the RW segment ...);
206 // * a pointer leads to the read-only segment of the current object;
207 // * a pointer lead to a different ELF object.
209 // The pointers are both in the heap:
210 if(addr_pointed1 > std_heap && (char *)addr_pointed1 < (char*) std_heap + STD_HEAP_SIZE){
211 if(!(addr_pointed2 > std_heap && (char *)addr_pointed2 < (char*) std_heap + STD_HEAP_SIZE))
213 return compare_heap_area(addr_pointed1, addr_pointed2, NULL, info, other_info, type->dw_type_id, pointer_level);
216 // The pointers are both in the current object R/W segment:
217 else if(addr_pointed1 > start_data && (char*)addr_pointed1 <= (char *)start_data + region_size){
218 if(!(addr_pointed2 > start_data && (char*)addr_pointed2 <= (char *)start_data + region_size))
220 if(type->dw_type_id == NULL)
221 return (addr_pointed1 != addr_pointed2);
223 return compare_areas_with_type(addr_pointed1, addr_pointed2, info, other_info, type->subtype, region_size, region_type, start_data, pointer_level);
227 return (addr_pointed1 != addr_pointed2);
231 case DW_TAG_structure_type:
232 xbt_dynar_foreach(type->members, cursor, member){
233 XBT_DEBUG("Compare member %s", member->name);
234 res = compare_areas_with_type((char *)area1 + member->offset, (char *)area2 + member->offset, info, other_info, member->subtype, region_size, region_type, start_data, pointer_level);
239 case DW_TAG_subroutine_type:
243 XBT_VERB("Unknown case : %d", type->type);
250 static int compare_global_variables(int region_type, mc_mem_region_t r1, mc_mem_region_t r2){
252 if(!compared_pointers){
253 compared_pointers = xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
254 MC_ignore_global_variable("compared_pointers");
256 xbt_dynar_reset(compared_pointers);
259 xbt_dynar_t variables;
261 unsigned int cursor = 0;
262 dw_variable_t current_var;
265 void* start_data_binary = mc_binary_info->start_rw;
266 void* start_data_libsimgrid = mc_libsimgrid_info->start_rw;
268 mc_object_info_t object_info = NULL;
269 mc_object_info_t other_object_info = NULL;
270 if(region_type == 2){
271 object_info = mc_binary_info;
272 other_object_info = mc_libsimgrid_info;
273 start_data = start_data_binary;
275 object_info = mc_libsimgrid_info;
276 other_object_info = mc_binary_info;
277 start_data = start_data_libsimgrid;
279 variables = object_info->global_variables;
281 xbt_dynar_foreach(variables, cursor, current_var){
283 // If the variable is not in this object, skip it:
284 // We do not expect to find a pointer to something which is not reachable
285 // by the global variables.
286 if((char*) current_var->address < (char*) object_info->start_rw
287 || (char*) current_var->address > (char*) object_info->end_rw)
290 offset = (char *)current_var->address - (char *)object_info->start_rw;
292 dw_type_t bvariable_type = xbt_dict_get_or_null(object_info->types, current_var->type_origin);
293 res = compare_areas_with_type((char *)r1->data + offset, (char *)r2->data + offset, object_info, other_object_info, bvariable_type, r1->size, region_type, start_data, 0);
295 XBT_VERB("Global variable %s (%p - %p) is different between snapshots", current_var->name, (char *)r1->data + offset, (char *)r2->data + offset);
296 xbt_dynar_free(&compared_pointers);
297 compared_pointers = NULL;
303 xbt_dynar_free(&compared_pointers);
304 compared_pointers = NULL;
310 static int compare_local_variables(mc_snapshot_stack_t stack1, mc_snapshot_stack_t stack2, void *heap1, void *heap2){
311 void* start_data_binary = mc_binary_info->start_rw;
312 void* start_data_libsimgrid = mc_libsimgrid_info->start_rw;
314 if(!compared_pointers){
315 compared_pointers = xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
316 MC_ignore_global_variable("compared_pointers");
318 xbt_dynar_reset(compared_pointers);
321 if(xbt_dynar_length(stack1->local_variables) != xbt_dynar_length(stack2->local_variables)){
322 XBT_VERB("Different number of local variables");
323 xbt_dynar_free(&compared_pointers);
324 compared_pointers = NULL;
327 unsigned int cursor = 0;
328 local_variable_t current_var1, current_var2;
329 int offset1, offset2, res;
330 while(cursor < xbt_dynar_length(stack1->local_variables)){
331 current_var1 = (local_variable_t)xbt_dynar_get_as(stack1->local_variables, cursor, local_variable_t);
332 current_var2 = (local_variable_t)xbt_dynar_get_as(stack2->local_variables, cursor, local_variable_t);
333 if(strcmp(current_var1->name, current_var2->name) != 0 || strcmp(current_var1->frame, current_var2->frame) != 0 || current_var1->ip != current_var2->ip){
334 xbt_dynar_free(&compared_pointers);
335 XBT_VERB("Different name of variable (%s - %s) or frame (%s - %s) or ip (%lu - %lu)", current_var1->name, current_var2->name, current_var1->frame, current_var2->frame, current_var1->ip, current_var2->ip);
338 offset1 = (char *)current_var1->address - (char *)std_heap;
339 offset2 = (char *)current_var2->address - (char *)std_heap;
340 XBT_DEBUG("Compare local variable %s of frame %s", current_var1->name, current_var1->frame);
343 if(current_var1->region == 1) {
344 dw_type_t subtype = xbt_dict_get_or_null(mc_libsimgrid_info->types, current_var1->type);
345 res = compare_areas_with_type( (char *)heap1 + offset1, (char *)heap2 + offset2, mc_libsimgrid_info, mc_binary_info, subtype, 0, 1, start_data_libsimgrid, 0);
347 dw_type_t subtype = xbt_dict_get_or_null(mc_binary_info->types, current_var1->type);
348 res = compare_areas_with_type( (char *)heap1 + offset1, (char *)heap2 + offset2, mc_binary_info, mc_libsimgrid_info, subtype, 0, 2, start_data_binary, 0);
351 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->frame);
352 xbt_dynar_free(&compared_pointers);
353 compared_pointers = NULL;
358 xbt_dynar_free(&compared_pointers);
359 compared_pointers = NULL;
364 int snapshot_compare(void *state1, void *state2){
366 mc_snapshot_t s1, s2;
369 if(_sg_mc_property_file && _sg_mc_property_file[0] != '\0'){ /* Liveness MC */
370 s1 = ((mc_visited_pair_t)state1)->graph_state->system_state;
371 s2 = ((mc_visited_pair_t)state2)->graph_state->system_state;
372 num1 = ((mc_visited_pair_t)state1)->num;
373 num2 = ((mc_visited_pair_t)state2)->num;
374 /* Firstly compare automaton state */
375 /*if(xbt_automaton_state_compare(((mc_pair_t)state1)->automaton_state, ((mc_pair_t)state2)->automaton_state) != 0)
377 if(xbt_automaton_propositional_symbols_compare_value(((mc_pair_t)state1)->atomic_propositions, ((mc_pair_t)state2)->atomic_propositions) != 0)
379 }else{ /* Safety MC */
380 s1 = ((mc_visited_state_t)state1)->system_state;
381 s2 = ((mc_visited_state_t)state2)->system_state;
382 num1 = ((mc_visited_state_t)state1)->num;
383 num2 = ((mc_visited_state_t)state2)->num;
389 xbt_os_timer_t global_timer = xbt_os_timer_new();
390 xbt_os_timer_t timer = xbt_os_timer_new();
392 xbt_os_walltimer_start(global_timer);
395 xbt_os_walltimer_start(timer);
398 if(MC_USE_SNAPSHOT_HASH) {
399 if(s1->hash != s2->hash) {
400 XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1, num2, s1->hash, s2->hash);
403 XBT_VERB("(%d - %d) Same hash : 0x%" PRIx64, num1, num2, s1->hash);
408 size_t size_used1, size_used2;
412 /* Compare size of stacks */
413 while(i < xbt_dynar_length(s1->stacks)){
414 size_used1 = s1->stack_sizes[i];
415 size_used2 = s2->stack_sizes[i];
416 if(size_used1 != size_used2){
419 xbt_os_walltimer_stop(timer);
420 mc_comp_times->stacks_sizes_comparison_time = xbt_os_timer_elapsed(timer);
422 XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1, num2, size_used1, size_used2);
427 XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1, num2, size_used1, size_used2);
430 xbt_os_walltimer_stop(timer);
431 xbt_os_timer_free(timer);
432 xbt_os_walltimer_stop(global_timer);
433 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
434 xbt_os_timer_free(global_timer);
444 xbt_os_walltimer_stop(timer);
445 xbt_os_walltimer_start(timer);
448 /* Init heap information used in heap comparison algorithm */
449 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);
452 XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
456 XBT_VERB("(%d - %d) Different heap information", num1, num2);
459 xbt_os_walltimer_stop(global_timer);
460 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
461 xbt_os_timer_free(global_timer);
468 xbt_os_walltimer_start(timer);
471 /* Stacks comparison */
472 unsigned int cursor = 0;
475 mc_snapshot_stack_t stack1, stack2;
477 while(cursor < xbt_dynar_length(s1->stacks)){
478 stack1 = (mc_snapshot_stack_t)xbt_dynar_get_as(s1->stacks, cursor, mc_snapshot_stack_t);
479 stack2 = (mc_snapshot_stack_t)xbt_dynar_get_as(s2->stacks, cursor, mc_snapshot_stack_t);
480 diff_local = compare_local_variables(stack1, stack2, s1->regions[0]->data, s2->regions[0]->data);
484 xbt_os_walltimer_stop(timer);
485 mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
487 XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1, num2, cursor + 1);
493 XBT_VERB("(%d - %d) Different local variables between stacks %d", num1, num2, cursor + 1);
496 reset_heap_information();
497 xbt_os_walltimer_stop(timer);
498 xbt_os_timer_free(timer);
499 xbt_os_walltimer_stop(global_timer);
500 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
501 xbt_os_timer_free(global_timer);
511 const char* names[3] = { "?", "libsimgrid", "binary" };
515 &mc_comp_times->libsimgrid_global_variables_comparison_time,
516 &mc_comp_times->binary_global_variables_comparison_time
521 for(k=2; k!=0; --k) {
524 xbt_os_walltimer_stop(timer);
525 xbt_os_walltimer_start(timer);
528 /* Compare global variables */
529 is_diff = compare_global_variables(k, s1->regions[k], s2->regions[k]);
532 xbt_os_walltimer_stop(timer);
533 *times[k] = xbt_os_timer_elapsed(timer);
534 XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2, names[k]);
538 XBT_VERB("(%d - %d) Different global variables in %s", num1, num2, names[k]);
541 reset_heap_information();
542 xbt_os_walltimer_stop(timer);
543 xbt_os_timer_free(timer);
544 xbt_os_walltimer_stop(global_timer);
545 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
546 xbt_os_timer_free(global_timer);
554 xbt_os_walltimer_start(timer);
558 if(mmalloc_compare_heap((xbt_mheap_t)s1->regions[0]->data,
559 (xbt_mheap_t)s2->regions[0]->data,
561 mc_binary_info) > 0){
564 xbt_os_walltimer_stop(timer);
565 mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
566 XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
571 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
574 reset_heap_information();
575 xbt_os_walltimer_stop(timer);
576 xbt_os_timer_free(timer);
577 xbt_os_walltimer_stop(global_timer);
578 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
579 xbt_os_timer_free(global_timer);
585 xbt_os_walltimer_stop(timer);
589 reset_heap_information();
591 xbt_os_walltimer_stop(timer);
592 xbt_os_timer_free(timer);
595 xbt_os_walltimer_stop(global_timer);
596 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
599 xbt_os_timer_free(global_timer);
602 print_comparison_times();
607 XBT_VERB("(%d - %d) No difference found", num1, num2);
613 /***************************** Statistics *****************************/
614 /*******************************************************************/
616 void print_comparison_times(){
617 XBT_DEBUG("*** Comparison times ***");
618 XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
619 XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
620 XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
621 XBT_DEBUG("- Binary global variables : %f", mc_comp_times->binary_global_variables_comparison_time);
622 XBT_DEBUG("- Libsimgrid global variables : %f", mc_comp_times->libsimgrid_global_variables_comparison_time);
623 XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
624 XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
627 /**************************** MC snapshot compare simcall **************************/
628 /***********************************************************************************/
630 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
631 mc_snapshot_t s1, mc_snapshot_t s2){
632 return snapshot_compare(s1, s2);
635 int MC_compare_snapshots(void *s1, void *s2){
637 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
638 return simcall_mc_compare_snapshots(s1, s2);