Logo AND Algorithmique Numérique Distribuée

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