action.cc

   1 #include <stdio.h>
   2 #define __STDC_FORMAT_MACROS
   3 #include <inttypes.h>
   4 #include <vector>
   5
   6 #include "model.h"
   7 #include "action.h"
   8 #include "clockvector.h"
   9 #include "common.h"
  10 #include "threads-model.h"
  11 #include "nodestack.h"
  12
  13 #define ACTION_INITIAL_CLOCK 0
  14
  15 /**
  16  * @brief Construct a new ModelAction
  17  *
  18  * @param type The type of action
  19  * @param order The memory order of this action. A "don't care" for non-ATOMIC
  20  * actions (e.g., THREAD_* or MODEL_* actions).
  21  * @param loc The location that this action acts upon
  22  * @param value (optional) A value associated with the action (e.g., the value
  23  * read or written). Defaults to a given macro constant, for debugging purposes.
  24  * @param thread (optional) The Thread in which this action occurred. If NULL
  25  * (default), then a Thread is assigned according to the scheduler.
  26  */
  27 ModelAction::ModelAction(action_type_t type, memory_order order, void *loc,
  28                 uint64_t value, Thread *thread) :
  29         type(type),
  30         order(order),
  31         location(loc),
  32         value(value),
  33         reads_from(NULL),
  34         node(NULL),
  35         seq_number(ACTION_INITIAL_CLOCK),
  36         cv(NULL),
  37         sleep_flag(false)
  38 {
  39         /* References to NULL atomic variables can end up here */
  40         ASSERT(loc || type == MODEL_FIXUP_RELSEQ);
  41
  42         Thread *t = thread ? thread : thread_current();
  43         this->tid = t->get_id();
  44 }
  45
  46 /** @brief ModelAction destructor */
  47 ModelAction::~ModelAction()
  48 {
  49         /**
  50          * We can't free the clock vector:
  51          * Clock vectors are snapshotting state. When we delete model actions,
  52          * they are at the end of the node list and have invalid old clock
  53          * vectors which have already been rolled back to an unallocated state.
  54          */
  55
  56         /*
  57          if (cv)
  58                 delete cv; */
  59 }
  60
  61 void ModelAction::copy_from_new(ModelAction *newaction)
  62 {
  63         seq_number = newaction->seq_number;
  64 }
  65
  66 void ModelAction::set_seq_number(modelclock_t num)
  67 {
  68         ASSERT(seq_number == ACTION_INITIAL_CLOCK);
  69         seq_number = num;
  70 }
  71
  72 bool ModelAction::is_relseq_fixup() const
  73 {
  74         return type == MODEL_FIXUP_RELSEQ;
  75 }
  76
  77 bool ModelAction::is_mutex_op() const
  78 {
  79         return type == ATOMIC_LOCK || type == ATOMIC_TRYLOCK || type == ATOMIC_UNLOCK || type == ATOMIC_WAIT || type == ATOMIC_NOTIFY_ONE || type == ATOMIC_NOTIFY_ALL;
  80 }
  81
  82 bool ModelAction::is_lock() const
  83 {
  84         return type == ATOMIC_LOCK;
  85 }
  86
  87 bool ModelAction::is_wait() const {
  88         return type == ATOMIC_WAIT;
  89 }
  90
  91 bool ModelAction::is_notify() const {
  92         return type==ATOMIC_NOTIFY_ONE || type==ATOMIC_NOTIFY_ALL;
  93 }
  94
  95 bool ModelAction::is_notify_one() const {
  96         return type==ATOMIC_NOTIFY_ONE;
  97 }
  98
  99 bool ModelAction::is_unlock() const
 100 {
 101         return type == ATOMIC_UNLOCK;
 102 }
 103
 104 bool ModelAction::is_trylock() const
 105 {
 106         return type == ATOMIC_TRYLOCK;
 107 }
 108
 109 bool ModelAction::is_success_lock() const
 110 {
 111         return type == ATOMIC_LOCK || (type == ATOMIC_TRYLOCK && value == VALUE_TRYSUCCESS);
 112 }
 113
 114 bool ModelAction::is_failed_trylock() const
 115 {
 116         return (type == ATOMIC_TRYLOCK && value == VALUE_TRYFAILED);
 117 }
 118
 119 bool ModelAction::is_read() const
 120 {
 121         return type == ATOMIC_READ || type == ATOMIC_RMWR || type == ATOMIC_RMW;
 122 }
 123
 124 bool ModelAction::is_write() const
 125 {
 126         return type == ATOMIC_WRITE || type == ATOMIC_RMW || type == ATOMIC_INIT;
 127 }
 128
 129 bool ModelAction::could_be_write() const
 130 {
 131         return is_write() || is_rmwr();
 132 }
 133
 134 bool ModelAction::is_rmwr() const
 135 {
 136         return type == ATOMIC_RMWR;
 137 }
 138
 139 bool ModelAction::is_rmw() const
 140 {
 141         return type == ATOMIC_RMW;
 142 }
 143
 144 bool ModelAction::is_rmwc() const
 145 {
 146         return type == ATOMIC_RMWC;
 147 }
 148
 149 bool ModelAction::is_fence() const
 150 {
 151         return type == ATOMIC_FENCE;
 152 }
 153
 154 bool ModelAction::is_initialization() const
 155 {
 156         return type == ATOMIC_INIT;
 157 }
 158
 159 bool ModelAction::is_acquire() const
 160 {
 161         switch (order) {
 162         case std::memory_order_acquire:
 163         case std::memory_order_acq_rel:
 164         case std::memory_order_seq_cst:
 165                 return true;
 166         default:
 167                 return false;
 168         }
 169 }
 170
 171 bool ModelAction::is_release() const
 172 {
 173         switch (order) {
 174         case std::memory_order_release:
 175         case std::memory_order_acq_rel:
 176         case std::memory_order_seq_cst:
 177                 return true;
 178         default:
 179                 return false;
 180         }
 181 }
 182
 183 bool ModelAction::is_seqcst() const
 184 {
 185         return order==std::memory_order_seq_cst;
 186 }
 187
 188 bool ModelAction::same_var(const ModelAction *act) const
 189 {
 190         if ( act->is_wait() || is_wait() ) {
 191                 if ( act->is_wait() && is_wait() ) {
 192                         if ( ((void *)value) == ((void *)act->value) )
 193                                 return true;
 194                 } else if ( is_wait() ) {
 195                         if ( ((void *)value) == act->location )
 196                                 return true;
 197                 } else if ( act->is_wait() ) {
 198                         if ( location == ((void *)act->value) )
 199                                 return true;
 200                 }
 201         }
 202
 203         return location == act->location;
 204 }
 205
 206 bool ModelAction::same_thread(const ModelAction *act) const
 207 {
 208         return tid == act->tid;
 209 }
 210
 211 void ModelAction::copy_typeandorder(ModelAction * act) {
 212         this->type = act->type;
 213         this->order = act->order;
 214 }
 215
 216 /** This method changes an existing read part of an RMW action into either:
 217  *  (1) a full RMW action in case of the completed write or
 218  *  (2) a READ action in case a failed action.
 219  * @todo  If the memory_order changes, we may potentially need to update our
 220  * clock vector.
 221  */
 222 void ModelAction::process_rmw(ModelAction * act) {
 223         this->order=act->order;
 224         if (act->is_rmwc())
 225                 this->type=ATOMIC_READ;
 226         else if (act->is_rmw()) {
 227                 this->type=ATOMIC_RMW;
 228                 this->value=act->value;
 229         }
 230 }
 231
 232 /** The is_synchronizing method should only explore interleavings if:
 233  *  (1) the operations are seq_cst and don't commute or
 234  *  (2) the reordering may establish or break a synchronization relation.
 235  *  Other memory operations will be dealt with by using the reads_from
 236  *  relation.
 237  *
 238  *  @param act is the action to consider exploring a reordering.
 239  *  @return tells whether we have to explore a reordering.
 240  */
 241 bool ModelAction::could_synchronize_with(const ModelAction *act) const
 242 {
 243         //Same thread can't be reordered
 244         if (same_thread(act))
 245                 return false;
 246
 247         // Different locations commute
 248         if (!same_var(act))
 249                 return false;
 250
 251         // Explore interleavings of seqcst writes to guarantee total order
 252         // of seq_cst operations that don't commute
 253         if ((could_be_write() || act->could_be_write()) && is_seqcst() && act->is_seqcst())
 254                 return true;
 255
 256         // Explore synchronizing read/write pairs
 257         if (is_read() && is_acquire() && act->could_be_write() && act->is_release())
 258                 return true;
 259
 260         //lock just released...we can grab lock
 261         if ((is_lock() ||is_trylock()) && (act->is_unlock()||act->is_wait()))
 262                 return true;
 263
 264         //lock just acquired...we can fail to grab lock
 265         if (is_trylock() && act->is_success_lock())
 266                 return true;
 267
 268         //other thread stalling on lock...we can release lock
 269         if (is_unlock() && (act->is_trylock()||act->is_lock()))
 270                 return true;
 271
 272         if (is_trylock() && (act->is_unlock()||act->is_wait()))
 273                 return true;
 274
 275         if ( is_notify() && act->is_wait() )
 276                 return true;
 277
 278         if ( is_wait() && act->is_notify() )
 279                 return true;
 280
 281         // Otherwise handle by reads_from relation
 282         return false;
 283 }
 284
 285 bool ModelAction::is_conflicting_lock(const ModelAction *act) const
 286 {
 287         //Must be different threads to reorder
 288         if (same_thread(act))
 289                 return false;
 290
 291         //Try to reorder a lock past a successful lock
 292         if (act->is_success_lock())
 293                 return true;
 294
 295         //Try to push a successful trylock past an unlock
 296         if (act->is_unlock() && is_trylock() && value == VALUE_TRYSUCCESS)
 297                 return true;
 298
 299         //Try to push a successful trylock past a wait
 300         if (act->is_wait() && is_trylock() && value == VALUE_TRYSUCCESS)
 301                 return true;
 302
 303         return false;
 304 }
 305
 306 /**
 307  * Create a new clock vector for this action. Note that this function allows a
 308  * user to clobber (and leak) a ModelAction's existing clock vector. A user
 309  * should ensure that the vector has already either been rolled back
 310  * (effectively "freed") or freed.
 311  *
 312  * @param parent A ModelAction from which to inherit a ClockVector
 313  */
 314 void ModelAction::create_cv(const ModelAction *parent)
 315 {
 316         if (parent)
 317                 cv = new ClockVector(parent->cv, this);
 318         else
 319                 cv = new ClockVector(NULL, this);
 320 }
 321
 322 void ModelAction::set_try_lock(bool obtainedlock) {
 323         if (obtainedlock)
 324                 value=VALUE_TRYSUCCESS;
 325         else
 326                 value=VALUE_TRYFAILED;
 327 }
 328
 329 /**
 330  * Update the model action's read_from action
 331  * @param act The action to read from; should be a write
 332  * @return True if this read established synchronization
 333  */
 334 bool ModelAction::read_from(const ModelAction *act)
 335 {
 336         ASSERT(cv);
 337         reads_from = act;
 338         if (act != NULL && this->is_acquire()) {
 339                 rel_heads_list_t release_heads;
 340                 model->get_release_seq_heads(this, &release_heads);
 341                 int num_heads = release_heads.size();
 342                 for (unsigned int i = 0; i < release_heads.size(); i++)
 343                         if (!synchronize_with(release_heads[i])) {
 344                                 model->set_bad_synchronization();
 345                                 num_heads--;
 346                         }
 347                 return num_heads > 0;
 348         }
 349         return false;
 350 }
 351
 352 /**
 353  * Synchronize the current thread with the thread corresponding to the
 354  * ModelAction parameter.
 355  * @param act The ModelAction to synchronize with
 356  * @return True if this is a valid synchronization; false otherwise
 357  */
 358 bool ModelAction::synchronize_with(const ModelAction *act) {
 359         if (*this < *act && type != THREAD_JOIN && type != ATOMIC_LOCK)
 360                 return false;
 361         model->check_promises(act->get_tid(), cv, act->cv);
 362         cv->merge(act->cv);
 363         return true;
 364 }
 365
 366 bool ModelAction::has_synchronized_with(const ModelAction *act) const
 367 {
 368         return cv->synchronized_since(act);
 369 }
 370
 371 /**
 372  * Check whether 'this' happens before act, according to the memory-model's
 373  * happens before relation. This is checked via the ClockVector constructs.
 374  * @return true if this action's thread has synchronized with act's thread
 375  * since the execution of act, false otherwise.
 376  */
 377 bool ModelAction::happens_before(const ModelAction *act) const
 378 {
 379         return act->cv->synchronized_since(this);
 380 }
 381
 382 /** @brief Print nicely-formatted info about this ModelAction */
 383 void ModelAction::print() const
 384 {
 385         const char *type_str, *mo_str;
 386         switch (this->type) {
 387         case MODEL_FIXUP_RELSEQ:
 388                 type_str = "relseq fixup";
 389                 break;
 390         case THREAD_CREATE:
 391                 type_str = "thread create";
 392                 break;
 393         case THREAD_START:
 394                 type_str = "thread start";
 395                 break;
 396         case THREAD_YIELD:
 397                 type_str = "thread yield";
 398                 break;
 399         case THREAD_JOIN:
 400                 type_str = "thread join";
 401                 break;
 402         case THREAD_FINISH:
 403                 type_str = "thread finish";
 404                 break;
 405         case ATOMIC_READ:
 406                 type_str = "atomic read";
 407                 break;
 408         case ATOMIC_WRITE:
 409                 type_str = "atomic write";
 410                 break;
 411         case ATOMIC_RMW:
 412                 type_str = "atomic rmw";
 413                 break;
 414         case ATOMIC_FENCE:
 415                 type_str = "fence";
 416                 break;
 417         case ATOMIC_RMWR:
 418                 type_str = "atomic rmwr";
 419                 break;
 420         case ATOMIC_RMWC:
 421                 type_str = "atomic rmwc";
 422                 break;
 423         case ATOMIC_INIT:
 424                 type_str = "init atomic";
 425                 break;
 426         case ATOMIC_LOCK:
 427                 type_str = "lock";
 428                 break;
 429         case ATOMIC_UNLOCK:
 430                 type_str = "unlock";
 431                 break;
 432         case ATOMIC_TRYLOCK:
 433                 type_str = "trylock";
 434                 break;
 435         case ATOMIC_WAIT:
 436                 type_str = "wait";
 437                 break;
 438         case ATOMIC_NOTIFY_ONE:
 439                 type_str = "notify one";
 440                 break;
 441         case ATOMIC_NOTIFY_ALL:
 442                 type_str = "notify all";
 443                 break;
 444         default:
 445                 type_str = "unknown type";
 446         }
 447
 448         uint64_t valuetoprint=type==ATOMIC_READ?(reads_from!=NULL?reads_from->value:VALUE_NONE):value;
 449
 450         switch (this->order) {
 451         case std::memory_order_relaxed:
 452                 mo_str = "relaxed";
 453                 break;
 454         case std::memory_order_acquire:
 455                 mo_str = "acquire";
 456                 break;
 457         case std::memory_order_release:
 458                 mo_str = "release";
 459                 break;
 460         case std::memory_order_acq_rel:
 461                 mo_str = "acq_rel";
 462                 break;
 463         case std::memory_order_seq_cst:
 464                 mo_str = "seq_cst";
 465                 break;
 466         default:
 467                 mo_str = "unknown";
 468                 break;
 469         }
 470
 471         model_print("(%4d) Thread: %-2d   Action: %-13s   MO: %7s  Loc: %14p   Value: %-#18" PRIx64,
 472                         seq_number, id_to_int(tid), type_str, mo_str, location, valuetoprint);
 473         if (is_read()) {
 474                 if (reads_from)
 475                         model_print("  Rf: %-3d", reads_from->get_seq_number());
 476                 else
 477                         model_print("  Rf: ?  ");
 478         }
 479         if (cv) {
 480                 if (is_read())
 481                         model_print(" ");
 482                 else
 483                         model_print("          ");
 484                 cv->print();
 485         } else
 486                 model_print("\n");
 487 }
 488
 489 /** @brief Print nicely-formatted info about this ModelAction */
 490 unsigned int ModelAction::hash() const
 491 {
 492         unsigned int hash=(unsigned int) this->type;
 493         hash^=((unsigned int)this->order)<<3;
 494         hash^=seq_number<<5;
 495         hash ^= id_to_int(tid) << 6;
 496
 497         if (is_read()) {
 498                 if (reads_from)
 499                         hash^=reads_from->get_seq_number();
 500         }
 501         return hash;
 502 }