cyclegraph: add edgeCreatesCycle() function
[c11tester.git] / cyclegraph.cc
index 967b0763abbdcdba0ec35cdd2608cb0fa94caa13..ec0ce45f55ae65ae77325889b0aa0bfe84444cf8 100644 (file)
@@ -1,15 +1,36 @@
 #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)
+       oldCycles(false),
+       hasRMWViolation(false),
+       oldRMWViolation(false)
 {
 }
 
 /** CycleGraph destructor */
-CycleGraph::~CycleGraph() {
+CycleGraph::~CycleGraph()
+{
+       delete discovered;
+}
+
+/**
+ * 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
 }
 
 /**
@@ -17,11 +38,12 @@ CycleGraph::~CycleGraph() {
  * @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);
-               actionToNode.put(action, node);
+CycleNode * CycleGraph::getNode(const ModelAction *action)
+{
+       CycleNode *node = actionToNode.get(action);
+       if (node == NULL) {
+               node = new CycleNode(action);
+               putNode(action, node);
        }
        return node;
 }
@@ -32,30 +54,37 @@ CycleNode * CycleGraph::getNode(const ModelAction *action) {
  * @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) {
-       CycleNode *fromnode=getNode(from);
-       CycleNode *tonode=getNode(to);
+void CycleGraph::addEdge(const ModelAction *from, const ModelAction *to)
+{
+       ASSERT(from);
+       ASSERT(to);
 
-       if (!hasCycles) {
-               // Check for Cycles
-               hasCycles=checkReachable(tonode, fromnode);
-       }
+       CycleNode *fromnode = getNode(from);
+       CycleNode *tonode = getNode(to);
 
-       rollbackvector.push_back(fromnode);
-       fromnode->addEdge(tonode);
+       if (!hasCycles)
+               hasCycles = edgeCreatesCycle(fromnode, tonode);
 
-       CycleNode * rmwnode=fromnode->getRMW();
+       if (fromnode->addEdge(tonode))
+               rollbackvector.push_back(fromnode);
 
-       //If the fromnode has a rmwnode that is not the tonode, we
-       //should add an edge between its rmwnode and the tonode
 
-       if (rmwnode!=NULL&&rmwnode!=tonode) {
-               if (!hasCycles) {
-                       // Check for Cycles
-                       hasCycles=checkReachable(tonode, rmwnode);
-               }
-               rollbackvector.push_back(rmwnode);
-               rmwnode->addEdge(tonode);
+       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);
        }
 }
 
@@ -64,28 +93,83 @@ void CycleGraph::addEdge(const ModelAction *from, const ModelAction *to) {
  *  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) {
-       CycleNode *fromnode=getNode(from);
-       CycleNode *rmwnode=getNode(rmw);
+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)) {
-               hasCycles=true;
+               hasRMWViolation = true;
        } else {
                rmwrollbackvector.push_back(fromnode);
        }
 
        /* Transfer all outgoing edges from the from node to the rmw node */
-       /* This process cannot add a cycle because rmw should not have any
-                incoming edges yet.*/
-       std::vector<CycleNode *> * edges=fromnode->getEdges();
-       for(unsigned int i=0;i<edges->size();i++) {
-               CycleNode * tonode=(*edges)[i];
-               rollbackvector.push_back(rmwnode);
-               rmwnode->addEdge(tonode);
+       /* 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);
+}
+
+#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());
+               }
        }
-       rollbackvector.push_back(fromnode);
-       fromnode->addEdge(rmwnode);
+}
+
+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);
 }
 
 /**
@@ -94,7 +178,8 @@ void CycleGraph::addRMWEdge(const ModelAction *from, const ModelAction *rmw) {
  * @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) {
+bool CycleGraph::checkReachable(const ModelAction *from, const ModelAction *to) const
+{
        CycleNode *fromnode = actionToNode.get(from);
        CycleNode *tonode = actionToNode.get(to);
 
@@ -110,22 +195,50 @@ bool CycleGraph::checkReachable(const ModelAction *from, const ModelAction *to)
  * @param to The CycleNode to reach
  * @return True, @a from can reach @a to; otherwise, false
  */
-bool CycleGraph::checkReachable(CycleNode *from, CycleNode *to) {
-       std::vector<CycleNode *> queue;
-       HashTable<CycleNode *, CycleNode *, uintptr_t, 4> discovered;
+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::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);
                        }
                }
@@ -133,15 +246,26 @@ bool CycleGraph::checkReachable(CycleNode *from, CycleNode *to) {
        return false;
 }
 
+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() {
+void CycleGraph::commitChanges()
+{
        rollbackvector.resize(0);
        rmwrollbackvector.resize(0);
-       oldCycles=hasCycles;
+       oldCycles = hasCycles;
+       oldRMWViolation = hasRMWViolation;
 }
 
 /** Rollback changes to the previous commit. */
-void CycleGraph::rollbackChanges() {
+void CycleGraph::rollbackChanges()
+{
        for (unsigned int i = 0; i < rollbackvector.size(); i++) {
                rollbackvector[i]->popEdge();
        }
@@ -151,40 +275,74 @@ void CycleGraph::rollbackChanges() {
        }
 
        hasCycles = oldCycles;
+       hasRMWViolation = oldRMWViolation;
        rollbackvector.resize(0);
        rmwrollbackvector.resize(0);
 }
 
 /** @returns whether a CycleGraph contains cycles. */
-bool CycleGraph::checkForCycles() {
+bool CycleGraph::checkForCycles() const
+{
        return hasCycles;
 }
 
+bool CycleGraph::checkForRMWViolation() const
+{
+       return hasRMWViolation;
+}
+
 /**
- * Constructor for a CycleNode.
- * @param modelaction The ModelAction for this node
+ * @brief Constructor for a CycleNode
+ * @param act The ModelAction for this node
  */
-CycleNode::CycleNode(const ModelAction *modelaction) :
-       action(modelaction),
+CycleNode::CycleNode(const ModelAction *act) :
+       action(act),
        hasRMW(NULL)
 {
 }
 
-/** @returns a vector of the edges from a CycleNode. */
-std::vector<CycleNode *> * CycleNode::getEdges() {
-       return &edges;
+/**
+ * @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 The number of edges leaving this CycleNode */
+unsigned int CycleNode::getNumEdges() const
+{
+       return edges.size();
+}
+
+CycleNode * CycleNode::getBackEdge(unsigned int i) const
+{
+       return back_edges[i];
+}
+
+unsigned int CycleNode::getNumBackEdges() const
+{
+       return back_edges.size();
 }
 
 /**
  * Adds an edge from this CycleNode to another CycleNode.
  * @param node The node to which we add a directed edge
  */
-void CycleNode::addEdge(CycleNode *node) {
+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() {
+CycleNode * CycleNode::getRMW() const
+{
        return hasRMW;
 }
 
@@ -194,9 +352,10 @@ CycleNode * CycleNode::getRMW() {
  * @return True, if this node already was read by another RMW; false otherwise
  * @see CycleGraph::addRMWEdge
  */
-bool CycleNode::setRMW(CycleNode *node) {
-       if (hasRMW!=NULL)
+bool CycleNode::setRMW(CycleNode *node)
+{
+       if (hasRMW != NULL)
                return true;
-       hasRMW=node;
+       hasRMW = node;
        return false;
 }