cyclegraph: add edgeCreatesCycle() function
[c11tester.git] / cyclegraph.cc
index 324e01cc0312747e4b39ee4b6c37343cfd7d163f..ec0ce45f55ae65ae77325889b0aa0bfe84444cf8 100644 (file)
 #include "cyclegraph.h"
 #include "action.h"
+#include "common.h"
+#include "promise.h"
+#include "model.h"
 
 /** Initializes a CycleGraph object. */
+CycleGraph::CycleGraph() :
+       discovered(new HashTable<const CycleNode *, const CycleNode *, uintptr_t, 4, model_malloc, model_calloc, model_free>(16)),
+       hasCycles(false),
+       oldCycles(false),
+       hasRMWViolation(false),
+       oldRMWViolation(false)
+{
+}
 
-CycleGraph::CycleGraph() {
-       hasCycles=false;
+/** CycleGraph destructor */
+CycleGraph::~CycleGraph()
+{
+       delete discovered;
 }
 
-/** Returns the CycleNode for a given ModelAction. */
+/**
+ * Add a CycleNode to the graph, corresponding to a store ModelAction
+ * @param act The write action that should be added
+ * @param node The CycleNode that corresponds to the store
+ */
+void CycleGraph::putNode(const ModelAction *act, CycleNode *node)
+{
+       actionToNode.put(act, node);
+#if SUPPORT_MOD_ORDER_DUMP
+       nodeList.push_back(node);
+#endif
+}
 
-CycleNode * CycleGraph::getNode(ModelAction * action) {
-       CycleNode *node=actionToNode.get(action);
-       if (node==NULL) {
-               node=new CycleNode(action);
-               actionToNode.put(action, node);
+/**
+ * @brief Returns the CycleNode corresponding to a given ModelAction
+ * @param action The ModelAction to find a node for
+ * @return The CycleNode paired with this action
+ */
+CycleNode * CycleGraph::getNode(const ModelAction *action)
+{
+       CycleNode *node = actionToNode.get(action);
+       if (node == NULL) {
+               node = new CycleNode(action);
+               putNode(action, node);
        }
        return node;
 }
 
-/** Adds an edge between two ModelActions. */
+/**
+ * Adds an edge between two ModelActions. The ModelAction @a to is ordered
+ * after the ModelAction @a from.
+ * @param to The edge points to this ModelAction
+ * @param from The edge comes from this ModelAction
+ */
+void CycleGraph::addEdge(const ModelAction *from, const ModelAction *to)
+{
+       ASSERT(from);
+       ASSERT(to);
+
+       CycleNode *fromnode = getNode(from);
+       CycleNode *tonode = getNode(to);
+
+       if (!hasCycles)
+               hasCycles = edgeCreatesCycle(fromnode, tonode);
+
+       if (fromnode->addEdge(tonode))
+               rollbackvector.push_back(fromnode);
+
+
+       CycleNode *rmwnode = fromnode->getRMW();
+
+       /*
+        * If the fromnode has a rmwnode that is not the tonode, we should add
+        * an edge between its rmwnode and the tonode
+        *
+        * If tonode is also a rmw, don't do this check as the execution is
+        * doomed and we'll catch the problem elsewhere, but we want to allow
+        * for the possibility of sending to's write value to rmwnode
+        */
+       if (rmwnode != NULL && !to->is_rmw()) {
+               if (!hasCycles)
+                       hasCycles = edgeCreatesCycle(rmwnode, tonode);
+
+               if (rmwnode->addEdge(tonode))
+                       rollbackvector.push_back(rmwnode);
+       }
+}
+
+/** Handles special case of a RMW action.  The ModelAction rmw reads
+ *  from the ModelAction from.  The key differences are: (1) no write
+ *  can occur in between the rmw and the from action.  Only one RMW
+ *  action can read from a given write.
+ */
+void CycleGraph::addRMWEdge(const ModelAction *from, const ModelAction *rmw)
+{
+       ASSERT(from);
+       ASSERT(rmw);
+
+       CycleNode *fromnode = getNode(from);
+       CycleNode *rmwnode = getNode(rmw);
+
+       /* Two RMW actions cannot read from the same write. */
+       if (fromnode->setRMW(rmwnode)) {
+               hasRMWViolation = 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);
+               }
+       }
+
+       if (!hasCycles)
+               hasCycles = edgeCreatesCycle(fromnode, rmwnode);
+
+       if (fromnode->addEdge(rmwnode))
+               rollbackvector.push_back(fromnode);
+}
 
-void CycleGraph::addEdge(ModelAction *from, ModelAction *to) {
-       CycleNode *fromnode=getNode(from);
-       CycleNode *tonode=getNode(to);
-       if (!hasCycles) {
-               // Check for Cycles
-               hasCycles=checkReachable(fromnode, tonode);
+#if SUPPORT_MOD_ORDER_DUMP
+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());
+               }
+               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());
+               }
        }
