model: improve some promise-related comments
[model-checker.git] / cyclegraph.h
1 /** @file cyclegraph.h @brief Data structure to track ordering
2  *  constraints on modification order.  The idea is to see whether a
3  *  total order exists that satisfies the ordering constriants.*/
4
5 #ifndef CYCLEGRAPH_H
6 #define CYCLEGRAPH_H
7
8 #include "hashtable.h"
9 #include <vector>
10 #include <inttypes.h>
11
12 class CycleNode;
13 class ModelAction;
14
15 /** @brief A graph of Model Actions for tracking cycles. */
16 class CycleGraph {
17  public:
18         CycleGraph();
19         ~CycleGraph();
20         void addEdge(const ModelAction *from, const ModelAction *to);
21         bool checkForCycles();
22         void addRMWEdge(const ModelAction *from, const ModelAction *rmw);
23
24         bool checkReachable(const ModelAction *from, const ModelAction *to);
25
26  private:
27         CycleNode * getNode(const ModelAction *);
28
29         /** @brief A table for mapping ModelActions to CycleNodes */
30         HashTable<const ModelAction *, CycleNode *, uintptr_t, 4> actionToNode;
31
32         bool checkReachable(CycleNode *from, CycleNode *to);
33
34         /** @brief A flag: true if this graph contains cycles */
35         bool hasCycles;
36 };
37
38 /** @brief A node within a CycleGraph; corresponds to one ModelAction */
39 class CycleNode {
40  public:
41         CycleNode(const ModelAction *action);
42         void addEdge(CycleNode * node);
43         std::vector<CycleNode *> * getEdges();
44         bool setRMW(CycleNode *);
45         CycleNode* getRMW();
46
47  private:
48         /** @brief The ModelAction that this node represents */
49         const ModelAction *action;
50
51         /** @brief The edges leading out from this node */
52         std::vector<CycleNode *> edges;
53
54         /** Pointer to a RMW node that reads from this node, or NULL, if none
55          * exists */
56         CycleNode * hasRMW;
57 };
58
59 #endif