Logo AND Algorithmique Numérique Distribuée

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