40b25d0d635a32a5fdd2832001c638c3ee1986fc
[c11tester.git] / model.cc
1 #include <stdio.h>
2 #include <algorithm>
3 #include <mutex>
4 #include <new>
5
6 #include "model.h"
7 #include "action.h"
8 #include "nodestack.h"
9 #include "schedule.h"
10 #include "snapshot-interface.h"
11 #include "common.h"
12 #include "clockvector.h"
13 #include "cyclegraph.h"
14 #include "promise.h"
15 #include "datarace.h"
16 #include "threads-model.h"
17 #include "output.h"
18
19 #define INITIAL_THREAD_ID       0
20
21 ModelChecker *model;
22
23 struct bug_message {
24         bug_message(const char *str) {
25                 const char *fmt = "  [BUG] %s\n";
26                 msg = (char *)snapshot_malloc(strlen(fmt) + strlen(str));
27                 sprintf(msg, fmt, str);
28         }
29         ~bug_message() { if (msg) snapshot_free(msg); }
30
31         char *msg;
32         void print() { model_print("%s", msg); }
33
34         SNAPSHOTALLOC
35 };
36
37 /**
38  * Structure for holding small ModelChecker members that should be snapshotted
39  */
40 struct model_snapshot_members {
41         model_snapshot_members() :
42                 current_action(NULL),
43                 /* First thread created will have id INITIAL_THREAD_ID */
44                 next_thread_id(INITIAL_THREAD_ID),
45                 used_sequence_numbers(0),
46                 next_backtrack(NULL),
47                 bugs(),
48                 stats(),
49                 failed_promise(false),
50                 too_many_reads(false),
51                 bad_synchronization(false),
52                 asserted(false)
53         { }
54
55         ~model_snapshot_members() {
56                 for (unsigned int i = 0; i < bugs.size(); i++)
57                         delete bugs[i];
58                 bugs.clear();
59         }
60
61         ModelAction *current_action;
62         unsigned int next_thread_id;
63         modelclock_t used_sequence_numbers;
64         ModelAction *next_backtrack;
65         std::vector< bug_message *, SnapshotAlloc<bug_message *> > bugs;
66         struct execution_stats stats;
67         bool failed_promise;
68         bool too_many_reads;
69         /** @brief Incorrectly-ordered synchronization was made */
70         bool bad_synchronization;
71         bool asserted;
72
73         SNAPSHOTALLOC
74 };
75
76 /** @brief Constructor */
77 ModelChecker::ModelChecker(struct model_params params) :
78         /* Initialize default scheduler */
79         params(params),
80         scheduler(new Scheduler()),
81         diverge(NULL),
82         earliest_diverge(NULL),
83         action_trace(new action_list_t()),
84         thread_map(new HashTable<int, Thread *, int>()),
85         obj_map(new HashTable<const void *, action_list_t *, uintptr_t, 4>()),
86         lock_waiters_map(new HashTable<const void *, action_list_t *, uintptr_t, 4>()),
87         condvar_waiters_map(new HashTable<const void *, action_list_t *, uintptr_t, 4>()),
88         obj_thrd_map(new HashTable<void *, std::vector<action_list_t> *, uintptr_t, 4 >()),
89         promises(new std::vector< Promise *, SnapshotAlloc<Promise *> >()),
90         futurevalues(new std::vector< struct PendingFutureValue, SnapshotAlloc<struct PendingFutureValue> >()),
91         pending_rel_seqs(new std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> >()),
92         thrd_last_action(new std::vector< ModelAction *, SnapshotAlloc<ModelAction *> >(1)),
93         thrd_last_fence_release(new std::vector< ModelAction *, SnapshotAlloc<ModelAction *> >()),
94         node_stack(new NodeStack()),
95         priv(new struct model_snapshot_members()),
96         mo_graph(new CycleGraph())
97 {
98         /* Initialize a model-checker thread, for special ModelActions */
99         model_thread = new Thread(get_next_id());
100         thread_map->put(id_to_int(model_thread->get_id()), model_thread);
101 }
102
103 /** @brief Destructor */
104 ModelChecker::~ModelChecker()
105 {
106         for (unsigned int i = 0; i < get_num_threads(); i++)
107                 delete thread_map->get(i);
108         delete thread_map;
109
110         delete obj_thrd_map;
111         delete obj_map;
112         delete lock_waiters_map;
113         delete condvar_waiters_map;
114         delete action_trace;
115
116         for (unsigned int i = 0; i < promises->size(); i++)
117                 delete (*promises)[i];
118         delete promises;
119
120         delete pending_rel_seqs;
121
122         delete thrd_last_action;
123         delete thrd_last_fence_release;
124         delete node_stack;
125         delete scheduler;
126         delete mo_graph;
127         delete priv;
128 }
129
130 static action_list_t * get_safe_ptr_action(HashTable<const void *, action_list_t *, uintptr_t, 4> * hash, void * ptr)
131 {
132         action_list_t *tmp = hash->get(ptr);
133         if (tmp == NULL) {
134                 tmp = new action_list_t();
135                 hash->put(ptr, tmp);
136         }
137         return tmp;
138 }
139
140 static std::vector<action_list_t> * get_safe_ptr_vect_action(HashTable<void *, std::vector<action_list_t> *, uintptr_t, 4> * hash, void * ptr)
141 {
142         std::vector<action_list_t> *tmp = hash->get(ptr);
143         if (tmp == NULL) {
144                 tmp = new std::vector<action_list_t>();
145                 hash->put(ptr, tmp);
146         }
147         return tmp;
148 }
149
150 /**
151  * Restores user program to initial state and resets all model-checker data
152  * structures.
153  */
154 void ModelChecker::reset_to_initial_state()
155 {
156         DEBUG("+++ Resetting to initial state +++\n");
157         node_stack->reset_execution();
158
159         /* Print all model-checker output before rollback */
160         fflush(model_out);
161
162         snapshot_backtrack_before(0);
163 }
164
165 /** @return a thread ID for a new Thread */
166 thread_id_t ModelChecker::get_next_id()
167 {
168         return priv->next_thread_id++;
169 }
170
171 /** @return the number of user threads created during this execution */
172 unsigned int ModelChecker::get_num_threads() const
173 {
174         return priv->next_thread_id;
175 }
176
177 /**
178  * Must be called from user-thread context (e.g., through the global
179  * thread_current() interface)
180  *
181  * @return The currently executing Thread.
182  */
183 Thread * ModelChecker::get_current_thread() const
184 {
185         return scheduler->get_current_thread();
186 }
187
188 /** @return a sequence number for a new ModelAction */
189 modelclock_t ModelChecker::get_next_seq_num()
190 {
191         return ++priv->used_sequence_numbers;
192 }
193
194 Node * ModelChecker::get_curr_node() const
195 {
196         return node_stack->get_head();
197 }
198
199 /**
200  * @brief Choose the next thread to execute.
201  *
202  * This function chooses the next thread that should execute. It can force the
203  * adjacency of read/write portions of a RMW action, force THREAD_CREATE to be
204  * followed by a THREAD_START, or it can enforce execution replay/backtracking.
205  * The model-checker may have no preference regarding the next thread (i.e.,
206  * when exploring a new execution ordering), in which case this will return
207  * NULL.
208  * @param curr The current ModelAction. This action might guide the choice of
209  * next thread.
210  * @return The next thread to run. If the model-checker has no preference, NULL.
211  */
212 Thread * ModelChecker::get_next_thread(ModelAction *curr)
213 {
214         thread_id_t tid;
215
216         if (curr != NULL) {
217                 /* Do not split atomic actions. */
218                 if (curr->is_rmwr())
219                         return thread_current();
220                 else if (curr->get_type() == THREAD_CREATE)
221                         return curr->get_thread_operand();
222         }
223
224         /* Have we completed exploring the preselected path? */
225         if (diverge == NULL)
226                 return NULL;
227
228         /* Else, we are trying to replay an execution */
229         ModelAction *next = node_stack->get_next()->get_action();
230
231         if (next == diverge) {
232                 if (earliest_diverge == NULL || *diverge < *earliest_diverge)
233                         earliest_diverge = diverge;
234
235                 Node *nextnode = next->get_node();
236                 Node *prevnode = nextnode->get_parent();
237                 scheduler->update_sleep_set(prevnode);
238
239                 /* Reached divergence point */
240                 if (nextnode->increment_misc()) {
241                         /* The next node will try to satisfy a different misc_index values. */
242                         tid = next->get_tid();
243                         node_stack->pop_restofstack(2);
244                 } else if (nextnode->increment_promise()) {
245                         /* The next node will try to satisfy a different set of promises. */
246                         tid = next->get_tid();
247                         node_stack->pop_restofstack(2);
248                 } else if (nextnode->increment_read_from()) {
249                         /* The next node will read from a different value. */
250                         tid = next->get_tid();
251                         node_stack->pop_restofstack(2);
252                 } else if (nextnode->increment_future_value()) {
253                         /* The next node will try to read from a different future value. */
254                         tid = next->get_tid();
255                         node_stack->pop_restofstack(2);
256                 } else if (nextnode->increment_relseq_break()) {
257                         /* The next node will try to resolve a release sequence differently */
258                         tid = next->get_tid();
259                         node_stack->pop_restofstack(2);
260                 } else {
261                         ASSERT(prevnode);
262                         /* Make a different thread execute for next step */
263                         scheduler->add_sleep(get_thread(next->get_tid()));
264                         tid = prevnode->get_next_backtrack();
265                         /* Make sure the backtracked thread isn't sleeping. */
266                         node_stack->pop_restofstack(1);
267                         if (diverge == earliest_diverge) {
268                                 earliest_diverge = prevnode->get_action();
269                         }
270                 }
271                 /* The correct sleep set is in the parent node. */
272                 execute_sleep_set();
273
274                 DEBUG("*** Divergence point ***\n");
275
276                 diverge = NULL;
277         } else {
278                 tid = next->get_tid();
279         }
280         DEBUG("*** ModelChecker chose next thread = %d ***\n", id_to_int(tid));
281         ASSERT(tid != THREAD_ID_T_NONE);
282         return thread_map->get(id_to_int(tid));
283 }
284
285 /**
286  * We need to know what the next actions of all threads in the sleep
287  * set will be.  This method computes them and stores the actions at
288  * the corresponding thread object's pending action.
289  */
290
291 void ModelChecker::execute_sleep_set()
292 {
293         for (unsigned int i = 0; i < get_num_threads(); i++) {
294                 thread_id_t tid = int_to_id(i);
295                 Thread *thr = get_thread(tid);
296                 if (scheduler->is_sleep_set(thr) && thr->get_pending() == NULL) {
297                         thr->set_state(THREAD_RUNNING);
298                         scheduler->next_thread(thr);
299                         Thread::swap(&system_context, thr);
300                         priv->current_action->set_sleep_flag();
301                         thr->set_pending(priv->current_action);
302                 }
303         }
304 }
305
306 void ModelChecker::wake_up_sleeping_actions(ModelAction *curr)
307 {
308         for (unsigned int i = 0; i < get_num_threads(); i++) {
309                 Thread *thr = get_thread(int_to_id(i));
310                 if (scheduler->is_sleep_set(thr)) {
311                         ModelAction *pending_act = thr->get_pending();
312                         if ((!curr->is_rmwr()) && pending_act->could_synchronize_with(curr))
313                                 //Remove this thread from sleep set
314                                 scheduler->remove_sleep(thr);
315                 }
316         }
317 }
318
319 /** @brief Alert the model-checker that an incorrectly-ordered
320  * synchronization was made */
321 void ModelChecker::set_bad_synchronization()
322 {
323         priv->bad_synchronization = true;
324 }
325
326 bool ModelChecker::has_asserted() const
327 {
328         return priv->asserted;
329 }
330
331 void ModelChecker::set_assert()
332 {
333         priv->asserted = true;
334 }
335
336 /**
337  * Check if we are in a deadlock. Should only be called at the end of an
338  * execution, although it should not give false positives in the middle of an
339  * execution (there should be some ENABLED thread).
340  *
341  * @return True if program is in a deadlock; false otherwise
342  */
343 bool ModelChecker::is_deadlocked() const
344 {
345         bool blocking_threads = false;
346         for (unsigned int i = 0; i < get_num_threads(); i++) {
347                 thread_id_t tid = int_to_id(i);
348                 if (is_enabled(tid))
349                         return false;
350                 Thread *t = get_thread(tid);
351                 if (!t->is_model_thread() && t->get_pending())
352                         blocking_threads = true;
353         }
354         return blocking_threads;
355 }
356
357 /**
358  * Check if this is a complete execution. That is, have all thread completed
359  * execution (rather than exiting because sleep sets have forced a redundant
360  * execution).
361  *
362  * @return True if the execution is complete.
363  */
364 bool ModelChecker::is_complete_execution() const
365 {
366         for (unsigned int i = 0; i < get_num_threads(); i++)
367                 if (is_enabled(int_to_id(i)))
368                         return false;
369         return true;
370 }
371
372 /**
373  * @brief Assert a bug in the executing program.
374  *
375  * Use this function to assert any sort of bug in the user program. If the
376  * current trace is feasible (actually, a prefix of some feasible execution),
377  * then this execution will be aborted, printing the appropriate message. If
378  * the current trace is not yet feasible, the error message will be stashed and
379  * printed if the execution ever becomes feasible.
380  *
381  * @param msg Descriptive message for the bug (do not include newline char)
382  * @return True if bug is immediately-feasible
383  */
384 bool ModelChecker::assert_bug(const char *msg)
385 {
386         priv->bugs.push_back(new bug_message(msg));
387
388         if (isfeasibleprefix()) {
389                 set_assert();
390                 return true;
391         }
392         return false;
393 }
394
395 /**
396  * @brief Assert a bug in the executing program, asserted by a user thread
397  * @see ModelChecker::assert_bug
398  * @param msg Descriptive message for the bug (do not include newline char)
399  */
400 void ModelChecker::assert_user_bug(const char *msg)
401 {
402         /* If feasible bug, bail out now */
403         if (assert_bug(msg))
404                 switch_to_master(NULL);
405 }
406
407 /** @return True, if any bugs have been reported for this execution */
408 bool ModelChecker::have_bug_reports() const
409 {
410         return priv->bugs.size() != 0;
411 }
412
413 /** @brief Print bug report listing for this execution (if any bugs exist) */
414 void ModelChecker::print_bugs() const
415 {
416         if (have_bug_reports()) {
417                 model_print("Bug report: %zu bug%s detected\n",
418                                 priv->bugs.size(),
419                                 priv->bugs.size() > 1 ? "s" : "");
420                 for (unsigned int i = 0; i < priv->bugs.size(); i++)
421                         priv->bugs[i]->print();
422         }
423 }
424
425 /**
426  * @brief Record end-of-execution stats
427  *
428  * Must be run when exiting an execution. Records various stats.
429  * @see struct execution_stats
430  */
431 void ModelChecker::record_stats()
432 {
433         stats.num_total++;
434         if (!isfeasibleprefix())
435                 stats.num_infeasible++;
436         else if (have_bug_reports())
437                 stats.num_buggy_executions++;
438         else if (is_complete_execution())
439                 stats.num_complete++;
440         else
441                 stats.num_redundant++;
442 }
443
444 /** @brief Print execution stats */
445 void ModelChecker::print_stats() const
446 {
447         model_print("Number of complete, bug-free executions: %d\n", stats.num_complete);
448         model_print("Number of redundant executions: %d\n", stats.num_redundant);
449         model_print("Number of buggy executions: %d\n", stats.num_buggy_executions);
450         model_print("Number of infeasible executions: %d\n", stats.num_infeasible);
451         model_print("Total executions: %d\n", stats.num_total);
452         model_print("Total nodes created: %d\n", node_stack->get_total_nodes());
453 }
454
455 /**
456  * @brief End-of-exeuction print
457  * @param printbugs Should any existing bugs be printed?
458  */
459 void ModelChecker::print_execution(bool printbugs) const
460 {
461         print_program_output();
462
463         if (DBG_ENABLED() || params.verbose) {
464                 model_print("Earliest divergence point since last feasible execution:\n");
465                 if (earliest_diverge)
466                         earliest_diverge->print();
467                 else
468                         model_print("(Not set)\n");
469
470                 model_print("\n");
471                 print_stats();
472         }
473
474         /* Don't print invalid bugs */
475         if (printbugs)
476                 print_bugs();
477
478         model_print("\n");
479         print_summary();
480 }
481
482 /**
483  * Queries the model-checker for more executions to explore and, if one
484  * exists, resets the model-checker state to execute a new execution.
485  *
486  * @return If there are more executions to explore, return true. Otherwise,
487  * return false.
488  */
489 bool ModelChecker::next_execution()
490 {
491         DBG();
492         /* Is this execution a feasible execution that's worth bug-checking? */
493         bool complete = isfeasibleprefix() && (is_complete_execution() ||
494                         have_bug_reports());
495
496         /* End-of-execution bug checks */
497         if (complete) {
498                 if (is_deadlocked())
499                         assert_bug("Deadlock detected");
500
501                 checkDataRaces();
502         }
503
504         record_stats();
505
506         /* Output */
507         if (DBG_ENABLED() || params.verbose || (complete && have_bug_reports()))
508                 print_execution(complete);
509         else
510                 clear_program_output();
511
512         if (complete)
513                 earliest_diverge = NULL;
514
515         if ((diverge = get_next_backtrack()) == NULL)
516                 return false;
517
518         if (DBG_ENABLED()) {
519                 model_print("Next execution will diverge at:\n");
520                 diverge->print();
521         }
522
523         reset_to_initial_state();
524         return true;
525 }
526
527 ModelAction * ModelChecker::get_last_conflict(ModelAction *act)
528 {
529         switch (act->get_type()) {
530         case ATOMIC_FENCE:
531         case ATOMIC_READ:
532         case ATOMIC_WRITE:
533         case ATOMIC_RMW: {
534                 /* Optimization: relaxed operations don't need backtracking */
535                 if (act->is_relaxed())
536                         return NULL;
537                 /* linear search: from most recent to oldest */
538                 action_list_t *list = get_safe_ptr_action(obj_map, act->get_location());
539                 action_list_t::reverse_iterator rit;
540                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
541                         ModelAction *prev = *rit;
542                         if (prev->could_synchronize_with(act))
543                                 return prev;
544                 }
545                 break;
546         }
547         case ATOMIC_LOCK:
548         case ATOMIC_TRYLOCK: {
549                 /* linear search: from most recent to oldest */
550                 action_list_t *list = get_safe_ptr_action(obj_map, act->get_location());
551                 action_list_t::reverse_iterator rit;
552                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
553                         ModelAction *prev = *rit;
554                         if (act->is_conflicting_lock(prev))
555                                 return prev;
556                 }
557                 break;
558         }
559         case ATOMIC_UNLOCK: {
560                 /* linear search: from most recent to oldest */
561                 action_list_t *list = get_safe_ptr_action(obj_map, act->get_location());
562                 action_list_t::reverse_iterator rit;
563                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
564                         ModelAction *prev = *rit;
565                         if (!act->same_thread(prev) && prev->is_failed_trylock())
566                                 return prev;
567                 }
568                 break;
569         }
570         case ATOMIC_WAIT: {
571                 /* linear search: from most recent to oldest */
572                 action_list_t *list = get_safe_ptr_action(obj_map, act->get_location());
573                 action_list_t::reverse_iterator rit;
574                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
575                         ModelAction *prev = *rit;
576                         if (!act->same_thread(prev) && prev->is_failed_trylock())
577                                 return prev;
578                         if (!act->same_thread(prev) && prev->is_notify())
579                                 return prev;
580                 }
581                 break;
582         }
583
584         case ATOMIC_NOTIFY_ALL:
585         case ATOMIC_NOTIFY_ONE: {
586                 /* linear search: from most recent to oldest */
587                 action_list_t *list = get_safe_ptr_action(obj_map, act->get_location());
588                 action_list_t::reverse_iterator rit;
589                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
590                         ModelAction *prev = *rit;
591                         if (!act->same_thread(prev) && prev->is_wait())
592                                 return prev;
593                 }
594                 break;
595         }
596         default:
597                 break;
598         }
599         return NULL;
600 }
601
602 /** This method finds backtracking points where we should try to
603  * reorder the parameter ModelAction against.
604  *
605  * @param the ModelAction to find backtracking points for.
606  */
607 void ModelChecker::set_backtracking(ModelAction *act)
608 {
609         Thread *t = get_thread(act);
610         ModelAction *prev = get_last_conflict(act);
611         if (prev == NULL)
612                 return;
613
614         Node *node = prev->get_node()->get_parent();
615
616         int low_tid, high_tid;
617         if (node->enabled_status(t->get_id()) == THREAD_ENABLED) {
618                 low_tid = id_to_int(act->get_tid());
619                 high_tid = low_tid + 1;
620         } else {
621                 low_tid = 0;
622                 high_tid = get_num_threads();
623         }
624
625         for (int i = low_tid; i < high_tid; i++) {
626                 thread_id_t tid = int_to_id(i);
627
628                 /* Make sure this thread can be enabled here. */
629                 if (i >= node->get_num_threads())
630                         break;
631
632                 /* Don't backtrack into a point where the thread is disabled or sleeping. */
633                 if (node->enabled_status(tid) != THREAD_ENABLED)
634                         continue;
635
636                 /* Check if this has been explored already */
637                 if (node->has_been_explored(tid))
638                         continue;
639
640                 /* See if fairness allows */
641                 if (model->params.fairwindow != 0 && !node->has_priority(tid)) {
642                         bool unfair = false;
643                         for (int t = 0; t < node->get_num_threads(); t++) {
644                                 thread_id_t tother = int_to_id(t);
645                                 if (node->is_enabled(tother) && node->has_priority(tother)) {
646                                         unfair = true;
647                                         break;
648                                 }
649                         }
650                         if (unfair)
651                                 continue;
652                 }
653                 /* Cache the latest backtracking point */
654                 set_latest_backtrack(prev);
655
656                 /* If this is a new backtracking point, mark the tree */
657                 if (!node->set_backtrack(tid))
658                         continue;
659                 DEBUG("Setting backtrack: conflict = %d, instead tid = %d\n",
660                                         id_to_int(prev->get_tid()),
661                                         id_to_int(t->get_id()));
662                 if (DBG_ENABLED()) {
663                         prev->print();
664                         act->print();
665                 }
666         }
667 }
668
669 /**
670  * @brief Cache the a backtracking point as the "most recent", if eligible
671  *
672  * Note that this does not prepare the NodeStack for this backtracking
673  * operation, it only caches the action on a per-execution basis
674  *
675  * @param act The operation at which we should explore a different next action
676  * (i.e., backtracking point)
677  * @return True, if this action is now the most recent backtracking point;
678  * false otherwise
679  */
680 bool ModelChecker::set_latest_backtrack(ModelAction *act)
681 {
682         if (!priv->next_backtrack || *act > *priv->next_backtrack) {
683                 priv->next_backtrack = act;
684                 return true;
685         }
686         return false;
687 }
688
689 /**
690  * Returns last backtracking point. The model checker will explore a different
691  * path for this point in the next execution.
692  * @return The ModelAction at which the next execution should diverge.
693  */
694 ModelAction * ModelChecker::get_next_backtrack()
695 {
696         ModelAction *next = priv->next_backtrack;
697         priv->next_backtrack = NULL;
698         return next;
699 }
700
701 /**
702  * Processes a read or rmw model action.
703  * @param curr is the read model action to process.
704  * @param second_part_of_rmw is boolean that is true is this is the second action of a rmw.
705  * @return True if processing this read updates the mo_graph.
706  */
707 bool ModelChecker::process_read(ModelAction *curr, bool second_part_of_rmw)
708 {
709         uint64_t value = VALUE_NONE;
710         bool updated = false;
711         while (true) {
712                 const ModelAction *reads_from = curr->get_node()->get_read_from();
713                 if (reads_from != NULL) {
714                         mo_graph->startChanges();
715
716                         value = reads_from->get_value();
717                         bool r_status = false;
718
719                         if (!second_part_of_rmw) {
720                                 check_recency(curr, reads_from);
721                                 r_status = r_modification_order(curr, reads_from);
722                         }
723
724
725                         if (!second_part_of_rmw && is_infeasible() && (curr->get_node()->increment_read_from() || curr->get_node()->increment_future_value())) {
726                                 mo_graph->rollbackChanges();
727                                 priv->too_many_reads = false;
728                                 continue;
729                         }
730
731                         read_from(curr, reads_from);
732                         mo_graph->commitChanges();
733                         mo_check_promises(curr->get_tid(), reads_from, NULL);
734
735                         updated |= r_status;
736                 } else if (!second_part_of_rmw) {
737                         /* Read from future value */
738                         struct future_value fv = curr->get_node()->get_future_value();
739                         value = fv.value;
740                         curr->set_read_from(NULL);
741                         promises->push_back(new Promise(curr, fv));
742                 }
743                 get_thread(curr)->set_return_value(value);
744                 return updated;
745         }
746 }
747
748 /**
749  * Processes a lock, trylock, or unlock model action.  @param curr is
750  * the read model action to process.
751  *
752  * The try lock operation checks whether the lock is taken.  If not,
753  * it falls to the normal lock operation case.  If so, it returns
754  * fail.
755  *
756  * The lock operation has already been checked that it is enabled, so
757  * it just grabs the lock and synchronizes with the previous unlock.
758  *
759  * The unlock operation has to re-enable all of the threads that are
760  * waiting on the lock.
761  *
762  * @return True if synchronization was updated; false otherwise
763  */
764 bool ModelChecker::process_mutex(ModelAction *curr)
765 {
766         std::mutex *mutex = NULL;
767         struct std::mutex_state *state = NULL;
768
769         if (curr->is_trylock() || curr->is_lock() || curr->is_unlock()) {
770                 mutex = (std::mutex *)curr->get_location();
771                 state = mutex->get_state();
772         } else if (curr->is_wait()) {
773                 mutex = (std::mutex *)curr->get_value();
774                 state = mutex->get_state();
775         }
776
777         switch (curr->get_type()) {
778         case ATOMIC_TRYLOCK: {
779                 bool success = !state->islocked;
780                 curr->set_try_lock(success);
781                 if (!success) {
782                         get_thread(curr)->set_return_value(0);
783                         break;
784                 }
785                 get_thread(curr)->set_return_value(1);
786         }
787                 //otherwise fall into the lock case
788         case ATOMIC_LOCK: {
789                 if (curr->get_cv()->getClock(state->alloc_tid) <= state->alloc_clock)
790                         assert_bug("Lock access before initialization");
791                 state->islocked = true;
792                 ModelAction *unlock = get_last_unlock(curr);
793                 //synchronize with the previous unlock statement
794                 if (unlock != NULL) {
795                         curr->synchronize_with(unlock);
796                         return true;
797                 }
798                 break;
799         }
800         case ATOMIC_UNLOCK: {
801                 //unlock the lock
802                 state->islocked = false;
803                 //wake up the other threads
804                 action_list_t *waiters = get_safe_ptr_action(lock_waiters_map, curr->get_location());
805                 //activate all the waiting threads
806                 for (action_list_t::iterator rit = waiters->begin(); rit != waiters->end(); rit++) {
807                         scheduler->wake(get_thread(*rit));
808                 }
809                 waiters->clear();
810                 break;
811         }
812         case ATOMIC_WAIT: {
813                 //unlock the lock
814                 state->islocked = false;
815                 //wake up the other threads
816                 action_list_t *waiters = get_safe_ptr_action(lock_waiters_map, (void *) curr->get_value());
817                 //activate all the waiting threads
818                 for (action_list_t::iterator rit = waiters->begin(); rit != waiters->end(); rit++) {
819                         scheduler->wake(get_thread(*rit));
820                 }
821                 waiters->clear();
822                 //check whether we should go to sleep or not...simulate spurious failures
823                 if (curr->get_node()->get_misc() == 0) {
824                         get_safe_ptr_action(condvar_waiters_map, curr->get_location())->push_back(curr);
825                         //disable us
826                         scheduler->sleep(get_thread(curr));
827                 }
828                 break;
829         }
830         case ATOMIC_NOTIFY_ALL: {
831                 action_list_t *waiters = get_safe_ptr_action(condvar_waiters_map, curr->get_location());
832                 //activate all the waiting threads
833                 for (action_list_t::iterator rit = waiters->begin(); rit != waiters->end(); rit++) {
834                         scheduler->wake(get_thread(*rit));
835                 }
836                 waiters->clear();
837                 break;
838         }
839         case ATOMIC_NOTIFY_ONE: {
840                 action_list_t *waiters = get_safe_ptr_action(condvar_waiters_map, curr->get_location());
841                 int wakeupthread = curr->get_node()->get_misc();
842                 action_list_t::iterator it = waiters->begin();
843                 advance(it, wakeupthread);
844                 scheduler->wake(get_thread(*it));
845                 waiters->erase(it);
846                 break;
847         }
848
849         default:
850                 ASSERT(0);
851         }
852         return false;
853 }
854
855 void ModelChecker::add_future_value(const ModelAction *writer, ModelAction *reader)
856 {
857         /* Do more ambitious checks now that mo is more complete */
858         if (mo_may_allow(writer, reader)) {
859                 struct future_value fv = {
860                         writer->get_value(),
861                         writer->get_seq_number() + params.maxfuturedelay,
862                 };
863                 if (reader->get_node()->add_future_value(fv))
864                         set_latest_backtrack(reader);
865         }
866 }
867
868 /**
869  * Process a write ModelAction
870  * @param curr The ModelAction to process
871  * @return True if the mo_graph was updated or promises were resolved
872  */
873 bool ModelChecker::process_write(ModelAction *curr)
874 {
875         bool updated_mod_order = w_modification_order(curr);
876         bool updated_promises = resolve_promises(curr);
877
878         if (promises->size() == 0) {
879                 for (unsigned int i = 0; i < futurevalues->size(); i++) {
880                         struct PendingFutureValue pfv = (*futurevalues)[i];
881                         add_future_value(pfv.writer, pfv.act);
882                 }
883                 futurevalues->clear();
884         }
885
886         mo_graph->commitChanges();
887         mo_check_promises(curr->get_tid(), curr, NULL);
888
889         get_thread(curr)->set_return_value(VALUE_NONE);
890         return updated_mod_order || updated_promises;
891 }
892
893 /**
894  * Process a fence ModelAction
895  * @param curr The ModelAction to process
896  * @return True if synchronization was updated
897  */
898 bool ModelChecker::process_fence(ModelAction *curr)
899 {
900         /*
901          * fence-relaxed: no-op
902          * fence-release: only log the occurence (not in this function), for
903          *   use in later synchronization
904          * fence-acquire (this function): search for hypothetical release
905          *   sequences
906          */
907         bool updated = false;
908         if (curr->is_acquire()) {
909                 action_list_t *list = action_trace;
910                 action_list_t::reverse_iterator rit;
911                 /* Find X : is_read(X) && X --sb-> curr */
912                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
913                         ModelAction *act = *rit;
914                         if (act == curr)
915                                 continue;
916                         if (act->get_tid() != curr->get_tid())
917                                 continue;
918                         /* Stop at the beginning of the thread */
919                         if (act->is_thread_start())
920                                 break;
921                         /* Stop once we reach a prior fence-acquire */
922                         if (act->is_fence() && act->is_acquire())
923                                 break;
924                         if (!act->is_read())
925                                 continue;
926                         /* read-acquire will find its own release sequences */
927                         if (act->is_acquire())
928                                 continue;
929
930                         /* Establish hypothetical release sequences */
931                         rel_heads_list_t release_heads;
932                         get_release_seq_heads(curr, act, &release_heads);
933                         for (unsigned int i = 0; i < release_heads.size(); i++)
934                                 if (!curr->synchronize_with(release_heads[i]))
935                                         set_bad_synchronization();
936                         if (release_heads.size() != 0)
937                                 updated = true;
938                 }
939         }
940         return updated;
941 }
942
943 /**
944  * @brief Process the current action for thread-related activity
945  *
946  * Performs current-action processing for a THREAD_* ModelAction. Proccesses
947  * may include setting Thread status, completing THREAD_FINISH/THREAD_JOIN
948  * synchronization, etc.  This function is a no-op for non-THREAD actions
949  * (e.g., ATOMIC_{READ,WRITE,RMW,LOCK}, etc.)
950  *
951  * @param curr The current action
952  * @return True if synchronization was updated or a thread completed
953  */
954 bool ModelChecker::process_thread_action(ModelAction *curr)
955 {
956         bool updated = false;
957
958         switch (curr->get_type()) {
959         case THREAD_CREATE: {
960                 Thread *th = curr->get_thread_operand();
961                 th->set_creation(curr);
962                 break;
963         }
964         case THREAD_JOIN: {
965                 Thread *blocking = curr->get_thread_operand();
966                 ModelAction *act = get_last_action(blocking->get_id());
967                 curr->synchronize_with(act);
968                 updated = true; /* trigger rel-seq checks */
969                 break;
970         }
971         case THREAD_FINISH: {
972                 Thread *th = get_thread(curr);
973                 while (!th->wait_list_empty()) {
974                         ModelAction *act = th->pop_wait_list();
975                         scheduler->wake(get_thread(act));
976                 }
977                 th->complete();
978                 updated = true; /* trigger rel-seq checks */
979                 break;
980         }
981         case THREAD_START: {
982                 check_promises(curr->get_tid(), NULL, curr->get_cv());
983                 break;
984         }
985         default:
986                 break;
987         }
988
989         return updated;
990 }
991
992 /**
993  * @brief Process the current action for release sequence fixup activity
994  *
995  * Performs model-checker release sequence fixups for the current action,
996  * forcing a single pending release sequence to break (with a given, potential
997  * "loose" write) or to complete (i.e., synchronize). If a pending release
998  * sequence forms a complete release sequence, then we must perform the fixup
999  * synchronization, mo_graph additions, etc.
1000  *
1001  * @param curr The current action; must be a release sequence fixup action
1002  * @param work_queue The work queue to which to add work items as they are
1003  * generated
1004  */
1005 void ModelChecker::process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue)
1006 {
1007         const ModelAction *write = curr->get_node()->get_relseq_break();
1008         struct release_seq *sequence = pending_rel_seqs->back();
1009         pending_rel_seqs->pop_back();
1010         ASSERT(sequence);
1011         ModelAction *acquire = sequence->acquire;
1012         const ModelAction *rf = sequence->rf;
1013         const ModelAction *release = sequence->release;
1014         ASSERT(acquire);
1015         ASSERT(release);
1016         ASSERT(rf);
1017         ASSERT(release->same_thread(rf));
1018
1019         if (write == NULL) {
1020                 /**
1021                  * @todo Forcing a synchronization requires that we set
1022                  * modification order constraints. For instance, we can't allow
1023                  * a fixup sequence in which two separate read-acquire
1024                  * operations read from the same sequence, where the first one
1025                  * synchronizes and the other doesn't. Essentially, we can't
1026                  * allow any writes to insert themselves between 'release' and
1027                  * 'rf'
1028                  */
1029
1030                 /* Must synchronize */
1031                 if (!acquire->synchronize_with(release)) {
1032                         set_bad_synchronization();
1033                         return;
1034                 }
1035                 /* Re-check all pending release sequences */
1036                 work_queue->push_back(CheckRelSeqWorkEntry(NULL));
1037                 /* Re-check act for mo_graph edges */
1038                 work_queue->push_back(MOEdgeWorkEntry(acquire));
1039
1040                 /* propagate synchronization to later actions */
1041                 action_list_t::reverse_iterator rit = action_trace->rbegin();
1042                 for (; (*rit) != acquire; rit++) {
1043                         ModelAction *propagate = *rit;
1044                         if (acquire->happens_before(propagate)) {
1045                                 propagate->synchronize_with(acquire);
1046                                 /* Re-check 'propagate' for mo_graph edges */
1047                                 work_queue->push_back(MOEdgeWorkEntry(propagate));
1048                         }
1049                 }
1050         } else {
1051                 /* Break release sequence with new edges:
1052                  *   release --mo--> write --mo--> rf */
1053                 mo_graph->addEdge(release, write);
1054                 mo_graph->addEdge(write, rf);
1055         }
1056
1057         /* See if we have realized a data race */
1058         checkDataRaces();
1059 }
1060
1061 /**
1062  * Initialize the current action by performing one or more of the following
1063  * actions, as appropriate: merging RMWR and RMWC/RMW actions, stepping forward
1064  * in the NodeStack, manipulating backtracking sets, allocating and
1065  * initializing clock vectors, and computing the promises to fulfill.
1066  *
1067  * @param curr The current action, as passed from the user context; may be
1068  * freed/invalidated after the execution of this function, with a different
1069  * action "returned" its place (pass-by-reference)
1070  * @return True if curr is a newly-explored action; false otherwise
1071  */
1072 bool ModelChecker::initialize_curr_action(ModelAction **curr)
1073 {
1074         ModelAction *newcurr;
1075
1076         if ((*curr)->is_rmwc() || (*curr)->is_rmw()) {
1077                 newcurr = process_rmw(*curr);
1078                 delete *curr;
1079
1080                 if (newcurr->is_rmw())
1081                         compute_promises(newcurr);
1082
1083                 *curr = newcurr;
1084                 return false;
1085         }
1086
1087         (*curr)->set_seq_number(get_next_seq_num());
1088
1089         newcurr = node_stack->explore_action(*curr, scheduler->get_enabled_array());
1090         if (newcurr) {
1091                 /* First restore type and order in case of RMW operation */
1092                 if ((*curr)->is_rmwr())
1093                         newcurr->copy_typeandorder(*curr);
1094
1095                 ASSERT((*curr)->get_location() == newcurr->get_location());
1096                 newcurr->copy_from_new(*curr);
1097
1098                 /* Discard duplicate ModelAction; use action from NodeStack */
1099                 delete *curr;
1100
1101                 /* Always compute new clock vector */
1102                 newcurr->create_cv(get_parent_action(newcurr->get_tid()));
1103
1104                 *curr = newcurr;
1105                 return false; /* Action was explored previously */
1106         } else {
1107                 newcurr = *curr;
1108
1109                 /* Always compute new clock vector */
1110                 newcurr->create_cv(get_parent_action(newcurr->get_tid()));
1111
1112                 /* Assign most recent release fence */
1113                 newcurr->set_last_fence_release(get_last_fence_release(newcurr->get_tid()));
1114
1115                 /*
1116                  * Perform one-time actions when pushing new ModelAction onto
1117                  * NodeStack
1118                  */
1119                 if (newcurr->is_write())
1120                         compute_promises(newcurr);
1121                 else if (newcurr->is_relseq_fixup())
1122                         compute_relseq_breakwrites(newcurr);
1123                 else if (newcurr->is_wait())
1124                         newcurr->get_node()->set_misc_max(2);
1125                 else if (newcurr->is_notify_one()) {
1126                         newcurr->get_node()->set_misc_max(get_safe_ptr_action(condvar_waiters_map, newcurr->get_location())->size());
1127                 }
1128                 return true; /* This was a new ModelAction */
1129         }
1130 }
1131
1132 /**
1133  * @brief Establish reads-from relation between two actions
1134  *
1135  * Perform basic operations involved with establishing a concrete rf relation,
1136  * including setting the ModelAction data and checking for release sequences.
1137  *
1138  * @param act The action that is reading (must be a read)
1139  * @param rf The action from which we are reading (must be a write)
1140  *
1141  * @return True if this read established synchronization
1142  */
1143 bool ModelChecker::read_from(ModelAction *act, const ModelAction *rf)
1144 {
1145         act->set_read_from(rf);
1146         if (rf != NULL && act->is_acquire()) {
1147                 rel_heads_list_t release_heads;
1148                 get_release_seq_heads(act, act, &release_heads);
1149                 int num_heads = release_heads.size();
1150                 for (unsigned int i = 0; i < release_heads.size(); i++)
1151                         if (!act->synchronize_with(release_heads[i])) {
1152                                 set_bad_synchronization();
1153                                 num_heads--;
1154                         }
1155                 return num_heads > 0;
1156         }
1157         return false;
1158 }
1159
1160 /**
1161  * @brief Check whether a model action is enabled.
1162  *
1163  * Checks whether a lock or join operation would be successful (i.e., is the
1164  * lock already locked, or is the joined thread already complete). If not, put
1165  * the action in a waiter list.
1166  *
1167  * @param curr is the ModelAction to check whether it is enabled.
1168  * @return a bool that indicates whether the action is enabled.
1169  */
1170 bool ModelChecker::check_action_enabled(ModelAction *curr) {
1171         if (curr->is_lock()) {
1172                 std::mutex *lock = (std::mutex *)curr->get_location();
1173                 struct std::mutex_state *state = lock->get_state();
1174                 if (state->islocked) {
1175                         //Stick the action in the appropriate waiting queue
1176                         get_safe_ptr_action(lock_waiters_map, curr->get_location())->push_back(curr);
1177                         return false;
1178                 }
1179         } else if (curr->get_type() == THREAD_JOIN) {
1180                 Thread *blocking = (Thread *)curr->get_location();
1181                 if (!blocking->is_complete()) {
1182                         blocking->push_wait_list(curr);
1183                         return false;
1184                 }
1185         }
1186
1187         return true;
1188 }
1189
1190 /**
1191  * Stores the ModelAction for the current thread action.  Call this
1192  * immediately before switching from user- to system-context to pass
1193  * data between them.
1194  * @param act The ModelAction created by the user-thread action
1195  */
1196 void ModelChecker::set_current_action(ModelAction *act) {
1197         priv->current_action = act;
1198 }
1199
1200 /**
1201  * This is the heart of the model checker routine. It performs model-checking
1202  * actions corresponding to a given "current action." Among other processes, it
1203  * calculates reads-from relationships, updates synchronization clock vectors,
1204  * forms a memory_order constraints graph, and handles replay/backtrack
1205  * execution when running permutations of previously-observed executions.
1206  *
1207  * @param curr The current action to process
1208  * @return The ModelAction that is actually executed; may be different than
1209  * curr; may be NULL, if the current action is not enabled to run
1210  */
1211 ModelAction * ModelChecker::check_current_action(ModelAction *curr)
1212 {
1213         ASSERT(curr);
1214         bool second_part_of_rmw = curr->is_rmwc() || curr->is_rmw();
1215
1216         if (!check_action_enabled(curr)) {
1217                 /* Make the execution look like we chose to run this action
1218                  * much later, when a lock/join can succeed */
1219                 get_thread(curr)->set_pending(curr);
1220                 scheduler->sleep(get_thread(curr));
1221                 return NULL;
1222         }
1223
1224         bool newly_explored = initialize_curr_action(&curr);
1225
1226         DBG();
1227         if (DBG_ENABLED())
1228                 curr->print();
1229
1230         wake_up_sleeping_actions(curr);
1231
1232         /* Add the action to lists before any other model-checking tasks */
1233         if (!second_part_of_rmw)
1234                 add_action_to_lists(curr);
1235
1236         /* Build may_read_from set for newly-created actions */
1237         if (newly_explored && curr->is_read())
1238                 build_reads_from_past(curr);
1239
1240         /* Initialize work_queue with the "current action" work */
1241         work_queue_t work_queue(1, CheckCurrWorkEntry(curr));
1242         while (!work_queue.empty() && !has_asserted()) {
1243                 WorkQueueEntry work = work_queue.front();
1244                 work_queue.pop_front();
1245
1246                 switch (work.type) {
1247                 case WORK_CHECK_CURR_ACTION: {
1248                         ModelAction *act = work.action;
1249                         bool update = false; /* update this location's release seq's */
1250                         bool update_all = false; /* update all release seq's */
1251
1252                         if (process_thread_action(curr))
1253                                 update_all = true;
1254
1255                         if (act->is_read() && process_read(act, second_part_of_rmw))
1256                                 update = true;
1257
1258                         if (act->is_write() && process_write(act))
1259                                 update = true;
1260
1261                         if (act->is_fence() && process_fence(act))
1262                                 update_all = true;
1263
1264                         if (act->is_mutex_op() && process_mutex(act))
1265                                 update_all = true;
1266
1267                         if (act->is_relseq_fixup())
1268                                 process_relseq_fixup(curr, &work_queue);
1269
1270                         if (update_all)
1271                                 work_queue.push_back(CheckRelSeqWorkEntry(NULL));
1272                         else if (update)
1273                                 work_queue.push_back(CheckRelSeqWorkEntry(act->get_location()));
1274                         break;
1275                 }
1276                 case WORK_CHECK_RELEASE_SEQ:
1277                         resolve_release_sequences(work.location, &work_queue);
1278                         break;
1279                 case WORK_CHECK_MO_EDGES: {
1280                         /** @todo Complete verification of work_queue */
1281                         ModelAction *act = work.action;
1282                         bool updated = false;
1283
1284                         if (act->is_read()) {
1285                                 const ModelAction *rf = act->get_reads_from();
1286                                 if (rf != NULL && r_modification_order(act, rf))
1287                                         updated = true;
1288                         }
1289                         if (act->is_write()) {
1290                                 if (w_modification_order(act))
1291                                         updated = true;
1292                         }
1293                         mo_graph->commitChanges();
1294
1295                         if (updated)
1296                                 work_queue.push_back(CheckRelSeqWorkEntry(act->get_location()));
1297                         break;
1298                 }
1299                 default:
1300                         ASSERT(false);
1301                         break;
1302                 }
1303         }
1304
1305         check_curr_backtracking(curr);
1306         set_backtracking(curr);
1307         return curr;
1308 }
1309
1310 void ModelChecker::check_curr_backtracking(ModelAction *curr)
1311 {
1312         Node *currnode = curr->get_node();
1313         Node *parnode = currnode->get_parent();
1314
1315         if ((parnode && !parnode->backtrack_empty()) ||
1316                          !currnode->misc_empty() ||
1317                          !currnode->read_from_empty() ||
1318                          !currnode->future_value_empty() ||
1319                          !currnode->promise_empty() ||
1320                          !currnode->relseq_break_empty()) {
1321                 set_latest_backtrack(curr);
1322         }
1323 }
1324
1325 bool ModelChecker::promises_expired() const
1326 {
1327         for (unsigned int i = 0; i < promises->size(); i++) {
1328                 Promise *promise = (*promises)[i];
1329                 if (promise->get_expiration() < priv->used_sequence_numbers)
1330                         return true;
1331         }
1332         return false;
1333 }
1334
1335 /**
1336  * This is the strongest feasibility check available.
1337  * @return whether the current trace (partial or complete) must be a prefix of
1338  * a feasible trace.
1339  */
1340 bool ModelChecker::isfeasibleprefix() const
1341 {
1342         return pending_rel_seqs->size() == 0 && is_feasible_prefix_ignore_relseq();
1343 }
1344
1345 /**
1346  * Print disagnostic information about an infeasible execution
1347  * @param prefix A string to prefix the output with; if NULL, then a default
1348  * message prefix will be provided
1349  */
1350 void ModelChecker::print_infeasibility(const char *prefix) const
1351 {
1352         char buf[100];
1353         char *ptr = buf;
1354         if (mo_graph->checkForRMWViolation())
1355                 ptr += sprintf(ptr, "[RMW atomicity]");
1356         if (mo_graph->checkForCycles())
1357                 ptr += sprintf(ptr, "[mo cycle]");
1358         if (priv->failed_promise)
1359                 ptr += sprintf(ptr, "[failed promise]");
1360         if (priv->too_many_reads)
1361                 ptr += sprintf(ptr, "[too many reads]");
1362         if (priv->bad_synchronization)
1363                 ptr += sprintf(ptr, "[bad sw ordering]");
1364         if (promises_expired())
1365                 ptr += sprintf(ptr, "[promise expired]");
1366         if (promises->size() != 0)
1367                 ptr += sprintf(ptr, "[unresolved promise]");
1368         if (ptr != buf)
1369                 model_print("%s: %s\n", prefix ? prefix : "Infeasible", buf);
1370 }
1371
1372 /**
1373  * Returns whether the current completed trace is feasible, except for pending
1374  * release sequences.
1375  */
1376 bool ModelChecker::is_feasible_prefix_ignore_relseq() const
1377 {
1378         return !is_infeasible() && promises->size() == 0;
1379 }
1380
1381 /**
1382  * Check if the current partial trace is infeasible. Does not check any
1383  * end-of-execution flags, which might rule out the execution. Thus, this is
1384  * useful only for ruling an execution as infeasible.
1385  * @return whether the current partial trace is infeasible.
1386  */
1387 bool ModelChecker::is_infeasible() const
1388 {
1389         return mo_graph->checkForRMWViolation() || is_infeasible_ignoreRMW();
1390 }
1391
1392 /**
1393  * Check If the current partial trace is infeasible, while ignoring
1394  * infeasibility related to 2 RMW's reading from the same store. It does not
1395  * check end-of-execution feasibility.
1396  * @see ModelChecker::is_infeasible
1397  * @return whether the current partial trace is infeasible, ignoring multiple
1398  * RMWs reading from the same store.
1399  * */
1400 bool ModelChecker::is_infeasible_ignoreRMW() const
1401 {
1402         return mo_graph->checkForCycles() || priv->failed_promise ||
1403                 priv->too_many_reads || priv->bad_synchronization ||
1404                 promises_expired();
1405 }
1406
1407 /** Close out a RMWR by converting previous RMWR into a RMW or READ. */
1408 ModelAction * ModelChecker::process_rmw(ModelAction *act) {
1409         ModelAction *lastread = get_last_action(act->get_tid());
1410         lastread->process_rmw(act);
1411         if (act->is_rmw() && lastread->get_reads_from() != NULL) {
1412                 mo_graph->addRMWEdge(lastread->get_reads_from(), lastread);
1413                 mo_graph->commitChanges();
1414         }
1415         return lastread;
1416 }
1417
1418 /**
1419  * Checks whether a thread has read from the same write for too many times
1420  * without seeing the effects of a later write.
1421  *
1422  * Basic idea:
1423  * 1) there must a different write that we could read from that would satisfy the modification order,
1424  * 2) we must have read from the same value in excess of maxreads times, and
1425  * 3) that other write must have been in the reads_from set for maxreads times.
1426  *
1427  * If so, we decide that the execution is no longer feasible.
1428  */
1429 void ModelChecker::check_recency(ModelAction *curr, const ModelAction *rf)
1430 {
1431         if (params.maxreads != 0) {
1432                 if (curr->get_node()->get_read_from_size() <= 1)
1433                         return;
1434                 //Must make sure that execution is currently feasible...  We could
1435                 //accidentally clear by rolling back
1436                 if (is_infeasible())
1437                         return;
1438                 std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, curr->get_location());
1439                 int tid = id_to_int(curr->get_tid());
1440
1441                 /* Skip checks */
1442                 if ((int)thrd_lists->size() <= tid)
1443                         return;
1444                 action_list_t *list = &(*thrd_lists)[tid];
1445
1446                 action_list_t::reverse_iterator rit = list->rbegin();
1447                 /* Skip past curr */
1448                 for (; (*rit) != curr; rit++)
1449                         ;
1450                 /* go past curr now */
1451                 rit++;
1452
1453                 action_list_t::reverse_iterator ritcopy = rit;
1454                 //See if we have enough reads from the same value
1455                 int count = 0;
1456                 for (; count < params.maxreads; rit++, count++) {
1457                         if (rit == list->rend())
1458                                 return;
1459                         ModelAction *act = *rit;
1460                         if (!act->is_read())
1461                                 return;
1462
1463                         if (act->get_reads_from() != rf)
1464                                 return;
1465                         if (act->get_node()->get_read_from_size() <= 1)
1466                                 return;
1467                 }
1468                 for (int i = 0; i < curr->get_node()->get_read_from_size(); i++) {
1469                         /* Get write */
1470                         const ModelAction *write = curr->get_node()->get_read_from_at(i);
1471
1472                         /* Need a different write */
1473                         if (write == rf)
1474                                 continue;
1475
1476                         /* Test to see whether this is a feasible write to read from */
1477                         mo_graph->startChanges();
1478                         r_modification_order(curr, write);
1479                         bool feasiblereadfrom = !is_infeasible();
1480                         mo_graph->rollbackChanges();
1481
1482                         if (!feasiblereadfrom)
1483                                 continue;
1484                         rit = ritcopy;
1485
1486                         bool feasiblewrite = true;
1487                         //new we need to see if this write works for everyone
1488
1489                         for (int loop = count; loop > 0; loop--, rit++) {
1490                                 ModelAction *act = *rit;
1491                                 bool foundvalue = false;
1492                                 for (int j = 0; j < act->get_node()->get_read_from_size(); j++) {
1493                                         if (act->get_node()->get_read_from_at(j) == write) {
1494                                                 foundvalue = true;
1495                                                 break;
1496                                         }
1497                                 }
1498                                 if (!foundvalue) {
1499                                         feasiblewrite = false;
1500                                         break;
1501                                 }
1502                         }
1503                         if (feasiblewrite) {
1504                                 priv->too_many_reads = true;
1505                                 return;
1506                         }
1507                 }
1508         }
1509 }
1510
1511 /**
1512  * Updates the mo_graph with the constraints imposed from the current
1513  * read.
1514  *
1515  * Basic idea is the following: Go through each other thread and find
1516  * the lastest action that happened before our read.  Two cases:
1517  *
1518  * (1) The action is a write => that write must either occur before
1519  * the write we read from or be the write we read from.
1520  *
1521  * (2) The action is a read => the write that that action read from
1522  * must occur before the write we read from or be the same write.
1523  *
1524  * @param curr The current action. Must be a read.
1525  * @param rf The action that curr reads from. Must be a write.
1526  * @return True if modification order edges were added; false otherwise
1527  */
1528 bool ModelChecker::r_modification_order(ModelAction *curr, const ModelAction *rf)
1529 {
1530         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, curr->get_location());
1531         unsigned int i;
1532         bool added = false;
1533         ASSERT(curr->is_read());
1534
1535         /* Last SC fence in the current thread */
1536         ModelAction *last_sc_fence_local = get_last_seq_cst_fence(curr->get_tid(), NULL);
1537
1538         /* Iterate over all threads */
1539         for (i = 0; i < thrd_lists->size(); i++) {
1540                 /* Last SC fence in thread i */
1541                 ModelAction *last_sc_fence_thread_local = NULL;
1542                 if (int_to_id((int)i) != curr->get_tid())
1543                         last_sc_fence_thread_local = get_last_seq_cst_fence(int_to_id(i), NULL);
1544
1545                 /* Last SC fence in thread i, before last SC fence in current thread */
1546                 ModelAction *last_sc_fence_thread_before = NULL;
1547                 if (last_sc_fence_local)
1548                         last_sc_fence_thread_before = get_last_seq_cst_fence(int_to_id(i), last_sc_fence_local);
1549
1550                 /* Iterate over actions in thread, starting from most recent */
1551                 action_list_t *list = &(*thrd_lists)[i];
1552                 action_list_t::reverse_iterator rit;
1553                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1554                         ModelAction *act = *rit;
1555
1556                         if (act->is_write() && act != rf && act != curr) {
1557                                 /* C++, Section 29.3 statement 5 */
1558                                 if (curr->is_seqcst() && last_sc_fence_thread_local &&
1559                                                 *act < *last_sc_fence_thread_local) {
1560                                         mo_graph->addEdge(act, rf);
1561                                         added = true;
1562                                         break;
1563                                 }
1564                                 /* C++, Section 29.3 statement 4 */
1565                                 else if (act->is_seqcst() && last_sc_fence_local &&
1566                                                 *act < *last_sc_fence_local) {
1567                                         mo_graph->addEdge(act, rf);
1568                                         added = true;
1569                                         break;
1570                                 }
1571                                 /* C++, Section 29.3 statement 6 */
1572                                 else if (last_sc_fence_thread_before &&
1573                                                 *act < *last_sc_fence_thread_before) {
1574                                         mo_graph->addEdge(act, rf);
1575                                         added = true;
1576                                         break;
1577                                 }
1578                         }
1579
1580                         /*
1581                          * Include at most one act per-thread that "happens
1582                          * before" curr. Don't consider reflexively.
1583                          */
1584                         if (act->happens_before(curr) && act != curr) {
1585                                 if (act->is_write()) {
1586                                         if (rf != act) {
1587                                                 mo_graph->addEdge(act, rf);
1588                                                 added = true;
1589                                         }
1590                                 } else {
1591                                         const ModelAction *prevreadfrom = act->get_reads_from();
1592                                         //if the previous read is unresolved, keep going...
1593                                         if (prevreadfrom == NULL)
1594                                                 continue;
1595
1596                                         if (rf != prevreadfrom) {
1597                                                 mo_graph->addEdge(prevreadfrom, rf);
1598                                                 added = true;
1599                                         }
1600                                 }
1601                                 break;
1602                         }
1603                 }
1604         }
1605
1606         return added;
1607 }
1608
1609 /** This method fixes up the modification order when we resolve a
1610  *  promises.  The basic problem is that actions that occur after the
1611  *  read curr could not property add items to the modification order
1612  *  for our read.
1613  *
1614  *  So for each thread, we find the earliest item that happens after
1615  *  the read curr.  This is the item we have to fix up with additional
1616  *  constraints.  If that action is write, we add a MO edge between
1617  *  the Action rf and that action.  If the action is a read, we add a
1618  *  MO edge between the Action rf, and whatever the read accessed.
1619  *
1620  * @param curr is the read ModelAction that we are fixing up MO edges for.
1621  * @param rf is the write ModelAction that curr reads from.
1622  *
1623  */
1624 void ModelChecker::post_r_modification_order(ModelAction *curr, const ModelAction *rf)
1625 {
1626         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, curr->get_location());
1627         unsigned int i;
1628         ASSERT(curr->is_read());
1629
1630         /* Iterate over all threads */
1631         for (i = 0; i < thrd_lists->size(); i++) {
1632                 /* Iterate over actions in thread, starting from most recent */
1633                 action_list_t *list = &(*thrd_lists)[i];
1634                 action_list_t::reverse_iterator rit;
1635                 ModelAction *lastact = NULL;
1636
1637                 /* Find last action that happens after curr that is either not curr or a rmw */
1638                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1639                         ModelAction *act = *rit;
1640                         if (curr->happens_before(act) && (curr != act || curr->is_rmw())) {
1641                                 lastact = act;
1642                         } else
1643                                 break;
1644                 }
1645
1646                         /* Include at most one act per-thread that "happens before" curr */
1647                 if (lastact != NULL) {
1648                         if (lastact == curr) {
1649                                 //Case 1: The resolved read is a RMW, and we need to make sure
1650                                 //that the write portion of the RMW mod order after rf
1651
1652                                 mo_graph->addEdge(rf, lastact);
1653                         } else if (lastact->is_read()) {
1654                                 //Case 2: The resolved read is a normal read and the next
1655                                 //operation is a read, and we need to make sure the value read
1656                                 //is mod ordered after rf
1657
1658                                 const ModelAction *postreadfrom = lastact->get_reads_from();
1659                                 if (postreadfrom != NULL && rf != postreadfrom)
1660                                         mo_graph->addEdge(rf, postreadfrom);
1661                         } else {
1662                                 //Case 3: The resolved read is a normal read and the next
1663                                 //operation is a write, and we need to make sure that the
1664                                 //write is mod ordered after rf
1665                                 if (lastact != rf)
1666                                         mo_graph->addEdge(rf, lastact);
1667                         }
1668                         break;
1669                 }
1670         }
1671 }
1672
1673 /**
1674  * Updates the mo_graph with the constraints imposed from the current write.
1675  *
1676  * Basic idea is the following: Go through each other thread and find
1677  * the lastest action that happened before our write.  Two cases:
1678  *
1679  * (1) The action is a write => that write must occur before
1680  * the current write
1681  *
1682  * (2) The action is a read => the write that that action read from
1683  * must occur before the current write.
1684  *
1685  * This method also handles two other issues:
1686  *
1687  * (I) Sequential Consistency: Making sure that if the current write is
1688  * seq_cst, that it occurs after the previous seq_cst write.
1689  *
1690  * (II) Sending the write back to non-synchronizing reads.
1691  *
1692  * @param curr The current action. Must be a write.
1693  * @return True if modification order edges were added; false otherwise
1694  */
1695 bool ModelChecker::w_modification_order(ModelAction *curr)
1696 {
1697         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, curr->get_location());
1698         unsigned int i;
1699         bool added = false;
1700         ASSERT(curr->is_write());
1701
1702         if (curr->is_seqcst()) {
1703                 /* We have to at least see the last sequentially consistent write,
1704                          so we are initialized. */
1705                 ModelAction *last_seq_cst = get_last_seq_cst_write(curr);
1706                 if (last_seq_cst != NULL) {
1707                         mo_graph->addEdge(last_seq_cst, curr);
1708                         added = true;
1709                 }
1710         }
1711
1712         /* Last SC fence in the current thread */
1713         ModelAction *last_sc_fence_local = get_last_seq_cst_fence(curr->get_tid(), NULL);
1714
1715         /* Iterate over all threads */
1716         for (i = 0; i < thrd_lists->size(); i++) {
1717                 /* Last SC fence in thread i, before last SC fence in current thread */
1718                 ModelAction *last_sc_fence_thread_before = NULL;
1719                 if (last_sc_fence_local && int_to_id((int)i) != curr->get_tid())
1720                         last_sc_fence_thread_before = get_last_seq_cst_fence(int_to_id(i), last_sc_fence_local);
1721
1722                 /* Iterate over actions in thread, starting from most recent */
1723                 action_list_t *list = &(*thrd_lists)[i];
1724                 action_list_t::reverse_iterator rit;
1725                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1726                         ModelAction *act = *rit;
1727                         if (act == curr) {
1728                                 /*
1729                                  * 1) If RMW and it actually read from something, then we
1730                                  * already have all relevant edges, so just skip to next
1731                                  * thread.
1732                                  *
1733                                  * 2) If RMW and it didn't read from anything, we should
1734                                  * whatever edge we can get to speed up convergence.
1735                                  *
1736                                  * 3) If normal write, we need to look at earlier actions, so
1737                                  * continue processing list.
1738                                  */
1739                                 if (curr->is_rmw()) {
1740                                         if (curr->get_reads_from() != NULL)
1741                                                 break;
1742                                         else
1743                                                 continue;
1744                                 } else
1745                                         continue;
1746                         }
1747
1748                         /* C++, Section 29.3 statement 7 */
1749                         if (last_sc_fence_thread_before && act->is_write() &&
1750                                         *act < *last_sc_fence_thread_before) {
1751                                 mo_graph->addEdge(act, curr);
1752                                 added = true;
1753                                 break;
1754                         }
1755
1756                         /*
1757                          * Include at most one act per-thread that "happens
1758                          * before" curr
1759                          */
1760                         if (act->happens_before(curr)) {
1761                                 /*
1762                                  * Note: if act is RMW, just add edge:
1763                                  *   act --mo--> curr
1764                                  * The following edge should be handled elsewhere:
1765                                  *   readfrom(act) --mo--> act
1766                                  */
1767                                 if (act->is_write())
1768                                         mo_graph->addEdge(act, curr);
1769                                 else if (act->is_read()) {
1770                                         //if previous read accessed a null, just keep going
1771                                         if (act->get_reads_from() == NULL)
1772                                                 continue;
1773                                         mo_graph->addEdge(act->get_reads_from(), curr);
1774                                 }
1775                                 added = true;
1776                                 break;
1777                         } else if (act->is_read() && !act->could_synchronize_with(curr) &&
1778                                                      !act->same_thread(curr)) {
1779                                 /* We have an action that:
1780                                    (1) did not happen before us
1781                                    (2) is a read and we are a write
1782                                    (3) cannot synchronize with us
1783                                    (4) is in a different thread
1784                                    =>
1785                                    that read could potentially read from our write.  Note that
1786                                    these checks are overly conservative at this point, we'll
1787                                    do more checks before actually removing the
1788                                    pendingfuturevalue.
1789
1790                                  */
1791                                 if (thin_air_constraint_may_allow(curr, act)) {
1792                                         if (!is_infeasible() ||
1793                                                         (curr->is_rmw() && act->is_rmw() && curr->get_reads_from() == act->get_reads_from() && !is_infeasible_ignoreRMW())) {
1794                                                 futurevalues->push_back(PendingFutureValue(curr, act));
1795                                         }
1796                                 }
1797                         }
1798                 }
1799         }
1800
1801         return added;
1802 }
1803
1804 /** Arbitrary reads from the future are not allowed.  Section 29.3
1805  * part 9 places some constraints.  This method checks one result of constraint
1806  * constraint.  Others require compiler support. */
1807 bool ModelChecker::thin_air_constraint_may_allow(const ModelAction *writer, const ModelAction *reader)
1808 {
1809         if (!writer->is_rmw())
1810                 return true;
1811
1812         if (!reader->is_rmw())
1813                 return true;
1814
1815         for (const ModelAction *search = writer->get_reads_from(); search != NULL; search = search->get_reads_from()) {
1816                 if (search == reader)
1817                         return false;
1818                 if (search->get_tid() == reader->get_tid() &&
1819                                 search->happens_before(reader))
1820                         break;
1821         }
1822
1823         return true;
1824 }
1825
1826 /**
1827  * Arbitrary reads from the future are not allowed. Section 29.3 part 9 places
1828  * some constraints. This method checks one the following constraint (others
1829  * require compiler support):
1830  *
1831  *   If X --hb-> Y --mo-> Z, then X should not read from Z.
1832  */
1833 bool ModelChecker::mo_may_allow(const ModelAction *writer, const ModelAction *reader)
1834 {
1835         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, reader->get_location());
1836         unsigned int i;
1837         /* Iterate over all threads */
1838         for (i = 0; i < thrd_lists->size(); i++) {
1839                 const ModelAction *write_after_read = NULL;
1840
1841                 /* Iterate over actions in thread, starting from most recent */
1842                 action_list_t *list = &(*thrd_lists)[i];
1843                 action_list_t::reverse_iterator rit;
1844                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1845                         ModelAction *act = *rit;
1846
1847                         /* Don't disallow due to act == reader */
1848                         if (!reader->happens_before(act) || reader == act)
1849                                 break;
1850                         else if (act->is_write())
1851                                 write_after_read = act;
1852                         else if (act->is_read() && act->get_reads_from() != NULL)
1853                                 write_after_read = act->get_reads_from();
1854                 }
1855
1856                 if (write_after_read && write_after_read != writer && mo_graph->checkReachable(write_after_read, writer))
1857                         return false;
1858         }
1859         return true;
1860 }
1861
1862 /**
1863  * Finds the head(s) of the release sequence(s) containing a given ModelAction.
1864  * The ModelAction under consideration is expected to be taking part in
1865  * release/acquire synchronization as an object of the "reads from" relation.
1866  * Note that this can only provide release sequence support for RMW chains
1867  * which do not read from the future, as those actions cannot be traced until
1868  * their "promise" is fulfilled. Similarly, we may not even establish the
1869  * presence of a release sequence with certainty, as some modification order
1870  * constraints may be decided further in the future. Thus, this function
1871  * "returns" two pieces of data: a pass-by-reference vector of @a release_heads
1872  * and a boolean representing certainty.
1873  *
1874  * @param rf The action that might be part of a release sequence. Must be a
1875  * write.
1876  * @param release_heads A pass-by-reference style return parameter. After
1877  * execution of this function, release_heads will contain the heads of all the
1878  * relevant release sequences, if any exists with certainty
1879  * @param pending A pass-by-reference style return parameter which is only used
1880  * when returning false (i.e., uncertain). Returns most information regarding
1881  * an uncertain release sequence, including any write operations that might
1882  * break the sequence.
1883  * @return true, if the ModelChecker is certain that release_heads is complete;
1884  * false otherwise
1885  */
1886 bool ModelChecker::release_seq_heads(const ModelAction *rf,
1887                 rel_heads_list_t *release_heads,
1888                 struct release_seq *pending) const
1889 {
1890         /* Only check for release sequences if there are no cycles */
1891         if (mo_graph->checkForCycles())
1892                 return false;
1893
1894         while (rf) {
1895                 ASSERT(rf->is_write());
1896
1897                 if (rf->is_release())
1898                         release_heads->push_back(rf);
1899                 else if (rf->get_last_fence_release())
1900                         release_heads->push_back(rf->get_last_fence_release());
1901                 if (!rf->is_rmw())
1902                         break; /* End of RMW chain */
1903
1904                 /** @todo Need to be smarter here...  In the linux lock
1905                  * example, this will run to the beginning of the program for
1906                  * every acquire. */
1907                 /** @todo The way to be smarter here is to keep going until 1
1908                  * thread has a release preceded by an acquire and you've seen
1909                  *       both. */
1910
1911                 /* acq_rel RMW is a sufficient stopping condition */
1912                 if (rf->is_acquire() && rf->is_release())
1913                         return true; /* complete */
1914
1915                 rf = rf->get_reads_from();
1916         };
1917         if (!rf) {
1918                 /* read from future: need to settle this later */
1919                 pending->rf = NULL;
1920                 return false; /* incomplete */
1921         }
1922
1923         if (rf->is_release())
1924                 return true; /* complete */
1925
1926         /* else relaxed write
1927          * - check for fence-release in the same thread (29.8, stmt. 3)
1928          * - check modification order for contiguous subsequence
1929          *   -> rf must be same thread as release */
1930
1931         const ModelAction *fence_release = rf->get_last_fence_release();
1932         /* Synchronize with a fence-release unconditionally; we don't need to
1933          * find any more "contiguous subsequence..." for it */
1934         if (fence_release)
1935                 release_heads->push_back(fence_release);
1936
1937         int tid = id_to_int(rf->get_tid());
1938         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, rf->get_location());
1939         action_list_t *list = &(*thrd_lists)[tid];
1940         action_list_t::const_reverse_iterator rit;
1941
1942         /* Find rf in the thread list */
1943         rit = std::find(list->rbegin(), list->rend(), rf);
1944         ASSERT(rit != list->rend());
1945
1946         /* Find the last {write,fence}-release */
1947         for (; rit != list->rend(); rit++) {
1948                 if (fence_release && *(*rit) < *fence_release)
1949                         break;
1950                 if ((*rit)->is_release())
1951                         break;
1952         }
1953         if (rit == list->rend()) {
1954                 /* No write-release in this thread */
1955                 return true; /* complete */
1956         } else if (fence_release && *(*rit) < *fence_release) {
1957                 /* The fence-release is more recent (and so, "stronger") than
1958                  * the most recent write-release */
1959                 return true; /* complete */
1960         } /* else, need to establish contiguous release sequence */
1961         ModelAction *release = *rit;
1962
1963         ASSERT(rf->same_thread(release));
1964
1965         pending->writes.clear();
1966
1967         bool certain = true;
1968         for (unsigned int i = 0; i < thrd_lists->size(); i++) {
1969                 if (id_to_int(rf->get_tid()) == (int)i)
1970                         continue;
1971                 list = &(*thrd_lists)[i];
1972
1973                 /* Can we ensure no future writes from this thread may break
1974                  * the release seq? */
1975                 bool future_ordered = false;
1976
1977                 ModelAction *last = get_last_action(int_to_id(i));
1978                 Thread *th = get_thread(int_to_id(i));
1979                 if ((last && rf->happens_before(last)) ||
1980                                 !is_enabled(th) ||
1981                                 th->is_complete())
1982                         future_ordered = true;
1983
1984                 ASSERT(!th->is_model_thread() || future_ordered);
1985
1986                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1987                         const ModelAction *act = *rit;
1988                         /* Reach synchronization -> this thread is complete */
1989                         if (act->happens_before(release))
1990                                 break;
1991                         if (rf->happens_before(act)) {
1992                                 future_ordered = true;
1993                                 continue;
1994                         }
1995
1996                         /* Only non-RMW writes can break release sequences */
1997                         if (!act->is_write() || act->is_rmw())
1998                                 continue;
1999
2000                         /* Check modification order */
2001                         if (mo_graph->checkReachable(rf, act)) {
2002                                 /* rf --mo--> act */
2003                                 future_ordered = true;
2004                                 continue;
2005                         }
2006                         if (mo_graph->checkReachable(act, release))
2007                                 /* act --mo--> release */
2008                                 break;
2009                         if (mo_graph->checkReachable(release, act) &&
2010                                       mo_graph->checkReachable(act, rf)) {
2011                                 /* release --mo-> act --mo--> rf */
2012                                 return true; /* complete */
2013                         }
2014                         /* act may break release sequence */
2015                         pending->writes.push_back(act);
2016                         certain = false;
2017                 }
2018                 if (!future_ordered)
2019                         certain = false; /* This thread is uncertain */
2020         }
2021
2022         if (certain) {
2023                 release_heads->push_back(release);
2024                 pending->writes.clear();
2025         } else {
2026                 pending->release = release;
2027                 pending->rf = rf;
2028         }
2029         return certain;
2030 }
2031
2032 /**
2033  * An interface for getting the release sequence head(s) with which a
2034  * given ModelAction must synchronize. This function only returns a non-empty
2035  * result when it can locate a release sequence head with certainty. Otherwise,
2036  * it may mark the internal state of the ModelChecker so that it will handle
2037  * the release sequence at a later time, causing @a acquire to update its
2038  * synchronization at some later point in execution.
2039  *
2040  * @param acquire The 'acquire' action that may synchronize with a release
2041  * sequence
2042  * @param read The read action that may read from a release sequence; this may
2043  * be the same as acquire, or else an earlier action in the same thread (i.e.,
2044  * when 'acquire' is a fence-acquire)
2045  * @param release_heads A pass-by-reference return parameter. Will be filled
2046  * with the head(s) of the release sequence(s), if they exists with certainty.
2047  * @see ModelChecker::release_seq_heads
2048  */
2049 void ModelChecker::get_release_seq_heads(ModelAction *acquire,
2050                 ModelAction *read, rel_heads_list_t *release_heads)
2051 {
2052         const ModelAction *rf = read->get_reads_from();
2053         struct release_seq *sequence = (struct release_seq *)snapshot_calloc(1, sizeof(struct release_seq));
2054         sequence->acquire = acquire;
2055         sequence->read = read;
2056
2057         if (!release_seq_heads(rf, release_heads, sequence)) {
2058                 /* add act to 'lazy checking' list */
2059                 pending_rel_seqs->push_back(sequence);
2060         } else {
2061                 snapshot_free(sequence);
2062         }
2063 }
2064
2065 /**
2066  * Attempt to resolve all stashed operations that might synchronize with a
2067  * release sequence for a given location. This implements the "lazy" portion of
2068  * determining whether or not a release sequence was contiguous, since not all
2069  * modification order information is present at the time an action occurs.
2070  *
2071  * @param location The location/object that should be checked for release
2072  * sequence resolutions. A NULL value means to check all locations.
2073  * @param work_queue The work queue to which to add work items as they are
2074  * generated
2075  * @return True if any updates occurred (new synchronization, new mo_graph
2076  * edges)
2077  */
2078 bool ModelChecker::resolve_release_sequences(void *location, work_queue_t *work_queue)
2079 {
2080         bool updated = false;
2081         std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> >::iterator it = pending_rel_seqs->begin();
2082         while (it != pending_rel_seqs->end()) {
2083                 struct release_seq *pending = *it;
2084                 ModelAction *acquire = pending->acquire;
2085                 const ModelAction *read = pending->read;
2086
2087                 /* Only resolve sequences on the given location, if provided */
2088                 if (location && read->get_location() != location) {
2089                         it++;
2090                         continue;
2091                 }
2092
2093                 const ModelAction *rf = read->get_reads_from();
2094                 rel_heads_list_t release_heads;
2095                 bool complete;
2096                 complete = release_seq_heads(rf, &release_heads, pending);
2097                 for (unsigned int i = 0; i < release_heads.size(); i++) {
2098                         if (!acquire->has_synchronized_with(release_heads[i])) {
2099                                 if (acquire->synchronize_with(release_heads[i]))
2100                                         updated = true;
2101                                 else
2102                                         set_bad_synchronization();
2103                         }
2104                 }
2105
2106                 if (updated) {
2107                         /* Re-check all pending release sequences */
2108                         work_queue->push_back(CheckRelSeqWorkEntry(NULL));
2109                         /* Re-check read-acquire for mo_graph edges */
2110                         if (acquire->is_read())
2111                                 work_queue->push_back(MOEdgeWorkEntry(acquire));
2112
2113                         /* propagate synchronization to later actions */
2114                         action_list_t::reverse_iterator rit = action_trace->rbegin();
2115                         for (; (*rit) != acquire; rit++) {
2116                                 ModelAction *propagate = *rit;
2117                                 if (acquire->happens_before(propagate)) {
2118                                         propagate->synchronize_with(acquire);
2119                                         /* Re-check 'propagate' for mo_graph edges */
2120                                         work_queue->push_back(MOEdgeWorkEntry(propagate));
2121                                 }
2122                         }
2123                 }
2124                 if (complete) {
2125                         it = pending_rel_seqs->erase(it);
2126                         snapshot_free(pending);
2127                 } else {
2128                         it++;
2129                 }
2130         }
2131
2132         // If we resolved promises or data races, see if we have realized a data race.
2133         checkDataRaces();
2134
2135         return updated;
2136 }
2137
2138 /**
2139  * Performs various bookkeeping operations for the current ModelAction. For
2140  * instance, adds action to the per-object, per-thread action vector and to the
2141  * action trace list of all thread actions.
2142  *
2143  * @param act is the ModelAction to add.
2144  */
2145 void ModelChecker::add_action_to_lists(ModelAction *act)
2146 {
2147         int tid = id_to_int(act->get_tid());
2148         ModelAction *uninit = NULL;
2149         int uninit_id = -1;
2150         action_list_t *list = get_safe_ptr_action(obj_map, act->get_location());
2151         if (list->empty() && act->is_atomic_var()) {
2152                 uninit = new_uninitialized_action(act->get_location());
2153                 uninit_id = id_to_int(uninit->get_tid());
2154                 list->push_back(uninit);
2155         }
2156         list->push_back(act);
2157
2158         action_trace->push_back(act);
2159         if (uninit)
2160                 action_trace->push_front(uninit);
2161
2162         std::vector<action_list_t> *vec = get_safe_ptr_vect_action(obj_thrd_map, act->get_location());
2163         if (tid >= (int)vec->size())
2164                 vec->resize(priv->next_thread_id);
2165         (*vec)[tid].push_back(act);
2166         if (uninit)
2167                 (*vec)[uninit_id].push_front(uninit);
2168
2169         if ((int)thrd_last_action->size() <= tid)
2170                 thrd_last_action->resize(get_num_threads());
2171         (*thrd_last_action)[tid] = act;
2172         if (uninit)
2173                 (*thrd_last_action)[uninit_id] = uninit;
2174
2175         if (act->is_fence() && act->is_release()) {
2176                 if ((int)thrd_last_fence_release->size() <= tid)
2177                         thrd_last_fence_release->resize(get_num_threads());
2178                 (*thrd_last_fence_release)[tid] = act;
2179         }
2180
2181         if (act->is_wait()) {
2182                 void *mutex_loc = (void *) act->get_value();
2183                 get_safe_ptr_action(obj_map, mutex_loc)->push_back(act);
2184
2185                 std::vector<action_list_t> *vec = get_safe_ptr_vect_action(obj_thrd_map, mutex_loc);
2186                 if (tid >= (int)vec->size())
2187                         vec->resize(priv->next_thread_id);
2188                 (*vec)[tid].push_back(act);
2189         }
2190 }
2191
2192 /**
2193  * @brief Get the last action performed by a particular Thread
2194  * @param tid The thread ID of the Thread in question
2195  * @return The last action in the thread
2196  */
2197 ModelAction * ModelChecker::get_last_action(thread_id_t tid) const
2198 {
2199         int threadid = id_to_int(tid);
2200         if (threadid < (int)thrd_last_action->size())
2201                 return (*thrd_last_action)[id_to_int(tid)];
2202         else
2203                 return NULL;
2204 }
2205
2206 /**
2207  * @brief Get the last fence release performed by a particular Thread
2208  * @param tid The thread ID of the Thread in question
2209  * @return The last fence release in the thread, if one exists; NULL otherwise
2210  */
2211 ModelAction * ModelChecker::get_last_fence_release(thread_id_t tid) const
2212 {
2213         int threadid = id_to_int(tid);
2214         if (threadid < (int)thrd_last_fence_release->size())
2215                 return (*thrd_last_fence_release)[id_to_int(tid)];
2216         else
2217                 return NULL;
2218 }
2219
2220 /**
2221  * Gets the last memory_order_seq_cst write (in the total global sequence)
2222  * performed on a particular object (i.e., memory location), not including the
2223  * current action.
2224  * @param curr The current ModelAction; also denotes the object location to
2225  * check
2226  * @return The last seq_cst write
2227  */
2228 ModelAction * ModelChecker::get_last_seq_cst_write(ModelAction *curr) const
2229 {
2230         void *location = curr->get_location();
2231         action_list_t *list = get_safe_ptr_action(obj_map, location);
2232         /* Find: max({i in dom(S) | seq_cst(t_i) && isWrite(t_i) && samevar(t_i, t)}) */
2233         action_list_t::reverse_iterator rit;
2234         for (rit = list->rbegin(); rit != list->rend(); rit++)
2235                 if ((*rit)->is_write() && (*rit)->is_seqcst() && (*rit) != curr)
2236                         return *rit;
2237         return NULL;
2238 }
2239
2240 /**
2241  * Gets the last memory_order_seq_cst fence (in the total global sequence)
2242  * performed in a particular thread, prior to a particular fence.
2243  * @param tid The ID of the thread to check
2244  * @param before_fence The fence from which to begin the search; if NULL, then
2245  * search for the most recent fence in the thread.
2246  * @return The last prior seq_cst fence in the thread, if exists; otherwise, NULL
2247  */
2248 ModelAction * ModelChecker::get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const
2249 {
2250         /* All fences should have NULL location */
2251         action_list_t *list = get_safe_ptr_action(obj_map, NULL);
2252         action_list_t::reverse_iterator rit = list->rbegin();
2253
2254         if (before_fence) {
2255                 for (; rit != list->rend(); rit++)
2256                         if (*rit == before_fence)
2257                                 break;
2258
2259                 ASSERT(*rit == before_fence);
2260                 rit++;
2261         }
2262
2263         for (; rit != list->rend(); rit++)
2264                 if ((*rit)->is_fence() && (tid == (*rit)->get_tid()) && (*rit)->is_seqcst())
2265                         return *rit;
2266         return NULL;
2267 }
2268
2269 /**
2270  * Gets the last unlock operation performed on a particular mutex (i.e., memory
2271  * location). This function identifies the mutex according to the current
2272  * action, which is presumed to perform on the same mutex.
2273  * @param curr The current ModelAction; also denotes the object location to
2274  * check
2275  * @return The last unlock operation
2276  */
2277 ModelAction * ModelChecker::get_last_unlock(ModelAction *curr) const
2278 {
2279         void *location = curr->get_location();
2280         action_list_t *list = get_safe_ptr_action(obj_map, location);
2281         /* Find: max({i in dom(S) | isUnlock(t_i) && samevar(t_i, t)}) */
2282         action_list_t::reverse_iterator rit;
2283         for (rit = list->rbegin(); rit != list->rend(); rit++)
2284                 if ((*rit)->is_unlock() || (*rit)->is_wait())
2285                         return *rit;
2286         return NULL;
2287 }
2288
2289 ModelAction * ModelChecker::get_parent_action(thread_id_t tid) const
2290 {
2291         ModelAction *parent = get_last_action(tid);
2292         if (!parent)
2293                 parent = get_thread(tid)->get_creation();
2294         return parent;
2295 }
2296
2297 /**
2298  * Returns the clock vector for a given thread.
2299  * @param tid The thread whose clock vector we want
2300  * @return Desired clock vector
2301  */
2302 ClockVector * ModelChecker::get_cv(thread_id_t tid) const
2303 {
2304         return get_parent_action(tid)->get_cv();
2305 }
2306
2307 /**
2308  * Resolve a set of Promises with a current write. The set is provided in the
2309  * Node corresponding to @a write.
2310  * @param write The ModelAction that is fulfilling Promises
2311  * @return True if promises were resolved; false otherwise
2312  */
2313 bool ModelChecker::resolve_promises(ModelAction *write)
2314 {
2315         bool resolved = false;
2316         std::vector< ModelAction *, ModelAlloc<ModelAction *> > actions_to_check;
2317
2318         for (unsigned int i = 0, promise_index = 0; promise_index < promises->size(); i++) {
2319                 Promise *promise = (*promises)[promise_index];
2320                 if (write->get_node()->get_promise(i)) {
2321                         ModelAction *read = promise->get_action();
2322                         if (read->is_rmw()) {
2323                                 mo_graph->addRMWEdge(write, read);
2324                         }
2325                         read_from(read, write);
2326                         //First fix up the modification order for actions that happened
2327                         //before the read
2328                         r_modification_order(read, write);
2329                         //Next fix up the modification order for actions that happened
2330                         //after the read.
2331                         post_r_modification_order(read, write);
2332                         //Make sure the promise's value matches the write's value
2333                         ASSERT(promise->get_value() == write->get_value());
2334                         delete(promise);
2335
2336                         promises->erase(promises->begin() + promise_index);
2337                         actions_to_check.push_back(read);
2338
2339                         resolved = true;
2340                 } else
2341                         promise_index++;
2342         }
2343
2344         //Check whether reading these writes has made threads unable to
2345         //resolve promises
2346
2347         for (unsigned int i = 0; i < actions_to_check.size(); i++) {
2348                 ModelAction *read=actions_to_check[i];
2349                 mo_check_promises(read->get_tid(), write, read);
2350         }
2351
2352         return resolved;
2353 }
2354
2355 /**
2356  * Compute the set of promises that could potentially be satisfied by this
2357  * action. Note that the set computation actually appears in the Node, not in
2358  * ModelChecker.
2359  * @param curr The ModelAction that may satisfy promises
2360  */
2361 void ModelChecker::compute_promises(ModelAction *curr)
2362 {
2363         for (unsigned int i = 0; i < promises->size(); i++) {
2364                 Promise *promise = (*promises)[i];
2365                 const ModelAction *act = promise->get_action();
2366                 if (!act->happens_before(curr) &&
2367                                 act->is_read() &&
2368                                 !act->could_synchronize_with(curr) &&
2369                                 !act->same_thread(curr) &&
2370                                 act->get_location() == curr->get_location() &&
2371                                 promise->get_value() == curr->get_value()) {
2372                         curr->get_node()->set_promise(i, act->is_rmw());
2373                 }
2374         }
2375 }
2376
2377 /** Checks promises in response to change in ClockVector Threads. */
2378 void ModelChecker::check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector *merge_cv)
2379 {
2380         for (unsigned int i = 0; i < promises->size(); i++) {
2381                 Promise *promise = (*promises)[i];
2382                 const ModelAction *act = promise->get_action();
2383                 if ((old_cv == NULL || !old_cv->synchronized_since(act)) &&
2384                                 merge_cv->synchronized_since(act)) {
2385                         if (promise->eliminate_thread(tid)) {
2386                                 //Promise has failed
2387                                 priv->failed_promise = true;
2388                                 return;
2389                         }
2390                 }
2391         }
2392 }
2393
2394 void ModelChecker::check_promises_thread_disabled()
2395 {
2396         for (unsigned int i = 0; i < promises->size(); i++) {
2397                 Promise *promise = (*promises)[i];
2398                 if (promise->has_failed()) {
2399                         priv->failed_promise = true;
2400                         return;
2401                 }
2402         }
2403 }
2404
2405 /**
2406  * @brief Checks promises in response to addition to modification order for
2407  * threads.
2408  *
2409  * Definitions:
2410  *
2411  * pthread is the thread that performed the read that created the promise
2412  *
2413  * pread is the read that created the promise
2414  *
2415  * pwrite is either the first write to same location as pread by
2416  * pthread that is sequenced after pread or the write read by the
2417  * first read to the same location as pread by pthread that is
2418  * sequenced after pread.
2419  *
2420  * 1. If tid=pthread, then we check what other threads are reachable
2421  * through the mod order starting with pwrite.  Those threads cannot
2422  * perform a write that will resolve the promise due to modification
2423  * order constraints.
2424  *
2425  * 2. If the tid is not pthread, we check whether pwrite can reach the
2426  * action write through the modification order.  If so, that thread
2427  * cannot perform a future write that will resolve the promise due to
2428  * modificatin order constraints.
2429  *
2430  * @param tid The thread that either read from the model action write, or
2431  * actually did the model action write.
2432  *
2433  * @param write The ModelAction representing the relevant write.
2434  * @param read  The ModelAction that reads a promised write, or NULL otherwise.
2435  */
2436 void ModelChecker::mo_check_promises(thread_id_t tid, const ModelAction *write, const ModelAction *read)
2437 {
2438         void *location = write->get_location();
2439         for (unsigned int i = 0; i < promises->size(); i++) {
2440                 Promise *promise = (*promises)[i];
2441                 const ModelAction *act = promise->get_action();
2442
2443                 // Is this promise on the same location?
2444                 if (act->get_location() != location)
2445                         continue;
2446
2447                 // same thread as the promise
2448                 if (act->get_tid() == tid) {
2449                         // make sure that the reader of this write happens after the promise
2450                         if ((read == NULL) || (promise->get_action()->happens_before(read))) {
2451                                 // do we have a pwrite for the promise, if not, set it
2452                                 if (promise->get_write() == NULL) {
2453                                         promise->set_write(write);
2454                                         // The pwrite cannot happen before the promise
2455                                         if (write->happens_before(act) && (write != act)) {
2456                                                 priv->failed_promise = true;
2457                                                 return;
2458                                         }
2459                                 }
2460
2461                                 if (mo_graph->checkPromise(write, promise)) {
2462                                         priv->failed_promise = true;
2463                                         return;
2464                                 }
2465                         }
2466                 }
2467
2468                 // Don't do any lookups twice for the same thread
2469                 if (promise->thread_is_eliminated(tid))
2470                         continue;
2471
2472                 if (promise->get_write() && mo_graph->checkReachable(promise->get_write(), write)) {
2473                         if (promise->eliminate_thread(tid)) {
2474                                 priv->failed_promise = true;
2475                                 return;
2476                         }
2477                 }
2478         }
2479 }
2480
2481 /**
2482  * Compute the set of writes that may break the current pending release
2483  * sequence. This information is extracted from previou release sequence
2484  * calculations.
2485  *
2486  * @param curr The current ModelAction. Must be a release sequence fixup
2487  * action.
2488  */
2489 void ModelChecker::compute_relseq_breakwrites(ModelAction *curr)
2490 {
2491         if (pending_rel_seqs->empty())
2492                 return;
2493
2494         struct release_seq *pending = pending_rel_seqs->back();
2495         for (unsigned int i = 0; i < pending->writes.size(); i++) {
2496                 const ModelAction *write = pending->writes[i];
2497                 curr->get_node()->add_relseq_break(write);
2498         }
2499
2500         /* NULL means don't break the sequence; just synchronize */
2501         curr->get_node()->add_relseq_break(NULL);
2502 }
2503
2504 /**
2505  * Build up an initial set of all past writes that this 'read' action may read
2506  * from. This set is determined by the clock vector's "happens before"
2507  * relationship.
2508  * @param curr is the current ModelAction that we are exploring; it must be a
2509  * 'read' operation.
2510  */
2511 void ModelChecker::build_reads_from_past(ModelAction *curr)
2512 {
2513         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, curr->get_location());
2514         unsigned int i;
2515         ASSERT(curr->is_read());
2516
2517         ModelAction *last_sc_write = NULL;
2518
2519         if (curr->is_seqcst())
2520                 last_sc_write = get_last_seq_cst_write(curr);
2521
2522         /* Iterate over all threads */
2523         for (i = 0; i < thrd_lists->size(); i++) {
2524                 /* Iterate over actions in thread, starting from most recent */
2525                 action_list_t *list = &(*thrd_lists)[i];
2526                 action_list_t::reverse_iterator rit;
2527                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
2528                         ModelAction *act = *rit;
2529
2530                         /* Only consider 'write' actions */
2531                         if (!act->is_write() || act == curr)
2532                                 continue;
2533
2534                         /* Don't consider more than one seq_cst write if we are a seq_cst read. */
2535                         bool allow_read = true;
2536
2537                         if (curr->is_seqcst() && (act->is_seqcst() || (last_sc_write != NULL && act->happens_before(last_sc_write))) && act != last_sc_write)
2538                                 allow_read = false;
2539                         else if (curr->get_sleep_flag() && !curr->is_seqcst() && !sleep_can_read_from(curr, act))
2540                                 allow_read = false;
2541
2542                         if (allow_read)
2543                                 curr->get_node()->add_read_from(act);
2544
2545                         /* Include at most one act per-thread that "happens before" curr */
2546                         if (act->happens_before(curr))
2547                                 break;
2548                 }
2549         }
2550
2551         if (DBG_ENABLED()) {
2552                 model_print("Reached read action:\n");
2553                 curr->print();
2554                 model_print("Printing may_read_from\n");
2555                 curr->get_node()->print_may_read_from();
2556                 model_print("End printing may_read_from\n");
2557         }
2558 }
2559
2560 bool ModelChecker::sleep_can_read_from(ModelAction *curr, const ModelAction *write)
2561 {
2562         while (true) {
2563                 /* UNINIT actions don't have a Node, and they never sleep */
2564                 if (write->is_uninitialized())
2565                         return true;
2566                 Node *prevnode = write->get_node()->get_parent();
2567
2568                 bool thread_sleep = prevnode->enabled_status(curr->get_tid()) == THREAD_SLEEP_SET;
2569                 if (write->is_release() && thread_sleep)
2570                         return true;
2571                 if (!write->is_rmw()) {
2572                         return false;
2573                 }
2574                 if (write->get_reads_from() == NULL)
2575                         return true;
2576                 write = write->get_reads_from();
2577         }
2578 }
2579
2580 /**
2581  * @brief Create a new action representing an uninitialized atomic
2582  * @param location The memory location of the atomic object
2583  * @return A pointer to a new ModelAction
2584  */
2585 ModelAction * ModelChecker::new_uninitialized_action(void *location) const
2586 {
2587         ModelAction *act = (ModelAction *)snapshot_malloc(sizeof(class ModelAction));
2588         act = new (act) ModelAction(ATOMIC_UNINIT, std::memory_order_relaxed, location, 0, model_thread);
2589         act->create_cv(NULL);
2590         return act;
2591 }
2592
2593 static void print_list(action_list_t *list)
2594 {
2595         action_list_t::iterator it;
2596
2597         model_print("---------------------------------------------------------------------\n");
2598
2599         unsigned int hash = 0;
2600
2601         for (it = list->begin(); it != list->end(); it++) {
2602                 (*it)->print();
2603                 hash = hash^(hash<<3)^((*it)->hash());
2604         }
2605         model_print("HASH %u\n", hash);
2606         model_print("---------------------------------------------------------------------\n");
2607 }
2608
2609 #if SUPPORT_MOD_ORDER_DUMP
2610 void ModelChecker::dumpGraph(char *filename) const
2611 {
2612         char buffer[200];
2613         sprintf(buffer, "%s.dot", filename);
2614         FILE *file = fopen(buffer, "w");
2615         fprintf(file, "digraph %s {\n", filename);
2616         mo_graph->dumpNodes(file);
2617         ModelAction **thread_array = (ModelAction **)model_calloc(1, sizeof(ModelAction *) * get_num_threads());
2618
2619         for (action_list_t::iterator it = action_trace->begin(); it != action_trace->end(); it++) {
2620                 ModelAction *action = *it;
2621                 if (action->is_read()) {
2622                         fprintf(file, "N%u [label=\"%u, T%u\"];\n", action->get_seq_number(), action->get_seq_number(), action->get_tid());
2623                         if (action->get_reads_from() != NULL)
2624                                 fprintf(file, "N%u -> N%u[label=\"rf\", color=red];\n", action->get_seq_number(), action->get_reads_from()->get_seq_number());
2625                 }
2626                 if (thread_array[action->get_tid()] != NULL) {
2627                         fprintf(file, "N%u -> N%u[label=\"sb\", color=blue];\n", thread_array[action->get_tid()]->get_seq_number(), action->get_seq_number());
2628                 }
2629
2630                 thread_array[action->get_tid()] = action;
2631         }
2632         fprintf(file, "}\n");
2633         model_free(thread_array);
2634         fclose(file);
2635 }
2636 #endif
2637
2638 /** @brief Prints an execution trace summary. */
2639 void ModelChecker::print_summary() const
2640 {
2641 #if SUPPORT_MOD_ORDER_DUMP
2642         scheduler->print();
2643         char buffername[100];
2644         sprintf(buffername, "exec%04u", stats.num_total);
2645         mo_graph->dumpGraphToFile(buffername);
2646         sprintf(buffername, "graph%04u", stats.num_total);
2647         dumpGraph(buffername);
2648 #endif
2649
2650         model_print("Execution %d:", stats.num_total);
2651         if (isfeasibleprefix())
2652                 model_print("\n");
2653         else
2654                 print_infeasibility(" INFEASIBLE");
2655         print_list(action_trace);
2656         model_print("\n");
2657 }
2658
2659 /**
2660  * Add a Thread to the system for the first time. Should only be called once
2661  * per thread.
2662  * @param t The Thread to add
2663  */
2664 void ModelChecker::add_thread(Thread *t)
2665 {
2666         thread_map->put(id_to_int(t->get_id()), t);
2667         scheduler->add_thread(t);
2668 }
2669
2670 /**
2671  * Removes a thread from the scheduler.
2672  * @param the thread to remove.
2673  */
2674 void ModelChecker::remove_thread(Thread *t)
2675 {
2676         scheduler->remove_thread(t);
2677 }
2678
2679 /**
2680  * @brief Get a Thread reference by its ID
2681  * @param tid The Thread's ID
2682  * @return A Thread reference
2683  */
2684 Thread * ModelChecker::get_thread(thread_id_t tid) const
2685 {
2686         return thread_map->get(id_to_int(tid));
2687 }
2688
2689 /**
2690  * @brief Get a reference to the Thread in which a ModelAction was executed
2691  * @param act The ModelAction
2692  * @return A Thread reference
2693  */
2694 Thread * ModelChecker::get_thread(const ModelAction *act) const
2695 {
2696         return get_thread(act->get_tid());
2697 }
2698
2699 /**
2700  * @brief Check if a Thread is currently enabled
2701  * @param t The Thread to check
2702  * @return True if the Thread is currently enabled
2703  */
2704 bool ModelChecker::is_enabled(Thread *t) const
2705 {
2706         return scheduler->is_enabled(t);
2707 }
2708
2709 /**
2710  * @brief Check if a Thread is currently enabled
2711  * @param tid The ID of the Thread to check
2712  * @return True if the Thread is currently enabled
2713  */
2714 bool ModelChecker::is_enabled(thread_id_t tid) const
2715 {
2716         return scheduler->is_enabled(tid);
2717 }
2718
2719 /**
2720  * Switch from a user-context to the "master thread" context (a.k.a. system
2721  * context). This switch is made with the intention of exploring a particular
2722  * model-checking action (described by a ModelAction object). Must be called
2723  * from a user-thread context.
2724  *
2725  * @param act The current action that will be explored. May be NULL only if
2726  * trace is exiting via an assertion (see ModelChecker::set_assert and
2727  * ModelChecker::has_asserted).
2728  * @return Return the value returned by the current action
2729  */
2730 uint64_t ModelChecker::switch_to_master(ModelAction *act)
2731 {
2732         DBG();
2733         Thread *old = thread_current();
2734         set_current_action(act);
2735         old->set_state(THREAD_READY);
2736         if (Thread::swap(old, &system_context) < 0) {
2737                 perror("swap threads");
2738                 exit(EXIT_FAILURE);
2739         }
2740         return old->get_return_value();
2741 }
2742
2743 /**
2744  * Takes the next step in the execution, if possible.
2745  * @param curr The current step to take
2746  * @return Returns true (success) if a step was taken and false otherwise.
2747  */
2748 bool ModelChecker::take_step(ModelAction *curr)
2749 {
2750         if (has_asserted())
2751                 return false;
2752
2753         Thread *curr_thrd = get_thread(curr);
2754         ASSERT(curr_thrd->get_state() == THREAD_READY);
2755
2756         curr = check_current_action(curr);
2757
2758         /* Infeasible -> don't take any more steps */
2759         if (is_infeasible())
2760                 return false;
2761         else if (isfeasibleprefix() && have_bug_reports()) {
2762                 set_assert();
2763                 return false;
2764         }
2765
2766         if (params.bound != 0)
2767                 if (priv->used_sequence_numbers > params.bound)
2768                         return false;
2769
2770         if (curr_thrd->is_blocked() || curr_thrd->is_complete())
2771                 scheduler->remove_thread(curr_thrd);
2772
2773         Thread *next_thrd = get_next_thread(curr);
2774         next_thrd = scheduler->next_thread(next_thrd);
2775
2776         DEBUG("(%d, %d)\n", curr_thrd ? id_to_int(curr_thrd->get_id()) : -1,
2777                         next_thrd ? id_to_int(next_thrd->get_id()) : -1);
2778
2779         /*
2780          * Launch end-of-execution release sequence fixups only when there are:
2781          *
2782          * (1) no more user threads to run (or when execution replay chooses
2783          *     the 'model_thread')
2784          * (2) pending release sequences
2785          * (3) pending assertions (i.e., data races)
2786          * (4) no pending promises
2787          */
2788         if (!pending_rel_seqs->empty() && (!next_thrd || next_thrd->is_model_thread()) &&
2789                         is_feasible_prefix_ignore_relseq() && !unrealizedraces.empty()) {
2790                 model_print("*** WARNING: release sequence fixup action (%zu pending release seuqences) ***\n",
2791                                 pending_rel_seqs->size());
2792                 ModelAction *fixup = new ModelAction(MODEL_FIXUP_RELSEQ,
2793                                 std::memory_order_seq_cst, NULL, VALUE_NONE,
2794                                 model_thread);
2795                 set_current_action(fixup);
2796                 return true;
2797         }
2798
2799         /* next_thrd == NULL -> don't take any more steps */
2800         if (!next_thrd)
2801                 return false;
2802
2803         next_thrd->set_state(THREAD_RUNNING);
2804
2805         if (next_thrd->get_pending() != NULL) {
2806                 /* restart a pending action */
2807                 set_current_action(next_thrd->get_pending());
2808                 next_thrd->set_pending(NULL);
2809                 next_thrd->set_state(THREAD_READY);
2810                 return true;
2811         }
2812
2813         /* Return false only if swap fails with an error */
2814         return (Thread::swap(&system_context, next_thrd) == 0);
2815 }
2816
2817 /** Wrapper to run the user's main function, with appropriate arguments */
2818 void user_main_wrapper(void *)
2819 {
2820         user_main(model->params.argc, model->params.argv);
2821 }
2822
2823 /** @brief Run ModelChecker for the user program */
2824 void ModelChecker::run()
2825 {
2826         do {
2827                 thrd_t user_thread;
2828                 Thread *t = new Thread(&user_thread, &user_main_wrapper, NULL);
2829
2830                 add_thread(t);
2831
2832                 /* Run user thread up to its first action */
2833                 scheduler->next_thread(t);
2834                 Thread::swap(&system_context, t);
2835
2836                 /* Wait for all threads to complete */
2837                 while (take_step(priv->current_action));
2838         } while (next_execution());
2839
2840         print_stats();
2841 }