bugfix - add stl-model.h wrappers, to provide more control over STL
[c11tester.git] / snapshot-interface.cc
index 58e1dd2ff3ae036a2011a0db24e1f95db03dcc60..bd1de3e60645f15e299e545b07d197b5c90d4e43 100644 (file)
@@ -1,33 +1,52 @@
-#include "snapshot-interface.h"
-#include "snapshot.h"
-#include <iostream>
-#include <fstream>
+#include <stdlib.h>
 #include <unistd.h>
-#include <sys/types.h>
-#include <sstream>
 #include <cstring>
-#include <string>
-#include <cassert>
-#include <vector>
-#include <utility>
 #include <inttypes.h>
-#include "common.h"
 
+#include "snapshot-interface.h"
+#include "snapshot.h"
+#include "common.h"
+#include "mymemory.h"
+#include "stl-model.h"
 
+/* MYBINARYNAME only works because our pathname usually includes 'model' (e.g.,
+ * /.../model-checker/test/userprog.o) */
 #define MYBINARYNAME "model"
 #define MYLIBRARYNAME "libmodel.so"
-#define MAPFILE_FORMAT "/proc/%d/maps"
+#define MAPFILE "/proc/self/maps"
+
+struct snapshot_entry {
+       snapshot_entry(snapshot_id id, int idx) : snapshotid(id), index(idx) { }
+       snapshot_id snapshotid;
+       int index;
+       MEMALLOC
+};
 
-SnapshotStack * snapshotObject;
+class SnapshotStack {
+ public:
+       int backTrackBeforeStep(int seq_index);
+       void snapshotStep(int seq_index);
+
+       MEMALLOC
+ private:
+       ModelVector<struct snapshot_entry> stack;
+};
+
+static SnapshotStack *snap_stack;
 
 #ifdef MAC
