1 /* Copyright (c) 2008-2019. The SimGrid Team. All rights reserved. */
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. */
6 /** \file compare.cpp Memory snapshooting and comparison */
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"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, xbt, "Logging specific to mc_compare in mc");
15 using simgrid::mc::remote;
20 /*********************************** Heap comparison ***********************************/
21 /***************************************************************************************/
28 HeapLocation() = default;
29 HeapLocation(int block, int fragment = 0) : block_(block), fragment_(fragment) {}
31 bool operator==(HeapLocation const& that) const
33 return block_ == that.block_ && fragment_ == that.fragment_;
35 bool operator<(HeapLocation const& that) const
37 return std::make_pair(block_, fragment_) < std::make_pair(that.block_, that.fragment_);
41 typedef std::array<HeapLocation, 2> HeapLocationPair;
42 typedef std::set<HeapLocationPair> HeapLocationPairs;
44 class HeapArea : public HeapLocation {
48 explicit HeapArea(int block) : valid_(true) { block_ = block; }
49 HeapArea(int block, int fragment) : valid_(true)
56 class ProcessComparisonState {
58 const std::vector<simgrid::mc::IgnoredHeapRegion>* to_ignore = nullptr;
59 std::vector<HeapArea> equals_to;
60 std::vector<simgrid::mc::Type*> types;
61 std::size_t heapsize = 0;
63 void initHeapInformation(xbt_mheap_t heap, const std::vector<simgrid::mc::IgnoredHeapRegion>& i);
66 class StateComparator {
68 s_xbt_mheap_t std_heap_copy;
69 std::size_t heaplimit;
70 std::array<ProcessComparisonState, 2> processStates;
72 std::unordered_set<std::pair<const void*, const void*>, simgrid::xbt::hash<std::pair<const void*, const void*>>>
77 compared_pointers.clear();
80 int initHeapInformation(xbt_mheap_t heap1, xbt_mheap_t heap2, const std::vector<simgrid::mc::IgnoredHeapRegion>& i1,
81 const std::vector<simgrid::mc::IgnoredHeapRegion>& i2);
83 template <int rank> HeapArea& equals_to_(std::size_t i, std::size_t j)
85 return processStates[rank - 1].equals_to[MAX_FRAGMENT_PER_BLOCK * i + j];
87 template <int rank> Type*& types_(std::size_t i, std::size_t j)
89 return processStates[rank - 1].types[MAX_FRAGMENT_PER_BLOCK * i + j];
92 template <int rank> HeapArea const& equals_to_(std::size_t i, std::size_t j) const
94 return processStates[rank - 1].equals_to[MAX_FRAGMENT_PER_BLOCK * i + j];
96 template <int rank> Type* const& types_(std::size_t i, std::size_t j) const
98 return processStates[rank - 1].types[MAX_FRAGMENT_PER_BLOCK * i + j];
101 /** Check whether two blocks are known to be matching
103 * @param b1 Block of state 1
104 * @param b2 Block of state 2
105 * @return if the blocks are known to be matching
107 bool blocksEqual(int b1, int b2) const
109 return this->equals_to_<1>(b1, 0).block_ == b2 && this->equals_to_<2>(b2, 0).block_ == b1;
112 /** Check whether two fragments are known to be matching
114 * @param b1 Block of state 1
115 * @param f1 Fragment of state 1
116 * @param b2 Block of state 2
117 * @param f2 Fragment of state 2
118 * @return if the fragments are known to be matching
120 int fragmentsEqual(int b1, int f1, int b2, int f2) const
122 return this->equals_to_<1>(b1, f1).block_ == b2 && this->equals_to_<1>(b1, f1).fragment_ == f2 &&
123 this->equals_to_<2>(b2, f2).block_ == b1 && this->equals_to_<2>(b2, f2).fragment_ == f1;
126 void match_equals(HeapLocationPairs* list);
132 /************************************************************************************/
134 static ssize_t heap_comparison_ignore_size(const std::vector<simgrid::mc::IgnoredHeapRegion>* ignore_list,
138 int end = ignore_list->size() - 1;
140 while (start <= end) {
141 unsigned int cursor = (start + end) / 2;
142 simgrid::mc::IgnoredHeapRegion const& region = (*ignore_list)[cursor];
143 if (region.address == address)
145 if (region.address < address)
147 if (region.address > address)
154 static bool is_on_heap(const void* address)
156 const xbt_mheap_t heap = mc_model_checker->process().get_heap();
157 return address >= heap->heapbase && address < heap->breakval;
160 static bool is_stack(const void *address)
162 for (auto const& stack : mc_model_checker->process().stack_areas())
163 if (address == stack.address)
168 // TODO, this should depend on the snapshot?
169 static bool is_block_stack(int block)
171 for (auto const& stack : mc_model_checker->process().stack_areas())
172 if (block == stack.block)
180 void StateComparator::match_equals(HeapLocationPairs* list)
182 for (auto const& pair : *list) {
183 if (pair[0].fragment_ != -1) {
184 this->equals_to_<1>(pair[0].block_, pair[0].fragment_) = simgrid::mc::HeapArea(pair[1].block_, pair[1].fragment_);
185 this->equals_to_<2>(pair[1].block_, pair[1].fragment_) = simgrid::mc::HeapArea(pair[0].block_, pair[0].fragment_);
187 this->equals_to_<1>(pair[0].block_, 0) = simgrid::mc::HeapArea(pair[1].block_, pair[1].fragment_);
188 this->equals_to_<2>(pair[1].block_, 0) = simgrid::mc::HeapArea(pair[0].block_, pair[0].fragment_);
193 void ProcessComparisonState::initHeapInformation(xbt_mheap_t heap, const std::vector<simgrid::mc::IgnoredHeapRegion>& i)
195 auto heaplimit = heap->heaplimit;
196 this->heapsize = heap->heapsize;
197 this->to_ignore = &i;
198 this->equals_to.assign(heaplimit * MAX_FRAGMENT_PER_BLOCK, HeapArea());
199 this->types.assign(heaplimit * MAX_FRAGMENT_PER_BLOCK, nullptr);
202 int StateComparator::initHeapInformation(xbt_mheap_t heap1, xbt_mheap_t heap2,
203 const std::vector<simgrid::mc::IgnoredHeapRegion>& i1,
204 const std::vector<simgrid::mc::IgnoredHeapRegion>& i2)
206 if ((heap1->heaplimit != heap2->heaplimit) || (heap1->heapsize != heap2->heapsize))
208 this->heaplimit = heap1->heaplimit;
209 this->std_heap_copy = *mc_model_checker->process().get_heap();
210 this->processStates[0].initHeapInformation(heap1, i1);
211 this->processStates[1].initHeapInformation(heap2, i2);
215 // TODO, have a robust way to find it in O(1)
216 static inline Region* MC_get_heap_region(const Snapshot& snapshot)
218 for (auto const& region : snapshot.snapshot_regions_)
219 if (region->region_type() == simgrid::mc::RegionType::Heap)
221 xbt_die("No heap region");
224 static bool heap_area_differ(StateComparator& state, const void* area1, const void* area2, const Snapshot& snapshot1,
225 const Snapshot& snapshot2, HeapLocationPairs* previous, Type* type, int pointer_level);
227 static bool mmalloc_heap_differ(simgrid::mc::StateComparator& state, const simgrid::mc::Snapshot& snapshot1,
228 const simgrid::mc::Snapshot& snapshot2)
230 const simgrid::mc::RemoteClient& process = mc_model_checker->process();
232 /* Check busy blocks */
235 malloc_info heapinfo_temp1;
236 malloc_info heapinfo_temp2;
237 malloc_info heapinfo_temp2b;
239 simgrid::mc::Region* heap_region1 = MC_get_heap_region(snapshot1);
240 simgrid::mc::Region* heap_region2 = MC_get_heap_region(snapshot2);
242 // This is the address of std_heap->heapinfo in the application process:
243 void* heapinfo_address = &((xbt_mheap_t)process.heap_address)->heapinfo;
245 // This is in snapshot do not use them directly:
246 const malloc_info* heapinfos1 =
247 snapshot1.read<malloc_info*>(RemotePtr<malloc_info*>((std::uint64_t)heapinfo_address));
248 const malloc_info* heapinfos2 =
249 snapshot2.read<malloc_info*>(RemotePtr<malloc_info*>((std::uint64_t)heapinfo_address));
251 while (i1 < state.heaplimit) {
253 const malloc_info* heapinfo1 =
254 (const malloc_info*)heap_region1->read(&heapinfo_temp1, &heapinfos1[i1], sizeof(malloc_info));
255 const malloc_info* heapinfo2 =
256 (const malloc_info*)heap_region2->read(&heapinfo_temp2, &heapinfos2[i1], sizeof(malloc_info));
258 if (heapinfo1->type == MMALLOC_TYPE_FREE || heapinfo1->type == MMALLOC_TYPE_HEAPINFO) { /* Free block */
263 if (heapinfo1->type < 0) {
264 fprintf(stderr, "Unkown mmalloc block type.\n");
268 void* addr_block1 = ((void*)(((ADDR2UINT(i1)) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase));
270 if (heapinfo1->type == MMALLOC_TYPE_UNFRAGMENTED) { /* Large block */
272 if (is_stack(addr_block1)) {
273 for (size_t k = 0; k < heapinfo1->busy_block.size; k++)
274 state.equals_to_<1>(i1 + k, 0) = HeapArea(i1, -1);
275 for (size_t k = 0; k < heapinfo2->busy_block.size; k++)
276 state.equals_to_<2>(i1 + k, 0) = HeapArea(i1, -1);
277 i1 += heapinfo1->busy_block.size;
281 if (state.equals_to_<1>(i1, 0).valid_) {
289 /* Try first to associate to same block in the other heap */
290 if (heapinfo2->type == heapinfo1->type && state.equals_to_<2>(i1, 0).valid_ == 0) {
291 void* addr_block2 = (ADDR2UINT(i1) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
292 if (not heap_area_differ(state, addr_block1, addr_block2, snapshot1, snapshot2, nullptr, nullptr, 0)) {
293 for (size_t k = 1; k < heapinfo2->busy_block.size; k++)
294 state.equals_to_<2>(i1 + k, 0) = HeapArea(i1, -1);
295 for (size_t k = 1; k < heapinfo1->busy_block.size; k++)
296 state.equals_to_<1>(i1 + k, 0) = HeapArea(i1, -1);
298 i1 += heapinfo1->busy_block.size;
302 while (i2 < state.heaplimit && not equal) {
304 void* addr_block2 = (ADDR2UINT(i2) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
311 const malloc_info* heapinfo2b =
312 (const malloc_info*)heap_region2->read(&heapinfo_temp2b, &heapinfos2[i2], sizeof(malloc_info));
314 if (heapinfo2b->type != MMALLOC_TYPE_UNFRAGMENTED) {
319 if (state.equals_to_<2>(i2, 0).valid_) {
324 if (not heap_area_differ(state, addr_block1, addr_block2, snapshot1, snapshot2, nullptr, nullptr, 0)) {
325 for (size_t k = 1; k < heapinfo2b->busy_block.size; k++)
326 state.equals_to_<2>(i2 + k, 0) = HeapArea(i1, -1);
327 for (size_t k = 1; k < heapinfo1->busy_block.size; k++)
328 state.equals_to_<1>(i1 + k, 0) = HeapArea(i2, -1);
330 i1 += heapinfo1->busy_block.size;
337 XBT_DEBUG("Block %zu not found (size_used = %zu, addr = %p)", i1, heapinfo1->busy_block.busy_size, addr_block1);
341 } else { /* Fragmented block */
343 for (size_t j1 = 0; j1 < (size_t)(BLOCKSIZE >> heapinfo1->type); j1++) {
345 if (heapinfo1->busy_frag.frag_size[j1] == -1) /* Free fragment_ */
348 if (state.equals_to_<1>(i1, j1).valid_)
351 void* addr_frag1 = (void*)((char*)addr_block1 + (j1 << heapinfo1->type));
356 /* Try first to associate to same fragment_ in the other heap */
357 if (heapinfo2->type == heapinfo1->type && not state.equals_to_<2>(i1, j1).valid_) {
358 void* addr_block2 = (ADDR2UINT(i1) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
359 void* addr_frag2 = (void*)((char*)addr_block2 + (j1 << heapinfo2->type));
360 if (not heap_area_differ(state, addr_frag1, addr_frag2, snapshot1, snapshot2, nullptr, nullptr, 0))
364 while (i2 < state.heaplimit && not equal) {
366 const malloc_info* heapinfo2b =
367 (const malloc_info*)heap_region2->read(&heapinfo_temp2b, &heapinfos2[i2], sizeof(malloc_info));
369 if (heapinfo2b->type == MMALLOC_TYPE_FREE || heapinfo2b->type == MMALLOC_TYPE_HEAPINFO) {
374 // We currently do not match fragments with unfragmented blocks (maybe we should).
375 if (heapinfo2b->type == MMALLOC_TYPE_UNFRAGMENTED) {
380 if (heapinfo2b->type < 0) {
381 fprintf(stderr, "Unknown mmalloc block type.\n");
385 for (size_t j2 = 0; j2 < (size_t)(BLOCKSIZE >> heapinfo2b->type); j2++) {
387 if (i2 == i1 && j2 == j1)
390 if (state.equals_to_<2>(i2, j2).valid_)
393 void* addr_block2 = (ADDR2UINT(i2) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
394 void* addr_frag2 = (void*)((char*)addr_block2 + (j2 << heapinfo2b->type));
396 if (not heap_area_differ(state, addr_frag1, addr_frag2, snapshot1, snapshot2, nullptr, nullptr, 0)) {
406 XBT_DEBUG("Block %zu, fragment_ %zu not found (size_used = %zd, address = %p)\n", i1, j1,
407 heapinfo1->busy_frag.frag_size[j1], addr_frag1);
416 /* All blocks/fragments are equal to another block/fragment_ ? */
417 for (size_t i = 1; i < state.heaplimit; i++) {
418 const malloc_info* heapinfo1 =
419 (const malloc_info*)heap_region1->read(&heapinfo_temp1, &heapinfos1[i], sizeof(malloc_info));
421 if (heapinfo1->type == MMALLOC_TYPE_UNFRAGMENTED && i1 == state.heaplimit && heapinfo1->busy_block.busy_size > 0 &&
422 not state.equals_to_<1>(i, 0).valid_) {
423 XBT_DEBUG("Block %zu not found (size used = %zu)", i, heapinfo1->busy_block.busy_size);
427 if (heapinfo1->type <= 0)
429 for (size_t j = 0; j < (size_t)(BLOCKSIZE >> heapinfo1->type); j++)
430 if (i1 == state.heaplimit && heapinfo1->busy_frag.frag_size[j] > 0 && not state.equals_to_<1>(i, j).valid_) {
431 XBT_DEBUG("Block %zu, Fragment %zu not found (size used = %zd)", i, j, heapinfo1->busy_frag.frag_size[j]);
436 for (size_t i = 1; i < state.heaplimit; i++) {
437 const malloc_info* heapinfo2 =
438 (const malloc_info*)heap_region2->read(&heapinfo_temp2, &heapinfos2[i], sizeof(malloc_info));
439 if (heapinfo2->type == MMALLOC_TYPE_UNFRAGMENTED && i1 == state.heaplimit && heapinfo2->busy_block.busy_size > 0 &&
440 not state.equals_to_<2>(i, 0).valid_) {
441 XBT_DEBUG("Block %zu not found (size used = %zu)", i,
442 heapinfo2->busy_block.busy_size);
446 if (heapinfo2->type <= 0)
449 for (size_t j = 0; j < (size_t)(BLOCKSIZE >> heapinfo2->type); j++)
450 if (i1 == state.heaplimit && heapinfo2->busy_frag.frag_size[j] > 0 && not state.equals_to_<2>(i, j).valid_) {
451 XBT_DEBUG("Block %zu, Fragment %zu not found (size used = %zd)",
452 i, j, heapinfo2->busy_frag.frag_size[j]);
463 * @param real_area1 Process address for state 1
464 * @param real_area2 Process address for state 2
465 * @param snapshot1 Snapshot of state 1
466 * @param snapshot2 Snapshot of state 2
469 * @param check_ignore
470 * @return true when different, false otherwise (same or unknown)
472 static bool heap_area_differ_without_type(simgrid::mc::StateComparator& state, const void* real_area1,
473 const void* real_area2, const simgrid::mc::Snapshot& snapshot1,
474 const simgrid::mc::Snapshot& snapshot2, HeapLocationPairs* previous, int size,
477 const simgrid::mc::RemoteClient& process = mc_model_checker->process();
478 simgrid::mc::Region* heap_region1 = MC_get_heap_region(snapshot1);
479 simgrid::mc::Region* heap_region2 = MC_get_heap_region(snapshot2);
481 for (int i = 0; i < size; ) {
483 if (check_ignore > 0) {
484 ssize_t ignore1 = heap_comparison_ignore_size(state.processStates[0].to_ignore, (const char*)real_area1 + i);
486 ssize_t ignore2 = heap_comparison_ignore_size(state.processStates[1].to_ignore, (const char*)real_area2 + i);
487 if (ignore2 == ignore1) {
500 if (MC_snapshot_region_memcmp((const char*)real_area1 + i, heap_region1, (const char*)real_area2 + i, heap_region2,
503 int pointer_align = (i / sizeof(void *)) * sizeof(void *);
504 const void* addr_pointed1 = snapshot1.read(remote((void**)((const char*)real_area1 + pointer_align)));
505 const void* addr_pointed2 = snapshot2.read(remote((void**)((const char*)real_area2 + pointer_align)));
507 if (process.in_maestro_stack(remote(addr_pointed1)) && process.in_maestro_stack(remote(addr_pointed2))) {
508 i = pointer_align + sizeof(void *);
512 if (is_on_heap(addr_pointed1) && is_on_heap(addr_pointed2)) {
513 // Both addresses are in the heap:
514 if (heap_area_differ(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, previous, nullptr, 0))
516 i = pointer_align + sizeof(void *);
532 * @param real_area1 Process address for state 1
533 * @param real_area2 Process address for state 2
534 * @param snapshot1 Snapshot of state 1
535 * @param snapshot2 Snapshot of state 2
538 * @param area_size either a byte_size or an elements_count (?)
539 * @param check_ignore
540 * @param pointer_level
541 * @return true when different, false otherwise (same or unknown)
543 static bool heap_area_differ_with_type(simgrid::mc::StateComparator& state, const void* real_area1,
544 const void* real_area2, const simgrid::mc::Snapshot& snapshot1,
545 const simgrid::mc::Snapshot& snapshot2, HeapLocationPairs* previous,
546 simgrid::mc::Type* type, int area_size, int check_ignore, int pointer_level)
548 // HACK: This should not happen but in pratice, there are some
549 // DW_TAG_typedef without an associated DW_AT_type:
550 //<1><538832>: Abbrev Number: 111 (DW_TAG_typedef)
551 // <538833> DW_AT_name : (indirect string, offset: 0x2292f3): gregset_t
552 // <538837> DW_AT_decl_file : 98
553 // <538838> DW_AT_decl_line : 37
557 if (is_stack(real_area1) && is_stack(real_area2))
560 if (check_ignore > 0) {
561 ssize_t ignore1 = heap_comparison_ignore_size(state.processStates[0].to_ignore, real_area1);
562 if (ignore1 > 0 && heap_comparison_ignore_size(state.processStates[1].to_ignore, real_area2) == ignore1)
566 simgrid::mc::Type* subtype;
567 simgrid::mc::Type* subsubtype;
569 const void* addr_pointed1;
570 const void* addr_pointed2;
572 simgrid::mc::Region* heap_region1 = MC_get_heap_region(snapshot1);
573 simgrid::mc::Region* heap_region2 = MC_get_heap_region(snapshot2);
575 switch (type->type) {
576 case DW_TAG_unspecified_type:
579 case DW_TAG_base_type:
580 if (not type->name.empty() && type->name == "char") { /* String, hence random (arbitrary ?) size */
581 if (real_area1 == real_area2)
584 return MC_snapshot_region_memcmp(real_area1, heap_region1, real_area2, heap_region2, area_size) != 0;
586 if (area_size != -1 && type->byte_size != area_size)
589 return MC_snapshot_region_memcmp(real_area1, heap_region1, real_area2, heap_region2, type->byte_size) != 0;
592 case DW_TAG_enumeration_type:
593 if (area_size != -1 && type->byte_size != area_size)
595 return MC_snapshot_region_memcmp(real_area1, heap_region1, real_area2, heap_region2, type->byte_size) != 0;
598 case DW_TAG_const_type:
599 case DW_TAG_volatile_type:
600 return heap_area_differ_with_type(state, real_area1, real_area2, snapshot1, snapshot2, previous, type->subtype,
601 area_size, check_ignore, pointer_level);
603 case DW_TAG_array_type:
604 subtype = type->subtype;
605 switch (subtype->type) {
606 case DW_TAG_unspecified_type:
609 case DW_TAG_base_type:
610 case DW_TAG_enumeration_type:
611 case DW_TAG_pointer_type:
612 case DW_TAG_reference_type:
613 case DW_TAG_rvalue_reference_type:
614 case DW_TAG_structure_type:
615 case DW_TAG_class_type:
616 case DW_TAG_union_type:
617 if (subtype->full_type)
618 subtype = subtype->full_type;
619 elm_size = subtype->byte_size;
621 // TODO, just remove the type indirection?
622 case DW_TAG_const_type:
624 case DW_TAG_volatile_type:
625 subsubtype = subtype->subtype;
626 if (subsubtype->full_type)
627 subsubtype = subsubtype->full_type;
628 elm_size = subsubtype->byte_size;
633 for (int i = 0; i < type->element_count; i++) {
634 // TODO, add support for variable stride (DW_AT_byte_stride)
635 if (heap_area_differ_with_type(state, (const char*)real_area1 + (i * elm_size),
636 (const char*)real_area2 + (i * elm_size), snapshot1, snapshot2, previous,
637 type->subtype, subtype->byte_size, check_ignore, pointer_level))
642 case DW_TAG_reference_type:
643 case DW_TAG_rvalue_reference_type:
644 case DW_TAG_pointer_type:
645 if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
646 addr_pointed1 = snapshot1.read(remote((void* const*)real_area1));
647 addr_pointed2 = snapshot2.read(remote((void* const*)real_area2));
648 return (addr_pointed1 != addr_pointed2);
651 if (pointer_level <= 1) {
652 addr_pointed1 = snapshot1.read(remote((void* const*)real_area1));
653 addr_pointed2 = snapshot2.read(remote((void* const*)real_area2));
654 if (is_on_heap(addr_pointed1) && is_on_heap(addr_pointed2))
655 return heap_area_differ(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, previous, type->subtype,
658 return (addr_pointed1 != addr_pointed2);
660 for (size_t i = 0; i < (area_size / sizeof(void*)); i++) {
661 addr_pointed1 = snapshot1.read(remote((void* const*)((const char*)real_area1 + i * sizeof(void*))));
662 addr_pointed2 = snapshot2.read(remote((void* const*)((const char*)real_area2 + i * sizeof(void*))));
663 bool differ = is_on_heap(addr_pointed1) && is_on_heap(addr_pointed2)
664 ? heap_area_differ(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, previous,
665 type->subtype, pointer_level)
666 : addr_pointed1 != addr_pointed2;
672 case DW_TAG_structure_type:
673 case DW_TAG_class_type:
675 type = type->full_type;
676 if (area_size != -1 && type->byte_size != area_size) {
677 if (area_size <= type->byte_size || area_size % type->byte_size != 0)
679 for (size_t i = 0; i < (size_t)(area_size / type->byte_size); i++) {
680 if (heap_area_differ_with_type(state, (const char*)real_area1 + i * type->byte_size,
681 (const char*)real_area2 + i * type->byte_size, snapshot1, snapshot2, previous,
682 type, -1, check_ignore, 0))
686 for (simgrid::mc::Member& member : type->members) {
687 // TODO, optimize this? (for the offset case)
688 void* real_member1 = simgrid::dwarf::resolve_member(real_area1, type, &member, &snapshot1);
689 void* real_member2 = simgrid::dwarf::resolve_member(real_area2, type, &member, &snapshot2);
690 if (heap_area_differ_with_type(state, real_member1, real_member2, snapshot1, snapshot2, previous,
691 member.type, -1, check_ignore, 0))
697 case DW_TAG_union_type:
698 return heap_area_differ_without_type(state, real_area1, real_area2, snapshot1, snapshot2, previous,
699 type->byte_size, check_ignore);
702 XBT_VERB("Unknown case: %d", type->type);
708 /** Infer the type of a part of the block from the type of the block
710 * TODO, handle DW_TAG_array_type as well as arrays of the object ((*p)[5], p[5])
712 * TODO, handle subfields ((*p).bar.foo, (*p)[5].bar…)
714 * @param type DWARF type ID of the root address
716 * @return DWARF type ID for given offset
718 static simgrid::mc::Type* get_offset_type(void* real_base_address, simgrid::mc::Type* type, int offset, int area_size,
719 const simgrid::mc::Snapshot& snapshot)
722 // Beginning of the block, the infered variable type if the type of the block:
726 switch (type->type) {
728 case DW_TAG_structure_type:
729 case DW_TAG_class_type:
731 type = type->full_type;
732 if (area_size != -1 && type->byte_size != area_size) {
733 if (area_size > type->byte_size && area_size % type->byte_size == 0)
739 for (simgrid::mc::Member& member : type->members) {
740 if (member.has_offset_location()) {
741 // We have the offset, use it directly (shortcut):
742 if (member.offset() == offset)
745 void* real_member = simgrid::dwarf::resolve_member(real_base_address, type, &member, &snapshot);
746 if ((char*)real_member - (char*)real_base_address == offset)
753 /* FIXME: other cases ? */
761 * @param area1 Process address for state 1
762 * @param area2 Process address for state 2
763 * @param snapshot1 Snapshot of state 1
764 * @param snapshot2 Snapshot of state 2
765 * @param previous Pairs of blocks already compared on the current path (or nullptr)
766 * @param type_id Type of variable
767 * @param pointer_level
768 * @return true when different, false otherwise (same or unknown)
770 static bool heap_area_differ(simgrid::mc::StateComparator& state, const void* area1, const void* area2,
771 const simgrid::mc::Snapshot& snapshot1, const simgrid::mc::Snapshot& snapshot2,
772 HeapLocationPairs* previous, simgrid::mc::Type* type, int pointer_level)
774 const simgrid::mc::RemoteClient& process = mc_model_checker->process();
779 int check_ignore = 0;
787 simgrid::mc::Type* new_type1 = nullptr;
788 simgrid::mc::Type* new_type2 = nullptr;
790 bool match_pairs = false;
792 // This is the address of std_heap->heapinfo in the application process:
793 void* heapinfo_address = &((xbt_mheap_t)process.heap_address)->heapinfo;
795 const malloc_info* heapinfos1 = snapshot1.read(remote((const malloc_info**)heapinfo_address));
796 const malloc_info* heapinfos2 = snapshot2.read(remote((const malloc_info**)heapinfo_address));
798 malloc_info heapinfo_temp1;
799 malloc_info heapinfo_temp2;
801 simgrid::mc::HeapLocationPairs current;
802 if (previous == nullptr) {
808 block1 = ((char*)area1 - (char*)state.std_heap_copy.heapbase) / BLOCKSIZE + 1;
809 block2 = ((char*)area2 - (char*)state.std_heap_copy.heapbase) / BLOCKSIZE + 1;
811 // If either block is a stack block:
812 if (is_block_stack((int) block1) && is_block_stack((int) block2)) {
813 previous->insert(HeapLocationPair{{HeapLocation(block1, -1), HeapLocation(block2, -1)}});
815 state.match_equals(previous);
819 // If either block is not in the expected area of memory:
820 if (((char*)area1 < (char*)state.std_heap_copy.heapbase) || (block1 > (ssize_t)state.processStates[0].heapsize) ||
821 (block1 < 1) || ((char*)area2 < (char*)state.std_heap_copy.heapbase) ||
822 (block2 > (ssize_t)state.processStates[1].heapsize) || (block2 < 1)) {
826 // Process address of the block:
827 void* real_addr_block1 = (ADDR2UINT(block1) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
828 void* real_addr_block2 = (ADDR2UINT(block2) - 1) * BLOCKSIZE + (char*)state.std_heap_copy.heapbase;
832 type = type->full_type;
834 // This assume that for "boring" types (volatile ...) byte_size is absent:
835 while (type->byte_size == 0 && type->subtype != nullptr)
836 type = type->subtype;
839 if (type->type == DW_TAG_pointer_type ||
840 (type->type == DW_TAG_base_type && not type->name.empty() && type->name == "char"))
843 type_size = type->byte_size;
847 simgrid::mc::Region* heap_region1 = MC_get_heap_region(snapshot1);
848 simgrid::mc::Region* heap_region2 = MC_get_heap_region(snapshot2);
850 const malloc_info* heapinfo1 =
851 (const malloc_info*)heap_region1->read(&heapinfo_temp1, &heapinfos1[block1], sizeof(malloc_info));
852 const malloc_info* heapinfo2 =
853 (const malloc_info*)heap_region2->read(&heapinfo_temp2, &heapinfos2[block2], sizeof(malloc_info));
855 if ((heapinfo1->type == MMALLOC_TYPE_FREE || heapinfo1->type==MMALLOC_TYPE_HEAPINFO)
856 && (heapinfo2->type == MMALLOC_TYPE_FREE || heapinfo2->type ==MMALLOC_TYPE_HEAPINFO)) {
859 state.match_equals(previous);
863 if (heapinfo1->type == MMALLOC_TYPE_UNFRAGMENTED && heapinfo2->type == MMALLOC_TYPE_UNFRAGMENTED) {
866 // TODO, lookup variable type from block type as done for fragmented blocks
868 if (state.equals_to_<1>(block1, 0).valid_ && state.equals_to_<2>(block2, 0).valid_ &&
869 state.blocksEqual(block1, block2)) {
871 state.match_equals(previous);
875 if (type_size != -1 && type_size != (ssize_t)heapinfo1->busy_block.busy_size &&
876 type_size != (ssize_t)heapinfo2->busy_block.busy_size &&
877 (type->name.empty() || type->name == "struct s_smx_context")) {
879 state.match_equals(previous);
883 if (heapinfo1->busy_block.size != heapinfo2->busy_block.size ||
884 heapinfo1->busy_block.busy_size != heapinfo2->busy_block.busy_size)
887 if (not previous->insert(HeapLocationPair{{HeapLocation(block1, -1), HeapLocation(block2, -1)}}).second) {
889 state.match_equals(previous);
893 size = heapinfo1->busy_block.busy_size;
895 // Remember (basic) type inference.
896 // The current data structure only allows us to do this for the whole block.
897 if (type != nullptr && area1 == real_addr_block1)
898 state.types_<1>(block1, 0) = type;
899 if (type != nullptr && area2 == real_addr_block2)
900 state.types_<2>(block2, 0) = type;
904 state.match_equals(previous);
908 if (heapinfo1->busy_block.ignore > 0
909 && heapinfo2->busy_block.ignore == heapinfo1->busy_block.ignore)
910 check_ignore = heapinfo1->busy_block.ignore;
912 } else if ((heapinfo1->type > 0) && (heapinfo2->type > 0)) { /* Fragmented block */
915 ssize_t frag1 = ((uintptr_t)(ADDR2UINT(area1) % (BLOCKSIZE))) >> heapinfo1->type;
916 ssize_t frag2 = ((uintptr_t)(ADDR2UINT(area2) % (BLOCKSIZE))) >> heapinfo2->type;
918 // Process address of the fragment_:
919 void* real_addr_frag1 = (void*)((char*)real_addr_block1 + (frag1 << heapinfo1->type));
920 void* real_addr_frag2 = (void*)((char*)real_addr_block2 + (frag2 << heapinfo2->type));
922 // Check the size of the fragments against the size of the type:
923 if (type_size != -1) {
924 if (heapinfo1->busy_frag.frag_size[frag1] == -1 || heapinfo2->busy_frag.frag_size[frag2] == -1) {
926 state.match_equals(previous);
930 if (type_size != heapinfo1->busy_frag.frag_size[frag1]
931 || type_size != heapinfo2->busy_frag.frag_size[frag2]) {
933 state.match_equals(previous);
938 // Check if the blocks are already matched together:
939 if (state.equals_to_<1>(block1, frag1).valid_ && state.equals_to_<2>(block2, frag2).valid_ && offset1 == offset2 &&
940 state.fragmentsEqual(block1, frag1, block2, frag2)) {
942 state.match_equals(previous);
945 // Compare the size of both fragments:
946 if (heapinfo1->busy_frag.frag_size[frag1] != heapinfo2->busy_frag.frag_size[frag2]) {
947 if (type_size == -1) {
949 state.match_equals(previous);
955 // Size of the fragment_:
956 size = heapinfo1->busy_frag.frag_size[frag1];
958 // Remember (basic) type inference.
959 // The current data structure only allows us to do this for the whole fragment_.
960 if (type != nullptr && area1 == real_addr_frag1)
961 state.types_<1>(block1, frag1) = type;
962 if (type != nullptr && area2 == real_addr_frag2)
963 state.types_<2>(block2, frag2) = type;
965 // The type of the variable is already known:
967 new_type1 = new_type2 = type;
969 // Type inference from the block type.
970 else if (state.types_<1>(block1, frag1) != nullptr || state.types_<2>(block2, frag2) != nullptr) {
972 offset1 = (char*)area1 - (char*)real_addr_frag1;
973 offset2 = (char*)area2 - (char*)real_addr_frag2;
975 if (state.types_<1>(block1, frag1) != nullptr && state.types_<2>(block2, frag2) != nullptr) {
976 new_type1 = get_offset_type(real_addr_frag1, state.types_<1>(block1, frag1), offset1, size, snapshot1);
977 new_type2 = get_offset_type(real_addr_frag2, state.types_<2>(block2, frag2), offset1, size, snapshot2);
978 } else if (state.types_<1>(block1, frag1) != nullptr) {
979 new_type1 = get_offset_type(real_addr_frag1, state.types_<1>(block1, frag1), offset1, size, snapshot1);
980 new_type2 = get_offset_type(real_addr_frag2, state.types_<1>(block1, frag1), offset2, size, snapshot2);
981 } else if (state.types_<2>(block2, frag2) != nullptr) {
982 new_type1 = get_offset_type(real_addr_frag1, state.types_<2>(block2, frag2), offset1, size, snapshot1);
983 new_type2 = get_offset_type(real_addr_frag2, state.types_<2>(block2, frag2), offset2, size, snapshot2);
986 state.match_equals(previous);
990 if (new_type1 != nullptr && new_type2 != nullptr && new_type1 != new_type2) {
993 while (type->byte_size == 0 && type->subtype != nullptr)
994 type = type->subtype;
995 new_size1 = type->byte_size;
998 while (type->byte_size == 0 && type->subtype != nullptr)
999 type = type->subtype;
1000 new_size2 = type->byte_size;
1004 state.match_equals(previous);
1009 if (new_size1 > 0 && new_size1 == new_size2) {
1014 if (offset1 == 0 && offset2 == 0 &&
1015 not previous->insert(HeapLocationPair{{HeapLocation(block1, frag1), HeapLocation(block2, frag2)}}).second) {
1017 state.match_equals(previous);
1023 state.match_equals(previous);
1027 if ((heapinfo1->busy_frag.ignore[frag1] > 0) &&
1028 (heapinfo2->busy_frag.ignore[frag2] == heapinfo1->busy_frag.ignore[frag1]))
1029 check_ignore = heapinfo1->busy_frag.ignore[frag1];
1034 /* Start comparison */
1036 type ? heap_area_differ_with_type(state, area1, area2, snapshot1, snapshot2, previous, type, size, check_ignore,
1038 : heap_area_differ_without_type(state, area1, area2, snapshot1, snapshot2, previous, size, check_ignore);
1043 state.match_equals(previous);
1050 /************************** Snapshot comparison *******************************/
1051 /******************************************************************************/
1053 static bool areas_differ_with_type(simgrid::mc::StateComparator& state, const void* real_area1,
1054 const simgrid::mc::Snapshot& snapshot1, simgrid::mc::Region* region1,
1055 const void* real_area2, const simgrid::mc::Snapshot& snapshot2,
1056 simgrid::mc::Region* region2, simgrid::mc::Type* type, int pointer_level)
1058 simgrid::mc::Type* subtype;
1059 simgrid::mc::Type* subsubtype;
1063 xbt_assert(type != nullptr);
1064 switch (type->type) {
1065 case DW_TAG_unspecified_type:
1068 case DW_TAG_base_type:
1069 case DW_TAG_enumeration_type:
1070 case DW_TAG_union_type:
1071 return MC_snapshot_region_memcmp(real_area1, region1, real_area2, region2, type->byte_size) != 0;
1072 case DW_TAG_typedef:
1073 case DW_TAG_volatile_type:
1074 case DW_TAG_const_type:
1075 return areas_differ_with_type(state, real_area1, snapshot1, region1, real_area2, snapshot2, region2,
1076 type->subtype, pointer_level);
1077 case DW_TAG_array_type:
1078 subtype = type->subtype;
1079 switch (subtype->type) {
1080 case DW_TAG_unspecified_type:
1083 case DW_TAG_base_type:
1084 case DW_TAG_enumeration_type:
1085 case DW_TAG_pointer_type:
1086 case DW_TAG_reference_type:
1087 case DW_TAG_rvalue_reference_type:
1088 case DW_TAG_structure_type:
1089 case DW_TAG_class_type:
1090 case DW_TAG_union_type:
1091 if (subtype->full_type)
1092 subtype = subtype->full_type;
1093 elm_size = subtype->byte_size;
1095 case DW_TAG_const_type:
1096 case DW_TAG_typedef:
1097 case DW_TAG_volatile_type:
1098 subsubtype = subtype->subtype;
1099 if (subsubtype->full_type)
1100 subsubtype = subsubtype->full_type;
1101 elm_size = subsubtype->byte_size;
1106 for (i = 0; i < type->element_count; i++) {
1107 size_t off = i * elm_size;
1108 if (areas_differ_with_type(state, (char*)real_area1 + off, snapshot1, region1, (char*)real_area2 + off,
1109 snapshot2, region2, type->subtype, pointer_level))
1113 case DW_TAG_pointer_type:
1114 case DW_TAG_reference_type:
1115 case DW_TAG_rvalue_reference_type: {
1116 const void* addr_pointed1 = MC_region_read_pointer(region1, real_area1);
1117 const void* addr_pointed2 = MC_region_read_pointer(region2, real_area2);
1119 if (type->subtype && type->subtype->type == DW_TAG_subroutine_type)
1120 return (addr_pointed1 != addr_pointed2);
1121 if (addr_pointed1 == nullptr && addr_pointed2 == nullptr)
1123 if (addr_pointed1 == nullptr || addr_pointed2 == nullptr)
1125 if (not state.compared_pointers.insert(std::make_pair(addr_pointed1, addr_pointed2)).second)
1130 // Some cases are not handled here:
1131 // * the pointers lead to different areas (one to the heap, the other to the RW segment ...)
1132 // * a pointer leads to the read-only segment of the current object
1133 // * a pointer lead to a different ELF object
1135 if (is_on_heap(addr_pointed1)) {
1136 if (not is_on_heap(addr_pointed2))
1138 // The pointers are both in the heap:
1139 return simgrid::mc::heap_area_differ(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, nullptr,
1140 type->subtype, pointer_level);
1142 } else if (region1->contain(simgrid::mc::remote(addr_pointed1))) {
1143 // The pointers are both in the current object R/W segment:
1144 if (not region2->contain(simgrid::mc::remote(addr_pointed2)))
1146 if (not type->type_id)
1147 return (addr_pointed1 != addr_pointed2);
1149 return areas_differ_with_type(state, addr_pointed1, snapshot1, region1, addr_pointed2, snapshot2, region2,
1150 type->subtype, pointer_level);
1153 // TODO, We do not handle very well the case where
1154 // it belongs to a different (non-heap) region from the current one.
1156 return (addr_pointed1 != addr_pointed2);
1159 case DW_TAG_structure_type:
1160 case DW_TAG_class_type:
1161 for (simgrid::mc::Member& member : type->members) {
1162 void* member1 = simgrid::dwarf::resolve_member(real_area1, type, &member, &snapshot1);
1163 void* member2 = simgrid::dwarf::resolve_member(real_area2, type, &member, &snapshot2);
1164 simgrid::mc::Region* subregion1 = snapshot1.get_region(member1, region1); // region1 is hinted
1165 simgrid::mc::Region* subregion2 = snapshot2.get_region(member2, region2); // region2 is hinted
1166 if (areas_differ_with_type(state, member1, snapshot1, subregion1, member2, snapshot2, subregion2, member.type,
1171 case DW_TAG_subroutine_type:
1174 XBT_VERB("Unknown case: %d", type->type);
1181 static bool global_variables_differ(simgrid::mc::StateComparator& state, simgrid::mc::ObjectInformation* object_info,
1182 simgrid::mc::Region* r1, simgrid::mc::Region* r2,
1183 const simgrid::mc::Snapshot& snapshot1, const simgrid::mc::Snapshot& snapshot2)
1185 xbt_assert(r1 && r2, "Missing region.");
1187 std::vector<simgrid::mc::Variable>& variables = object_info->global_variables;
1189 for (simgrid::mc::Variable const& current_var : variables) {
1191 // If the variable is not in this object, skip it:
1192 // We do not expect to find a pointer to something which is not reachable
1193 // by the global variables.
1194 if ((char *) current_var.address < (char *) object_info->start_rw
1195 || (char *) current_var.address > (char *) object_info->end_rw)
1198 simgrid::mc::Type* bvariable_type = current_var.type;
1199 if (areas_differ_with_type(state, (char*)current_var.address, snapshot1, r1, (char*)current_var.address, snapshot2,
1200 r2, bvariable_type, 0)) {
1201 XBT_VERB("Global variable %s (%p) is different between snapshots",
1202 current_var.name.c_str(),
1203 (char *) current_var.address);
1211 static bool local_variables_differ(simgrid::mc::StateComparator& state, const simgrid::mc::Snapshot& snapshot1,
1212 const simgrid::mc::Snapshot& snapshot2, const_mc_snapshot_stack_t stack1,
1213 const_mc_snapshot_stack_t stack2)
1215 if (stack1->local_variables.size() != stack2->local_variables.size()) {
1216 XBT_VERB("Different number of local variables");
1220 for (unsigned int cursor = 0; cursor < stack1->local_variables.size(); cursor++) {
1221 const_local_variable_t current_var1 = &stack1->local_variables[cursor];
1222 const_local_variable_t current_var2 = &stack2->local_variables[cursor];
1223 if (current_var1->name != current_var2->name || current_var1->subprogram != current_var2->subprogram ||
1224 current_var1->ip != current_var2->ip) {
1225 // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
1226 XBT_VERB("Different name of variable (%s - %s) "
1227 "or frame (%s - %s) or ip (%lu - %lu)",
1228 current_var1->name.c_str(), current_var2->name.c_str(), current_var1->subprogram->name.c_str(),
1229 current_var2->subprogram->name.c_str(), current_var1->ip, current_var2->ip);
1233 if (areas_differ_with_type(state, current_var1->address, snapshot1, snapshot1.get_region(current_var1->address),
1234 current_var2->address, snapshot2, snapshot2.get_region(current_var2->address),
1235 current_var1->type, 0)) {
1236 XBT_VERB("Local variable %s (%p - %p) in frame %s "
1237 "is different between snapshots",
1238 current_var1->name.c_str(), current_var1->address, current_var2->address,
1239 current_var1->subprogram->name.c_str());
1249 bool snapshot_equal(const Snapshot* s1, const Snapshot* s2)
1251 // TODO, make this a field of ModelChecker or something similar
1252 static StateComparator state_comparator;
1254 const RemoteClient& process = mc_model_checker->process();
1256 if (s1->hash_ != s2->hash_) {
1257 XBT_VERB("(%d - %d) Different hash: 0x%" PRIx64 "--0x%" PRIx64, s1->num_state_, s2->num_state_, s1->hash_,
1261 XBT_VERB("(%d - %d) Same hash: 0x%" PRIx64, s1->num_state_, s2->num_state_, s1->hash_);
1263 /* Compare enabled processes */
1264 if (s1->enabled_processes_ != s2->enabled_processes_) {
1265 XBT_VERB("(%d - %d) Different amount of enabled processes", s1->num_state_, s2->num_state_);
1269 /* Compare size of stacks */
1270 for (unsigned long i = 0; i < s1->stacks_.size(); i++) {
1271 size_t size_used1 = s1->stack_sizes_[i];
1272 size_t size_used2 = s2->stack_sizes_[i];
1273 if (size_used1 != size_used2) {
1274 XBT_VERB("(%d - %d) Different size used in stacks: %zu - %zu", s1->num_state_, s2->num_state_, size_used1,
1280 /* Init heap information used in heap comparison algorithm */
1282 static_cast<xbt_mheap_t>(s1->read_bytes(alloca(sizeof(struct mdesc)), sizeof(struct mdesc),
1283 remote(process.heap_address), simgrid::mc::ReadOptions::lazy()));
1285 static_cast<xbt_mheap_t>(s2->read_bytes(alloca(sizeof(struct mdesc)), sizeof(struct mdesc),
1286 remote(process.heap_address), simgrid::mc::ReadOptions::lazy()));
1287 if (state_comparator.initHeapInformation(heap1, heap2, s1->to_ignore_, s2->to_ignore_) == -1) {
1288 XBT_VERB("(%d - %d) Different heap information", s1->num_state_, s2->num_state_);
1292 /* Stacks comparison */
1293 for (unsigned int cursor = 0; cursor < s1->stacks_.size(); cursor++) {
1294 const_mc_snapshot_stack_t stack1 = &s1->stacks_[cursor];
1295 const_mc_snapshot_stack_t stack2 = &s2->stacks_[cursor];
1297 if (local_variables_differ(state_comparator, *s1, *s2, stack1, stack2)) {
1298 XBT_VERB("(%d - %d) Different local variables between stacks %u", s1->num_state_, s2->num_state_, cursor + 1);
1303 size_t regions_count = s1->snapshot_regions_.size();
1304 if (regions_count != s2->snapshot_regions_.size())
1307 for (size_t k = 0; k != regions_count; ++k) {
1308 Region* region1 = s1->snapshot_regions_[k].get();
1309 Region* region2 = s2->snapshot_regions_[k].get();
1312 if (region1->region_type() != RegionType::Data)
1315 xbt_assert(region1->region_type() == region2->region_type());
1316 xbt_assert(region1->object_info() == region2->object_info());
1317 xbt_assert(region1->object_info());
1319 /* Compare global variables */
1320 if (global_variables_differ(state_comparator, region1->object_info(), region1, region2, *s1, *s2)) {
1321 std::string const& name = region1->object_info()->file_name;
1322 XBT_VERB("(%d - %d) Different global variables in %s", s1->num_state_, s2->num_state_, name.c_str());
1328 if (mmalloc_heap_differ(state_comparator, *s1, *s2)) {
1329 XBT_VERB("(%d - %d) Different heap (mmalloc_compare)", s1->num_state_, s2->num_state_);
1333 XBT_VERB("(%d - %d) No difference found", s1->num_state_, s2->num_state_);