main, threads: improve comments regarding thread stepping
[model-checker.git] / snapshot.cc
1 #include <inttypes.h>
2 #include <sys/mman.h>
3 #include <unistd.h>
4 #include <signal.h>
5 #include <stdlib.h>
6 #include "hashtable.h"
7 #include <cstring>
8 #include <cstdio>
9 #include "snapshot.h"
10 #include "snapshotimp.h"
11 #include "mymemory.h"
12 #include <fcntl.h>
13 #include <assert.h>
14 #include <pthread.h>
15 #include <semaphore.h>
16 #include <errno.h>
17 #include <sys/wait.h>
18 #include <ucontext.h>
19
20 #define FAILURE(mesg) { printf("failed in the API: %s with errno relative message: %s\n", mesg, strerror( errno ) ); exit(EXIT_FAILURE); }
21
22 #ifdef CONFIG_SSDEBUG
23 #define SSDEBUG         printf
24 #else
25 #define SSDEBUG(...)    do { } while (0)
26 #endif
27
28 /* extern declaration definition */
29 struct SnapShot * snapshotrecord = NULL;
30
31 #if !USE_MPROTECT_SNAPSHOT
32 /** @statics
33 *   These variables are necessary because the stack is shared region and
34 *   there exists a race between all processes executing the same function.
35 *   To avoid the problem above, we require variables allocated in 'safe' regions.
36 *   The bug was actually observed with the forkID, these variables below are
37 *   used to indicate the various contexts to which to switch to.
38 *
39 *   @savedSnapshotContext: contains the point to which takesnapshot() call should switch to.
40 *   @savedUserSnapshotContext: contains the point to which the process whose snapshotid is equal to the rollbackid should switch to
41 *   @snapshotid: it is a running counter for the various forked processes snapshotid. it is incremented and set in a persistently shared record
42 */
43 static ucontext_t savedSnapshotContext;
44 static ucontext_t savedUserSnapshotContext;
45 static snapshot_id snapshotid = 0;
46 #endif
47
48 /** PageAlignedAdressUpdate return a page aligned address for the
49  * address being added as a side effect the numBytes are also changed.
50  */
51 static void * PageAlignAddressUpward(void * addr) {
52         return (void *)((((uintptr_t)addr)+PAGESIZE-1)&~(PAGESIZE-1));
53 }
54
55 #if USE_MPROTECT_SNAPSHOT
56
57 /** ReturnPageAlignedAddress returns a page aligned address for the
58  * address being added as a side effect the numBytes are also changed.
59  */
60 static void * ReturnPageAlignedAddress(void * addr) {
61         return (void *)(((uintptr_t)addr)&~(PAGESIZE-1));
62 }
63
64 /** The initSnapShotRecord method initialized the snapshotting data
65  *  structures for the mprotect based snapshot.
66  */
67 static void initSnapShotRecord(unsigned int numbackingpages, unsigned int numsnapshots, unsigned int nummemoryregions) {
68         snapshotrecord=( struct SnapShot * )MYMALLOC(sizeof(struct SnapShot));
69         snapshotrecord->regionsToSnapShot=( struct MemoryRegion * )MYMALLOC(sizeof(struct MemoryRegion)*nummemoryregions);
70         snapshotrecord->backingStoreBasePtr= ( struct SnapShotPage * )MYMALLOC( sizeof( struct SnapShotPage ) * (numbackingpages + 1) );
71         //Page align the backingstorepages
72         snapshotrecord->backingStore=( struct SnapShotPage * )PageAlignAddressUpward(snapshotrecord->backingStoreBasePtr);
73         snapshotrecord->backingRecords=( struct BackingPageRecord * )MYMALLOC(sizeof(struct BackingPageRecord)*numbackingpages);
74         snapshotrecord->snapShots= ( struct SnapShotRecord * )MYMALLOC(sizeof(struct SnapShotRecord)*numsnapshots);
75         snapshotrecord->lastSnapShot=0;
76         snapshotrecord->lastBackingPage=0;
77         snapshotrecord->lastRegion=0;
78         snapshotrecord->maxRegions=nummemoryregions;
79         snapshotrecord->maxBackingPages=numbackingpages;
80         snapshotrecord->maxSnapShots=numsnapshots;
81 }
82
83 /** HandlePF is the page fault handler for mprotect based snapshotting
84  * algorithm.
85  */
86 static void HandlePF( int sig, siginfo_t *si, void * unused){
87         if( si->si_code == SEGV_MAPERR ){
88                 printf("Real Fault at %p\n", si->si_addr);
89                 exit( EXIT_FAILURE );
90         }
91         void* addr = ReturnPageAlignedAddress(si->si_addr);
92
93         unsigned int backingpage=snapshotrecord->lastBackingPage++; //Could run out of pages...
94         if (backingpage==snapshotrecord->maxBackingPages) {
95                 printf("Out of backing pages at %p\n", si->si_addr);
96                 exit( EXIT_FAILURE );
97         }
98
99         //copy page
100         memcpy(&(snapshotrecord->backingStore[backingpage]), addr, sizeof(struct SnapShotPage));
101         //remember where to copy page back to
102         snapshotrecord->backingRecords[backingpage].basePtrOfPage=addr;
103         //set protection to read/write
104         if (mprotect( addr, sizeof(struct SnapShotPage), PROT_READ | PROT_WRITE )) {
105                 perror("mprotect");
106                 // Handle error by quitting?
107         }
108 }
109 #endif //nothing to handle for non snapshotting case.
110
111 #if !USE_MPROTECT_SNAPSHOT
112 void createSharedMemory(){
113         //step 1. create shared memory.
114         void * memMapBase = mmap( 0, SHARED_MEMORY_DEFAULT + STACK_SIZE_DEFAULT, PROT_READ | PROT_WRITE, MAP_SHARED|MAP_ANON, -1, 0 );
115         if( MAP_FAILED == memMapBase )
116                 FAILURE("mmap");
117
118         //Setup snapshot record at top of free region
119         snapshotrecord = ( struct SnapShot * )memMapBase;
120         snapshotrecord->mSharedMemoryBase = (void *)((uintptr_t)memMapBase + sizeof(struct SnapShot));
121         snapshotrecord->mStackBase = (void *)((uintptr_t)memMapBase + SHARED_MEMORY_DEFAULT);
122         snapshotrecord->mStackSize = STACK_SIZE_DEFAULT;
123         snapshotrecord->mIDToRollback = -1;
124         snapshotrecord->currSnapShotID = 0;
125 }
126 #endif
127
128
129 /** The initSnapShotLibrary function initializes the Snapshot library.
130  *  @param entryPoint the function that should run the program.
131  */
132 #if USE_MPROTECT_SNAPSHOT
133
134 void initSnapShotLibrary(unsigned int numbackingpages,
135                 unsigned int numsnapshots, unsigned int nummemoryregions,
136                 unsigned int numheappages, VoidFuncPtr entryPoint) {
137         /* Setup a stack for our signal handler....  */
138         stack_t ss;
139         ss.ss_sp = MYMALLOC(SIGSTACKSIZE);
140         ss.ss_size = SIGSTACKSIZE;
141         ss.ss_flags = 0;
142         sigaltstack(&ss, NULL);
143
144         struct sigaction sa;
145         sa.sa_flags = SA_SIGINFO | SA_NODEFER | SA_RESTART | SA_ONSTACK;
146         sigemptyset( &sa.sa_mask );
147         sa.sa_sigaction = HandlePF;
148 #ifdef MAC
149         if( sigaction( SIGBUS, &sa, NULL ) == -1 ){
150                 printf("SIGACTION CANNOT BE INSTALLED\n");
151                 exit(EXIT_FAILURE);
152         }
153 #endif
154         if( sigaction( SIGSEGV, &sa, NULL ) == -1 ){
155                 printf("SIGACTION CANNOT BE INSTALLED\n");
156                 exit(EXIT_FAILURE);
157         }
158
159         initSnapShotRecord(numbackingpages, numsnapshots, nummemoryregions);
160
161         // EVIL HACK: We need to make sure that calls into the HandlePF method don't cause dynamic links
162         // The problem is that we end up protecting state in the dynamic linker...
163         // Solution is to call our signal handler before we start protecting stuff...
164
165         siginfo_t si;
166         memset(&si, 0, sizeof(si));
167         si.si_addr=ss.ss_sp;
168         HandlePF(SIGSEGV, &si, NULL);
169         snapshotrecord->lastBackingPage--; //remove the fake page we copied
170
171         basemySpace=MYMALLOC((numheappages+1)*PAGESIZE);
172         void * pagealignedbase=PageAlignAddressUpward(basemySpace);
173         mySpace = create_mspace_with_base(pagealignedbase,  numheappages*PAGESIZE, 1 );
174         addMemoryRegionToSnapShot(pagealignedbase, numheappages);
175         entryPoint();
176 }
177 #else
178 void initSnapShotLibrary(unsigned int numbackingpages,
179                 unsigned int numsnapshots, unsigned int nummemoryregions,
180                 unsigned int numheappages, VoidFuncPtr entryPoint) {
181         basemySpace=system_malloc((numheappages+1)*PAGESIZE);
182         void * pagealignedbase=PageAlignAddressUpward(basemySpace);
183         mySpace = create_mspace_with_base(pagealignedbase,  numheappages*PAGESIZE, 1 );
184         if (!snapshotrecord)
185                 createSharedMemory();
186
187         //step 2 setup the stack context.
188         ucontext_t newContext;
189         getcontext( &newContext );
190         newContext.uc_stack.ss_sp = snapshotrecord->mStackBase;
191         newContext.uc_stack.ss_size = STACK_SIZE_DEFAULT;
192         makecontext( &newContext, entryPoint, 0 );
193         /* switch to a new entryPoint context, on a new stack */
194         swapcontext(&savedSnapshotContext, &newContext);
195
196         /* switch back here when takesnapshot is called */
197         pid_t forkedID = 0;
198         snapshotid = snapshotrecord->currSnapShotID;
199         /* This bool indicates that the current process's snapshotid is same
200                  as the id to which the rollback needs to occur */
201
202         bool rollback = false;
203         while( true ){
204                 snapshotrecord->currSnapShotID=snapshotid+1;
205                 forkedID = fork();
206
207                 if( 0 == forkedID ){
208                         /* If the rollback bool is set, switch to the context we need to
209                                  return to during a rollback. */
210                         if( rollback) {
211                                 setcontext( &( snapshotrecord->mContextToRollback ) );
212                         } else {
213                                 /*Child process which is forked as a result of takesnapshot
214                                         call should switch back to the takesnapshot context*/
215                                 setcontext( &savedUserSnapshotContext );
216                         }
217                 } else {
218                         int status;
219                         int retVal;
220
221                         SSDEBUG("The process id of child is %d and the process id of this process is %d and snapshot id is %d\n",
222                                 forkedID, getpid(), snapshotid );
223
224                         do {
225                                 retVal=waitpid( forkedID, &status, 0 );
226                         } while( -1 == retVal && errno == EINTR );
227
228                         if( snapshotrecord->mIDToRollback != snapshotid ) {
229                                 exit(EXIT_SUCCESS);
230                         }
231                         rollback = true;
232                 }
233         }
234 }
235 #endif
236
237 /** The addMemoryRegionToSnapShot function assumes that addr is page aligned.
238  */
239 void addMemoryRegionToSnapShot( void * addr, unsigned int numPages) {
240 #if USE_MPROTECT_SNAPSHOT
241         unsigned int memoryregion=snapshotrecord->lastRegion++;
242         if (memoryregion==snapshotrecord->maxRegions) {
243                 printf("Exceeded supported number of memory regions!\n");
244                 exit(EXIT_FAILURE);
245         }
246
247         snapshotrecord->regionsToSnapShot[ memoryregion ].basePtr=addr;
248         snapshotrecord->regionsToSnapShot[ memoryregion ].sizeInPages=numPages;
249 #endif //NOT REQUIRED IN THE CASE OF FORK BASED SNAPSHOTS.
250 }
251
252 /** The takeSnapshot function takes a snapshot.
253  * @return The snapshot identifier.
254  */
255 snapshot_id takeSnapshot( ){
256 #if USE_MPROTECT_SNAPSHOT
257         for(unsigned int region=0; region<snapshotrecord->lastRegion;region++) {
258                 if( mprotect(snapshotrecord->regionsToSnapShot[region].basePtr, snapshotrecord->regionsToSnapShot[region].sizeInPages*sizeof(struct SnapShotPage), PROT_READ ) == -1 ){
259                         perror("mprotect");
260                         printf("Failed to mprotect inside of takeSnapShot\n");
261                         exit(EXIT_FAILURE);
262                 }
263         }
264         unsigned int snapshot=snapshotrecord->lastSnapShot++;
265         if (snapshot==snapshotrecord->maxSnapShots) {
266                 printf("Out of snapshots\n");
267                 exit(EXIT_FAILURE);
268         }
269         snapshotrecord->snapShots[snapshot].firstBackingPage=snapshotrecord->lastBackingPage;
270
271         return snapshot;
272 #else
273         swapcontext( &savedUserSnapshotContext, &savedSnapshotContext );
274         SSDEBUG("TAKESNAPSHOT RETURN\n");
275         return snapshotid;
276 #endif
277 }
278
279 /** The rollBack function rollback to the given snapshot identifier.
280  *  @param theID is the snapshot identifier to rollback to.
281  */
282 void rollBack( snapshot_id theID ){
283 #if USE_MPROTECT_SNAPSHOT
284         HashTable< void *, bool, uintptr_t, 4, MYMALLOC, MYCALLOC, MYFREE> duplicateMap;
285         for(unsigned int region=0; region<snapshotrecord->lastRegion;region++) {
286                 if( mprotect(snapshotrecord->regionsToSnapShot[region].basePtr, snapshotrecord->regionsToSnapShot[region].sizeInPages*sizeof(struct SnapShotPage), PROT_READ | PROT_WRITE ) == -1 ){
287                         perror("mprotect");
288                         printf("Failed to mprotect inside of takeSnapShot\n");
289                         exit(EXIT_FAILURE);
290                 }
291         }
292         for(unsigned int page=snapshotrecord->snapShots[theID].firstBackingPage; page<snapshotrecord->lastBackingPage; page++) {
293                 if( !duplicateMap.contains(snapshotrecord->backingRecords[page].basePtrOfPage )) {
294                         duplicateMap.put(snapshotrecord->backingRecords[page].basePtrOfPage, true);
295                         memcpy(snapshotrecord->backingRecords[page].basePtrOfPage, &snapshotrecord->backingStore[page], sizeof(struct SnapShotPage));
296                 }
297         }
298         snapshotrecord->lastSnapShot=theID;
299         snapshotrecord->lastBackingPage=snapshotrecord->snapShots[theID].firstBackingPage;
300         takeSnapshot(); //Make sure current snapshot is still good...All later ones are cleared
301 #else
302         snapshotrecord->mIDToRollback = theID;
303         volatile int sTemp = 0;
304         getcontext( &snapshotrecord->mContextToRollback );
305         /*
306          * This is used to quit the process on rollback, so that the process
307          * which needs to rollback can quit allowing the process whose
308          * snapshotid matches the rollbackid to switch to this context and
309          * continue....
310          */
311         if( !sTemp ){
312                 sTemp = 1;
313                 SSDEBUG("Invoked rollback\n");
314                 exit(EXIT_SUCCESS);
315         }
316         /*
317          * This fix obviates the need for a finalize call. hence less dependences for model-checker....
318          *
319          */
320         snapshotrecord->mIDToRollback = -1;
321 #endif
322 }
323