cyclegraph: expand template usage

[c11tester.git] / cyclegraph.h

diff --git a/cyclegraph.h b/cyclegraph.h
index 818a3e88f3afca519cbff27e8d4310f485e130ff..bb2ab2d87b4370065ff64fa9dfcac45e86f2ce39 100644 (file)
--- a/cyclegraph.h
+++ b/cyclegraph.h
@@ -1,38 +1,132 @@
-#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 "action.h"
 #include <vector>
 #include <inttypes.h>
+#include "config.h"
+#include "mymemory.h"
 
+class Promise;
 class CycleNode;
+class ModelAction;
+
+typedef std::vector< const Promise *, ModelAlloc<const Promise *> > promise_list_t;
 
 /** @brief A graph of Model Actions for tracking cycles. */
 class CycleGraph {
  public:
        CycleGraph();
-       void addEdge(ModelAction *from, ModelAction *to);
-       bool checkForCycles();
+       ~CycleGraph();
+
+       template <typename T, typename U>
+       bool addEdge(const T *from, const U *to);
+
+       template <typename T>
+       void addRMWEdge(const T *from, const ModelAction *rmw);
+
+       bool checkForCycles() const;
+       bool checkPromise(const ModelAction *from, Promise *p) const;
+
+       template <typename T, typename U>
+       bool checkReachable(const T *from, const U *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
+
+       bool resolvePromise(ModelAction *reader, ModelAction *writer,
+                       promise_list_t *mustResolve);
+
+       SNAPSHOTALLOC
  private:
-       CycleNode * getNode(ModelAction *);
-       HashTable<class ModelAction *, class CycleNode *, uintptr_t, 4> actionToNode;
-       bool checkReachable(CycleNode *from, CycleNode *to);
-       
+       bool addNodeEdge(CycleNode *fromnode, CycleNode *tonode);
+       void putNode(const ModelAction *act, CycleNode *node);
+       void putNode(const Promise *promise, CycleNode *node);
+       void erasePromiseNode(const Promise *promise);
+       CycleNode * getNode(const ModelAction *act);
+       CycleNode * getNode(const Promise *promise);
+       CycleNode * getNode_noCreate(const ModelAction *act) const;
+       CycleNode * getNode_noCreate(const Promise *promise) const;
+       bool mergeNodes(CycleNode *node1, CycleNode *node2,
+                       promise_list_t *mustMerge);
+
+       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;
+       /** @brief A table for mapping reader ModelActions to Promise
+        *  CycleNodes */
+       HashTable<const ModelAction *, CycleNode *, uintptr_t, 4> readerToPromiseNode;
+
+#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(ModelAction *action);
-       void addEdge(CycleNode * node);
-       std::vector<class 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;
+       CycleNode * removeEdge();
+       CycleNode * removeBackEdge();
+
+       bool setRMW(CycleNode *);
+       CycleNode * getRMW() const;
+       void clearRMW() { hasRMW = NULL; }
+       const ModelAction * getAction() const { return action; }
+       const Promise * getPromise() const { return promise; }
+       bool is_promise() const { return !action; }
+       void resolvePromise(const ModelAction *writer);
 
+       SNAPSHOTALLOC
  private:
-       ModelAction *action;
-       std::vector<class CycleNode *> edges;
+       /** @brief The ModelAction that this node represents */
+       const ModelAction *action;
+
+       /** @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__ */