future_value: add thread ID parameter
[model-checker.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                 Node *node = reader->get_node();
860
861                 /* Find an ancestor thread which exists at the time of the reader */
862                 Thread *write_thread = get_thread(writer);
863                 while (id_to_int(write_thread->get_id()) >= node->get_num_threads())
864                         write_thread = write_thread->get_parent();
865
866                 struct future_value fv = {
867                         writer->get_value(),
868                         writer->get_seq_number() + params.maxfuturedelay,
869                         write_thread->get_id(),
870                 };
871                 if (node->add_future_value(fv))
872                         set_latest_backtrack(reader);
873         }
874 }
875
876 /**
877  * Process a write ModelAction
878  * @param curr The ModelAction to process
879  * @return True if the mo_graph was updated or promises were resolved
880  */
881 bool ModelChecker::process_write(ModelAction *curr)
882 {
883         bool updated_mod_order = w_modification_order(curr);
884         bool updated_promises = resolve_promises(curr);
885
886         if (promises->size() == 0) {
887                 for (unsigned int i = 0; i < futurevalues->size(); i++) {
888                         struct PendingFutureValue pfv = (*futurevalues)[i];
889                         add_future_value(pfv.writer, pfv.act);
890                 }
891                 futurevalues->clear();
892         }
893
894         mo_graph->commitChanges();
895         mo_check_promises(curr->get_tid(), curr, NULL);
896
897         get_thread(curr)->set_return_value(VALUE_NONE);
898         return updated_mod_order || updated_promises;
899 }
900
901 /**
902  * Process a fence ModelAction
903  * @param curr The ModelAction to process
904  * @return True if synchronization was updated
905  */
906 bool ModelChecker::process_fence(ModelAction *curr)
907 {
908         /*
909          * fence-relaxed: no-op
910          * fence-release: only log the occurence (not in this function), for
911          *   use in later synchronization
912          * fence-acquire (this function): search for hypothetical release
913          *   sequences
914          */
915         bool updated = false;
916         if (curr->is_acquire()) {
917                 action_list_t *list = action_trace;
918                 action_list_t::reverse_iterator rit;
919                 /* Find X : is_read(X) && X --sb-> curr */
920                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
921                         ModelAction *act = *rit;
922                         if (act == curr)
923                                 continue;
924                         if (act->get_tid() != curr->get_tid())
925                                 continue;
926                         /* Stop at the beginning of the thread */
927                         if (act->is_thread_start())
928                                 break;
929                         /* Stop once we reach a prior fence-acquire */
930                         if (act->is_fence() && act->is_acquire())
931                                 break;
932                         if (!act->is_read())
933                                 continue;
934                         /* read-acquire will find its own release sequences */
935                         if (act->is_acquire())
936                                 continue;
937
938                         /* Establish hypothetical release sequences */
939                         rel_heads_list_t release_heads;
940                         get_release_seq_heads(curr, act, &release_heads);
941                         for (unsigned int i = 0; i < release_heads.size(); i++)
942                                 if (!curr->synchronize_with(release_heads[i]))
943                                         set_bad_synchronization();
944                         if (release_heads.size() != 0)
945                                 updated = true;
946                 }
947         }
948         return updated;
949 }
950
951 /**
952  * @brief Process the current action for thread-related activity
953  *
954  * Performs current-action processing for a THREAD_* ModelAction. Proccesses
955  * may include setting Thread status, completing THREAD_FINISH/THREAD_JOIN
956  * synchronization, etc.  This function is a no-op for non-THREAD actions
957  * (e.g., ATOMIC_{READ,WRITE,RMW,LOCK}, etc.)
958  *
959  * @param curr The current action
960  * @return True if synchronization was updated or a thread completed
961  */
962 bool ModelChecker::process_thread_action(ModelAction *curr)
963 {
964         bool updated = false;
965
966         switch (curr->get_type()) {
967         case THREAD_CREATE: {
968                 Thread *th = curr->get_thread_operand();
969                 th->set_creation(curr);
970                 break;
971         }
972         case THREAD_JOIN: {
973                 Thread *blocking = curr->get_thread_operand();
974                 ModelAction *act = get_last_action(blocking->get_id());
975                 curr->synchronize_with(act);
976                 updated = true; /* trigger rel-seq checks */
977                 break;
978         }
979         case THREAD_FINISH: {
980                 Thread *th = get_thread(curr);
981                 while (!th->wait_list_empty()) {
982                         ModelAction *act = th->pop_wait_list();
983                         scheduler->wake(get_thread(act));
984                 }
985                 th->complete();
986                 updated = true; /* trigger rel-seq checks */
987                 break;
988         }
989         case THREAD_START: {
990                 check_promises(curr->get_tid(), NULL, curr->get_cv());
991                 break;
992         }
993         default:
994                 break;
995         }
996
997         return updated;
998 }
999
1000 /**
1001  * @brief Process the current action for release sequence fixup activity
1002  *
1003  * Performs model-checker release sequence fixups for the current action,
1004  * forcing a single pending release sequence to break (with a given, potential
1005  * "loose" write) or to complete (i.e., synchronize). If a pending release
1006  * sequence forms a complete release sequence, then we must perform the fixup
1007  * synchronization, mo_graph additions, etc.
1008  *
1009  * @param curr The current action; must be a release sequence fixup action
1010  * @param work_queue The work queue to which to add work items as they are
1011  * generated
1012  */
1013 void ModelChecker::process_relseq_fixup(ModelAction *curr, work_queue_t *work_queue)
1014 {
1015         const ModelAction *write = curr->get_node()->get_relseq_break();
1016         struct release_seq *sequence = pending_rel_seqs->back();
1017         pending_rel_seqs->pop_back();
1018         ASSERT(sequence);
1019         ModelAction *acquire = sequence->acquire;
1020         const ModelAction *rf = sequence->rf;
1021         const ModelAction *release = sequence->release;
1022         ASSERT(acquire);
1023         ASSERT(release);
1024         ASSERT(rf);
1025         ASSERT(release->same_thread(rf));
1026
1027         if (write == NULL) {
1028                 /**
1029                  * @todo Forcing a synchronization requires that we set
1030                  * modification order constraints. For instance, we can't allow
1031                  * a fixup sequence in which two separate read-acquire
1032                  * operations read from the same sequence, where the first one
1033                  * synchronizes and the other doesn't. Essentially, we can't
1034                  * allow any writes to insert themselves between 'release' and
1035                  * 'rf'
1036                  */
1037
1038                 /* Must synchronize */
1039                 if (!acquire->synchronize_with(release)) {
1040                         set_bad_synchronization();
1041                         return;
1042                 }
1043                 /* Re-check all pending release sequences */
1044                 work_queue->push_back(CheckRelSeqWorkEntry(NULL));
1045                 /* Re-check act for mo_graph edges */
1046                 work_queue->push_back(MOEdgeWorkEntry(acquire));
1047
1048                 /* propagate synchronization to later actions */
1049                 action_list_t::reverse_iterator rit = action_trace->rbegin();
1050                 for (; (*rit) != acquire; rit++) {
1051                         ModelAction *propagate = *rit;
1052                         if (acquire->happens_before(propagate)) {
1053                                 propagate->synchronize_with(acquire);
1054                                 /* Re-check 'propagate' for mo_graph edges */
1055                                 work_queue->push_back(MOEdgeWorkEntry(propagate));
1056                         }
1057                 }
1058         } else {
1059                 /* Break release sequence with new edges:
1060                  *   release --mo--> write --mo--> rf */
1061                 mo_graph->addEdge(release, write);
1062                 mo_graph->addEdge(write, rf);
1063         }
1064
1065         /* See if we have realized a data race */
1066         checkDataRaces();
1067 }
1068
1069 /**
1070  * Initialize the current action by performing one or more of the following
1071  * actions, as appropriate: merging RMWR and RMWC/RMW actions, stepping forward
1072  * in the NodeStack, manipulating backtracking sets, allocating and
1073  * initializing clock vectors, and computing the promises to fulfill.
1074  *
1075  * @param curr The current action, as passed from the user context; may be
1076  * freed/invalidated after the execution of this function, with a different
1077  * action "returned" its place (pass-by-reference)
1078  * @return True if curr is a newly-explored action; false otherwise
1079  */
1080 bool ModelChecker::initialize_curr_action(ModelAction **curr)
1081 {
1082         ModelAction *newcurr;
1083
1084         if ((*curr)->is_rmwc() || (*curr)->is_rmw()) {
1085                 newcurr = process_rmw(*curr);
1086                 delete *curr;
1087
1088                 if (newcurr->is_rmw())
1089                         compute_promises(newcurr);
1090
1091                 *curr = newcurr;
1092                 return false;
1093         }
1094
1095         (*curr)->set_seq_number(get_next_seq_num());
1096
1097         newcurr = node_stack->explore_action(*curr, scheduler->get_enabled_array());
1098         if (newcurr) {
1099                 /* First restore type and order in case of RMW operation */
1100                 if ((*curr)->is_rmwr())
1101                         newcurr->copy_typeandorder(*curr);
1102
1103                 ASSERT((*curr)->get_location() == newcurr->get_location());
1104                 newcurr->copy_from_new(*curr);
1105
1106                 /* Discard duplicate ModelAction; use action from NodeStack */
1107                 delete *curr;
1108
1109                 /* Always compute new clock vector */
1110                 newcurr->create_cv(get_parent_action(newcurr->get_tid()));
1111
1112                 *curr = newcurr;
1113                 return false; /* Action was explored previously */
1114         } else {
1115                 newcurr = *curr;
1116
1117                 /* Always compute new clock vector */
1118                 newcurr->create_cv(get_parent_action(newcurr->get_tid()));
1119
1120                 /* Assign most recent release fence */
1121                 newcurr->set_last_fence_release(get_last_fence_release(newcurr->get_tid()));
1122
1123                 /*
1124                  * Perform one-time actions when pushing new ModelAction onto
1125                  * NodeStack
1126                  */
1127                 if (newcurr->is_write())
1128                         compute_promises(newcurr);
1129                 else if (newcurr->is_relseq_fixup())
1130                         compute_relseq_breakwrites(newcurr);
1131                 else if (newcurr->is_wait())
1132                         newcurr->get_node()->set_misc_max(2);
1133                 else if (newcurr->is_notify_one()) {
1134                         newcurr->get_node()->set_misc_max(get_safe_ptr_action(condvar_waiters_map, newcurr->get_location())->size());
1135                 }
1136                 return true; /* This was a new ModelAction */
1137         }
1138 }
1139
1140 /**
1141  * @brief Establish reads-from relation between two actions
1142  *
1143  * Perform basic operations involved with establishing a concrete rf relation,
1144  * including setting the ModelAction data and checking for release sequences.
1145  *
1146  * @param act The action that is reading (must be a read)
1147  * @param rf The action from which we are reading (must be a write)
1148  *
1149  * @return True if this read established synchronization
1150  */
1151 bool ModelChecker::read_from(ModelAction *act, const ModelAction *rf)
1152 {
1153         act->set_read_from(rf);
1154         if (rf != NULL && act->is_acquire()) {
1155                 rel_heads_list_t release_heads;
1156                 get_release_seq_heads(act, act, &release_heads);
1157                 int num_heads = release_heads.size();
1158                 for (unsigned int i = 0; i < release_heads.size(); i++)
1159                         if (!act->synchronize_with(release_heads[i])) {
1160                                 set_bad_synchronization();
1161                                 num_heads--;
1162                         }
1163                 return num_heads > 0;
1164         }
1165         return false;
1166 }
1167
1168 /**
1169  * @brief Check whether a model action is enabled.
1170  *
1171  * Checks whether a lock or join operation would be successful (i.e., is the
1172  * lock already locked, or is the joined thread already complete). If not, put
1173  * the action in a waiter list.
1174  *
1175  * @param curr is the ModelAction to check whether it is enabled.
1176  * @return a bool that indicates whether the action is enabled.
1177  */
1178 bool ModelChecker::check_action_enabled(ModelAction *curr) {
1179         if (curr->is_lock()) {
1180                 std::mutex *lock = (std::mutex *)curr->get_location();
1181                 struct std::mutex_state *state = lock->get_state();
1182                 if (state->islocked) {
1183                         //Stick the action in the appropriate waiting queue
1184                         get_safe_ptr_action(lock_waiters_map, curr->get_location())->push_back(curr);
1185                         return false;
1186                 }
1187         } else if (curr->get_type() == THREAD_JOIN) {
1188                 Thread *blocking = (Thread *)curr->get_location();
1189                 if (!blocking->is_complete()) {
1190                         blocking->push_wait_list(curr);
1191                         return false;
1192                 }
1193         }
1194
1195         return true;
1196 }
1197
1198 /**
1199  * Stores the ModelAction for the current thread action.  Call this
1200  * immediately before switching from user- to system-context to pass
1201  * data between them.
1202  * @param act The ModelAction created by the user-thread action
1203  */
1204 void ModelChecker::set_current_action(ModelAction *act) {
1205         priv->current_action = act;
1206 }
1207
1208 /**
1209  * This is the heart of the model checker routine. It performs model-checking
1210  * actions corresponding to a given "current action." Among other processes, it
1211  * calculates reads-from relationships, updates synchronization clock vectors,
1212  * forms a memory_order constraints graph, and handles replay/backtrack
1213  * execution when running permutations of previously-observed executions.
1214  *
1215  * @param curr The current action to process
1216  * @return The ModelAction that is actually executed; may be different than
1217  * curr; may be NULL, if the current action is not enabled to run
1218  */
1219 ModelAction * ModelChecker::check_current_action(ModelAction *curr)
1220 {
1221         ASSERT(curr);
1222         bool second_part_of_rmw = curr->is_rmwc() || curr->is_rmw();
1223
1224         if (!check_action_enabled(curr)) {
1225                 /* Make the execution look like we chose to run this action
1226                  * much later, when a lock/join can succeed */
1227                 get_thread(curr)->set_pending(curr);
1228                 scheduler->sleep(get_thread(curr));
1229                 return NULL;
1230         }
1231
1232         bool newly_explored = initialize_curr_action(&curr);
1233
1234         DBG();
1235         if (DBG_ENABLED())
1236                 curr->print();
1237
1238         wake_up_sleeping_actions(curr);
1239
1240         /* Add the action to lists before any other model-checking tasks */
1241         if (!second_part_of_rmw)
1242                 add_action_to_lists(curr);
1243
1244         /* Build may_read_from set for newly-created actions */
1245         if (newly_explored && curr->is_read())
1246                 build_reads_from_past(curr);
1247
1248         /* Initialize work_queue with the "current action" work */
1249         work_queue_t work_queue(1, CheckCurrWorkEntry(curr));
1250         while (!work_queue.empty() && !has_asserted()) {
1251                 WorkQueueEntry work = work_queue.front();
1252                 work_queue.pop_front();
1253
1254                 switch (work.type) {
1255                 case WORK_CHECK_CURR_ACTION: {
1256                         ModelAction *act = work.action;
1257                         bool update = false; /* update this location's release seq's */
1258                         bool update_all = false; /* update all release seq's */
1259
1260                         if (process_thread_action(curr))
1261                                 update_all = true;
1262
1263                         if (act->is_read() && process_read(act, second_part_of_rmw))
1264                                 update = true;
1265
1266                         if (act->is_write() && process_write(act))
1267                                 update = true;
1268
1269                         if (act->is_fence() && process_fence(act))
1270                                 update_all = true;
1271
1272                         if (act->is_mutex_op() && process_mutex(act))
1273                                 update_all = true;
1274
1275                         if (act->is_relseq_fixup())
1276                                 process_relseq_fixup(curr, &work_queue);
1277
1278                         if (update_all)
1279                                 work_queue.push_back(CheckRelSeqWorkEntry(NULL));
1280                         else if (update)
1281                                 work_queue.push_back(CheckRelSeqWorkEntry(act->get_location()));
1282                         break;
1283                 }
1284                 case WORK_CHECK_RELEASE_SEQ:
1285                         resolve_release_sequences(work.location, &work_queue);
1286                         break;
1287                 case WORK_CHECK_MO_EDGES: {
1288                         /** @todo Complete verification of work_queue */
1289                         ModelAction *act = work.action;
1290                         bool updated = false;
1291
1292                         if (act->is_read()) {
1293                                 const ModelAction *rf = act->get_reads_from();
1294                                 if (rf != NULL && r_modification_order(act, rf))
1295                                         updated = true;
1296                         }
1297                         if (act->is_write()) {
1298                                 if (w_modification_order(act))
1299                                         updated = true;
1300                         }
1301                         mo_graph->commitChanges();
1302
1303                         if (updated)
1304                                 work_queue.push_back(CheckRelSeqWorkEntry(act->get_location()));
1305                         break;
1306                 }
1307                 default:
1308                         ASSERT(false);
1309                         break;
1310                 }
1311         }
1312
1313         check_curr_backtracking(curr);
1314         set_backtracking(curr);
1315         return curr;
1316 }
1317
1318 void ModelChecker::check_curr_backtracking(ModelAction *curr)
1319 {
1320         Node *currnode = curr->get_node();
1321         Node *parnode = currnode->get_parent();
1322
1323         if ((parnode && !parnode->backtrack_empty()) ||
1324                          !currnode->misc_empty() ||
1325                          !currnode->read_from_empty() ||
1326                          !currnode->future_value_empty() ||
1327                          !currnode->promise_empty() ||
1328                          !currnode->relseq_break_empty()) {
1329                 set_latest_backtrack(curr);
1330         }
1331 }
1332
1333 bool ModelChecker::promises_expired() const
1334 {
1335         for (unsigned int i = 0; i < promises->size(); i++) {
1336                 Promise *promise = (*promises)[i];
1337                 if (promise->get_expiration() < priv->used_sequence_numbers)
1338                         return true;
1339         }
1340         return false;
1341 }
1342
1343 /**
1344  * This is the strongest feasibility check available.
1345  * @return whether the current trace (partial or complete) must be a prefix of
1346  * a feasible trace.
1347  */
1348 bool ModelChecker::isfeasibleprefix() const
1349 {
1350         return pending_rel_seqs->size() == 0 && is_feasible_prefix_ignore_relseq();
1351 }
1352
1353 /**
1354  * Print disagnostic information about an infeasible execution
1355  * @param prefix A string to prefix the output with; if NULL, then a default
1356  * message prefix will be provided
1357  */
1358 void ModelChecker::print_infeasibility(const char *prefix) const
1359 {
1360         char buf[100];
1361         char *ptr = buf;
1362         if (mo_graph->checkForRMWViolation())
1363                 ptr += sprintf(ptr, "[RMW atomicity]");
1364         if (mo_graph->checkForCycles())
1365                 ptr += sprintf(ptr, "[mo cycle]");
1366         if (priv->failed_promise)
1367                 ptr += sprintf(ptr, "[failed promise]");
1368         if (priv->too_many_reads)
1369                 ptr += sprintf(ptr, "[too many reads]");
1370         if (priv->bad_synchronization)
1371                 ptr += sprintf(ptr, "[bad sw ordering]");
1372         if (promises_expired())
1373                 ptr += sprintf(ptr, "[promise expired]");
1374         if (promises->size() != 0)
1375                 ptr += sprintf(ptr, "[unresolved promise]");
1376         if (ptr != buf)
1377                 model_print("%s: %s\n", prefix ? prefix : "Infeasible", buf);
1378 }
1379
1380 /**
1381  * Returns whether the current completed trace is feasible, except for pending
1382  * release sequences.
1383  */
1384 bool ModelChecker::is_feasible_prefix_ignore_relseq() const
1385 {
1386         return !is_infeasible() && promises->size() == 0;
1387 }
1388
1389 /**
1390  * Check if the current partial trace is infeasible. Does not check any
1391  * end-of-execution flags, which might rule out the execution. Thus, this is
1392  * useful only for ruling an execution as infeasible.
1393  * @return whether the current partial trace is infeasible.
1394  */
1395 bool ModelChecker::is_infeasible() const
1396 {
1397         return mo_graph->checkForRMWViolation() || is_infeasible_ignoreRMW();
1398 }
1399
1400 /**
1401  * Check If the current partial trace is infeasible, while ignoring
1402  * infeasibility related to 2 RMW's reading from the same store. It does not
1403  * check end-of-execution feasibility.
1404  * @see ModelChecker::is_infeasible
1405  * @return whether the current partial trace is infeasible, ignoring multiple
1406  * RMWs reading from the same store.
1407  * */
1408 bool ModelChecker::is_infeasible_ignoreRMW() const
1409 {
1410         return mo_graph->checkForCycles() || priv->failed_promise ||
1411                 priv->too_many_reads || priv->bad_synchronization ||
1412                 promises_expired();
1413 }
1414
1415 /** Close out a RMWR by converting previous RMWR into a RMW or READ. */
1416 ModelAction * ModelChecker::process_rmw(ModelAction *act) {
1417         ModelAction *lastread = get_last_action(act->get_tid());
1418         lastread->process_rmw(act);
1419         if (act->is_rmw() && lastread->get_reads_from() != NULL) {
1420                 mo_graph->addRMWEdge(lastread->get_reads_from(), lastread);
1421                 mo_graph->commitChanges();
1422         }
1423         return lastread;
1424 }
1425
1426 /**
1427  * Checks whether a thread has read from the same write for too many times
1428  * without seeing the effects of a later write.
1429  *
1430  * Basic idea:
1431  * 1) there must a different write that we could read from that would satisfy the modification order,
1432  * 2) we must have read from the same value in excess of maxreads times, and
1433  * 3) that other write must have been in the reads_from set for maxreads times.
1434  *
1435  * If so, we decide that the execution is no longer feasible.
1436  */
1437 void ModelChecker::check_recency(ModelAction *curr, const ModelAction *rf)
1438 {
1439         if (params.maxreads != 0) {
1440                 if (curr->get_node()->get_read_from_size() <= 1)
1441                         return;
1442                 //Must make sure that execution is currently feasible...  We could
1443                 //accidentally clear by rolling back
1444                 if (is_infeasible())
1445                         return;
1446                 std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, curr->get_location());
1447                 int tid = id_to_int(curr->get_tid());
1448
1449                 /* Skip checks */
1450                 if ((int)thrd_lists->size() <= tid)
1451                         return;
1452                 action_list_t *list = &(*thrd_lists)[tid];
1453
1454                 action_list_t::reverse_iterator rit = list->rbegin();
1455                 /* Skip past curr */
1456                 for (; (*rit) != curr; rit++)
1457                         ;
1458                 /* go past curr now */
1459                 rit++;
1460
1461                 action_list_t::reverse_iterator ritcopy = rit;
1462                 //See if we have enough reads from the same value
1463                 int count = 0;
1464                 for (; count < params.maxreads; rit++, count++) {
1465                         if (rit == list->rend())
1466                                 return;
1467                         ModelAction *act = *rit;
1468                         if (!act->is_read())
1469                                 return;
1470
1471                         if (act->get_reads_from() != rf)
1472                                 return;
1473                         if (act->get_node()->get_read_from_size() <= 1)
1474                                 return;
1475                 }
1476                 for (int i = 0; i < curr->get_node()->get_read_from_size(); i++) {
1477                         /* Get write */
1478                         const ModelAction *write = curr->get_node()->get_read_from_at(i);
1479
1480                         /* Need a different write */
1481                         if (write == rf)
1482                                 continue;
1483
1484                         /* Test to see whether this is a feasible write to read from */
1485                         mo_graph->startChanges();
1486                         r_modification_order(curr, write);
1487                         bool feasiblereadfrom = !is_infeasible();
1488                         mo_graph->rollbackChanges();
1489
1490                         if (!feasiblereadfrom)
1491                                 continue;
1492                         rit = ritcopy;
1493
1494                         bool feasiblewrite = true;
1495                         //new we need to see if this write works for everyone
1496
1497                         for (int loop = count; loop > 0; loop--, rit++) {
1498                                 ModelAction *act = *rit;
1499                                 bool foundvalue = false;
1500                                 for (int j = 0; j < act->get_node()->get_read_from_size(); j++) {
1501                                         if (act->get_node()->get_read_from_at(j) == write) {
1502                                                 foundvalue = true;
1503                                                 break;
1504                                         }
1505                                 }
1506                                 if (!foundvalue) {
1507                                         feasiblewrite = false;
1508                                         break;
1509                                 }
1510                         }
1511                         if (feasiblewrite) {
1512                                 priv->too_many_reads = true;
1513                                 return;
1514                         }
1515                 }
1516         }
1517 }
1518
1519 /**
1520  * Updates the mo_graph with the constraints imposed from the current
1521  * read.
1522  *
1523  * Basic idea is the following: Go through each other thread and find
1524  * the lastest action that happened before our read.  Two cases:
1525  *
1526  * (1) The action is a write => that write must either occur before
1527  * the write we read from or be the write we read from.
1528  *
1529  * (2) The action is a read => the write that that action read from
1530  * must occur before the write we read from or be the same write.
1531  *
1532  * @param curr The current action. Must be a read.
1533  * @param rf The action that curr reads from. Must be a write.
1534  * @return True if modification order edges were added; false otherwise
1535  */
1536 bool ModelChecker::r_modification_order(ModelAction *curr, const ModelAction *rf)
1537 {
1538         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, curr->get_location());
1539         unsigned int i;
1540         bool added = false;
1541         ASSERT(curr->is_read());
1542
1543         /* Last SC fence in the current thread */
1544         ModelAction *last_sc_fence_local = get_last_seq_cst_fence(curr->get_tid(), NULL);
1545
1546         /* Iterate over all threads */
1547         for (i = 0; i < thrd_lists->size(); i++) {
1548                 /* Last SC fence in thread i */
1549                 ModelAction *last_sc_fence_thread_local = NULL;
1550                 if (int_to_id((int)i) != curr->get_tid())
1551                         last_sc_fence_thread_local = get_last_seq_cst_fence(int_to_id(i), NULL);
1552
1553                 /* Last SC fence in thread i, before last SC fence in current thread */
1554                 ModelAction *last_sc_fence_thread_before = NULL;
1555                 if (last_sc_fence_local)
1556                         last_sc_fence_thread_before = get_last_seq_cst_fence(int_to_id(i), last_sc_fence_local);
1557
1558                 /* Iterate over actions in thread, starting from most recent */
1559                 action_list_t *list = &(*thrd_lists)[i];
1560                 action_list_t::reverse_iterator rit;
1561                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1562                         ModelAction *act = *rit;
1563
1564                         if (act->is_write() && act != rf && act != curr) {
1565                                 /* C++, Section 29.3 statement 5 */
1566                                 if (curr->is_seqcst() && last_sc_fence_thread_local &&
1567                                                 *act < *last_sc_fence_thread_local) {
1568                                         mo_graph->addEdge(act, rf);
1569                                         added = true;
1570                                         break;
1571                                 }
1572                                 /* C++, Section 29.3 statement 4 */
1573                                 else if (act->is_seqcst() && last_sc_fence_local &&
1574                                                 *act < *last_sc_fence_local) {
1575                                         mo_graph->addEdge(act, rf);
1576                                         added = true;
1577                                         break;
1578                                 }
1579                                 /* C++, Section 29.3 statement 6 */
1580                                 else if (last_sc_fence_thread_before &&
1581                                                 *act < *last_sc_fence_thread_before) {
1582                                         mo_graph->addEdge(act, rf);
1583                                         added = true;
1584                                         break;
1585                                 }
1586                         }
1587
1588                         /*
1589                          * Include at most one act per-thread that "happens
1590                          * before" curr. Don't consider reflexively.
1591                          */
1592                         if (act->happens_before(curr) && act != curr) {
1593                                 if (act->is_write()) {
1594                                         if (rf != act) {
1595                                                 mo_graph->addEdge(act, rf);
1596                                                 added = true;
1597                                         }
1598                                 } else {
1599                                         const ModelAction *prevreadfrom = act->get_reads_from();
1600                                         //if the previous read is unresolved, keep going...
1601                                         if (prevreadfrom == NULL)
1602                                                 continue;
1603
1604                                         if (rf != prevreadfrom) {
1605                                                 mo_graph->addEdge(prevreadfrom, rf);
1606                                                 added = true;
1607                                         }
1608                                 }
1609                                 break;
1610                         }
1611                 }
1612         }
1613
1614         return added;
1615 }
1616
1617 /** This method fixes up the modification order when we resolve a
1618  *  promises.  The basic problem is that actions that occur after the
1619  *  read curr could not property add items to the modification order
1620  *  for our read.
1621  *
1622  *  So for each thread, we find the earliest item that happens after
1623  *  the read curr.  This is the item we have to fix up with additional
1624  *  constraints.  If that action is write, we add a MO edge between
1625  *  the Action rf and that action.  If the action is a read, we add a
1626  *  MO edge between the Action rf, and whatever the read accessed.
1627  *
1628  * @param curr is the read ModelAction that we are fixing up MO edges for.
1629  * @param rf is the write ModelAction that curr reads from.
1630  *
1631  */
1632 void ModelChecker::post_r_modification_order(ModelAction *curr, const ModelAction *rf)
1633 {
1634         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, curr->get_location());
1635         unsigned int i;
1636         ASSERT(curr->is_read());
1637
1638         /* Iterate over all threads */
1639         for (i = 0; i < thrd_lists->size(); i++) {
1640                 /* Iterate over actions in thread, starting from most recent */
1641                 action_list_t *list = &(*thrd_lists)[i];
1642                 action_list_t::reverse_iterator rit;
1643                 ModelAction *lastact = NULL;
1644
1645                 /* Find last action that happens after curr that is either not curr or a rmw */
1646                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1647                         ModelAction *act = *rit;
1648                         if (curr->happens_before(act) && (curr != act || curr->is_rmw())) {
1649                                 lastact = act;
1650                         } else
1651                                 break;
1652                 }
1653
1654                         /* Include at most one act per-thread that "happens before" curr */
1655                 if (lastact != NULL) {
1656                         if (lastact == curr) {
1657                                 //Case 1: The resolved read is a RMW, and we need to make sure
1658                                 //that the write portion of the RMW mod order after rf
1659
1660                                 mo_graph->addEdge(rf, lastact);
1661                         } else if (lastact->is_read()) {
1662                                 //Case 2: The resolved read is a normal read and the next
1663                                 //operation is a read, and we need to make sure the value read
1664                                 //is mod ordered after rf
1665
1666                                 const ModelAction *postreadfrom = lastact->get_reads_from();
1667                                 if (postreadfrom != NULL && rf != postreadfrom)
1668                                         mo_graph->addEdge(rf, postreadfrom);
1669                         } else {
1670                                 //Case 3: The resolved read is a normal read and the next
1671                                 //operation is a write, and we need to make sure that the
1672                                 //write is mod ordered after rf
1673                                 if (lastact != rf)
1674                                         mo_graph->addEdge(rf, lastact);
1675                         }
1676                         break;
1677                 }
1678         }
1679 }
1680
1681 /**
1682  * Updates the mo_graph with the constraints imposed from the current write.
1683  *
1684  * Basic idea is the following: Go through each other thread and find
1685  * the lastest action that happened before our write.  Two cases:
1686  *
1687  * (1) The action is a write => that write must occur before
1688  * the current write
1689  *
1690  * (2) The action is a read => the write that that action read from
1691  * must occur before the current write.
1692  *
1693  * This method also handles two other issues:
1694  *
1695  * (I) Sequential Consistency: Making sure that if the current write is
1696  * seq_cst, that it occurs after the previous seq_cst write.
1697  *
1698  * (II) Sending the write back to non-synchronizing reads.
1699  *
1700  * @param curr The current action. Must be a write.
1701  * @return True if modification order edges were added; false otherwise
1702  */
1703 bool ModelChecker::w_modification_order(ModelAction *curr)
1704 {
1705         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, curr->get_location());
1706         unsigned int i;
1707         bool added = false;
1708         ASSERT(curr->is_write());
1709
1710         if (curr->is_seqcst()) {
1711                 /* We have to at least see the last sequentially consistent write,
1712                          so we are initialized. */
1713                 ModelAction *last_seq_cst = get_last_seq_cst_write(curr);
1714                 if (last_seq_cst != NULL) {
1715                         mo_graph->addEdge(last_seq_cst, curr);
1716                         added = true;
1717                 }
1718         }
1719
1720         /* Last SC fence in the current thread */
1721         ModelAction *last_sc_fence_local = get_last_seq_cst_fence(curr->get_tid(), NULL);
1722
1723         /* Iterate over all threads */
1724         for (i = 0; i < thrd_lists->size(); i++) {
1725                 /* Last SC fence in thread i, before last SC fence in current thread */
1726                 ModelAction *last_sc_fence_thread_before = NULL;
1727                 if (last_sc_fence_local && int_to_id((int)i) != curr->get_tid())
1728                         last_sc_fence_thread_before = get_last_seq_cst_fence(int_to_id(i), last_sc_fence_local);
1729
1730                 /* Iterate over actions in thread, starting from most recent */
1731                 action_list_t *list = &(*thrd_lists)[i];
1732                 action_list_t::reverse_iterator rit;
1733                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1734                         ModelAction *act = *rit;
1735                         if (act == curr) {
1736                                 /*
1737                                  * 1) If RMW and it actually read from something, then we
1738                                  * already have all relevant edges, so just skip to next
1739                                  * thread.
1740                                  *
1741                                  * 2) If RMW and it didn't read from anything, we should
1742                                  * whatever edge we can get to speed up convergence.
1743                                  *
1744                                  * 3) If normal write, we need to look at earlier actions, so
1745                                  * continue processing list.
1746                                  */
1747                                 if (curr->is_rmw()) {
1748                                         if (curr->get_reads_from() != NULL)
1749                                                 break;
1750                                         else
1751                                                 continue;
1752                                 } else
1753                                         continue;
1754                         }
1755
1756                         /* C++, Section 29.3 statement 7 */
1757                         if (last_sc_fence_thread_before && act->is_write() &&
1758                                         *act < *last_sc_fence_thread_before) {
1759                                 mo_graph->addEdge(act, curr);
1760                                 added = true;
1761                                 break;
1762                         }
1763
1764                         /*
1765                          * Include at most one act per-thread that "happens
1766                          * before" curr
1767                          */
1768                         if (act->happens_before(curr)) {
1769                                 /*
1770                                  * Note: if act is RMW, just add edge:
1771                                  *   act --mo--> curr
1772                                  * The following edge should be handled elsewhere:
1773                                  *   readfrom(act) --mo--> act
1774                                  */
1775                                 if (act->is_write())
1776                                         mo_graph->addEdge(act, curr);
1777                                 else if (act->is_read()) {
1778                                         //if previous read accessed a null, just keep going
1779                                         if (act->get_reads_from() == NULL)
1780                                                 continue;
1781                                         mo_graph->addEdge(act->get_reads_from(), curr);
1782                                 }
1783                                 added = true;
1784                                 break;
1785                         } else if (act->is_read() && !act->could_synchronize_with(curr) &&
1786                                                      !act->same_thread(curr)) {
1787                                 /* We have an action that:
1788                                    (1) did not happen before us
1789                                    (2) is a read and we are a write
1790                                    (3) cannot synchronize with us
1791                                    (4) is in a different thread
1792                                    =>
1793                                    that read could potentially read from our write.  Note that
1794                                    these checks are overly conservative at this point, we'll
1795                                    do more checks before actually removing the
1796                                    pendingfuturevalue.
1797
1798                                  */
1799                                 if (thin_air_constraint_may_allow(curr, act)) {
1800                                         if (!is_infeasible() ||
1801                                                         (curr->is_rmw() && act->is_rmw() && curr->get_reads_from() == act->get_reads_from() && !is_infeasible_ignoreRMW())) {
1802                                                 futurevalues->push_back(PendingFutureValue(curr, act));
1803                                         }
1804                                 }
1805                         }
1806                 }
1807         }
1808
1809         return added;
1810 }
1811
1812 /** Arbitrary reads from the future are not allowed.  Section 29.3
1813  * part 9 places some constraints.  This method checks one result of constraint
1814  * constraint.  Others require compiler support. */
1815 bool ModelChecker::thin_air_constraint_may_allow(const ModelAction *writer, const ModelAction *reader)
1816 {
1817         if (!writer->is_rmw())
1818                 return true;
1819
1820         if (!reader->is_rmw())
1821                 return true;
1822
1823         for (const ModelAction *search = writer->get_reads_from(); search != NULL; search = search->get_reads_from()) {
1824                 if (search == reader)
1825                         return false;
1826                 if (search->get_tid() == reader->get_tid() &&
1827                                 search->happens_before(reader))
1828                         break;
1829         }
1830
1831         return true;
1832 }
1833
1834 /**
1835  * Arbitrary reads from the future are not allowed. Section 29.3 part 9 places
1836  * some constraints. This method checks one the following constraint (others
1837  * require compiler support):
1838  *
1839  *   If X --hb-> Y --mo-> Z, then X should not read from Z.
1840  */
1841 bool ModelChecker::mo_may_allow(const ModelAction *writer, const ModelAction *reader)
1842 {
1843         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, reader->get_location());
1844         unsigned int i;
1845         /* Iterate over all threads */
1846         for (i = 0; i < thrd_lists->size(); i++) {
1847                 const ModelAction *write_after_read = NULL;
1848
1849                 /* Iterate over actions in thread, starting from most recent */
1850                 action_list_t *list = &(*thrd_lists)[i];
1851                 action_list_t::reverse_iterator rit;
1852                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1853                         ModelAction *act = *rit;
1854
1855                         /* Don't disallow due to act == reader */
1856                         if (!reader->happens_before(act) || reader == act)
1857                                 break;
1858                         else if (act->is_write())
1859                                 write_after_read = act;
1860                         else if (act->is_read() && act->get_reads_from() != NULL)
1861                                 write_after_read = act->get_reads_from();
1862                 }
1863
1864                 if (write_after_read && write_after_read != writer && mo_graph->checkReachable(write_after_read, writer))
1865                         return false;
1866         }
1867         return true;
1868 }
1869
1870 /**
1871  * Finds the head(s) of the release sequence(s) containing a given ModelAction.
1872  * The ModelAction under consideration is expected to be taking part in
1873  * release/acquire synchronization as an object of the "reads from" relation.
1874  * Note that this can only provide release sequence support for RMW chains
1875  * which do not read from the future, as those actions cannot be traced until
1876  * their "promise" is fulfilled. Similarly, we may not even establish the
1877  * presence of a release sequence with certainty, as some modification order
1878  * constraints may be decided further in the future. Thus, this function
1879  * "returns" two pieces of data: a pass-by-reference vector of @a release_heads
1880  * and a boolean representing certainty.
1881  *
1882  * @param rf The action that might be part of a release sequence. Must be a
1883  * write.
1884  * @param release_heads A pass-by-reference style return parameter. After
1885  * execution of this function, release_heads will contain the heads of all the
1886  * relevant release sequences, if any exists with certainty
1887  * @param pending A pass-by-reference style return parameter which is only used
1888  * when returning false (i.e., uncertain). Returns most information regarding
1889  * an uncertain release sequence, including any write operations that might
1890  * break the sequence.
1891  * @return true, if the ModelChecker is certain that release_heads is complete;
1892  * false otherwise
1893  */
1894 bool ModelChecker::release_seq_heads(const ModelAction *rf,
1895                 rel_heads_list_t *release_heads,
1896                 struct release_seq *pending) const
1897 {
1898         /* Only check for release sequences if there are no cycles */
1899         if (mo_graph->checkForCycles())
1900                 return false;
1901
1902         while (rf) {
1903                 ASSERT(rf->is_write());
1904
1905                 if (rf->is_release())
1906                         release_heads->push_back(rf);
1907                 else if (rf->get_last_fence_release())
1908                         release_heads->push_back(rf->get_last_fence_release());
1909                 if (!rf->is_rmw())
1910                         break; /* End of RMW chain */
1911
1912                 /** @todo Need to be smarter here...  In the linux lock
1913                  * example, this will run to the beginning of the program for
1914                  * every acquire. */
1915                 /** @todo The way to be smarter here is to keep going until 1
1916                  * thread has a release preceded by an acquire and you've seen
1917                  *       both. */
1918
1919                 /* acq_rel RMW is a sufficient stopping condition */
1920                 if (rf->is_acquire() && rf->is_release())
1921                         return true; /* complete */
1922
1923                 rf = rf->get_reads_from();
1924         };
1925         if (!rf) {
1926                 /* read from future: need to settle this later */
1927                 pending->rf = NULL;
1928                 return false; /* incomplete */
1929         }
1930
1931         if (rf->is_release())
1932                 return true; /* complete */
1933
1934         /* else relaxed write
1935          * - check for fence-release in the same thread (29.8, stmt. 3)
1936          * - check modification order for contiguous subsequence
1937          *   -> rf must be same thread as release */
1938
1939         const ModelAction *fence_release = rf->get_last_fence_release();
1940         /* Synchronize with a fence-release unconditionally; we don't need to
1941          * find any more "contiguous subsequence..." for it */
1942         if (fence_release)
1943                 release_heads->push_back(fence_release);
1944
1945         int tid = id_to_int(rf->get_tid());
1946         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, rf->get_location());
1947         action_list_t *list = &(*thrd_lists)[tid];
1948         action_list_t::const_reverse_iterator rit;
1949
1950         /* Find rf in the thread list */
1951         rit = std::find(list->rbegin(), list->rend(), rf);
1952         ASSERT(rit != list->rend());
1953
1954         /* Find the last {write,fence}-release */
1955         for (; rit != list->rend(); rit++) {
1956                 if (fence_release && *(*rit) < *fence_release)
1957                         break;
1958                 if ((*rit)->is_release())
1959                         break;
1960         }
1961         if (rit == list->rend()) {
1962                 /* No write-release in this thread */
1963                 return true; /* complete */
1964         } else if (fence_release && *(*rit) < *fence_release) {
1965                 /* The fence-release is more recent (and so, "stronger") than
1966                  * the most recent write-release */
1967                 return true; /* complete */
1968         } /* else, need to establish contiguous release sequence */
1969         ModelAction *release = *rit;
1970
1971         ASSERT(rf->same_thread(release));
1972
1973         pending->writes.clear();
1974
1975         bool certain = true;
1976         for (unsigned int i = 0; i < thrd_lists->size(); i++) {
1977                 if (id_to_int(rf->get_tid()) == (int)i)
1978                         continue;
1979                 list = &(*thrd_lists)[i];
1980
1981                 /* Can we ensure no future writes from this thread may break
1982                  * the release seq? */
1983                 bool future_ordered = false;
1984
1985                 ModelAction *last = get_last_action(int_to_id(i));
1986                 Thread *th = get_thread(int_to_id(i));
1987                 if ((last && rf->happens_before(last)) ||
1988                                 !is_enabled(th) ||
1989                                 th->is_complete())
1990                         future_ordered = true;
1991
1992                 ASSERT(!th->is_model_thread() || future_ordered);
1993
1994                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1995                         const ModelAction *act = *rit;
1996                         /* Reach synchronization -> this thread is complete */
1997                         if (act->happens_before(release))
1998                                 break;
1999                         if (rf->happens_before(act)) {
2000                                 future_ordered = true;
2001                                 continue;
2002                         }
2003
2004                         /* Only non-RMW writes can break release sequences */
2005                         if (!act->is_write() || act->is_rmw())
2006                                 continue;
2007
2008                         /* Check modification order */
2009                         if (mo_graph->checkReachable(rf, act)) {
2010                                 /* rf --mo--> act */
2011                                 future_ordered = true;
2012                                 continue;
2013                         }
2014                         if (mo_graph->checkReachable(act, release))
2015                                 /* act --mo--> release */
2016                                 break;
2017                         if (mo_graph->checkReachable(release, act) &&
2018                                       mo_graph->checkReachable(act, rf)) {
2019                                 /* release --mo-> act --mo--> rf */
2020                                 return true; /* complete */
2021                         }
2022                         /* act may break release sequence */
2023                         pending->writes.push_back(act);
2024                         certain = false;
2025                 }
2026                 if (!future_ordered)
2027                         certain = false; /* This thread is uncertain */
2028         }
2029
2030         if (certain) {
2031                 release_heads->push_back(release);
2032                 pending->writes.clear();
2033         } else {
2034                 pending->release = release;
2035                 pending->rf = rf;
2036         }
2037         return certain;
2038 }
2039
2040 /**
2041  * An interface for getting the release sequence head(s) with which a
2042  * given ModelAction must synchronize. This function only returns a non-empty
2043  * result when it can locate a release sequence head with certainty. Otherwise,
2044  * it may mark the internal state of the ModelChecker so that it will handle
2045  * the release sequence at a later time, causing @a acquire to update its
2046  * synchronization at some later point in execution.
2047  *
2048  * @param acquire The 'acquire' action that may synchronize with a release
2049  * sequence
2050  * @param read The read action that may read from a release sequence; this may
2051  * be the same as acquire, or else an earlier action in the same thread (i.e.,
2052  * when 'acquire' is a fence-acquire)
2053  * @param release_heads A pass-by-reference return parameter. Will be filled
2054  * with the head(s) of the release sequence(s), if they exists with certainty.
2055  * @see ModelChecker::release_seq_heads
2056  */
2057 void ModelChecker::get_release_seq_heads(ModelAction *acquire,
2058                 ModelAction *read, rel_heads_list_t *release_heads)
2059 {
2060         const ModelAction *rf = read->get_reads_from();
2061         struct release_seq *sequence = (struct release_seq *)snapshot_calloc(1, sizeof(struct release_seq));
2062         sequence->acquire = acquire;
2063         sequence->read = read;
2064
2065         if (!release_seq_heads(rf, release_heads, sequence)) {
2066                 /* add act to 'lazy checking' list */
2067                 pending_rel_seqs->push_back(sequence);
2068         } else {
2069                 snapshot_free(sequence);
2070         }
2071 }
2072
2073 /**
2074  * Attempt to resolve all stashed operations that might synchronize with a
2075  * release sequence for a given location. This implements the "lazy" portion of
2076  * determining whether or not a release sequence was contiguous, since not all
2077  * modification order information is present at the time an action occurs.
2078  *
2079  * @param location The location/object that should be checked for release
2080  * sequence resolutions. A NULL value means to check all locations.
2081  * @param work_queue The work queue to which to add work items as they are
2082  * generated
2083  * @return True if any updates occurred (new synchronization, new mo_graph
2084  * edges)
2085  */
2086 bool ModelChecker::resolve_release_sequences(void *location, work_queue_t *work_queue)
2087 {
2088         bool updated = false;
2089         std::vector< struct release_seq *, SnapshotAlloc<struct release_seq *> >::iterator it = pending_rel_seqs->begin();
2090         while (it != pending_rel_seqs->end()) {
2091                 struct release_seq *pending = *it;
2092                 ModelAction *acquire = pending->acquire;
2093                 const ModelAction *read = pending->read;
2094
2095                 /* Only resolve sequences on the given location, if provided */
2096                 if (location && read->get_location() != location) {
2097                         it++;
2098                         continue;
2099                 }
2100
2101                 const ModelAction *rf = read->get_reads_from();
2102                 rel_heads_list_t release_heads;
2103                 bool complete;
2104                 complete = release_seq_heads(rf, &release_heads, pending);
2105                 for (unsigned int i = 0; i < release_heads.size(); i++) {
2106                         if (!acquire->has_synchronized_with(release_heads[i])) {
2107                                 if (acquire->synchronize_with(release_heads[i]))
2108                                         updated = true;
2109                                 else
2110                                         set_bad_synchronization();
2111                         }
2112                 }
2113
2114                 if (updated) {
2115                         /* Re-check all pending release sequences */
2116                         work_queue->push_back(CheckRelSeqWorkEntry(NULL));
2117                         /* Re-check read-acquire for mo_graph edges */
2118                         if (acquire->is_read())
2119                                 work_queue->push_back(MOEdgeWorkEntry(acquire));
2120
2121                         /* propagate synchronization to later actions */
2122                         action_list_t::reverse_iterator rit = action_trace->rbegin();
2123                         for (; (*rit) != acquire; rit++) {
2124                                 ModelAction *propagate = *rit;
2125                                 if (acquire->happens_before(propagate)) {
2126                                         propagate->synchronize_with(acquire);
2127                                         /* Re-check 'propagate' for mo_graph edges */
2128                                         work_queue->push_back(MOEdgeWorkEntry(propagate));
2129                                 }
2130                         }
2131                 }
2132                 if (complete) {
2133                         it = pending_rel_seqs->erase(it);
2134                         snapshot_free(pending);
2135                 } else {
2136                         it++;
2137                 }
2138         }
2139
2140         // If we resolved promises or data races, see if we have realized a data race.
2141         checkDataRaces();
2142
2143         return updated;
2144 }
2145
2146 /**
2147  * Performs various bookkeeping operations for the current ModelAction. For
2148  * instance, adds action to the per-object, per-thread action vector and to the
2149  * action trace list of all thread actions.
2150  *
2151  * @param act is the ModelAction to add.
2152  */
2153 void ModelChecker::add_action_to_lists(ModelAction *act)
2154 {
2155         int tid = id_to_int(act->get_tid());
2156         ModelAction *uninit = NULL;
2157         int uninit_id = -1;
2158         action_list_t *list = get_safe_ptr_action(obj_map, act->get_location());
2159         if (list->empty() && act->is_atomic_var()) {
2160                 uninit = new_uninitialized_action(act->get_location());
2161                 uninit_id = id_to_int(uninit->get_tid());
2162                 list->push_back(uninit);
2163         }
2164         list->push_back(act);
2165
2166         action_trace->push_back(act);
2167         if (uninit)
2168                 action_trace->push_front(uninit);
2169
2170         std::vector<action_list_t> *vec = get_safe_ptr_vect_action(obj_thrd_map, act->get_location());
2171         if (tid >= (int)vec->size())
2172                 vec->resize(priv->next_thread_id);
2173         (*vec)[tid].push_back(act);
2174         if (uninit)
2175                 (*vec)[uninit_id].push_front(uninit);
2176
2177         if ((int)thrd_last_action->size() <= tid)
2178                 thrd_last_action->resize(get_num_threads());
2179         (*thrd_last_action)[tid] = act;
2180         if (uninit)
2181                 (*thrd_last_action)[uninit_id] = uninit;
2182
2183         if (act->is_fence() && act->is_release()) {
2184                 if ((int)thrd_last_fence_release->size() <= tid)
2185                         thrd_last_fence_release->resize(get_num_threads());
2186                 (*thrd_last_fence_release)[tid] = act;
2187         }
2188
2189         if (act->is_wait()) {
2190                 void *mutex_loc = (void *) act->get_value();
2191                 get_safe_ptr_action(obj_map, mutex_loc)->push_back(act);
2192
2193                 std::vector<action_list_t> *vec = get_safe_ptr_vect_action(obj_thrd_map, mutex_loc);
2194                 if (tid >= (int)vec->size())
2195                         vec->resize(priv->next_thread_id);
2196                 (*vec)[tid].push_back(act);
2197         }
2198 }
2199
2200 /**
2201  * @brief Get the last action performed by a particular Thread
2202  * @param tid The thread ID of the Thread in question
2203  * @return The last action in the thread
2204  */
2205 ModelAction * ModelChecker::get_last_action(thread_id_t tid) const
2206 {
2207         int threadid = id_to_int(tid);
2208         if (threadid < (int)thrd_last_action->size())
2209                 return (*thrd_last_action)[id_to_int(tid)];
2210         else
2211                 return NULL;
2212 }
2213
2214 /**
2215  * @brief Get the last fence release performed by a particular Thread
2216  * @param tid The thread ID of the Thread in question
2217  * @return The last fence release in the thread, if one exists; NULL otherwise
2218  */
2219 ModelAction * ModelChecker::get_last_fence_release(thread_id_t tid) const
2220 {
2221         int threadid = id_to_int(tid);
2222         if (threadid < (int)thrd_last_fence_release->size())
2223                 return (*thrd_last_fence_release)[id_to_int(tid)];
2224         else
2225                 return NULL;
2226 }
2227
2228 /**
2229  * Gets the last memory_order_seq_cst write (in the total global sequence)
2230  * performed on a particular object (i.e., memory location), not including the
2231  * current action.
2232  * @param curr The current ModelAction; also denotes the object location to
2233  * check
2234  * @return The last seq_cst write
2235  */
2236 ModelAction * ModelChecker::get_last_seq_cst_write(ModelAction *curr) const
2237 {
2238         void *location = curr->get_location();
2239         action_list_t *list = get_safe_ptr_action(obj_map, location);
2240         /* Find: max({i in dom(S) | seq_cst(t_i) && isWrite(t_i) && samevar(t_i, t)}) */
2241         action_list_t::reverse_iterator rit;
2242         for (rit = list->rbegin(); rit != list->rend(); rit++)
2243                 if ((*rit)->is_write() && (*rit)->is_seqcst() && (*rit) != curr)
2244                         return *rit;
2245         return NULL;
2246 }
2247
2248 /**
2249  * Gets the last memory_order_seq_cst fence (in the total global sequence)
2250  * performed in a particular thread, prior to a particular fence.
2251  * @param tid The ID of the thread to check
2252  * @param before_fence The fence from which to begin the search; if NULL, then
2253  * search for the most recent fence in the thread.
2254  * @return The last prior seq_cst fence in the thread, if exists; otherwise, NULL
2255  */
2256 ModelAction * ModelChecker::get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const
2257 {
2258         /* All fences should have NULL location */
2259         action_list_t *list = get_safe_ptr_action(obj_map, NULL);
2260         action_list_t::reverse_iterator rit = list->rbegin();
2261
2262         if (before_fence) {
2263                 for (; rit != list->rend(); rit++)
2264                         if (*rit == before_fence)
2265                                 break;
2266
2267                 ASSERT(*rit == before_fence);
2268                 rit++;
2269         }
2270
2271         for (; rit != list->rend(); rit++)
2272                 if ((*rit)->is_fence() && (tid == (*rit)->get_tid()) && (*rit)->is_seqcst())
2273                         return *rit;
2274         return NULL;
2275 }
2276
2277 /**
2278  * Gets the last unlock operation performed on a particular mutex (i.e., memory
2279  * location). This function identifies the mutex according to the current
2280  * action, which is presumed to perform on the same mutex.
2281  * @param curr The current ModelAction; also denotes the object location to
2282  * check
2283  * @return The last unlock operation
2284  */
2285 ModelAction * ModelChecker::get_last_unlock(ModelAction *curr) const
2286 {
2287         void *location = curr->get_location();
2288         action_list_t *list = get_safe_ptr_action(obj_map, location);
2289         /* Find: max({i in dom(S) | isUnlock(t_i) && samevar(t_i, t)}) */
2290         action_list_t::reverse_iterator rit;
2291         for (rit = list->rbegin(); rit != list->rend(); rit++)
2292                 if ((*rit)->is_unlock() || (*rit)->is_wait())
2293                         return *rit;
2294         return NULL;
2295 }
2296
2297 ModelAction * ModelChecker::get_parent_action(thread_id_t tid) const
2298 {
2299         ModelAction *parent = get_last_action(tid);
2300         if (!parent)
2301                 parent = get_thread(tid)->get_creation();
2302         return parent;
2303 }
2304
2305 /**
2306  * Returns the clock vector for a given thread.
2307  * @param tid The thread whose clock vector we want
2308  * @return Desired clock vector
2309  */
2310 ClockVector * ModelChecker::get_cv(thread_id_t tid) const
2311 {
2312         return get_parent_action(tid)->get_cv();
2313 }
2314
2315 /**
2316  * Resolve a set of Promises with a current write. The set is provided in the
2317  * Node corresponding to @a write.
2318  * @param write The ModelAction that is fulfilling Promises
2319  * @return True if promises were resolved; false otherwise
2320  */
2321 bool ModelChecker::resolve_promises(ModelAction *write)
2322 {
2323         bool resolved = false;
2324         std::vector< ModelAction *, ModelAlloc<ModelAction *> > actions_to_check;
2325
2326         for (unsigned int i = 0, promise_index = 0; promise_index < promises->size(); i++) {
2327                 Promise *promise = (*promises)[promise_index];
2328                 if (write->get_node()->get_promise(i)) {
2329                         ModelAction *read = promise->get_action();
2330                         if (read->is_rmw()) {
2331                                 mo_graph->addRMWEdge(write, read);
2332                         }
2333                         read_from(read, write);
2334                         //First fix up the modification order for actions that happened
2335                         //before the read
2336                         r_modification_order(read, write);
2337                         //Next fix up the modification order for actions that happened
2338                         //after the read.
2339                         post_r_modification_order(read, write);
2340                         //Make sure the promise's value matches the write's value
2341                         ASSERT(promise->get_value() == write->get_value());
2342                         delete(promise);
2343
2344                         promises->erase(promises->begin() + promise_index);
2345                         actions_to_check.push_back(read);
2346
2347                         resolved = true;
2348                 } else
2349                         promise_index++;
2350         }
2351
2352         //Check whether reading these writes has made threads unable to
2353         //resolve promises
2354
2355         for (unsigned int i = 0; i < actions_to_check.size(); i++) {
2356                 ModelAction *read=actions_to_check[i];
2357                 mo_check_promises(read->get_tid(), write, read);
2358         }
2359
2360         return resolved;
2361 }
2362
2363 /**
2364  * Compute the set of promises that could potentially be satisfied by this
2365  * action. Note that the set computation actually appears in the Node, not in
2366  * ModelChecker.
2367  * @param curr The ModelAction that may satisfy promises
2368  */
2369 void ModelChecker::compute_promises(ModelAction *curr)
2370 {
2371         for (unsigned int i = 0; i < promises->size(); i++) {
2372                 Promise *promise = (*promises)[i];
2373                 const ModelAction *act = promise->get_action();
2374                 if (!act->happens_before(curr) &&
2375                                 act->is_read() &&
2376                                 !act->could_synchronize_with(curr) &&
2377                                 !act->same_thread(curr) &&
2378                                 act->get_location() == curr->get_location() &&
2379                                 promise->get_value() == curr->get_value()) {
2380                         curr->get_node()->set_promise(i, act->is_rmw());
2381                 }
2382         }
2383 }
2384
2385 /** Checks promises in response to change in ClockVector Threads. */
2386 void ModelChecker::check_promises(thread_id_t tid, ClockVector *old_cv, ClockVector *merge_cv)
2387 {
2388         for (unsigned int i = 0; i < promises->size(); i++) {
2389                 Promise *promise = (*promises)[i];
2390                 const ModelAction *act = promise->get_action();
2391                 if ((old_cv == NULL || !old_cv->synchronized_since(act)) &&
2392                                 merge_cv->synchronized_since(act)) {
2393                         if (promise->eliminate_thread(tid)) {
2394                                 //Promise has failed
2395                                 priv->failed_promise = true;
2396                                 return;
2397                         }
2398                 }
2399         }
2400 }
2401
2402 void ModelChecker::check_promises_thread_disabled()
2403 {
2404         for (unsigned int i = 0; i < promises->size(); i++) {
2405                 Promise *promise = (*promises)[i];
2406                 if (promise->has_failed()) {
2407                         priv->failed_promise = true;
2408                         return;
2409                 }
2410         }
2411 }
2412
2413 /**
2414  * @brief Checks promises in response to addition to modification order for
2415  * threads.
2416  *
2417  * Definitions:
2418  *
2419  * pthread is the thread that performed the read that created the promise
2420  *
2421  * pread is the read that created the promise
2422  *
2423  * pwrite is either the first write to same location as pread by
2424  * pthread that is sequenced after pread or the write read by the
2425  * first read to the same location as pread by pthread that is
2426  * sequenced after pread.
2427  *
2428  * 1. If tid=pthread, then we check what other threads are reachable
2429  * through the mod order starting with pwrite.  Those threads cannot
2430  * perform a write that will resolve the promise due to modification
2431  * order constraints.
2432  *
2433  * 2. If the tid is not pthread, we check whether pwrite can reach the
2434  * action write through the modification order.  If so, that thread
2435  * cannot perform a future write that will resolve the promise due to
2436  * modificatin order constraints.
2437  *
2438  * @param tid The thread that either read from the model action write, or
2439  * actually did the model action write.
2440  *
2441  * @param write The ModelAction representing the relevant write.
2442  * @param read  The ModelAction that reads a promised write, or NULL otherwise.
2443  */
2444 void ModelChecker::mo_check_promises(thread_id_t tid, const ModelAction *write, const ModelAction *read)
2445 {
2446         void *location = write->get_location();
2447         for (unsigned int i = 0; i < promises->size(); i++) {
2448                 Promise *promise = (*promises)[i];
2449                 const ModelAction *act = promise->get_action();
2450
2451                 // Is this promise on the same location?
2452                 if (act->get_location() != location)
2453                         continue;
2454
2455                 // same thread as the promise
2456                 if (act->get_tid() == tid) {
2457                         // make sure that the reader of this write happens after the promise
2458                         if ((read == NULL) || (promise->get_action()->happens_before(read))) {
2459                                 // do we have a pwrite for the promise, if not, set it
2460                                 if (promise->get_write() == NULL) {
2461                                         promise->set_write(write);
2462                                         // The pwrite cannot happen before the promise
2463                                         if (write->happens_before(act) && (write != act)) {
2464                                                 priv->failed_promise = true;
2465                                                 return;
2466                                         }
2467                                 }
2468
2469                                 if (mo_graph->checkPromise(write, promise)) {
2470                                         priv->failed_promise = true;
2471                                         return;
2472                                 }
2473                         }
2474                 }
2475
2476                 // Don't do any lookups twice for the same thread
2477                 if (promise->thread_is_eliminated(tid))
2478                         continue;
2479
2480                 if (promise->get_write() && mo_graph->checkReachable(promise->get_write(), write)) {
2481                         if (promise->eliminate_thread(tid)) {
2482                                 priv->failed_promise = true;
2483                                 return;
2484                         }
2485                 }
2486         }
2487 }
2488
2489 /**
2490  * Compute the set of writes that may break the current pending release
2491  * sequence. This information is extracted from previou release sequence
2492  * calculations.
2493  *
2494  * @param curr The current ModelAction. Must be a release sequence fixup
2495  * action.
2496  */
2497 void ModelChecker::compute_relseq_breakwrites(ModelAction *curr)
2498 {
2499         if (pending_rel_seqs->empty())
2500                 return;
2501
2502         struct release_seq *pending = pending_rel_seqs->back();
2503         for (unsigned int i = 0; i < pending->writes.size(); i++) {
2504                 const ModelAction *write = pending->writes[i];
2505                 curr->get_node()->add_relseq_break(write);
2506         }
2507
2508         /* NULL means don't break the sequence; just synchronize */
2509         curr->get_node()->add_relseq_break(NULL);
2510 }
2511
2512 /**
2513  * Build up an initial set of all past writes that this 'read' action may read
2514  * from. This set is determined by the clock vector's "happens before"
2515  * relationship.
2516  * @param curr is the current ModelAction that we are exploring; it must be a
2517  * 'read' operation.
2518  */
2519 void ModelChecker::build_reads_from_past(ModelAction *curr)
2520 {
2521         std::vector<action_list_t> *thrd_lists = get_safe_ptr_vect_action(obj_thrd_map, curr->get_location());
2522         unsigned int i;
2523         ASSERT(curr->is_read());
2524
2525         ModelAction *last_sc_write = NULL;
2526
2527         if (curr->is_seqcst())
2528                 last_sc_write = get_last_seq_cst_write(curr);
2529
2530         /* Iterate over all threads */
2531         for (i = 0; i < thrd_lists->size(); i++) {
2532                 /* Iterate over actions in thread, starting from most recent */
2533                 action_list_t *list = &(*thrd_lists)[i];
2534                 action_list_t::reverse_iterator rit;
2535                 for (rit = list->rbegin(); rit != list->rend(); rit++) {
2536                         ModelAction *act = *rit;
2537
2538                         /* Only consider 'write' actions */
2539                         if (!act->is_write() || act == curr)
2540                                 continue;
2541
2542                         /* Don't consider more than one seq_cst write if we are a seq_cst read. */
2543                         bool allow_read = true;
2544
2545                         if (curr->is_seqcst() && (act->is_seqcst() || (last_sc_write != NULL && act->happens_before(last_sc_write))) && act != last_sc_write)
2546                                 allow_read = false;
2547                         else if (curr->get_sleep_flag() && !curr->is_seqcst() && !sleep_can_read_from(curr, act))
2548                                 allow_read = false;
2549
2550                         if (allow_read)
2551                                 curr->get_node()->add_read_from(act);
2552
2553                         /* Include at most one act per-thread that "happens before" curr */
2554                         if (act->happens_before(curr))
2555                                 break;
2556                 }
2557         }
2558
2559         if (DBG_ENABLED()) {
2560                 model_print("Reached read action:\n");
2561                 curr->print();
2562                 model_print("Printing may_read_from\n");
2563                 curr->get_node()->print_may_read_from();
2564                 model_print("End printing may_read_from\n");
2565         }
2566 }
2567
2568 bool ModelChecker::sleep_can_read_from(ModelAction *curr, const ModelAction *write)
2569 {
2570         while (true) {
2571                 /* UNINIT actions don't have a Node, and they never sleep */
2572                 if (write->is_uninitialized())
2573                         return true;
2574                 Node *prevnode = write->get_node()->get_parent();
2575
2576                 bool thread_sleep = prevnode->enabled_status(curr->get_tid()) == THREAD_SLEEP_SET;
2577                 if (write->is_release() && thread_sleep)
2578                         return true;
2579                 if (!write->is_rmw()) {
2580                         return false;
2581                 }
2582                 if (write->get_reads_from() == NULL)
2583                         return true;
2584                 write = write->get_reads_from();
2585         }
2586 }
2587
2588 /**
2589  * @brief Create a new action representing an uninitialized atomic
2590  * @param location The memory location of the atomic object
2591  * @return A pointer to a new ModelAction
2592  */
2593 ModelAction * ModelChecker::new_uninitialized_action(void *location) const
2594 {
2595         ModelAction *act = (ModelAction *)snapshot_malloc(sizeof(class ModelAction));
2596         act = new (act) ModelAction(ATOMIC_UNINIT, std::memory_order_relaxed, location, 0, model_thread);
2597         act->create_cv(NULL);
2598         return act;
2599 }
2600
2601 static void print_list(action_list_t *list)
2602 {
2603         action_list_t::iterator it;
2604
2605         model_print("---------------------------------------------------------------------\n");
2606
2607         unsigned int hash = 0;
2608
2609         for (it = list->begin(); it != list->end(); it++) {
2610                 (*it)->print();
2611                 hash = hash^(hash<<3)^((*it)->hash());
2612         }
2613         model_print("HASH %u\n", hash);
2614         model_print("---------------------------------------------------------------------\n");
2615 }
2616
2617 #if SUPPORT_MOD_ORDER_DUMP
2618 void ModelChecker::dumpGraph(char *filename) const
2619 {
2620         char buffer[200];
2621         sprintf(buffer, "%s.dot", filename);
2622         FILE *file = fopen(buffer, "w");
2623         fprintf(file, "digraph %s {\n", filename);
2624         mo_graph->dumpNodes(file);
2625         ModelAction **thread_array = (ModelAction **)model_calloc(1, sizeof(ModelAction *) * get_num_threads());
2626
2627         for (action_list_t::iterator it = action_trace->begin(); it != action_trace->end(); it++) {
2628                 ModelAction *action = *it;
2629                 if (action->is_read()) {
2630                         fprintf(file, "N%u [label=\"%u, T%u\"];\n", action->get_seq_number(), action->get_seq_number(), action->get_tid());
2631                         if (action->get_reads_from() != NULL)
2632                                 fprintf(file, "N%u -> N%u[label=\"rf\", color=red];\n", action->get_seq_number(), action->get_reads_from()->get_seq_number());
2633                 }
2634                 if (thread_array[action->get_tid()] != NULL) {
2635                         fprintf(file, "N%u -> N%u[label=\"sb\", color=blue];\n", thread_array[action->get_tid()]->get_seq_number(), action->get_seq_number());
2636                 }
2637
2638                 thread_array[action->get_tid()] = action;
2639         }
2640         fprintf(file, "}\n");
2641         model_free(thread_array);
2642         fclose(file);
2643 }
2644 #endif
2645
2646 /** @brief Prints an execution trace summary. */
2647 void ModelChecker::print_summary() const
2648 {
2649 #if SUPPORT_MOD_ORDER_DUMP
2650         scheduler->print();
2651         char buffername[100];
2652         sprintf(buffername, "exec%04u", stats.num_total);
2653         mo_graph->dumpGraphToFile(buffername);
2654         sprintf(buffername, "graph%04u", stats.num_total);
2655         dumpGraph(buffername);
2656 #endif
2657
2658         model_print("Execution %d:", stats.num_total);
2659         if (isfeasibleprefix())
2660                 model_print("\n");
2661         else
2662                 print_infeasibility(" INFEASIBLE");
2663         print_list(action_trace);
2664         model_print("\n");
2665 }
2666
2667 /**
2668  * Add a Thread to the system for the first time. Should only be called once
2669  * per thread.
2670  * @param t The Thread to add
2671  */
2672 void ModelChecker::add_thread(Thread *t)
2673 {
2674         thread_map->put(id_to_int(t->get_id()), t);
2675         scheduler->add_thread(t);
2676 }
2677
2678 /**
2679  * Removes a thread from the scheduler.
2680  * @param the thread to remove.
2681  */
2682 void ModelChecker::remove_thread(Thread *t)
2683 {
2684         scheduler->remove_thread(t);
2685 }
2686
2687 /**
2688  * @brief Get a Thread reference by its ID
2689  * @param tid The Thread's ID
2690  * @return A Thread reference
2691  */
2692 Thread * ModelChecker::get_thread(thread_id_t tid) const
2693 {
2694         return thread_map->get(id_to_int(tid));
2695 }
2696
2697 /**
2698  * @brief Get a reference to the Thread in which a ModelAction was executed
2699  * @param act The ModelAction
2700  * @return A Thread reference
2701  */
2702 Thread * ModelChecker::get_thread(const ModelAction *act) const
2703 {
2704         return get_thread(act->get_tid());
2705 }
2706
2707 /**
2708  * @brief Check if a Thread is currently enabled
2709  * @param t The Thread to check
2710  * @return True if the Thread is currently enabled
2711  */
2712 bool ModelChecker::is_enabled(Thread *t) const
2713 {
2714         return scheduler->is_enabled(t);
2715 }
2716
2717 /**
2718  * @brief Check if a Thread is currently enabled
2719  * @param tid The ID of the Thread to check
2720  * @return True if the Thread is currently enabled
2721  */
2722 bool ModelChecker::is_enabled(thread_id_t tid) const
2723 {
2724         return scheduler->is_enabled(tid);
2725 }
2726
2727 /**
2728  * Switch from a user-context to the "master thread" context (a.k.a. system
2729  * context). This switch is made with the intention of exploring a particular
2730  * model-checking action (described by a ModelAction object). Must be called
2731  * from a user-thread context.
2732  *
2733  * @param act The current action that will be explored. May be NULL only if
2734  * trace is exiting via an assertion (see ModelChecker::set_assert and
2735  * ModelChecker::has_asserted).
2736  * @return Return the value returned by the current action
2737  */
2738 uint64_t ModelChecker::switch_to_master(ModelAction *act)
2739 {
2740         DBG();
2741         Thread *old = thread_current();
2742         set_current_action(act);
2743         old->set_state(THREAD_READY);
2744         if (Thread::swap(old, &system_context) < 0) {
2745                 perror("swap threads");
2746                 exit(EXIT_FAILURE);
2747         }
2748         return old->get_return_value();
2749 }
2750
2751 /**
2752  * Takes the next step in the execution, if possible.
2753  * @param curr The current step to take
2754  * @return Returns true (success) if a step was taken and false otherwise.
2755  */
2756 bool ModelChecker::take_step(ModelAction *curr)
2757 {
2758         if (has_asserted())
2759                 return false;
2760
2761         Thread *curr_thrd = get_thread(curr);
2762         ASSERT(curr_thrd->get_state() == THREAD_READY);
2763
2764         curr = check_current_action(curr);
2765
2766         /* Infeasible -> don't take any more steps */
2767         if (is_infeasible())
2768                 return false;
2769         else if (isfeasibleprefix() && have_bug_reports()) {
2770                 set_assert();
2771                 return false;
2772         }
2773
2774         if (params.bound != 0)
2775                 if (priv->used_sequence_numbers > params.bound)
2776                         return false;
2777
2778         if (curr_thrd->is_blocked() || curr_thrd->is_complete())
2779                 scheduler->remove_thread(curr_thrd);
2780
2781         Thread *next_thrd = get_next_thread(curr);
2782         next_thrd = scheduler->next_thread(next_thrd);
2783
2784         DEBUG("(%d, %d)\n", curr_thrd ? id_to_int(curr_thrd->get_id()) : -1,
2785                         next_thrd ? id_to_int(next_thrd->get_id()) : -1);
2786
2787         /*
2788          * Launch end-of-execution release sequence fixups only when there are:
2789          *
2790          * (1) no more user threads to run (or when execution replay chooses
2791          *     the 'model_thread')
2792          * (2) pending release sequences
2793          * (3) pending assertions (i.e., data races)
2794          * (4) no pending promises
2795          */
2796         if (!pending_rel_seqs->empty() && (!next_thrd || next_thrd->is_model_thread()) &&
2797                         is_feasible_prefix_ignore_relseq() && !unrealizedraces.empty()) {
2798                 model_print("*** WARNING: release sequence fixup action (%zu pending release seuqences) ***\n",
2799                                 pending_rel_seqs->size());
2800                 ModelAction *fixup = new ModelAction(MODEL_FIXUP_RELSEQ,
2801                                 std::memory_order_seq_cst, NULL, VALUE_NONE,
2802                                 model_thread);
2803                 set_current_action(fixup);
2804                 return true;
2805         }
2806
2807         /* next_thrd == NULL -> don't take any more steps */
2808         if (!next_thrd)
2809                 return false;
2810
2811         next_thrd->set_state(THREAD_RUNNING);
2812
2813         if (next_thrd->get_pending() != NULL) {
2814                 /* restart a pending action */
2815                 set_current_action(next_thrd->get_pending());
2816                 next_thrd->set_pending(NULL);
2817                 next_thrd->set_state(THREAD_READY);
2818                 return true;
2819         }
2820
2821         /* Return false only if swap fails with an error */
2822         return (Thread::swap(&system_context, next_thrd) == 0);
2823 }
2824
2825 /** Wrapper to run the user's main function, with appropriate arguments */
2826 void user_main_wrapper(void *)
2827 {
2828         user_main(model->params.argc, model->params.argv);
2829 }
2830
2831 /** @brief Run ModelChecker for the user program */
2832 void ModelChecker::run()
2833 {
2834         do {
2835                 thrd_t user_thread;
2836                 Thread *t = new Thread(&user_thread, &user_main_wrapper, NULL);
2837
2838                 add_thread(t);
2839
2840                 /* Run user thread up to its first action */
2841                 scheduler->next_thread(t);
2842                 Thread::swap(&system_context, t);
2843
2844                 /* Wait for all threads to complete */
2845                 while (take_step(priv->current_action));
2846         } while (next_execution());
2847
2848         print_stats();
2849 }