1 /* Copyright (c) 2007-2014. The SimGrid Team.
2 * All rights reserved. */
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. */
10 #include <sys/types.h> // off_t
11 #include <stdint.h> // size_t
13 #include <simgrid_config.h>
14 #include "../xbt/mmalloc/mmprivate.h"
15 #include <xbt/asserts.h>
16 #include <xbt/dynar.h>
18 #include "mc_forward.h"
19 #include "mc_model_checker.h"
20 #include "mc_page_store.h"
21 #include "mc_mmalloc.h"
22 #include "mc_address_space.h"
27 // ***** Snapshot region
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
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;
43 /** @brief Copy/snapshot of a given memory region
45 * Different types of region snapshot storage types exist:
47 * <li>flat/dense snapshots are a simple copy of the region;</li>
48 * <li>sparse/per-page snapshots are snaapshots which shared
49 * identical pages.</li>
50 * <li>privatized (SMPI global variable privatisation).
53 * This is handled with a variant based approch:
55 * * `storage_type` identified the type of storage;
56 * * an anonymous enum is used to distinguish the relevant types for
59 typedef struct s_mc_mem_region s_mc_mem_region_t, *mc_mem_region_t;
61 struct s_mc_mem_region {
62 mc_region_type_t region_type;
63 mc_region_storage_type_t storage_type;
64 mc_object_info_t object_info;
66 /** @brief Virtual address of the region in the simulated process */
69 /** @brief Size of the data region in bytes */
72 /** @brief Permanent virtual address of the region
74 * This is usually the same address as the simuilated process address.
75 * However, when using SMPI privatization of global variables,
76 * each SMPI process has its own set of global variables stored
77 * at a different virtual address. The scheduler maps those region
78 * on the region of the global variables.
85 /** @brief Copy of the snapshot for flat snapshots regions (NULL otherwise) */
89 /** @brief Pages indices in the page store for per-page snapshots (NULL otherwise) */
94 mc_mem_region_t* regions;
100 mc_mem_region_t mc_region_new_sparse(
101 mc_region_type_t type, void *start_addr, void* data_addr, size_t size);
102 void MC_region_destroy(mc_mem_region_t reg);
103 void mc_region_restore_sparse(mc_process_t process, mc_mem_region_t reg);
105 static inline __attribute__ ((always_inline))
106 bool mc_region_contain(mc_mem_region_t region, const void* p)
108 return p >= region->start_addr &&
109 p < (void*)((char*) region->start_addr + region->size);
112 static inline __attribute__((always_inline))
113 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region)
115 size_t pageno = mc_page_number(region->start_addr, (void*) addr);
116 size_t snapshot_pageno = region->chunked.page_numbers[pageno];
117 const void* snapshot_page = mc_page_store_get_page(mc_model_checker->pages, snapshot_pageno);
118 return (char*) snapshot_page + mc_page_offset((void*) addr);
121 mc_mem_region_t mc_get_snapshot_region(const void* addr, mc_snapshot_t snapshot, int process_index);
123 /** \brief Translate a pointer from process address space to snapshot address space
125 * The address space contains snapshot of the main/application memory:
126 * this function finds the address in a given snaphot for a given
127 * real/application address.
129 * For read only memory regions and other regions which are not int the
130 * snapshot, the address is not changed.
132 * \param addr Application address
133 * \param snapshot The snapshot of interest (if NULL no translation is done)
134 * \return Translated address in the snapshot address space
136 static inline __attribute__((always_inline))
137 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot, int process_index)
140 // If not in a process state/clone:
142 return (uintptr_t *) addr;
145 mc_mem_region_t region = mc_get_snapshot_region((void*) addr, snapshot, process_index);
147 xbt_assert(mc_region_contain(region, (void*) addr), "Trying to read out of the region boundary.");
150 return (void *) addr;
153 switch (region->storage_type) {
154 case MC_REGION_STORAGE_TYPE_NONE:
156 xbt_die("Storage type not supported");
158 case MC_REGION_STORAGE_TYPE_FLAT:
160 uintptr_t offset = addr - (uintptr_t) region->start_addr;
161 return (void *) ((uintptr_t) region->flat.data + offset);
164 case MC_REGION_STORAGE_TYPE_CHUNKED:
165 return mc_translate_address_region(addr, region);
167 case MC_REGION_STORAGE_TYPE_PRIVATIZED:
169 xbt_assert(process_index >=0,
170 "Missing process index for privatized region");
171 xbt_assert((size_t) process_index < region->privatized.regions_count,
172 "Out of range process index");
173 mc_mem_region_t subregion = region->privatized.regions[process_index];
174 xbt_assert(subregion, "Missing memory region for process %i", process_index);
175 return mc_translate_address(addr, snapshot, process_index);
184 * Some parts of the snapshot are ignored by zeroing them out: the real
185 * values is stored here.
187 typedef struct s_mc_snapshot_ignored_data {
191 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
193 typedef struct s_fd_infos{
196 off_t current_position;
198 }s_fd_infos_t, *fd_infos_t;
200 struct s_mc_snapshot {
201 mc_process_t process;
203 s_mc_address_space_t address_space;
204 size_t heap_bytes_used;
205 mc_mem_region_t* snapshot_regions;
206 size_t snapshot_regions_count;
207 xbt_dynar_t enabled_processes;
208 int privatization_index;
211 xbt_dynar_t to_ignore;
213 xbt_dynar_t ignored_data;
215 fd_infos_t *current_fd;
218 static inline __attribute__ ((always_inline))
219 mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
221 if (mc_region_contain(region, addr))
224 return mc_get_snapshot_region(addr, snapshot, process_index);
227 /** Information about a given stack frame
230 typedef struct s_mc_stack_frame {
231 /** Instruction pointer */
235 unw_word_t frame_base;
238 unw_cursor_t unw_cursor;
239 } s_mc_stack_frame_t, *mc_stack_frame_t;
241 typedef struct s_mc_snapshot_stack{
242 xbt_dynar_t local_variables;
243 mc_unw_context_t context;
244 xbt_dynar_t stack_frames; // mc_stack_frame_t
246 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
248 typedef struct s_mc_global_t {
249 mc_snapshot_t snapshot;
253 int initial_communications_pattern_done;
254 int recv_deterministic;
255 int send_deterministic;
258 }s_mc_global_t, *mc_global_t;
260 typedef struct s_mc_checkpoint_ignore_region{
263 }s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
265 static const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
267 mc_snapshot_t MC_take_snapshot(int num_state);
268 void MC_restore_snapshot(mc_snapshot_t);
269 void MC_free_snapshot(mc_snapshot_t);
271 int mc_important_snapshot(mc_snapshot_t snapshot);
273 size_t* mc_take_page_snapshot_region(mc_process_t process,
274 void* data, size_t page_count);
275 void mc_free_page_snapshot_region(size_t* pagenos, size_t page_count);
276 void mc_restore_page_snapshot_region(
277 mc_process_t process,
278 void* start_addr, size_t page_count, size_t* pagenos);
280 const void* MC_region_read_fragmented(mc_mem_region_t region, void* target, const void* addr, size_t size);
282 const void* MC_snapshot_read(mc_snapshot_t snapshot, adress_space_read_flags_t flags,
283 void* target, const void* addr, size_t size, int process_index);
284 int MC_snapshot_region_memcmp(
285 const void* addr1, mc_mem_region_t region1,
286 const void* addr2, mc_mem_region_t region2, size_t size);
287 int MC_snapshot_memcmp(
288 const void* addr1, mc_snapshot_t snapshot1,
289 const void* addr2, mc_snapshot_t snapshot2, int process_index, size_t size);
291 static inline __attribute__ ((always_inline))
292 const void* MC_snapshot_read_pointer(mc_snapshot_t snapshot, const void* addr, int process_index)
295 return *(const void**) MC_snapshot_read(snapshot, MC_ADDRESS_SPACE_READ_FLAGS_LAZY,
296 &res, addr, sizeof(void*), process_index);
299 static inline __attribute__ ((always_inline))
300 const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot)
303 xbt_die("snapshot is NULL");
304 return MC_process_get_heap(&mc_model_checker->process)->breakval;
307 /** @brief Read memory from a snapshot region
309 * @param addr Process (non-snapshot) address of the data
310 * @param region Snapshot memory region where the data is located
311 * @param target Buffer to store the value
312 * @param size Size of the data to read in bytes
313 * @return Pointer where the data is located (target buffer of original location)
315 static inline __attribute__((always_inline))
316 const void* MC_region_read(mc_mem_region_t region, void* target, const void* addr, size_t size)
319 // Should be deprecated:
322 uintptr_t offset = (char*) addr - (char*) region->start_addr;
324 xbt_assert(mc_region_contain(region, addr),
325 "Trying to read out of the region boundary.");
327 switch (region->storage_type) {
328 case MC_REGION_STORAGE_TYPE_NONE:
330 xbt_die("Storage type not supported");
332 case MC_REGION_STORAGE_TYPE_FLAT:
333 return (char*) region->flat.data + offset;
335 case MC_REGION_STORAGE_TYPE_CHUNKED:
337 // Last byte of the region:
338 void* end = (char*) addr + size - 1;
339 if (mc_same_page(addr, end) ) {
340 // The memory is contained in a single page:
341 return mc_translate_address_region((uintptr_t) addr, region);
343 // The memory spans several pages:
344 return MC_region_read_fragmented(region, target, addr, size);
348 // We currently do not pass the process_index to this function so we assume
349 // that the privatized region has been resolved in the callers:
350 case MC_REGION_STORAGE_TYPE_PRIVATIZED:
351 xbt_die("Storage type not supported");
355 static inline __attribute__ ((always_inline))
356 void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
359 return *(void**) MC_region_read(region, &res, addr, sizeof(void*));