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