src/mc/mc_snapshot.h

   1 /* Copyright (c) 2007-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef MC_SNAPSHOT_H
   8 #define MC_SNAPSHOT_H
   9
  10 #include <sys/types.h> // off_t
  11 #include <stdint.h> // size_t
  12
  13 #include <simgrid_config.h>
  14 #include "../xbt/mmalloc/mmprivate.h"
  15 #include <xbt/asserts.h>
  16 #include <xbt/dynar.h>
  17
  18 #include "mc_forward.h"
  19 #include "ModelChecker.hpp"
  20 #include "PageStore.hpp"
  21 #include "mc_mmalloc.h"
  22 #include "mc/AddressSpace.hpp"
  23 #include "mc_unw.h"
  24
  25 SG_BEGIN_DECL()
  26
  27 // ***** Snapshot region
  28
  29 typedef enum e_mc_region_type_t {
  30   MC_REGION_TYPE_UNKNOWN = 0,
  31   MC_REGION_TYPE_HEAP = 1,
  32   MC_REGION_TYPE_DATA = 2
  33 } mc_region_type_t;
  34
  35 // TODO, use OO instead of this
  36 typedef enum e_mc_region_storeage_type_t {
  37   MC_REGION_STORAGE_TYPE_NONE = 0,
  38   MC_REGION_STORAGE_TYPE_FLAT = 1,
  39   MC_REGION_STORAGE_TYPE_CHUNKED = 2,
  40   MC_REGION_STORAGE_TYPE_PRIVATIZED = 3
  41 } mc_region_storage_type_t;
  42
  43 namespace simgrid {
  44 namespace mc {
  45
  46 class PerPageCopy {
  47   PageStore* store_;
  48   std::vector<std::size_t> pagenos_;
  49 public:
  50   PerPageCopy() : store_(nullptr) {}
  51   PerPageCopy(PerPageCopy const& that)
  52   {
  53     store_ = that.store_;
  54     pagenos_ = that.pagenos_;
  55     for (std::size_t pageno : pagenos_)
  56       store_->ref_page(pageno);
  57   }
  58   void clear()
  59   {
  60     for (std::size_t pageno : pagenos_)
  61       store_->unref_page(pageno);
  62     pagenos_.clear();
  63   }
  64   ~PerPageCopy() {
  65     clear();
  66   }
  67
  68   PerPageCopy(PerPageCopy&& that)
  69   {
  70     store_ = that.store_;
  71     that.store_ = nullptr;
  72     pagenos_ = std::move(that.pagenos_);
  73     that.pagenos_.clear();
  74   }
  75   PerPageCopy& operator=(PerPageCopy const& that)
  76   {
  77     this->clear();
  78     store_ = that.store_;
  79     pagenos_ = that.pagenos_;
  80     for (std::size_t pageno : pagenos_)
  81       store_->ref_page(pageno);
  82     return *this;
  83   }
  84   PerPageCopy& operator=(PerPageCopy && that)
  85   {
  86     this->clear();
  87     store_ = that.store_;
  88     that.store_ = nullptr;
  89     pagenos_ = std::move(that.pagenos_);
  90     that.pagenos_.clear();
  91     return *this;
  92   }
  93
  94   std::size_t page_count() const
  95   {
  96     return pagenos_.size();
  97   }
  98
  99   std::size_t pageno(std::size_t i) const
 100   {
 101     return pagenos_[i];
 102   }
 103
 104   const void* page(std::size_t i) const
 105   {
 106     return store_->get_page(pagenos_[i]);
 107   }
 108
 109   PerPageCopy(PageStore& store, AddressSpace& as,
 110     remote_ptr<void> addr, std::size_t page_count);
 111 };
 112
 113 /** @brief Copy/snapshot of a given memory region
 114  *
 115  *  Different types of region snapshot storage types exist:
 116  *  <ul>
 117  *    <li>flat/dense snapshots are a simple copy of the region;</li>
 118  *    <li>sparse/per-page snapshots are snaapshots which shared
 119  *    identical pages.</li>
 120  *    <li>privatized (SMPI global variable privatisation).
 121  *  </ul>
 122  *
 123  *  This is handled with a variant based approch:
 124  *
 125  *    * `storage_type` identified the type of storage;
 126  *    * an anonymous enum is used to distinguish the relevant types for
 127  *      each type.
 128  */
 129 class RegionSnapshot {
 130 public:
 131   mc_region_type_t region_type;
 132   mc_region_storage_type_t storage_type;
 133   mc_object_info_t object_info;
 134
 135   /** @brief  Virtual address of the region in the simulated process */
 136   void *start_addr;
 137
 138   /** @brief Size of the data region in bytes */
 139   size_t size;
 140
 141   /** @brief Permanent virtual address of the region
 142    *
 143    * This is usually the same address as the simuilated process address.
 144    * However, when using SMPI privatization of global variables,
 145    * each SMPI process has its own set of global variables stored
 146    * at a different virtual address. The scheduler maps those region
 147    * on the region of the global variables.
 148    *
 149    * */
 150   void *permanent_addr;
 151
 152 private:
 153   std::vector<char> flat_data_;
 154   PerPageCopy page_numbers_;
 155   std::vector<std::unique_ptr<RegionSnapshot>> privatized_regions_;
 156 public:
 157   RegionSnapshot() :
 158     region_type(MC_REGION_TYPE_UNKNOWN),
 159     storage_type(MC_REGION_STORAGE_TYPE_NONE),
 160     object_info(nullptr),
 161     start_addr(nullptr),
 162     size(0),
 163     permanent_addr(nullptr)
 164   {}
 165   RegionSnapshot(mc_region_type_t type, void *start_addr, void* permanent_addr, size_t size) :
 166     region_type(type),
 167     storage_type(MC_REGION_STORAGE_TYPE_NONE),
 168     object_info(nullptr),
 169     start_addr(start_addr),
 170     size(size),
 171     permanent_addr(permanent_addr)
 172   {}
 173   ~RegionSnapshot();
 174   RegionSnapshot(RegionSnapshot const&) = delete;
 175   RegionSnapshot& operator=(RegionSnapshot const&) = delete;
 176
 177   void clear_data()
 178   {
 179     storage_type = MC_REGION_STORAGE_TYPE_NONE;
 180     flat_data_.clear();
 181     page_numbers_.clear();
 182     privatized_regions_.clear();
 183   }
 184
 185   void flat_data(std::vector<char> data)
 186   {
 187     storage_type = MC_REGION_STORAGE_TYPE_FLAT;
 188     flat_data_ = std::move(data);
 189     page_numbers_.clear();
 190     privatized_regions_.clear();
 191   }
 192   std::vector<char> const& flat_data() const { return flat_data_; }
 193
 194   void page_data(PerPageCopy page_data)
 195   {
 196     storage_type = MC_REGION_STORAGE_TYPE_CHUNKED;
 197     flat_data_.clear();
 198     page_numbers_ = std::move(page_data);
 199     privatized_regions_.clear();
 200   }
 201   PerPageCopy const& page_data() const { return page_numbers_; }
 202
 203   void privatized_data(std::vector<std::unique_ptr<RegionSnapshot>> data)
 204   {
 205     storage_type = MC_REGION_STORAGE_TYPE_PRIVATIZED;
 206     flat_data_.clear();
 207     page_numbers_.clear();
 208     privatized_regions_ = std::move(data);
 209   }
 210   std::vector<std::unique_ptr<RegionSnapshot>> const& privatized_data() const
 211   {
 212     return privatized_regions_;
 213   }
 214 };
 215
 216 }
 217 }
 218
 219 typedef class simgrid::mc::RegionSnapshot s_mc_mem_region_t, *mc_mem_region_t;
 220
 221 MC_SHOULD_BE_INTERNAL mc_mem_region_t mc_region_new_sparse(
 222   mc_region_type_t type, void *start_addr, void* data_addr, size_t size);
 223 XBT_INTERNAL void mc_region_restore_sparse(mc_process_t process, mc_mem_region_t reg);
 224
 225 static inline  __attribute__ ((always_inline))
 226 bool mc_region_contain(mc_mem_region_t region, const void* p)
 227 {
 228   return p >= region->start_addr &&
 229     p < (void*)((char*) region->start_addr + region->size);
 230 }
 231
 232 static inline __attribute__((always_inline))
 233 void* mc_translate_address_region_chunked(uintptr_t addr, mc_mem_region_t region)
 234 {
 235   size_t pageno = mc_page_number(region->start_addr, (void*) addr);
 236   const void* snapshot_page =
 237     region->page_data().page(pageno);
 238   return (char*) snapshot_page + mc_page_offset((void*) addr);
 239 }
 240
 241 static inline __attribute__((always_inline))
 242 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region, int process_index)
 243 {
 244   switch (region->storage_type) {
 245   case MC_REGION_STORAGE_TYPE_NONE:
 246   default:
 247     xbt_die("Storage type not supported");
 248
 249   case MC_REGION_STORAGE_TYPE_FLAT:
 250     {
 251       uintptr_t offset = addr - (uintptr_t) region->start_addr;
 252       return (void *) ((uintptr_t) region->flat_data().data() + offset);
 253     }
 254
 255   case MC_REGION_STORAGE_TYPE_CHUNKED:
 256     return mc_translate_address_region_chunked(addr, region);
 257
 258   case MC_REGION_STORAGE_TYPE_PRIVATIZED:
 259     {
 260       xbt_assert(process_index >=0,
 261         "Missing process index for privatized region");
 262       xbt_assert((size_t) process_index < region->privatized_data().size(),
 263         "Out of range process index");
 264       mc_mem_region_t subregion = region->privatized_data()[process_index].get();
 265       xbt_assert(subregion, "Missing memory region for process %i", process_index);
 266       return mc_translate_address_region(addr, subregion, process_index);
 267     }
 268   }
 269 }
 270
 271 XBT_INTERNAL mc_mem_region_t mc_get_snapshot_region(
 272   const void* addr, const s_mc_snapshot_t *snapshot, int process_index);
 273
 274 // ***** MC Snapshot
 275
 276 /** Ignored data
 277  *
 278  *  Some parts of the snapshot are ignored by zeroing them out: the real
 279  *  values is stored here.
 280  * */
 281 typedef struct s_mc_snapshot_ignored_data {
 282   void* start;
 283   size_t size;
 284   void* data;
 285 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
 286
 287 typedef struct s_fd_infos{
 288   char *filename;
 289   int number;
 290   off_t current_position;
 291   int flags;
 292 }s_fd_infos_t, *fd_infos_t;
 293
 294 }
 295
 296 namespace simgrid {
 297 namespace mc {
 298
 299 class Snapshot : public AddressSpace {
 300 public:
 301   Snapshot();
 302   ~Snapshot();
 303   const void* read_bytes(void* buffer, std::size_t size,
 304     remote_ptr<void> address, int process_index = ProcessIndexAny,
 305     ReadMode mode = Normal) const MC_OVERRIDE;
 306 public: // To be private
 307   mc_process_t process;
 308   int num_state;
 309   size_t heap_bytes_used;
 310   mc_mem_region_t* snapshot_regions;
 311   size_t snapshot_regions_count;
 312   xbt_dynar_t enabled_processes;
 313   int privatization_index;
 314   size_t *stack_sizes;
 315   xbt_dynar_t stacks;
 316   xbt_dynar_t to_ignore;
 317   uint64_t hash;
 318   xbt_dynar_t ignored_data;
 319   int total_fd;
 320   fd_infos_t *current_fd;
 321 };
 322
 323 }
 324 }
 325
 326 extern "C" {
 327
 328 static inline __attribute__ ((always_inline))
 329 mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
 330 {
 331   if (mc_region_contain(region, addr))
 332     return region;
 333   else
 334     return mc_get_snapshot_region(addr, snapshot, process_index);
 335 }
 336
 337 /** Information about a given stack frame
 338  *
 339  */
 340 typedef struct s_mc_stack_frame {
 341   /** Instruction pointer */
 342   unw_word_t ip;
 343   /** Stack pointer */
 344   unw_word_t sp;
 345   unw_word_t frame_base;
 346   dw_frame_t frame;
 347   char* frame_name;
 348   unw_cursor_t unw_cursor;
 349 } s_mc_stack_frame_t, *mc_stack_frame_t;
 350
 351 typedef struct s_mc_snapshot_stack{
 352   xbt_dynar_t local_variables;
 353   mc_unw_context_t context;
 354   xbt_dynar_t stack_frames; // mc_stack_frame_t
 355   int process_index;
 356 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
 357
 358 typedef struct s_mc_global_t {
 359   mc_snapshot_t snapshot;
 360   int prev_pair;
 361   char *prev_req;
 362   int initial_communications_pattern_done;
 363   int recv_deterministic;
 364   int send_deterministic;
 365   char *send_diff;
 366   char *recv_diff;
 367 }s_mc_global_t, *mc_global_t;
 368
 369 static const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
 370
 371 XBT_INTERNAL mc_snapshot_t MC_take_snapshot(int num_state);
 372 XBT_INTERNAL void MC_restore_snapshot(mc_snapshot_t);
 373
 374 XBT_INTERNAL void mc_restore_page_snapshot_region(
 375   mc_process_t process,
 376   void* start_addr, simgrid::mc::PerPageCopy const& pagenos);
 377
 378 MC_SHOULD_BE_INTERNAL const void* MC_region_read_fragmented(
 379   mc_mem_region_t region, void* target, const void* addr, size_t size);
 380
 381 // Deprecated compatibility wrapper
 382 static inline
 383 const void* MC_snapshot_read(mc_snapshot_t snapshot,
 384   simgrid::mc::AddressSpace::ReadMode mode,
 385   void* target, const void* addr, size_t size, int process_index)
 386 {
 387   return snapshot->read_bytes(target, size, simgrid::mc::remote(addr),
 388     process_index, mode);
 389 }
 390
 391 MC_SHOULD_BE_INTERNAL int MC_snapshot_region_memcmp(
 392   const void* addr1, mc_mem_region_t region1,
 393   const void* addr2, mc_mem_region_t region2, size_t size);
 394 XBT_INTERNAL int MC_snapshot_memcmp(
 395   const void* addr1, mc_snapshot_t snapshot1,
 396   const void* addr2, mc_snapshot_t snapshot2, int process_index, size_t size);
 397
 398 static inline __attribute__ ((always_inline))
 399 const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot)
 400 {
 401   if(snapshot==NULL)
 402       xbt_die("snapshot is NULL");
 403   return mc_model_checker->process().get_heap()->breakval;
 404 }
 405
 406 /** @brief Read memory from a snapshot region
 407  *
 408  *  @param addr    Process (non-snapshot) address of the data
 409  *  @param region  Snapshot memory region where the data is located
 410  *  @param target  Buffer to store the value
 411  *  @param size    Size of the data to read in bytes
 412  *  @return Pointer where the data is located (target buffer of original location)
 413  */
 414 static inline __attribute__((always_inline))
 415 const void* MC_region_read(mc_mem_region_t region, void* target, const void* addr, size_t size)
 416 {
 417   xbt_assert(region);
 418
 419   uintptr_t offset = (char*) addr - (char*) region->start_addr;
 420
 421   xbt_assert(mc_region_contain(region, addr),
 422     "Trying to read out of the region boundary.");
 423
 424   switch (region->storage_type) {
 425   case MC_REGION_STORAGE_TYPE_NONE:
 426   default:
 427     xbt_die("Storage type not supported");
 428
 429   case MC_REGION_STORAGE_TYPE_FLAT:
 430     return (char*) region->flat_data().data() + offset;
 431
 432   case MC_REGION_STORAGE_TYPE_CHUNKED:
 433     {
 434       // Last byte of the region:
 435       void* end = (char*) addr + size - 1;
 436       if (mc_same_page(addr, end) ) {
 437         // The memory is contained in a single page:
 438         return mc_translate_address_region_chunked((uintptr_t) addr, region);
 439       } else {
 440         // The memory spans several pages:
 441         return MC_region_read_fragmented(region, target, addr, size);
 442       }
 443     }
 444
 445   // We currently do not pass the process_index to this function so we assume
 446   // that the privatized region has been resolved in the callers:
 447   case MC_REGION_STORAGE_TYPE_PRIVATIZED:
 448     xbt_die("Storage type not supported");
 449   }
 450 }
 451
 452 static inline __attribute__ ((always_inline))
 453 void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
 454 {
 455   void* res;
 456   return *(void**) MC_region_read(region, &res, addr, sizeof(void*));
 457 }
 458
 459 SG_END_DECL()
 460
 461 #endif