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 <map>
   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 //extern declaration definition
  21 #define FAILURE(mesg) { printf("failed in the API: %s with errno relative message: %s\n", mesg, strerror( errno ) ); exit( -1 ); }
  22 #if USE_MPROTECT_SNAPSHOT
  23 struct SnapShot * snapshotrecord = NULL;
  24 struct Snapshot_t * sTheRecord = NULL;
  25 #else
  26 struct Snapshot_t * sTheRecord = NULL;
  27 #endif
  28 void DumpIntoLog( const char * filename, const char * message ){
  29 #if SSDEBUG
  30         static pid_t thePID = getpid();
  31         char newFn[ 1024 ] ={ 0 };
  32         sprintf( newFn,"%s-%d.txt", filename, thePID );
  33         FILE * myFile = fopen( newFn, "w+" );
  34         fprintf( myFile, "the message %s: the process id %d\n", message, thePID );
  35         fflush( myFile );
  36         fclose( myFile );
  37         myFile = NULL;
  38 #endif
  39 }
  40 #if !USE_MPROTECT_SNAPSHOT
  41 static ucontext_t savedSnapshotContext;
  42 static ucontext_t savedUserSnapshotContext;
  43 static snapshot_id snapshotid = 0;
  44 #endif
  45 /* Initialize snapshot data structure */
  46 #if USE_MPROTECT_SNAPSHOT
  47 void initSnapShotRecord(unsigned int numbackingpages, unsigned int numsnapshots, unsigned int nummemoryregions) {
  48         snapshotrecord=( struct SnapShot * )MYMALLOC(sizeof(struct SnapShot));
  49         snapshotrecord->regionsToSnapShot=( struct MemoryRegion * )MYMALLOC(sizeof(struct MemoryRegion)*nummemoryregions);
  50         snapshotrecord->backingStoreBasePtr= ( struct SnapShotPage * )MYMALLOC( sizeof( struct SnapShotPage ) * (numbackingpages + 1) );
  51         //Page align the backingstorepages
  52         snapshotrecord->backingStore=( struct SnapShotPage * )PageAlignAddressUpward(snapshotrecord->backingStoreBasePtr);
  53         snapshotrecord->backingRecords=( struct BackingPageRecord * )MYMALLOC(sizeof(struct BackingPageRecord)*numbackingpages);
  54         snapshotrecord->snapShots= ( struct SnapShotRecord * )MYMALLOC(sizeof(struct SnapShotRecord)*numsnapshots);
  55         snapshotrecord->lastSnapShot=0;
  56         snapshotrecord->lastBackingPage=0;
  57         snapshotrecord->lastRegion=0;
  58         snapshotrecord->maxRegions=nummemoryregions;
  59         snapshotrecord->maxBackingPages=numbackingpages;
  60         snapshotrecord->maxSnapShots=numsnapshots;
  61 }
  62 #endif //nothing to initialize for the fork based snapshotting.
  63
  64 void HandlePF( int sig, siginfo_t *si, void * unused){
  65 #if USE_MPROTECT_SNAPSHOT
  66         if( si->si_code == SEGV_MAPERR ){
  67                 printf("Real Fault at %p\n", si->si_addr);
  68                 exit( EXIT_FAILURE );
  69         }
  70         void* addr = ReturnPageAlignedAddress(si->si_addr);
  71         unsigned int backingpage=snapshotrecord->lastBackingPage++; //Could run out of pages...
  72         if (backingpage==snapshotrecord->maxBackingPages) {
  73                 printf("Out of backing pages at %p\n", si->si_addr);
  74                 exit( EXIT_FAILURE );
  75         }
  76
  77         //copy page
  78         memcpy(&(snapshotrecord->backingStore[backingpage]), addr, sizeof(struct SnapShotPage));
  79         //remember where to copy page back to
  80         snapshotrecord->backingRecords[backingpage].basePtrOfPage=addr;
  81         //set protection to read/write
  82         if (mprotect( addr, sizeof(struct SnapShotPage), PROT_READ | PROT_WRITE )) {
  83                 perror("mprotect");
  84                 // Handle error by quitting?
  85         }
  86 #endif //nothing to handle for non snapshotting case.
  87 }
  88
  89 //Return a page aligned address for the address being added
  90 //as a side effect the numBytes are also changed.
  91 void * ReturnPageAlignedAddress(void * addr) {
  92         return (void *)(((uintptr_t)addr)&~(PAGESIZE-1));
  93 }
  94
  95 //Return a page aligned address for the address being added
  96 //as a side effect the numBytes are also changed.
  97 void * PageAlignAddressUpward(void * addr) {
  98         return (void *)((((uintptr_t)addr)+PAGESIZE-1)&~(PAGESIZE-1));
  99 }
 100 #ifdef __cplusplus
 101 extern "C" {
 102 #endif
 103         void createSharedLibrary(){
 104 #if !USE_MPROTECT_SNAPSHOT
 105                 //step 1. create shared memory.
 106                 if( sTheRecord ) return;
 107                 int fd = shm_open( "/ModelChecker-Snapshotter", O_RDWR | O_CREAT, 0777 ); //universal permissions.
 108                 if( -1 == fd ) FAILURE("shm_open");
 109                 if( -1 == ftruncate( fd, ( size_t )SHARED_MEMORY_DEFAULT + ( size_t )STACK_SIZE_DEFAULT ) ) FAILURE( "ftruncate" );
 110                 char * memMapBase = ( char * ) mmap( 0, ( size_t )SHARED_MEMORY_DEFAULT + ( size_t )STACK_SIZE_DEFAULT, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0 );
 111                 if( MAP_FAILED == memMapBase ) FAILURE("mmap");
 112                 sTheRecord = ( struct Snapshot_t * )memMapBase;
 113                 sTheRecord->mSharedMemoryBase = memMapBase + sizeof( struct Snapshot_t );
 114                 sTheRecord->mStackBase = ( char * )memMapBase + ( size_t )SHARED_MEMORY_DEFAULT;
 115                 sTheRecord->mStackSize = STACK_SIZE_DEFAULT;
 116                 sTheRecord->mIDToRollback = -1;
 117                 sTheRecord->currSnapShotID = 0;
 118 #endif
 119         }
 120 #ifdef __cplusplus
 121 }
 122 #endif
 123 void initSnapShotLibrary(unsigned int numbackingpages,
 124                 unsigned int numsnapshots, unsigned int nummemoryregions,
 125                 unsigned int numheappages, VoidFuncPtr entryPoint) {
 126 #if USE_MPROTECT_SNAPSHOT
 127         /* Setup a stack for our signal handler....  */
 128         stack_t ss;
 129         ss.ss_sp = MYMALLOC(SIGSTACKSIZE);
 130         ss.ss_size = SIGSTACKSIZE;
 131         ss.ss_flags = 0;
 132         sigaltstack(&ss, NULL);
 133
 134         struct sigaction sa;
 135         sa.sa_flags = SA_SIGINFO | SA_NODEFER | SA_RESTART | SA_ONSTACK;
 136         sigemptyset( &sa.sa_mask );
 137         sa.sa_sigaction = HandlePF;
 138         if( sigaction( SIGSEGV, &sa, NULL ) == -1 ){
 139                 printf("SIGACTION CANNOT BE INSTALLED\n");
 140                 exit(-1);
 141         }
 142         initSnapShotRecord(numbackingpages, numsnapshots, nummemoryregions);
 143
 144         basemySpace=MYMALLOC((numheappages+1)*PAGESIZE);
 145         void * pagealignedbase=PageAlignAddressUpward(basemySpace);
 146         mySpace = create_mspace_with_base(pagealignedbase,  numheappages*PAGESIZE, 1 );
 147         addMemoryRegionToSnapShot(pagealignedbase, numheappages);
 148         entryPoint();
 149 #else
 150         //add a signal to indicate that the process is going to terminate.
 151         struct sigaction sa;
 152         sa.sa_flags = SA_SIGINFO | SA_NODEFER | SA_RESTART;
 153         sigemptyset( &sa.sa_mask );
 154         sa.sa_sigaction = HandlePF;
 155         if( sigaction( SIGUSR1, &sa, NULL ) == -1 ){
 156                 printf("SIGACTION CANNOT BE INSTALLED\n");
 157                 exit(-1);
 158         }
 159         createSharedLibrary();
 160
 161         //step 2 setup the stack context.
 162
 163         int alreadySwapped = 0;
 164         getcontext( &savedSnapshotContext );
 165         if( !alreadySwapped ){
 166                 alreadySwapped = 1;
 167                 ucontext_t currentContext, swappedContext, newContext;
 168                 getcontext( &newContext );
 169                 newContext.uc_stack.ss_sp = sTheRecord->mStackBase;
 170                 newContext.uc_stack.ss_size = STACK_SIZE_DEFAULT;
 171                 newContext.uc_link = &currentContext;
 172                 makecontext( &newContext, entryPoint, 0 );
 173                 swapcontext( &swappedContext, &newContext );
 174         }
 175
 176         //add the code to take a snapshot here...
 177         //to return to user process, do a second swapcontext...
 178         pid_t forkedID = 0;
 179         snapshotid = sTheRecord->currSnapShotID;
 180         bool swapContext = false;
 181         while( !sTheRecord->mbFinalize ){
 182                 sTheRecord->currSnapShotID=snapshotid+1;
 183                 forkedID = fork();
 184                 if( 0 == forkedID ){
 185                         ucontext_t currentContext;
 186 #if 0
 187                         int dbg = 0;
 188                         while( !dbg );
 189 #endif
 190                         if( swapContext )
 191                                 swapcontext( &currentContext, &( sTheRecord->mContextToRollback ) );
 192                         else{
 193                                 swapcontext( &currentContext, &savedUserSnapshotContext );
 194                         }
 195                 } else {
 196                         int status;
 197                         int retVal;
 198 #if SSDEBUG
 199                         char mesg[ 1024 ] = { 0 };
 200                         sprintf( mesg, "The process id of child is %d and the process id of this process is %d and snapshot id is %d", forkedID, getpid(), snapshotid );
 201                         DumpIntoLog( "ModelSnapshot", mesg );
 202 #endif
 203                         do {
 204                                 retVal=waitpid( forkedID, &status, 0 );
 205                         } while( -1 == retVal && errno == EINTR );
 206
 207                         if( sTheRecord->mIDToRollback != snapshotid )
 208                                 exit(0);
 209                         else{
 210                                 swapContext = true;
 211                         }
 212                 }
 213         }
 214
 215 #endif
 216 }
 217 /* This function assumes that addr is page aligned */
 218 void addMemoryRegionToSnapShot( void * addr, unsigned int numPages) {
 219 #if USE_MPROTECT_SNAPSHOT
 220         unsigned int memoryregion=snapshotrecord->lastRegion++;
 221         if (memoryregion==snapshotrecord->maxRegions) {
 222                 printf("Exceeded supported number of memory regions!\n");
 223                 exit(-1);
 224         }
 225
 226         snapshotrecord->regionsToSnapShot[ memoryregion ].basePtr=addr;
 227         snapshotrecord->regionsToSnapShot[ memoryregion ].sizeInPages=numPages;
 228 #endif //NOT REQUIRED IN THE CASE OF FORK BASED SNAPSHOTS.
 229 }
 230 //take snapshot
 231 snapshot_id takeSnapshot( ){
 232 #if USE_MPROTECT_SNAPSHOT
 233         for(unsigned int region=0; region<snapshotrecord->lastRegion;region++) {
 234                 if( mprotect(snapshotrecord->regionsToSnapShot[region].basePtr, snapshotrecord->regionsToSnapShot[region].sizeInPages*sizeof(struct SnapShotPage), PROT_READ ) == -1 ){
 235                         perror("mprotect");
 236                         printf("Failed to mprotect inside of takeSnapShot\n");
 237                         exit(-1);
 238                 }
 239         }
 240         unsigned int snapshot=snapshotrecord->lastSnapShot++;
 241         if (snapshot==snapshotrecord->maxSnapShots) {
 242                 printf("Out of snapshots\n");
 243                 exit(-1);
 244         }
 245         snapshotrecord->snapShots[snapshot].firstBackingPage=snapshotrecord->lastBackingPage;
 246
 247         return snapshot;
 248 #else
 249         swapcontext( &savedUserSnapshotContext, &savedSnapshotContext );
 250         return snapshotid;
 251 #endif
 252 }
 253 void rollBack( snapshot_id theID ){
 254 #if USE_MPROTECT_SNAPSHOT
 255         std::map< void *, bool, std::less< void * >, MyAlloc< std::pair< const void *, bool > > > duplicateMap;
 256         for(unsigned int region=0; region<snapshotrecord->lastRegion;region++) {
 257                 if( mprotect(snapshotrecord->regionsToSnapShot[region].basePtr, snapshotrecord->regionsToSnapShot[region].sizeInPages*sizeof(struct SnapShotPage), PROT_READ | PROT_WRITE ) == -1 ){
 258                         perror("mprotect");
 259                         printf("Failed to mprotect inside of takeSnapShot\n");
 260                         exit(-1);
 261                 }
 262         }
 263         for(unsigned int page=snapshotrecord->snapShots[theID].firstBackingPage; page<snapshotrecord->lastBackingPage; page++) {
 264                 bool oldVal = false;
 265                 if( duplicateMap.find( snapshotrecord->backingRecords[page].basePtrOfPage ) != duplicateMap.end() ){
 266                         oldVal = true;
 267                 }
 268                 else{
 269                         duplicateMap[ snapshotrecord->backingRecords[page].basePtrOfPage ] = true;
 270                 }
 271                 if(  !oldVal ){
 272                         memcpy(snapshotrecord->backingRecords[page].basePtrOfPage, &snapshotrecord->backingStore[page], sizeof(struct SnapShotPage));
 273                 }
 274         }
 275         snapshotrecord->lastSnapShot=theID;
 276         snapshotrecord->lastBackingPage=snapshotrecord->snapShots[theID].firstBackingPage;
 277         takeSnapshot(); //Make sure current snapshot is still good...All later ones are cleared
 278 #else
 279         sTheRecord->mIDToRollback = theID;
 280         int sTemp = 0;
 281         getcontext( &sTheRecord->mContextToRollback );
 282         if( !sTemp ){
 283                 sTemp = 1;
 284 #if SSDEBUG
 285                 DumpIntoLog( "ModelSnapshot", "Invoked rollback" );
 286 #endif
 287                 exit( 0 );
 288         }
 289 #endif
 290 }
 291
 292 void finalize(){
 293 #if !USE_MPROTECT_SNAPSHOT
 294         sTheRecord->mbFinalize = true;
 295 #endif
 296 }
 297