nodestack.cc

   1 #define __STDC_FORMAT_MACROS
   2 #include <inttypes.h>
   3
   4 #include <string.h>
   5
   6 #include "nodestack.h"
   7 #include "action.h"
   8 #include "common.h"
   9 #include "model.h"
  10 #include "threads-model.h"
  11
  12 /**
  13  * @brief Node constructor
  14  *
  15  * Constructs a single Node for use in a NodeStack. Each Node is associated
  16  * with exactly one ModelAction (exception: the first Node should be created
  17  * as an empty stub, to represent the first thread "choice") and up to one
  18  * parent.
  19  *
  20  * @param act The ModelAction to associate with this Node. May be NULL.
  21  * @param par The parent Node in the NodeStack. May be NULL if there is no
  22  * parent.
  23  * @param nthreads The number of threads which exist at this point in the
  24  * execution trace.
  25  */
  26 Node::Node(ModelAction *act, Node *par, int nthreads, Node *prevfairness)
  27         : action(act),
  28         parent(par),
  29         num_threads(nthreads),
  30         explored_children(num_threads),
  31         backtrack(num_threads),
  32         fairness(num_threads),
  33         numBacktracks(0),
  34         enabled_array(NULL),
  35         may_read_from(),
  36         read_from_index(0),
  37         future_values(),
  38         future_index(-1),
  39         relseq_break_writes(),
  40         relseq_break_index(0),
  41         misc_index(0),
  42         misc_max(0)
  43 {
  44         ASSERT(act);
  45         act->set_node(this);
  46         int currtid = id_to_int(act->get_tid());
  47         int prevtid = prevfairness ? id_to_int(prevfairness->action->get_tid()) : 0;
  48
  49         if (model->params.fairwindow != 0) {
  50                 for (int i = 0; i < num_threads; i++) {
  51                         ASSERT(i < ((int)fairness.size()));
  52                         struct fairness_info *fi = &fairness[i];
  53                         struct fairness_info *prevfi = (parent && i < parent->get_num_threads()) ? &parent->fairness[i] : NULL;
  54                         if (prevfi) {
  55                                 *fi = *prevfi;
  56                         }
  57                         if (parent && parent->is_enabled(int_to_id(i))) {
  58                                 fi->enabled_count++;
  59                         }
  60                         if (i == currtid) {
  61                                 fi->turns++;
  62                                 fi->priority = false;
  63                         }
  64                         /* Do window processing */
  65                         if (prevfairness != NULL) {
  66                                 if (prevfairness->parent->is_enabled(int_to_id(i)))
  67                                         fi->enabled_count--;
  68                                 if (i == prevtid) {
  69                                         fi->turns--;
  70                                 }
  71                                 /* Need full window to start evaluating
  72                                  * conditions
  73                                  * If we meet the enabled count and have no
  74                                  * turns, give us priority */
  75                                 if ((fi->enabled_count >= model->params.enabledcount) &&
  76                                                 (fi->turns == 0))
  77                                         fi->priority = true;
  78                         }
  79                 }
  80         }
  81 }
  82
  83 /** @brief Node desctructor */
  84 Node::~Node()
  85 {
  86         delete action;
  87         if (enabled_array)
  88                 model_free(enabled_array);
  89 }
  90
  91 /** Prints debugging info for the ModelAction associated with this Node */
  92 void Node::print()
  93 {
  94         action->print();
  95         model_print("          backtrack: %s", backtrack_empty() ? "empty" : "non-empty ");
  96         for (int i = 0; i < (int)backtrack.size(); i++)
  97                 if (backtrack[i] == true)
  98                         model_print("[%d]", i);
  99         model_print("\n");
 100         model_print("          future values: %s", future_value_empty() ? "empty" : "non-empty ");
 101         for (int i = future_index + 1; i < (int)future_values.size(); i++)
 102                 model_print("[%#" PRIx64 "]", future_values[i].value);
 103         model_print("\n");
 104
 105         model_print("          read-from: %s", read_from_empty() ? "empty" : "non-empty ");
 106         for (int i = read_from_index + 1; i < (int)may_read_from.size(); i++)
 107                 model_print("[%d]", may_read_from[i]->get_seq_number());
 108         model_print("\n");
 109
 110         model_print("          promises: %s\n", promise_empty() ? "empty" : "non-empty");
 111         model_print("          misc: %s\n", misc_empty() ? "empty" : "non-empty");
 112         model_print("          rel seq break: %s\n", relseq_break_empty() ? "empty" : "non-empty");
 113 }
 114
 115 /** @brief Prints info about may_read_from set */
 116 void Node::print_may_read_from()
 117 {
 118         for (unsigned int i = 0; i < may_read_from.size(); i++)
 119                 may_read_from[i]->print();
 120 }
 121
 122 /**
 123  * Sets a promise to explore meeting with the given node.
 124  * @param i is the promise index.
 125  */
 126 void Node::set_promise(unsigned int i, bool is_rmw)
 127 {
 128         if (i >= promises.size())
 129                 promises.resize(i + 1, PROMISE_IGNORE);
 130         if (promises[i] == PROMISE_IGNORE) {
 131                 promises[i] = PROMISE_UNFULFILLED;
 132                 if (is_rmw)
 133                         promises[i] |= PROMISE_RMW;
 134         }
 135 }
 136
 137 /**
 138  * Looks up whether a given promise should be satisfied by this node.
 139  * @param i The promise index.
 140  * @return true if the promise should be satisfied by the given model action.
 141  */
 142 bool Node::get_promise(unsigned int i) const
 143 {
 144         return (i < promises.size()) && ((promises[i] & PROMISE_MASK) == PROMISE_FULFILLED);
 145 }
 146
 147 /**
 148  * Increments to the next combination of promises.
 149  * @return true if we have a valid combination.
 150  */
 151 bool Node::increment_promise()
 152 {
 153         DBG();
 154         unsigned int rmw_count = 0;
 155         for (unsigned int i = 0; i < promises.size(); i++) {
 156                 if (promises[i] == (PROMISE_RMW|PROMISE_FULFILLED))
 157                         rmw_count++;
 158         }
 159
 160         for (unsigned int i = 0; i < promises.size(); i++) {
 161                 if ((promises[i] & PROMISE_MASK) == PROMISE_UNFULFILLED) {
 162                         if ((rmw_count > 0) && (promises[i] & PROMISE_RMW)) {
 163                                 //sending our value to two rmws... not going to work..try next combination
 164                                 continue;
 165                         }
 166                         promises[i] = (promises[i] & PROMISE_RMW) |PROMISE_FULFILLED;
 167                         while (i > 0) {
 168                                 i--;
 169                                 if ((promises[i] & PROMISE_MASK) == PROMISE_FULFILLED)
 170                                         promises[i] = (promises[i] & PROMISE_RMW) | PROMISE_UNFULFILLED;
 171                         }
 172                         return true;
 173                 } else if (promises[i] == (PROMISE_RMW|PROMISE_FULFILLED)) {
 174                         rmw_count--;
 175                 }
 176         }
 177         return false;
 178 }
 179
 180 /**
 181  * Returns whether the promise set is empty.
 182  * @return true if we have explored all promise combinations.
 183  */
 184 bool Node::promise_empty() const
 185 {
 186         bool fulfilledrmw = false;
 187         for (int i = promises.size() - 1; i >= 0; i--) {
 188                 if (promises[i] == PROMISE_UNFULFILLED)
 189                         return false;
 190                 if (!fulfilledrmw && ((promises[i]&PROMISE_MASK) == PROMISE_UNFULFILLED))
 191                         return false;
 192                 if (promises[i] == (PROMISE_FULFILLED|PROMISE_RMW))
 193                         fulfilledrmw = true;
 194         }
 195         return true;
 196 }
 197
 198 void Node::set_misc_max(int i)
 199 {
 200         misc_max = i;
 201 }
 202
 203 int Node::get_misc() const
 204 {
 205         return misc_index;
 206 }
 207
 208 bool Node::increment_misc()
 209 {
 210         return (misc_index < misc_max) && ((++misc_index) < misc_max);
 211 }
 212
 213 bool Node::misc_empty() const
 214 {
 215         return (misc_index + 1) >= misc_max;
 216 }
 217
 218 /**
 219  * Adds a value from a weakly ordered future write to backtrack to. This
 220  * operation may "fail" if the future value has already been run (within some
 221  * sloppiness window of this expiration), or if the futurevalues set has
 222  * reached its maximum.
 223  * @see model_params.maxfuturevalues
 224  *
 225  * @param value is the value to backtrack to.
 226  * @return True if the future value was successully added; false otherwise
 227  */
 228 bool Node::add_future_value(uint64_t value, modelclock_t expiration)
 229 {
 230         int idx = -1; /* Highest index where value is found */
 231         for (unsigned int i = 0; i < future_values.size(); i++) {
 232                 if (future_values[i].value == value) {
 233                         if (expiration <= future_values[i].expiration)
 234                                 return false;
 235                         idx = i;
 236                 }
 237         }
 238         if (idx > future_index) {
 239                 /* Future value hasn't been explored; update expiration */
 240                 future_values[idx].expiration = expiration;
 241                 return true;
 242         } else if (idx >= 0 && expiration <= future_values[idx].expiration + model->params.expireslop) {
 243                 /* Future value has been explored and is within the "sloppy" window */
 244                 return false;
 245         }
 246
 247         /* Limit the size of the future-values set */
 248         if (model->params.maxfuturevalues > 0 &&
 249                         (int)future_values.size() >= model->params.maxfuturevalues)
 250                 return false;
 251
 252         struct future_value newfv = {value, expiration};
 253         future_values.push_back(newfv);
 254         return true;
 255 }
 256
 257 /**
 258  * Checks whether the future_values set for this node is empty.
 259  * @return true if the future_values set is empty.
 260  */
 261 bool Node::future_value_empty() const
 262 {
 263         return ((future_index + 1) >= ((int)future_values.size()));
 264 }
 265
 266 /**
 267  * Checks if the Thread associated with this thread ID has been explored from
 268  * this Node already.
 269  * @param tid is the thread ID to check
 270  * @return true if this thread choice has been explored already, false
 271  * otherwise
 272  */
 273 bool Node::has_been_explored(thread_id_t tid) const
 274 {
 275         int id = id_to_int(tid);
 276         return explored_children[id];
 277 }
 278
 279 /**
 280  * Checks if the backtracking set is empty.
 281  * @return true if the backtracking set is empty
 282  */
 283 bool Node::backtrack_empty() const
 284 {
 285         return (numBacktracks == 0);
 286 }
 287
 288 /**
 289  * Checks whether the readsfrom set for this node is empty.
 290  * @return true if the readsfrom set is empty.
 291  */
 292 bool Node::read_from_empty() const
 293 {
 294         return ((read_from_index + 1) >= may_read_from.size());
 295 }
 296
 297 /**
 298  * Mark the appropriate backtracking information for exploring a thread choice.
 299  * @param act The ModelAction to explore
 300  */
 301 void Node::explore_child(ModelAction *act, enabled_type_t *is_enabled)
 302 {
 303         if (!enabled_array)
 304                 enabled_array = (enabled_type_t *)model_malloc(sizeof(enabled_type_t) * num_threads);
 305         if (is_enabled != NULL)
 306                 memcpy(enabled_array, is_enabled, sizeof(enabled_type_t) * num_threads);
 307         else {
 308                 for (int i = 0; i < num_threads; i++)
 309                         enabled_array[i] = THREAD_DISABLED;
 310         }
 311
 312         explore(act->get_tid());
 313 }
 314
 315 /**
 316  * Records a backtracking reference for a thread choice within this Node.
 317  * Provides feedback as to whether this thread choice is already set for
 318  * backtracking.
 319  * @return false if the thread was already set to be backtracked, true
 320  * otherwise
 321  */
 322 bool Node::set_backtrack(thread_id_t id)
 323 {
 324         int i = id_to_int(id);
 325         ASSERT(i < ((int)backtrack.size()));
 326         if (backtrack[i])
 327                 return false;
 328         backtrack[i] = true;
 329         numBacktracks++;
 330         return true;
 331 }
 332
 333 thread_id_t Node::get_next_backtrack()
 334 {
 335         /** @todo Find next backtrack */
 336         unsigned int i;
 337         for (i = 0; i < backtrack.size(); i++)
 338                 if (backtrack[i] == true)
 339                         break;
 340         /* Backtrack set was empty? */
 341         ASSERT(i != backtrack.size());
 342
 343         backtrack[i] = false;
 344         numBacktracks--;
 345         return int_to_id(i);
 346 }
 347
 348 bool Node::is_enabled(Thread *t) const
 349 {
 350         int thread_id = id_to_int(t->get_id());
 351         return thread_id < num_threads && (enabled_array[thread_id] != THREAD_DISABLED);
 352 }
 353
 354 enabled_type_t Node::enabled_status(thread_id_t tid) const
 355 {
 356         int thread_id = id_to_int(tid);
 357         if (thread_id < num_threads)
 358                 return enabled_array[thread_id];
 359         else
 360                 return THREAD_DISABLED;
 361 }
 362
 363 bool Node::is_enabled(thread_id_t tid) const
 364 {
 365         int thread_id = id_to_int(tid);
 366         return thread_id < num_threads && (enabled_array[thread_id] != THREAD_DISABLED);
 367 }
 368
 369 bool Node::has_priority(thread_id_t tid) const
 370 {
 371         return fairness[id_to_int(tid)].priority;
 372 }
 373
 374 /**
 375  * Add an action to the may_read_from set.
 376  * @param act is the action to add
 377  */
 378 void Node::add_read_from(const ModelAction *act)
 379 {
 380         may_read_from.push_back(act);
 381 }
 382
 383 /**
 384  * Gets the next 'future_value' value from this Node. Only valid for a node
 385  * where this->action is a 'read'.
 386  * @return The first element in future_values
 387  */
 388 uint64_t Node::get_future_value() const
 389 {
 390         ASSERT(future_index >= 0 && future_index < ((int)future_values.size()));
 391         return future_values[future_index].value;
 392 }
 393
 394 modelclock_t Node::get_future_value_expiration() const
 395 {
 396         ASSERT(future_index >= 0 && future_index < ((int)future_values.size()));
 397         return future_values[future_index].expiration;
 398 }
 399
 400 int Node::get_read_from_size() const
 401 {
 402         return may_read_from.size();
 403 }
 404
 405 const ModelAction * Node::get_read_from_at(int i) const
 406 {
 407         return may_read_from[i];
 408 }
 409
 410 /**
 411  * Gets the next 'may_read_from' action from this Node. Only valid for a node
 412  * where this->action is a 'read'.
 413  * @return The first element in may_read_from
 414  */
 415 const ModelAction * Node::get_read_from() const
 416 {
 417         if (read_from_index < may_read_from.size())
 418                 return may_read_from[read_from_index];
 419         else
 420                 return NULL;
 421 }
 422
 423 /**
 424  * Increments the index into the readsfrom set to explore the next item.
 425  * @return Returns false if we have explored all items.
 426  */
 427 bool Node::increment_read_from()
 428 {
 429         DBG();
 430         promises.clear();
 431         if (read_from_index < may_read_from.size()) {
 432                 read_from_index++;
 433                 return read_from_index < may_read_from.size();
 434         }
 435         return false;
 436 }
 437
 438 /**
 439  * Increments the index into the future_values set to explore the next item.
 440  * @return Returns false if we have explored all values.
 441  */
 442 bool Node::increment_future_value()
 443 {
 444         DBG();
 445         promises.clear();
 446         if (future_index < ((int)future_values.size())) {
 447                 future_index++;
 448                 return (future_index < ((int)future_values.size()));
 449         }
 450         return false;
 451 }
 452
 453 /**
 454  * Add a write ModelAction to the set of writes that may break the release
 455  * sequence. This is used during replay exploration of pending release
 456  * sequences. This Node must correspond to a release sequence fixup action.
 457  *
 458  * @param write The write that may break the release sequence. NULL means we
 459  * allow the release sequence to synchronize.
 460  */
 461 void Node::add_relseq_break(const ModelAction *write)
 462 {
 463         relseq_break_writes.push_back(write);
 464 }
 465
 466 /**
 467  * Get the write that may break the current pending release sequence,
 468  * according to the replay / divergence pattern.
 469  *
 470  * @return A write that may break the release sequence. If NULL, that means
 471  * the release sequence should not be broken.
 472  */
 473 const ModelAction * Node::get_relseq_break() const
 474 {
 475         if (relseq_break_index < (int)relseq_break_writes.size())
 476                 return relseq_break_writes[relseq_break_index];
 477         else
 478                 return NULL;
 479 }
 480
 481 /**
 482  * Increments the index into the relseq_break_writes set to explore the next
 483  * item.
 484  * @return Returns false if we have explored all values.
 485  */
 486 bool Node::increment_relseq_break()
 487 {
 488         DBG();
 489         promises.clear();
 490         if (relseq_break_index < ((int)relseq_break_writes.size())) {
 491                 relseq_break_index++;
 492                 return (relseq_break_index < ((int)relseq_break_writes.size()));
 493         }
 494         return false;
 495 }
 496
 497 /**
 498  * @return True if all writes that may break the release sequence have been
 499  * explored
 500  */
 501 bool Node::relseq_break_empty() const
 502 {
 503         return ((relseq_break_index + 1) >= ((int)relseq_break_writes.size()));
 504 }
 505
 506 void Node::explore(thread_id_t tid)
 507 {
 508         int i = id_to_int(tid);
 509         ASSERT(i < ((int)backtrack.size()));
 510         if (backtrack[i]) {
 511                 backtrack[i] = false;
 512                 numBacktracks--;
 513         }
 514         explored_children[i] = true;
 515 }
 516
 517 NodeStack::NodeStack() :
 518         node_list(),
 519         head_idx(-1),
 520         total_nodes(0)
 521 {
 522         total_nodes++;
 523 }
 524
 525 NodeStack::~NodeStack()
 526 {
 527         for (unsigned int i = 0; i < node_list.size(); i++)
 528                 delete node_list[i];
 529 }
 530
 531 void NodeStack::print() const
 532 {
 533         model_print("............................................\n");
 534         model_print("NodeStack printing node_list:\n");
 535         for (unsigned int it = 0; it < node_list.size(); it++) {
 536                 if ((int)it == this->head_idx)
 537                         model_print("vvv following action is the current iterator vvv\n");
 538                 node_list[it]->print();
 539         }
 540         model_print("............................................\n");
 541 }
 542
 543 /** Note: The is_enabled set contains what actions were enabled when
 544  *  act was chosen. */
 545 ModelAction * NodeStack::explore_action(ModelAction *act, enabled_type_t *is_enabled)
 546 {
 547         DBG();
 548
 549         if ((head_idx + 1) < (int)node_list.size()) {
 550                 head_idx++;
 551                 return node_list[head_idx]->get_action();
 552         }
 553
 554         /* Record action */
 555         Node *head = get_head();
 556         Node *prevfairness = NULL;
 557         if (head) {
 558                 head->explore_child(act, is_enabled);
 559                 if (model->params.fairwindow != 0 && head_idx > (int)model->params.fairwindow)
 560                         prevfairness = node_list[head_idx - model->params.fairwindow];
 561         }
 562         node_list.push_back(new Node(act, head, model->get_num_threads(), prevfairness));
 563         total_nodes++;
 564         head_idx++;
 565         return NULL;
 566 }
 567
 568 /**
 569  * Empties the stack of all trailing nodes after a given position and calls the
 570  * destructor for each. This function is provided an offset which determines
 571  * how many nodes (relative to the current replay state) to save before popping
 572  * the stack.
 573  * @param numAhead gives the number of Nodes (including this Node) to skip over
 574  * before removing nodes.
 575  */
 576 void NodeStack::pop_restofstack(int numAhead)
 577 {
 578         /* Diverging from previous execution; clear out remainder of list */
 579         unsigned int it = head_idx + numAhead;
 580         for (unsigned int i = it; i < node_list.size(); i++)
 581                 delete node_list[i];
 582         node_list.resize(it);
 583 }
 584
 585 Node * NodeStack::get_head() const
 586 {
 587         if (node_list.empty() || head_idx < 0)
 588                 return NULL;
 589         return node_list[head_idx];
 590 }
 591
 592 Node * NodeStack::get_next() const
 593 {
 594         if (node_list.empty()) {
 595                 DEBUG("Empty\n");
 596                 return NULL;
 597         }
 598         unsigned int it = head_idx + 1;
 599         if (it == node_list.size()) {
 600                 DEBUG("At end\n");
 601                 return NULL;
 602         }
 603         return node_list[it];
 604 }
 605
 606 void NodeStack::reset_execution()
 607 {
 608         head_idx = -1;
 609 }