cyclegraph.h

   1 /**
   2  * @file cyclegraph.h
   3  * @brief Data structure to track ordering constraints on modification order
   4  *
   5  * Used to determine whether a total order exists that satisfies the ordering
   6  * constraints.
   7  */
   8
   9 #ifndef __CYCLEGRAPH_H__
  10 #define __CYCLEGRAPH_H__
  11
  12 #include "hashtable.h"
  13 #include <vector>
  14 #include <inttypes.h>
  15 #include "config.h"
  16 #include "mymemory.h"
  17
  18 class Promise;
  19 class CycleNode;
  20 class ModelAction;
  21
  22 typedef std::vector< const Promise *, ModelAlloc<const Promise *> > promise_list_t;
  23
  24 /** @brief A graph of Model Actions for tracking cycles. */
  25 class CycleGraph {
  26  public:
  27         CycleGraph();
  28         ~CycleGraph();
  29
  30         template <typename T, typename U>
  31         void addEdge(const T from, const U to);
  32
  33         bool checkForCycles() const;
  34         void addRMWEdge(const ModelAction *from, const ModelAction *rmw);
  35         bool checkPromise(const ModelAction *from, Promise *p) const;
  36
  37         template <typename T>
  38         bool checkReachable(const ModelAction *from, const T *to) const;
  39
  40         void startChanges();
  41         void commitChanges();
  42         void rollbackChanges();
  43 #if SUPPORT_MOD_ORDER_DUMP
  44         void dumpNodes(FILE *file) const;
  45         void dumpGraphToFile(const char *filename) const;
  46 #endif
  47
  48         bool resolvePromise(ModelAction *reader, ModelAction *writer,
  49                         promise_list_t *mustResolve);
  50
  51         SNAPSHOTALLOC
  52  private:
  53         void addNodeEdge(CycleNode *fromnode, CycleNode *tonode);
  54         void putNode(const ModelAction *act, CycleNode *node);
  55         CycleNode * getNode(const ModelAction *);
  56         CycleNode * getNode(const Promise *promise);
  57         bool mergeNodes(CycleNode *node1, CycleNode *node2,
  58                         promise_list_t *mustMerge);
  59
  60         HashTable<const CycleNode *, const CycleNode *, uintptr_t, 4, model_malloc, model_calloc, model_free> *discovered;
  61
  62         /** @brief A table for mapping ModelActions to CycleNodes */
  63         HashTable<const ModelAction *, CycleNode *, uintptr_t, 4> actionToNode;
  64         /** @brief A table for mapping reader ModelActions to Promise
  65          *  CycleNodes */
  66         HashTable<const ModelAction *, CycleNode *, uintptr_t, 4> readerToPromiseNode;
  67
  68 #if SUPPORT_MOD_ORDER_DUMP
  69         std::vector<CycleNode *> nodeList;
  70 #endif
  71
  72         bool checkReachable(const CycleNode *from, const CycleNode *to) const;
  73
  74         /** @brief A flag: true if this graph contains cycles */
  75         bool hasCycles;
  76         bool oldCycles;
  77
  78         std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > rollbackvector;
  79         std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > rmwrollbackvector;
  80 };
  81
  82 /**
  83  * @brief A node within a CycleGraph; corresponds either to one ModelAction or
  84  * to a promised future value
  85  */
  86 class CycleNode {
  87  public:
  88         CycleNode(const ModelAction *act);
  89         CycleNode(const Promise *promise);
  90         bool addEdge(CycleNode *node);
  91         CycleNode * getEdge(unsigned int i) const;
  92         unsigned int getNumEdges() const;
  93         CycleNode * getBackEdge(unsigned int i) const;
  94         unsigned int getNumBackEdges() const;
  95         CycleNode * removeEdge();
  96         CycleNode * removeBackEdge();
  97
  98         bool setRMW(CycleNode *);
  99         CycleNode * getRMW() const;
 100         void clearRMW() { hasRMW = NULL; }
 101         const ModelAction * getAction() const { return action; }
 102         const Promise * getPromise() const { return promise; }
 103
 104         void popEdge() {
 105                 edges.pop_back();
 106         }
 107
 108         bool is_promise() const { return !action; }
 109         void resolvePromise(const ModelAction *writer);
 110
 111         SNAPSHOTALLOC
 112  private:
 113         /** @brief The ModelAction that this node represents */
 114         const ModelAction *action;
 115
 116         /** @brief The promise represented by this node; only valid when action
 117          * is NULL */
 118         const Promise *promise;
 119
 120         /** @brief The edges leading out from this node */
 121         std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > edges;
 122
 123         /** @brief The edges leading into this node */
 124         std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > back_edges;
 125
 126         /** Pointer to a RMW node that reads from this node, or NULL, if none
 127          * exists */
 128         CycleNode *hasRMW;
 129 };
 130
 131 #endif /* __CYCLEGRAPH_H__ */