src/mc/mc_compare.c

   1 /* Copyright (c) 2008-2012 Da SimGrid Team. All rights reserved.            */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "mc_private.h"
   7
   8 #include "xbt/mmalloc.h"
   9
  10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, mc,
  11                                 "Logging specific to mc_compare");
  12
  13 static int data_bss_program_region_compare(void *d1, void *d2, size_t size);
  14 static int data_bss_libsimgrid_region_compare(void *d1, void *d2, size_t size);
  15 static int heap_region_compare(void *d1, void *d2, size_t size);
  16
  17 static int compare_stack(stack_region_t s1, stack_region_t s2, void *sp1, void *sp2, void *heap1, void *heap2, xbt_dynar_t equals);
  18 static int is_heap_equality(xbt_dynar_t equals, void *a1, void *a2);
  19 static size_t heap_ignore_size(void *address);
  20 static size_t data_bss_ignore_size(void *address);
  21
  22 static void stack_region_free(stack_region_t s);
  23 static void heap_equality_free(heap_equality_t e);
  24
  25 static int is_stack_ignore_variable(char *frame, char *var_name);
  26 static int compare_local_variables(char *s1, char *s2, xbt_dynar_t heap_equals);
  27
  28 static size_t heap_ignore_size(void *address){
  29   unsigned int cursor = 0;
  30   int start = 0;
  31   int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
  32   mc_heap_ignore_region_t region;
  33
  34   while(start <= end){
  35     cursor = (start + end) / 2;
  36     region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
  37     if(region->address == address)
  38       return region->size;
  39     if(region->address < address)
  40       start = cursor + 1;
  41     if(region->address > address)
  42       end = cursor - 1;
  43   }
  44
  45   return 0;
  46 }
  47
  48 static size_t data_bss_ignore_size(void *address){
  49   unsigned int cursor = 0;
  50   int start = 0;
  51   int end = xbt_dynar_length(mc_data_bss_comparison_ignore) - 1;
  52   mc_data_bss_ignore_variable_t var;
  53
  54   while(start <= end){
  55     cursor = (start + end) / 2;
  56     var = (mc_data_bss_ignore_variable_t)xbt_dynar_get_as(mc_data_bss_comparison_ignore, cursor, mc_data_bss_ignore_variable_t);
  57     if(var->address == address)
  58       return var->size;
  59     if(var->address < address)
  60       start = cursor + 1;
  61     if(var->address > address)
  62       end = cursor - 1;
  63   }
  64
  65   return 0;
  66 }
  67
  68 static int data_bss_program_region_compare(void *d1, void *d2, size_t size){
  69
  70   size_t i = 0;
  71   int pointer_align;
  72   void *addr_pointed1 = NULL, *addr_pointed2 = NULL;
  73
  74   for(i=0; i<size; i++){
  75     if(memcmp(((char *)d1) + i, ((char *)d2) + i, 1) != 0){
  76       pointer_align = (i / sizeof(void*)) * sizeof(void*);
  77       addr_pointed1 = *((void **)((char *)d1 + pointer_align));
  78       addr_pointed2 = *((void **)((char *)d2 + pointer_align));
  79       if((addr_pointed1 > start_plt_binary && addr_pointed1 < end_plt_binary) || (addr_pointed2 > start_plt_binary && addr_pointed2 < end_plt_binary)){
  80         continue;
  81       }else{
  82         if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose)){
  83           XBT_VERB("Different byte (offset=%zu) (%p - %p) in data program region", i, (char *)d1 + i, (char *)d2 + i);
  84           XBT_VERB("Addresses pointed : %p - %p\n", addr_pointed1, addr_pointed2);
  85         }
  86         return 1;
  87       }
  88     }
  89   }
  90
  91   return 0;
  92 }
  93
  94 static int data_bss_libsimgrid_region_compare(void *d1, void *d2, size_t size){
  95
  96   size_t i = 0, ignore_size = 0;
  97   int pointer_align;
  98   void *addr_pointed1 = NULL, *addr_pointed2 = NULL;
  99
 100   for(i=0; i<size; i++){
 101     if(memcmp(((char *)d1) + i, ((char *)d2) + i, 1) != 0){
 102       if((ignore_size = data_bss_ignore_size((char *)start_data_libsimgrid+i)) > 0){
 103         i = i + ignore_size;
 104         continue;
 105       }else if((ignore_size = data_bss_ignore_size((char *)start_bss_libsimgrid+i)) > 0){
 106         i = i + ignore_size;
 107         continue;
 108       }
 109       pointer_align = (i / sizeof(void*)) * sizeof(void*);
 110       addr_pointed1 = *((void **)((char *)d1 + pointer_align));
 111       addr_pointed2 = *((void **)((char *)d2 + pointer_align));
 112       if((addr_pointed1 > start_plt_libsimgrid && addr_pointed1 < end_plt_libsimgrid) || (addr_pointed2 > start_plt_libsimgrid && addr_pointed2 < end_plt_libsimgrid)){
 113         continue;
 114       }else if(addr_pointed1 >= raw_heap && addr_pointed1 <= end_raw_heap && addr_pointed2 >= raw_heap && addr_pointed2 <= end_raw_heap){
 115         continue;
 116       }else{
 117         if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose)){
 118           XBT_VERB("Different byte (offset=%zu) (%p - %p) in libsimgrid region", i, (char *)d1 + i, (char *)d2 + i);
 119           XBT_VERB("Addresses pointed : %p - %p\n", addr_pointed1, addr_pointed2);
 120         }
 121         return 1;
 122       }
 123     }
 124   }
 125
 126   return 0;
 127 }
 128
 129 static int heap_region_compare(void *d1, void *d2, size_t size){
 130
 131   size_t i = 0;
 132
 133   for(i=0; i<size; i++){
 134     if(memcmp(((char *)d1) + i, ((char *)d2) + i, 1) != 0){
 135       if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose)){
 136         XBT_VERB("Different byte (offset=%zu) (%p - %p) in heap region", i, (char *)d1 + i, (char *)d2 + i);
 137       }
 138       return 1;
 139     }
 140   }
 141
 142   return 0;
 143 }
 144
 145 static void stack_region_free(stack_region_t s){
 146   if(s){
 147     xbt_free(s->process_name);
 148     xbt_free(s);
 149   }
 150 }
 151
 152 void stack_region_free_voidp(void *s){
 153   stack_region_free((stack_region_t) * (void **) s);
 154 }
 155
 156 static void heap_equality_free(heap_equality_t e){
 157   if(e){
 158     xbt_free(e);
 159   }
 160 }
 161
 162 void heap_equality_free_voidp(void *e){
 163   heap_equality_free((heap_equality_t) * (void **) e);
 164 }
 165
 166 int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2){
 167
 168   raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
 169
 170   MC_SET_RAW_MEM;
 171
 172   int errors = 0, i = 0;
 173
 174   if(s1->num_reg != s2->num_reg){
 175     if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose)){
 176       XBT_VERB("Different num_reg (s1 = %u, s2 = %u)", s1->num_reg, s2->num_reg);
 177     }
 178     return 1;
 179   }
 180
 181   int heap_index = 0, data_libsimgrid_index = 0, data_program_index = 0;
 182
 183   /* Get index of regions */
 184   while(i < s1->num_reg){
 185     switch(s1->regions[i]->type){
 186     case 0:
 187       heap_index = i;
 188       i++;
 189       break;
 190     case 1:
 191       data_libsimgrid_index = i;
 192       i++;
 193       while( i < s1->num_reg && s1->regions[i]->type == 1)
 194         i++;
 195       break;
 196     case 2:
 197       data_program_index = i;
 198       i++;
 199       while( i < s1->num_reg && s1->regions[i]->type == 2)
 200         i++;
 201       break;
 202     }
 203   }
 204
 205   /* Compare number of blocks/fragments used in each heap */
 206   size_t chunks_used1 = mmalloc_get_chunks_used((xbt_mheap_t)s1->regions[heap_index]->data);
 207   size_t chunks_used2 = mmalloc_get_chunks_used((xbt_mheap_t)s2->regions[heap_index]->data);
 208   if(chunks_used1 != chunks_used2){
 209     if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_debug)){
 210       XBT_DEBUG("Different number of chunks used in each heap : %zu - %zu", chunks_used1, chunks_used2);
 211       errors++;
 212     }else{
 213       if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose))
 214         XBT_VERB("Different number of chunks used in each heap : %zu - %zu", chunks_used1, chunks_used2);
 215       if(!raw_mem_set)
 216         MC_UNSET_RAW_MEM;
 217       return 1;
 218     }
 219   }
 220
 221   /* Compare size of stacks */
 222   unsigned int cursor = 0;
 223   void *addr_stack1, *addr_stack2;
 224   void *sp1, *sp2;
 225   size_t size_used1, size_used2;
 226   while(cursor < xbt_dynar_length(stacks_areas)){
 227     addr_stack1 = (char *)s1->regions[heap_index]->data + ((char *)((stack_region_t)xbt_dynar_get_as(stacks_areas, cursor, stack_region_t))->address - (char *)std_heap);
 228     addr_stack2 = (char *)s2->regions[heap_index]->data + ((char *)((stack_region_t)xbt_dynar_get_as(stacks_areas, cursor, stack_region_t))->address - (char *)std_heap);
 229     sp1 = ((mc_snapshot_stack_t)xbt_dynar_get_as(s1->stacks, cursor, mc_snapshot_stack_t))->stack_pointer;
 230     sp2 = ((mc_snapshot_stack_t)xbt_dynar_get_as(s2->stacks, cursor, mc_snapshot_stack_t))->stack_pointer;
 231     size_used1 = ((stack_region_t)xbt_dynar_get_as(stacks_areas, cursor, stack_region_t))->size - ((char*)sp1 - (char*)addr_stack1);
 232     size_used2 = ((stack_region_t)xbt_dynar_get_as(stacks_areas, cursor, stack_region_t))->size - ((char*)sp2 - (char*)addr_stack2);
 233     if(size_used1 != size_used2){
 234       if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_debug)){
 235         XBT_DEBUG("Different size used in stacks : %zu - %zu", size_used1, size_used2);
 236         errors++;
 237       }else{
 238         if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose))
 239           XBT_VERB("Different size used in stacks : %zu - %zu", size_used1, size_used2);
 240         if(!raw_mem_set)
 241           MC_UNSET_RAW_MEM;
 242         return 1;
 243       }
 244     }
 245     cursor++;
 246   }
 247
 248
 249   /* Compare program data segment(s) */
 250   i = data_program_index;
 251   while(i < s1->num_reg && s1->regions[i]->type == 2){
 252     if(data_bss_program_region_compare(s1->regions[i]->data, s2->regions[i]->data, s1->regions[i]->size) != 0){
 253       if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_debug)){
 254         XBT_DEBUG("Different memcmp for data in program");
 255         errors++;
 256       }else{
 257         if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose))
 258           XBT_VERB("Different memcmp for data in program");
 259         if(!raw_mem_set)
 260           MC_UNSET_RAW_MEM;
 261         return 1;
 262       }
 263     }
 264     i++;
 265   }
 266
 267   /* Compare libsimgrid data segment(s) */
 268   i = data_libsimgrid_index;
 269   while(i < s1->num_reg && s1->regions[i]->type == 1){
 270     if(data_bss_libsimgrid_region_compare(s1->regions[i]->data, s2->regions[i]->data, s1->regions[i]->size) != 0){
 271       if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_debug)){
 272         XBT_DEBUG("Different memcmp for data in libsimgrid");
 273         errors++;
 274       }else{
 275         if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose))
 276           XBT_VERB("Different memcmp for data in libsimgrid");
 277         if(!raw_mem_set)
 278           MC_UNSET_RAW_MEM;
 279         return 1;
 280       }
 281     }
 282     i++;
 283   }
 284
 285   /* Compare heap */
 286   xbt_dynar_t stacks1 = xbt_dynar_new(sizeof(stack_region_t), stack_region_free_voidp);
 287   xbt_dynar_t stacks2 = xbt_dynar_new(sizeof(stack_region_t), stack_region_free_voidp);
 288   xbt_dynar_t equals = xbt_dynar_new(sizeof(heap_equality_t), heap_equality_free_voidp);
 289
 290   void *heap1 = s1->regions[heap_index]->data, *heap2 = s2->regions[heap_index]->data;
 291
 292   if(mmalloc_compare_heap((xbt_mheap_t)s1->regions[heap_index]->data, (xbt_mheap_t)s2->regions[heap_index]->data, &stacks1, &stacks2, &equals)){
 293
 294     if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_debug)){
 295       XBT_DEBUG("Different heap (mmalloc_compare)");
 296       errors++;
 297     }else{
 298
 299       xbt_dynar_free(&stacks1);
 300       xbt_dynar_free(&stacks2);
 301       xbt_dynar_free(&equals);
 302
 303       if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose))
 304         XBT_VERB("Different heap (mmalloc_compare)");
 305       if(!raw_mem_set)
 306         MC_UNSET_RAW_MEM;
 307       return 1;
 308     }
 309   }
 310
 311   /* Stacks comparison */
 312   cursor = 0;
 313   stack_region_t stack_region1, stack_region2;
 314   int diff = 0, diff_local = 0;
 315
 316   while(cursor < xbt_dynar_length(stacks1)){
 317     stack_region1 = (stack_region_t)(xbt_dynar_get_as(stacks1, cursor, stack_region_t));
 318     stack_region2 = (stack_region_t)(xbt_dynar_get_as(stacks2, cursor, stack_region_t));
 319     sp1 = ((mc_snapshot_stack_t)xbt_dynar_get_as(s1->stacks, cursor, mc_snapshot_stack_t))->stack_pointer;
 320     sp2 = ((mc_snapshot_stack_t)xbt_dynar_get_as(s2->stacks, cursor, mc_snapshot_stack_t))->stack_pointer;
 321     diff = compare_stack(stack_region1, stack_region2, sp1, sp2, heap1, heap2, equals);
 322
 323     if(diff > 0){ /* Differences may be due to padding */
 324       diff_local = compare_local_variables(((mc_snapshot_stack_t)xbt_dynar_get_as(s1->stacks, cursor, mc_snapshot_stack_t))->local_variables->data, ((mc_snapshot_stack_t)xbt_dynar_get_as(s2->stacks, cursor, mc_snapshot_stack_t))->local_variables->data, equals);
 325       if(diff_local > 0){
 326         if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_debug)){
 327           XBT_DEBUG("Different local variables between stacks %d", cursor + 1);
 328           errors++;
 329         }else{
 330           xbt_dynar_free(&stacks1);
 331           xbt_dynar_free(&stacks2);
 332           xbt_dynar_free(&equals);
 333
 334           if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose))
 335             XBT_VERB("Different local variables between stacks %d", cursor + 1);
 336
 337           if(!raw_mem_set)
 338             MC_UNSET_RAW_MEM;
 339
 340           return 1;
 341         }
 342       }
 343     }
 344     cursor++;
 345   }
 346
 347   xbt_dynar_free(&stacks1);
 348   xbt_dynar_free(&stacks2);
 349   xbt_dynar_free(&equals);
 350   if(!raw_mem_set)
 351     MC_UNSET_RAW_MEM;
 352
 353   return errors > 0;
 354
 355 }
 356
 357 static int is_stack_ignore_variable(char *frame, char *var_name){
 358
 359   unsigned int cursor = 0;
 360   int start = 0;
 361   int end = xbt_dynar_length(mc_stack_comparison_ignore) - 1;
 362   mc_stack_ignore_variable_t current_var;
 363
 364   while(start <= end){
 365     cursor = (start + end) / 2;
 366     current_var = (mc_stack_ignore_variable_t)xbt_dynar_get_as(mc_stack_comparison_ignore, cursor, mc_stack_ignore_variable_t);
 367     if(strcmp(current_var->frame, frame) == 0){
 368       if(strcmp(current_var->var_name, var_name) == 0)
 369         return 1;
 370       if(strcmp(current_var->var_name, var_name) < 0)
 371         start = cursor + 1;
 372       if(strcmp(current_var->var_name, var_name) > 0)
 373         end = cursor - 1;
 374     }
 375   if(strcmp(current_var->frame, frame) < 0)
 376       start = cursor + 1;
 377   if(strcmp(current_var->frame, frame) > 0)
 378       end = cursor - 1;
 379   }
 380
 381   return 0;
 382 }
 383
 384 static int compare_local_variables(char *s1, char *s2, xbt_dynar_t heap_equals){
 385
 386   xbt_dynar_t tokens1 = xbt_str_split(s1, NULL);
 387   xbt_dynar_t tokens2 = xbt_str_split(s2, NULL);
 388
 389   xbt_dynar_t s_tokens1, s_tokens2;
 390   unsigned int cursor = 0;
 391   void *addr1, *addr2;
 392   char *ip1 = NULL, *ip2 = NULL;
 393
 394   while(cursor < xbt_dynar_length(tokens1)){
 395     s_tokens1 = xbt_str_split(xbt_dynar_get_as(tokens1, cursor, char *), "=");
 396     s_tokens2 = xbt_str_split(xbt_dynar_get_as(tokens2, cursor, char *), "=");
 397     if(xbt_dynar_length(s_tokens1) > 1 && xbt_dynar_length(s_tokens2) > 1){
 398       if((strcmp(xbt_dynar_get_as(s_tokens1, 0, char *), "ip") == 0) && (strcmp(xbt_dynar_get_as(s_tokens2, 0, char *), "ip") == 0)){
 399         ip1 = strdup(xbt_dynar_get_as(s_tokens1, 1, char *));
 400         ip2 = strdup(xbt_dynar_get_as(s_tokens2, 1, char *));
 401         /*if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose))
 402           XBT_VERB("Instruction pointer : %s, Instruction pointer : %s", ip1, ip2);*/
 403       }
 404       if(strcmp(xbt_dynar_get_as(s_tokens1, 1, char *), xbt_dynar_get_as(s_tokens2, 1, char *)) != 0){
 405         /* Ignore this variable ?  */
 406         if(is_stack_ignore_variable(ip1, xbt_dynar_get_as(s_tokens1, 0, char *)) && is_stack_ignore_variable(ip2, xbt_dynar_get_as(s_tokens2, 0, char *))){
 407           xbt_dynar_free(&s_tokens1);
 408           xbt_dynar_free(&s_tokens2);
 409           cursor++;
 410           continue;
 411         }
 412         addr1 = (void *) strtoul(xbt_dynar_get_as(s_tokens1, 1, char *), NULL, 16);
 413         addr2 = (void *) strtoul(xbt_dynar_get_as(s_tokens2, 1, char *), NULL, 16);
 414         if(is_heap_equality(heap_equals, addr1, addr2) == 0){
 415           if(XBT_LOG_ISENABLED(mc_compare, xbt_log_priority_verbose))
 416             XBT_VERB("Variable %s is different between stacks : %s - %s", xbt_dynar_get_as(s_tokens1, 0, char *), xbt_dynar_get_as(s_tokens1, 1, char *), xbt_dynar_get_as(s_tokens2, 1, char *));
 417           xbt_dynar_free(&s_tokens1);
 418           xbt_dynar_free(&s_tokens2);
 419           return 1;
 420         }
 421       }
 422     }
 423     xbt_dynar_free(&s_tokens1);
 424     xbt_dynar_free(&s_tokens2);
 425     cursor++;
 426   }
 427
 428   xbt_dynar_free(&tokens1);
 429   xbt_dynar_free(&tokens2);
 430   return 0;
 431
 432 }
 433
 434 static int is_heap_equality(xbt_dynar_t equals, void *a1, void *a2){
 435
 436   unsigned int cursor = 0;
 437   int start = 0;
 438   int end = xbt_dynar_length(equals) - 1;
 439   heap_equality_t current_equality;
 440
 441   while(start <= end){
 442     cursor = (start + end) / 2;
 443     current_equality = (heap_equality_t)xbt_dynar_get_as(equals, cursor, heap_equality_t);
 444     if(current_equality->address1 == a1){
 445       if(current_equality->address2 == a2)
 446         return 1;
 447       if(current_equality->address2 < a2)
 448         start = cursor + 1;
 449       if(current_equality->address2 > a2)
 450         end = cursor - 1;
 451     }
 452     if(current_equality->address1 < a1)
 453       start = cursor + 1;
 454     if(current_equality->address1 > a1)
 455       end = cursor - 1;
 456   }
 457
 458   return 0;
 459
 460 }
 461
 462
 463 static int compare_stack(stack_region_t s1, stack_region_t s2, void *sp1, void *sp2, void *heap1, void *heap2, xbt_dynar_t equals){
 464
 465   size_t k = 0;
 466   size_t size_used1 = s1->size - ((char*)sp1 - (char*)s1->address);
 467   size_t size_used2 = s2->size - ((char*)sp2 - (char*)s2->address);
 468
 469   int pointer_align;
 470   void *addr_pointed1 = NULL, *addr_pointed2 = NULL;
 471
 472   while(k < size_used1){
 473     if(memcmp((char *)s1->address + s1->size - k, (char *)s2->address + s2->size - k, 1) != 0){
 474       pointer_align = ((size_used1 - k) / sizeof(void*)) * sizeof(void*);
 475       addr_pointed1 = *((void **)(((char*)s1->address + (s1->size - size_used1)) + pointer_align));
 476       addr_pointed2 = *((void **)(((char*)s2->address + (s2->size - size_used2)) + pointer_align));
 477       if(is_heap_equality(equals, addr_pointed1, addr_pointed2) == 0){
 478         if((addr_pointed1 > std_heap) && (addr_pointed1 < (void *)((char *)std_heap + STD_HEAP_SIZE)) && (addr_pointed2 > std_heap) && (addr_pointed2 < (void *)((char *)std_heap + STD_HEAP_SIZE))){
 479           if(is_free_area(addr_pointed1, (xbt_mheap_t)heap1) == 0 || is_free_area(addr_pointed2, (xbt_mheap_t)heap2) == 0){
 480             return 1;
 481           }
 482         }else{
 483           return 1;
 484         }
 485       }
 486     }
 487     k++;
 488   }
 489
 490   return 0;
 491 }
 492
 493 int MC_compare_snapshots(void *s1, void *s2){
 494
 495   return simcall_mc_compare_snapshots(s1, s2);
 496
 497 }