src/mc/sosp/mc_snapshot.cpp

   1 /* Copyright (c) 2014-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include <cstddef> /* std::size_t */
   7
   8 #include "src/mc/mc_config.hpp"
   9 #include "src/mc/mc_hash.hpp"
  10 #include "src/mc/mc_smx.hpp"
  11 #include "src/mc/sosp/mc_snapshot.hpp"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_snapshot, mc, "Taking and restoring snapshots");
  14
  15 /** @brief Read memory from a snapshot region broken across fragmented pages
  16  *
  17  *  @param addr    Process (non-snapshot) address of the data
  18  *  @param region  Snapshot memory region where the data is located
  19  *  @param target  Buffer to store the value
  20  *  @param size    Size of the data to read in bytes
  21  *  @return Pointer where the data is located (target buffer of original location)
  22  */
  23 const void* MC_region_read_fragmented(simgrid::mc::RegionSnapshot* region, void* target, const void* addr, size_t size)
  24 {
  25   // Last byte of the memory area:
  26   void* end = (char*)addr + size - 1;
  27
  28   // TODO, we assume the chunks are aligned to natural chunk boundaries.
  29   // We should remove this assumption.
  30
  31   // Page of the last byte of the memory area:
  32   size_t page_end = simgrid::mc::mmu::split((std::uintptr_t)end).first;
  33
  34   void* dest = target;
  35
  36   if (dest == nullptr)
  37     xbt_die("Missing destination buffer for fragmented memory access");
  38
  39   // Read each page:
  40   while (simgrid::mc::mmu::split((std::uintptr_t)addr).first != page_end) {
  41     void* snapshot_addr = mc_translate_address_region((uintptr_t)addr, region);
  42     void* next_page     = (void*)simgrid::mc::mmu::join(simgrid::mc::mmu::split((std::uintptr_t)addr).first + 1, 0);
  43     size_t readable     = (char*)next_page - (char*)addr;
  44     memcpy(dest, snapshot_addr, readable);
  45     addr = (char*)addr + readable;
  46     dest = (char*)dest + readable;
  47     size -= readable;
  48   }
  49
  50   // Read the end:
  51   void* snapshot_addr = mc_translate_address_region((uintptr_t)addr, region);
  52   memcpy(dest, snapshot_addr, size);
  53
  54   return target;
  55 }
  56
  57 /** Compare memory between snapshots (with known regions)
  58  *
  59  * @param addr1 Address in the first snapshot
  60  * @param region1 Region of the address in the first snapshot
  61  * @param addr2 Address in the second snapshot
  62  * @param region2 Region of the address in the second snapshot
  63  * @return same semantic as memcmp
  64  */
  65 int MC_snapshot_region_memcmp(const void* addr1, simgrid::mc::RegionSnapshot* region1, const void* addr2,
  66                               simgrid::mc::RegionSnapshot* region2, size_t size)
  67 {
  68   // Using alloca() for large allocations may trigger stack overflow:
  69   // use malloc if the buffer is too big.
  70   bool stack_alloc = size < 64;
  71   void* buffer1a      = stack_alloc ? alloca(size) : ::operator new(size);
  72   void* buffer2a      = stack_alloc ? alloca(size) : ::operator new(size);
  73   const void* buffer1 = MC_region_read(region1, buffer1a, addr1, size);
  74   const void* buffer2 = MC_region_read(region2, buffer2a, addr2, size);
  75   int res;
  76   if (buffer1 == buffer2)
  77     res = 0;
  78   else
  79     res = memcmp(buffer1, buffer2, size);
  80   if (not stack_alloc) {
  81     ::operator delete(buffer1a);
  82     ::operator delete(buffer2a);
  83   }
  84   return res;
  85 }
  86
  87 namespace simgrid {
  88 namespace mc {
  89 /************************************* Take Snapshot ************************************/
  90 /****************************************************************************************/
  91
  92 void simgrid::mc::Snapshot::snapshot_regions(simgrid::mc::RemoteClient* process)
  93 {
  94   snapshot_regions_.clear();
  95
  96   for (auto const& object_info : process->object_infos)
  97     add_region(simgrid::mc::RegionType::Data, object_info.get(), object_info->start_rw,
  98                object_info->end_rw - object_info->start_rw);
  99
 100   xbt_mheap_t heap = process->get_heap();
 101   void* start_heap = heap->base;
 102   void* end_heap   = heap->breakval;
 103
 104   add_region(simgrid::mc::RegionType::Heap, nullptr, start_heap, (char*)end_heap - (char*)start_heap);
 105   heap_bytes_used_     = mmalloc_get_bytes_used_remote(heap->heaplimit, process->get_malloc_info());
 106 }
 107
 108 /** @brief Checks whether the variable is in scope for a given IP.
 109  *
 110  *  A variable may be defined only from a given value of IP.
 111  *
 112  *  @param var   Variable description
 113  *  @param scope Scope description
 114  *  @param ip    Instruction pointer
 115  *  @return      true if the variable is valid
 116  * */
 117 static bool valid_variable(simgrid::mc::Variable* var, simgrid::mc::Frame* scope, const void* ip)
 118 {
 119   // The variable is not yet valid:
 120   if (scope->range.begin() + var->start_scope > (std::uint64_t)ip)
 121     return false;
 122   else
 123     return true;
 124 }
 125
 126 static void fill_local_variables_values(mc_stack_frame_t stack_frame, simgrid::mc::Frame* scope,
 127                                         std::vector<s_local_variable_t>& result)
 128 {
 129   if (not scope || not scope->range.contain(stack_frame->ip))
 130     return;
 131
 132   for (simgrid::mc::Variable& current_variable : scope->variables) {
 133
 134     if (not valid_variable(&current_variable, scope, (void*)stack_frame->ip))
 135       continue;
 136
 137     s_local_variable_t new_var;
 138     new_var.subprogram = stack_frame->frame;
 139     new_var.ip         = stack_frame->ip;
 140     new_var.name       = current_variable.name;
 141     new_var.type       = current_variable.type;
 142     new_var.address    = nullptr;
 143
 144     if (current_variable.address != nullptr)
 145       new_var.address = current_variable.address;
 146     else if (not current_variable.location_list.empty()) {
 147       simgrid::dwarf::Location location = simgrid::dwarf::resolve(
 148           current_variable.location_list, current_variable.object_info, &(stack_frame->unw_cursor),
 149           (void*)stack_frame->frame_base, &mc_model_checker->process());
 150
 151       if (not location.in_memory())
 152         xbt_die("Cannot handle non-address variable");
 153       new_var.address = location.address();
 154
 155     } else
 156       xbt_die("No address");
 157
 158     result.push_back(std::move(new_var));
 159   }
 160
 161   // Recursive processing of nested scopes:
 162   for (simgrid::mc::Frame& nested_scope : scope->scopes)
 163     fill_local_variables_values(stack_frame, &nested_scope, result);
 164 }
 165
 166 static std::vector<s_local_variable_t> get_local_variables_values(std::vector<s_mc_stack_frame_t>& stack_frames)
 167 {
 168   std::vector<s_local_variable_t> variables;
 169   for (s_mc_stack_frame_t& stack_frame : stack_frames)
 170     fill_local_variables_values(&stack_frame, stack_frame.frame, variables);
 171   return variables;
 172 }
 173
 174 static std::vector<s_mc_stack_frame_t> unwind_stack_frames(simgrid::mc::UnwindContext* stack_context)
 175 {
 176   simgrid::mc::RemoteClient* process = &mc_model_checker->process();
 177   std::vector<s_mc_stack_frame_t> result;
 178
 179   unw_cursor_t c = stack_context->cursor();
 180
 181   // TODO, check condition check (unw_init_local==0 means end of frame)
 182
 183   while (1) {
 184
 185     s_mc_stack_frame_t stack_frame;
 186
 187     stack_frame.unw_cursor = c;
 188
 189     unw_word_t ip;
 190     unw_word_t sp;
 191
 192     unw_get_reg(&c, UNW_REG_IP, &ip);
 193     unw_get_reg(&c, UNW_REG_SP, &sp);
 194
 195     stack_frame.ip = ip;
 196     stack_frame.sp = sp;
 197
 198     // TODO, use real addresses in frame_t instead of fixing it here
 199
 200     simgrid::mc::Frame* frame = process->find_function(remote(ip));
 201     stack_frame.frame         = frame;
 202
 203     if (frame) {
 204       stack_frame.frame_name = frame->name;
 205       stack_frame.frame_base = (unw_word_t)frame->frame_base(c);
 206     } else {
 207       stack_frame.frame_base = 0;
 208       stack_frame.frame_name = std::string();
 209     }
 210
 211     result.push_back(std::move(stack_frame));
 212
 213     /* Stop before context switch with maestro */
 214     if (frame != nullptr && frame->name == "smx_ctx_wrapper")
 215       break;
 216
 217     int ret = unw_step(&c);
 218     if (ret == 0)
 219       xbt_die("Unexpected end of stack.");
 220     else if (ret < 0)
 221       xbt_die("Error while unwinding stack");
 222   }
 223
 224   xbt_assert(not result.empty(), "unw_init_local failed");
 225
 226   return result;
 227 }
 228
 229 void simgrid::mc::Snapshot::snapshot_stacks(simgrid::mc::RemoteClient* process)
 230 {
 231   for (auto const& stack : process->stack_areas()) {
 232     s_mc_snapshot_stack_t st;
 233
 234     // Read the context from remote process:
 235     unw_context_t context;
 236     process->read_bytes(&context, sizeof(context), remote(stack.context));
 237
 238     st.context.initialize(process, &context);
 239
 240     st.stack_frames    = unwind_stack_frames(&st.context);
 241     st.local_variables = get_local_variables_values(st.stack_frames);
 242
 243     unw_word_t sp = st.stack_frames[0].sp;
 244
 245     stacks_.push_back(std::move(st));
 246
 247     size_t stack_size = (char*)stack.address + stack.size - (char*)sp;
 248     stack_sizes_.push_back(stack_size);
 249   }
 250 }
 251
 252 static void snapshot_handle_ignore(simgrid::mc::Snapshot* snapshot)
 253 {
 254   xbt_assert(snapshot->process());
 255
 256   // Copy the memory:
 257   for (auto const& region : snapshot->process()->ignored_regions()) {
 258     s_mc_snapshot_ignored_data_t ignored_data;
 259     ignored_data.start = (void*)region.addr;
 260     ignored_data.data.resize(region.size);
 261     // TODO, we should do this once per privatization segment:
 262     snapshot->process()->read_bytes(ignored_data.data.data(), region.size, remote(region.addr));
 263     snapshot->ignored_data_.push_back(std::move(ignored_data));
 264   }
 265
 266   // Zero the memory:
 267   for (auto const& region : snapshot->process()->ignored_regions())
 268     snapshot->process()->clear_bytes(remote(region.addr), region.size);
 269 }
 270 static void snapshot_ignore_restore(simgrid::mc::Snapshot* snapshot)
 271 {
 272   for (auto const& ignored_data : snapshot->ignored_data_)
 273     snapshot->process()->write_bytes(ignored_data.data.data(), ignored_data.data.size(), remote(ignored_data.start));
 274 }
 275
 276 Snapshot::Snapshot(int num_state, RemoteClient* process)
 277     : AddressSpace(process)
 278     , num_state_(num_state)
 279     , heap_bytes_used_(0)
 280     , enabled_processes_()
 281     , hash_(0)
 282 {
 283   XBT_DEBUG("Taking snapshot %i", num_state);
 284
 285   for (auto const& p : process->actors())
 286     enabled_processes_.insert(p.copy.get_buffer()->get_pid());
 287
 288   snapshot_handle_ignore(this);
 289
 290   /* Save the std heap and the writable mapped pages of libsimgrid and binary */
 291   snapshot_regions(process);
 292
 293   to_ignore_ = process->ignored_heap();
 294
 295   if (_sg_mc_max_visited_states > 0 || not _sg_mc_property_file.get().empty()) {
 296     snapshot_stacks(process);
 297     if (_sg_mc_hash)
 298       hash_ = simgrid::mc::hash(*this);
 299   }
 300
 301   snapshot_ignore_restore(this);
 302 }
 303
 304 void Snapshot::add_region(RegionType type, ObjectInformation* object_info, void* start_addr, std::size_t size)
 305 {
 306   if (type == simgrid::mc::RegionType::Data)
 307     xbt_assert(object_info, "Missing object info for object.");
 308   else if (type == simgrid::mc::RegionType::Heap)
 309     xbt_assert(not object_info, "Unexpected object info for heap region.");
 310
 311   simgrid::mc::RegionSnapshot* region = new RegionSnapshot(type, start_addr, size);
 312   region->object_info(object_info);
 313   snapshot_regions_.push_back(std::unique_ptr<simgrid::mc::RegionSnapshot>(std::move(region)));
 314 }
 315
 316 const void* Snapshot::read_bytes(void* buffer, std::size_t size, RemotePtr<void> address, ReadOptions options) const
 317 {
 318   RegionSnapshot* region = this->get_region((void*)address.address());
 319   if (region) {
 320     const void* res = MC_region_read(region, buffer, (void*)address.address(), size);
 321     if (buffer == res || options & ReadOptions::lazy())
 322       return res;
 323     else {
 324       memcpy(buffer, res, size);
 325       return buffer;
 326     }
 327   } else
 328     return this->process()->read_bytes(buffer, size, address, options);
 329 }
 330 /** @brief Find the snapshoted region from a pointer
 331  *
 332  *  @param addr     Pointer
 333  * */
 334 RegionSnapshot* Snapshot::get_region(const void* addr) const
 335 {
 336   size_t n = snapshot_regions_.size();
 337   for (size_t i = 0; i != n; ++i) {
 338     RegionSnapshot* region = snapshot_regions_[i].get();
 339     if (not(region && region->contain(simgrid::mc::remote(addr))))
 340       continue;
 341
 342     return region;
 343   }
 344
 345   return nullptr;
 346 }
 347
 348 /** @brief Find the snapshoted region from a pointer, with a hinted_region */
 349 RegionSnapshot* Snapshot::get_region(const void* addr, RegionSnapshot* hinted_region) const
 350 {
 351   if (hinted_region->contain(simgrid::mc::remote(addr)))
 352     return hinted_region;
 353   else
 354     return get_region(addr);
 355 }
 356
 357 void Snapshot::restore(RemoteClient* process)
 358 {
 359   XBT_DEBUG("Restore snapshot %i", num_state_);
 360
 361   // Restore regions
 362   for (std::unique_ptr<simgrid::mc::RegionSnapshot> const& region : snapshot_regions_) {
 363     if (region) // privatized variables are not snapshoted
 364       region.get()->restore();
 365   }
 366
 367   snapshot_ignore_restore(this);
 368   process->clear_cache();
 369 }
 370
 371 } // namespace mc
 372 } // namespace simgrid