Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Use vector<RegionSnapshot> instead of vector<unique_ptr<RegionSnapshot>> in...
[simgrid.git] / 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_storage_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 private:
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   std::vector<char> flat_data_;
153   PerPageCopy page_numbers_;
154   std::vector<RegionSnapshot> privatized_regions_;
155 public:
156   RegionSnapshot() :
157     region_type_(MC_REGION_TYPE_UNKNOWN),
158     storage_type_(MC_REGION_STORAGE_TYPE_NONE),
159     object_info_(nullptr),
160     start_addr_(nullptr),
161     size_(0),
162     permanent_addr_(nullptr)
163   {}
164   RegionSnapshot(mc_region_type_t type, void *start_addr, void* permanent_addr, size_t size) :
165     region_type_(type),
166     storage_type_(MC_REGION_STORAGE_TYPE_NONE),
167     object_info_(nullptr),
168     start_addr_(start_addr),
169     size_(size),
170     permanent_addr_(permanent_addr)
171   {}
172   ~RegionSnapshot();
173   RegionSnapshot(RegionSnapshot const&) = default;
174   RegionSnapshot& operator=(RegionSnapshot const&) = default;
175   RegionSnapshot(RegionSnapshot&& that)
176   {
177     region_type_ = that.region_type_;
178     storage_type_ = that.storage_type_;
179     object_info_ = that.object_info_;
180     start_addr_ = that.start_addr_;
181     size_ = that.size_;
182     permanent_addr_ = that.permanent_addr_;
183     flat_data_ = std::move(that.flat_data_);
184     page_numbers_ = std::move(that.page_numbers_);
185     privatized_regions_ = std::move(that.privatized_regions_);
186     that.clear();
187   }
188   RegionSnapshot& operator=(RegionSnapshot&& that)
189   {
190     region_type_ = that.region_type_;
191     storage_type_ = that.storage_type_;
192     object_info_ = that.object_info_;
193     start_addr_ = that.start_addr_;
194     size_ = that.size_;
195     permanent_addr_ = that.permanent_addr_;
196     flat_data_ = std::move(that.flat_data_);
197     page_numbers_ = std::move(that.page_numbers_);
198     privatized_regions_ = std::move(that.privatized_regions_);
199     that.clear();
200     return *this;
201   }
202
203   // Data
204
205   void clear()
206   {
207     region_type_ = MC_REGION_TYPE_UNKNOWN;
208     storage_type_ = MC_REGION_STORAGE_TYPE_NONE;
209     privatized_regions_.clear();
210     page_numbers_.clear();
211     flat_data_.clear();
212     object_info_ = nullptr;
213     start_addr_ = nullptr;
214     size_ = 0;
215     permanent_addr_ = nullptr;
216   }
217
218   void clear_data()
219   {
220     storage_type_ = MC_REGION_STORAGE_TYPE_NONE;
221     flat_data_.clear();
222     page_numbers_.clear();
223     privatized_regions_.clear();
224   }
225   
226   void flat_data(std::vector<char> data)
227   {
228     storage_type_ = MC_REGION_STORAGE_TYPE_FLAT;
229     flat_data_ = std::move(data);
230     page_numbers_.clear();
231     privatized_regions_.clear();
232   }
233   std::vector<char> const& flat_data() const { return flat_data_; }
234
235   void page_data(PerPageCopy page_data)
236   {
237     storage_type_ = MC_REGION_STORAGE_TYPE_CHUNKED;
238     flat_data_.clear();
239     page_numbers_ = std::move(page_data);
240     privatized_regions_.clear();
241   }
242   PerPageCopy const& page_data() const { return page_numbers_; }
243
244   void privatized_data(std::vector<RegionSnapshot> data)
245   {
246     storage_type_ = MC_REGION_STORAGE_TYPE_PRIVATIZED;
247     flat_data_.clear();
248     page_numbers_.clear();
249     privatized_regions_ = std::move(data);
250   }
251   std::vector<RegionSnapshot> const& privatized_data() const
252   {
253     return privatized_regions_;
254   }
255   std::vector<RegionSnapshot>& privatized_data()
256   {
257     return privatized_regions_;
258   }
259
260   mc_object_info_t object_info() const { return object_info_; }
261   void object_info(mc_object_info_t info) { object_info_ = info; }
262
263   // Other getters
264
265   remote_ptr<void> start() const { return remote(start_addr_); }
266   remote_ptr<void> end() const { return remote((char*)start_addr_ + size_); }
267   remote_ptr<void> permanent_address() const { return remote(permanent_addr_); }
268   std::size_t size() const { return size_; }
269   mc_region_storage_type_t storage_type() const { return storage_type_; }
270   mc_region_type_t region_type() const { return region_type_; }
271
272   bool contain(remote_ptr<void> p) const
273   {
274     return p >= start() && p < end();
275   }
276 };
277
278 }
279 }
280
281 typedef class simgrid::mc::RegionSnapshot s_mc_mem_region_t, *mc_mem_region_t;
282
283 MC_SHOULD_BE_INTERNAL simgrid::mc::RegionSnapshot MC_region_sparse(
284   mc_region_type_t type, void *start_addr, void* data_addr, size_t size);
285 XBT_INTERNAL void mc_region_restore_sparse(mc_process_t process, mc_mem_region_t reg);
286
287 static inline  __attribute__ ((always_inline))
288 bool mc_region_contain(mc_mem_region_t region, const void* p)
289 {
290   return region->contain(simgrid::mc::remote(p));
291 }
292
293 static inline __attribute__((always_inline))
294 void* mc_translate_address_region_chunked(uintptr_t addr, mc_mem_region_t region)
295 {
296   size_t pageno = mc_page_number((void*)region->start().address(), (void*) addr);
297   const void* snapshot_page =
298     region->page_data().page(pageno);
299   return (char*) snapshot_page + mc_page_offset((void*) addr);
300 }
301
302 static inline __attribute__((always_inline))
303 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region, int process_index)
304 {
305   switch (region->storage_type()) {
306   case MC_REGION_STORAGE_TYPE_NONE:
307   default:
308     xbt_die("Storage type not supported");
309
310   case MC_REGION_STORAGE_TYPE_FLAT:
311     {
312       uintptr_t offset = (uintptr_t) addr - (uintptr_t) region->start().address();
313       return (void *) ((uintptr_t) region->flat_data().data() + offset);
314     }
315
316   case MC_REGION_STORAGE_TYPE_CHUNKED:
317     return mc_translate_address_region_chunked(addr, region);
318
319   case MC_REGION_STORAGE_TYPE_PRIVATIZED:
320     {
321       xbt_assert(process_index >=0,
322         "Missing process index for privatized region");
323       xbt_assert((size_t) process_index < region->privatized_data().size(),
324         "Out of range process index");
325       simgrid::mc::RegionSnapshot& subregion= region->privatized_data()[process_index];
326       return mc_translate_address_region(addr, &subregion, process_index);
327     }
328   }
329 }
330
331 XBT_INTERNAL mc_mem_region_t mc_get_snapshot_region(
332   const void* addr, const s_mc_snapshot_t *snapshot, int process_index);
333
334 // ***** MC Snapshot
335
336 /** Ignored data
337  *
338  *  Some parts of the snapshot are ignored by zeroing them out: the real
339  *  values is stored here.
340  * */
341 typedef struct s_mc_snapshot_ignored_data {
342   void* start;
343   size_t size;
344   void* data;
345 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
346
347 typedef struct s_fd_infos{
348   char *filename;
349   int number;
350   off_t current_position;
351   int flags;
352 }s_fd_infos_t, *fd_infos_t;
353
354 }
355
356 namespace simgrid {
357 namespace mc {
358
359 class Snapshot : public AddressSpace {
360 public:
361   Snapshot();
362   ~Snapshot();
363   const void* read_bytes(void* buffer, std::size_t size,
364     remote_ptr<void> address, int process_index = ProcessIndexAny,
365     ReadMode mode = Normal) const MC_OVERRIDE;
366 public: // To be private
367   mc_process_t process;
368   int num_state;
369   size_t heap_bytes_used;
370   mc_mem_region_t* snapshot_regions;
371   size_t snapshot_regions_count;
372   xbt_dynar_t enabled_processes;
373   int privatization_index;
374   size_t *stack_sizes;
375   xbt_dynar_t stacks;
376   xbt_dynar_t to_ignore;
377   uint64_t hash;
378   xbt_dynar_t ignored_data;
379   int total_fd;
380   fd_infos_t *current_fd;
381 };
382
383 }
384 }
385
386 extern "C" {
387
388 static inline __attribute__ ((always_inline))
389 mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
390 {
391   if (mc_region_contain(region, addr))
392     return region;
393   else
394     return mc_get_snapshot_region(addr, snapshot, process_index);
395 }
396
397 /** Information about a given stack frame
398  *
399  */
400 typedef struct s_mc_stack_frame {
401   /** Instruction pointer */
402   unw_word_t ip;
403   /** Stack pointer */
404   unw_word_t sp;
405   unw_word_t frame_base;
406   dw_frame_t frame;
407   char* frame_name;
408   unw_cursor_t unw_cursor;
409 } s_mc_stack_frame_t, *mc_stack_frame_t;
410
411 typedef struct s_mc_snapshot_stack{
412   xbt_dynar_t local_variables;
413   mc_unw_context_t context;
414   xbt_dynar_t stack_frames; // mc_stack_frame_t
415   int process_index;
416 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
417
418 typedef struct s_mc_global_t {
419   mc_snapshot_t snapshot;
420   int prev_pair;
421   char *prev_req;
422   int initial_communications_pattern_done;
423   int recv_deterministic;
424   int send_deterministic;
425   char *send_diff;
426   char *recv_diff;
427 }s_mc_global_t, *mc_global_t;
428
429 static const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
430
431 XBT_INTERNAL mc_snapshot_t MC_take_snapshot(int num_state);
432 XBT_INTERNAL void MC_restore_snapshot(mc_snapshot_t);
433
434 XBT_INTERNAL void mc_restore_page_snapshot_region(
435   mc_process_t process,
436   void* start_addr, simgrid::mc::PerPageCopy const& pagenos);
437
438 MC_SHOULD_BE_INTERNAL const void* MC_region_read_fragmented(
439   mc_mem_region_t region, void* target, const void* addr, size_t size);
440
441 MC_SHOULD_BE_INTERNAL int MC_snapshot_region_memcmp(
442   const void* addr1, mc_mem_region_t region1,
443   const void* addr2, mc_mem_region_t region2, size_t size);
444 XBT_INTERNAL int MC_snapshot_memcmp(
445   const void* addr1, mc_snapshot_t snapshot1,
446   const void* addr2, mc_snapshot_t snapshot2, int process_index, size_t size);
447
448 static inline __attribute__ ((always_inline))
449 const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot)
450 {
451   if(snapshot==NULL)
452       xbt_die("snapshot is NULL");
453   return mc_model_checker->process().get_heap()->breakval;
454 }
455
456 /** @brief Read memory from a snapshot region
457  *
458  *  @param addr    Process (non-snapshot) address of the data
459  *  @param region  Snapshot memory region where the data is located
460  *  @param target  Buffer to store the value
461  *  @param size    Size of the data to read in bytes
462  *  @return Pointer where the data is located (target buffer of original location)
463  */
464 static inline __attribute__((always_inline))
465 const void* MC_region_read(mc_mem_region_t region, void* target, const void* addr, size_t size)
466 {
467   xbt_assert(region);
468
469   uintptr_t offset = (uintptr_t) addr - (uintptr_t) region->start().address();
470
471   xbt_assert(mc_region_contain(region, addr),
472     "Trying to read out of the region boundary.");
473
474   switch (region->storage_type()) {
475   case MC_REGION_STORAGE_TYPE_NONE:
476   default:
477     xbt_die("Storage type not supported");
478
479   case MC_REGION_STORAGE_TYPE_FLAT:
480     return (char*) region->flat_data().data() + offset;
481
482   case MC_REGION_STORAGE_TYPE_CHUNKED:
483     {
484       // Last byte of the region:
485       void* end = (char*) addr + size - 1;
486       if (mc_same_page(addr, end) ) {
487         // The memory is contained in a single page:
488         return mc_translate_address_region_chunked((uintptr_t) addr, region);
489       } else {
490         // The memory spans several pages:
491         return MC_region_read_fragmented(region, target, addr, size);
492       }
493     }
494
495   // We currently do not pass the process_index to this function so we assume
496   // that the privatized region has been resolved in the callers:
497   case MC_REGION_STORAGE_TYPE_PRIVATIZED:
498     xbt_die("Storage type not supported");
499   }
500 }
501
502 static inline __attribute__ ((always_inline))
503 void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
504 {
505   void* res;
506   return *(void**) MC_region_read(region, &res, addr, sizeof(void*));
507 }
508
509 SG_END_DECL()
510
511 #endif