Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
e725c1d2464b6a52468091f119b98600c4ba60f2
[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 <vector>
14 #include <set>
15 #include <memory>
16
17 #include <simgrid_config.h>
18 #include "../xbt/mmalloc/mmprivate.h"
19 #include <xbt/asserts.h>
20 #include <xbt/dynar.h>
21
22 #include "mc_forward.h"
23 #include "ModelChecker.hpp"
24 #include "PageStore.hpp"
25 #include "mc_mmalloc.h"
26 #include "mc/AddressSpace.hpp"
27 #include "mc_unw.h"
28 #include "RegionSnapshot.hpp"
29
30 SG_BEGIN_DECL()
31
32 // ***** Snapshot region
33
34 XBT_INTERNAL void mc_region_restore_sparse(mc_process_t process, mc_mem_region_t reg);
35
36 static inline __attribute__((always_inline))
37 void* mc_translate_address_region_chunked(uintptr_t addr, mc_mem_region_t region)
38 {
39   size_t pageno = mc_page_number((void*)region->start().address(), (void*) addr);
40   const void* snapshot_page =
41     region->page_data().page(pageno);
42   return (char*) snapshot_page + mc_page_offset((void*) addr);
43 }
44
45 static inline __attribute__((always_inline))
46 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region, int process_index)
47 {
48   switch (region->storage_type()) {
49   case simgrid::mc::StorageType::NoData:
50   default:
51     xbt_die("Storage type not supported");
52
53   case simgrid::mc::StorageType::Flat:
54     {
55       uintptr_t offset = (uintptr_t) addr - (uintptr_t) region->start().address();
56       return (void *) ((uintptr_t) region->flat_data().data() + offset);
57     }
58
59   case simgrid::mc::StorageType::Chunked:
60     return mc_translate_address_region_chunked(addr, region);
61
62   case simgrid::mc::StorageType::Privatized:
63     {
64       xbt_assert(process_index >=0,
65         "Missing process index for privatized region");
66       xbt_assert((size_t) process_index < region->privatized_data().size(),
67         "Out of range process index");
68       simgrid::mc::RegionSnapshot& subregion= region->privatized_data()[process_index];
69       return mc_translate_address_region(addr, &subregion, process_index);
70     }
71   }
72 }
73
74 XBT_INTERNAL mc_mem_region_t mc_get_snapshot_region(
75   const void* addr, const s_mc_snapshot_t *snapshot, int process_index);
76
77 }
78
79 // ***** MC Snapshot
80
81 /** Ignored data
82  *
83  *  Some parts of the snapshot are ignored by zeroing them out: the real
84  *  values is stored here.
85  * */
86 typedef struct s_mc_snapshot_ignored_data {
87   void* start;
88   std::vector<char> data;
89 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
90
91 typedef struct s_fd_infos{
92   std::string filename;
93   int number;
94   off_t current_position;
95   int flags;
96 }s_fd_infos_t, *fd_infos_t;
97
98 /** Information about a given stack frame
99  *
100  */
101 typedef struct s_mc_stack_frame {
102   /** Instruction pointer */
103   unw_word_t ip;
104   /** Stack pointer */
105   unw_word_t sp;
106   unw_word_t frame_base;
107   dw_frame_t frame;
108   std::string frame_name;
109   unw_cursor_t unw_cursor;
110 } s_mc_stack_frame_t, *mc_stack_frame_t;
111
112 typedef struct s_local_variable{
113   dw_frame_t subprogram;
114   unsigned long ip;
115   std::string name;
116   dw_type_t type;
117   void *address;
118   int region;
119 } s_local_variable_t, *local_variable_t;
120
121 typedef struct s_mc_snapshot_stack{
122   std::vector<s_local_variable> local_variables;
123   mc_unw_context_t context;
124   std::vector<s_mc_stack_frame_t> stack_frames;
125   int process_index;
126
127   s_mc_snapshot_stack()
128     : context(nullptr), process_index(0)
129   {}
130   ~s_mc_snapshot_stack();
131   s_mc_snapshot_stack(s_mc_snapshot_stack& p) = delete;
132   s_mc_snapshot_stack& operator=(s_mc_snapshot_stack&) = delete;
133
134   s_mc_snapshot_stack(s_mc_snapshot_stack&& that)
135   {
136     *this = std::move(that);
137   }
138   s_mc_snapshot_stack& operator=(s_mc_snapshot_stack&& that)
139   {
140     this->local_variables = std::move(that.local_variables);
141     this->context = std::move(that.context);
142     that.context = nullptr;
143     this->process_index = that.process_index;
144     that.process_index = 0;
145     return *this;
146   }
147
148 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
149
150 typedef struct s_mc_global_t {
151   mc_snapshot_t snapshot;
152   int prev_pair;
153   char *prev_req;
154   int initial_communications_pattern_done;
155   int recv_deterministic;
156   int send_deterministic;
157   char *send_diff;
158   char *recv_diff;
159 }s_mc_global_t, *mc_global_t;
160
161 namespace simgrid {
162 namespace mc {
163
164 class Snapshot : public AddressSpace {
165 public:
166   Snapshot();
167   ~Snapshot();
168   const void* read_bytes(void* buffer, std::size_t size,
169     remote_ptr<void> address, int process_index = ProcessIndexAny,
170     ReadMode mode = Normal) const MC_OVERRIDE;
171 public: // To be private
172   mc_process_t process;
173   int num_state;
174   size_t heap_bytes_used;
175   std::vector<std::unique_ptr<s_mc_mem_region_t>> snapshot_regions;
176   std::set<pid_t> enabled_processes;
177   int privatization_index;
178   std::vector<size_t> stack_sizes;
179   std::vector<s_mc_snapshot_stack_t> stacks;
180   std::vector<s_mc_heap_ignore_region_t> to_ignore;
181   uint64_t hash;
182   std::vector<s_mc_snapshot_ignored_data> ignored_data;
183   std::vector<s_fd_infos_t> current_fds;
184 };
185
186 }
187 }
188
189 extern "C" {
190
191 static inline __attribute__ ((always_inline))
192 mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
193 {
194   if (region->contain(simgrid::mc::remote(addr)))
195     return region;
196   else
197     return mc_get_snapshot_region(addr, snapshot, process_index);
198 }
199
200 static const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
201
202 XBT_INTERNAL mc_snapshot_t MC_take_snapshot(int num_state);
203 XBT_INTERNAL void MC_restore_snapshot(mc_snapshot_t);
204
205 XBT_INTERNAL void mc_restore_page_snapshot_region(
206   mc_process_t process,
207   void* start_addr, simgrid::mc::PerPageCopy const& pagenos);
208
209 MC_SHOULD_BE_INTERNAL const void* MC_region_read_fragmented(
210   mc_mem_region_t region, void* target, const void* addr, size_t size);
211
212 MC_SHOULD_BE_INTERNAL int MC_snapshot_region_memcmp(
213   const void* addr1, mc_mem_region_t region1,
214   const void* addr2, mc_mem_region_t region2, size_t size);
215 XBT_INTERNAL int MC_snapshot_memcmp(
216   const void* addr1, mc_snapshot_t snapshot1,
217   const void* addr2, mc_snapshot_t snapshot2, int process_index, size_t size);
218
219 static inline __attribute__ ((always_inline))
220 const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot)
221 {
222   if(snapshot==NULL)
223       xbt_die("snapshot is NULL");
224   return mc_model_checker->process().get_heap()->breakval;
225 }
226
227 /** @brief Read memory from a snapshot region
228  *
229  *  @param addr    Process (non-snapshot) address of the data
230  *  @param region  Snapshot memory region where the data is located
231  *  @param target  Buffer to store the value
232  *  @param size    Size of the data to read in bytes
233  *  @return Pointer where the data is located (target buffer of original location)
234  */
235 static inline __attribute__((always_inline))
236 const void* MC_region_read(mc_mem_region_t region, void* target, const void* addr, size_t size)
237 {
238   xbt_assert(region);
239
240   uintptr_t offset = (uintptr_t) addr - (uintptr_t) region->start().address();
241
242   xbt_assert(region->contain(simgrid::mc::remote(addr)),
243     "Trying to read out of the region boundary.");
244
245   switch (region->storage_type()) {
246   case simgrid::mc::StorageType::NoData:
247   default:
248     xbt_die("Storage type not supported");
249
250   case simgrid::mc::StorageType::Flat:
251     return (char*) region->flat_data().data() + offset;
252
253   case simgrid::mc::StorageType::Chunked:
254     {
255       // Last byte of the region:
256       void* end = (char*) addr + size - 1;
257       if (mc_same_page(addr, end) ) {
258         // The memory is contained in a single page:
259         return mc_translate_address_region_chunked((uintptr_t) addr, region);
260       } else {
261         // The memory spans several pages:
262         return MC_region_read_fragmented(region, target, addr, size);
263       }
264     }
265
266   // We currently do not pass the process_index to this function so we assume
267   // that the privatized region has been resolved in the callers:
268   case simgrid::mc::StorageType::Privatized:
269     xbt_die("Storage type not supported");
270   }
271 }
272
273 static inline __attribute__ ((always_inline))
274 void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
275 {
276   void* res;
277   return *(void**) MC_region_read(region, &res, addr, sizeof(void*));
278 }
279
280 SG_END_DECL()
281
282 XBT_INTERNAL int init_heap_information(xbt_mheap_t heap1, xbt_mheap_t heap2,
283                           std::vector<s_mc_heap_ignore_region_t>* i1,
284                           std::vector<s_mc_heap_ignore_region_t>* i2);
285
286 #endif