src/mc/compare.cpp

   1 /* Copyright (c) 2008-2019. The 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 /** \file compare.cpp Memory snapshooting and comparison                    */
   7
   8 #include "src/mc/mc_config.hpp"
   9 #include "src/mc/mc_private.hpp"
  10 #include "src/mc/mc_smx.hpp"
  11 #include "src/mc/sosp/Snapshot.hpp"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, xbt, "Logging specific to mc_compare in mc");
  14
  15 using simgrid::mc::remote;
  16
  17 namespace simgrid {
  18 namespace mc {
  19
  20 /*********************************** Heap comparison ***********************************/
  21 /***************************************************************************************/
  22
  23 class HeapLocation {
  24 public:
  25   int block_    = 0;
  26   int fragment_ = 0;
  27
  28   HeapLocation() = default;
  29   HeapLocation(int block, int fragment = 0) : block_(block), fragment_(fragment) {}
  30
  31   bool operator==(HeapLocation const& that) const
  32   {
  33     return block_ == that.block_ && fragment_ == that.fragment_;
  34   }
  35   bool operator<(HeapLocation const& that) const
  36   {
  37     return std::make_pair(block_, fragment_) < std::make_pair(that.block_, that.fragment_);
  38   }
  39 };
  40
  41 typedef std::array<HeapLocation, 2> HeapLocationPair;
  42 typedef std::set<HeapLocationPair> HeapLocationPairs;
  43
  44 struct ProcessComparisonState;
  45 struct StateComparator;
  46
  47 static inline
  48 HeapLocationPair makeHeapLocationPair(int block1, int fragment1, int block2, int fragment2)
  49 {
  50   return HeapLocationPair{{HeapLocation(block1, fragment1), HeapLocation(block2, fragment2)}};
  51 }
  52
  53 class HeapArea : public HeapLocation {
  54 public:
  55   bool valid_ = false;
  56   HeapArea() = default;
  57   explicit HeapArea(int block) : valid_(true) { block_ = block; }
  58   HeapArea(int block, int fragment) : valid_(true)
  59   {
  60     block_    = block;
  61     fragment_ = fragment;
  62   }
  63 };
  64
  65 class ProcessComparisonState {
  66 public:
  67   std::vector<simgrid::mc::IgnoredHeapRegion>* to_ignore = nullptr;
  68   std::vector<HeapArea> equals_to;
  69   std::vector<simgrid::mc::Type*> types;
  70   std::size_t heapsize = 0;
  71
  72   void initHeapInformation(xbt_mheap_t heap, std::vector<simgrid::mc::IgnoredHeapRegion>* i);
  73 };
  74
  75 static int compare_heap_area(StateComparator& state, const void* area1, const void* area2, Snapshot* snapshot1,
  76                              Snapshot* snapshot2, HeapLocationPairs* previous, Type* type, int pointer_level);
  77
  78 class StateComparator {
  79 public:
  80   s_xbt_mheap_t std_heap_copy;
  81   std::size_t heaplimit;
  82   std::array<ProcessComparisonState, 2> processStates;
  83
  84   std::unordered_set<std::pair<void*, void*>, simgrid::xbt::hash<std::pair<void*, void*>>> compared_pointers;
  85
  86   void clear()
  87   {
  88     compared_pointers.clear();
  89   }
  90
  91   int initHeapInformation(
  92     xbt_mheap_t heap1, xbt_mheap_t heap2,
  93     std::vector<simgrid::mc::IgnoredHeapRegion>* i1,
  94     std::vector<simgrid::mc::IgnoredHeapRegion>* i2);
  95
  96   HeapArea& equals_to1_(std::size_t i, std::size_t j)
  97   {
  98     return processStates[0].equals_to[ MAX_FRAGMENT_PER_BLOCK * i + j];
  99   }
 100   HeapArea& equals_to2_(std::size_t i, std::size_t j)
 101   {
 102     return processStates[1].equals_to[ MAX_FRAGMENT_PER_BLOCK * i + j];
 103   }
 104   Type*& types1_(std::size_t i, std::size_t j)
 105   {
 106     return processStates[0].types[ MAX_FRAGMENT_PER_BLOCK * i + j];
 107   }
 108   Type*& types2_(std::size_t i, std::size_t j)
 109   {
 110     return processStates[1].types[ MAX_FRAGMENT_PER_BLOCK * i + j];
 111   }
 112
 113   HeapArea const& equals_to1_(std::size_t i, std::size_t j) const
 114   {
 115     return processStates[0].equals_to[ MAX_FRAGMENT_PER_BLOCK * i + j];
 116   }
 117   HeapArea const& equals_to2_(std::size_t i, std::size_t j) const
 118   {
 119     return processStates[1].equals_to[ MAX_FRAGMENT_PER_BLOCK * i + j];
 120   }
 121   Type* const& types1_(std::size_t i, std::size_t j) const
 122   {
 123     return processStates[0].types[ MAX_FRAGMENT_PER_BLOCK * i + j];
 124   }
 125   Type* const& types2_(std::size_t i, std::size_t j) const
 126   {
 127     return processStates[1].types[ MAX_FRAGMENT_PER_BLOCK * i + j];
 128   }
 129
 130   /** Check whether two blocks are known to be matching
 131    *
 132    *  @param b1     Block of state 1
 133    *  @param b2     Block of state 2
 134    *  @return       if the blocks are known to be matching
 135    */
 136   bool blocksEqual(int b1, int b2) const
 137   {
 138     return this->equals_to1_(b1, 0).block_ == b2 && this->equals_to2_(b2, 0).block_ == b1;
 139   }
 140
 141   /** Check whether two fragments are known to be matching
 142    *
 143    *  @param b1     Block of state 1
 144    *  @param f1     Fragment of state 1
 145    *  @param b2     Block of state 2
 146    *  @param f2     Fragment of state 2
 147    *  @return       if the fragments are known to be matching
 148    */
 149   int fragmentsEqual(int b1, int f1, int b2, int f2) const
 150   {
 151     return this->equals_to1_(b1, f1).block_ == b2 && this->equals_to1_(b1, f1).fragment_ == f2 &&
 152            this->equals_to2_(b2, f2).block_ == b1 && this->equals_to2_(b2, f2).fragment_ == f1;
 153   }
 154
 155   void match_equals(HeapLocationPairs* list);
 156 };
 157
 158 }
 159 }
 160
 161 /************************************************************************************/
 162
 163 static ssize_t heap_comparison_ignore_size(
 164   std::vector<simgrid::mc::IgnoredHeapRegion>* ignore_list,
 165   const void *address)
 166 {
 167   int start = 0;
 168   int end = ignore_list->size() - 1;
 169
 170   while (start <= end) {
 171     unsigned int cursor = (start + end) / 2;
 172     simgrid::mc::IgnoredHeapRegion const& region = (*ignore_list)[cursor];
 173     if (region.address == address)
 174       return region.size;
 175     if (region.address < address)
 176       start = cursor + 1;
 177     if (region.address > address)
 178       end = cursor - 1;
 179   }
 180
 181   return -1;
 182 }
 183
 184 static bool is_stack(const void *address)
 185 {
 186   for (auto const& stack : mc_model_checker->process().stack_areas())
 187     if (address == stack.address)
 188       return true;
 189   return false;
 190 }
 191
 192 // TODO, this should depend on the snapshot?
 193 static bool is_block_stack(int block)
 194 {
 195   for (auto const& stack : mc_model_checker->process().stack_areas())
 196     if (block == stack.block)
 197       return true;
 198   return false;
 199 }
 200
 201 namespace simgrid {
 202 namespace mc {
 203
 204 void StateComparator::match_equals(HeapLocationPairs* list)
 205 {
 206   for (auto const& pair : *list) {
 207     if (pair[0].fragment_ != -1) {
 208       this->equals_to1_(pair[0].block_, pair[0].fragment_) = simgrid::mc::HeapArea(pair[1].block_, pair[1].fragment_);
 209       this->equals_to2_(pair[1].block_, pair[1].fragment_) = simgrid::mc::HeapArea(pair[0].block_, pair[0].fragment_);
 210     } else {
 211       this->equals_to1_(pair[0].block_, 0) = simgrid::mc::HeapArea(pair[1].block_, pair[1].fragment_);
 212       this->equals_to2_(pair[1].block_, 0) = simgrid::mc::HeapArea(pair[0].block_, pair[0].fragment_);
 213     }
 214   }
 215 }
 216
 217 void ProcessComparisonState::initHeapInformation(xbt_mheap_t heap,
 218                         std::vector<simgrid::mc::IgnoredHeapRegion>* i)
 219 {
 220   auto heaplimit  = heap->heaplimit;
 221   this->heapsize  = heap->heapsize;
 222   this->to_ignore = i;
 223   this->equals_to.assign(heaplimit * MAX_FRAGMENT_PER_BLOCK, HeapArea());
 224   this->types.assign(heaplimit * MAX_FRAGMENT_PER_BLOCK, nullptr);
 225 }
 226
 227 int StateComparator::initHeapInformation(xbt_mheap_t heap1, xbt_mheap_t heap2,
 228                           std::vector<simgrid::mc::IgnoredHeapRegion>* i1,
 229                           std::vector<simgrid::mc::IgnoredHeapRegion>* i2)
 230 {
 231   if ((heap1->heaplimit != heap2->heaplimit) || (heap1->heapsize != heap2->heapsize))
 232     return -1;
 233   this->heaplimit     = heap1->heaplimit;
 234   this->std_heap_copy = *mc_model_checker->process().get_heap();
 235   this->processStates[0].initHeapInformation(heap1, i1);
 236   this->processStates[1].initHeapInformation(heap2, i2);
 237   return 0;
 238 }
 239
 240 // TODO, have a robust way to find it in O(1)
 241 static inline Region* MC_get_heap_region(Snapshot* snapshot)
 242 {
 243   for (auto const& region : snapshot->snapshot_regions_)
 244     if (region->region_type() == simgrid::mc::RegionType::Heap)
 245       return region.get();
 246   xbt_die("No heap region");
 247 }
 248
 249 static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc::Snapshot* snapshot1,
 250                                simgrid::mc::Snapshot* snapshot2)
 251 {
 252   simgrid::mc::RemoteClient* process = &mc_model_checker->process();
 253
 254   /* Check busy blocks */
 255   size_t i1 = 1;
 256
 257   malloc_info heapinfo_temp1;
 258   malloc_info heapinfo_temp2;
 259   malloc_info heapinfo_temp2b;
 260
 261   simgrid::mc::Region* heap_region1 = MC_get_heap_region(snapshot1);
 262   simgrid::mc::Region* heap_region2 = MC_get_heap_region(snapshot2);
 263
 264   // This is the address of std_heap->heapinfo in the application process:
 265   void* heapinfo_address = &((xbt_mheap_t) process->heap_address)->heapinfo;
 266
 267   // This is in snapshot do not use them directly:
 268   const malloc_info* heapinfos1 =
 269       snapshot1->read<malloc_info*>(RemotePtr<malloc_info*>((std::uint64_t)heapinfo_address));
 270   const malloc_info* heapinfos2 =
 271       snapshot2->read<malloc_info*>(RemotePtr<malloc_info*>((std::uint64_t)heapinfo_address));
 272
 273   while (i1 < state.heaplimit) {
 274
 275     const malloc_info* heapinfo1 =
 276         (const malloc_info*)heap_region1->read(&heapinfo_temp1, &heapinfos1[i1], sizeof(malloc_info));
 277     const malloc_info* heapinfo2 =
 278         (const malloc_info*)heap_region2->read(&heapinfo_temp2, &heapinfos2[i1], sizeof(malloc_info));
 279
 280     if (heapinfo1->type == MMALLOC_TYPE_FREE || heapinfo1->type == MMALLOC_TYPE_HEAPINFO) {      /* Free block */
 281       i1 ++;
 282       continue;
 283     }
 284
 285     if (heapinfo1->type < 0) {
 286       fprintf(stderr, "Unkown mmalloc block type.\n");
 287       abort();
 288     }
 289
 290     void* addr_block1 = ((void*)(((ADDR2UINT(i1)) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase));
 291
 292     if (heapinfo1->type == MMALLOC_TYPE_UNFRAGMENTED) {       /* Large block */
 293
 294       if (is_stack(addr_block1)) {
 295         for (size_t k = 0; k < heapinfo1->busy_block.size; k++)
 296           state.equals_to1_(i1 + k, 0) = HeapArea(i1, -1);
 297         for (size_t k = 0; k < heapinfo2->busy_block.size; k++)
 298           state.equals_to2_(i1 + k, 0) = HeapArea(i1, -1);
 299         i1 += heapinfo1->busy_block.size;
 300         continue;
 301       }
 302
 303       if (state.equals_to1_(i1, 0).valid_) {
 304         i1++;
 305         continue;
 306       }
 307
 308       size_t i2 = 1;
 309       bool equal = false;
 310
 311       /* Try first to associate to same block in the other heap */
 312       if (heapinfo2->type == heapinfo1->type && state.equals_to2_(i1, 0).valid_ == 0) {
 313         void* addr_block2 = (ADDR2UINT(i1) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
 314         int res_compare = compare_heap_area(state, addr_block1, addr_block2, snapshot1, snapshot2, nullptr, nullptr, 0);
 315         if (res_compare != 1) {
 316           for (size_t k = 1; k < heapinfo2->busy_block.size; k++)
 317             state.equals_to2_(i1 + k, 0) = HeapArea(i1, -1);
 318           for (size_t k = 1; k < heapinfo1->busy_block.size; k++)
 319             state.equals_to1_(i1 + k, 0) = HeapArea(i1, -1);
 320           equal = true;
 321           i1 += heapinfo1->busy_block.size;
 322         }
 323       }
 324
 325       while (i2 < state.heaplimit && not equal) {
 326
 327         void* addr_block2 = (ADDR2UINT(i2) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
 328
 329         if (i2 == i1) {
 330           i2++;
 331           continue;
 332         }
 333
 334         const malloc_info* heapinfo2b =
 335             (const malloc_info*)heap_region2->read(&heapinfo_temp2b, &heapinfos2[i2], sizeof(malloc_info));
 336
 337         if (heapinfo2b->type != MMALLOC_TYPE_UNFRAGMENTED) {
 338           i2++;
 339           continue;
 340         }
 341
 342         if (state.equals_to2_(i2, 0).valid_) {
 343           i2++;
 344           continue;
 345         }
 346
 347         int res_compare = compare_heap_area(state, addr_block1, addr_block2, snapshot1, snapshot2, nullptr, nullptr, 0);
 348
 349         if (res_compare != 1) {
 350           for (size_t k = 1; k < heapinfo2b->busy_block.size; k++)
 351             state.equals_to2_(i2 + k, 0) = HeapArea(i1, -1);
 352           for (size_t k = 1; k < heapinfo1->busy_block.size; k++)
 353             state.equals_to1_(i1 + k, 0) = HeapArea(i2, -1);
 354           equal = true;
 355           i1 += heapinfo1->busy_block.size;
 356         }
 357
 358         i2++;
 359       }
 360
 361       if (not equal) {
 362         XBT_DEBUG("Block %zu not found (size_used = %zu, addr = %p)", i1, heapinfo1->busy_block.busy_size, addr_block1);
 363         return false;
 364       }
 365
 366     } else {                    /* Fragmented block */
 367
 368       for (size_t j1 = 0; j1 < (size_t)(BLOCKSIZE >> heapinfo1->type); j1++) {
 369
 370         if (heapinfo1->busy_frag.frag_size[j1] == -1) /* Free fragment_ */
 371           continue;
 372
 373         if (state.equals_to1_(i1, j1).valid_)
 374           continue;
 375
 376         void* addr_frag1 = (void*)((char*)addr_block1 + (j1 << heapinfo1->type));
 377
 378         size_t i2 = 1;
 379         bool equal = false;
 380
 381         /* Try first to associate to same fragment_ in the other heap */
 382         if (heapinfo2->type == heapinfo1->type && not state.equals_to2_(i1, j1).valid_) {
 383           void* addr_block2 = (ADDR2UINT(i1) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
 384           void* addr_frag2  = (void*)((char*)addr_block2 + (j1 << heapinfo2->type));
 385           int res_compare = compare_heap_area(state, addr_frag1, addr_frag2, snapshot1, snapshot2, nullptr, nullptr, 0);
 386           if (res_compare != 1)
 387             equal = true;
 388         }
 389
 390         while (i2 < state.heaplimit && not equal) {
 391
 392           const malloc_info* heapinfo2b =
 393               (const malloc_info*)heap_region2->read(&heapinfo_temp2b, &heapinfos2[i2], sizeof(malloc_info));
 394
 395           if (heapinfo2b->type == MMALLOC_TYPE_FREE || heapinfo2b->type == MMALLOC_TYPE_HEAPINFO) {
 396             i2 ++;
 397             continue;
 398           }
 399
 400           // We currently do not match fragments with unfragmented blocks (maybe we should).
 401           if (heapinfo2b->type == MMALLOC_TYPE_UNFRAGMENTED) {
 402             i2++;
 403             continue;
 404           }
 405
 406           if (heapinfo2b->type < 0) {
 407             fprintf(stderr, "Unknown mmalloc block type.\n");
 408             abort();
 409           }
 410
 411           for (size_t j2 = 0; j2 < (size_t)(BLOCKSIZE >> heapinfo2b->type); j2++) {
 412
 413             if (i2 == i1 && j2 == j1)
 414               continue;
 415
 416             if (state.equals_to2_(i2, j2).valid_)
 417               continue;
 418
 419             void* addr_block2 = (ADDR2UINT(i2) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
 420             void* addr_frag2  = (void*)((char*)addr_block2 + (j2 << heapinfo2b->type));
 421
 422             int res_compare =
 423                 compare_heap_area(state, addr_frag1, addr_frag2, snapshot1, snapshot2, nullptr, nullptr, 0);
 424             if (res_compare != 1) {
 425               equal = true;
 426               break;
 427             }
 428           }
 429
 430           i2++;
 431         }
 432
 433         if (not equal) {
 434           XBT_DEBUG("Block %zu, fragment_ %zu not found (size_used = %zd, address = %p)\n", i1, j1,
 435                     heapinfo1->busy_frag.frag_size[j1], addr_frag1);
 436           return false;
 437         }
 438       }
 439
 440       i1++;
 441     }
 442   }
 443
 444   /* All blocks/fragments are equal to another block/fragment_ ? */
 445   for (size_t i = 1; i < state.heaplimit; i++) {
 446     const malloc_info* heapinfo1 =
 447         (const malloc_info*)heap_region1->read(&heapinfo_temp1, &heapinfos1[i], sizeof(malloc_info));
 448
 449     if (heapinfo1->type == MMALLOC_TYPE_UNFRAGMENTED && i1 == state.heaplimit && heapinfo1->busy_block.busy_size > 0 &&
 450         not state.equals_to1_(i, 0).valid_) {
 451       XBT_DEBUG("Block %zu not found (size used = %zu)", i, heapinfo1->busy_block.busy_size);
 452       return false;
 453     }
 454
 455     if (heapinfo1->type <= 0)
 456       continue;
 457     for (size_t j = 0; j < (size_t)(BLOCKSIZE >> heapinfo1->type); j++)
 458       if (i1 == state.heaplimit && heapinfo1->busy_frag.frag_size[j] > 0 && not state.equals_to1_(i, j).valid_) {
 459         XBT_DEBUG("Block %zu, Fragment %zu not found (size used = %zd)", i, j, heapinfo1->busy_frag.frag_size[j]);
 460         return false;
 461       }
 462   }
 463
 464   for (size_t i = 1; i < state.heaplimit; i++) {
 465     const malloc_info* heapinfo2 =
 466         (const malloc_info*)heap_region2->read(&heapinfo_temp2, &heapinfos2[i], sizeof(malloc_info));
 467     if (heapinfo2->type == MMALLOC_TYPE_UNFRAGMENTED && i1 == state.heaplimit && heapinfo2->busy_block.busy_size > 0 &&
 468         not state.equals_to2_(i, 0).valid_) {
 469       XBT_DEBUG("Block %zu not found (size used = %zu)", i,
 470                 heapinfo2->busy_block.busy_size);
 471       return false;
 472     }
 473
 474     if (heapinfo2->type <= 0)
 475       continue;
 476
 477     for (size_t j = 0; j < (size_t)(BLOCKSIZE >> heapinfo2->type); j++)
 478       if (i1 == state.heaplimit && heapinfo2->busy_frag.frag_size[j] > 0 && not state.equals_to2_(i, j).valid_) {
 479         XBT_DEBUG("Block %zu, Fragment %zu not found (size used = %zd)",
 480           i, j, heapinfo2->busy_frag.frag_size[j]);
 481         return false;
 482       }
 483   }
 484
 485   return true;
 486 }
 487
 488 /**
 489  *
 490  * @param state
 491  * @param real_area1     Process address for state 1
 492  * @param real_area2     Process address for state 2
 493  * @param snapshot1      Snapshot of state 1
 494  * @param snapshot2      Snapshot of state 2
 495  * @param previous
 496  * @param size
 497  * @param check_ignore
 498  */
 499 static bool heap_area_equal_without_type(simgrid::mc::StateComparator& state, const void* real_area1,
 500                                          const void* real_area2, simgrid::mc::Snapshot* snapshot1,
 501                                          simgrid::mc::Snapshot* snapshot2, HeapLocationPairs* previous, int size,
 502                                          int check_ignore)
 503 {
 504   simgrid::mc::RemoteClient* process = &mc_model_checker->process();
 505   simgrid::mc::Region* heap_region1  = MC_get_heap_region(snapshot1);
 506   simgrid::mc::Region* heap_region2  = MC_get_heap_region(snapshot2);
 507
 508   for (int i = 0; i < size; ) {
 509
 510     if (check_ignore > 0) {
 511       ssize_t ignore1 = heap_comparison_ignore_size(state.processStates[0].to_ignore, (char*)real_area1 + i);
 512       if (ignore1 != -1) {
 513         ssize_t ignore2 = heap_comparison_ignore_size(state.processStates[1].to_ignore, (char*)real_area2 + i);
 514         if (ignore2 == ignore1) {
 515           if (ignore1 == 0) {
 516             check_ignore--;
 517             return true;
 518           } else {
 519             i = i + ignore2;
 520             check_ignore--;
 521             continue;
 522           }
 523         }
 524       }
 525     }
 526
 527     if (MC_snapshot_region_memcmp(((char *) real_area1) + i, heap_region1, ((char *) real_area2) + i, heap_region2, 1) != 0) {
 528
 529       int pointer_align = (i / sizeof(void *)) * sizeof(void *);
 530       const void* addr_pointed1 = snapshot1->read(remote((void**)((char*)real_area1 + pointer_align)));
 531       const void* addr_pointed2 = snapshot2->read(remote((void**)((char*)real_area2 + pointer_align)));
 532
 533       if (process->in_maestro_stack(remote(addr_pointed1))
 534         && process->in_maestro_stack(remote(addr_pointed2))) {
 535         i = pointer_align + sizeof(void *);
 536         continue;
 537       }
 538
 539       if (addr_pointed1 > state.std_heap_copy.heapbase
 540            && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)
 541            && addr_pointed2 > state.std_heap_copy.heapbase
 542            && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)) {
 543         // Both addresses are in the heap:
 544         int res_compare =
 545             compare_heap_area(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, previous, nullptr, 0);
 546         if (res_compare == 1)
 547           return false;
 548         i = pointer_align + sizeof(void *);
 549         continue;
 550       }
 551
 552       return false;
 553     }
 554
 555     i++;
 556   }
 557
 558   return true;
 559 }
 560
 561 /**
 562  *
 563  * @param state
 564  * @param real_area1     Process address for state 1
 565  * @param real_area2     Process address for state 2
 566  * @param snapshot1      Snapshot of state 1
 567  * @param snapshot2      Snapshot of state 2
 568  * @param previous
 569  * @param type
 570  * @param area_size      either a byte_size or an elements_count (?)
 571  * @param check_ignore
 572  * @param pointer_level
 573  * @return               0 (same), 1 (different), -1 (unknown)
 574  */
 575 static int compare_heap_area_with_type(simgrid::mc::StateComparator& state, const void* real_area1,
 576                                        const void* real_area2, simgrid::mc::Snapshot* snapshot1,
 577                                        simgrid::mc::Snapshot* snapshot2, HeapLocationPairs* previous,
 578                                        simgrid::mc::Type* type, int area_size, int check_ignore, int pointer_level)
 579 {
 580   // HACK: This should not happen but in pratice, there are some
 581   // DW_TAG_typedef without an associated DW_AT_type:
 582   //<1><538832>: Abbrev Number: 111 (DW_TAG_typedef)
 583   //    <538833>   DW_AT_name        : (indirect string, offset: 0x2292f3): gregset_t
 584   //    <538837>   DW_AT_decl_file   : 98
 585   //    <538838>   DW_AT_decl_line   : 37
 586   if (type == nullptr)
 587     return 0;
 588
 589   if (is_stack(real_area1) && is_stack(real_area2))
 590     return 0;
 591
 592   if (check_ignore > 0) {
 593     ssize_t ignore1 = heap_comparison_ignore_size(state.processStates[0].to_ignore, real_area1);
 594     if (ignore1 > 0 && heap_comparison_ignore_size(state.processStates[1].to_ignore, real_area2) == ignore1)
 595       return 0;
 596   }
 597
 598   simgrid::mc::Type* subtype;
 599   simgrid::mc::Type* subsubtype;
 600   int elm_size;
 601   const void* addr_pointed1;
 602   const void* addr_pointed2;
 603
 604   simgrid::mc::Region* heap_region1 = MC_get_heap_region(snapshot1);
 605   simgrid::mc::Region* heap_region2 = MC_get_heap_region(snapshot2);
 606
 607   switch (type->type) {
 608     case DW_TAG_unspecified_type:
 609       return 1;
 610
 611     case DW_TAG_base_type:
 612       if (not type->name.empty() && type->name == "char") { /* String, hence random (arbitrary ?) size */
 613         if (real_area1 == real_area2)
 614           return -1;
 615         else
 616           return MC_snapshot_region_memcmp(real_area1, heap_region1, real_area2, heap_region2, area_size) != 0;
 617       } else {
 618         if (area_size != -1 && type->byte_size != area_size)
 619           return -1;
 620         else
 621           return MC_snapshot_region_memcmp(real_area1, heap_region1, real_area2, heap_region2, type->byte_size) != 0;
 622       }
 623
 624     case DW_TAG_enumeration_type:
 625       if (area_size != -1 && type->byte_size != area_size)
 626         return -1;
 627       return MC_snapshot_region_memcmp(real_area1, heap_region1, real_area2, heap_region2, type->byte_size) != 0;
 628
 629     case DW_TAG_typedef:
 630     case DW_TAG_const_type:
 631     case DW_TAG_volatile_type:
 632       return compare_heap_area_with_type(state, real_area1, real_area2, snapshot1, snapshot2, previous, type->subtype,
 633                                          area_size, check_ignore, pointer_level);
 634
 635     case DW_TAG_array_type:
 636       subtype = type->subtype;
 637       switch (subtype->type) {
 638         case DW_TAG_unspecified_type:
 639           return 1;
 640
 641         case DW_TAG_base_type:
 642         case DW_TAG_enumeration_type:
 643         case DW_TAG_pointer_type:
 644         case DW_TAG_reference_type:
 645         case DW_TAG_rvalue_reference_type:
 646         case DW_TAG_structure_type:
 647         case DW_TAG_class_type:
 648         case DW_TAG_union_type:
 649           if (subtype->full_type)
 650             subtype = subtype->full_type;
 651           elm_size  = subtype->byte_size;
 652           break;
 653         // TODO, just remove the type indirection?
 654         case DW_TAG_const_type:
 655         case DW_TAG_typedef:
 656         case DW_TAG_volatile_type:
 657           subsubtype = subtype->subtype;
 658           if (subsubtype->full_type)
 659             subsubtype = subsubtype->full_type;
 660           elm_size     = subsubtype->byte_size;
 661           break;
 662         default:
 663           return 0;
 664       }
 665       for (int i = 0; i < type->element_count; i++) {
 666         // TODO, add support for variable stride (DW_AT_byte_stride)
 667         int res = compare_heap_area_with_type(state, (char*)real_area1 + (i * elm_size),
 668                                               (char*)real_area2 + (i * elm_size), snapshot1, snapshot2, previous,
 669                                               type->subtype, subtype->byte_size, check_ignore, pointer_level);
 670         if (res == 1)
 671           return res;
 672       }
 673       return 0;
 674
 675     case DW_TAG_reference_type:
 676     case DW_TAG_rvalue_reference_type:
 677     case DW_TAG_pointer_type:
 678       if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
 679         addr_pointed1 = snapshot1->read(remote((void**)real_area1));
 680         addr_pointed2 = snapshot2->read(remote((void**)real_area2));
 681         return (addr_pointed1 != addr_pointed2);
 682       }
 683       pointer_level++;
 684       if (pointer_level <= 1) {
 685         addr_pointed1 = snapshot1->read(remote((void**)real_area1));
 686         addr_pointed2 = snapshot2->read(remote((void**)real_area2));
 687         if (addr_pointed1 > state.std_heap_copy.heapbase && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1) &&
 688             addr_pointed2 > state.std_heap_copy.heapbase && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2))
 689           return compare_heap_area(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, previous, type->subtype,
 690                                    pointer_level);
 691         else
 692           return (addr_pointed1 != addr_pointed2);
 693       }
 694       for (size_t i = 0; i < (area_size / sizeof(void*)); i++) {
 695         addr_pointed1 = snapshot1->read(remote((void**)((char*)real_area1 + i * sizeof(void*))));
 696         addr_pointed2 = snapshot2->read(remote((void**)((char*)real_area2 + i * sizeof(void*))));
 697         int res;
 698         if (addr_pointed1 > state.std_heap_copy.heapbase && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1) &&
 699             addr_pointed2 > state.std_heap_copy.heapbase && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2))
 700           res = compare_heap_area(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, previous, type->subtype,
 701                                   pointer_level);
 702         else
 703           res = (addr_pointed1 != addr_pointed2);
 704         if (res == 1)
 705           return res;
 706       }
 707       return 0;
 708
 709     case DW_TAG_structure_type:
 710     case DW_TAG_class_type:
 711       if (type->full_type)
 712         type = type->full_type;
 713       if (area_size != -1 && type->byte_size != area_size) {
 714         if (area_size <= type->byte_size || area_size % type->byte_size != 0)
 715           return -1;
 716         for (size_t i = 0; i < (size_t)(area_size / type->byte_size); i++) {
 717           int res = compare_heap_area_with_type(state, (char*)real_area1 + i * type->byte_size,
 718                                                 (char*)real_area2 + i * type->byte_size, snapshot1, snapshot2, previous,
 719                                                 type, -1, check_ignore, 0);
 720           if (res == 1)
 721             return res;
 722         }
 723         } else {
 724           for (simgrid::mc::Member& member : type->members) {
 725             // TODO, optimize this? (for the offset case)
 726             void* real_member1 =
 727                 simgrid::dwarf::resolve_member(real_area1, type, &member, (simgrid::mc::AddressSpace*)snapshot1);
 728             void* real_member2 =
 729                 simgrid::dwarf::resolve_member(real_area2, type, &member, (simgrid::mc::AddressSpace*)snapshot2);
 730             int res = compare_heap_area_with_type(state, real_member1, real_member2, snapshot1, snapshot2, previous,
 731                                                   member.type, -1, check_ignore, 0);
 732             if (res == 1)
 733               return res;
 734           }
 735         }
 736         return 0;
 737
 738     case DW_TAG_union_type:
 739       return not heap_area_equal_without_type(state, real_area1, real_area2, snapshot1, snapshot2, previous,
 740                                               type->byte_size, check_ignore);
 741
 742     default:
 743       XBT_VERB("Unknown case: %d", type->type);
 744       break;
 745   }
 746   return 0;
 747 }
 748
 749 /** Infer the type of a part of the block from the type of the block
 750  *
 751  * TODO, handle DW_TAG_array_type as well as arrays of the object ((*p)[5], p[5])
 752  *
 753  * TODO, handle subfields ((*p).bar.foo, (*p)[5].bar…)
 754  *
 755  * @param  type               DWARF type ID of the root address
 756  * @param  area_size
 757  * @return                    DWARF type ID for given offset
 758  */
 759 static simgrid::mc::Type* get_offset_type(void* real_base_address, simgrid::mc::Type* type, int offset, int area_size,
 760                                           simgrid::mc::Snapshot* snapshot)
 761 {
 762
 763   // Beginning of the block, the infered variable type if the type of the block:
 764   if (offset == 0)
 765     return type;
 766
 767   switch (type->type) {
 768
 769   case DW_TAG_structure_type:
 770   case DW_TAG_class_type:
 771     if (type->full_type)
 772       type = type->full_type;
 773     if (area_size != -1 && type->byte_size != area_size) {
 774       if (area_size > type->byte_size && area_size % type->byte_size == 0)
 775         return type;
 776       else
 777         return nullptr;
 778     }
 779
 780     for (simgrid::mc::Member& member : type->members) {
 781       if (member.has_offset_location()) {
 782         // We have the offset, use it directly (shortcut):
 783         if (member.offset() == offset)
 784           return member.type;
 785       } else {
 786         void* real_member = simgrid::dwarf::resolve_member(real_base_address, type, &member, snapshot);
 787         if ((char*)real_member - (char*)real_base_address == offset)
 788           return member.type;
 789       }
 790     }
 791     return nullptr;
 792
 793   default:
 794     /* FIXME: other cases ? */
 795     return nullptr;
 796
 797   }
 798 }
 799
 800 /**
 801  *
 802  * @param area1          Process address for state 1
 803  * @param area2          Process address for state 2
 804  * @param snapshot1      Snapshot of state 1
 805  * @param snapshot2      Snapshot of state 2
 806  * @param previous       Pairs of blocks already compared on the current path (or nullptr)
 807  * @param type_id        Type of variable
 808  * @param pointer_level
 809  * @return 0 (same), 1 (different), -1
 810  */
 811 static int compare_heap_area(simgrid::mc::StateComparator& state, const void* area1, const void* area2,
 812                              simgrid::mc::Snapshot* snapshot1, simgrid::mc::Snapshot* snapshot2,
 813                              HeapLocationPairs* previous, simgrid::mc::Type* type, int pointer_level)
 814 {
 815   simgrid::mc::RemoteClient* process = &mc_model_checker->process();
 816
 817   ssize_t block1;
 818   ssize_t block2;
 819   ssize_t size;
 820   int check_ignore = 0;
 821
 822   int type_size = -1;
 823   int offset1   = 0;
 824   int offset2   = 0;
 825   int new_size1 = -1;
 826   int new_size2 = -1;
 827
 828   simgrid::mc::Type* new_type1 = nullptr;
 829   simgrid::mc::Type* new_type2 = nullptr;
 830
 831   bool match_pairs = false;
 832
 833   // This is the address of std_heap->heapinfo in the application process:
 834   void* heapinfo_address = &((xbt_mheap_t) process->heap_address)->heapinfo;
 835
 836   const malloc_info* heapinfos1 = snapshot1->read(remote((const malloc_info**)heapinfo_address));
 837   const malloc_info* heapinfos2 = snapshot2->read(remote((const malloc_info**)heapinfo_address));
 838
 839   malloc_info heapinfo_temp1;
 840   malloc_info heapinfo_temp2;
 841
 842   simgrid::mc::HeapLocationPairs current;
 843   if (previous == nullptr) {
 844     previous = &current;
 845     match_pairs = true;
 846   }
 847
 848   // Get block number:
 849   block1 = ((char*)area1 - (char*)state.std_heap_copy.heapbase) / BLOCKSIZE + 1;
 850   block2 = ((char*)area2 - (char*)state.std_heap_copy.heapbase) / BLOCKSIZE + 1;
 851
 852   // If either block is a stack block:
 853   if (is_block_stack((int) block1) && is_block_stack((int) block2)) {
 854     previous->insert(simgrid::mc::makeHeapLocationPair(block1, -1, block2, -1));
 855     if (match_pairs)
 856       state.match_equals(previous);
 857     return 0;
 858   }
 859
 860   // If either block is not in the expected area of memory:
 861   if (((char*)area1 < (char*)state.std_heap_copy.heapbase) || (block1 > (ssize_t)state.processStates[0].heapsize) ||
 862       (block1 < 1) || ((char*)area2 < (char*)state.std_heap_copy.heapbase) ||
 863       (block2 > (ssize_t)state.processStates[1].heapsize) || (block2 < 1)) {
 864     return 1;
 865   }
 866
 867   // Process address of the block:
 868   void* real_addr_block1 = (ADDR2UINT(block1) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
 869   void* real_addr_block2 = (ADDR2UINT(block2) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
 870
 871   if (type) {
 872     if (type->full_type)
 873       type = type->full_type;
 874
 875     // This assume that for "boring" types (volatile ...) byte_size is absent:
 876     while (type->byte_size == 0 && type->subtype != nullptr)
 877       type = type->subtype;
 878
 879     // Find type_size:
 880     if (type->type == DW_TAG_pointer_type ||
 881         (type->type == DW_TAG_base_type && not type->name.empty() && type->name == "char"))
 882       type_size = -1;
 883     else
 884       type_size = type->byte_size;
 885
 886   }
 887
 888   simgrid::mc::Region* heap_region1 = MC_get_heap_region(snapshot1);
 889   simgrid::mc::Region* heap_region2 = MC_get_heap_region(snapshot2);
 890
 891   const malloc_info* heapinfo1 =
 892       (const malloc_info*)heap_region1->read(&heapinfo_temp1, &heapinfos1[block1], sizeof(malloc_info));
 893   const malloc_info* heapinfo2 =
 894       (const malloc_info*)heap_region2->read(&heapinfo_temp2, &heapinfos2[block2], sizeof(malloc_info));
 895
 896   if ((heapinfo1->type == MMALLOC_TYPE_FREE || heapinfo1->type==MMALLOC_TYPE_HEAPINFO)
 897     && (heapinfo2->type == MMALLOC_TYPE_FREE || heapinfo2->type ==MMALLOC_TYPE_HEAPINFO)) {
 898     /* Free block */
 899     if (match_pairs)
 900       state.match_equals(previous);
 901     return 0;
 902   }
 903
 904   if (heapinfo1->type == MMALLOC_TYPE_UNFRAGMENTED && heapinfo2->type == MMALLOC_TYPE_UNFRAGMENTED) {
 905     /* Complete block */
 906
 907     // TODO, lookup variable type from block type as done for fragmented blocks
 908
 909     if (state.equals_to1_(block1, 0).valid_ && state.equals_to2_(block2, 0).valid_ &&
 910         state.blocksEqual(block1, block2)) {
 911       if (match_pairs)
 912         state.match_equals(previous);
 913       return 0;
 914     }
 915
 916     if (type_size != -1 && type_size != (ssize_t)heapinfo1->busy_block.busy_size &&
 917         type_size != (ssize_t)heapinfo2->busy_block.busy_size &&
 918         (type->name.empty() || type->name == "struct s_smx_context")) {
 919       if (match_pairs)
 920         state.match_equals(previous);
 921       return -1;
 922     }
 923
 924     if (heapinfo1->busy_block.size != heapinfo2->busy_block.size)
 925       return 1;
 926     if (heapinfo1->busy_block.busy_size != heapinfo2->busy_block.busy_size)
 927       return 1;
 928
 929     if (not previous->insert(simgrid::mc::makeHeapLocationPair(block1, -1, block2, -1)).second) {
 930       if (match_pairs)
 931         state.match_equals(previous);
 932       return 0;
 933     }
 934
 935     size = heapinfo1->busy_block.busy_size;
 936
 937     // Remember (basic) type inference.
 938     // The current data structure only allows us to do this for the whole block.
 939     if (type != nullptr && area1 == real_addr_block1)
 940       state.types1_(block1, 0) = type;
 941     if (type != nullptr && area2 == real_addr_block2)
 942       state.types2_(block2, 0) = type;
 943
 944     if (size <= 0) {
 945       if (match_pairs)
 946         state.match_equals(previous);
 947       return 0;
 948     }
 949
 950     if (heapinfo1->busy_block.ignore > 0
 951         && heapinfo2->busy_block.ignore == heapinfo1->busy_block.ignore)
 952       check_ignore = heapinfo1->busy_block.ignore;
 953
 954   } else if ((heapinfo1->type > 0) && (heapinfo2->type > 0)) {      /* Fragmented block */
 955
 956     // Fragment number:
 957     ssize_t frag1 = ((uintptr_t)(ADDR2UINT(area1) % (BLOCKSIZE))) >> heapinfo1->type;
 958     ssize_t frag2 = ((uintptr_t)(ADDR2UINT(area2) % (BLOCKSIZE))) >> heapinfo2->type;
 959
 960     // Process address of the fragment_:
 961     void* real_addr_frag1 = (void*)((char*)real_addr_block1 + (frag1 << heapinfo1->type));
 962     void* real_addr_frag2 = (void*)((char*)real_addr_block2 + (frag2 << heapinfo2->type));
 963
 964     // Check the size of the fragments against the size of the type:
 965     if (type_size != -1) {
 966       if (heapinfo1->busy_frag.frag_size[frag1] == -1 || heapinfo2->busy_frag.frag_size[frag2] == -1) {
 967         if (match_pairs)
 968           state.match_equals(previous);
 969         return -1;
 970       }
 971       // ?
 972       if (type_size != heapinfo1->busy_frag.frag_size[frag1]
 973           || type_size != heapinfo2->busy_frag.frag_size[frag2]) {
 974         if (match_pairs)
 975           state.match_equals(previous);
 976         return -1;
 977       }
 978     }
 979
 980     // Check if the blocks are already matched together:
 981     if (state.equals_to1_(block1, frag1).valid_ && state.equals_to2_(block2, frag2).valid_ && offset1 == offset2 &&
 982         state.fragmentsEqual(block1, frag1, block2, frag2)) {
 983       if (match_pairs)
 984         state.match_equals(previous);
 985       return 0;
 986     }
 987     // Compare the size of both fragments:
 988     if (heapinfo1->busy_frag.frag_size[frag1] != heapinfo2->busy_frag.frag_size[frag2]) {
 989       if (type_size == -1) {
 990         if (match_pairs)
 991           state.match_equals(previous);
 992         return -1;
 993       } else
 994         return 1;
 995     }
 996
 997     // Size of the fragment_:
 998     size = heapinfo1->busy_frag.frag_size[frag1];
 999
1000     // Remember (basic) type inference.
1001     // The current data structure only allows us to do this for the whole fragment_.
1002     if (type != nullptr && area1 == real_addr_frag1)
1003       state.types1_(block1, frag1) = type;
1004     if (type != nullptr && area2 == real_addr_frag2)
1005       state.types2_(block2, frag2) = type;
1006
1007     // The type of the variable is already known:
1008     if (type) {
1009       new_type1 = new_type2 = type;
1010     }
1011     // Type inference from the block type.
1012     else if (state.types1_(block1, frag1) != nullptr || state.types2_(block2, frag2) != nullptr) {
1013
1014       offset1 = (char*)area1 - (char*)real_addr_frag1;
1015       offset2 = (char*)area2 - (char*)real_addr_frag2;
1016
1017       if (state.types1_(block1, frag1) != nullptr && state.types2_(block2, frag2) != nullptr) {
1018         new_type1 = get_offset_type(real_addr_frag1, state.types1_(block1, frag1), offset1, size, snapshot1);
1019         new_type2 = get_offset_type(real_addr_frag2, state.types2_(block2, frag2), offset1, size, snapshot2);
1020       } else if (state.types1_(block1, frag1) != nullptr) {
1021         new_type1 = get_offset_type(real_addr_frag1, state.types1_(block1, frag1), offset1, size, snapshot1);
1022         new_type2 = get_offset_type(real_addr_frag2, state.types1_(block1, frag1), offset2, size, snapshot2);
1023       } else if (state.types2_(block2, frag2) != nullptr) {
1024         new_type1 = get_offset_type(real_addr_frag1, state.types2_(block2, frag2), offset1, size, snapshot1);
1025         new_type2 = get_offset_type(real_addr_frag2, state.types2_(block2, frag2), offset2, size, snapshot2);
1026       } else {
1027         if (match_pairs)
1028           state.match_equals(previous);
1029         return -1;
1030       }
1031
1032       if (new_type1 != nullptr && new_type2 != nullptr && new_type1 != new_type2) {
1033
1034         type = new_type1;
1035         while (type->byte_size == 0 && type->subtype != nullptr)
1036           type = type->subtype;
1037         new_size1 = type->byte_size;
1038
1039         type = new_type2;
1040         while (type->byte_size == 0 && type->subtype != nullptr)
1041           type = type->subtype;
1042         new_size2 = type->byte_size;
1043
1044       } else {
1045         if (match_pairs)
1046           state.match_equals(previous);
1047         return -1;
1048       }
1049     }
1050
1051     if (new_size1 > 0 && new_size1 == new_size2) {
1052       type = new_type1;
1053       size = new_size1;
1054     }
1055
1056     if (offset1 == 0 && offset2 == 0 &&
1057         not previous->insert(simgrid::mc::makeHeapLocationPair(block1, frag1, block2, frag2)).second) {
1058       if (match_pairs)
1059         state.match_equals(previous);
1060       return 0;
1061     }
1062
1063     if (size <= 0) {
1064       if (match_pairs)
1065         state.match_equals(previous);
1066       return 0;
1067     }
1068
1069     if ((heapinfo1->busy_frag.ignore[frag1] > 0) &&
1070         (heapinfo2->busy_frag.ignore[frag2] == heapinfo1->busy_frag.ignore[frag1]))
1071       check_ignore = heapinfo1->busy_frag.ignore[frag1];
1072
1073   } else
1074     return 1;
1075
1076
1077   /* Start comparison */
1078   int res_compare;
1079   if (type)
1080     res_compare = compare_heap_area_with_type(state, area1, area2, snapshot1, snapshot2, previous, type, size,
1081                                               check_ignore, pointer_level);
1082   else
1083     res_compare =
1084         not heap_area_equal_without_type(state, area1, area2, snapshot1, snapshot2, previous, size, check_ignore);
1085
1086   if (res_compare == 1)
1087     return res_compare;
1088
1089   if (match_pairs)
1090     state.match_equals(previous);
1091   return 0;
1092 }
1093
1094 }
1095 }
1096
1097 /************************** Snapshot comparison *******************************/
1098 /******************************************************************************/
1099
1100 static int compare_areas_with_type(simgrid::mc::StateComparator& state, void* real_area1,
1101                                    simgrid::mc::Snapshot* snapshot1, simgrid::mc::Region* region1, void* real_area2,
1102                                    simgrid::mc::Snapshot* snapshot2, simgrid::mc::Region* region2,
1103                                    simgrid::mc::Type* type, int pointer_level)
1104 {
1105   simgrid::mc::RemoteClient* process = &mc_model_checker->process();
1106
1107   simgrid::mc::Type* subtype;
1108   simgrid::mc::Type* subsubtype;
1109   int elm_size;
1110   int i;
1111   int res;
1112
1113   xbt_assert(type != nullptr);
1114   switch (type->type) {
1115     case DW_TAG_unspecified_type:
1116       return 1;
1117
1118     case DW_TAG_base_type:
1119     case DW_TAG_enumeration_type:
1120     case DW_TAG_union_type:
1121       return MC_snapshot_region_memcmp(real_area1, region1, real_area2, region2, type->byte_size) != 0;
1122     case DW_TAG_typedef:
1123     case DW_TAG_volatile_type:
1124     case DW_TAG_const_type:
1125       return compare_areas_with_type(state, real_area1, snapshot1, region1, real_area2, snapshot2, region2,
1126                                      type->subtype, pointer_level);
1127     case DW_TAG_array_type:
1128       subtype = type->subtype;
1129       switch (subtype->type) {
1130         case DW_TAG_unspecified_type:
1131           return 1;
1132
1133         case DW_TAG_base_type:
1134         case DW_TAG_enumeration_type:
1135         case DW_TAG_pointer_type:
1136         case DW_TAG_reference_type:
1137         case DW_TAG_rvalue_reference_type:
1138         case DW_TAG_structure_type:
1139         case DW_TAG_class_type:
1140         case DW_TAG_union_type:
1141           if (subtype->full_type)
1142             subtype = subtype->full_type;
1143           elm_size  = subtype->byte_size;
1144           break;
1145         case DW_TAG_const_type:
1146         case DW_TAG_typedef:
1147         case DW_TAG_volatile_type:
1148           subsubtype = subtype->subtype;
1149           if (subsubtype->full_type)
1150             subsubtype = subsubtype->full_type;
1151           elm_size     = subsubtype->byte_size;
1152           break;
1153         default:
1154           return 0;
1155       }
1156       for (i = 0; i < type->element_count; i++) {
1157         size_t off = i * elm_size;
1158         res = compare_areas_with_type(state, (char*)real_area1 + off, snapshot1, region1, (char*)real_area2 + off,
1159                                       snapshot2, region2, type->subtype, pointer_level);
1160         if (res == 1)
1161           return res;
1162       }
1163       break;
1164     case DW_TAG_pointer_type:
1165     case DW_TAG_reference_type:
1166     case DW_TAG_rvalue_reference_type: {
1167       void* addr_pointed1 = MC_region_read_pointer(region1, real_area1);
1168       void* addr_pointed2 = MC_region_read_pointer(region2, real_area2);
1169
1170       if (type->subtype && type->subtype->type == DW_TAG_subroutine_type)
1171         return (addr_pointed1 != addr_pointed2);
1172       if (addr_pointed1 == nullptr && addr_pointed2 == nullptr)
1173         return 0;
1174       if (addr_pointed1 == nullptr || addr_pointed2 == nullptr)
1175         return 1;
1176       if (not state.compared_pointers.insert(std::make_pair(addr_pointed1, addr_pointed2)).second)
1177         return 0;
1178
1179       pointer_level++;
1180
1181       // Some cases are not handled here:
1182       // * the pointers lead to different areas (one to the heap, the other to the RW segment ...)
1183       // * a pointer leads to the read-only segment of the current object
1184       // * a pointer lead to a different ELF object
1185
1186       if (addr_pointed1 > process->heap_address && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)) {
1187         if (not(addr_pointed2 > process->heap_address && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
1188           return 1;
1189         // The pointers are both in the heap:
1190         return simgrid::mc::compare_heap_area(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, nullptr,
1191                                               type->subtype, pointer_level);
1192
1193       } else if (region1->contain(simgrid::mc::remote(addr_pointed1))) {
1194         // The pointers are both in the current object R/W segment:
1195         if (not region2->contain(simgrid::mc::remote(addr_pointed2)))
1196           return 1;
1197         if (not type->type_id)
1198           return (addr_pointed1 != addr_pointed2);
1199         else
1200           return compare_areas_with_type(state, addr_pointed1, snapshot1, region1, addr_pointed2, snapshot2, region2,
1201                                          type->subtype, pointer_level);
1202       } else {
1203
1204         // TODO, We do not handle very well the case where
1205         // it belongs to a different (non-heap) region from the current one.
1206
1207         return (addr_pointed1 != addr_pointed2);
1208       }
1209     }
1210     case DW_TAG_structure_type:
1211     case DW_TAG_class_type:
1212       for (simgrid::mc::Member& member : type->members) {
1213         void* member1                   = simgrid::dwarf::resolve_member(real_area1, type, &member, snapshot1);
1214         void* member2                   = simgrid::dwarf::resolve_member(real_area2, type, &member, snapshot2);
1215         simgrid::mc::Region* subregion1 = snapshot1->get_region(member1, region1); // region1 is hinted
1216         simgrid::mc::Region* subregion2 = snapshot2->get_region(member2, region2); // region2 is hinted
1217         res = compare_areas_with_type(state, member1, snapshot1, subregion1, member2, snapshot2, subregion2,
1218                                       member.type, pointer_level);
1219         if (res == 1)
1220           return res;
1221       }
1222       break;
1223     case DW_TAG_subroutine_type:
1224       return -1;
1225     default:
1226       XBT_VERB("Unknown case: %d", type->type);
1227       break;
1228   }
1229
1230   return 0;
1231 }
1232
1233 static bool global_variables_equal(simgrid::mc::StateComparator& state, simgrid::mc::ObjectInformation* object_info,
1234                                    simgrid::mc::Region* r1, simgrid::mc::Region* r2, simgrid::mc::Snapshot* snapshot1,
1235                                    simgrid::mc::Snapshot* snapshot2)
1236 {
1237   xbt_assert(r1 && r2, "Missing region.");
1238
1239   std::vector<simgrid::mc::Variable>& variables = object_info->global_variables;
1240
1241   for (simgrid::mc::Variable const& current_var : variables) {
1242
1243     // If the variable is not in this object, skip it:
1244     // We do not expect to find a pointer to something which is not reachable
1245     // by the global variables.
1246     if ((char *) current_var.address < (char *) object_info->start_rw
1247         || (char *) current_var.address > (char *) object_info->end_rw)
1248       continue;
1249
1250     simgrid::mc::Type* bvariable_type = current_var.type;
1251     int res = compare_areas_with_type(state, (char*)current_var.address, snapshot1, r1, (char*)current_var.address,
1252                                       snapshot2, r2, bvariable_type, 0);
1253     if (res == 1) {
1254       XBT_VERB("Global variable %s (%p) is different between snapshots",
1255                current_var.name.c_str(),
1256                (char *) current_var.address);
1257       return false;
1258     }
1259   }
1260
1261   return true;
1262 }
1263
1264 static bool local_variables_equal(simgrid::mc::StateComparator& state, simgrid::mc::Snapshot* snapshot1,
1265                                   simgrid::mc::Snapshot* snapshot2, mc_snapshot_stack_t stack1,
1266                                   mc_snapshot_stack_t stack2)
1267 {
1268   if (stack1->local_variables.size() != stack2->local_variables.size()) {
1269     XBT_VERB("Different number of local variables");
1270     return false;
1271   }
1272
1273   for (unsigned int cursor = 0; cursor < stack1->local_variables.size(); cursor++) {
1274     local_variable_t current_var1 = &stack1->local_variables[cursor];
1275     local_variable_t current_var2 = &stack2->local_variables[cursor];
1276     if (current_var1->name != current_var2->name || current_var1->subprogram != current_var2->subprogram ||
1277         current_var1->ip != current_var2->ip) {
1278       // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
1279       XBT_VERB("Different name of variable (%s - %s) "
1280                "or frame (%s - %s) or ip (%lu - %lu)",
1281                current_var1->name.c_str(), current_var2->name.c_str(), current_var1->subprogram->name.c_str(),
1282                current_var2->subprogram->name.c_str(), current_var1->ip, current_var2->ip);
1283       return false;
1284     }
1285
1286     if (compare_areas_with_type(state, current_var1->address, snapshot1, snapshot1->get_region(current_var1->address),
1287                                 current_var2->address, snapshot2, snapshot2->get_region(current_var2->address),
1288                                 current_var1->type, 0) == 1) {
1289       XBT_VERB("Local variable %s (%p - %p) in frame %s "
1290                "is different between snapshots",
1291                current_var1->name.c_str(), current_var1->address, current_var2->address,
1292                current_var1->subprogram->name.c_str());
1293       return false;
1294     }
1295     }
1296     return true;
1297 }
1298
1299 namespace simgrid {
1300 namespace mc {
1301
1302 static std::unique_ptr<simgrid::mc::StateComparator> state_comparator;
1303
1304 bool snapshot_equal(Snapshot* s1, Snapshot* s2)
1305 {
1306   // TODO, make this a field of ModelChecker or something similar
1307   if (state_comparator == nullptr)
1308     state_comparator.reset(new StateComparator());
1309   else
1310     state_comparator->clear();
1311
1312   RemoteClient* process = &mc_model_checker->process();
1313
1314   if (s1->hash_ != s2->hash_) {
1315     XBT_VERB("(%d - %d) Different hash: 0x%" PRIx64 "--0x%" PRIx64, s1->num_state_, s2->num_state_, s1->hash_,
1316              s2->hash_);
1317     return false;
1318     } else
1319       XBT_VERB("(%d - %d) Same hash: 0x%" PRIx64, s1->num_state_, s2->num_state_, s1->hash_);
1320
1321   /* Compare enabled processes */
1322   if (s1->enabled_processes_ != s2->enabled_processes_) {
1323     XBT_VERB("(%d - %d) Different amount of enabled processes", s1->num_state_, s2->num_state_);
1324     return false;
1325   }
1326
1327   /* Compare size of stacks */
1328   for (unsigned long i = 0; i < s1->stacks_.size(); i++) {
1329     size_t size_used1 = s1->stack_sizes_[i];
1330     size_t size_used2 = s2->stack_sizes_[i];
1331     if (size_used1 != size_used2) {
1332       XBT_VERB("(%d - %d) Different size used in stacks: %zu - %zu", s1->num_state_, s2->num_state_, size_used1,
1333                size_used2);
1334       return false;
1335     }
1336   }
1337
1338   /* Init heap information used in heap comparison algorithm */
1339   xbt_mheap_t heap1 = (xbt_mheap_t)s1->read_bytes(alloca(sizeof(struct mdesc)), sizeof(struct mdesc),
1340                                                   remote(process->heap_address), simgrid::mc::ReadOptions::lazy());
1341   xbt_mheap_t heap2 = (xbt_mheap_t)s2->read_bytes(alloca(sizeof(struct mdesc)), sizeof(struct mdesc),
1342                                                   remote(process->heap_address), simgrid::mc::ReadOptions::lazy());
1343   int res_init = state_comparator->initHeapInformation(heap1, heap2, &s1->to_ignore_, &s2->to_ignore_);
1344
1345   if (res_init == -1) {
1346     XBT_VERB("(%d - %d) Different heap information", s1->num_state_, s2->num_state_);
1347     return false;
1348   }
1349
1350   /* Stacks comparison */
1351   for (unsigned int cursor = 0; cursor < s1->stacks_.size(); cursor++) {
1352     mc_snapshot_stack_t stack1 = &s1->stacks_[cursor];
1353     mc_snapshot_stack_t stack2 = &s2->stacks_[cursor];
1354
1355     if (not local_variables_equal(*state_comparator, s1, s2, stack1, stack2)) {
1356       XBT_VERB("(%d - %d) Different local variables between stacks %u", s1->num_state_, s2->num_state_, cursor + 1);
1357       return false;
1358     }
1359   }
1360
1361   size_t regions_count = s1->snapshot_regions_.size();
1362   if (regions_count != s2->snapshot_regions_.size())
1363     return false;
1364
1365   for (size_t k = 0; k != regions_count; ++k) {
1366     Region* region1 = s1->snapshot_regions_[k].get();
1367     Region* region2 = s2->snapshot_regions_[k].get();
1368
1369     // Preconditions:
1370     if (region1->region_type() != RegionType::Data)
1371       continue;
1372
1373     xbt_assert(region1->region_type() == region2->region_type());
1374     xbt_assert(region1->object_info() == region2->object_info());
1375     xbt_assert(region1->object_info());
1376
1377     /* Compare global variables */
1378     if (not global_variables_equal(*state_comparator, region1->object_info(), region1, region2, s1, s2)) {
1379       std::string const& name = region1->object_info()->file_name;
1380       XBT_VERB("(%d - %d) Different global variables in %s", s1->num_state_, s2->num_state_, name.c_str());
1381       return false;
1382     }
1383   }
1384
1385   /* Compare heap */
1386   if (not mmalloc_heap_equal(*state_comparator, s1, s2)) {
1387     XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", s1->num_state_, s2->num_state_);
1388     return false;
1389   }
1390
1391     XBT_VERB("(%d - %d) No difference found", s1->num_state_, s2->num_state_);
1392
1393     return true;
1394 }
1395
1396 }
1397 }