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. */
7 #include "mc_private.h"
9 #include "xbt/mmalloc.h"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, mc,
12 "Logging specific to mc_compare");
14 typedef struct s_pointers_pair{
17 }s_pointers_pair_t, *pointers_pair_t;
19 __thread xbt_dynar_t compared_pointers;
21 /************************** Free functions ****************************/
22 /********************************************************************/
24 static void stack_region_free(stack_region_t s){
26 xbt_free(s->process_name);
31 static void stack_region_free_voidp(void *s){
32 stack_region_free((stack_region_t) * (void **) s);
35 static void pointers_pair_free(pointers_pair_t p){
39 static void pointers_pair_free_voidp(void *p){
40 pointers_pair_free((pointers_pair_t) * (void **)p);
43 /************************** Snapshot comparison *******************************/
44 /******************************************************************************/
46 static int already_compared_pointers(void *p1, void *p2){
48 if(xbt_dynar_is_empty(compared_pointers))
51 unsigned int cursor = 0;
53 int end = xbt_dynar_length(compared_pointers) - 1;
57 cursor = (start + end) / 2;
58 pair = (pointers_pair_t)xbt_dynar_get_as(compared_pointers, cursor, pointers_pair_t);
62 else if(pair->p2 < p2)
66 }else if(pair->p1 < p1){
77 static void add_compared_pointers(void *p1, void *p2){
79 pointers_pair_t new_pair = xbt_new0(s_pointers_pair_t, 1);
83 if(xbt_dynar_is_empty(compared_pointers)){
84 xbt_dynar_push(compared_pointers, &new_pair);
88 unsigned int cursor = 0;
90 int end = xbt_dynar_length(compared_pointers) - 1;
91 pointers_pair_t pair = NULL;
94 cursor = (start + end) / 2;
95 pair = (pointers_pair_t)xbt_dynar_get_as(compared_pointers, cursor, pointers_pair_t);
98 pointers_pair_free(new_pair);
100 }else if(pair->p2 < p2)
104 }else if(pair->p1 < p1){
113 xbt_dynar_insert_at(compared_pointers, cursor + 1, &new_pair);
115 xbt_dynar_insert_at(compared_pointers, cursor, &new_pair);
118 xbt_dynar_insert_at(compared_pointers, cursor + 1, &new_pair);
120 xbt_dynar_insert_at(compared_pointers, cursor, &new_pair);
125 static int compare_areas_with_type(void *area1, void *area2, xbt_dict_t types, xbt_dict_t other_types, char *type_id, int region_size, int region_type, void *start_data, int pointer_level){
127 dw_type_t type = xbt_dict_get_or_null(types, type_id);;
128 unsigned int cursor = 0;
129 dw_type_t member, subtype, subsubtype;
130 int elm_size, i, res, switch_types = 0;
131 void *addr_pointed1, *addr_pointed2;
134 case DW_TAG_base_type:
135 case DW_TAG_enumeration_type:
136 case DW_TAG_union_type:
137 return (memcmp(area1, area2, type->byte_size) != 0);
140 case DW_TAG_volatile_type:
141 case DW_TAG_const_type:
142 return compare_areas_with_type(area1, area2, types, other_types, type->dw_type_id, region_size, region_type, start_data, pointer_level);
144 case DW_TAG_array_type:
145 subtype = xbt_dict_get_or_null(types, type->dw_type_id);
146 switch(subtype->type){
147 case DW_TAG_base_type:
148 case DW_TAG_enumeration_type:
149 case DW_TAG_pointer_type:
150 case DW_TAG_structure_type:
151 case DW_TAG_union_type:
152 if(subtype->byte_size == 0){ /*declaration of the type, need the complete description */
153 subtype = xbt_dict_get_or_null(types, get_type_description(types, subtype->name));
155 subtype = xbt_dict_get_or_null(other_types, get_type_description(other_types, subtype->name));
159 elm_size = subtype->byte_size;
161 case DW_TAG_const_type:
163 case DW_TAG_volatile_type:
164 subsubtype = xbt_dict_get_or_null(types, subtype->dw_type_id);
165 if(subsubtype->byte_size == 0){ /*declaration of the type, need the complete description */
166 subsubtype = xbt_dict_get_or_null(types, get_type_description(types, subsubtype->name));
167 if(subsubtype == NULL){
168 subsubtype = xbt_dict_get_or_null(other_types, get_type_description(other_types, 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_types, types, type->dw_type_id, region_size, region_type, start_data, pointer_level);
182 res = compare_areas_with_type((char *)area1 + (i*elm_size), (char *)area2 + (i*elm_size), types, other_types, type->dw_type_id, 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(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 if(addr_pointed1 > std_heap && (char *)addr_pointed1 < (char*) std_heap + STD_HEAP_SIZE && addr_pointed2 > std_heap && (char *)addr_pointed2 < (char*) std_heap + STD_HEAP_SIZE){
205 return compare_heap_area(addr_pointed1, addr_pointed2, NULL, types, other_types, type->dw_type_id, pointer_level);
206 }else if(addr_pointed1 > start_data && (char*)addr_pointed1 <= (char *)start_data + region_size && addr_pointed2 > start_data && (char*)addr_pointed2 <= (char *)start_data + region_size){
207 if(type->dw_type_id == NULL)
208 return (addr_pointed1 != addr_pointed2);
210 return compare_areas_with_type(addr_pointed1, addr_pointed2, types, other_types, type->dw_type_id, region_size, region_type, start_data, pointer_level);
212 return (addr_pointed1 != addr_pointed2);
216 case DW_TAG_structure_type:
217 xbt_dynar_foreach(type->members, cursor, member){
218 res = compare_areas_with_type((char *)area1 + member->offset, (char *)area2 + member->offset, types, other_types, member->dw_type_id, region_size, region_type, start_data, pointer_level);
223 case DW_TAG_subroutine_type:
227 XBT_VERB("Unknown case : %d", type->type);
234 static int compare_global_variables(int region_type, mc_mem_region_t r1, mc_mem_region_t r2){
236 if(!compared_pointers){
237 compared_pointers = xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
238 MC_ignore_global_variable("compared_pointers");
240 xbt_dynar_reset(compared_pointers);
243 xbt_dynar_t variables;
244 xbt_dict_t types, other_types;
246 unsigned int cursor = 0;
247 dw_variable_t current_var;
250 void* start_data_binary = mc_binary_info->start_rw;
251 void* start_data_libsimgrid = mc_libsimgrid_info->start_rw;
253 mc_object_info_t object_info = NULL;
254 mc_object_info_t other_object_info = NULL;
255 if(region_type == 2){
256 object_info = mc_binary_info;
257 other_object_info = mc_libsimgrid_info;
258 start_data = start_data_binary;
260 object_info = mc_libsimgrid_info;
261 other_object_info = mc_binary_info;
262 start_data = start_data_libsimgrid;
264 variables = object_info->global_variables;
265 types = object_info->types;
266 other_types = other_object_info->types;
268 xbt_dynar_foreach(variables, cursor, current_var){
270 // If the variable is not in this object, skip it:
271 // We do not expect to find a pointer to something which is not reachable
272 // by the global variables.
273 if((char*) current_var->address.address < (char*) object_info->start_rw
274 || (char*) current_var->address.address > (char*) object_info->end_rw)
277 offset = (char *)current_var->address.address - (char *)object_info->start_rw;
279 res = compare_areas_with_type((char *)r1->data + offset, (char *)r2->data + offset, types, other_types, current_var->type_origin, r1->size, region_type, start_data, 0);
281 XBT_VERB("Global variable %s (%p - %p) is different between snapshots", current_var->name, (char *)r1->data + offset, (char *)r2->data + offset);
282 xbt_dynar_free(&compared_pointers);
283 compared_pointers = NULL;
289 xbt_dynar_free(&compared_pointers);
290 compared_pointers = NULL;
296 static int compare_local_variables(mc_snapshot_stack_t stack1, mc_snapshot_stack_t stack2, void *heap1, void *heap2){
297 void* start_data_binary = mc_binary_info->start_rw;
298 void* start_data_libsimgrid = mc_libsimgrid_info->start_rw;
300 if(!compared_pointers){
301 compared_pointers = xbt_dynar_new(sizeof(pointers_pair_t), pointers_pair_free_voidp);
302 MC_ignore_global_variable("compared_pointers");
304 xbt_dynar_reset(compared_pointers);
307 if(xbt_dynar_length(stack1->local_variables) != xbt_dynar_length(stack2->local_variables)){
308 XBT_VERB("Different number of local variables");
309 xbt_dynar_free(&compared_pointers);
310 compared_pointers = NULL;
313 unsigned int cursor = 0;
314 local_variable_t current_var1, current_var2;
315 int offset1, offset2, res;
316 while(cursor < xbt_dynar_length(stack1->local_variables)){
317 current_var1 = (local_variable_t)xbt_dynar_get_as(stack1->local_variables, cursor, local_variable_t);
318 current_var2 = (local_variable_t)xbt_dynar_get_as(stack2->local_variables, cursor, local_variable_t);
319 if(strcmp(current_var1->name, current_var2->name) != 0 || strcmp(current_var1->frame, current_var2->frame) != 0 || current_var1->ip != current_var2->ip){
320 xbt_dynar_free(&compared_pointers);
321 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);
324 offset1 = (char *)current_var1->address - (char *)std_heap;
325 offset2 = (char *)current_var2->address - (char *)std_heap;
326 if(current_var1->region == 1)
327 res = compare_areas_with_type( (char *)heap1 + offset1, (char *)heap2 + offset2, mc_libsimgrid_info->types, mc_binary_info->types, current_var1->type, 0, 1, start_data_libsimgrid, 0);
329 res = compare_areas_with_type( (char *)heap1 + offset1, (char *)heap2 + offset2, mc_binary_info->types, mc_libsimgrid_info->types, current_var1->type, 0, 2, start_data_binary, 0);
331 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);
332 xbt_dynar_free(&compared_pointers);
333 compared_pointers = NULL;
338 xbt_dynar_free(&compared_pointers);
339 compared_pointers = NULL;
344 int snapshot_compare(void *state1, void *state2){
346 mc_snapshot_t s1, s2;
349 if(_sg_mc_property_file && _sg_mc_property_file[0] != '\0'){ /* Liveness MC */
350 s1 = ((mc_visited_pair_t)state1)->graph_state->system_state;
351 s2 = ((mc_visited_pair_t)state2)->graph_state->system_state;
352 num1 = ((mc_visited_pair_t)state1)->num;
353 num2 = ((mc_visited_pair_t)state2)->num;
354 /* Firstly compare automaton state */
355 /*if(xbt_automaton_state_compare(((mc_pair_t)state1)->automaton_state, ((mc_pair_t)state2)->automaton_state) != 0)
357 if(xbt_automaton_propositional_symbols_compare_value(((mc_pair_t)state1)->atomic_propositions, ((mc_pair_t)state2)->atomic_propositions) != 0)
359 }else{ /* Safety 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);
378 /* Compare size of stacks */
380 size_t size_used1, size_used2;
382 while(i < xbt_dynar_length(s1->stacks)){
383 size_used1 = s1->stack_sizes[i];
384 size_used2 = s2->stack_sizes[i];
385 if(size_used1 != size_used2){
388 xbt_os_walltimer_stop(timer);
389 mc_comp_times->stacks_sizes_comparison_time = xbt_os_timer_elapsed(timer);
391 XBT_DEBUG("(%d - %d) Different size used in stacks : %zu - %zu", num1, num2, size_used1, size_used2);
396 XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1, num2, size_used1, size_used2);
399 xbt_os_walltimer_stop(timer);
400 xbt_os_timer_free(timer);
401 xbt_os_walltimer_stop(global_timer);
402 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
403 xbt_os_timer_free(global_timer);
413 xbt_os_walltimer_stop(timer);
414 xbt_os_walltimer_start(timer);
417 /* Compare hash of global variables */
418 if(s1->hash_global != NULL && s2->hash_global != NULL){
419 if(strcmp(s1->hash_global, s2->hash_global) != 0){
421 xbt_os_walltimer_stop(timer);
422 mc_comp_times->hash_global_variables_comparison_time = xbt_os_timer_elapsed(timer);
423 XBT_DEBUG("Different hash of global variables : %s - %s", s1->hash_global, s2->hash_global);
427 XBT_VERB("Different hash of global variables : %s - %s", s1->hash_global, s2->hash_global);
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);
442 xbt_os_walltimer_start(timer);
445 /* Compare hash of local variables */
446 if(s1->hash_local != NULL && s2->hash_local != NULL){
447 if(strcmp(s1->hash_local, s2->hash_local) != 0){
449 xbt_os_walltimer_stop(timer);
450 mc_comp_times->hash_local_variables_comparison_time = xbt_os_timer_elapsed(timer);
451 XBT_DEBUG("Different hash of local variables : %s - %s", s1->hash_local, s2->hash_local);
455 XBT_VERB("Different hash of local variables : %s - %s", s1->hash_local, s2->hash_local);
458 xbt_os_walltimer_stop(timer);
459 xbt_os_timer_free(timer);
460 xbt_os_walltimer_stop(global_timer);
461 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
462 xbt_os_timer_free(global_timer);
470 xbt_os_walltimer_start(timer);
473 /* Init heap information used in heap comparison algorithm */
474 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);
477 XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
481 XBT_VERB("(%d - %d) Different heap information", num1, num2);
484 xbt_os_walltimer_stop(global_timer);
485 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
486 xbt_os_timer_free(global_timer);
493 xbt_os_walltimer_start(timer);
496 /* Stacks comparison */
497 unsigned int cursor = 0;
500 mc_snapshot_stack_t stack1, stack2;
502 while(cursor < xbt_dynar_length(s1->stacks)){
503 stack1 = (mc_snapshot_stack_t)xbt_dynar_get_as(s1->stacks, cursor, mc_snapshot_stack_t);
504 stack2 = (mc_snapshot_stack_t)xbt_dynar_get_as(s2->stacks, cursor, mc_snapshot_stack_t);
505 diff_local = compare_local_variables(stack1, stack2, s1->regions[0]->data, s2->regions[0]->data);
509 xbt_os_walltimer_stop(timer);
510 mc_comp_times->stacks_comparison_time = xbt_os_timer_elapsed(timer);
512 XBT_DEBUG("(%d - %d) Different local variables between stacks %d", num1, num2, cursor + 1);
518 XBT_VERB("(%d - %d) Different local variables between stacks %d", num1, num2, cursor + 1);
521 reset_heap_information();
522 xbt_os_walltimer_stop(timer);
523 xbt_os_timer_free(timer);
524 xbt_os_walltimer_stop(global_timer);
525 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
526 xbt_os_timer_free(global_timer);
536 const char* names[3] = { "?", "libsimgrid", "binary" };
540 &mc_comp_times->libsimgrid_global_variables_comparison_time,
541 &mc_comp_times->binary_global_variables_comparison_time
546 for(k=2; k!=0; --k) {
549 xbt_os_walltimer_stop(timer);
550 xbt_os_walltimer_start(timer);
553 /* Compare global variables */
554 is_diff = compare_global_variables(k, s1->regions[k], s2->regions[k]);
557 xbt_os_walltimer_stop(timer);
558 *times[k] = xbt_os_timer_elapsed(timer);
559 XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2, names[k]);
563 XBT_VERB("(%d - %d) Different global variables in %s", num1, num2, names[k]);
566 reset_heap_information();
567 xbt_os_walltimer_stop(timer);
568 xbt_os_timer_free(timer);
569 xbt_os_walltimer_stop(global_timer);
570 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
571 xbt_os_timer_free(global_timer);
579 xbt_os_walltimer_start(timer);
583 if(mmalloc_compare_heap((xbt_mheap_t)s1->regions[0]->data,
584 (xbt_mheap_t)s2->regions[0]->data,
585 mc_libsimgrid_info->types,
586 mc_binary_info->types) > 0){
589 xbt_os_walltimer_stop(timer);
590 mc_comp_times->heap_comparison_time = xbt_os_timer_elapsed(timer);
591 XBT_DEBUG("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
596 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", num1, num2);
599 reset_heap_information();
600 xbt_os_walltimer_stop(timer);
601 xbt_os_timer_free(timer);
602 xbt_os_walltimer_stop(global_timer);
603 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
604 xbt_os_timer_free(global_timer);
610 xbt_os_walltimer_stop(timer);
614 reset_heap_information();
616 xbt_os_walltimer_stop(timer);
617 xbt_os_timer_free(timer);
620 xbt_os_walltimer_stop(global_timer);
621 mc_snapshot_comparison_time = xbt_os_timer_elapsed(global_timer);
624 xbt_os_timer_free(global_timer);
627 print_comparison_times();
634 /***************************** Statistics *****************************/
635 /*******************************************************************/
637 void print_comparison_times(){
638 XBT_DEBUG("*** Comparison times ***");
639 XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
640 XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
641 XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
642 XBT_DEBUG("- Binary global variables : %f", mc_comp_times->binary_global_variables_comparison_time);
643 XBT_DEBUG("- Libsimgrid global variables : %f", mc_comp_times->libsimgrid_global_variables_comparison_time);
644 XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
645 XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
648 /**************************** MC snapshot compare simcall **************************/
649 /***********************************************************************************/
651 int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
652 mc_snapshot_t s1, mc_snapshot_t s2){
653 return snapshot_compare(s1, s2);
656 int MC_compare_snapshots(void *s1, void *s2){
658 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
659 return simcall_mc_compare_snapshots(s1, s2);