+/**
+ * @brief Returns a CycleNode corresponding to a promise
+ *
+ * Gets (or creates, if none exist) a CycleNode corresponding to a promised
+ * value.
+ *
+ * @param promise The Promise generated by a reader
+ * @return The CycleNode corresponding to the Promise
+ */
+CycleNode * CycleGraph::getNode(const Promise *promise)
+{
+ CycleNode *node = getNode_noCreate(promise);
+ if (node == NULL) {
+ node = new CycleNode(promise);
+ putNode(promise, node);
+ }
+ return node;
+}
+
+/**
+ * Resolve/satisfy a Promise with a particular store ModelAction, taking care
+ * of the CycleGraph cleanups, including merging any necessary CycleNodes.
+ *
+ * @param promise The Promise to resolve
+ * @param writer The store that will resolve this Promise
+ * @return false if the resolution results in a cycle (or fails in some other
+ * way); true otherwise
+ */
+bool CycleGraph::resolvePromise(const Promise *promise, ModelAction *writer)
+{
+ CycleNode *promise_node = promiseToNode.get(promise);
+ CycleNode *w_node = actionToNode.get(writer);
+ ASSERT(promise_node);
+
+ if (w_node)
+ return mergeNodes(w_node, promise_node);
+ /* No existing write-node; just convert the promise-node */
+ promise_node->resolvePromise(writer);
+ erasePromiseNode(promise_node->getPromise());
+ putNode(writer, promise_node);
+ return true;
+}
+
+/**
+ * @brief Merge two CycleNodes that represent the same write
+ *
+ * Note that this operation cannot be rolled back.
+ *
+ * @param w_node The write ModelAction node with which to merge
+ * @param p_node The Promise node to merge. Will be destroyed after this
+ * function.
+ *
+ * @return false if the merge cannot succeed; true otherwise
+ */
+bool CycleGraph::mergeNodes(CycleNode *w_node, CycleNode *p_node)
+{
+ ASSERT(!w_node->is_promise());
+ ASSERT(p_node->is_promise());
+
+ const Promise *promise = p_node->getPromise();
+ if (!promise->is_compatible(w_node->getAction()) ||
+ !promise->same_value(w_node->getAction()))
+ return false;
+
+ /* Transfer the RMW */
+ CycleNode *promise_rmw = p_node->getRMW();
+ if (promise_rmw && promise_rmw != w_node->getRMW() && w_node->setRMW(promise_rmw))
+ return false;
+
+ /* Transfer back edges to w_node */
+ while (p_node->getNumBackEdges() > 0) {
+ CycleNode *back = p_node->removeBackEdge();
+ if (back == w_node)
+ continue;
+ addNodeEdge(back, w_node);
+ if (hasCycles)
+ return false;
+ }
+
+ /* Transfer forward edges to w_node */
+ while (p_node->getNumEdges() > 0) {
+ CycleNode *forward = p_node->removeEdge();
+ if (forward == w_node)
+ continue;
+ addNodeEdge(w_node, forward);
+ if (hasCycles)
+ return false;
+ }
+
+ erasePromiseNode(promise);
+ /* Not deleting p_node, to maintain consistency if mergeNodes() fails */
+
+ return !hasCycles;
+}
+
+/**
+ * Adds an edge between two CycleNodes.
+ * @param fromnode The edge comes from this CycleNode
+ * @param tonode The edge points to this CycleNode
+ * @return True, if new edge(s) are added; otherwise false
+ */
+bool CycleGraph::addNodeEdge(CycleNode *fromnode, CycleNode *tonode)
+{
+ if (fromnode->addEdge(tonode)) {
+ rollbackvector.push_back(fromnode);
+ if (!hasCycles)
+ hasCycles = checkReachable(tonode, fromnode);
+ } else
+ return false; /* No new edge */
+
+ /*
+ * If the fromnode has a rmwnode that is not the tonode, we should
+ * follow its RMW chain to add an edge at the end, unless we encounter
+ * tonode along the way
+ */
+ CycleNode *rmwnode = fromnode->getRMW();
+ if (rmwnode) {
+ while (rmwnode != tonode && rmwnode->getRMW())
+ rmwnode = rmwnode->getRMW();
+
+ if (rmwnode != tonode) {
+ if (rmwnode->addEdge(tonode)) {
+ if (!hasCycles)
+ hasCycles = checkReachable(tonode, rmwnode);
+
+ rollbackvector.push_back(rmwnode);
+ }
+ }
+ }
+ return true;
+}
+
+/**
+ * @brief Add an edge between a write and the RMW which reads from it
+ *
+ * Handles special case of a RMW action, where the ModelAction rmw reads from
+ * the ModelAction/Promise from. The key differences are:
+ * -# No write can occur in between the @a rmw and @a from actions.
+ * -# Only one RMW action can read from a given write.
+ *
+ * @param from The edge comes from this ModelAction/Promise
+ * @param rmw The edge points to this ModelAction; this action must read from
+ * the ModelAction/Promise from
+ */
+template <typename T>
+void CycleGraph::addRMWEdge(const T *from, const ModelAction *rmw)
+{
+ ASSERT(from);
+ ASSERT(rmw);
+
+ CycleNode *fromnode = getNode(from);
+ CycleNode *rmwnode = getNode(rmw);
+
+ /* We assume that this RMW has no RMW reading from it yet */
+ ASSERT(!rmwnode->getRMW());
+
+ /* Two RMW actions cannot read from the same write. */
+ if (fromnode->setRMW(rmwnode))
+ hasCycles = true;
+ else
+ rmwrollbackvector.push_back(fromnode);
+
+ /* Transfer all outgoing edges from the from node to the rmw node */
+ /* This process should not add a cycle because either:
+ * (1) The rmw should not have any incoming edges yet if it is the
+ * new node or
+ * (2) the fromnode is the new node and therefore it should not
+ * have any outgoing edges.
+ */
+ for (unsigned int i = 0; i < fromnode->getNumEdges(); i++) {
+ CycleNode *tonode = fromnode->getEdge(i);
+ if (tonode != rmwnode) {
+ if (rmwnode->addEdge(tonode))
+ rollbackvector.push_back(rmwnode);
+ }
+ }
+
+ addNodeEdge(fromnode, rmwnode);
+}
+/* Instantiate two forms of CycleGraph::addRMWEdge */
+template void CycleGraph::addRMWEdge(const ModelAction *from, const ModelAction *rmw);
+template void CycleGraph::addRMWEdge(const Promise *from, const ModelAction *rmw);
+
+/**
+ * @brief Adds an edge between objects
+ *
+ * This function will add an edge between any two objects which can be
+ * associated with a CycleNode. That is, if they have a CycleGraph::getNode
+ * implementation.
+ *
+ * The object to is ordered after the object from.
+ *
+ * @param to The edge points to this object, of type T
+ * @param from The edge comes from this object, of type U
+ * @return True, if new edge(s) are added; otherwise false
+ */
+template <typename T, typename U>
+bool CycleGraph::addEdge(const T *from, const U *to)
+{
+ ASSERT(from);
+ ASSERT(to);
+
+ CycleNode *fromnode = getNode(from);
+ CycleNode *tonode = getNode(to);
+
+ return addNodeEdge(fromnode, tonode);
+}
+/* Instantiate four forms of CycleGraph::addEdge */
+template bool CycleGraph::addEdge(const ModelAction *from, const ModelAction *to);
+template bool CycleGraph::addEdge(const ModelAction *from, const Promise *to);
+template bool CycleGraph::addEdge(const Promise *from, const ModelAction *to);
+template bool CycleGraph::addEdge(const Promise *from, const Promise *to);
+
+#if SUPPORT_MOD_ORDER_DUMP
+
+static void print_node(FILE *file, const CycleNode *node, int label)
+{
+ if (node->is_promise()) {
+ const Promise *promise = node->getPromise();
+ int idx = promise->get_index();
+ fprintf(file, "P%u", idx);
+ if (label) {
+ int first = 1;
+ fprintf(file, " [label=\"P%d, T", idx);
+ for (unsigned int i = 0 ; i < promise->max_available_thread_idx(); i++)
+ if (promise->thread_is_available(int_to_id(i))) {
+ fprintf(file, "%s%u", first ? "": ",", i);
+ first = 0;
+ }
+ fprintf(file, "\"]");
+ }
+ } else {
+ const ModelAction *act = node->getAction();
+ modelclock_t idx = act->get_seq_number();
+ fprintf(file, "N%u", idx);
+ if (label)
+ fprintf(file, " [label=\"N%u, T%u\"]", idx, act->get_tid());
+ }
+}
+
+static void print_edge(FILE *file, const CycleNode *from, const CycleNode *to, const char *prop)
+{
+ print_node(file, from, 0);
+ fprintf(file, " -> ");
+ print_node(file, to, 0);
+ if (prop && strlen(prop))
+ fprintf(file, " [%s]", prop);
+ fprintf(file, ";\n");
+}
+
+void CycleGraph::dot_print_node(FILE *file, const ModelAction *act)
+{
+ print_node(file, getNode(act), 1);
+}
+
+template <typename T, typename U>
+void CycleGraph::dot_print_edge(FILE *file, const T *from, const U *to, const char *prop)
+{
+ CycleNode *fromnode = getNode(from);
+ CycleNode *tonode = getNode(to);
+
+ print_edge(file, fromnode, tonode, prop);
+}
+/* Instantiate two forms of CycleGraph::dot_print_edge */
+template void CycleGraph::dot_print_edge(FILE *file, const Promise *from, const ModelAction *to, const char *prop);
+template void CycleGraph::dot_print_edge(FILE *file, const ModelAction *from, const ModelAction *to, const char *prop);
+
+void CycleGraph::dumpNodes(FILE *file) const
+{
+ for (unsigned int i = 0; i < nodeList.size(); i++) {
+ CycleNode *n = nodeList[i];
+ print_node(file, n, 1);
+ fprintf(file, ";\n");
+ if (n->getRMW())
+ print_edge(file, n, n->getRMW(), "style=dotted");
+ for (unsigned int j = 0; j < n->getNumEdges(); j++)
+ print_edge(file, n, n->getEdge(j), NULL);