-       fromnode->addEdge(tonode);
 }
 
-/** Checks whether the first CycleNode can reach the second one. */
+void CycleGraph::dumpGraphToFile(const char *filename) const
+{
+       char buffer[200];
+       sprintf(buffer, "%s.dot", filename);
+       FILE *file = fopen(buffer, "w");
+       fprintf(file, "digraph %s {\n", filename);
+       dumpNodes(file);
+       fprintf(file, "}\n");
+       fclose(file);
+}
+#endif
+
+/**
+ * Checks whether the addition of an edge between these two nodes would create
+ * a cycle in the graph.
+ * @param from The CycleNode from which the edge would start
+ * @param to The CycleNode to which the edge would point
+ * @return True if this edge would create a cycle; false otherwise
+ */
+bool CycleGraph::edgeCreatesCycle(const CycleNode *from, const CycleNode *to) const
+{
+       return (from == to) || checkReachable(to, from);
+}
+
+/**
+ * Checks whether one ModelAction can reach another.
+ * @param from The ModelAction from which to begin exploration
+ * @param to The ModelAction to reach
+ * @return True, @a from can reach @a to; otherwise, false
+ */
+bool CycleGraph::checkReachable(const ModelAction *from, const ModelAction *to) const
+{
+       CycleNode *fromnode = actionToNode.get(from);
+       CycleNode *tonode = actionToNode.get(to);
+
+       if (!fromnode || !tonode)
+               return false;
+
+       return checkReachable(fromnode, tonode);
+}
+
+/**
+ * Checks whether one CycleNode can reach another.
+ * @param from The CycleNode from which to begin exploration
+ * @param to The CycleNode to reach
+ * @return True, @a from can reach @a to; otherwise, false
+ */
+bool CycleGraph::checkReachable(const CycleNode *from, const CycleNode *to) const
+{
+       std::vector< const CycleNode *, ModelAlloc<const CycleNode *> > queue;
+       discovered->reset();
+
+       queue.push_back(from);
+       discovered->put(from, from);
+       while (!queue.empty()) {
+               const CycleNode *node = queue.back();
+               queue.pop_back();
+               if (node == to)
+                       return true;
+
+               for (unsigned int i = 0; i < node->getNumEdges(); i++) {
+                       CycleNode *next = node->getEdge(i);
+                       if (!discovered->contains(next)) {
+                               discovered->put(next, next);
+                               queue.push_back(next);
+                       }
+               }
+       }
+       return false;
+}
 
