cyclegraph: expand template usage
[c11tester.git] / cyclegraph.cc
index 1ff9d70b792ad685749f8fa3c038bc7de91fdb86..7fadcbda00d8b6f02f9cfe81d5cd3f423e9a3a2b 100644 (file)
@@ -31,6 +31,39 @@ void CycleGraph::putNode(const ModelAction *act, CycleNode *node)
 #endif
 }
 
+/**
+ * Add a CycleNode to the graph, corresponding to a Promise
+ * @param promise The Promise that should be added
+ * @param node The CycleNode that corresponds to the Promise
+ */
+void CycleGraph::putNode(const Promise *promise, CycleNode *node)
+{
+       const ModelAction *reader = promise->get_action();
+       readerToPromiseNode.put(reader, node);
+#if SUPPORT_MOD_ORDER_DUMP
+       nodeList.push_back(node);
+#endif
+}
+
+/**
+ * @brief Remove the Promise node from the graph
+ * @param promise The promise to remove from the graph
+ */
+void CycleGraph::erasePromiseNode(const Promise *promise)
+{
+       const ModelAction *reader = promise->get_action();
+       readerToPromiseNode.put(reader, NULL);
+#if SUPPORT_MOD_ORDER_DUMP
+       /* Remove the promise node from nodeList */
+       CycleNode *node = getNode_noCreate(promise);
+       for (unsigned int i = 0; i < nodeList.size(); )
+               if (nodeList[i] == node)
+                       nodeList.erase(nodeList.begin() + i);
+               else
+                       i++;
+#endif
+}
+
 /** @return The corresponding CycleNode, if exists; otherwise NULL */
 CycleNode * CycleGraph::getNode_noCreate(const ModelAction *act) const
 {
@@ -72,11 +105,10 @@ CycleNode * CycleGraph::getNode(const ModelAction *action)
  */
 CycleNode * CycleGraph::getNode(const Promise *promise)
 {
-       const ModelAction *reader = promise->get_action();
        CycleNode *node = getNode_noCreate(promise);
        if (node == NULL) {
                node = new CycleNode(promise);
-               readerToPromiseNode.put(reader, node);
+               putNode(promise, node);
        }
        return node;
 }
@@ -95,7 +127,7 @@ bool CycleGraph::resolvePromise(ModelAction *reader, ModelAction *writer,
                return mergeNodes(w_node, promise_node, mustResolve);
        /* No existing write-node; just convert the promise-node */
        promise_node->resolvePromise(writer);
-       readerToPromiseNode.put(reader, NULL); /* erase promise_node */
+       erasePromiseNode(promise_node->getPromise());
        putNode(writer, promise_node);
        return true;
 }
@@ -127,45 +159,46 @@ bool CycleGraph::mergeNodes(CycleNode *w_node, CycleNode *p_node,
 
        /* Transfer the RMW */
        CycleNode *promise_rmw = p_node->getRMW();
-       if (promise_rmw && promise_rmw != w_node->getRMW() && w_node->setRMW(promise_rmw))
+       if (promise_rmw && promise_rmw != w_node->getRMW() && w_node->setRMW(promise_rmw)) {
                hasCycles = true;
+               return false;
+       }
 
        /* Transfer back edges to w_node */
        while (p_node->getNumBackEdges() > 0) {
                CycleNode *back = p_node->removeBackEdge();
-               if (back != w_node) {
-                       if (back->is_promise()) {
-                               if (checkReachable(w_node, back)) {
-                                       /* Edge would create cycle; merge instead */
-                                       mustMerge->push_back(back->getPromise());
-                                       if (!mergeNodes(w_node, back, mustMerge))
-                                               return false;
-                               } else
-                                       back->addEdge(w_node);
+               if (back == w_node)
+                       continue;
+               if (back->is_promise()) {
+                       if (checkReachable(w_node, back)) {
+                               /* Edge would create cycle; merge instead */
+                               mustMerge->push_back(back->getPromise());
+                               if (!mergeNodes(w_node, back, mustMerge))
+                                       return false;
                        } else
-                               addNodeEdge(back, w_node);
-               }
+                               back->addEdge(w_node);
+               } else
+                       addNodeEdge(back, w_node);
        }
 
        /* Transfer forward edges to w_node */
        while (p_node->getNumEdges() > 0) {
                CycleNode *forward = p_node->removeEdge();
-               if (forward != w_node) {
-                       if (forward->is_promise()) {
-                               if (checkReachable(forward, w_node)) {
-                                       mustMerge->push_back(forward->getPromise());
-                                       if (!mergeNodes(w_node, forward, mustMerge))
-                                               return false;
-                               } else
-                                       w_node->addEdge(forward);
+               if (forward == w_node)
+                       continue;
+               if (forward->is_promise()) {
+                       if (checkReachable(forward, w_node)) {
+                               mustMerge->push_back(forward->getPromise());
+                               if (!mergeNodes(w_node, forward, mustMerge))
+                                       return false;
                        } else
-                               addNodeEdge(w_node, forward);
-               }
+                               w_node->addEdge(forward);
+               } else
+                       addNodeEdge(w_node, forward);
        }
 
-       /* erase p_node */
-       readerToPromiseNode.put(promise->get_action(), NULL);
-       delete p_node;
+       erasePromiseNode(promise);
+       /* Not deleting p_node, to maintain consistency if mergeNodes() fails */
 
        return !hasCycles;
 }
@@ -251,20 +284,81 @@ void CycleGraph::addRMWEdge(const T *from, const ModelAction *rmw)
 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(const CycleNode *node, FILE *file, int label)
+{
+       modelclock_t idx;
+       if (node->is_promise()) {
+               const Promise *promise = node->getPromise();
+               idx = promise->get_action()->get_seq_number();
+               fprintf(file, "P%u", idx);
+               if (label) {
+                       int first = 1;
+                       fprintf(file, " [label=\"P%u, T", idx);
+                       for (unsigned int i = 0 ; i < model->get_num_threads(); 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();
+               idx = act->get_seq_number();
+               fprintf(file, "N%u", idx);
+               if (label)
+                       fprintf(file, " [label=\"N%u, T%u\"]", idx, act->get_tid());
+       }
+}
+
 void CycleGraph::dumpNodes(FILE *file) const
 {
        for (unsigned int i = 0; i < nodeList.size(); i++) {
-               CycleNode *cn = nodeList[i];
-               const ModelAction *action = cn->getAction();
-               fprintf(file, "N%u [label=\"%u, T%u\"];\n", action->get_seq_number(), action->get_seq_number(), action->get_tid());
-               if (cn->getRMW() != NULL) {
-                       fprintf(file, "N%u -> N%u[style=dotted];\n", action->get_seq_number(), cn->getRMW()->getAction()->get_seq_number());
+               CycleNode *n = nodeList[i];
+               print_node(n, file, 1);
+               fprintf(file, ";\n");
+               if (n->getRMW() != NULL) {
+                       print_node(n, file, 0);
+                       fprintf(file, " -> ");
+                       print_node(n->getRMW(), file, 0);
+                       fprintf(file, "[style=dotted];\n");
                }
-               for (unsigned int j = 0; j < cn->getNumEdges(); j++) {
-                       CycleNode *dst = cn->getEdge(j);
-                       const ModelAction *dstaction = dst->getAction();
-                       fprintf(file, "N%u -> N%u;\n", action->get_seq_number(), dstaction->get_seq_number());
+               for (unsigned int j = 0; j < n->getNumEdges(); j++) {
+                       print_node(n, file, 0);
+                       fprintf(file, " -> ");
+                       print_node(n->getEdge(j), file, 0);
+                       fprintf(file, ";\n");
                }
        }
 }
@@ -311,6 +405,31 @@ bool CycleGraph::checkReachable(const CycleNode *from, const CycleNode *to) cons
        return false;
 }
 
+/**
+ * Checks whether one ModelAction/Promise can reach another ModelAction/Promise
+ * @param from The ModelAction or Promise from which to begin exploration
+ * @param to The ModelAction or Promise to reach
+ * @return True, @a from can reach @a to; otherwise, false
+ */
+template <typename T, typename U>
+bool CycleGraph::checkReachable(const T *from, const U *to) const
+{
+       CycleNode *fromnode = getNode_noCreate(from);
+       CycleNode *tonode = getNode_noCreate(to);
+
+       if (!fromnode || !tonode)
+               return false;
+
+       return checkReachable(fromnode, tonode);
+}
+/* Instantiate three forms of CycleGraph::checkReachable */
+template bool CycleGraph::checkReachable(const ModelAction *from,
+               const ModelAction *to) const;
+template bool CycleGraph::checkReachable(const ModelAction *from,
+               const Promise *to) const;
+template bool CycleGraph::checkReachable(const Promise *from,
+               const ModelAction *to) const;
+
 /** @return True, if the promise has failed; false otherwise */
 bool CycleGraph::checkPromise(const ModelAction *fromact, Promise *promise) const
 {