Logo AND Algorithmique Numérique Distribuée

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