-bool CycleGraph::checkReachable(CycleNode *from, CycleNode *to) {
-       std::vector<CycleNode *> queue;
-       HashTable<CycleNode *, CycleNode *, uintptr_t, 4> discovered;
+bool CycleGraph::checkPromise(const ModelAction *fromact, Promise *promise) const
+{
+       std::vector< CycleNode *, ModelAlloc<CycleNode *> > queue;
+       discovered->reset();
+       CycleNode *from = actionToNode.get(fromact);
 
        queue.push_back(from);
-       discovered.put(from, from);
-       while(!queue.empty()) {
-               CycleNode * node=queue.back();
+       discovered->put(from, from);
+       while (!queue.empty()) {
+               CycleNode *node = queue.back();
                queue.pop_back();
-               if (node==to)
+
+               if (promise->increment_threads(node->getAction()->get_tid())) {
                        return true;
+               }
 
-               for(unsigned int i=0;i<node->getEdges()->size();i++) {
-                       CycleNode *next=(*node->getEdges())[i];
-                       if (!discovered.contains(next)) {
-                               discovered.put(next,next);
+               for (unsigned int i = 0; i < node->getNumEdges(); i++) {
+                       CycleNode *next = node->getEdge(i);
+                       if (!discovered->contains(next)) {
+                               discovered->put(next, next);
                                queue.push_back(next);
                        }
                }
@@ -55,25 +246,116 @@ bool CycleGraph::checkReachable(CycleNode *from, CycleNode *to) {
        return false;
 }
 
-/** Returns whether a CycleGraph contains cycles. */
-bool CycleGraph::checkForCycles() {
+void CycleGraph::startChanges()
+{
+       ASSERT(rollbackvector.size() == 0);
+       ASSERT(rmwrollbackvector.size() == 0);
+       ASSERT(oldCycles == hasCycles);
+       ASSERT(oldRMWViolation == hasRMWViolation);
+}
+
+/** Commit changes to the cyclegraph. */
+void CycleGraph::commitChanges()
+{
+       rollbackvector.resize(0);
+       rmwrollbackvector.resize(0);
+       oldCycles = hasCycles;
+       oldRMWViolation = hasRMWViolation;
+}
+
+/** Rollback changes to the previous commit. */
+void CycleGraph::rollbackChanges()
+{
+       for (unsigned int i = 0; i < rollbackvector.size(); i++) {
+               rollbackvector[i]->popEdge();
+       }
+
+       for (unsigned int i = 0; i < rmwrollbackvector.size(); i++) {
+               rmwrollbackvector[i]->clearRMW();
+       }
+
+       hasCycles = oldCycles;
+       hasRMWViolation = oldRMWViolation;
+       rollbackvector.resize(0);
+       rmwrollbackvector.resize(0);
+}
+
+/** @returns whether a CycleGraph contains cycles. */
+bool CycleGraph::checkForCycles() const
+{
        return hasCycles;
 }
 
-/** Constructor for a CycleNode. */
+bool CycleGraph::checkForRMWViolation() const
+{
+       return hasRMWViolation;
+}
+
+/**
+ * @brief Constructor for a CycleNode
+ * @param act The ModelAction for this node
+ */
+CycleNode::CycleNode(const ModelAction *act) :
+       action(act),
+       hasRMW(NULL)
+{
+}
 
-CycleNode::CycleNode(ModelAction *modelaction) {
-       action=modelaction;
+/**
+ * @param i The index of the edge to return
+ * @returns The a CycleNode edge indexed by i
+ */
+CycleNode * CycleNode::getEdge(unsigned int i) const
+{
+       return edges[i];
 }
 
-/** Returns a vector of the edges from a CycleNode. */
+/** @returns The number of edges leaving this CycleNode */
+unsigned int CycleNode::getNumEdges() const
+{
+       return edges.size();
+}
 
-std::vector<CycleNode *> * CycleNode::getEdges() {
-       return &edges;
+CycleNode * CycleNode::getBackEdge(unsigned int i) const
+{
+       return back_edges[i];
 }
 
-/** Adds an edge to a CycleNode. */
+unsigned int CycleNode::getNumBackEdges() const
+{
+       return back_edges.size();
+}
 
-void CycleNode::addEdge(CycleNode * node) {
+/**
+ * Adds an edge from this CycleNode to another CycleNode.
+ * @param node The node to which we add a directed edge
+ */
+bool CycleNode::addEdge(CycleNode *node)
+{
+       for (unsigned int i = 0; i < edges.size(); i++)
+               if (edges[i] == node)
+                       return false;
        edges.push_back(node);
+       node->back_edges.push_back(this);
+       return true;
+}
+
+/** @returns the RMW CycleNode that reads from the current CycleNode */
+CycleNode * CycleNode::getRMW() const
+{
+       return hasRMW;
+}
+
+/**
+ * Set a RMW action node that reads from the current CycleNode.
+ * @param node The RMW that reads from the current node
+ * @return True, if this node already was read by another RMW; false otherwise
+ * @see CycleGraph::addRMWEdge
+ */
+bool CycleNode::setRMW(CycleNode *node)
+{
+       if (hasRMW != NULL)
+               return true;
+       hasRMW = node;
+       return false;
 }