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 "ModelChecker.hpp"
20 #include "PageStore.hpp"
21 #include "mc_mmalloc.h"
22 #include "mc/AddressSpace.hpp"
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_SHOULD_BE_INTERNAL mc_mem_region_t mc_region_new_sparse(
101 mc_region_type_t type, void *start_addr, void* data_addr, size_t size);
102 MC_SHOULD_BE_INTERNAL void MC_region_destroy(mc_mem_region_t reg);
103 XBT_INTERNAL 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 =
118 mc_model_checker->page_store().get_page(snapshot_pageno);
119 return (char*) snapshot_page + mc_page_offset((void*) addr);
122 XBT_INTERNAL mc_mem_region_t mc_get_snapshot_region(
123 const void* addr, const s_mc_snapshot_t *snapshot, int process_index);
125 /** \brief Translate a pointer from process address space to snapshot address space
127 * The address space contains snapshot of the main/application memory:
128 * this function finds the address in a given snaphot for a given
129 * real/application address.
131 * For read only memory regions and other regions which are not int the
132 * snapshot, the address is not changed.
134 * \param addr Application address
135 * \param snapshot The snapshot of interest (if NULL no translation is done)
136 * \return Translated address in the snapshot address space
138 static inline __attribute__((always_inline))
139 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot, int process_index)
142 // If not in a process state/clone:
144 return (uintptr_t *) addr;
147 mc_mem_region_t region = mc_get_snapshot_region((void*) addr, snapshot, process_index);
149 xbt_assert(mc_region_contain(region, (void*) addr), "Trying to read out of the region boundary.");
152 return (void *) addr;
155 switch (region->storage_type) {
156 case MC_REGION_STORAGE_TYPE_NONE:
158 xbt_die("Storage type not supported");
160 case MC_REGION_STORAGE_TYPE_FLAT:
162 uintptr_t offset = addr - (uintptr_t) region->start_addr;
163 return (void *) ((uintptr_t) region->flat.data + offset);
166 case MC_REGION_STORAGE_TYPE_CHUNKED:
167 return mc_translate_address_region(addr, region);
169 case MC_REGION_STORAGE_TYPE_PRIVATIZED:
171 xbt_assert(process_index >=0,
172 "Missing process index for privatized region");
173 xbt_assert((size_t) process_index < region->privatized.regions_count,
174 "Out of range process index");
175 mc_mem_region_t subregion = region->privatized.regions[process_index];
176 xbt_assert(subregion, "Missing memory region for process %i", process_index);
177 return mc_translate_address(addr, snapshot, process_index);
186 * Some parts of the snapshot are ignored by zeroing them out: the real
187 * values is stored here.
189 typedef struct s_mc_snapshot_ignored_data {
193 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
195 typedef struct s_fd_infos{
198 off_t current_position;
200 }s_fd_infos_t, *fd_infos_t;
207 class Snapshot : public AddressSpace {
211 const void* read_bytes(void* buffer, std::size_t size,
212 remote_ptr<void> address, int process_index = ProcessIndexAny,
213 ReadMode mode = Normal) const override;
214 public: // To be private
215 mc_process_t process;
217 size_t heap_bytes_used;
218 mc_mem_region_t* snapshot_regions;
219 size_t snapshot_regions_count;
220 xbt_dynar_t enabled_processes;
221 int privatization_index;
224 xbt_dynar_t to_ignore;
226 xbt_dynar_t ignored_data;
228 fd_infos_t *current_fd;
236 static inline __attribute__ ((always_inline))
237 mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
239 if (mc_region_contain(region, addr))
242 return mc_get_snapshot_region(addr, snapshot, process_index);
245 /** Information about a given stack frame
248 typedef struct s_mc_stack_frame {
249 /** Instruction pointer */
253 unw_word_t frame_base;
256 unw_cursor_t unw_cursor;
257 } s_mc_stack_frame_t, *mc_stack_frame_t;
259 typedef struct s_mc_snapshot_stack{
260 xbt_dynar_t local_variables;
261 mc_unw_context_t context;
262 xbt_dynar_t stack_frames; // mc_stack_frame_t
264 }s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
266 typedef struct s_mc_global_t {
267 mc_snapshot_t snapshot;
270 int initial_communications_pattern_done;
271 int recv_deterministic;
272 int send_deterministic;
275 }s_mc_global_t, *mc_global_t;
277 static const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
279 XBT_INTERNAL mc_snapshot_t MC_take_snapshot(int num_state);
280 XBT_INTERNAL void MC_restore_snapshot(mc_snapshot_t);
282 XBT_INTERNAL size_t* mc_take_page_snapshot_region(mc_process_t process,
283 void* data, size_t page_count);
284 XBT_INTERNAL void mc_free_page_snapshot_region(size_t* pagenos, size_t page_count);
285 XBT_INTERNAL void mc_restore_page_snapshot_region(
286 mc_process_t process,
287 void* start_addr, size_t page_count, size_t* pagenos);
289 MC_SHOULD_BE_INTERNAL const void* MC_region_read_fragmented(
290 mc_mem_region_t region, void* target, const void* addr, size_t size);
292 // Deprecated compatibility wrapper
294 const void* MC_snapshot_read(mc_snapshot_t snapshot,
295 simgrid::mc::AddressSpace::ReadMode mode,
296 void* target, const void* addr, size_t size, int process_index)
298 return snapshot->read_bytes(target, size, simgrid::mc::remote(addr),
299 process_index, mode);
302 MC_SHOULD_BE_INTERNAL int MC_snapshot_region_memcmp(
303 const void* addr1, mc_mem_region_t region1,
304 const void* addr2, mc_mem_region_t region2, size_t size);
305 XBT_INTERNAL int MC_snapshot_memcmp(
306 const void* addr1, mc_snapshot_t snapshot1,
307 const void* addr2, mc_snapshot_t snapshot2, int process_index, size_t size);
309 static inline __attribute__ ((always_inline))
310 const void* MC_snapshot_read_pointer(mc_snapshot_t snapshot, const void* addr, int process_index)
313 return *(const void**) MC_snapshot_read(snapshot, simgrid::mc::AddressSpace::Lazy,
314 &res, addr, sizeof(void*), process_index);
317 static inline __attribute__ ((always_inline))
318 const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot)
321 xbt_die("snapshot is NULL");
322 return mc_model_checker->process().get_heap()->breakval;
325 /** @brief Read memory from a snapshot region
327 * @param addr Process (non-snapshot) address of the data
328 * @param region Snapshot memory region where the data is located
329 * @param target Buffer to store the value
330 * @param size Size of the data to read in bytes
331 * @return Pointer where the data is located (target buffer of original location)
333 static inline __attribute__((always_inline))
334 const void* MC_region_read(mc_mem_region_t region, void* target, const void* addr, size_t size)
338 uintptr_t offset = (char*) addr - (char*) region->start_addr;
340 xbt_assert(mc_region_contain(region, addr),
341 "Trying to read out of the region boundary.");
343 switch (region->storage_type) {
344 case MC_REGION_STORAGE_TYPE_NONE:
346 xbt_die("Storage type not supported");
348 case MC_REGION_STORAGE_TYPE_FLAT:
349 return (char*) region->flat.data + offset;
351 case MC_REGION_STORAGE_TYPE_CHUNKED:
353 // Last byte of the region:
354 void* end = (char*) addr + size - 1;
355 if (mc_same_page(addr, end) ) {
356 // The memory is contained in a single page:
357 return mc_translate_address_region((uintptr_t) addr, region);
359 // The memory spans several pages:
360 return MC_region_read_fragmented(region, target, addr, size);
364 // We currently do not pass the process_index to this function so we assume
365 // that the privatized region has been resolved in the callers:
366 case MC_REGION_STORAGE_TYPE_PRIVATIZED:
367 xbt_die("Storage type not supported");
371 static inline __attribute__ ((always_inline))
372 void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
375 return *(void**) MC_region_read(region, &res, addr, sizeof(void*));