Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Add some documentation
[simgrid.git] / src / mc / mc_snapshot.c
1 /* Copyright (c) 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 #include "mc_private.h"
8 #include "mc_mmu.h"
9
10 mc_mem_region_t mc_get_snapshot_region(void* addr, mc_snapshot_t snapshot)
11 {
12   for (size_t i = 0; i != NB_REGIONS; ++i) {
13     mc_mem_region_t region = snapshot->regions[i];
14     void* start = region->start_addr;
15     void* end = (char*) start + region->size;
16
17     if (addr >= start && addr < end) {
18       return region;
19     }
20   }
21
22   return NULL;
23 }
24
25 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region)
26 {
27   xbt_assert(mc_region_contain(region, (void*) addr), "Trying to read out of the region boundary.");
28
29   if (!region) {
30     return (void *) addr;
31   }
32
33   // Flat snapshot:
34   else if (region->data) {
35     uintptr_t offset = addr - (uintptr_t) region->start_addr;
36     return (void *) ((uintptr_t) region->data + offset);
37   }
38
39   // Per-page snapshot:
40   else if (region->page_numbers) {
41     size_t pageno = mc_page_number(region->start_addr, (void*) addr);
42     size_t snapshot_pageno = region->page_numbers[pageno];
43     const void* snapshot_page = mc_page_store_get_page(mc_model_checker->pages, snapshot_pageno);
44     return (char*) snapshot_page + mc_page_offset((void*) addr);
45   }
46
47   else {
48     xbt_die("No data for this memory region");
49   }
50 }
51
52 void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot)
53 {
54
55   // If not in a process state/clone:
56   if (!snapshot) {
57     return (uintptr_t *) addr;
58   }
59
60   mc_mem_region_t region = mc_get_snapshot_region((void*) addr, snapshot);
61   return mc_translate_address_region(addr, region);
62 }
63
64 /** @brief Read memory from a snapshot region broken across fragmented pages
65  *
66  *  @param addr    Process (non-snapshot) address of the data
67  *  @param region  Snapshot memory region where the data is located
68  *  @param target  Buffer to store the value
69  *  @param size    Size of the data to read in bytes
70  *  @return Pointer where the data is located (target buffer of original location)
71  */
72 static void* mc_snapshot_read_fragmented(void* addr, mc_mem_region_t region, void* target, size_t size)
73 {
74   void* end = (char*) addr + size - 1;
75   size_t page_end = mc_page_number(NULL, end);
76   void* dest = target;
77
78   // Read each page:
79   while (mc_page_number(NULL, addr) != page_end) {
80     void* snapshot_addr = mc_translate_address_region((uintptr_t) addr, region);
81     void* next_page = mc_page_from_number(NULL, mc_page_number(NULL, addr) + 1);
82     size_t readable = (char*) next_page - (char*) addr;
83     memcpy(dest, snapshot_addr, readable);
84     addr = (char*) addr + readable;
85     dest = (char*) dest + readable;
86     size -= readable;
87   }
88
89   // Read the end:
90   void* snapshot_addr = mc_translate_address_region((uintptr_t)addr, region);
91   memcpy(dest, snapshot_addr, size);
92
93   return target;
94 }
95
96 /** @brief Read memory from a snapshot region
97  *
98  *  @param addr    Process (non-snapshot) address of the data
99  *  @param region  Snapshot memory region where the data is located
100  *  @param target  Buffer to store the value
101  *  @param size    Size of the data to read in bytes
102  *  @return Pointer where the data is located (target buffer of original location)
103  */
104 void* mc_snapshot_read_region(void* addr, mc_mem_region_t region, void* target, size_t size)
105 {
106   uintptr_t offset = (uintptr_t) addr - (uintptr_t) region->start_addr;
107
108   xbt_assert(addr >= region->start_addr && (char*) addr+size < (char*)region->start_addr+region->size,
109     "Trying to read out of the region boundary.");
110
111   // Linear memory region:
112   if (region->data) {
113     return (void*) ((uintptr_t) region->data + offset);
114   }
115
116   // Fragmented memory region:
117   else if (region->page_numbers) {
118     void* end = (char*) addr + size - 1;
119     if( mc_same_page(addr, end) ) {
120       // The memory is contained in a single page:
121       return mc_translate_address_region((uintptr_t) addr, region);
122     } else {
123       // The memory spans several pages:
124       return mc_snapshot_read_fragmented(addr, region, target, size);
125     }
126   }
127
128   else {
129     xbt_die("No data available for this region");
130   }
131 }
132
133 /** @brief Read memory from a snapshot
134  *
135  *  @param addr     Process (non-snapshot) address of the data
136  *  @param snapshot Snapshot (or NULL is no snapshot)
137  *  @param target   Buffer to store the value
138  *  @param size     Size of the data to read in bytes
139  *  @return Pointer where the data is located (target buffer of original location)
140  */
141 void* mc_snapshot_read(void* addr, mc_snapshot_t snapshot, void* target, size_t size)
142 {
143   if (snapshot) {
144     mc_mem_region_t region = mc_get_snapshot_region(addr, snapshot);
145     return mc_snapshot_read_region(addr, region, target, size);
146   } else {
147     return addr;
148   }
149 }
150
151 /** Compare memory between snapshots (with known regions)
152  *
153  * @param addr1 Address in the first snapshot
154  * @param snapshot2 Region of the address in the first snapshot
155  * @param addr2 Address in the second snapshot
156  * @param snapshot2 Region of the address in the second snapshot
157  * @return same as memcmp
158  * */
159 int mc_snapshot_region_memcp(
160   void* addr1, mc_mem_region_t region1,
161   void* addr2, mc_mem_region_t region2, size_t size)
162 {
163   // TODO, optimize this, avoid alloca
164   void* buffer1 = mc_snapshot_read_region(addr1, region1, alloca(size), size);
165   void* buffer2 = mc_snapshot_read_region(addr2, region2, alloca(size), size);
166   if (buffer1 == buffer2) {
167     return 0;
168   }
169   return memcmp(buffer1, buffer2, size);
170 }
171
172 /** Compare memory between snapshots
173  *
174  * @param addr1 Address in the first snapshot
175  * @param snapshot1 First snapshot
176  * @param addr2 Address in the second snapshot
177  * @param snapshot2 Second snapshot
178  * @return same as memcmp
179  * */
180 int mc_snapshot_memcp(
181   void* addr1, mc_snapshot_t snapshot1,
182   void* addr2, mc_snapshot_t snapshot2, size_t size)
183 {
184   // TODO, optimize this, avoid alloca
185   void* buffer1 = mc_snapshot_read(addr1, snapshot1, alloca(size), size);
186   void* buffer2 = mc_snapshot_read(addr2, snapshot2, alloca(size), size);
187   if (buffer1 == buffer2) {
188     return 0;
189   }
190   return memcmp(buffer1, buffer2, size);
191 }