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 <string.h>
   7 #include <errno.h>
   8 #include <sys/wait.h>
   9
  10 #include "hashtable.h"
  11 #include "snapshot.h"
  12 #include "mymemory.h"
  13 #include "common.h"
  14 #include "context.h"
  15 #include "model.h"
  16
  17 /** PageAlignedAdressUpdate return a page aligned address for the
  18  * address being added as a side effect the numBytes are also changed.
  19  */
  20 static void * PageAlignAddressUpward(void *addr)
  21 {
  22         return (void *)((((uintptr_t)addr) + PAGESIZE - 1) & ~(PAGESIZE - 1));
  23 }
  24
  25 #if USE_MPROTECT_SNAPSHOT
  26
  27 /* Each SnapShotRecord lists the firstbackingpage that must be written to
  28  * revert to that snapshot */
  29 struct SnapShotRecord {
  30         unsigned int firstBackingPage;
  31 };
  32
  33 /** @brief Backing store page */
  34 typedef unsigned char snapshot_page_t[PAGESIZE];
  35
  36 /* List the base address of the corresponding page in the backing store so we
  37  * know where to copy it to */
  38 struct BackingPageRecord {
  39         void *basePtrOfPage;
  40 };
  41
  42 /* Struct for each memory region */
  43 struct MemoryRegion {
  44         void *basePtr;  // base of memory region
  45         int sizeInPages;        // size of memory region in pages
  46 };
  47
  48 /** ReturnPageAlignedAddress returns a page aligned address for the
  49  * address being added as a side effect the numBytes are also changed.
  50  */
  51 static void * ReturnPageAlignedAddress(void *addr)
  52 {
  53         return (void *)(((uintptr_t)addr) & ~(PAGESIZE - 1));
  54 }
  55
  56 /* Primary struct for snapshotting system */
  57 struct mprot_snapshotter {
  58         mprot_snapshotter(unsigned int numbackingpages, unsigned int numsnapshots, unsigned int nummemoryregions);
  59         ~mprot_snapshotter();
  60
  61         struct MemoryRegion *regionsToSnapShot; //This pointer references an array of memory regions to snapshot
  62         snapshot_page_t *backingStore;  //This pointer references an array of snapshotpage's that form the backing store
  63         void *backingStoreBasePtr;      //This pointer references an array of snapshotpage's that form the backing store
  64         struct BackingPageRecord *backingRecords;       //This pointer references an array of backingpagerecord's (same number of elements as backingstore
  65         struct SnapShotRecord *snapShots;       //This pointer references the snapshot array
  66
  67         unsigned int lastSnapShot;      //Stores the next snapshot record we should use
  68         unsigned int lastBackingPage;   //Stores the next backingpage we should use
  69         unsigned int lastRegion;        //Stores the next memory region to be used
  70
  71         unsigned int maxRegions;        //Stores the max number of memory regions we support
  72         unsigned int maxBackingPages;   //Stores the total number of backing pages
  73         unsigned int maxSnapShots;      //Stores the total number of snapshots we allow
  74
  75         MEMALLOC
  76 };
  77
  78 static struct mprot_snapshotter *mprot_snap = NULL;
  79
  80 mprot_snapshotter::mprot_snapshotter(unsigned int backing_pages, unsigned int snapshots, unsigned int regions) :
  81         lastSnapShot(0),
  82         lastBackingPage(0),
  83         lastRegion(0),
  84         maxRegions(regions),
  85         maxBackingPages(backing_pages),
  86         maxSnapShots(snapshots)
  87 {
  88         regionsToSnapShot = (struct MemoryRegion *)model_malloc(sizeof(struct MemoryRegion) * regions);
  89         backingStoreBasePtr = (void *)model_malloc(sizeof(snapshot_page_t) * (backing_pages + 1));
  90         //Page align the backingstorepages
  91         backingStore = (snapshot_page_t *)PageAlignAddressUpward(backingStoreBasePtr);
  92         backingRecords = (struct BackingPageRecord *)model_malloc(sizeof(struct BackingPageRecord) * backing_pages);
  93         snapShots = (struct SnapShotRecord *)model_malloc(sizeof(struct SnapShotRecord) * snapshots);
  94 }
  95
  96 mprot_snapshotter::~mprot_snapshotter()
  97 {
  98         model_free(regionsToSnapShot);
  99         model_free(backingStoreBasePtr);
 100         model_free(backingRecords);
 101         model_free(snapShots);
 102 }
 103
 104 /** mprot_handle_pf is the page fault handler for mprotect based snapshotting
 105  * algorithm.
 106  */
 107 static void mprot_handle_pf(int sig, siginfo_t *si, void *unused)
 108 {
 109         if (si->si_code == SEGV_MAPERR) {
 110                 model_print("Segmentation fault at %p\n", si->si_addr);
 111                 model_print("For debugging, place breakpoint at: %s:%d\n",
 112                                                                 __FILE__, __LINE__);
 113                 // print_trace(); // Trace printing may cause dynamic memory allocation
 114                 exit(EXIT_FAILURE);
 115         }
 116         void* addr = ReturnPageAlignedAddress(si->si_addr);
 117
 118         unsigned int backingpage = mprot_snap->lastBackingPage++;       //Could run out of pages...
 119         if (backingpage == mprot_snap->maxBackingPages) {
 120                 model_print("Out of backing pages at %p\n", si->si_addr);
 121                 exit(EXIT_FAILURE);
 122         }
 123
 124         //copy page
 125         memcpy(&(mprot_snap->backingStore[backingpage]), addr, sizeof(snapshot_page_t));
 126         //remember where to copy page back to
 127         mprot_snap->backingRecords[backingpage].basePtrOfPage = addr;
 128         //set protection to read/write
 129         if (mprotect(addr, sizeof(snapshot_page_t), PROT_READ | PROT_WRITE)) {
 130                 perror("mprotect");
 131                 // Handle error by quitting?
 132         }
 133 }
 134
 135 static void mprot_snapshot_init(unsigned int numbackingpages,
 136                                                                                                                                 unsigned int numsnapshots, unsigned int nummemoryregions,
 137                                                                                                                                 unsigned int numheappages)
 138 {
 139         /* Setup a stack for our signal handler....  */
 140         stack_t ss;
 141         ss.ss_sp = PageAlignAddressUpward(model_malloc(SIGSTACKSIZE + PAGESIZE - 1));
 142         ss.ss_size = SIGSTACKSIZE;
 143         ss.ss_flags = 0;
 144         sigaltstack(&ss, NULL);
 145
 146         struct sigaction sa;
 147         sa.sa_flags = SA_SIGINFO | SA_NODEFER | SA_RESTART | SA_ONSTACK;
 148         sigemptyset(&sa.sa_mask);
 149         sa.sa_sigaction = mprot_handle_pf;
 150 #ifdef MAC
 151         if (sigaction(SIGBUS, &sa, NULL) == -1) {
 152                 perror("sigaction(SIGBUS)");
 153                 exit(EXIT_FAILURE);
 154         }
 155 #endif
 156         if (sigaction(SIGSEGV, &sa, NULL) == -1) {
 157                 perror("sigaction(SIGSEGV)");
 158                 exit(EXIT_FAILURE);
 159         }
 160
 161         mprot_snap = new mprot_snapshotter(numbackingpages, numsnapshots, nummemoryregions);
 162
 163         // EVIL HACK: We need to make sure that calls into the mprot_handle_pf method don't cause dynamic links
 164         // The problem is that we end up protecting state in the dynamic linker...
 165         // Solution is to call our signal handler before we start protecting stuff...
 166
 167         siginfo_t si;
 168         memset(&si, 0, sizeof(si));
 169         si.si_addr = ss.ss_sp;
 170         mprot_handle_pf(SIGSEGV, &si, NULL);
 171         mprot_snap->lastBackingPage--;  //remove the fake page we copied
 172
 173         void *basemySpace = model_malloc((numheappages + 1) * PAGESIZE);
 174         void *pagealignedbase = PageAlignAddressUpward(basemySpace);
 175         user_snapshot_space = create_mspace_with_base(pagealignedbase, numheappages * PAGESIZE, 1);
 176         snapshot_add_memory_region(pagealignedbase, numheappages);
 177
 178         void *base_model_snapshot_space = model_malloc((numheappages + 1) * PAGESIZE);
 179         pagealignedbase = PageAlignAddressUpward(base_model_snapshot_space);
 180         model_snapshot_space = create_mspace_with_base(pagealignedbase, numheappages * PAGESIZE, 1);
 181         snapshot_add_memory_region(pagealignedbase, numheappages);
 182 }
 183
 184
 185 static void mprot_startExecution(VoidFuncPtr entryPoint) {
 186         entryPoint();
 187 }
 188
 189 static void mprot_add_to_snapshot(void *addr, unsigned int numPages)
 190 {
 191         unsigned int memoryregion = mprot_snap->lastRegion++;
 192         if (memoryregion == mprot_snap->maxRegions) {
 193                 model_print("Exceeded supported number of memory regions!\n");
 194                 exit(EXIT_FAILURE);
 195         }
 196
 197         DEBUG("snapshot region %p-%p (%u page%s)\n",
 198                                 addr, (char *)addr + numPages * PAGESIZE, numPages,
 199                                 numPages > 1 ? "s" : "");
 200         mprot_snap->regionsToSnapShot[memoryregion].basePtr = addr;
 201         mprot_snap->regionsToSnapShot[memoryregion].sizeInPages = numPages;
 202 }
 203
 204 static snapshot_id mprot_take_snapshot()
 205 {
 206         for (unsigned int region = 0;region < mprot_snap->lastRegion;region++) {
 207                 if (mprotect(mprot_snap->regionsToSnapShot[region].basePtr, mprot_snap->regionsToSnapShot[region].sizeInPages * sizeof(snapshot_page_t), PROT_READ) == -1) {
 208                         perror("mprotect");
 209                         model_print("Failed to mprotect inside of takeSnapShot\n");
 210                         exit(EXIT_FAILURE);
 211                 }
 212         }
 213         unsigned int snapshot = mprot_snap->lastSnapShot++;
 214         if (snapshot == mprot_snap->maxSnapShots) {
 215                 model_print("Out of snapshots\n");
 216                 exit(EXIT_FAILURE);
 217         }
 218         mprot_snap->snapShots[snapshot].firstBackingPage = mprot_snap->lastBackingPage;
 219
 220         return snapshot;
 221 }
 222
 223 static void mprot_roll_back(snapshot_id theID)
 224 {
 225 #if USE_MPROTECT_SNAPSHOT == 2
 226         if (mprot_snap->lastSnapShot == (theID + 1)) {
 227                 for (unsigned int page = mprot_snap->snapShots[theID].firstBackingPage;page < mprot_snap->lastBackingPage;page++) {
 228                         memcpy(mprot_snap->backingRecords[page].basePtrOfPage, &mprot_snap->backingStore[page], sizeof(snapshot_page_t));
 229                 }
 230                 return;
 231         }
 232 #endif
 233
 234         HashTable< void *, bool, uintptr_t, 4, model_malloc, model_calloc, model_free> duplicateMap;
 235         for (unsigned int region = 0;region < mprot_snap->lastRegion;region++) {
 236                 if (mprotect(mprot_snap->regionsToSnapShot[region].basePtr, mprot_snap->regionsToSnapShot[region].sizeInPages * sizeof(snapshot_page_t), PROT_READ | PROT_WRITE) == -1) {
 237                         perror("mprotect");
 238                         model_print("Failed to mprotect inside of takeSnapShot\n");
 239                         exit(EXIT_FAILURE);
 240                 }
 241         }
 242         for (unsigned int page = mprot_snap->snapShots[theID].firstBackingPage;page < mprot_snap->lastBackingPage;page++) {
 243                 if (!duplicateMap.contains(mprot_snap->backingRecords[page].basePtrOfPage)) {
 244                         duplicateMap.put(mprot_snap->backingRecords[page].basePtrOfPage, true);
 245                         memcpy(mprot_snap->backingRecords[page].basePtrOfPage, &mprot_snap->backingStore[page], sizeof(snapshot_page_t));
 246                 }
 247         }
 248         mprot_snap->lastSnapShot = theID;
 249         mprot_snap->lastBackingPage = mprot_snap->snapShots[theID].firstBackingPage;
 250         mprot_take_snapshot();  //Make sure current snapshot is still good...All later ones are cleared
 251 }
 252
 253 #else   /* !USE_MPROTECT_SNAPSHOT */
 254
 255 #define SHARED_MEMORY_DEFAULT  (200 * ((size_t)1 << 20))        // 100mb for the shared memory
 256 #define STACK_SIZE_DEFAULT      (((size_t)1 << 20) * 20)        // 20 mb out of the above 100 mb for my stack
 257
 258 struct fork_snapshotter {
 259         /** @brief Pointer to the shared (non-snapshot) memory heap base
 260          * (NOTE: this has size SHARED_MEMORY_DEFAULT - sizeof(*fork_snap)) */
 261         void *mSharedMemoryBase;
 262
 263         /** @brief Pointer to the shared (non-snapshot) stack region */
 264         void *mStackBase;
 265
 266         /** @brief Size of the shared stack */
 267         size_t mStackSize;
 268
 269         /**
 270          * @brief Stores the ID that we are attempting to roll back to
 271          *
 272          * Used in inter-process communication so that each process can
 273          * determine whether or not to take over execution (w/ matching ID) or
 274          * exit (we're rolling back even further). Dubiously marked 'volatile'
 275          * to prevent compiler optimizations from messing with the
 276          * inter-process behavior.
 277          */
 278         volatile snapshot_id mIDToRollback;
 279
 280         /**
 281          * @brief The context for the shared (non-snapshot) stack
 282          *
 283          * This context is passed between the various processes which represent
 284          * various snapshot states. It should be used primarily for the
 285          * "client-side" code, not the main snapshot loop.
 286          */
 287         ucontext_t shared_ctxt;
 288
 289         /** @brief Inter-process tracking of the next snapshot ID */
 290         snapshot_id currSnapShotID;
 291 };
 292
 293 static struct fork_snapshotter *fork_snap = NULL;
 294
 295 /** @statics
 296  *   These variables are necessary because the stack is shared region and
 297  *   there exists a race between all processes executing the same function.
 298  *   To avoid the problem above, we require variables allocated in 'safe' regions.
 299  *   The bug was actually observed with the forkID, these variables below are
 300  *   used to indicate the various contexts to which to switch to.
 301  *
 302  *   @private_ctxt: the context which is internal to the current process. Used
 303  *   for running the internal snapshot/rollback loop.
 304  *   @exit_ctxt: a special context used just for exiting from a process (so we
 305  *   can use swapcontext() instead of setcontext() + hacks)
 306  *   @snapshotid: it is a running counter for the various forked processes
 307  *   snapshotid. it is incremented and set in a persistently shared record
 308  */
 309 static ucontext_t private_ctxt;
 310 static ucontext_t exit_ctxt;
 311 static snapshot_id snapshotid = 0;
 312
 313 /**
 314  * @brief Create a new context, with a given stack and entry function
 315  * @param ctxt The context structure to fill
 316  * @param stack The stack to run the new context in
 317  * @param stacksize The size of the stack
 318  * @param func The entry point function for the context
 319  */
 320 static void create_context(ucontext_t *ctxt, void *stack, size_t stacksize,
 321                                                                                                          void (*func)(void))
 322 {
 323         getcontext(ctxt);
 324         ctxt->uc_stack.ss_sp = stack;
 325         ctxt->uc_stack.ss_size = stacksize;
 326         makecontext(ctxt, func, 0);
 327 }
 328
 329 /** @brief An empty function, used for an "empty" context which just exits a
 330  *  process */
 331 static void fork_exit()
 332 {
 333         /* Intentionally empty */
 334 }
 335
 336 static void createSharedMemory()
 337 {
 338         //step 1. create shared memory.
 339         void *memMapBase = mmap(0, SHARED_MEMORY_DEFAULT + STACK_SIZE_DEFAULT, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_ANON, -1, 0);
 340         if (memMapBase == MAP_FAILED) {
 341                 perror("mmap");
 342                 exit(EXIT_FAILURE);
 343         }
 344
 345         //Setup snapshot record at top of free region
 346         fork_snap = (struct fork_snapshotter *)memMapBase;
 347         fork_snap->mSharedMemoryBase = (void *)((uintptr_t)memMapBase + sizeof(*fork_snap));
 348         fork_snap->mStackBase = (void *)((uintptr_t)memMapBase + SHARED_MEMORY_DEFAULT);
 349         fork_snap->mStackSize = STACK_SIZE_DEFAULT;
 350         fork_snap->mIDToRollback = -1;
 351         fork_snap->currSnapShotID = 0;
 352 }
 353
 354 /**
 355  * Create a new mspace pointer for the non-snapshotting (i.e., inter-process
 356  * shared) memory region. Only for fork-based snapshotting.
 357  *
 358  * @return The shared memory mspace
 359  */
 360 mspace create_shared_mspace()
 361 {
 362         if (!fork_snap)
 363                 createSharedMemory();
 364         return create_mspace_with_base((void *)(fork_snap->mSharedMemoryBase), SHARED_MEMORY_DEFAULT - sizeof(*fork_snap), 1);
 365 }
 366
 367 static void fork_snapshot_init(unsigned int numbackingpages,
 368                                                                                                                          unsigned int numsnapshots, unsigned int nummemoryregions,
 369                                                                                                                          unsigned int numheappages)
 370 {
 371         if (!fork_snap)
 372                 createSharedMemory();
 373
 374         void *base_model_snapshot_space = malloc((numheappages + 1) * PAGESIZE);
 375         void *pagealignedbase = PageAlignAddressUpward(base_model_snapshot_space);
 376         model_snapshot_space = create_mspace_with_base(pagealignedbase, numheappages * PAGESIZE, 1);
 377 }
 378
 379 static void fork_startExecution(VoidFuncPtr entryPoint) {
 380         /* setup an "exiting" context */
 381         char stack[128];
 382         create_context(&exit_ctxt, stack, sizeof(stack), fork_exit);
 383
 384         /* setup the shared-stack context */
 385         create_context(&fork_snap->shared_ctxt, fork_snap->mStackBase,
 386                                                                  STACK_SIZE_DEFAULT, entryPoint);
 387         /* switch to a new entryPoint context, on a new stack */
 388         model_swapcontext(&private_ctxt, &fork_snap->shared_ctxt);
 389
 390         /* switch back here when takesnapshot is called */
 391         snapshotid = fork_snap->currSnapShotID;
 392         if (model->params.nofork) {
 393                 setcontext(&fork_snap->shared_ctxt);
 394                 exit(EXIT_SUCCESS);
 395         }
 396
 397         while (true) {
 398                 pid_t forkedID;
 399                 fork_snap->currSnapShotID = snapshotid + 1;
 400                 forkedID = fork();
 401
 402                 if (0 == forkedID) {
 403                         setcontext(&fork_snap->shared_ctxt);
 404                 } else {
 405                         DEBUG("parent PID: %d, child PID: %d, snapshot ID: %d\n",
 406                                                 getpid(), forkedID, snapshotid);
 407
 408                         while (waitpid(forkedID, NULL, 0) < 0) {
 409                                 /* waitpid() may be interrupted */
 410                                 if (errno != EINTR) {
 411                                         perror("waitpid");
 412                                         exit(EXIT_FAILURE);
 413                                 }
 414                         }
 415
 416                         if (fork_snap->mIDToRollback != snapshotid)
 417                                 exit(EXIT_SUCCESS);
 418                 }
 419         }
 420 }
 421
 422 static snapshot_id fork_take_snapshot()
 423 {
 424         model_swapcontext(&fork_snap->shared_ctxt, &private_ctxt);
 425         DEBUG("TAKESNAPSHOT RETURN\n");
 426         return snapshotid;
 427 }
 428
 429 static void fork_roll_back(snapshot_id theID)
 430 {
 431         DEBUG("Rollback\n");
 432         fork_snap->mIDToRollback = theID;
 433         model_swapcontext(&fork_snap->shared_ctxt, &exit_ctxt);
 434         fork_snap->mIDToRollback = -1;
 435 }
 436
 437 #endif  /* !USE_MPROTECT_SNAPSHOT */
 438
 439 /**
 440  * @brief Initializes the snapshot system
 441  * @param entryPoint the function that should run the program.
 442  */
 443 void snapshot_system_init(unsigned int numbackingpages,
 444                                                                                                         unsigned int numsnapshots, unsigned int nummemoryregions,
 445                                                                                                         unsigned int numheappages)
 446 {
 447 #if USE_MPROTECT_SNAPSHOT
 448         mprot_snapshot_init(numbackingpages, numsnapshots, nummemoryregions, numheappages);
 449 #else
 450         fork_snapshot_init(numbackingpages, numsnapshots, nummemoryregions, numheappages);
 451 #endif
 452 }
 453
 454 void startExecution(VoidFuncPtr entryPoint)
 455 {
 456 #if USE_MPROTECT_SNAPSHOT
 457         mprot_startExecution(entryPoint);
 458 #else
 459         fork_startExecution(entryPoint);
 460 #endif
 461 }
 462
 463 /** Assumes that addr is page aligned. */
 464 void snapshot_add_memory_region(void *addr, unsigned int numPages)
 465 {
 466 #if USE_MPROTECT_SNAPSHOT
 467         mprot_add_to_snapshot(addr, numPages);
 468 #else
 469         /* not needed for fork-based snapshotting */
 470 #endif
 471 }
 472
 473 /** Takes a snapshot of memory.
 474  * @return The snapshot identifier.
 475  */
 476 snapshot_id take_snapshot()
 477 {
 478 #if USE_MPROTECT_SNAPSHOT
 479         return mprot_take_snapshot();
 480 #else
 481         return fork_take_snapshot();
 482 #endif
 483 }
 484
 485 /** Rolls the memory state back to the given snapshot identifier.
 486  *  @param theID is the snapshot identifier to rollback to.
 487  */
 488 void snapshot_roll_back(snapshot_id theID)
 489 {
 490 #if USE_MPROTECT_SNAPSHOT
 491         mprot_roll_back(theID);
 492 #else
 493         fork_roll_back(theID);
 494 #endif
 495 }