Logo AND Algorithmique Numérique Distribuée

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