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