-void SnapshotGlobalSegments(){
+/** The SnapshotGlobalSegments function computes the memory regions
+ *     that may contain globals and then configures the snapshotting
+ *     library to snapshot them.
+ */
+static void SnapshotGlobalSegments()
+{
        int pid = getpid();
        char buf[9000], execname[100];
        FILE *map;
 
        sprintf(execname, "vmmap -interleaved %d", pid);
-       map=popen(execname, "r");
+       map = popen(execname, "r");
 
        if (!map) {
                perror("popen");
@@ -50,77 +69,100 @@ void SnapshotGlobalSegments(){
                void *begin, *end;
 
                //Skip out at the end of the section
-               if (buf[0]=='\n')
+               if (buf[0] == '\n')
                        break;
-               
-               sscanf(buf, "%22s %p-%p [%5dK] %c%c%c/%c%c%c SM=%3s %200s\n", &type, &begin, &end, &size, &r, &w, &x, &mr, &mw, &mx, smstr, regionname);
+
+               sscanf(buf, "%22s %p-%p [%5dK] %c%c%c/%c%c%c SM=%3s %200s\n", type, &begin, &end, &size, &r, &w, &x, &mr, &mw, &mx, smstr, regionname);
 
                if (w == 'w' && (strstr(regionname, MYBINARYNAME) || strstr(regionname, MYLIBRARYNAME))) {
                        size_t len = ((uintptr_t)end - (uintptr_t)begin) / PAGESIZE;
                        if (len != 0)
-                               addMemoryRegionToSnapShot(begin, len);
-                       DEBUG("%s\n", buf);
-                       DEBUG("%45s: %18p - %18p\t%c%c%c%c\n", regionname, begin, end, r, w, x, p);
+                               snapshot_add_memory_region(begin, len);
                }
        }
        pclose(map);
 }
 #else
-void SnapshotGlobalSegments(){
-       int pid = getpid();
-       char buf[9000], filename[100];
+
+static void get_binary_name(char *buf, size_t len)
+{
+       if (readlink("/proc/self/exe", buf, len) == -1) {
+               perror("readlink");
+               exit(EXIT_FAILURE);
+       }
+}
+
+/** The SnapshotGlobalSegments function computes the memory regions
+ *     that may contain globals and then configures the snapshotting
+ *     library to snapshot them.
+ */
+static void SnapshotGlobalSegments()
+{
+       char buf[9000];
+       char binary_name[800];
        FILE *map;
 
-       sprintf(filename, MAPFILE_FORMAT, pid);
-       map = fopen(filename, "r");
+       map = fopen(MAPFILE, "r");
        if (!map) {
                perror("fopen");
                exit(EXIT_FAILURE);
        }
+       get_binary_name(binary_name, sizeof(binary_name));
        while (fgets(buf, sizeof(buf), map)) {
                char regionname[200] = "";
                char r, w, x, p;
                void *begin, *end;
 
                sscanf(buf, "%p-%p %c%c%c%c %*x %*x:%*x %*u %200s\n", &begin, &end, &r, &w, &x, &p, regionname);
-               if (w == 'w' && (strstr(regionname, MYBINARYNAME) || strstr(regionname, MYLIBRARYNAME))) {
+               if (w == 'w' && (strstr(regionname, binary_name) || strstr(regionname, MYLIBRARYNAME))) {
                        size_t len = ((uintptr_t)end - (uintptr_t)begin) / PAGESIZE;
                        if (len != 0)
-                               addMemoryRegionToSnapShot(begin, len);
-                       DEBUG("%45s: %18p - %18p\t%c%c%c%c\n", regionname, begin, end, r, w, x, p);
+                               snapshot_add_memory_region(begin, len);
+                       DEBUG("%55s: %18p - %18p\t%c%c%c%c\n", regionname, begin, end, r, w, x, p);
                }
        }
        fclose(map);
 }
 #endif
 
-//class definition of SnapshotStack.....
-//declaration of constructor....
-SnapshotStack::SnapshotStack(){
-       SnapshotGlobalSegments();
-       stack=NULL;
+/** This method returns to the last snapshot before the inputted
+ * sequence number.  This function must be called from the model
+ * checking thread and not from a snapshotted stack.
+ * @param seqindex is the sequence number to rollback before.
+ * @return is the sequence number we actually rolled back to.
+ */
+int SnapshotStack::backTrackBeforeStep(int seqindex)
+{
+       int i;
+       for (i = (int)stack.size() - 1; i >= 0; i++)
+               if (stack[i].index <= seqindex)
+                       break;
+               else
+                       stack.pop_back();
+
+       ASSERT(i >= 0);
+       snapshot_roll_back(stack[i].snapshotid);
+       return stack[i].index;
 }
 
-SnapshotStack::~SnapshotStack(){
+/** This method takes a snapshot at the given sequence number. */
+void SnapshotStack::snapshotStep(int seqindex)
+{
+       stack.push_back(snapshot_entry(take_snapshot(), seqindex));
 }
 
-int SnapshotStack::backTrackBeforeStep(int seqindex) {
-       while(true) {
-               if (stack->index<=seqindex) {
-                       //have right entry
-                       rollBack(stack->snapshotid);
-                       return stack->index;
-               }
-               struct stackEntry *tmp=stack;
-               MYFREE(tmp);
-               stack=stack->next;
-       }
+void snapshot_stack_init()
+{
+       snap_stack = new SnapshotStack();
+       SnapshotGlobalSegments();
+}
+
+void snapshot_record(int seq_index)
+{
+       snap_stack->snapshotStep(seq_index);
 }
 
-void SnapshotStack::snapshotStep(int seqindex) {
-       struct stackEntry *tmp=(struct stackEntry *)MYMALLOC(sizeof(struct stackEntry));
-       tmp->next=stack;
-       tmp->index=seqindex;
-       tmp->snapshotid=takeSnapshot();
-       stack=tmp;
+int snapshot_backtrack_before(int seq_index)
+{
+       return snap_stack->backTrackBeforeStep(seq_index);
 }