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 <set>
   8 #include <cstring>
   9 #include <cstdio>
  10 #include "snapshot.h"
  11 #include "snapshotimp.h"
  12 #include "mymemory.h"
  13 #include <fcntl.h>
  14 #include <assert.h>
  15 #include <pthread.h>
  16 #include <semaphore.h>
  17 #include <errno.h>
  18 #include <sys/wait.h>
  19 #include <ucontext.h>
  20 #include <sys/time.h>
  21 //extern declaration definition
  22 #define FAILURE(mesg) { printf("failed in the API: %s with errno relative message: %s\n", mesg, strerror( errno ) ); exit( -1 ); }
  23 #if USE_CHECKPOINTING
  24 struct SnapShot * snapshotrecord = NULL;
  25 struct Snapshot_t * sTheRecord = NULL;
  26 #else
  27 struct Snapshot_t * sTheRecord = NULL;
  28 #endif
  29 void BeginOperation( struct timeval * theStartTime ){
  30 #if 1
  31         gettimeofday( theStartTime, NULL );
  32 #endif
  33 }
  34 #if SSDEBUG
  35 struct timeval *starttime = NULL;
  36 #endif
  37 void DumpIntoLog( const char * filename, const char * message ){
  38 #if SSDEBUG
  39         static pid_t thePID = getpid();
  40         char newFn[ 1024 ] ={ 0 };
  41         sprintf( newFn,"%s-%d.txt", filename, thePID );
  42         FILE * myFile = fopen( newFn, "w+" );
  43         struct timeval theEndTime;
  44         BeginOperation( &theEndTime );
  45         double elapsed = ( theEndTime.tv_sec - starttime->tv_sec ) + ( theEndTime.tv_usec - starttime->tv_usec ) / 1000000.0;
  46         fprintf( myFile, "The timestamp %f:--> the message %s: the process id %d\n", elapsed, message, thePID );
  47         fflush( myFile );
  48         fclose( myFile );
  49         myFile = NULL;
  50 #endif
  51 }
  52 #if !USE_CHECKPOINTING
  53 static ucontext_t savedSnapshotContext;
  54 static ucontext_t savedUserSnapshotContext;
  55 static int snapshotid = 0;
  56 #endif
  57 /* Initialize snapshot data structure */
  58 #if USE_CHECKPOINTING
  59 void initSnapShotRecord(unsigned int numbackingpages, unsigned int numsnapshots, unsigned int nummemoryregions) {
  60         snapshotrecord=( struct SnapShot * )MYMALLOC(sizeof(struct SnapShot));
  61         snapshotrecord->regionsToSnapShot=( struct MemoryRegion * )MYMALLOC(sizeof(struct MemoryRegion)*nummemoryregions);
  62         snapshotrecord->backingStoreBasePtr= ( struct SnapShotPage * )MYMALLOC( sizeof( struct SnapShotPage ) * (numbackingpages + 1) );
  63         //Page align the backingstorepages
  64         snapshotrecord->backingStore=( struct SnapShotPage * )ReturnPageAlignedAddress((void*) ((uintptr_t)(snapshotrecord->backingStoreBasePtr)+sizeof(struct SnapShotPage)-1));
  65         snapshotrecord->backingRecords=( struct BackingPageRecord * )MYMALLOC(sizeof(struct BackingPageRecord)*numbackingpages);
  66         snapshotrecord->snapShots= ( struct SnapShotRecord * )MYMALLOC(sizeof(struct SnapShotRecord)*numsnapshots);
  67         snapshotrecord->lastSnapShot=0;
  68         snapshotrecord->lastBackingPage=0;
  69         snapshotrecord->lastRegion=0;
  70         snapshotrecord->maxRegions=nummemoryregions;
  71         snapshotrecord->maxBackingPages=numbackingpages;
  72         snapshotrecord->maxSnapShots=numsnapshots;
  73 }
  74 #endif //nothing to initialize for the fork based snapshotting.
  75
  76 void HandlePF( int sig, siginfo_t *si, void * unused){
  77 #if USE_CHECKPOINTING
  78         if( si->si_code == SEGV_MAPERR ){
  79                 printf("Real Fault at %llx\n", ( long long )si->si_addr);
  80                 exit( EXIT_FAILURE );
  81         }
  82         void* addr = ReturnPageAlignedAddress(si->si_addr);
  83         unsigned int backingpage=snapshotrecord->lastBackingPage++; //Could run out of pages...
  84         if (backingpage==snapshotrecord->maxBackingPages) {
  85                 printf("Out of backing pages at %llx\n", ( long long )si->si_addr);
  86                 exit( EXIT_FAILURE );
  87         }
  88
  89         //copy page
  90         memcpy(&(snapshotrecord->backingStore[backingpage]), addr, sizeof(struct SnapShotPage));
  91         //remember where to copy page back to
  92         snapshotrecord->backingRecords[backingpage].basePtrOfPage=addr;
  93         //set protection to read/write
  94         if (mprotect( addr, sizeof(struct SnapShotPage), PROT_READ | PROT_WRITE )) {
  95                 perror("mprotect");
  96                 // Handle error by quitting?
  97         }
  98 #endif //nothing to handle for non snapshotting case.
  99 }
 100
 101 //Return a page aligned address for the address being added
 102 //as a side effect the numBytes are also changed.
 103 void * ReturnPageAlignedAddress(void * addr) {
 104         return (void *)(((uintptr_t)addr)&~(PAGESIZE-1));
 105 }
 106 #ifdef __cplusplus
 107 extern "C" {
 108 #endif
 109         void createSharedLibrary(){
 110 #if !USE_CHECKPOINTING
 111                 //step 1. create shared memory.
 112                 if( sTheRecord ) return;
 113                 int fd = shm_open( "/ModelChecker-Snapshotter", O_RDWR | O_CREAT, 0777 ); //universal permissions.
 114                 if( -1 == fd ) FAILURE("shm_open");
 115                 if( -1 == ftruncate( fd, ( size_t )SHARED_MEMORY_DEFAULT + ( size_t )STACK_SIZE_DEFAULT ) ) FAILURE( "ftruncate" );
 116                 char * memMapBase = ( char * ) mmap( 0, ( size_t )SHARED_MEMORY_DEFAULT + ( size_t )STACK_SIZE_DEFAULT, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0 );
 117                 if( MAP_FAILED == memMapBase ) FAILURE("mmap");
 118                 sTheRecord = ( struct Snapshot_t * )memMapBase;
 119                 sTheRecord->mSharedMemoryBase = memMapBase + sizeof( struct Snapshot_t );
 120                 sTheRecord->mStackBase = ( char * )memMapBase + ( size_t )SHARED_MEMORY_DEFAULT;
 121                 sTheRecord->mStackSize = STACK_SIZE_DEFAULT;
 122                 sTheRecord->mIDToRollback = -1;
 123                 sTheRecord->currSnapShotID = 0;
 124 #endif
 125         }
 126 #ifdef __cplusplus
 127 }
 128 #endif
 129 void initSnapShotLibrary(unsigned int numbackingpages, unsigned int numsnapshots, unsigned int nummemoryregions, unsigned int numheappages, MyFuncPtr entryPoint){
 130 #if USE_CHECKPOINTING
 131         struct sigaction sa;
 132         sa.sa_flags = SA_SIGINFO | SA_NODEFER | SA_RESTART;
 133         sigemptyset( &sa.sa_mask );
 134         sa.sa_sigaction = HandlePF;
 135         if( sigaction( SIGSEGV, &sa, NULL ) == -1 ){
 136                 printf("SIGACTION CANNOT BE INSTALLED\n");
 137                 exit(-1);
 138         }
 139         initSnapShotRecord(numbackingpages, numsnapshots, nummemoryregions);
 140
 141         basemySpace=MYMALLOC((numheappages+1)*PAGESIZE);
 142         void * pagealignedbase=(void *)((((uintptr_t)basemySpace)+PAGESIZE-1)&~(PAGESIZE-1));
 143         mySpace = create_mspace_with_base(pagealignedbase,  numheappages*PAGESIZE, 1 );
 144         addMemoryRegionToSnapShot(pagealignedbase, numheappages);
 145         entryPoint();
 146 #else
 147         //add a signal to indicate that the process is going to terminate.
 148         struct sigaction sa;
 149         sa.sa_flags = SA_SIGINFO | SA_NODEFER | SA_RESTART;
 150         sigemptyset( &sa.sa_mask );
 151         sa.sa_sigaction = HandlePF;
 152         if( sigaction( SIGUSR1, &sa, NULL ) == -1 ){
 153                 printf("SIGACTION CANNOT BE INSTALLED\n");
 154                 exit(-1);
 155         }
 156         createSharedLibrary();
 157 #if SSDEBUG
 158         starttime = &(sTheRecord->startTimeGlobal);
 159         gettimeofday( starttime, NULL );
 160 #endif
 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_CHECKPOINTING
 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_CHECKPOINTING
 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_CHECKPOINTING
 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_CHECKPOINTING
 294         sTheRecord->mbFinalize = true;
 295 #endif
 296 }
 297