Logo AND Algorithmique Numérique Distribuée

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