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