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