2 #define __STDC_FORMAT_MACROS
8 #include "clockvector.h"
10 #include "threads-model.h"
11 #include "nodestack.h"
13 #define ACTION_INITIAL_CLOCK 0
16 * @brief Construct a new ModelAction
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.
27 ModelAction::ModelAction(action_type_t type, memory_order order, void *loc,
28 uint64_t value, Thread *thread) :
35 seq_number(ACTION_INITIAL_CLOCK),
39 /* References to NULL atomic variables can end up here */
40 ASSERT(loc || type == MODEL_FIXUP_RELSEQ);
42 Thread *t = thread ? thread : thread_current();
43 this->tid = t->get_id();
46 /** @brief ModelAction destructor */
47 ModelAction::~ModelAction()
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.
61 void ModelAction::copy_from_new(ModelAction *newaction)
63 seq_number = newaction->seq_number;
66 void ModelAction::set_seq_number(modelclock_t num)
68 ASSERT(seq_number == ACTION_INITIAL_CLOCK);
72 bool ModelAction::is_relseq_fixup() const
74 return type == MODEL_FIXUP_RELSEQ;
77 bool ModelAction::is_mutex_op() const
79 return type == ATOMIC_LOCK || type == ATOMIC_TRYLOCK || type == ATOMIC_UNLOCK || type == ATOMIC_WAIT || type == ATOMIC_NOTIFY_ONE || type == ATOMIC_NOTIFY_ALL;
82 bool ModelAction::is_lock() const
84 return type == ATOMIC_LOCK;
87 bool ModelAction::is_wait() const {
88 return type == ATOMIC_WAIT;
91 bool ModelAction::is_notify() const {
92 return type==ATOMIC_NOTIFY_ONE || type==ATOMIC_NOTIFY_ALL;
95 bool ModelAction::is_notify_one() const {
96 return type==ATOMIC_NOTIFY_ONE;
99 bool ModelAction::is_unlock() const
101 return type == ATOMIC_UNLOCK;
104 bool ModelAction::is_trylock() const
106 return type == ATOMIC_TRYLOCK;
109 bool ModelAction::is_success_lock() const
111 return type == ATOMIC_LOCK || (type == ATOMIC_TRYLOCK && value == VALUE_TRYSUCCESS);
114 bool ModelAction::is_failed_trylock() const
116 return (type == ATOMIC_TRYLOCK && value == VALUE_TRYFAILED);
119 bool ModelAction::is_read() const
121 return type == ATOMIC_READ || type == ATOMIC_RMWR || type == ATOMIC_RMW;
124 bool ModelAction::is_write() const
126 return type == ATOMIC_WRITE || type == ATOMIC_RMW || type == ATOMIC_INIT;
129 bool ModelAction::could_be_write() const
131 return is_write() || is_rmwr();
134 bool ModelAction::is_rmwr() const
136 return type == ATOMIC_RMWR;
139 bool ModelAction::is_rmw() const
141 return type == ATOMIC_RMW;
144 bool ModelAction::is_rmwc() const
146 return type == ATOMIC_RMWC;
149 bool ModelAction::is_fence() const
151 return type == ATOMIC_FENCE;
154 bool ModelAction::is_initialization() const
156 return type == ATOMIC_INIT;
159 bool ModelAction::is_acquire() const
162 case std::memory_order_acquire:
163 case std::memory_order_acq_rel:
164 case std::memory_order_seq_cst:
171 bool ModelAction::is_release() const
174 case std::memory_order_release:
175 case std::memory_order_acq_rel:
176 case std::memory_order_seq_cst:
183 bool ModelAction::is_seqcst() const
185 return order==std::memory_order_seq_cst;
188 bool ModelAction::same_var(const ModelAction *act) const
190 if ( act->is_wait() || is_wait() ) {
191 if ( act->is_wait() && is_wait() ) {
192 if ( ((void *)value) == ((void *)act->value) )
194 } else if ( is_wait() ) {
195 if ( ((void *)value) == act->location )
197 } else if ( act->is_wait() ) {
198 if ( location == ((void *)act->value) )
203 return location == act->location;
206 bool ModelAction::same_thread(const ModelAction *act) const
208 return tid == act->tid;
211 void ModelAction::copy_typeandorder(ModelAction * act) {
212 this->type = act->type;
213 this->order = act->order;
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
222 void ModelAction::process_rmw(ModelAction * act) {
223 this->order=act->order;
225 this->type=ATOMIC_READ;
226 else if (act->is_rmw()) {
227 this->type=ATOMIC_RMW;
228 this->value=act->value;
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
238 * @param act is the action to consider exploring a reordering.
239 * @return tells whether we have to explore a reordering.
241 bool ModelAction::could_synchronize_with(const ModelAction *act) const
243 //Same thread can't be reordered
244 if (same_thread(act))
247 // Different locations commute
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())
256 // Explore synchronizing read/write pairs
257 if (is_read() && is_acquire() && act->could_be_write() && act->is_release())
260 //lock just released...we can grab lock
261 if ((is_lock() ||is_trylock()) && (act->is_unlock()||act->is_wait()))
264 //lock just acquired...we can fail to grab lock
265 if (is_trylock() && act->is_success_lock())
268 //other thread stalling on lock...we can release lock
269 if (is_unlock() && (act->is_trylock()||act->is_lock()))
272 if (is_trylock() && (act->is_unlock()||act->is_wait()))
275 if ( is_notify() && act->is_wait() )
278 if ( is_wait() && act->is_notify() )
281 // Otherwise handle by reads_from relation
285 bool ModelAction::is_conflicting_lock(const ModelAction *act) const
287 //Must be different threads to reorder
288 if (same_thread(act))
291 //Try to reorder a lock past a successful lock
292 if (act->is_success_lock())
295 //Try to push a successful trylock past an unlock
296 if (act->is_unlock() && is_trylock() && value == VALUE_TRYSUCCESS)
299 //Try to push a successful trylock past a wait
300 if (act->is_wait() && is_trylock() && value == VALUE_TRYSUCCESS)
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.
312 * @param parent A ModelAction from which to inherit a ClockVector
314 void ModelAction::create_cv(const ModelAction *parent)
317 cv = new ClockVector(parent->cv, this);
319 cv = new ClockVector(NULL, this);
322 void ModelAction::set_try_lock(bool obtainedlock) {
324 value=VALUE_TRYSUCCESS;
326 value=VALUE_TRYFAILED;
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
334 bool ModelAction::read_from(const ModelAction *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();
347 return num_heads > 0;
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
358 bool ModelAction::synchronize_with(const ModelAction *act) {
359 if (*this < *act && type != THREAD_JOIN && type != ATOMIC_LOCK)
361 model->check_promises(act->get_tid(), cv, act->cv);
366 bool ModelAction::has_synchronized_with(const ModelAction *act) const
368 return cv->synchronized_since(act);
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.
377 bool ModelAction::happens_before(const ModelAction *act) const
379 return act->cv->synchronized_since(this);
382 /** @brief Print nicely-formatted info about this ModelAction */
383 void ModelAction::print() const
385 const char *type_str, *mo_str;
386 switch (this->type) {
387 case MODEL_FIXUP_RELSEQ:
388 type_str = "relseq fixup";
391 type_str = "thread create";
394 type_str = "thread start";
397 type_str = "thread yield";
400 type_str = "thread join";
403 type_str = "thread finish";
406 type_str = "atomic read";
409 type_str = "atomic write";
412 type_str = "atomic rmw";
418 type_str = "atomic rmwr";
421 type_str = "atomic rmwc";
424 type_str = "init atomic";
433 type_str = "trylock";
438 case ATOMIC_NOTIFY_ONE:
439 type_str = "notify one";
441 case ATOMIC_NOTIFY_ALL:
442 type_str = "notify all";
445 type_str = "unknown type";
448 uint64_t valuetoprint=type==ATOMIC_READ?(reads_from!=NULL?reads_from->value:VALUE_NONE):value;
450 switch (this->order) {
451 case std::memory_order_relaxed:
454 case std::memory_order_acquire:
457 case std::memory_order_release:
460 case std::memory_order_acq_rel:
463 case std::memory_order_seq_cst:
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);
475 model_print(" Rf: %-3d", reads_from->get_seq_number());
477 model_print(" Rf: ? ");
489 /** @brief Print nicely-formatted info about this ModelAction */
490 unsigned int ModelAction::hash() const
492 unsigned int hash=(unsigned int) this->type;
493 hash^=((unsigned int)this->order)<<3;
495 hash ^= id_to_int(tid) << 6;
499 hash^=reads_from->get_seq_number();