X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=cyclegraph.h;h=42866a3b370ceb52ab85967c1cfe0c80f4aedf6f;hb=bad8cc4598438f8b8d9e8fa210e2790f92c9ec44;hp=3ed4e4a2f6fe6bb008a3038b9c7208db0f9613b4;hpb=247e28f81f258c3c380be00a89430186f8ac11ed;p=model-checker.git

diff --git a/cyclegraph.h b/cyclegraph.h
index 3ed4e4a..42866a3 100644
--- a/cyclegraph.h
+++ b/cyclegraph.h
@@ -1,9 +1,15 @@
+/** @file cyclegraph.h @brief Data structure to track ordering
+ *  constraints on modification order.  The idea is to see whether a
+ *  total order exists that satisfies the ordering constriants.*/
+
 #ifndef CYCLEGRAPH_H
 #define CYCLEGRAPH_H
 
 #include "hashtable.h"
 #include <vector>
 #include <inttypes.h>
+#include "config.h"
+#include "mymemory.h"
 
 class CycleNode;
 class ModelAction;
@@ -15,26 +21,68 @@ class CycleGraph {
 	~CycleGraph();
 	void addEdge(const ModelAction *from, const ModelAction *to);
 	bool checkForCycles();
-	void addRMWEdge(const ModelAction *from, const ModelAction *to);
+	bool checkForRMWViolation();
+	void addRMWEdge(const ModelAction *from, const ModelAction *rmw);
+
+	bool checkReachable(const ModelAction *from, const ModelAction *to);
+	void startChanges();
+	void commitChanges();
+	void rollbackChanges();
+#if SUPPORT_MOD_ORDER_DUMP
+	void dumpNodes(FILE *file);
+	void dumpGraphToFile(const char * filename);
+#endif
 
+	SNAPSHOTALLOC
  private:
 	CycleNode * getNode(const ModelAction *);
+
+	/** @brief A table for mapping ModelActions to CycleNodes */
 	HashTable<const ModelAction *, CycleNode *, uintptr_t, 4> actionToNode;
+#if SUPPORT_MOD_ORDER_DUMP
+	std::vector<CycleNode *> nodeList;
+#endif
+
 	bool checkReachable(CycleNode *from, CycleNode *to);
+
+	/** @brief A flag: true if this graph contains cycles */
 	bool hasCycles;
+	bool oldCycles;
+
+	bool hasRMWViolation;
+	bool oldRMWViolation;
+
+	std::vector<CycleNode *> rollbackvector;
+	std::vector<CycleNode *> rmwrollbackvector;
 };
 
+/** @brief A node within a CycleGraph; corresponds to one ModelAction */
 class CycleNode {
  public:
 	CycleNode(const ModelAction *action);
-	void addEdge(CycleNode * node);
+	bool addEdge(CycleNode * node);
 	std::vector<CycleNode *> * getEdges();
 	bool setRMW(CycleNode *);
 	CycleNode* getRMW();
+	const ModelAction * getAction() {return action;};
 
+	void popEdge() {
+		edges.pop_back();
+	};
+	void clearRMW() {
+		hasRMW=NULL;
+	}
+
+	SNAPSHOTALLOC
  private:
+	/** @brief The ModelAction that this node represents */
 	const ModelAction *action;
+
+	/** @brief The edges leading out from this node */
 	std::vector<CycleNode *> edges;
+
+	/** Pointer to a RMW node that reads from this node, or NULL, if none
+	 * exists */
 	CycleNode * hasRMW;
 };