cyclegraph: add Promise CycleNode

[c11tester.git] / cyclegraph.h

diff --git a/cyclegraph.h b/cyclegraph.h
index a98e68c972e77cf6b615cff94521bd872df4e26a..f7b346c1f062c6b8932908b552144829f070b2d8 100644 (file)
--- a/cyclegraph.h
+++ b/cyclegraph.h
@@ -1,10 +1,21 @@
-#ifndef CYCLEGRAPH_H
-#define CYCLEGRAPH_H
+/**
+ * @file cyclegraph.h
+ * @brief Data structure to track ordering constraints on modification order
+ *
+ * Used to determine whether a total order exists that satisfies the ordering
+ * constraints.
+ */
+
+#ifndef __CYCLEGRAPH_H__
+#define __CYCLEGRAPH_H__
 
 #include "hashtable.h"
 #include <vector>
 #include <inttypes.h>
+#include "config.h"
+#include "mymemory.h"
 
+class Promise;
 class CycleNode;
 class ModelAction;
 
@@ -14,24 +25,83 @@ class CycleGraph {
        CycleGraph();
        ~CycleGraph();
        void addEdge(const ModelAction *from, const ModelAction *to);
-       bool checkForCycles();
+       bool checkForCycles() const;
+       void addRMWEdge(const ModelAction *from, const ModelAction *rmw);
+       bool checkPromise(const ModelAction *from, Promise *p) const;
+       bool checkReachable(const ModelAction *from, const ModelAction *to) const;
+       void startChanges();
+       void commitChanges();
+       void rollbackChanges();
+#if SUPPORT_MOD_ORDER_DUMP
+       void dumpNodes(FILE *file) const;
+       void dumpGraphToFile(const char *filename) const;
+#endif
 
+       SNAPSHOTALLOC
  private:
+       void addEdge(CycleNode *fromnode, CycleNode *tonode);
+       void putNode(const ModelAction *act, CycleNode *node);
        CycleNode * getNode(const ModelAction *);
+       HashTable<const CycleNode *, const CycleNode *, uintptr_t, 4, model_malloc, model_calloc, model_free> *discovered;
+
+       /** @brief A table for mapping ModelActions to CycleNodes */
        HashTable<const ModelAction *, CycleNode *, uintptr_t, 4> actionToNode;
-       bool checkReachable(CycleNode *from, CycleNode *to);
+#if SUPPORT_MOD_ORDER_DUMP
+       std::vector<CycleNode *> nodeList;
+#endif
+
+       bool checkReachable(const CycleNode *from, const CycleNode *to) const;
+
+       /** @brief A flag: true if this graph contains cycles */
        bool hasCycles;
+       bool oldCycles;
+
+       std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > rollbackvector;
+       std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > rmwrollbackvector;
 };
 
+/**
+ * @brief A node within a CycleGraph; corresponds either to one ModelAction or
+ * to a promised future value
+ */
 class CycleNode {
  public:
-       CycleNode(const ModelAction *action);
-       void addEdge(CycleNode * node);
-       std::vector<CycleNode *> * getEdges();
+       CycleNode(const ModelAction *act);
+       CycleNode(const Promise *promise);
+       bool addEdge(CycleNode *node);
+       CycleNode * getEdge(unsigned int i) const;
+       unsigned int getNumEdges() const;
+       CycleNode * getBackEdge(unsigned int i) const;
+       unsigned int getNumBackEdges() const;
+       bool setRMW(CycleNode *);
+       CycleNode * getRMW() const;
+       void clearRMW() { hasRMW = NULL; }
+       const ModelAction * getAction() const { return action; }
 
+       void popEdge() {
+               edges.pop_back();
+       }
+
+       bool is_promise() const { return !action; }
+
+       SNAPSHOTALLOC
  private:
+       /** @brief The ModelAction that this node represents */
        const ModelAction *action;
-       std::vector<CycleNode *> edges;
+
+       /** @brief The promise represented by this node; only valid when action
+        * is NULL */
+       const Promise *promise;
+
+       /** @brief The edges leading out from this node */
+       std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > edges;
+
+       /** @brief The edges leading into this node */
+       std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > back_edges;
+
+       /** Pointer to a RMW node that reads from this node, or NULL, if none
+        * exists */
+       CycleNode *hasRMW;
 };
 
-#endif
+#endif /* __CYCLEGRAPH_H__ */