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 /** @brief A graph of Model Actions for tracking cycles. */
  23 class CycleGraph {
  24  public:
  25         CycleGraph();
  26         ~CycleGraph();
  27         void addEdge(const ModelAction *from, const ModelAction *to);
  28         bool checkForCycles() const;
  29         void addRMWEdge(const ModelAction *from, const ModelAction *rmw);
  30         bool checkPromise(const ModelAction *from, Promise *p) const;
  31         bool checkReachable(const ModelAction *from, const ModelAction *to) const;
  32         void startChanges();
  33         void commitChanges();
  34         void rollbackChanges();
  35 #if SUPPORT_MOD_ORDER_DUMP
  36         void dumpNodes(FILE *file) const;
  37         void dumpGraphToFile(const char *filename) const;
  38 #endif
  39
  40         SNAPSHOTALLOC
  41  private:
  42         void addEdge(CycleNode *fromnode, CycleNode *tonode);
  43         void putNode(const ModelAction *act, CycleNode *node);
  44         CycleNode * getNode(const ModelAction *);
  45         HashTable<const CycleNode *, const CycleNode *, uintptr_t, 4, model_malloc, model_calloc, model_free> *discovered;
  46
  47         /** @brief A table for mapping ModelActions to CycleNodes */
  48         HashTable<const ModelAction *, CycleNode *, uintptr_t, 4> actionToNode;
  49 #if SUPPORT_MOD_ORDER_DUMP
  50         std::vector<CycleNode *> nodeList;
  51 #endif
  52
  53         bool checkReachable(const CycleNode *from, const CycleNode *to) const;
  54
  55         /** @brief A flag: true if this graph contains cycles */
  56         bool hasCycles;
  57         bool oldCycles;
  58
  59         std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > rollbackvector;
  60         std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > rmwrollbackvector;
  61 };
  62
  63 /** @brief A node within a CycleGraph; corresponds to one ModelAction */
  64 class CycleNode {
  65  public:
  66         CycleNode(const ModelAction *act);
  67         bool addEdge(CycleNode *node);
  68         CycleNode * getEdge(unsigned int i) const;
  69         unsigned int getNumEdges() const;
  70         CycleNode * getBackEdge(unsigned int i) const;
  71         unsigned int getNumBackEdges() const;
  72         bool setRMW(CycleNode *);
  73         CycleNode * getRMW() const;
  74         void clearRMW() { hasRMW = NULL; }
  75         const ModelAction * getAction() const { return action; }
  76
  77         void popEdge() {
  78                 edges.pop_back();
  79         }
  80
  81         SNAPSHOTALLOC
  82  private:
  83         /** @brief The ModelAction that this node represents */
  84         const ModelAction *action;
  85
  86         /** @brief The edges leading out from this node */
  87         std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > edges;
  88
  89         /** @brief The edges leading into this node */
  90         std::vector< CycleNode *, SnapshotAlloc<CycleNode *> > back_edges;
  91
  92         /** Pointer to a RMW node that reads from this node, or NULL, if none
  93          * exists */
  94         CycleNode *hasRMW;
  95 };
  96
  97 #endif /* __CYCLEGRAPH_H__ */