nodestack.cc

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