libthreads: thrd_join() always return 0
[c11tester.git] / snapshot-interface.cc
index 58e1dd2ff3ae036a2011a0db24e1f95db03dcc60..84749f1f4b0d3a3fa2cca047dee826696eba84c9 100644 (file)
 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,7 +56,7 @@ 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);
 
                if (w == 'w' && (strstr(regionname, MYBINARYNAME) || strstr(regionname, MYLIBRARYNAME))) {
@@ -66,7 +70,11 @@ void SnapshotGlobalSegments(){
        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;
@@ -94,8 +102,6 @@ void SnapshotGlobalSegments(){
 }
 #endif
 
-//class definition of SnapshotStack.....
-//declaration of constructor....
 SnapshotStack::SnapshotStack(){
        SnapshotGlobalSegments();
        stack=NULL;
@@ -104,6 +110,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) {
@@ -117,6 +130,7 @@ int SnapshotStack::backTrackBeforeStep(int seqindex) {
        }
 }
 
+/** 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;