src/mc/sosp/Snapshot.cpp

   1 /* Copyright (c) 2014-2023. 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
   9 #include <cstddef> /* std::size_t */
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_snapshot, mc, "Taking and restoring snapshots");
  12 namespace simgrid::mc {
  13 /************************************* Take Snapshot ************************************/
  14 /****************************************************************************************/
  15
  16 void Snapshot::snapshot_regions(RemoteProcessMemory& memory)
  17 {
  18   snapshot_regions_.clear();
  19
  20   for (auto const& object_info : memory.object_infos)
  21     add_region(RegionType::Data, memory, object_info.get(), object_info->start_rw,
  22                object_info->end_rw - object_info->start_rw);
  23
  24   const s_xbt_mheap_t* heap = memory.get_heap();
  25   void* start_heap = heap->base;
  26   void* end_heap   = heap->breakval;
  27
  28   add_region(RegionType::Heap, memory, nullptr, start_heap, (char*)end_heap - (char*)start_heap);
  29   heap_bytes_used_ = mmalloc_get_bytes_used_remote(heap->heaplimit, memory.get_malloc_info());
  30 }
  31
  32 /** @brief Checks whether the variable is in scope for a given IP.
  33  *
  34  *  A variable may be defined only from a given value of IP.
  35  *
  36  *  @param var   Variable description
  37  *  @param scope Scope description
  38  *  @param ip    Instruction pointer
  39  *  @return      true if the variable is valid
  40  * */
  41 static bool valid_variable(const simgrid::mc::Variable* var, simgrid::mc::Frame* scope, const void* ip)
  42 {
  43   // The variable is not yet valid:
  44   if (scope->range.begin() + var->start_scope > (std::uint64_t)ip)
  45     return false;
  46   else
  47     return true;
  48 }
  49
  50 static void fill_local_variables_values(mc_stack_frame_t stack_frame, Frame* scope,
  51                                         std::vector<s_local_variable_t>& result)
  52 {
  53   if (not scope || not scope->range.contain(stack_frame->ip))
  54     return;
  55
  56   for (const Variable& current_variable : scope->variables) {
  57     if (not valid_variable(&current_variable, scope, (void*)stack_frame->ip))
  58       continue;
  59
  60     if (not current_variable.type) {
  61       XBT_VERB("Ignore local variable without type: '%s' [%s]", current_variable.name.c_str(),
  62                stack_frame->frame->name.c_str());
  63       continue;
  64     }
  65
  66     s_local_variable_t new_var;
  67     new_var.subprogram = stack_frame->frame;
  68     new_var.ip         = stack_frame->ip;
  69     new_var.name       = current_variable.name;
  70     new_var.type       = current_variable.type;
  71     new_var.address    = nullptr;
  72
  73     if (current_variable.address != nullptr)
  74       new_var.address = current_variable.address;
  75     else if (not current_variable.location_list.empty()) {
  76       dwarf::Location location = simgrid::dwarf::resolve(current_variable.location_list, current_variable.object_info,
  77                                                          &(stack_frame->unw_cursor), (void*)stack_frame->frame_base,
  78                                                          &mc_model_checker->get_remote_process_memory());
  79
  80       xbt_assert(location.in_memory(), "Cannot handle non-address variable");
  81       new_var.address = location.address();
  82     } else
  83       xbt_die("No address");
  84
  85     result.push_back(std::move(new_var));
  86   }
  87
  88   // Recursive processing of nested scopes:
  89   for (Frame& nested_scope : scope->scopes)
  90     fill_local_variables_values(stack_frame, &nested_scope, result);
  91 }
  92
  93 static std::vector<s_local_variable_t> get_local_variables_values(std::vector<s_mc_stack_frame_t>& stack_frames)
  94 {
  95   std::vector<s_local_variable_t> variables;
  96   for (s_mc_stack_frame_t& stack_frame : stack_frames)
  97     fill_local_variables_values(&stack_frame, stack_frame.frame, variables);
  98   return variables;
  99 }
 100
 101 static std::vector<s_mc_stack_frame_t> unwind_stack_frames(UnwindContext* stack_context)
 102 {
 103   const RemoteProcessMemory* process_memory = &mc_model_checker->get_remote_process_memory();
 104   std::vector<s_mc_stack_frame_t> result;
 105
 106   unw_cursor_t c = stack_context->cursor();
 107
 108   // TODO, check condition check (unw_init_local==0 means end of frame)
 109
 110   while (true) {
 111     s_mc_stack_frame_t stack_frame;
 112
 113     stack_frame.unw_cursor = c;
 114
 115     unw_word_t ip;
 116     unw_word_t sp;
 117
 118     unw_get_reg(&c, UNW_REG_IP, &ip);
 119     unw_get_reg(&c, UNW_REG_SP, &sp);
 120
 121     stack_frame.ip = ip;
 122     stack_frame.sp = sp;
 123
 124     // TODO, use real addresses in frame_t instead of fixing it here
 125
 126     Frame* frame              = process_memory->find_function(remote(ip));
 127     stack_frame.frame         = frame;
 128
 129     if (frame) {
 130       stack_frame.frame_name = frame->name;
 131       stack_frame.frame_base = (unw_word_t)frame->frame_base(c);
 132     } else {
 133       stack_frame.frame_base = 0;
 134       stack_frame.frame_name = "";
 135     }
 136
 137     result.push_back(std::move(stack_frame));
 138
 139     /* Stop before context switch with maestro */
 140     if (frame != nullptr && frame->name == "smx_ctx_wrapper")
 141       break;
 142
 143     int ret = unw_step(&c);
 144     xbt_assert(ret >= 0, "Error while unwinding stack");
 145     xbt_assert(ret != 0, "Unexpected end of stack.");
 146   }
 147
 148   xbt_assert(not result.empty(), "unw_init_local failed");
 149
 150   return result;
 151 }
 152
 153 void Snapshot::snapshot_stacks(RemoteProcessMemory& process_memory)
 154 {
 155   for (auto const& stack : process_memory.stack_areas()) {
 156     s_mc_snapshot_stack_t st;
 157
 158     // Read the context from remote process memory:
 159     unw_context_t context;
 160     process_memory.read_bytes(&context, sizeof(context), remote(stack.context));
 161
 162     st.context.initialize(process_memory, &context);
 163
 164     st.stack_frames    = unwind_stack_frames(&st.context);
 165     st.local_variables = get_local_variables_values(st.stack_frames);
 166
 167     unw_word_t sp = st.stack_frames[0].sp;
 168
 169     stacks_.push_back(std::move(st));
 170
 171     size_t stack_size = (char*)stack.address + stack.size - (char*)sp;
 172     stack_sizes_.push_back(stack_size);
 173   }
 174 }
 175
 176 void Snapshot::handle_ignore()
 177 {
 178   xbt_assert(get_remote_process_memory());
 179
 180   // Copy the memory:
 181   for (auto const& region : get_remote_process_memory()->ignored_regions()) {
 182     s_mc_snapshot_ignored_data_t ignored_data;
 183     ignored_data.start = (void*)region.addr;
 184     ignored_data.data.resize(region.size);
 185     get_remote_process_memory()->read_bytes(ignored_data.data.data(), region.size, remote(region.addr));
 186     ignored_data_.push_back(std::move(ignored_data));
 187   }
 188
 189   // Zero the memory:
 190   for (auto const& region : get_remote_process_memory()->ignored_regions())
 191     get_remote_process_memory()->clear_bytes(remote(region.addr), region.size);
 192 }
 193
 194 void Snapshot::ignore_restore() const
 195 {
 196   for (auto const& ignored_data : ignored_data_)
 197     get_remote_process_memory()->write_bytes(ignored_data.data.data(), ignored_data.data.size(),
 198                                              remote(ignored_data.start));
 199 }
 200
 201 Snapshot::Snapshot(long num_state, PageStore& store, RemoteProcessMemory& memory)
 202     : AddressSpace(memory), page_store_(store), num_state_(num_state)
 203 {
 204   XBT_DEBUG("Taking snapshot %ld", num_state);
 205
 206   handle_ignore();
 207
 208   /* Save the std heap and the writable mapped pages of libsimgrid and binary */
 209   snapshot_regions(memory);
 210
 211   to_ignore_ = memory.ignored_heap();
 212
 213   if (_sg_mc_max_visited_states > 0 || not _sg_mc_property_file.get().empty()) {
 214     snapshot_stacks(memory);
 215     hash_ = this->do_hash();
 216   }
 217
 218   ignore_restore();
 219 }
 220
 221 void Snapshot::add_region(RegionType type, RemoteProcessMemory& memory, ObjectInformation* object_info,
 222                           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   auto* region = new Region(page_store_, memory, type, start_addr, size);
 230   region->object_info(object_info);
 231   snapshot_regions_.push_back(std::unique_ptr<Region>(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->get_remote_process_memory()->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(RemoteProcessMemory& memory) const
 276 {
 277   XBT_DEBUG("Restore snapshot %ld", num_state_);
 278
 279   // Restore regions
 280   for (std::unique_ptr<Region> const& region : snapshot_regions_) {
 281     region->restore(memory);
 282   }
 283
 284   ignore_restore();
 285   memory.clear_cache();
 286 }
 287
 288 /* ----------- Hashing logic -------------- */
 289 class djb_hash {
 290   hash_type state_ = 5381LL;
 291
 292 public:
 293   template <class T> void update(T& x) { state_ = (state_ << 5) + state_ + x; }
 294   hash_type value() const { return state_; }
 295 };
 296 hash_type Snapshot::do_hash() const
 297 {
 298   XBT_DEBUG("START hash %ld", num_state_);
 299   djb_hash hash;
 300   // TODO:
 301   // * nb_processes
 302   // * heap_bytes_used
 303   // * root variables
 304   // * basic stack frame information
 305   // * stack frame local variables
 306   XBT_DEBUG("END hash %ld", num_state_);
 307   return hash.value();
 308 }
 309
 310 } // namespace simgrid::mc