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