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