1 #include "cyclegraph.h"
6 #include "threads-model.h"
8 /** Initializes a CycleGraph object. */
9 CycleGraph::CycleGraph() :
10 discovered(new HashTable<const CycleNode *, const CycleNode *, uintptr_t, 4, model_malloc, model_calloc, model_free>(16)),
16 /** CycleGraph destructor */
17 CycleGraph::~CycleGraph()
23 * Add a CycleNode to the graph, corresponding to a store ModelAction
24 * @param act The write action that should be added
25 * @param node The CycleNode that corresponds to the store
27 void CycleGraph::putNode(const ModelAction *act, CycleNode *node)
29 actionToNode.put(act, node);
30 #if SUPPORT_MOD_ORDER_DUMP
31 nodeList.push_back(node);
36 * Add a CycleNode to the graph, corresponding to a Promise
37 * @param promise The Promise that should be added
38 * @param node The CycleNode that corresponds to the Promise
40 void CycleGraph::putNode(const Promise *promise, CycleNode *node)
42 promiseToNode.put(promise, node);
43 #if SUPPORT_MOD_ORDER_DUMP
44 nodeList.push_back(node);
49 * @brief Remove the Promise node from the graph
50 * @param promise The promise to remove from the graph
52 void CycleGraph::erasePromiseNode(const Promise *promise)
54 promiseToNode.put(promise, NULL);
55 #if SUPPORT_MOD_ORDER_DUMP
56 /* Remove the promise node from nodeList */
57 CycleNode *node = getNode_noCreate(promise);
58 for (unsigned int i = 0; i < nodeList.size(); )
59 if (nodeList[i] == node)
60 nodeList.erase(nodeList.begin() + i);
66 /** @return The corresponding CycleNode, if exists; otherwise NULL */
67 CycleNode * CycleGraph::getNode_noCreate(const ModelAction *act) const
69 return actionToNode.get(act);
72 /** @return The corresponding CycleNode, if exists; otherwise NULL */
73 CycleNode * CycleGraph::getNode_noCreate(const Promise *promise) const
75 return promiseToNode.get(promise);
79 * @brief Returns the CycleNode corresponding to a given ModelAction
81 * Gets (or creates, if none exist) a CycleNode corresponding to a ModelAction
83 * @param action The ModelAction to find a node for
84 * @return The CycleNode paired with this action
86 CycleNode * CycleGraph::getNode(const ModelAction *action)
88 CycleNode *node = getNode_noCreate(action);
90 node = new CycleNode(action);
91 putNode(action, node);
97 * @brief Returns a CycleNode corresponding to a promise
99 * Gets (or creates, if none exist) a CycleNode corresponding to a promised
102 * @param promise The Promise generated by a reader
103 * @return The CycleNode corresponding to the Promise
105 CycleNode * CycleGraph::getNode(const Promise *promise)
107 CycleNode *node = getNode_noCreate(promise);
109 node = new CycleNode(promise);
110 putNode(promise, node);
116 * @return false if the resolution results in a cycle; true otherwise
118 bool CycleGraph::resolvePromise(const Promise *promise, ModelAction *writer,
119 promise_list_t *mustResolve)
121 CycleNode *promise_node = promiseToNode.get(promise);
122 CycleNode *w_node = actionToNode.get(writer);
123 ASSERT(promise_node);
126 return mergeNodes(w_node, promise_node, mustResolve);
127 /* No existing write-node; just convert the promise-node */
128 promise_node->resolvePromise(writer);
129 erasePromiseNode(promise_node->getPromise());
130 putNode(writer, promise_node);
135 * @brief Merge two CycleNodes that represent the same write
137 * Note that this operation cannot be rolled back.
139 * @param w_node The write ModelAction node with which to merge
140 * @param p_node The Promise node to merge. Will be destroyed after this
142 * @param mustMerge Return (pass-by-reference) any additional Promises that
143 * must also be merged with w_node
145 * @return false if the merge results in a cycle; true otherwise
147 bool CycleGraph::mergeNodes(CycleNode *w_node, CycleNode *p_node,
148 promise_list_t *mustMerge)
150 ASSERT(!w_node->is_promise());
151 ASSERT(p_node->is_promise());
153 const Promise *promise = p_node->getPromise();
154 if (!promise->is_compatible(w_node->getAction())) {
159 /* Transfer the RMW */
160 CycleNode *promise_rmw = p_node->getRMW();
161 if (promise_rmw && promise_rmw != w_node->getRMW() && w_node->setRMW(promise_rmw)) {
166 /* Transfer back edges to w_node */
167 while (p_node->getNumBackEdges() > 0) {
168 CycleNode *back = p_node->removeBackEdge();
171 if (back->is_promise()) {
172 if (checkReachable(w_node, back)) {
173 /* Edge would create cycle; merge instead */
174 mustMerge->push_back(back->getPromise());
175 if (!mergeNodes(w_node, back, mustMerge))
178 back->addEdge(w_node);
180 addNodeEdge(back, w_node);
183 /* Transfer forward edges to w_node */
184 while (p_node->getNumEdges() > 0) {
185 CycleNode *forward = p_node->removeEdge();
186 if (forward == w_node)
188 if (forward->is_promise()) {
189 if (checkReachable(forward, w_node)) {
190 mustMerge->push_back(forward->getPromise());
191 if (!mergeNodes(w_node, forward, mustMerge))
194 w_node->addEdge(forward);
196 addNodeEdge(w_node, forward);
199 erasePromiseNode(promise);
200 /* Not deleting p_node, to maintain consistency if mergeNodes() fails */
206 * Adds an edge between two CycleNodes.
207 * @param fromnode The edge comes from this CycleNode
208 * @param tonode The edge points to this CycleNode
209 * @return True, if new edge(s) are added; otherwise false
211 bool CycleGraph::addNodeEdge(CycleNode *fromnode, CycleNode *tonode)
216 hasCycles = checkReachable(tonode, fromnode);
218 if ((added = fromnode->addEdge(tonode)))
219 rollbackvector.push_back(fromnode);
222 * If the fromnode has a rmwnode that is not the tonode, we should add
223 * an edge between its rmwnode and the tonode
225 CycleNode *rmwnode = fromnode->getRMW();
226 if (rmwnode && rmwnode != tonode) {
228 hasCycles = checkReachable(tonode, rmwnode);
230 if (rmwnode->addEdge(tonode)) {
231 rollbackvector.push_back(rmwnode);
239 * @brief Add an edge between a write and the RMW which reads from it
241 * Handles special case of a RMW action, where the ModelAction rmw reads from
242 * the ModelAction/Promise from. The key differences are:
243 * (1) no write can occur in between the rmw and the from action.
244 * (2) Only one RMW action can read from a given write.
246 * @param from The edge comes from this ModelAction/Promise
247 * @param rmw The edge points to this ModelAction; this action must read from
248 * the ModelAction/Promise from
250 template <typename T>
251 void CycleGraph::addRMWEdge(const T *from, const ModelAction *rmw)
256 CycleNode *fromnode = getNode(from);
257 CycleNode *rmwnode = getNode(rmw);
259 /* Two RMW actions cannot read from the same write. */
260 if (fromnode->setRMW(rmwnode))
263 rmwrollbackvector.push_back(fromnode);
265 /* Transfer all outgoing edges from the from node to the rmw node */
266 /* This process should not add a cycle because either:
267 * (1) The rmw should not have any incoming edges yet if it is the
269 * (2) the fromnode is the new node and therefore it should not
270 * have any outgoing edges.
272 for (unsigned int i = 0; i < fromnode->getNumEdges(); i++) {
273 CycleNode *tonode = fromnode->getEdge(i);
274 if (tonode != rmwnode) {
275 if (rmwnode->addEdge(tonode))
276 rollbackvector.push_back(rmwnode);
280 addNodeEdge(fromnode, rmwnode);
282 /* Instantiate two forms of CycleGraph::addRMWEdge */
283 template void CycleGraph::addRMWEdge(const ModelAction *from, const ModelAction *rmw);
284 template void CycleGraph::addRMWEdge(const Promise *from, const ModelAction *rmw);
287 * @brief Adds an edge between objects
289 * This function will add an edge between any two objects which can be
290 * associated with a CycleNode. That is, if they have a CycleGraph::getNode
293 * The object to is ordered after the object from.
295 * @param to The edge points to this object, of type T
296 * @param from The edge comes from this object, of type U
297 * @return True, if new edge(s) are added; otherwise false
299 template <typename T, typename U>
300 bool CycleGraph::addEdge(const T *from, const U *to)
305 CycleNode *fromnode = getNode(from);
306 CycleNode *tonode = getNode(to);
308 return addNodeEdge(fromnode, tonode);
310 /* Instantiate four forms of CycleGraph::addEdge */
311 template bool CycleGraph::addEdge(const ModelAction *from, const ModelAction *to);
312 template bool CycleGraph::addEdge(const ModelAction *from, const Promise *to);
313 template bool CycleGraph::addEdge(const Promise *from, const ModelAction *to);
314 template bool CycleGraph::addEdge(const Promise *from, const Promise *to);
316 #if SUPPORT_MOD_ORDER_DUMP
318 static void print_node(FILE *file, const CycleNode *node, int label)
320 if (node->is_promise()) {
321 const Promise *promise = node->getPromise();
322 int idx = model->get_promise_number(promise);
323 fprintf(file, "P%u", idx);
326 fprintf(file, " [label=\"P%d, T", idx);
327 for (unsigned int i = 0 ; i < model->get_num_threads(); i++)
328 if (promise->thread_is_available(int_to_id(i))) {
329 fprintf(file, "%s%u", first ? "": ",", i);
332 fprintf(file, "\"]");
335 const ModelAction *act = node->getAction();
336 modelclock_t idx = act->get_seq_number();
337 fprintf(file, "N%u", idx);
339 fprintf(file, " [label=\"N%u, T%u\"]", idx, act->get_tid());
343 static void print_edge(FILE *file, const CycleNode *from, const CycleNode *to, const char *prop)
345 print_node(file, from, 0);
346 fprintf(file, " -> ");
347 print_node(file, to, 0);
348 if (prop && strlen(prop))
349 fprintf(file, " [%s]", prop);
350 fprintf(file, ";\n");
353 void CycleGraph::dot_print_node(FILE *file, const ModelAction *act)
355 print_node(file, getNode(act), 1);
358 template <typename T, typename U>
359 void CycleGraph::dot_print_edge(FILE *file, const T *from, const U *to, const char *prop)
361 CycleNode *fromnode = getNode(from);
362 CycleNode *tonode = getNode(to);
364 print_edge(file, fromnode, tonode, prop);
366 /* Instantiate two forms of CycleGraph::dot_print_edge */
367 template void CycleGraph::dot_print_edge(FILE *file, const Promise *from, const ModelAction *to, const char *prop);
368 template void CycleGraph::dot_print_edge(FILE *file, const ModelAction *from, const ModelAction *to, const char *prop);
370 void CycleGraph::dumpNodes(FILE *file) const
372 for (unsigned int i = 0; i < nodeList.size(); i++) {
373 CycleNode *n = nodeList[i];
374 print_node(file, n, 1);
375 fprintf(file, ";\n");
377 print_edge(file, n, n->getRMW(), "style=dotted");
378 for (unsigned int j = 0; j < n->getNumEdges(); j++)
379 print_edge(file, n, n->getEdge(j), NULL);
383 void CycleGraph::dumpGraphToFile(const char *filename) const
386 sprintf(buffer, "%s.dot", filename);
387 FILE *file = fopen(buffer, "w");
388 fprintf(file, "digraph %s {\n", filename);
390 fprintf(file, "}\n");
396 * Checks whether one CycleNode can reach another.
397 * @param from The CycleNode from which to begin exploration
398 * @param to The CycleNode to reach
399 * @return True, @a from can reach @a to; otherwise, false
401 bool CycleGraph::checkReachable(const CycleNode *from, const CycleNode *to) const
403 std::vector< const CycleNode *, ModelAlloc<const CycleNode *> > queue;
406 queue.push_back(from);
407 discovered->put(from, from);
408 while (!queue.empty()) {
409 const CycleNode *node = queue.back();
414 for (unsigned int i = 0; i < node->getNumEdges(); i++) {
415 CycleNode *next = node->getEdge(i);
416 if (!discovered->contains(next)) {
417 discovered->put(next, next);
418 queue.push_back(next);
426 * Checks whether one ModelAction/Promise can reach another ModelAction/Promise
427 * @param from The ModelAction or Promise from which to begin exploration
428 * @param to The ModelAction or Promise to reach
429 * @return True, @a from can reach @a to; otherwise, false
431 template <typename T, typename U>
432 bool CycleGraph::checkReachable(const T *from, const U *to) const
434 CycleNode *fromnode = getNode_noCreate(from);
435 CycleNode *tonode = getNode_noCreate(to);
437 if (!fromnode || !tonode)
440 return checkReachable(fromnode, tonode);
442 /* Instantiate three forms of CycleGraph::checkReachable */
443 template bool CycleGraph::checkReachable(const ModelAction *from,
444 const ModelAction *to) const;
445 template bool CycleGraph::checkReachable(const ModelAction *from,
446 const Promise *to) const;
447 template bool CycleGraph::checkReachable(const Promise *from,
448 const ModelAction *to) const;
450 /** @return True, if the promise has failed; false otherwise */
451 bool CycleGraph::checkPromise(const ModelAction *fromact, Promise *promise) const
453 std::vector< CycleNode *, ModelAlloc<CycleNode *> > queue;
455 CycleNode *from = actionToNode.get(fromact);
457 queue.push_back(from);
458 discovered->put(from, from);
459 while (!queue.empty()) {
460 CycleNode *node = queue.back();
463 if (node->getPromise() == promise)
465 if (!node->is_promise() &&
466 promise->eliminate_thread(node->getAction()->get_tid()))
469 for (unsigned int i = 0; i < node->getNumEdges(); i++) {
470 CycleNode *next = node->getEdge(i);
471 if (!discovered->contains(next)) {
472 discovered->put(next, next);
473 queue.push_back(next);
480 void CycleGraph::startChanges()
482 ASSERT(rollbackvector.empty());
483 ASSERT(rmwrollbackvector.empty());
484 ASSERT(oldCycles == hasCycles);
487 /** Commit changes to the cyclegraph. */
488 void CycleGraph::commitChanges()
490 rollbackvector.clear();
491 rmwrollbackvector.clear();
492 oldCycles = hasCycles;
495 /** Rollback changes to the previous commit. */
496 void CycleGraph::rollbackChanges()
498 for (unsigned int i = 0; i < rollbackvector.size(); i++)
499 rollbackvector[i]->removeEdge();
501 for (unsigned int i = 0; i < rmwrollbackvector.size(); i++)
502 rmwrollbackvector[i]->clearRMW();
504 hasCycles = oldCycles;
505 rollbackvector.clear();
506 rmwrollbackvector.clear();
509 /** @returns whether a CycleGraph contains cycles. */
510 bool CycleGraph::checkForCycles() const
516 * @brief Constructor for a CycleNode
517 * @param act The ModelAction for this node
519 CycleNode::CycleNode(const ModelAction *act) :
527 * @brief Constructor for a Promise CycleNode
528 * @param promise The Promise which was generated
530 CycleNode::CycleNode(const Promise *promise) :
538 * @param i The index of the edge to return
539 * @returns The a CycleNode edge indexed by i
541 CycleNode * CycleNode::getEdge(unsigned int i) const
546 /** @returns The number of edges leaving this CycleNode */
547 unsigned int CycleNode::getNumEdges() const
552 CycleNode * CycleNode::getBackEdge(unsigned int i) const
554 return back_edges[i];
557 unsigned int CycleNode::getNumBackEdges() const
559 return back_edges.size();
563 * @brief Remove an element from a vector
564 * @param v The vector
565 * @param n The element to remove
566 * @return True if the element was found; false otherwise
568 template <typename T>
569 static bool vector_remove_node(std::vector<T, SnapshotAlloc<T> >& v, const T n)
571 for (unsigned int i = 0; i < v.size(); i++) {
573 v.erase(v.begin() + i);
581 * @brief Remove a (forward) edge from this CycleNode
582 * @return The CycleNode which was popped, if one exists; otherwise NULL
584 CycleNode * CycleNode::removeEdge()
589 CycleNode *ret = edges.back();
591 vector_remove_node(ret->back_edges, this);
596 * @brief Remove a (back) edge from this CycleNode
597 * @return The CycleNode which was popped, if one exists; otherwise NULL
599 CycleNode * CycleNode::removeBackEdge()
601 if (back_edges.empty())
604 CycleNode *ret = back_edges.back();
605 back_edges.pop_back();
606 vector_remove_node(ret->edges, this);
611 * Adds an edge from this CycleNode to another CycleNode.
612 * @param node The node to which we add a directed edge
613 * @return True if this edge is a new edge; false otherwise
615 bool CycleNode::addEdge(CycleNode *node)
617 for (unsigned int i = 0; i < edges.size(); i++)
618 if (edges[i] == node)
620 edges.push_back(node);
621 node->back_edges.push_back(this);
625 /** @returns the RMW CycleNode that reads from the current CycleNode */
626 CycleNode * CycleNode::getRMW() const
632 * Set a RMW action node that reads from the current CycleNode.
633 * @param node The RMW that reads from the current node
634 * @return True, if this node already was read by another RMW; false otherwise
635 * @see CycleGraph::addRMWEdge
637 bool CycleNode::setRMW(CycleNode *node)
646 * Convert a Promise CycleNode into a concrete-valued CycleNode. Should only be
647 * used when there's no existing ModelAction CycleNode for this write.
649 * @param writer The ModelAction which wrote the future value represented by
652 void CycleNode::resolvePromise(const ModelAction *writer)
654 ASSERT(is_promise());
655 ASSERT(promise->is_compatible(writer));
658 ASSERT(!is_promise());