X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=snapshot-interface.cc;h=d93e5c20dce3203378c2ea9d4f611bb90580686d;hb=3864415594472a6a9b2b09bb0e0f846f056b7a47;hp=58e1dd2ff3ae036a2011a0db24e1f95db03dcc60;hpb=843f65d8af9e9b4c73f844ecc2a22fbafaee7967;p=c11tester.git

diff --git a/snapshot-interface.cc b/snapshot-interface.cc
index 58e1dd2f..d93e5c20 100644
--- a/snapshot-interface.cc
+++ b/snapshot-interface.cc
@@ -21,7 +21,11 @@
 SnapshotStack * snapshotObject;
 
 #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;
@@ -52,21 +56,23 @@ void SnapshotGlobalSegments(){
 		//Skip out at the end of the section
 		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);
 		}
 	}
 	pclose(map);
 }
 #else
-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], filename[100];
 	FILE *map;
@@ -87,15 +93,13 @@ void SnapshotGlobalSegments(){
 			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);
+			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;
@@ -104,6 +108,13 @@ SnapshotStack::SnapshotStack(){
 SnapshotStack::~SnapshotStack(){
 }
 
+
+/** 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) {
 	while(true) {
 		if (stack->index<=seqindex) {
@@ -112,11 +123,12 @@ int SnapshotStack::backTrackBeforeStep(int seqindex) {
 			return stack->index;
 		}
 		struct stackEntry *tmp=stack;
-		MYFREE(tmp);
 		stack=stack->next;
+		MYFREE(tmp);
 	}
 }
 
+/** This method takes a snapshot at the given sequence number. */
 void SnapshotStack::snapshotStep(int seqindex) {
 	struct stackEntry *tmp=(struct stackEntry *)MYMALLOC(sizeof(struct stackEntry));
 	tmp->next=stack;