bug in fence support fixed
[model-checker.git] / action.cc
1 #include <stdio.h>
2 #define __STDC_FORMAT_MACROS
3 #include <inttypes.h>
4 #include <stdlib.h>
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 #include "wildcard.h"
13
14 #define ACTION_INITIAL_CLOCK 0
15
16 /** @brief A special value to represent a successful trylock */
17 #define VALUE_TRYSUCCESS 1
18
19 /** @brief A special value to represent a failed trylock */
20 #define VALUE_TRYFAILED 0
21
22 /**
23  * @brief Construct a new ModelAction
24  *
25  * @param type The type of action
26  * @param order The memory order of this action. A "don't care" for non-ATOMIC
27  * actions (e.g., THREAD_* or MODEL_* actions).
28  * @param loc The location that this action acts upon
29  * @param value (optional) A value associated with the action (e.g., the value
30  * read or written). Defaults to a given macro constant, for debugging purposes.
31  * @param thread (optional) The Thread in which this action occurred. If NULL
32  * (default), then a Thread is assigned according to the scheduler.
33  */
34 ModelAction::ModelAction(action_type_t type, memory_order order, void *loc,
35                 uint64_t value, Thread *thread) :
36         type(type),
37         order(order),
38         original_order(order),
39         location(loc),
40         value(value),
41         reads_from(NULL),
42         reads_from_promise(NULL),
43         last_fence_release(NULL),
44         node(NULL),
45         seq_number(ACTION_INITIAL_CLOCK),
46         cv(NULL),
47         sleep_flag(false)
48 {
49         /* References to NULL atomic variables can end up here */
50         ASSERT(loc || type == ATOMIC_FENCE || type == MODEL_FIXUP_RELSEQ);
51
52         Thread *t = thread ? thread : thread_current();
53         this->tid = t->get_id();
54 }
55
56 /** @brief ModelAction destructor */
57 ModelAction::~ModelAction()
58 {
59         /**
60          * We can't free the clock vector:
61          * Clock vectors are snapshotting state. When we delete model actions,
62          * they are at the end of the node list and have invalid old clock
63          * vectors which have already been rolled back to an unallocated state.
64          */
65
66         /*
67          if (cv)
68                 delete cv; */
69 }
70
71 void ModelAction::copy_from_new(ModelAction *newaction)
72 {
73         seq_number = newaction->seq_number;
74 }
75
76 void ModelAction::set_seq_number(modelclock_t num)
77 {
78         /* ATOMIC_UNINIT actions should never have non-zero clock */
79         ASSERT(!is_uninitialized());
80         ASSERT(seq_number == ACTION_INITIAL_CLOCK);
81         seq_number = num;
82 }
83
84 bool ModelAction::is_thread_start() const
85 {
86         return type == THREAD_START;
87 }
88
89 bool ModelAction::is_thread_join() const
90 {
91         return type == THREAD_JOIN;
92 }
93
94 bool ModelAction::is_relseq_fixup() const
95 {
96         return type == MODEL_FIXUP_RELSEQ;
97 }
98
99 bool ModelAction::is_mutex_op() const
100 {
101         return type == ATOMIC_LOCK || type == ATOMIC_TRYLOCK || type == ATOMIC_UNLOCK || type == ATOMIC_WAIT || type == ATOMIC_NOTIFY_ONE || type == ATOMIC_NOTIFY_ALL;
102 }
103
104 bool ModelAction::is_lock() const
105 {
106         return type == ATOMIC_LOCK;
107 }
108
109 bool ModelAction::is_wait() const {
110         return type == ATOMIC_WAIT;
111 }
112
113 bool ModelAction::is_notify() const {
114         return type == ATOMIC_NOTIFY_ONE || type == ATOMIC_NOTIFY_ALL;
115 }
116
117 bool ModelAction::is_notify_one() const {
118         return type == ATOMIC_NOTIFY_ONE;
119 }
120
121 bool ModelAction::is_unlock() const
122 {
123         return type == ATOMIC_UNLOCK;
124 }
125
126 bool ModelAction::is_trylock() const
127 {
128         return type == ATOMIC_TRYLOCK;
129 }
130
131 bool ModelAction::is_success_lock() const
132 {
133         return type == ATOMIC_LOCK || (type == ATOMIC_TRYLOCK && value == VALUE_TRYSUCCESS);
134 }
135
136 bool ModelAction::is_failed_trylock() const
137 {
138         return (type == ATOMIC_TRYLOCK && value == VALUE_TRYFAILED);
139 }
140
141 /** @return True if this operation is performed on a C/C++ atomic variable */
142 bool ModelAction::is_atomic_var() const
143 {
144         return is_read() || could_be_write();
145 }
146
147 bool ModelAction::is_uninitialized() const
148 {
149         return type == ATOMIC_UNINIT;
150 }
151
152 bool ModelAction::is_read() const
153 {
154         return type == ATOMIC_READ || type == ATOMIC_RMWR || type == ATOMIC_RMW;
155 }
156
157 bool ModelAction::is_write() const
158 {
159         return type == ATOMIC_WRITE || type == ATOMIC_RMW || type == ATOMIC_INIT || type == ATOMIC_UNINIT;
160 }
161
162 bool ModelAction::could_be_write() const
163 {
164         return is_write() || is_rmwr();
165 }
166
167 bool ModelAction::is_yield() const
168 {
169         return type == THREAD_YIELD;
170 }
171
172 bool ModelAction::is_rmwr() const
173 {
174         return type == ATOMIC_RMWR;
175 }
176
177 bool ModelAction::is_rmw() const
178 {
179         return type == ATOMIC_RMW;
180 }
181
182 bool ModelAction::is_rmwc() const
183 {
184         return type == ATOMIC_RMWC;
185 }
186
187 bool ModelAction::is_fence() const
188 {
189         return type == ATOMIC_FENCE;
190 }
191
192 bool ModelAction::is_initialization() const
193 {
194         return type == ATOMIC_INIT;
195 }
196
197 bool ModelAction::is_annotation() const
198 {
199         return type == ATOMIC_ANNOTATION;
200 }
201
202 bool ModelAction::is_relaxed() const
203 {
204         return order == std::memory_order_relaxed;
205 }
206
207 bool ModelAction::is_acquire() const
208 {
209         switch (order) {
210         case std::memory_order_acquire:
211         case std::memory_order_acq_rel:
212         case std::memory_order_seq_cst:
213                 return true;
214         default:
215                 return false;
216         }
217 }
218
219 bool ModelAction::is_release() const
220 {
221         switch (order) {
222         case std::memory_order_release:
223         case std::memory_order_acq_rel:
224         case std::memory_order_seq_cst:
225                 return true;
226         default:
227                 return false;
228         }
229 }
230
231 bool ModelAction::is_seqcst() const
232 {
233         return order == std::memory_order_seq_cst;
234 }
235
236 bool ModelAction::same_var(const ModelAction *act) const
237 {
238         if (act->is_wait() || is_wait()) {
239                 if (act->is_wait() && is_wait()) {
240                         if (((void *)value) == ((void *)act->value))
241                                 return true;
242                 } else if (is_wait()) {
243                         if (((void *)value) == act->location)
244                                 return true;
245                 } else if (act->is_wait()) {
246                         if (location == ((void *)act->value))
247                                 return true;
248                 }
249         }
250
251         return location == act->location;
252 }
253
254 bool ModelAction::same_thread(const ModelAction *act) const
255 {
256         return tid == act->tid;
257 }
258
259 void ModelAction::copy_typeandorder(ModelAction * act)
260 {
261         this->type = act->type;
262         this->order = act->order;
263 }
264
265 /**
266  * Get the Thread which is the operand of this action. This is only valid for
267  * THREAD_* operations (currently only for THREAD_CREATE and THREAD_JOIN). Note
268  * that this provides a central place for determining the conventions of Thread
269  * storage in ModelAction, where we generally aren't very type-safe (e.g., we
270  * store object references in a (void *) address.
271  *
272  * For THREAD_CREATE, this yields the Thread which is created.
273  * For THREAD_JOIN, this yields the Thread we are joining with.
274  *
275  * @return The Thread which this action acts on, if exists; otherwise NULL
276  */
277 Thread * ModelAction::get_thread_operand() const
278 {
279         if (type == THREAD_CREATE) {
280                 /* THREAD_CREATE stores its (Thread *) in a thrd_t::priv */
281                 thrd_t *thrd = (thrd_t *)get_location();
282                 return thrd->priv;
283         } else if (type == THREAD_JOIN)
284                 /* THREAD_JOIN uses (Thread *) for location */
285                 return (Thread *)get_location();
286         else
287                 return NULL;
288 }
289
290 /**
291  * @brief Convert the read portion of an RMW
292  *
293  * Changes an existing read part of an RMW action into either:
294  *  -# a full RMW action in case of the completed write or
295  *  -# a READ action in case a failed action.
296  *
297  * @todo  If the memory_order changes, we may potentially need to update our
298  * clock vector.
299  *
300  * @param act The second half of the RMW (either RMWC or RMW)
301  */
302 void ModelAction::process_rmw(ModelAction *act)
303 {
304         this->order = act->order;
305         if (act->is_rmwc())
306                 this->type = ATOMIC_READ;
307         else if (act->is_rmw()) {
308                 this->type = ATOMIC_RMW;
309                 this->value = act->value;
310         }
311 }
312
313 /**
314  * @brief Check if this action should be backtracked with another, due to
315  * potential synchronization
316  *
317  * The is_synchronizing method should only explore interleavings if:
318  *  -# the operations are seq_cst and don't commute or
319  *  -# the reordering may establish or break a synchronization relation.
320  *
321  * Other memory operations will be dealt with by using the reads_from relation.
322  *
323  * @param act The action to consider exploring a reordering
324  * @return True, if we have to explore a reordering; otherwise false
325  */
326 bool ModelAction::could_synchronize_with(const ModelAction *act) const
327 {
328         // Same thread can't be reordered
329         if (same_thread(act))
330                 return false;
331
332         // Different locations commute
333         if (!same_var(act) && !is_fence() && !act->is_fence())
334                 return false;
335
336         // Explore interleavings of seqcst writes/fences to guarantee total
337         // order of seq_cst operations that don't commute
338         if ((could_be_write() || act->could_be_write() || is_fence() || act->is_fence()) && is_seqcst() && act->is_seqcst())
339                 return true;
340
341         // Explore synchronizing read/write pairs
342         if (is_acquire() && act->is_release() && is_read() && act->could_be_write())
343                 return true;
344
345         // lock just released...we can grab lock
346         if ((is_lock() || is_trylock()) && (act->is_unlock() || act->is_wait()))
347                 return true;
348
349         // lock just acquired...we can fail to grab lock
350         if (is_trylock() && act->is_success_lock())
351                 return true;
352
353         // other thread stalling on lock...we can release lock
354         if (is_unlock() && (act->is_trylock() || act->is_lock()))
355                 return true;
356
357         if (is_trylock() && (act->is_unlock() || act->is_wait()))
358                 return true;
359
360         if (is_notify() && act->is_wait())
361                 return true;
362
363         if (is_wait() && act->is_notify())
364                 return true;
365
366         // Otherwise handle by reads_from relation
367         return false;
368 }
369
370 bool ModelAction::is_conflicting_lock(const ModelAction *act) const
371 {
372         // Must be different threads to reorder
373         if (same_thread(act))
374                 return false;
375
376         // Try to reorder a lock past a successful lock
377         if (act->is_success_lock())
378                 return true;
379
380         // Try to push a successful trylock past an unlock
381         if (act->is_unlock() && is_trylock() && value == VALUE_TRYSUCCESS)
382                 return true;
383
384         // Try to push a successful trylock past a wait
385         if (act->is_wait() && is_trylock() && value == VALUE_TRYSUCCESS)
386                 return true;
387
388         return false;
389 }
390
391 /**
392  * Create a new clock vector for this action. Note that this function allows a
393  * user to clobber (and leak) a ModelAction's existing clock vector. A user
394  * should ensure that the vector has already either been rolled back
395  * (effectively "freed") or freed.
396  *
397  * @param parent A ModelAction from which to inherit a ClockVector
398  */
399 void ModelAction::create_cv(const ModelAction *parent)
400 {
401         if (parent)
402                 cv = new ClockVector(parent->cv, this);
403         else
404                 cv = new ClockVector(NULL, this);
405 }
406
407 void ModelAction::set_try_lock(bool obtainedlock)
408 {
409         value = obtainedlock ? VALUE_TRYSUCCESS : VALUE_TRYFAILED;
410 }
411
412 /**
413  * @brief Get the value read by this load
414  *
415  * We differentiate this function from ModelAction::get_write_value and
416  * ModelAction::get_value for the purpose of RMW's, which may have both a
417  * 'read' and a 'write' value.
418  *
419  * Note: 'this' must be a load.
420  *
421  * @return The value read by this load
422  */
423 uint64_t ModelAction::get_reads_from_value() const
424 {
425         ASSERT(is_read());
426         if (reads_from)
427                 return reads_from->get_write_value();
428         else if (reads_from_promise)
429                 return reads_from_promise->get_value();
430         return VALUE_NONE; /* Only for new actions with no reads-from */
431 }
432
433 /**
434  * @brief Get the value written by this store
435  *
436  * We differentiate this function from ModelAction::get_reads_from_value and
437  * ModelAction::get_value for the purpose of RMW's, which may have both a
438  * 'read' and a 'write' value.
439  *
440  * Note: 'this' must be a store.
441  *
442  * @return The value written by this store
443  */
444 uint64_t ModelAction::get_write_value() const
445 {
446         ASSERT(is_write());
447         return value;
448 }
449
450 /**
451  * @brief Get the value returned by this action
452  *
453  * For atomic reads (including RMW), an operation returns the value it read.
454  * For atomic writes, an operation returns the value it wrote. For other
455  * operations, the return value varies (sometimes is a "don't care"), but the
456  * value is simply stored in the "value" field.
457  *
458  * @return This action's return value
459  */
460 uint64_t ModelAction::get_return_value() const
461 {
462         if (is_read())
463                 return get_reads_from_value();
464         else if (is_write())
465                 return get_write_value();
466         else
467                 return value;
468 }
469
470 /** @return The Node associated with this ModelAction */
471 Node * ModelAction::get_node() const
472 {
473         /* UNINIT actions do not have a Node */
474         ASSERT(!is_uninitialized());
475         return node;
476 }
477
478 /**
479  * Update the model action's read_from action
480  * @param act The action to read from; should be a write
481  */
482 void ModelAction::set_read_from(const ModelAction *act)
483 {
484         ASSERT(act);
485         reads_from = act;
486         reads_from_promise = NULL;
487         if (act->is_uninitialized())
488                 model->assert_bug("May read from uninitialized atomic:\n"
489                                 "    action %d, thread %d, location %p (%s, %s)",
490                                 seq_number, id_to_int(tid), location,
491                                 get_type_str(), get_mo_str());
492 }
493
494 /**
495  * Set this action's read-from promise
496  * @param promise The promise to read from
497  */
498 void ModelAction::set_read_from_promise(Promise *promise)
499 {
500         ASSERT(is_read());
501         reads_from_promise = promise;
502         reads_from = NULL;
503 }
504
505 /**
506  * Synchronize the current thread with the thread corresponding to the
507  * ModelAction parameter.
508  * @param act The ModelAction to synchronize with
509  * @return True if this is a valid synchronization; false otherwise
510  */
511 bool ModelAction::synchronize_with(const ModelAction *act)
512 {
513         if (*this < *act)
514                 return false;
515         cv->merge(act->cv);
516         return true;
517 }
518
519 bool ModelAction::has_synchronized_with(const ModelAction *act) const
520 {
521         return cv->synchronized_since(act);
522 }
523
524 /**
525  * Check whether 'this' happens before act, according to the memory-model's
526  * happens before relation. This is checked via the ClockVector constructs.
527  * @return true if this action's thread has synchronized with act's thread
528  * since the execution of act, false otherwise.
529  */
530 bool ModelAction::happens_before(const ModelAction *act) const
531 {
532         return act->cv->synchronized_since(this);
533 }
534
535 const char * ModelAction::get_type_str() const
536 {
537         switch (this->type) {
538                 case MODEL_FIXUP_RELSEQ: return "relseq fixup";
539                 case THREAD_CREATE: return "thread create";
540                 case THREAD_START: return "thread start";
541                 case THREAD_YIELD: return "thread yield";
542                 case THREAD_JOIN: return "thread join";
543                 case THREAD_FINISH: return "thread finish";
544                 case ATOMIC_UNINIT: return "uninitialized";
545                 case ATOMIC_READ: return "atomic read";
546                 case ATOMIC_WRITE: return "atomic write";
547                 case ATOMIC_RMW: return "atomic rmw";
548                 case ATOMIC_FENCE: return "fence";
549                 case ATOMIC_RMWR: return "atomic rmwr";
550                 case ATOMIC_RMWC: return "atomic rmwc";
551                 case ATOMIC_INIT: return "init atomic";
552                 case ATOMIC_LOCK: return "lock";
553                 case ATOMIC_UNLOCK: return "unlock";
554                 case ATOMIC_TRYLOCK: return "trylock";
555                 case ATOMIC_WAIT: return "wait";
556                 case ATOMIC_NOTIFY_ONE: return "notify one";
557           case ATOMIC_NOTIFY_ALL: return "notify all";
558           case ATOMIC_ANNOTATION: return "annotation";
559                 default: return "unknown type";
560         };
561 }
562
563 const char * ModelAction::get_mo_str() const
564 {
565         switch (this->order) {
566                 case std::memory_order_relaxed: return "relaxed";
567                 case std::memory_order_acquire: return "acquire";
568                 case std::memory_order_release: return "release";
569                 case std::memory_order_acq_rel: return "acq_rel";
570                 case std::memory_order_seq_cst: return "seq_cst";
571                 default: return "unknown";
572         }
573 }
574
575 /** @brief Print nicely-formatted info about this ModelAction */
576 void ModelAction::print() const
577 {
578         const char *type_str = get_type_str(), *mo_str = get_mo_str();
579
580         model_print("%-4d %-2d   %-13s   %7s  %14p   %-#18" PRIx64,
581                         seq_number, id_to_int(tid), type_str, mo_str, location, get_return_value());
582         if (is_read()) {
583                 if (reads_from)
584                         model_print("  %-3d", reads_from->get_seq_number());
585                 else if (reads_from_promise) {
586                         int idx = reads_from_promise->get_index();
587                         if (idx >= 0)
588                                 model_print("  P%-2d", idx);
589                         else
590                                 model_print("  P? ");
591                 } else
592                         model_print("  ?  ");
593         }
594         if (cv) {
595                 if (is_read())
596                         model_print(" ");
597                 else
598                         model_print("      ");
599                 cv->print();
600         } else
601                 model_print("\n");
602 }
603
604 /** @brief Get a (likely) unique hash for this ModelAction */
605 unsigned int ModelAction::hash() const
606 {
607         unsigned int hash = (unsigned int)this->type;
608         hash ^= ((unsigned int)this->order) << 3;
609         hash ^= seq_number << 5;
610         hash ^= id_to_int(tid) << 6;
611
612         if (is_read()) {
613                if (reads_from)
614                        hash ^= reads_from->get_seq_number();
615                else if (reads_from_promise)
616                        hash ^= reads_from_promise->get_index();
617                hash ^= get_reads_from_value();
618         }
619         return hash;
620 }
621
622 /**
623  * @brief Checks the NodeStack to see if a ModelAction is in our may-read-from set
624  * @param write The ModelAction to check for
625  * @return True if the ModelAction is found; false otherwise
626  */
627 bool ModelAction::may_read_from(const ModelAction *write) const
628 {
629         for (int i = 0; i < node->get_read_from_past_size(); i++)
630                 if (node->get_read_from_past(i) == write)
631                         return true;
632         return false;
633 }
634
635 /**
636  * @brief Checks the NodeStack to see if a Promise is in our may-read-from set
637  * @param promise The Promise to check for
638  * @return True if the Promise is found; false otherwise
639  */
640 bool ModelAction::may_read_from(const Promise *promise) const
641 {
642         for (int i = 0; i < node->get_read_from_promise_size(); i++)
643                 if (node->get_read_from_promise(i) == promise)
644                         return true;
645         return false;
646 }
647
648 /**
649  * Only valid for LOCK, TRY_LOCK, UNLOCK, and WAIT operations.
650  * @return The mutex operated on by this action, if any; otherwise NULL
651  */
652 std::mutex * ModelAction::get_mutex() const
653 {
654         if (is_trylock() || is_lock() || is_unlock())
655                 return (std::mutex *)get_location();
656         else if (is_wait())
657                 return (std::mutex *)get_value();
658         else
659                 return NULL;
660 }