Logo AND Algorithmique Numérique Distribuée

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