src/mc/sosp/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 "src/mc/sosp/Snapshot.hpp"
   7 #include "src/mc/mc_config.hpp"
   8 #include "src/mc/mc_hash.hpp"
   9 #include "src/mc/mc_smx.hpp"
  10
  11 #include <cstddef> /* std::size_t */
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_snapshot, mc, "Taking and restoring snapshots");
  14 namespace simgrid {
  15 namespace mc {
  16 /************************************* Take Snapshot ************************************/
  17 /****************************************************************************************/
  18
  19 void Snapshot::snapshot_regions(RemoteClient* process)
  20 {
  21   snapshot_regions_.clear();
  22
  23   for (auto const& object_info : process->object_infos)
  24     add_region(RegionType::Data, object_info.get(), object_info->start_rw, object_info->end_rw - object_info->start_rw);
  25
  26   const s_xbt_mheap_t* heap = process->get_heap();
  27   void* start_heap = heap->base;
  28   void* end_heap   = heap->breakval;
  29
  30   add_region(RegionType::Heap, nullptr, start_heap, (char*)end_heap - (char*)start_heap);
  31   heap_bytes_used_ = mmalloc_get_bytes_used_remote(heap->heaplimit, process->get_malloc_info());
  32 }
  33
  34 /** @brief Checks whether the variable is in scope for a given IP.
  35  *
  36  *  A variable may be defined only from a given value of IP.
  37  *
  38  *  @param var   Variable description
  39  *  @param scope Scope description
  40  *  @param ip    Instruction pointer
  41  *  @return      true if the variable is valid
  42  * */
  43 static bool valid_variable(const simgrid::mc::Variable* var, simgrid::mc::Frame* scope, const void* ip)
  44 {
  45   // The variable is not yet valid:
  46   if (scope->range.begin() + var->start_scope > (std::uint64_t)ip)
  47     return false;
  48   else
  49     return true;
  50 }
  51
  52 static void fill_local_variables_values(mc_stack_frame_t stack_frame, Frame* scope,
  53                                         std::vector<s_local_variable_t>& result)
  54 {
  55   if (not scope || not scope->range.contain(stack_frame->ip))
  56     return;
  57
  58   for (const Variable& current_variable : scope->variables) {
  59     if (not valid_variable(&current_variable, scope, (void*)stack_frame->ip))
  60       continue;
  61
  62     s_local_variable_t new_var;
  63     new_var.subprogram = stack_frame->frame;
  64     new_var.ip         = stack_frame->ip;
  65     new_var.name       = current_variable.name;
  66     new_var.type       = current_variable.type;
  67     new_var.address    = nullptr;
  68
  69     if (current_variable.address != nullptr)
  70       new_var.address = current_variable.address;
  71     else if (not current_variable.location_list.empty()) {
  72       dwarf::Location location = simgrid::dwarf::resolve(current_variable.location_list, current_variable.object_info,
  73                                                          &(stack_frame->unw_cursor), (void*)stack_frame->frame_base,
  74                                                          &mc_model_checker->process());
  75
  76       if (not location.in_memory())
  77         xbt_die("Cannot handle non-address variable");
  78       new_var.address = location.address();
  79     } else
  80       xbt_die("No address");
  81
  82     result.push_back(std::move(new_var));
  83   }
  84
  85   // Recursive processing of nested scopes:
  86   for (Frame& nested_scope : scope->scopes)
  87     fill_local_variables_values(stack_frame, &nested_scope, result);
  88 }
  89
  90 static std::vector<s_local_variable_t> get_local_variables_values(std::vector<s_mc_stack_frame_t>& stack_frames)
  91 {
  92   std::vector<s_local_variable_t> variables;
  93   for (s_mc_stack_frame_t& stack_frame : stack_frames)
  94     fill_local_variables_values(&stack_frame, stack_frame.frame, variables);
  95   return variables;
  96 }
  97
  98 static std::vector<s_mc_stack_frame_t> unwind_stack_frames(UnwindContext* stack_context)
  99 {
 100   const RemoteClient* process = &mc_model_checker->process();
 101   std::vector<s_mc_stack_frame_t> result;
 102
 103   unw_cursor_t c = stack_context->cursor();
 104
 105   // TODO, check condition check (unw_init_local==0 means end of frame)
 106
 107   while (1) {
 108     s_mc_stack_frame_t stack_frame;
 109
 110     stack_frame.unw_cursor = c;
 111
 112     unw_word_t ip;
 113     unw_word_t sp;
 114
 115     unw_get_reg(&c, UNW_REG_IP, &ip);
 116     unw_get_reg(&c, UNW_REG_SP, &sp);
 117
 118     stack_frame.ip = ip;
 119     stack_frame.sp = sp;
 120
 121     // TODO, use real addresses in frame_t instead of fixing it here
 122
 123     Frame* frame              = process->find_function(remote(ip));
 124     stack_frame.frame         = frame;
 125
 126     if (frame) {
 127       stack_frame.frame_name = frame->name;
 128       stack_frame.frame_base = (unw_word_t)frame->frame_base(c);
 129     } else {
 130       stack_frame.frame_base = 0;
 131       stack_frame.frame_name = std::string();
 132     }
 133
 134     result.push_back(std::move(stack_frame));
 135
 136     /* Stop before context switch with maestro */
 137     if (frame != nullptr && frame->name == "smx_ctx_wrapper")
 138       break;
 139
 140     int ret = unw_step(&c);
 141     if (ret == 0)
 142       xbt_die("Unexpected end of stack.");
 143     else if (ret < 0)
 144       xbt_die("Error while unwinding stack");
 145   }
 146
 147   xbt_assert(not result.empty(), "unw_init_local failed");
 148
 149   return result;
 150 }
 151
 152 void Snapshot::snapshot_stacks(RemoteClient* process)
 153 {
 154   for (auto const& stack : process->stack_areas()) {
 155     s_mc_snapshot_stack_t st;
 156
 157     // Read the context from remote process:
 158     unw_context_t context;
 159     process->read_bytes(&context, sizeof(context), remote(stack.context));
 160
 161     st.context.initialize(process, &context);
 162
 163     st.stack_frames    = unwind_stack_frames(&st.context);
 164     st.local_variables = get_local_variables_values(st.stack_frames);
 165
 166     unw_word_t sp = st.stack_frames[0].sp;
 167
 168     stacks_.push_back(std::move(st));
 169
 170     size_t stack_size = (char*)stack.address + stack.size - (char*)sp;
 171     stack_sizes_.push_back(stack_size);
 172   }
 173 }
 174
 175 static void snapshot_handle_ignore(Snapshot* snapshot)
 176 {
 177   xbt_assert(snapshot->process());
 178
 179   // Copy the memory:
 180   for (auto const& region : snapshot->process()->ignored_regions()) {
 181     s_mc_snapshot_ignored_data_t ignored_data;
 182     ignored_data.start = (void*)region.addr;
 183     ignored_data.data.resize(region.size);
 184     // TODO, we should do this once per privatization segment:
 185     snapshot->process()->read_bytes(ignored_data.data.data(), region.size, remote(region.addr));
 186     snapshot->ignored_data_.push_back(std::move(ignored_data));
 187   }
 188
 189   // Zero the memory:
 190   for (auto const& region : snapshot->process()->ignored_regions())
 191     snapshot->process()->clear_bytes(remote(region.addr), region.size);
 192 }
 193
 194 static void snapshot_ignore_restore(const simgrid::mc::Snapshot* snapshot)
 195 {
 196   for (auto const& ignored_data : snapshot->ignored_data_)
 197     snapshot->process()->write_bytes(ignored_data.data.data(), ignored_data.data.size(), remote(ignored_data.start));
 198 }
 199
 200 Snapshot::Snapshot(int num_state, RemoteClient* process) : AddressSpace(process), num_state_(num_state)
 201 {
 202   XBT_DEBUG("Taking snapshot %i", num_state);
 203
 204   for (auto const& p : process->actors())
 205     enabled_processes_.insert(p.copy.get_buffer()->get_pid());
 206
 207   snapshot_handle_ignore(this);
 208
 209   /* Save the std heap and the writable mapped pages of libsimgrid and binary */
 210   snapshot_regions(process);
 211
 212   to_ignore_ = process->ignored_heap();
 213
 214   if (_sg_mc_max_visited_states > 0 || not _sg_mc_property_file.get().empty()) {
 215     snapshot_stacks(process);
 216     hash_ = simgrid::mc::hash(*this);
 217   }
 218
 219   snapshot_ignore_restore(this);
 220 }
 221
 222 void Snapshot::add_region(RegionType type, ObjectInformation* object_info, void* start_addr, std::size_t size)
 223 {
 224   if (type == RegionType::Data)
 225     xbt_assert(object_info, "Missing object info for object.");
 226   else if (type == RegionType::Heap)
 227     xbt_assert(not object_info, "Unexpected object info for heap region.");
 228
 229   Region* region = new Region(type, start_addr, size);
 230   region->object_info(object_info);
 231   snapshot_regions_.push_back(std::unique_ptr<Region>(std::move(region)));
 232 }
 233
 234 void* Snapshot::read_bytes(void* buffer, std::size_t size, RemotePtr<void> address, ReadOptions options) const
 235 {
 236   const Region* region = this->get_region((void*)address.address());
 237   if (region) {
 238     void* res = region->read(buffer, (void*)address.address(), size);
 239     if (buffer == res || options & ReadOptions::lazy())
 240       return res;
 241     else {
 242       memcpy(buffer, res, size);
 243       return buffer;
 244     }
 245   } else
 246     return this->process()->read_bytes(buffer, size, address, options);
 247 }
 248 /** @brief Find the snapshotted region from a pointer
 249  *
 250  *  @param addr     Pointer
 251  * */
 252 Region* Snapshot::get_region(const void* addr) const
 253 {
 254   size_t n = snapshot_regions_.size();
 255   for (size_t i = 0; i != n; ++i) {
 256     Region* region = snapshot_regions_[i].get();
 257     if (not(region && region->contain(simgrid::mc::remote(addr))))
 258       continue;
 259
 260     return region;
 261   }
 262
 263   return nullptr;
 264 }
 265
 266 /** @brief Find the snapshotted region from a pointer, with a hinted_region */
 267 Region* Snapshot::get_region(const void* addr, Region* hinted_region) const
 268 {
 269   if (hinted_region->contain(simgrid::mc::remote(addr)))
 270     return hinted_region;
 271   else
 272     return get_region(addr);
 273 }
 274
 275 void Snapshot::restore(RemoteClient* process)
 276 {
 277   XBT_DEBUG("Restore snapshot %i", num_state_);
 278
 279   // Restore regions
 280   for (std::unique_ptr<Region> const& region : snapshot_regions_) {
 281     if (region) // privatized variables are not snapshotted
 282       region.get()->restore();
 283   }
 284
 285   snapshot_ignore_restore(this);
 286   process->clear_cache();
 287 }
 288
 289 } // namespace mc
 290 } // namespace simgrid