1 #include "cyclegraph.h"
4 #include "threads-model.h"
5 #include "clockvector.h"
7 /** Initializes a CycleGraph object. */
8 CycleGraph::CycleGraph() :
9 queue(new SnapVector<const CycleNode *>())
13 /** CycleGraph destructor */
14 CycleGraph::~CycleGraph()
20 * Add a CycleNode to the graph, corresponding to a store ModelAction
21 * @param act The write action that should be added
22 * @param node The CycleNode that corresponds to the store
24 void CycleGraph::putNode(const ModelAction *act, CycleNode *node)
26 actionToNode.put(act, node);
27 #if SUPPORT_MOD_ORDER_DUMP
28 nodeList.push_back(node);
32 /** @return The corresponding CycleNode, if exists; otherwise NULL */
33 CycleNode * CycleGraph::getNode_noCreate(const ModelAction *act) const
35 return actionToNode.get(act);
39 * @brief Returns the CycleNode corresponding to a given ModelAction
41 * Gets (or creates, if none exist) a CycleNode corresponding to a ModelAction
43 * @param action The ModelAction to find a node for
44 * @return The CycleNode paired with this action
46 CycleNode * CycleGraph::getNode(ModelAction *action)
48 CycleNode *node = getNode_noCreate(action);
50 node = new CycleNode(action);
51 putNode(action, node);
57 * Adds an edge between two CycleNodes.
58 * @param fromnode The edge comes from this CycleNode
59 * @param tonode The edge points to this CycleNode
60 * @return True, if new edge(s) are added; otherwise false
62 void CycleGraph::addNodeEdge(CycleNode *fromnode, CycleNode *tonode, bool forceedge)
64 //quick check whether edge is redundant
65 if (checkReachable(fromnode, tonode) && !forceedge) {
70 * If the fromnode has a rmwnode, we should
71 * follow its RMW chain to add an edge at the end.
73 while (CycleNode * nextnode = fromnode->getRMW()) {
74 if (nextnode == tonode)
79 fromnode->addEdge(tonode); //Add edge to edgeSrcNode
81 /* Propagate clock vector changes */
82 if (tonode->cv->merge(fromnode->cv)) {
83 queue->push_back(tonode);
84 while(!queue->empty()) {
85 const CycleNode *node = queue->back();
87 unsigned int numedges = node->getNumEdges();
88 for(unsigned int i = 0;i < numedges;i++) {
89 CycleNode * enode = node->getEdge(i);
90 if (enode->cv->merge(node->cv))
91 queue->push_back(enode);
98 * @brief Add an edge between a write and the RMW which reads from it
100 * Handles special case of a RMW action, where the ModelAction rmw reads from
101 * the ModelAction from. The key differences are:
102 * -# No write can occur in between the @a rmw and @a from actions.
103 * -# Only one RMW action can read from a given write.
105 * @param from The edge comes from this ModelAction
106 * @param rmw The edge points to this ModelAction; this action must read from
107 * the ModelAction from
109 void CycleGraph::addRMWEdge(ModelAction *from, ModelAction *rmw)
114 CycleNode *fromnode = getNode(from);
115 CycleNode *rmwnode = getNode(rmw);
116 /* We assume that this RMW has no RMW reading from it yet */
117 ASSERT(!rmwnode->getRMW());
119 fromnode->setRMW(rmwnode);
121 /* Transfer all outgoing edges from the from node to the rmw node */
122 /* This process should not add a cycle because either:
123 * (1) The rmw should not have any incoming edges yet if it is the
125 * (2) the fromnode is the new node and therefore it should not
126 * have any outgoing edges.
128 for (unsigned int i = 0;i < fromnode->getNumEdges();i++) {
129 CycleNode *tonode = fromnode->getEdge(i);
130 if (tonode != rmwnode) {
131 rmwnode->addEdge(tonode);
133 tonode->removeInEdge(fromnode);
135 fromnode->edges.clear();
137 addNodeEdge(fromnode, rmwnode, true);
140 void CycleGraph::addEdges(SnapList<ModelAction *> * edgeset, ModelAction *to) {
141 for(sllnode<ModelAction*> * it = edgeset->begin();it!=NULL;) {
142 ModelAction *act = it->getVal();
143 CycleNode *node = getNode(act);
144 sllnode<ModelAction*> * it2 = it;
147 ModelAction *act2 = it2->getVal();
148 CycleNode *node2 = getNode(act2);
149 if (checkReachable(node, node2)) {
150 it = edgeset->erase(it);
152 } else if (checkReachable(node2, node)) {
153 it2 = edgeset->erase(it2);
164 for(sllnode<ModelAction*> *it = edgeset->begin();it!=NULL;it=it->getNext()) {
165 ModelAction *from = it->getVal();
166 addEdge(from, to, from->get_tid() == to->get_tid());
171 * @brief Adds an edge between objects
173 * This function will add an edge between any two objects which can be
174 * associated with a CycleNode. That is, if they have a CycleGraph::getNode
177 * The object to is ordered after the object from.
179 * @param to The edge points to this object, of type T
180 * @param from The edge comes from this object, of type U
181 * @return True, if new edge(s) are added; otherwise false
184 void CycleGraph::addEdge(ModelAction *from, ModelAction *to)
189 CycleNode *fromnode = getNode(from);
190 CycleNode *tonode = getNode(to);
192 addNodeEdge(fromnode, tonode, false);
195 void CycleGraph::addEdge(ModelAction *from, ModelAction *to, bool forceedge)
200 CycleNode *fromnode = getNode(from);
201 CycleNode *tonode = getNode(to);
203 addNodeEdge(fromnode, tonode, forceedge);
206 #if SUPPORT_MOD_ORDER_DUMP
208 static void print_node(FILE *file, const CycleNode *node, int label)
210 const ModelAction *act = node->getAction();
211 modelclock_t idx = act->get_seq_number();
212 fprintf(file, "N%u", idx);
214 fprintf(file, " [label=\"N%u, T%u\"]", idx, act->get_tid());
217 static void print_edge(FILE *file, const CycleNode *from, const CycleNode *to, const char *prop)
219 print_node(file, from, 0);
220 fprintf(file, " -> ");
221 print_node(file, to, 0);
222 if (prop && strlen(prop))
223 fprintf(file, " [%s]", prop);
224 fprintf(file, ";\n");
227 void CycleGraph::dot_print_node(FILE *file, const ModelAction *act)
229 print_node(file, getNode(act), 1);
232 void CycleGraph::dot_print_edge(FILE *file, const ModelAction *from, const ModelAction *to, const char *prop)
234 CycleNode *fromnode = getNode(from);
235 CycleNode *tonode = getNode(to);
237 print_edge(file, fromnode, tonode, prop);
240 void CycleGraph::dumpNodes(FILE *file) const
242 for (unsigned int i = 0;i < nodeList.size();i++) {
243 CycleNode *n = nodeList[i];
244 print_node(file, n, 1);
245 fprintf(file, ";\n");
247 print_edge(file, n, n->getRMW(), "style=dotted");
248 for (unsigned int j = 0;j < n->getNumEdges();j++)
249 print_edge(file, n, n->getEdge(j), NULL);
253 void CycleGraph::dumpGraphToFile(const char *filename) const
256 sprintf(buffer, "%s.dot", filename);
257 FILE *file = fopen(buffer, "w");
258 fprintf(file, "digraph %s {\n", filename);
260 fprintf(file, "}\n");
266 * Checks whether one CycleNode can reach another.
267 * @param from The CycleNode from which to begin exploration
268 * @param to The CycleNode to reach
269 * @return True, @a from can reach @a to; otherwise, false
271 bool CycleGraph::checkReachable(const CycleNode *from, const CycleNode *to) const
273 return to->cv->synchronized_since(from->action);
277 * Checks whether one ModelAction can reach another ModelAction
278 * @param from The ModelAction from which to begin exploration
279 * @param to The ModelAction to reach
280 * @return True, @a from can reach @a to; otherwise, false
282 bool CycleGraph::checkReachable(const ModelAction *from, const ModelAction *to) const
284 CycleNode *fromnode = getNode_noCreate(from);
285 CycleNode *tonode = getNode_noCreate(to);
287 if (!fromnode || !tonode)
290 return checkReachable(fromnode, tonode);
293 void CycleGraph::freeAction(const ModelAction * act) {
294 CycleNode *cn = actionToNode.remove(act);
295 for(unsigned int i=0;i<cn->edges.size();i++) {
296 CycleNode *dst = cn->edges[i];
297 dst->removeInEdge(cn);
299 for(unsigned int i=0;i<cn->inedges.size();i++) {
300 CycleNode *src = cn->inedges[i];
307 * @brief Constructor for a CycleNode
308 * @param act The ModelAction for this node
310 CycleNode::CycleNode(ModelAction *act) :
313 cv(new ClockVector(NULL, act))
317 CycleNode::~CycleNode() {
321 void CycleNode::removeInEdge(CycleNode *src) {
322 for(unsigned int i=0;i < inedges.size();i++) {
323 if (inedges[i] == src) {
324 inedges[i] = inedges[inedges.size()-1];
331 void CycleNode::removeEdge(CycleNode *dst) {
332 for(unsigned int i=0;i < edges.size();i++) {
333 if (edges[i] == dst) {
334 edges[i] = edges[edges.size()-1];
342 * @param i The index of the edge to return
343 * @returns The CycleNode edge indexed by i
345 CycleNode * CycleNode::getEdge(unsigned int i) const
350 /** @returns The number of edges leaving this CycleNode */
351 unsigned int CycleNode::getNumEdges() const
357 * @param i The index of the edge to return
358 * @returns The CycleNode edge indexed by i
360 CycleNode * CycleNode::getInEdge(unsigned int i) const
365 /** @returns The number of edges leaving this CycleNode */
366 unsigned int CycleNode::getNumInEdges() const
368 return inedges.size();
372 * Adds an edge from this CycleNode to another CycleNode.
373 * @param node The node to which we add a directed edge
374 * @return True if this edge is a new edge; false otherwise
376 void CycleNode::addEdge(CycleNode *node)
378 for (unsigned int i = 0;i < edges.size();i++)
379 if (edges[i] == node)
381 edges.push_back(node);
382 node->inedges.push_back(this);
385 /** @returns the RMW CycleNode that reads from the current CycleNode */
386 CycleNode * CycleNode::getRMW() const
392 * Set a RMW action node that reads from the current CycleNode.
393 * @param node The RMW that reads from the current node
394 * @return True, if this node already was read by another RMW; false otherwise
395 * @see CycleGraph::addRMWEdge
397 bool CycleNode::setRMW(CycleNode *node)