add support for dumping cyclegraphs as dot files... also eliminate redundant edges...

[model-checker.git] / cyclegraph.h

diff --git a/cyclegraph.h b/cyclegraph.h
index a748c7791110f5c37837ff72131bc8901b98e4e5..c8e8956be10529d194304061f8f90a6c48181181 100644 (file)
--- 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;
@@ -12,26 +18,71 @@ class ModelAction;
 class CycleGraph {
  public:
        CycleGraph();
-       void addEdge(ModelAction *from, ModelAction *to);
+       ~CycleGraph();
+       void addEdge(const ModelAction *from, const ModelAction *to);
        bool checkForCycles();
+       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 dumpGraphToFile(const char * filename);
+#endif
 
+       SNAPSHOTALLOC
  private:
-       CycleNode * getNode(ModelAction *);
-       HashTable<ModelAction *, CycleNode *, uintptr_t, 4> actionToNode;
+       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(ModelAction *action);
-       void addEdge(CycleNode * node);
+       CycleNode(const ModelAction *action);
+       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:
-       ModelAction *action;
+       /** @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;
 };
 
 #endif