add support for dumping cyclegraphs as dot files... also eliminate redundant edges...
[model-checker.git] / cyclegraph.h
index 5cf709324a863d51e4ec45956093600460495232..c8e8956be10529d194304061f8f90a6c48181181 100644 (file)
@@ -8,6 +8,8 @@
 #include "hashtable.h"
 #include <vector>
 #include <inttypes.h>
+#include "config.h"
+#include "mymemory.h"
 
 class CycleNode;
 class ModelAction;
@@ -19,26 +21,67 @@ 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 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;
 };