src/mc/mc_snapshot.hpp

   1 /* Copyright (c) 2007-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 #ifndef SIMGRID_MC_SNAPSHOT_HPP
   7 #define SIMGRID_MC_SNAPSHOT_HPP
   8
   9 #include <memory>
  10 #include <set>
  11 #include <string>
  12 #include <vector>
  13
  14 #include "src/mc/ModelChecker.hpp"
  15 #include "src/mc/RegionSnapshot.hpp"
  16 #include "src/mc/mc_forward.hpp"
  17 #include "src/mc/mc_unw.hpp"
  18
  19 extern "C" {
  20
  21 // ***** Snapshot region
  22
  23 XBT_PRIVATE void mc_region_restore_sparse(simgrid::mc::RemoteClient* process, mc_mem_region_t reg);
  24
  25 static XBT_ALWAYS_INLINE void* mc_translate_address_region_chunked(uintptr_t addr, mc_mem_region_t region)
  26 {
  27   auto split                = simgrid::mc::mmu::split(addr - region->start().address());
  28   auto pageno               = split.first;
  29   auto offset               = split.second;
  30   const void* snapshot_page = region->page_data().page(pageno);
  31   return (char*)snapshot_page + offset;
  32 }
  33
  34 static XBT_ALWAYS_INLINE void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region, int process_index)
  35 {
  36   switch (region->storage_type()) {
  37     case simgrid::mc::StorageType::Flat: {
  38       uintptr_t offset = (uintptr_t)addr - (uintptr_t)region->start().address();
  39       return (void*)((uintptr_t)region->flat_data().get() + offset);
  40     }
  41     case simgrid::mc::StorageType::Chunked:
  42       return mc_translate_address_region_chunked(addr, region);
  43     case simgrid::mc::StorageType::Privatized: {
  44       xbt_assert(process_index >= 0, "Missing process index for privatized region");
  45       xbt_assert((size_t)process_index < region->privatized_data().size(), "Out of range process index");
  46       simgrid::mc::RegionSnapshot& subregion = region->privatized_data()[process_index];
  47       return mc_translate_address_region(addr, &subregion, process_index);
  48     }
  49     case simgrid::mc::StorageType::NoData:
  50     default:
  51       xbt_die("Storage type not supported");
  52   }
  53 }
  54
  55 XBT_PRIVATE mc_mem_region_t mc_get_snapshot_region(const void* addr, const simgrid::mc::Snapshot* snapshot,
  56                                                    int process_index);
  57 }
  58
  59 // ***** MC Snapshot
  60
  61 /** Ignored data
  62  *
  63  *  Some parts of the snapshot are ignored by zeroing them out: the real
  64  *  values is stored here.
  65  * */
  66 struct s_mc_snapshot_ignored_data_t {
  67   void* start;
  68   std::vector<char> data;
  69 };
  70
  71 struct s_fd_infos_t {
  72   std::string filename;
  73   int number;
  74   off_t current_position;
  75   int flags;
  76 };
  77
  78 /** Information about a given stack frame */
  79 struct s_mc_stack_frame_t {
  80   /** Instruction pointer */
  81   unw_word_t ip;
  82   /** Stack pointer */
  83   unw_word_t sp;
  84   unw_word_t frame_base;
  85   simgrid::mc::Frame* frame;
  86   std::string frame_name;
  87   unw_cursor_t unw_cursor;
  88 };
  89 typedef s_mc_stack_frame_t* mc_stack_frame_t;
  90
  91 struct s_local_variable_t {
  92   simgrid::mc::Frame* subprogram;
  93   unsigned long ip;
  94   std::string name;
  95   simgrid::mc::Type* type;
  96   void* address;
  97   int region;
  98 };
  99 typedef s_local_variable_t* local_variable_t;
 100
 101 struct XBT_PRIVATE s_mc_snapshot_stack_t {
 102   std::vector<s_local_variable_t> local_variables;
 103   simgrid::mc::UnwindContext context;
 104   std::vector<s_mc_stack_frame_t> stack_frames;
 105   int process_index;
 106 };
 107 typedef s_mc_snapshot_stack_t* mc_snapshot_stack_t;
 108
 109 namespace simgrid {
 110 namespace mc {
 111
 112 class XBT_PRIVATE Snapshot final : public AddressSpace {
 113 public:
 114   Snapshot(RemoteClient* process, int num_state);
 115   ~Snapshot() = default;
 116   const void* read_bytes(void* buffer, std::size_t size, RemotePtr<void> address, int process_index = ProcessIndexAny,
 117                          ReadOptions options = ReadOptions::none()) const override;
 118
 119   // To be private
 120   int num_state;
 121   std::size_t heap_bytes_used;
 122   std::vector<std::unique_ptr<s_mc_mem_region_t>> snapshot_regions;
 123   std::set<pid_t> enabled_processes;
 124   int privatization_index;
 125   std::vector<std::size_t> stack_sizes;
 126   std::vector<s_mc_snapshot_stack_t> stacks;
 127   std::vector<simgrid::mc::IgnoredHeapRegion> to_ignore;
 128   std::uint64_t hash;
 129   std::vector<s_mc_snapshot_ignored_data_t> ignored_data;
 130   std::vector<s_fd_infos_t> current_fds;
 131 };
 132 }
 133 }
 134
 135 extern "C" {
 136
 137 static XBT_ALWAYS_INLINE mc_mem_region_t mc_get_region_hinted(void* addr, simgrid::mc::Snapshot* snapshot,
 138                                                               int process_index, mc_mem_region_t region)
 139 {
 140   if (region->contain(simgrid::mc::remote(addr)))
 141     return region;
 142   else
 143     return mc_get_snapshot_region(addr, snapshot, process_index);
 144 }
 145
 146 static const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot);
 147 }
 148
 149 namespace simgrid {
 150 namespace mc {
 151
 152 XBT_PRIVATE std::shared_ptr<simgrid::mc::Snapshot> take_snapshot(int num_state);
 153 XBT_PRIVATE void restore_snapshot(std::shared_ptr<simgrid::mc::Snapshot> snapshot);
 154 }
 155 }
 156
 157 extern "C" {
 158
 159 XBT_PRIVATE void mc_restore_page_snapshot_region(simgrid::mc::RemoteClient* process, void* start_addr,
 160                                                  simgrid::mc::ChunkedData const& pagenos);
 161
 162 const void* MC_region_read_fragmented(mc_mem_region_t region, void* target, const void* addr, std::size_t size);
 163
 164 int MC_snapshot_region_memcmp(const void* addr1, mc_mem_region_t region1, const void* addr2, mc_mem_region_t region2,
 165                               std::size_t size);
 166 XBT_PRIVATE int MC_snapshot_memcmp(const void* addr1, simgrid::mc::Snapshot* snapshot1, const void* addr2,
 167                                    simgrid::mc::Snapshot* snapshot2, int process_index, std::size_t size);
 168
 169 static XBT_ALWAYS_INLINE const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot)
 170 {
 171   if (snapshot == nullptr)
 172     xbt_die("snapshot is nullptr");
 173   return mc_model_checker->process().get_heap()->breakval;
 174 }
 175
 176 /** @brief Read memory from a snapshot region
 177  *
 178  *  @param addr    Process (non-snapshot) address of the data
 179  *  @param region  Snapshot memory region where the data is located
 180  *  @param target  Buffer to store the value
 181  *  @param size    Size of the data to read in bytes
 182  *  @return Pointer where the data is located (target buffer of original location)
 183  */
 184 static XBT_ALWAYS_INLINE const void* MC_region_read(mc_mem_region_t region, void* target, const void* addr,
 185                                                     std::size_t size)
 186 {
 187   xbt_assert(region);
 188
 189   std::uintptr_t offset = (std::uintptr_t)addr - (std::uintptr_t)region->start().address();
 190
 191   xbt_assert(region->contain(simgrid::mc::remote(addr)), "Trying to read out of the region boundary.");
 192
 193   switch (region->storage_type()) {
 194     case simgrid::mc::StorageType::NoData:
 195     default:
 196       xbt_die("Storage type not supported");
 197
 198     case simgrid::mc::StorageType::Flat:
 199       return (char*)region->flat_data().get() + offset;
 200
 201     case simgrid::mc::StorageType::Chunked: {
 202       // Last byte of the region:
 203       void* end = (char*)addr + size - 1;
 204       if (simgrid::mc::mmu::sameChunk((std::uintptr_t)addr, (std::uintptr_t)end)) {
 205         // The memory is contained in a single page:
 206         return mc_translate_address_region_chunked((uintptr_t)addr, region);
 207       } else {
 208         // The memory spans several pages:
 209         return MC_region_read_fragmented(region, target, addr, size);
 210       }
 211     }
 212
 213     // We currently do not pass the process_index to this function so we assume
 214     // that the privatized region has been resolved in the callers:
 215     case simgrid::mc::StorageType::Privatized:
 216       xbt_die("Storage type not supported");
 217   }
 218 }
 219
 220 static XBT_ALWAYS_INLINE void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
 221 {
 222   void* res;
 223   return *(void**)MC_region_read(region, &res, addr, sizeof(void*));
 224 }
 225 }
 226
 227 #endif