more documentation

[c11tester.git] / snapshot-interface.h

diff --git a/snapshot-interface.h b/snapshot-interface.h
index 5f5f4ea01246b8fa506e06dcfb5cba5f3a38ef81..1c4c32b0339c574bc7bde31096a78c2fec3a5932 100644 (file)
--- a/snapshot-interface.h
+++ b/snapshot-interface.h
@@ -1,17 +1,19 @@
+/** @file snapshot-interface.h
+ *  @brief C++ layer on top of snapshotting system.
+ */
+
+
 #ifndef __SNAPINTERFACE_H
 #define __SNAPINTERFACE_H
-#include "snapshot.h"
 #include "mymemory.h"
-#include <vector>
-#include <utility>
-#include <string>
-#include <map>
-#include <set>
-#include "snapshot.h"
-#include "libthreads.h"
 
-class snapshotStack;
-typedef std::basic_string<char, std::char_traits<char>, MyAlloc<char> > MyString;
+typedef unsigned int snapshot_id;
+
+typedef void (*VoidFuncPtr)();
+void initSnapShotLibrary(unsigned int numbackingpages,
+               unsigned int numsnapshots, unsigned int nummemoryregions,
+               unsigned int numheappages, VoidFuncPtr entryPoint);
+void finalize();
 
 void SnapshotGlobalSegments();
 
@@ -21,15 +23,20 @@ struct stackEntry {
   int index;
 };
 
-class snapshotStack {
+class SnapshotStack {
  public:
   MEMALLOC
-  snapshotStack( );
-  ~snapshotStack();
+  SnapshotStack( );
+  ~SnapshotStack();
   int backTrackBeforeStep(int seq_index);
   void snapshotStep(int seq_index);
 
  private: 
   struct stackEntry * stack;
 };
+
+/* Not sure what it even means to have more than one snapshot object,
+   so let's just make a global reference to it.*/
+
+extern SnapshotStack * snapshotObject;
 #endif