2 #define __STDC_FORMAT_MACROS
7 #include "clockvector.h"
9 #include "threads-model.h"
10 #include "nodestack.h"
12 #define ACTION_INITIAL_CLOCK 0
14 /** A special value to represent a successful trylock */
15 #define VALUE_TRYSUCCESS 1
17 /** A special value to represent a failed trylock */
18 #define VALUE_TRYFAILED 0
21 * @brief Construct a new ModelAction
23 * @param type The type of action
24 * @param order The memory order of this action. A "don't care" for non-ATOMIC
25 * actions (e.g., THREAD_* or MODEL_* actions).
26 * @param loc The location that this action acts upon
27 * @param value (optional) A value associated with the action (e.g., the value
28 * read or written). Defaults to a given macro constant, for debugging purposes.
29 * @param thread (optional) The Thread in which this action occurred. If NULL
30 * (default), then a Thread is assigned according to the scheduler.
32 ModelAction::ModelAction(action_type_t type, memory_order order, void *loc,
33 uint64_t value, Thread *thread) :
39 reads_from_promise(NULL),
40 last_fence_release(NULL),
42 seq_number(ACTION_INITIAL_CLOCK),
46 /* References to NULL atomic variables can end up here */
47 ASSERT(loc || type == ATOMIC_FENCE || type == MODEL_FIXUP_RELSEQ);
49 Thread *t = thread ? thread : thread_current();
50 this->tid = t->get_id();
53 /** @brief ModelAction destructor */
54 ModelAction::~ModelAction()
57 * We can't free the clock vector:
58 * Clock vectors are snapshotting state. When we delete model actions,
59 * they are at the end of the node list and have invalid old clock
60 * vectors which have already been rolled back to an unallocated state.
68 void ModelAction::copy_from_new(ModelAction *newaction)
70 seq_number = newaction->seq_number;
73 void ModelAction::set_seq_number(modelclock_t num)
75 /* ATOMIC_UNINIT actions should never have non-zero clock */
76 ASSERT(!is_uninitialized());
77 ASSERT(seq_number == ACTION_INITIAL_CLOCK);
81 bool ModelAction::is_thread_start() const
83 return type == THREAD_START;
86 bool ModelAction::is_thread_join() const
88 return type == THREAD_JOIN;
91 bool ModelAction::is_relseq_fixup() const
93 return type == MODEL_FIXUP_RELSEQ;
96 bool ModelAction::is_mutex_op() const
98 return type == ATOMIC_LOCK || type == ATOMIC_TRYLOCK || type == ATOMIC_UNLOCK || type == ATOMIC_WAIT || type == ATOMIC_NOTIFY_ONE || type == ATOMIC_NOTIFY_ALL;
101 bool ModelAction::is_lock() const
103 return type == ATOMIC_LOCK;
106 bool ModelAction::is_wait() const {
107 return type == ATOMIC_WAIT;
110 bool ModelAction::is_notify() const {
111 return type == ATOMIC_NOTIFY_ONE || type == ATOMIC_NOTIFY_ALL;
114 bool ModelAction::is_notify_one() const {
115 return type == ATOMIC_NOTIFY_ONE;
118 bool ModelAction::is_unlock() const
120 return type == ATOMIC_UNLOCK;
123 bool ModelAction::is_trylock() const
125 return type == ATOMIC_TRYLOCK;
128 bool ModelAction::is_success_lock() const
130 return type == ATOMIC_LOCK || (type == ATOMIC_TRYLOCK && value == VALUE_TRYSUCCESS);
133 bool ModelAction::is_failed_trylock() const
135 return (type == ATOMIC_TRYLOCK && value == VALUE_TRYFAILED);
138 /** @return True if this operation is performed on a C/C++ atomic variable */
139 bool ModelAction::is_atomic_var() const
141 return is_read() || could_be_write();
144 bool ModelAction::is_uninitialized() const
146 return type == ATOMIC_UNINIT;
149 bool ModelAction::is_read() const
151 return type == ATOMIC_READ || type == ATOMIC_RMWR || type == ATOMIC_RMW;
154 bool ModelAction::is_write() const
156 return type == ATOMIC_WRITE || type == ATOMIC_RMW || type == ATOMIC_INIT || type == ATOMIC_UNINIT;
159 bool ModelAction::could_be_write() const
161 return is_write() || is_rmwr();
164 bool ModelAction::is_yield() const
166 return type == THREAD_YIELD;
169 bool ModelAction::is_rmwr() const
171 return type == ATOMIC_RMWR;
174 bool ModelAction::is_rmw() const
176 return type == ATOMIC_RMW;
179 bool ModelAction::is_rmwc() const
181 return type == ATOMIC_RMWC;
184 bool ModelAction::is_fence() const
186 return type == ATOMIC_FENCE;
189 bool ModelAction::is_initialization() const
191 return type == ATOMIC_INIT;
194 bool ModelAction::is_relaxed() const
196 return order == std::memory_order_relaxed;
199 bool ModelAction::is_acquire() const
202 case std::memory_order_acquire:
203 case std::memory_order_acq_rel:
204 case std::memory_order_seq_cst:
211 bool ModelAction::is_release() const
214 case std::memory_order_release:
215 case std::memory_order_acq_rel:
216 case std::memory_order_seq_cst:
223 bool ModelAction::is_seqcst() const
225 return order == std::memory_order_seq_cst;
228 bool ModelAction::same_var(const ModelAction *act) const
230 if (act->is_wait() || is_wait()) {
231 if (act->is_wait() && is_wait()) {
232 if (((void *)value) == ((void *)act->value))
234 } else if (is_wait()) {
235 if (((void *)value) == act->location)
237 } else if (act->is_wait()) {
238 if (location == ((void *)act->value))
243 return location == act->location;
246 bool ModelAction::same_thread(const ModelAction *act) const
248 return tid == act->tid;
251 void ModelAction::copy_typeandorder(ModelAction * act)
253 this->type = act->type;
254 this->order = act->order;
258 * Get the Thread which is the operand of this action. This is only valid for
259 * THREAD_* operations (currently only for THREAD_CREATE and THREAD_JOIN). Note
260 * that this provides a central place for determining the conventions of Thread
261 * storage in ModelAction, where we generally aren't very type-safe (e.g., we
262 * store object references in a (void *) address.
264 * For THREAD_CREATE, this yields the Thread which is created.
265 * For THREAD_JOIN, this yields the Thread we are joining with.
267 * @return The Thread which this action acts on, if exists; otherwise NULL
269 Thread * ModelAction::get_thread_operand() const
271 if (type == THREAD_CREATE) {
272 /* THREAD_CREATE stores its (Thread *) in a thrd_t::priv */
273 thrd_t *thrd = (thrd_t *)get_location();
275 } else if (type == THREAD_JOIN)
276 /* THREAD_JOIN uses (Thread *) for location */
277 return (Thread *)get_location();
282 /** This method changes an existing read part of an RMW action into either:
283 * (1) a full RMW action in case of the completed write or
284 * (2) a READ action in case a failed action.
285 * @todo If the memory_order changes, we may potentially need to update our
288 void ModelAction::process_rmw(ModelAction *act)
290 this->order = act->order;
292 this->type = ATOMIC_READ;
293 else if (act->is_rmw()) {
294 this->type = ATOMIC_RMW;
295 this->value = act->value;
299 /** The is_synchronizing method should only explore interleavings if:
300 * (1) the operations are seq_cst and don't commute or
301 * (2) the reordering may establish or break a synchronization relation.
302 * Other memory operations will be dealt with by using the reads_from
305 * @param act is the action to consider exploring a reordering.
306 * @return tells whether we have to explore a reordering.
308 bool ModelAction::could_synchronize_with(const ModelAction *act) const
310 // Same thread can't be reordered
311 if (same_thread(act))
314 // Different locations commute
318 // Explore interleavings of seqcst writes/fences to guarantee total
319 // order of seq_cst operations that don't commute
320 if ((could_be_write() || act->could_be_write() || is_fence() || act->is_fence()) && is_seqcst() && act->is_seqcst())
323 // Explore synchronizing read/write pairs
324 if (is_acquire() && act->is_release() && is_read() && act->could_be_write())
327 // lock just released...we can grab lock
328 if ((is_lock() || is_trylock()) && (act->is_unlock() || act->is_wait()))
331 // lock just acquired...we can fail to grab lock
332 if (is_trylock() && act->is_success_lock())
335 // other thread stalling on lock...we can release lock
336 if (is_unlock() && (act->is_trylock() || act->is_lock()))
339 if (is_trylock() && (act->is_unlock() || act->is_wait()))
342 if (is_notify() && act->is_wait())
345 if (is_wait() && act->is_notify())
348 // Otherwise handle by reads_from relation
352 bool ModelAction::is_conflicting_lock(const ModelAction *act) const
354 // Must be different threads to reorder
355 if (same_thread(act))
358 // Try to reorder a lock past a successful lock
359 if (act->is_success_lock())
362 // Try to push a successful trylock past an unlock
363 if (act->is_unlock() && is_trylock() && value == VALUE_TRYSUCCESS)
366 // Try to push a successful trylock past a wait
367 if (act->is_wait() && is_trylock() && value == VALUE_TRYSUCCESS)
374 * Create a new clock vector for this action. Note that this function allows a
375 * user to clobber (and leak) a ModelAction's existing clock vector. A user
376 * should ensure that the vector has already either been rolled back
377 * (effectively "freed") or freed.
379 * @param parent A ModelAction from which to inherit a ClockVector
381 void ModelAction::create_cv(const ModelAction *parent)
384 cv = new ClockVector(parent->cv, this);
386 cv = new ClockVector(NULL, this);
389 void ModelAction::set_try_lock(bool obtainedlock)
391 value = obtainedlock ? VALUE_TRYSUCCESS : VALUE_TRYFAILED;
395 * @brief Get the value read by this load
397 * We differentiate this function from ModelAction::get_write_value and
398 * ModelAction::get_value for the purpose of RMW's, which may have both a
399 * 'read' and a 'write' value.
401 * Note: 'this' must be a load.
403 * @return The value read by this load
405 uint64_t ModelAction::get_reads_from_value() const
409 return reads_from->get_write_value();
410 else if (reads_from_promise)
411 return reads_from_promise->get_value();
412 return VALUE_NONE; /* Only for new actions with no reads-from */
416 * @brief Get the value written by this store
418 * We differentiate this function from ModelAction::get_reads_from_value and
419 * ModelAction::get_value for the purpose of RMW's, which may have both a
420 * 'read' and a 'write' value.
422 * Note: 'this' must be a store.
424 * @return The value written by this store
426 uint64_t ModelAction::get_write_value() const
433 * @brief Get the value returned by this action
435 * For atomic reads (including RMW), an operation returns the value it read.
436 * For atomic writes, an operation returns the value it wrote. For other
437 * operations, the return value varies (sometimes is a "don't care"), but the
438 * value is simply stored in the "value" field.
440 * @return This action's return value
442 uint64_t ModelAction::get_return_value() const
445 return get_reads_from_value();
447 return get_write_value();
452 /** @return The Node associated with this ModelAction */
453 Node * ModelAction::get_node() const
455 /* UNINIT actions do not have a Node */
456 ASSERT(!is_uninitialized());
461 * Update the model action's read_from action
462 * @param act The action to read from; should be a write
464 void ModelAction::set_read_from(const ModelAction *act)
468 reads_from_promise = NULL;
469 if (act->is_uninitialized())
470 model->assert_bug("May read from uninitialized atomic\n");
474 * Set this action's read-from promise
475 * @param promise The promise to read from
477 void ModelAction::set_read_from_promise(Promise *promise)
480 reads_from_promise = promise;
485 * Synchronize the current thread with the thread corresponding to the
486 * ModelAction parameter.
487 * @param act The ModelAction to synchronize with
488 * @return True if this is a valid synchronization; false otherwise
490 bool ModelAction::synchronize_with(const ModelAction *act)
492 if (*this < *act && type != THREAD_JOIN && type != ATOMIC_LOCK)
494 model->check_promises(act->get_tid(), cv, act->cv);
499 bool ModelAction::has_synchronized_with(const ModelAction *act) const
501 return cv->synchronized_since(act);
505 * Check whether 'this' happens before act, according to the memory-model's
506 * happens before relation. This is checked via the ClockVector constructs.
507 * @return true if this action's thread has synchronized with act's thread
508 * since the execution of act, false otherwise.
510 bool ModelAction::happens_before(const ModelAction *act) const
512 return act->cv->synchronized_since(this);
515 /** @brief Print nicely-formatted info about this ModelAction */
516 void ModelAction::print() const
518 const char *type_str, *mo_str;
519 switch (this->type) {
520 case MODEL_FIXUP_RELSEQ:
521 type_str = "relseq fixup";
524 type_str = "thread create";
527 type_str = "thread start";
530 type_str = "thread yield";
533 type_str = "thread join";
536 type_str = "thread finish";
539 type_str = "uninitialized";
542 type_str = "atomic read";
545 type_str = "atomic write";
548 type_str = "atomic rmw";
554 type_str = "atomic rmwr";
557 type_str = "atomic rmwc";
560 type_str = "init atomic";
569 type_str = "trylock";
574 case ATOMIC_NOTIFY_ONE:
575 type_str = "notify one";
577 case ATOMIC_NOTIFY_ALL:
578 type_str = "notify all";
581 type_str = "unknown type";
584 switch (this->order) {
585 case std::memory_order_relaxed:
588 case std::memory_order_acquire:
591 case std::memory_order_release:
594 case std::memory_order_acq_rel:
597 case std::memory_order_seq_cst:
605 model_print("(%4d) Thread: %-2d Action: %-13s MO: %7s Loc: %14p Value: %-#18" PRIx64,
606 seq_number, id_to_int(tid), type_str, mo_str, location, get_return_value());
609 model_print(" Rf: %-3d", reads_from->get_seq_number());
610 else if (reads_from_promise) {
611 int idx = model->get_promise_number(reads_from_promise);
613 model_print(" Rf: P%-2d", idx);
615 model_print(" Rf: P? ");
617 model_print(" Rf: ? ");
629 /** @brief Get a (likely) unique hash for this ModelAction */
630 unsigned int ModelAction::hash() const
632 unsigned int hash = (unsigned int)this->type;
633 hash ^= ((unsigned int)this->order) << 3;
634 hash ^= seq_number << 5;
635 hash ^= id_to_int(tid) << 6;
639 hash ^= reads_from->get_seq_number();
640 else if (reads_from_promise)
641 hash ^= model->get_promise_number(reads_from_promise);
642 hash ^= get_reads_from_value();
648 * @brief Checks the NodeStack to see if a ModelAction is in our may-read-from set
649 * @param write The ModelAction to check for
650 * @return True if the ModelAction is found; false otherwise
652 bool ModelAction::may_read_from(const ModelAction *write) const
654 for (int i = 0; i < node->get_read_from_past_size(); i++)
655 if (node->get_read_from_past(i) == write)
661 * @brief Checks the NodeStack to see if a Promise is in our may-read-from set
662 * @param promise The Promise to check for
663 * @return True if the Promise is found; false otherwise
665 bool ModelAction::may_read_from(const Promise *promise) const
667 for (int i = 0; i < node->get_read_from_promise_size(); i++)
668 if (node->get_read_from_promise(i) == promise)
674 * Only valid for LOCK, TRY_LOCK, UNLOCK, and WAIT operations.
675 * @return The mutex operated on by this action, if any; otherwise NULL
677 std::mutex * ModelAction::get_mutex() const
679 if (is_trylock() || is_lock() || is_unlock())
680 return (std::mutex *)get_location();
682 return (std::mutex *)get_value();