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 bool CycleGraph::checkPromise(const ModelAction *fromact, Promise *promise) const
 299 {
 300         std::vector< CycleNode *, ModelAlloc<CycleNode *> > queue;
 301         discovered->reset();
 302         CycleNode *from = actionToNode.get(fromact);
 303
 304         queue.push_back(from);
 305         discovered->put(from, from);
 306         while (!queue.empty()) {
 307                 CycleNode *node = queue.back();
 308                 queue.pop_back();
 309
 310                 if (promise->eliminate_thread(node->getAction()->get_tid())) {
 311                         return true;
 312                 }
 313
 314                 for (unsigned int i = 0; i < node->getNumEdges(); i++) {
 315                         CycleNode *next = node->getEdge(i);
 316                         if (!discovered->contains(next)) {
 317                                 discovered->put(next, next);
 318                                 queue.push_back(next);
 319                         }
 320                 }
 321         }
 322         return false;
 323 }
 324
 325 void CycleGraph::startChanges()
 326 {
 327         ASSERT(rollbackvector.empty());
 328         ASSERT(rmwrollbackvector.empty());
 329         ASSERT(oldCycles == hasCycles);
 330 }
 331
 332 /** Commit changes to the cyclegraph. */
 333 void CycleGraph::commitChanges()
 334 {
 335         rollbackvector.clear();
 336         rmwrollbackvector.clear();
 337         oldCycles = hasCycles;
 338 }
 339
 340 /** Rollback changes to the previous commit. */
 341 void CycleGraph::rollbackChanges()
 342 {
 343         for (unsigned int i = 0; i < rollbackvector.size(); i++)
 344                 rollbackvector[i]->popEdge();
 345
 346         for (unsigned int i = 0; i < rmwrollbackvector.size(); i++)
 347                 rmwrollbackvector[i]->clearRMW();
 348
 349         hasCycles = oldCycles;
 350         rollbackvector.clear();
 351         rmwrollbackvector.clear();
 352 }
 353
 354 /** @returns whether a CycleGraph contains cycles. */
 355 bool CycleGraph::checkForCycles() const
 356 {
 357         return hasCycles;
 358 }
 359
 360 /**
 361  * @brief Constructor for a CycleNode
 362  * @param act The ModelAction for this node
 363  */
 364 CycleNode::CycleNode(const ModelAction *act) :
 365         action(act),
 366         promise(NULL),
 367         hasRMW(NULL)
 368 {
 369 }
 370
 371 /**
 372  * @brief Constructor for a Promise CycleNode
 373  * @param promise The Promise which was generated
 374  */
 375 CycleNode::CycleNode(const Promise *promise) :
 376         action(NULL),
 377         promise(promise),
 378         hasRMW(NULL)
 379 {
 380 }
 381
 382 /**
 383  * @param i The index of the edge to return
 384  * @returns The a CycleNode edge indexed by i
 385  */
 386 CycleNode * CycleNode::getEdge(unsigned int i) const
 387 {
 388         return edges[i];
 389 }
 390
 391 /** @returns The number of edges leaving this CycleNode */
 392 unsigned int CycleNode::getNumEdges() const
 393 {
 394         return edges.size();
 395 }
 396
 397 CycleNode * CycleNode::getBackEdge(unsigned int i) const
 398 {
 399         return back_edges[i];
 400 }
 401
 402 unsigned int CycleNode::getNumBackEdges() const
 403 {
 404         return back_edges.size();
 405 }
 406
 407 /**
 408  * @brief Remove an element from a vector
 409  * @param v The vector
 410  * @param n The element to remove
 411  * @return True if the element was found; false otherwise
 412  */
 413 template <typename T>
 414 static bool vector_remove_node(std::vector<T, SnapshotAlloc<T> >& v, const T n)
 415 {
 416         for (unsigned int i = 0; i < v.size(); i++) {
 417                 if (v[i] == n) {
 418                         v.erase(v.begin() + i);
 419                         return true;
 420                 }
 421         }
 422         return false;
 423 }
 424
 425 /**
 426  * @brief Remove a (forward) edge from this CycleNode
 427  * @return The CycleNode which was popped, if one exists; otherwise NULL
 428  */
 429 CycleNode * CycleNode::removeEdge()
 430 {
 431         if (edges.empty())
 432                 return NULL;
 433
 434         CycleNode *ret = edges.back();
 435         edges.pop_back();
 436         vector_remove_node(ret->back_edges, this);
 437         return ret;
 438 }
 439
 440 /**
 441  * @brief Remove a (back) edge from this CycleNode
 442  * @return The CycleNode which was popped, if one exists; otherwise NULL
 443  */
 444 CycleNode * CycleNode::removeBackEdge()
 445 {
 446         if (back_edges.empty())
 447                 return NULL;
 448
 449         CycleNode *ret = back_edges.back();
 450         back_edges.pop_back();
 451         vector_remove_node(ret->edges, this);
 452         return ret;
 453 }
 454
 455 /**
 456  * Adds an edge from this CycleNode to another CycleNode.
 457  * @param node The node to which we add a directed edge
 458  * @return True if this edge is a new edge; false otherwise
 459  */
 460 bool CycleNode::addEdge(CycleNode *node)
 461 {
 462         for (unsigned int i = 0; i < edges.size(); i++)
 463                 if (edges[i] == node)
 464                         return false;
 465         edges.push_back(node);
 466         node->back_edges.push_back(this);
 467         return true;
 468 }
 469
 470 /** @returns the RMW CycleNode that reads from the current CycleNode */
 471 CycleNode * CycleNode::getRMW() const
 472 {
 473         return hasRMW;
 474 }
 475
 476 /**
 477  * Set a RMW action node that reads from the current CycleNode.
 478  * @param node The RMW that reads from the current node
 479  * @return True, if this node already was read by another RMW; false otherwise
 480  * @see CycleGraph::addRMWEdge
 481  */
 482 bool CycleNode::setRMW(CycleNode *node)
 483 {
 484         if (hasRMW != NULL)
 485                 return true;
 486         hasRMW = node;
 487         return false;
 488 }
 489
 490 /**
 491  * Convert a Promise CycleNode into a concrete-valued CycleNode. Should only be
 492  * used when there's no existing ModelAction CycleNode for this write.
 493  *
 494  * @param writer The ModelAction which wrote the future value represented by
 495  * this CycleNode
 496  */
 497 void CycleNode::resolvePromise(const ModelAction *writer)
 498 {
 499         ASSERT(is_promise());
 500         ASSERT(promise->is_compatible(writer));
 501         action = writer;
 502         promise = NULL;
 503         ASSERT(!is_promise());
 504 }