cyclegraph.cc

   1 #include "cyclegraph.h"
   2 #include "action.h"
   3 #include "common.h"
   4 #include "promise.h"
   5 #include "model.h"
   6
   7 /** Initializes a CycleGraph object. */
   8 CycleGraph::CycleGraph() :
   9         discovered(new HashTable<const CycleNode *, const CycleNode *, uintptr_t, 4, model_malloc, model_calloc, model_free>(16)),
  10         hasCycles(false),
  11         oldCycles(false)
  12 {
  13 }
  14
  15 /** CycleGraph destructor */
  16 CycleGraph::~CycleGraph()
  17 {
  18         delete discovered;
  19 }
  20
  21 /**
  22  * Add a CycleNode to the graph, corresponding to a store ModelAction
  23  * @param act The write action that should be added
  24  * @param node The CycleNode that corresponds to the store
  25  */
  26 void CycleGraph::putNode(const ModelAction *act, CycleNode *node)
  27 {
  28         actionToNode.put(act, node);
  29 #if SUPPORT_MOD_ORDER_DUMP
  30         nodeList.push_back(node);
  31 #endif
  32 }
  33
  34 /** @return The corresponding CycleNode, if exists; otherwise NULL */
  35 CycleNode * CycleGraph::getNode_noCreate(const ModelAction *act) const
  36 {
  37         return actionToNode.get(act);
  38 }
  39
  40 /** @return The corresponding CycleNode, if exists; otherwise NULL */
  41 CycleNode * CycleGraph::getNode_noCreate(const Promise *promise) const
  42 {
  43         return readerToPromiseNode.get(promise->get_action());
  44 }
  45
  46 /**
  47  * @brief Returns the CycleNode corresponding to a given ModelAction
  48  *
  49  * Gets (or creates, if none exist) a CycleNode corresponding to a ModelAction
  50  *
  51  * @param action The ModelAction to find a node for
  52  * @return The CycleNode paired with this action
  53  */
  54 CycleNode * CycleGraph::getNode(const ModelAction *action)
  55 {
  56         CycleNode *node = getNode_noCreate(action);
  57         if (node == NULL) {
  58                 node = new CycleNode(action);
  59                 putNode(action, node);
  60         }
  61         return node;
  62 }
  63
  64 /**
  65  * @brief Returns a CycleNode corresponding to a promise
  66  *
  67  * Gets (or creates, if none exist) a CycleNode corresponding to a promised
  68  * value.
  69  *
  70  * @param promise The Promise generated by a reader
  71  * @return The CycleNode corresponding to the Promise
  72  */
  73 CycleNode * CycleGraph::getNode(const Promise *promise)
  74 {
  75         const ModelAction *reader = promise->get_action();
  76         CycleNode *node = getNode_noCreate(promise);
  77         if (node == NULL) {
  78                 node = new CycleNode(promise);
  79                 readerToPromiseNode.put(reader, node);
  80         }
  81         return node;
  82 }
  83
  84 /**
  85  * @return false if the resolution results in a cycle; true otherwise
  86  */
  87 bool CycleGraph::resolvePromise(ModelAction *reader, ModelAction *writer,
  88                 promise_list_t *mustResolve)
  89 {
  90         CycleNode *promise_node = readerToPromiseNode.get(reader);
  91         CycleNode *w_node = actionToNode.get(writer);
  92         ASSERT(promise_node);
  93
  94         if (w_node)
  95                 return mergeNodes(w_node, promise_node, mustResolve);
  96         /* No existing write-node; just convert the promise-node */
  97         promise_node->resolvePromise(writer);
  98         readerToPromiseNode.put(reader, NULL); /* erase promise_node */
  99         putNode(writer, promise_node);
 100         return true;
 101 }
 102
 103 /**
 104  * @brief Merge two CycleNodes that represent the same write
 105  *
 106  * Note that this operation cannot be rolled back.
 107  *
 108  * @param w_node The write ModelAction node with which to merge
 109  * @param p_node The Promise node to merge. Will be destroyed after this
 110  * function.
 111  * @param mustMerge Return (pass-by-reference) any additional Promises that
 112  * must also be merged with w_node
 113  *
 114  * @return false if the merge results in a cycle; true otherwise
 115  */
 116 bool CycleGraph::mergeNodes(CycleNode *w_node, CycleNode *p_node,
 117                 promise_list_t *mustMerge)
 118 {
 119         ASSERT(!w_node->is_promise());
 120         ASSERT(p_node->is_promise());
 121         const Promise *promise = p_node->getPromise();
 122         if (!promise->is_compatible(w_node->getAction())) {
 123                 hasCycles = true;
 124                 return false;
 125         }
 126
 127         /* Transfer back edges to w_node */
 128         while (p_node->getNumBackEdges() > 0) {
 129                 CycleNode *back = p_node->removeBackEdge();
 130                 if (back != w_node) {
 131                         if (back->is_promise()) {
 132                                 if (checkReachable(w_node, back)) {
 133                                         /* Edge would create cycle; merge instead */
 134                                         mustMerge->push_back(back->getPromise());
 135                                         if (!mergeNodes(w_node, back, mustMerge))
 136                                                 return false;
 137                                 } else
 138                                         back->addEdge(w_node);
 139                         } else
 140                                 addNodeEdge(back, w_node);
 141                 }
 142         }
 143
 144         /* Transfer forward edges to w_node */
 145         while (p_node->getNumEdges() > 0) {
 146                 CycleNode *forward = p_node->removeEdge();
 147                 if (forward != w_node) {
 148                         if (forward->is_promise()) {
 149                                 if (checkReachable(forward, w_node)) {
 150                                         mustMerge->push_back(forward->getPromise());
 151                                         if (!mergeNodes(w_node, forward, mustMerge))
 152                                                 return false;
 153                                 } else
 154                                         w_node->addEdge(forward);
 155                         } else
 156                                 addNodeEdge(w_node, forward);
 157                 }
 158         }
 159
 160         /* erase p_node */
 161         readerToPromiseNode.put(promise->get_action(), NULL);
 162         delete p_node;
 163
 164         return !hasCycles;
 165 }
 166
 167 /**
 168  * Adds an edge between two CycleNodes.
 169  * @param fromnode The edge comes from this CycleNode
 170  * @param tonode The edge points to this CycleNode
 171  */
 172 void CycleGraph::addNodeEdge(CycleNode *fromnode, CycleNode *tonode)
 173 {
 174         if (!hasCycles)
 175                 hasCycles = checkReachable(tonode, fromnode);
 176
 177         if (fromnode->addEdge(tonode))
 178                 rollbackvector.push_back(fromnode);
 179
 180         /*
 181          * If the fromnode has a rmwnode that is not the tonode, we should add
 182          * an edge between its rmwnode and the tonode
 183          */
 184         CycleNode *rmwnode = fromnode->getRMW();
 185         if (rmwnode && rmwnode != tonode) {
 186                 if (!hasCycles)
 187                         hasCycles = checkReachable(tonode, rmwnode);
 188
 189                 if (rmwnode->addEdge(tonode))
 190                         rollbackvector.push_back(rmwnode);
 191         }
 192 }
 193
 194 /**
 195  * @brief Add an edge between a write and the RMW which reads from it
 196  *
 197  * Handles special case of a RMW action, where the ModelAction rmw reads from
 198  * the ModelAction from. The key differences are:
 199  * (1) no write can occur in between the rmw and the from action.
 200  * (2) Only one RMW action can read from a given write.
 201  *
 202  * @param from The edge comes from this ModelAction
 203  * @param rmw The edge points to this ModelAction; this action must read from
 204  * ModelAction from
 205  */
 206 void CycleGraph::addRMWEdge(const ModelAction *from, const ModelAction *rmw)
 207 {
 208         ASSERT(from);
 209         ASSERT(rmw);
 210
 211         CycleNode *fromnode = getNode(from);
 212         CycleNode *rmwnode = getNode(rmw);
 213
 214         /* Two RMW actions cannot read from the same write. */
 215         if (fromnode->setRMW(rmwnode))
 216                 hasCycles = true;
 217         else
 218                 rmwrollbackvector.push_back(fromnode);
 219
 220         /* Transfer all outgoing edges from the from node to the rmw node */
 221         /* This process should not add a cycle because either:
 222          * (1) The rmw should not have any incoming edges yet if it is the
 223          * new node or
 224          * (2) the fromnode is the new node and therefore it should not
 225          * have any outgoing edges.
 226          */
 227         for (unsigned int i = 0; i < fromnode->getNumEdges(); i++) {
 228                 CycleNode *tonode = fromnode->getEdge(i);
 229                 if (tonode != rmwnode) {
 230                         if (rmwnode->addEdge(tonode))
 231                                 rollbackvector.push_back(rmwnode);
 232                 }
 233         }
 234
 235         addNodeEdge(fromnode, rmwnode);
 236 }
 237
 238 #if SUPPORT_MOD_ORDER_DUMP
 239 void CycleGraph::dumpNodes(FILE *file) const
 240 {
 241         for (unsigned int i = 0; i < nodeList.size(); i++) {
 242                 CycleNode *cn = nodeList[i];
 243                 const ModelAction *action = cn->getAction();
 244                 fprintf(file, "N%u [label=\"%u, T%u\"];\n", action->get_seq_number(), action->get_seq_number(), action->get_tid());
 245                 if (cn->getRMW() != NULL) {
 246                         fprintf(file, "N%u -> N%u[style=dotted];\n", action->get_seq_number(), cn->getRMW()->getAction()->get_seq_number());
 247                 }
 248                 for (unsigned int j = 0; j < cn->getNumEdges(); j++) {
 249                         CycleNode *dst = cn->getEdge(j);
 250                         const ModelAction *dstaction = dst->getAction();
 251                         fprintf(file, "N%u -> N%u;\n", action->get_seq_number(), dstaction->get_seq_number());
 252                 }
 253         }
 254 }
 255
 256 void CycleGraph::dumpGraphToFile(const char *filename) const
 257 {
 258         char buffer[200];
 259         sprintf(buffer, "%s.dot", filename);
 260         FILE *file = fopen(buffer, "w");
 261         fprintf(file, "digraph %s {\n", filename);
 262         dumpNodes(file);
 263         fprintf(file, "}\n");
 264         fclose(file);
 265 }
 266 #endif
 267
 268 /**
 269  * Checks whether one CycleNode can reach another.
 270  * @param from The CycleNode from which to begin exploration
 271  * @param to The CycleNode to reach
 272  * @return True, @a from can reach @a to; otherwise, false
 273  */
 274 bool CycleGraph::checkReachable(const CycleNode *from, const CycleNode *to) const
 275 {
 276         std::vector< const CycleNode *, ModelAlloc<const CycleNode *> > queue;
 277         discovered->reset();
 278
 279         queue.push_back(from);
 280         discovered->put(from, from);
 281         while (!queue.empty()) {
 282                 const CycleNode *node = queue.back();
 283                 queue.pop_back();
 284                 if (node == to)
 285                         return true;
 286
 287                 for (unsigned int i = 0; i < node->getNumEdges(); i++) {
 288                         CycleNode *next = node->getEdge(i);
 289                         if (!discovered->contains(next)) {
 290                                 discovered->put(next, next);
 291                                 queue.push_back(next);
 292                         }
 293                 }
 294         }
 295         return false;
 296 }
 297
 298 /** @return True, if the promise has failed; false otherwise */
 299 bool CycleGraph::checkPromise(const ModelAction *fromact, Promise *promise) const
 300 {
 301         std::vector< CycleNode *, ModelAlloc<CycleNode *> > queue;
 302         discovered->reset();
 303         CycleNode *from = actionToNode.get(fromact);
 304
 305         queue.push_back(from);
 306         discovered->put(from, from);
 307         while (!queue.empty()) {
 308                 CycleNode *node = queue.back();
 309                 queue.pop_back();
 310
 311                 if (!node->is_promise() &&
 312                                 promise->eliminate_thread(node->getAction()->get_tid()))
 313                         return true;
 314
 315                 for (unsigned int i = 0; i < node->getNumEdges(); i++) {
 316                         CycleNode *next = node->getEdge(i);
 317                         if (!discovered->contains(next)) {
 318                                 discovered->put(next, next);
 319                                 queue.push_back(next);
 320                         }
 321                 }
 322         }
 323         return false;
 324 }
 325
 326 void CycleGraph::startChanges()
 327 {
 328         ASSERT(rollbackvector.empty());
 329         ASSERT(rmwrollbackvector.empty());
 330         ASSERT(oldCycles == hasCycles);
 331 }
 332
 333 /** Commit changes to the cyclegraph. */
 334 void CycleGraph::commitChanges()
 335 {
 336         rollbackvector.clear();
 337         rmwrollbackvector.clear();
 338         oldCycles = hasCycles;
 339 }
 340
 341 /** Rollback changes to the previous commit. */
 342 void CycleGraph::rollbackChanges()
 343 {
 344         for (unsigned int i = 0; i < rollbackvector.size(); i++)
 345                 rollbackvector[i]->popEdge();
 346
 347         for (unsigned int i = 0; i < rmwrollbackvector.size(); i++)
 348                 rmwrollbackvector[i]->clearRMW();
 349
 350         hasCycles = oldCycles;
 351         rollbackvector.clear();
 352         rmwrollbackvector.clear();
 353 }
 354
 355 /** @returns whether a CycleGraph contains cycles. */
 356 bool CycleGraph::checkForCycles() const
 357 {
 358         return hasCycles;
 359 }
 360
 361 /**
 362  * @brief Constructor for a CycleNode
 363  * @param act The ModelAction for this node
 364  */
 365 CycleNode::CycleNode(const ModelAction *act) :
 366         action(act),
 367         promise(NULL),
 368         hasRMW(NULL)
 369 {
 370 }
 371
 372 /**
 373  * @brief Constructor for a Promise CycleNode
 374  * @param promise The Promise which was generated
 375  */
 376 CycleNode::CycleNode(const Promise *promise) :
 377         action(NULL),
 378         promise(promise),
 379         hasRMW(NULL)
 380 {
 381 }
 382
 383 /**
 384  * @param i The index of the edge to return
 385  * @returns The a CycleNode edge indexed by i
 386  */
 387 CycleNode * CycleNode::getEdge(unsigned int i) const
 388 {
 389         return edges[i];
 390 }
 391
 392 /** @returns The number of edges leaving this CycleNode */
 393 unsigned int CycleNode::getNumEdges() const
 394 {
 395         return edges.size();
 396 }
 397
 398 CycleNode * CycleNode::getBackEdge(unsigned int i) const
 399 {
 400         return back_edges[i];
 401 }
 402
 403 unsigned int CycleNode::getNumBackEdges() const
 404 {
 405         return back_edges.size();
 406 }
 407
 408 /**
 409  * @brief Remove an element from a vector
 410  * @param v The vector
 411  * @param n The element to remove
 412  * @return True if the element was found; false otherwise
 413  */
 414 template <typename T>
 415 static bool vector_remove_node(std::vector<T, SnapshotAlloc<T> >& v, const T n)
 416 {
 417         for (unsigned int i = 0; i < v.size(); i++) {
 418                 if (v[i] == n) {
 419                         v.erase(v.begin() + i);
 420                         return true;
 421                 }
 422         }
 423         return false;
 424 }
 425
 426 /**
 427  * @brief Remove a (forward) edge from this CycleNode
 428  * @return The CycleNode which was popped, if one exists; otherwise NULL
 429  */
 430 CycleNode * CycleNode::removeEdge()
 431 {
 432         if (edges.empty())
 433                 return NULL;
 434
 435         CycleNode *ret = edges.back();
 436         edges.pop_back();
 437         vector_remove_node(ret->back_edges, this);
 438         return ret;
 439 }
 440
 441 /**
 442  * @brief Remove a (back) edge from this CycleNode
 443  * @return The CycleNode which was popped, if one exists; otherwise NULL
 444  */
 445 CycleNode * CycleNode::removeBackEdge()
 446 {
 447         if (back_edges.empty())
 448                 return NULL;
 449
 450         CycleNode *ret = back_edges.back();
 451         back_edges.pop_back();
 452         vector_remove_node(ret->edges, this);
 453         return ret;
 454 }
 455
 456 /**
 457  * Adds an edge from this CycleNode to another CycleNode.
 458  * @param node The node to which we add a directed edge
 459  * @return True if this edge is a new edge; false otherwise
 460  */
 461 bool CycleNode::addEdge(CycleNode *node)
 462 {
 463         for (unsigned int i = 0; i < edges.size(); i++)
 464                 if (edges[i] == node)
 465                         return false;
 466         edges.push_back(node);
 467         node->back_edges.push_back(this);
 468         return true;
 469 }
 470
 471 /** @returns the RMW CycleNode that reads from the current CycleNode */
 472 CycleNode * CycleNode::getRMW() const
 473 {
 474         return hasRMW;
 475 }
 476
 477 /**
 478  * Set a RMW action node that reads from the current CycleNode.
 479  * @param node The RMW that reads from the current node
 480  * @return True, if this node already was read by another RMW; false otherwise
 481  * @see CycleGraph::addRMWEdge
 482  */
 483 bool CycleNode::setRMW(CycleNode *node)
 484 {
 485         if (hasRMW != NULL)
 486                 return true;
 487         hasRMW = node;
 488         return false;
 489 }
 490
 491 /**
 492  * Convert a Promise CycleNode into a concrete-valued CycleNode. Should only be
 493  * used when there's no existing ModelAction CycleNode for this write.
 494  *
 495  * @param writer The ModelAction which wrote the future value represented by
 496  * this CycleNode
 497  */
 498 void CycleNode::resolvePromise(const ModelAction *writer)
 499 {
 500         ASSERT(is_promise());
 501         ASSERT(promise->is_compatible(writer));
 502         action = writer;
 503         promise = NULL;
 504         ASSERT(!is_promise());
 505 }