src/mc/sosp/mc_checkpoint.cpp

   1 /* Copyright (c) 2008-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 <unistd.h>
   7
   8 #ifndef WIN32
   9 #include <sys/mman.h>
  10 #endif
  11
  12 #include "src/internal_config.h"
  13 #include "src/mc/mc_private.hpp"
  14 #include "src/smpi/include/private.hpp"
  15 #include "xbt/file.hpp"
  16 #include "xbt/mmalloc.h"
  17 #include "xbt/module.h"
  18
  19 #include "src/xbt/mmalloc/mmprivate.h"
  20
  21 #include "src/simix/smx_private.hpp"
  22
  23 #include <libelf.h>
  24 #include <libunwind.h>
  25
  26 #include "src/mc/mc_private.hpp"
  27 #include <mc/mc.h>
  28
  29 #include "src/mc/mc_config.hpp"
  30 #include "src/mc/mc_hash.hpp"
  31 #include "src/mc/mc_mmu.hpp"
  32 #include "src/mc/mc_smx.hpp"
  33 #include "src/mc/remote/mc_protocol.h"
  34 #include "src/mc/sosp/mc_snapshot.hpp"
  35
  36 #include "src/mc/sosp/RegionSnapshot.hpp"
  37
  38 using simgrid::mc::remote;
  39
  40 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc, "Logging specific to mc_checkpoint");
  41
  42 #define PROT_RWX (PROT_READ | PROT_WRITE | PROT_EXEC)
  43 #define PROT_RW (PROT_READ | PROT_WRITE)
  44 #define PROT_RX (PROT_READ | PROT_EXEC)
  45
  46 namespace simgrid {
  47 namespace mc {
  48
  49 /************************************  Free functions **************************************/
  50 /*****************************************************************************************/
  51
  52 /** @brief Restore a region from a snapshot
  53  *
  54  *  @param region     Target region
  55  */
  56 static void restore(RegionSnapshot* region)
  57 {
  58   switch (region->storage_type()) {
  59     case simgrid::mc::StorageType::Flat:
  60       mc_model_checker->process().write_bytes(region->flat_data().get(), region->size(), region->permanent_address());
  61       break;
  62
  63     case simgrid::mc::StorageType::Chunked:
  64       xbt_assert(((region->permanent_address().address()) & (xbt_pagesize - 1)) == 0, "Not at the beginning of a page");
  65       xbt_assert(simgrid::mc::mmu::chunk_count(region->size()) == region->page_data().page_count());
  66
  67       for (size_t i = 0; i != region->page_data().page_count(); ++i) {
  68         void* target_page =
  69             (void*)simgrid::mc::mmu::join(i, (std::uintptr_t)(void*)region->permanent_address().address());
  70         const void* source_page = region->page_data().page(i);
  71         mc_model_checker->process().write_bytes(source_page, xbt_pagesize, remote(target_page));
  72       }
  73
  74       break;
  75
  76     case simgrid::mc::StorageType::Privatized:
  77       for (auto& p : region->privatized_data())
  78         restore(p.get());
  79       break;
  80
  81     default: // includes StorageType::NoData
  82       xbt_die("Storage type not supported");
  83       break;
  84   }
  85 }
  86
  87 static void get_memory_regions(simgrid::mc::RemoteClient* process, simgrid::mc::Snapshot* snapshot)
  88 {
  89   snapshot->snapshot_regions_.clear();
  90
  91   for (auto const& object_info : process->object_infos)
  92     snapshot->add_region(simgrid::mc::RegionType::Data, object_info.get(), object_info->start_rw, object_info->start_rw,
  93                          object_info->end_rw - object_info->start_rw);
  94
  95   xbt_mheap_t heap = process->get_heap();
  96   void* start_heap = heap->base;
  97   void* end_heap   = heap->breakval;
  98
  99   snapshot->add_region(simgrid::mc::RegionType::Heap, nullptr, start_heap, start_heap,
 100                        (char*)end_heap - (char*)start_heap);
 101   snapshot->heap_bytes_used_ = mmalloc_get_bytes_used_remote(heap->heaplimit, process->get_malloc_info());
 102   snapshot->privatization_index_ = simgrid::mc::ProcessIndexMissing;
 103
 104 #if HAVE_SMPI
 105   if (mc_model_checker->process().privatized() && MC_smpi_process_count())
 106     // snapshot->privatization_index = smpi_loaded_page
 107     mc_model_checker->process().read_variable("smpi_loaded_page", &snapshot->privatization_index_,
 108                                               sizeof(snapshot->privatization_index_));
 109 #endif
 110 }
 111
 112 /** @brief Fills the position of the segments (executable, read-only, read/write).
 113  * */
 114 // TODO, use the ELF segment information for more robustness
 115 void find_object_address(std::vector<simgrid::xbt::VmMap> const& maps, simgrid::mc::ObjectInformation* result)
 116 {
 117   std::string name = simgrid::xbt::Path(result->file_name).get_base_name();
 118
 119   for (size_t i = 0; i < maps.size(); ++i) {
 120     simgrid::xbt::VmMap const& reg = maps[i];
 121     if (maps[i].pathname.empty())
 122       continue;
 123     std::string map_basename = simgrid::xbt::Path(maps[i].pathname).get_base_name();
 124     if (map_basename != name)
 125       continue;
 126
 127     // This is the non-GNU_RELRO-part of the data segment:
 128     if (reg.prot == PROT_RW) {
 129       xbt_assert(not result->start_rw, "Multiple read-write segments for %s, not supported", maps[i].pathname.c_str());
 130       result->start_rw = (char*)reg.start_addr;
 131       result->end_rw   = (char*)reg.end_addr;
 132
 133       // The next VMA might be end of the data segment:
 134       if (i + 1 < maps.size() && maps[i + 1].pathname.empty() && maps[i + 1].prot == PROT_RW &&
 135           maps[i + 1].start_addr == reg.end_addr)
 136         result->end_rw = (char*)maps[i + 1].end_addr;
 137     }
 138
 139     // This is the text segment:
 140     else if (reg.prot == PROT_RX) {
 141       xbt_assert(not result->start_exec, "Multiple executable segments for %s, not supported",
 142                  maps[i].pathname.c_str());
 143       result->start_exec = (char*)reg.start_addr;
 144       result->end_exec   = (char*)reg.end_addr;
 145
 146       // The next VMA might be end of the data segment:
 147       if (i + 1 < maps.size() && maps[i + 1].pathname.empty() && maps[i + 1].prot == PROT_RW &&
 148           maps[i + 1].start_addr == reg.end_addr) {
 149         result->start_rw = (char*)maps[i + 1].start_addr;
 150         result->end_rw   = (char*)maps[i + 1].end_addr;
 151       }
 152     }
 153
 154     // This is the GNU_RELRO-part of the data segment:
 155     else if (reg.prot == PROT_READ) {
 156       xbt_assert(not result->start_ro, "Multiple read only segments for %s, not supported", maps[i].pathname.c_str());
 157       result->start_ro = (char*)reg.start_addr;
 158       result->end_ro   = (char*)reg.end_addr;
 159     }
 160   }
 161
 162   result->start = result->start_rw;
 163   if ((const void*)result->start_ro < result->start)
 164     result->start = result->start_ro;
 165   if ((const void*)result->start_exec < result->start)
 166     result->start = result->start_exec;
 167
 168   result->end = result->end_rw;
 169   if (result->end_ro && (const void*)result->end_ro > result->end)
 170     result->end = result->end_ro;
 171   if (result->end_exec && (const void*)result->end_exec > result->end)
 172     result->end = result->end_exec;
 173
 174   xbt_assert(result->start_exec || result->start_rw || result->start_ro);
 175 }
 176
 177 /************************************* Take Snapshot ************************************/
 178 /****************************************************************************************/
 179
 180 /** @brief Checks whether the variable is in scope for a given IP.
 181  *
 182  *  A variable may be defined only from a given value of IP.
 183  *
 184  *  @param var   Variable description
 185  *  @param scope Scope description
 186  *  @param ip    Instruction pointer
 187  *  @return      true if the variable is valid
 188  * */
 189 static bool valid_variable(simgrid::mc::Variable* var, simgrid::mc::Frame* scope, const void* ip)
 190 {
 191   // The variable is not yet valid:
 192   if (scope->range.begin() + var->start_scope > (std::uint64_t)ip)
 193     return false;
 194   else
 195     return true;
 196 }
 197
 198 static void fill_local_variables_values(mc_stack_frame_t stack_frame, simgrid::mc::Frame* scope, int process_index,
 199                                         std::vector<s_local_variable_t>& result)
 200 {
 201   if (not scope || not scope->range.contain(stack_frame->ip))
 202     return;
 203
 204   for (simgrid::mc::Variable& current_variable : scope->variables) {
 205
 206     if (not valid_variable(&current_variable, scope, (void*)stack_frame->ip))
 207       continue;
 208
 209     s_local_variable_t new_var;
 210     new_var.subprogram = stack_frame->frame;
 211     new_var.ip         = stack_frame->ip;
 212     new_var.name       = current_variable.name;
 213     new_var.type       = current_variable.type;
 214     new_var.address    = nullptr;
 215
 216     if (current_variable.address != nullptr)
 217       new_var.address = current_variable.address;
 218     else if (not current_variable.location_list.empty()) {
 219       simgrid::dwarf::Location location = simgrid::dwarf::resolve(
 220           current_variable.location_list, current_variable.object_info, &(stack_frame->unw_cursor),
 221           (void*)stack_frame->frame_base, &mc_model_checker->process(), process_index);
 222
 223       if (not location.in_memory())
 224         xbt_die("Cannot handle non-address variable");
 225       new_var.address = location.address();
 226
 227     } else
 228       xbt_die("No address");
 229
 230     result.push_back(std::move(new_var));
 231   }
 232
 233   // Recursive processing of nested scopes:
 234   for (simgrid::mc::Frame& nested_scope : scope->scopes)
 235     fill_local_variables_values(stack_frame, &nested_scope, process_index, result);
 236 }
 237
 238 static std::vector<s_local_variable_t> get_local_variables_values(std::vector<s_mc_stack_frame_t>& stack_frames,
 239                                                                   int process_index)
 240 {
 241   std::vector<s_local_variable_t> variables;
 242   for (s_mc_stack_frame_t& stack_frame : stack_frames)
 243     fill_local_variables_values(&stack_frame, stack_frame.frame, process_index, variables);
 244   return variables;
 245 }
 246
 247 static std::vector<s_mc_stack_frame_t> unwind_stack_frames(simgrid::mc::UnwindContext* stack_context)
 248 {
 249   simgrid::mc::RemoteClient* process = &mc_model_checker->process();
 250   std::vector<s_mc_stack_frame_t> result;
 251
 252   unw_cursor_t c = stack_context->cursor();
 253
 254   // TODO, check condition check (unw_init_local==0 means end of frame)
 255
 256   while (1) {
 257
 258     s_mc_stack_frame_t stack_frame;
 259
 260     stack_frame.unw_cursor = c;
 261
 262     unw_word_t ip;
 263     unw_word_t sp;
 264
 265     unw_get_reg(&c, UNW_REG_IP, &ip);
 266     unw_get_reg(&c, UNW_REG_SP, &sp);
 267
 268     stack_frame.ip = ip;
 269     stack_frame.sp = sp;
 270
 271     // TODO, use real addresses in frame_t instead of fixing it here
 272
 273     simgrid::mc::Frame* frame = process->find_function(remote(ip));
 274     stack_frame.frame         = frame;
 275
 276     if (frame) {
 277       stack_frame.frame_name = frame->name;
 278       stack_frame.frame_base = (unw_word_t)frame->frame_base(c);
 279     } else {
 280       stack_frame.frame_base = 0;
 281       stack_frame.frame_name = std::string();
 282     }
 283
 284     result.push_back(std::move(stack_frame));
 285
 286     /* Stop before context switch with maestro */
 287     if (frame != nullptr && frame->name == "smx_ctx_wrapper")
 288       break;
 289
 290     int ret = unw_step(&c);
 291     if (ret == 0)
 292       xbt_die("Unexpected end of stack.");
 293     else if (ret < 0)
 294       xbt_die("Error while unwinding stack");
 295   }
 296
 297   xbt_assert(not result.empty(), "unw_init_local failed");
 298
 299   return result;
 300 }
 301
 302 static void take_snapshot_stacks(simgrid::mc::Snapshot* snapshot)
 303 {
 304   for (auto const& stack : mc_model_checker->process().stack_areas()) {
 305     s_mc_snapshot_stack_t st;
 306
 307     // Read the context from remote process:
 308     unw_context_t context;
 309     mc_model_checker->process().read_bytes(&context, sizeof(context), remote(stack.context));
 310
 311     st.context.initialize(&mc_model_checker->process(), &context);
 312
 313     st.stack_frames    = unwind_stack_frames(&st.context);
 314     st.local_variables = get_local_variables_values(st.stack_frames, stack.process_index);
 315     st.process_index   = stack.process_index;
 316
 317     unw_word_t sp = st.stack_frames[0].sp;
 318
 319     snapshot->stacks_.push_back(std::move(st));
 320
 321     size_t stack_size = (char*)stack.address + stack.size - (char*)sp;
 322     snapshot->stack_sizes_.push_back(stack_size);
 323   }
 324 }
 325
 326 static void snapshot_handle_ignore(simgrid::mc::Snapshot* snapshot)
 327 {
 328   xbt_assert(snapshot->process());
 329
 330   // Copy the memory:
 331   for (auto const& region : mc_model_checker->process().ignored_regions()) {
 332     s_mc_snapshot_ignored_data_t ignored_data;
 333     ignored_data.start = (void*)region.addr;
 334     ignored_data.data.resize(region.size);
 335     // TODO, we should do this once per privatization segment:
 336     snapshot->process()->read_bytes(ignored_data.data.data(), region.size, remote(region.addr),
 337                                     simgrid::mc::ProcessIndexDisabled);
 338     snapshot->ignored_data_.push_back(std::move(ignored_data));
 339   }
 340
 341   // Zero the memory:
 342   for (auto const& region : mc_model_checker->process().ignored_regions())
 343     snapshot->process()->clear_bytes(remote(region.addr), region.size);
 344 }
 345
 346 static void snapshot_ignore_restore(simgrid::mc::Snapshot* snapshot)
 347 {
 348   for (auto const& ignored_data : snapshot->ignored_data_)
 349     snapshot->process()->write_bytes(ignored_data.data.data(), ignored_data.data.size(), remote(ignored_data.start));
 350 }
 351
 352 std::shared_ptr<simgrid::mc::Snapshot> take_snapshot(int num_state)
 353 {
 354   XBT_DEBUG("Taking snapshot %i", num_state);
 355
 356   simgrid::mc::RemoteClient* mc_process = &mc_model_checker->process();
 357
 358   std::shared_ptr<simgrid::mc::Snapshot> snapshot = std::make_shared<simgrid::mc::Snapshot>(mc_process, num_state);
 359
 360   for (auto const& p : mc_model_checker->process().actors())
 361     snapshot->enabled_processes_.insert(p.copy.getBuffer()->get_pid());
 362
 363   snapshot_handle_ignore(snapshot.get());
 364
 365   /* Save the std heap and the writable mapped pages of libsimgrid and binary */
 366   get_memory_regions(mc_process, snapshot.get());
 367
 368   snapshot->to_ignore_ = mc_model_checker->process().ignored_heap();
 369
 370   if (_sg_mc_max_visited_states > 0 || not _sg_mc_property_file.get().empty()) {
 371     take_snapshot_stacks(snapshot.get());
 372     if (_sg_mc_hash)
 373       snapshot->hash_ = simgrid::mc::hash(*snapshot);
 374   }
 375
 376   snapshot_ignore_restore(snapshot.get());
 377   return snapshot;
 378 }
 379
 380 static inline void restore_snapshot_regions(simgrid::mc::Snapshot* snapshot)
 381 {
 382   for (std::unique_ptr<simgrid::mc::RegionSnapshot> const& region : snapshot->snapshot_regions_) {
 383     // For privatized, variables we decided it was not necessary to take the snapshot:
 384     if (region)
 385       restore(region.get());
 386   }
 387
 388 #if HAVE_SMPI
 389   if (snapshot->privatization_index_ >= 0) {
 390     // Fix the privatization mmap:
 391     s_mc_message_restore_t message{MC_MESSAGE_RESTORE, snapshot->privatization_index_};
 392     mc_model_checker->process().getChannel().send(message);
 393   }
 394 #endif
 395 }
 396
 397 void restore_snapshot(std::shared_ptr<simgrid::mc::Snapshot> snapshot)
 398 {
 399   XBT_DEBUG("Restore snapshot %i", snapshot->num_state_);
 400   restore_snapshot_regions(snapshot.get());
 401   snapshot_ignore_restore(snapshot.get());
 402   mc_model_checker->process().clear_cache();
 403 }
 404
 405 } // namespace mc
 406 } // namespace simgrid