12 #include "clockvector.h"
13 #include "cyclegraph.h"
15 #include "threads-model.h"
16 #include "bugmessage.h"
19 #define INITIAL_THREAD_ID 0
22 * Structure for holding small ModelChecker members that should be snapshotted
24 struct model_snapshot_members {
25 model_snapshot_members() :
26 /* First thread created will have id INITIAL_THREAD_ID */
27 next_thread_id(INITIAL_THREAD_ID),
28 used_sequence_numbers(0),
30 bad_synchronization(false),
34 ~model_snapshot_members() {
35 for (unsigned int i = 0;i < bugs.size();i++)
40 unsigned int next_thread_id;
41 modelclock_t used_sequence_numbers;
42 SnapVector<bug_message *> bugs;
43 /** @brief Incorrectly-ordered synchronization was made */
44 bool bad_synchronization;
50 /** @brief Constructor */
51 ModelExecution::ModelExecution(ModelChecker *m, Scheduler *scheduler, NodeStack *node_stack) :
56 thread_map(2), /* We'll always need at least 2 threads */
60 condvar_waiters_map(),
64 thrd_last_fence_release(),
65 node_stack(node_stack),
66 priv(new struct model_snapshot_members ()),
67 mo_graph(new CycleGraph()),
70 /* Initialize a model-checker thread, for special ModelActions */
71 model_thread = new Thread(get_next_id());
72 add_thread(model_thread);
73 scheduler->register_engine(this);
74 node_stack->register_engine(this);
77 /** @brief Destructor */
78 ModelExecution::~ModelExecution()
80 for (unsigned int i = 0;i < get_num_threads();i++)
81 delete get_thread(int_to_id(i));
87 int ModelExecution::get_execution_number() const
89 return model->get_execution_number();
92 static action_list_t * get_safe_ptr_action(HashTable<const void *, action_list_t *, uintptr_t, 4> * hash, void * ptr)
94 action_list_t *tmp = hash->get(ptr);
96 tmp = new action_list_t();
102 static SnapVector<action_list_t> * get_safe_ptr_vect_action(HashTable<void *, SnapVector<action_list_t> *, uintptr_t, 4> * hash, void * ptr)
104 SnapVector<action_list_t> *tmp = hash->get(ptr);
106 tmp = new SnapVector<action_list_t>();
112 /** @return a thread ID for a new Thread */
113 thread_id_t ModelExecution::get_next_id()
115 return priv->next_thread_id++;
118 /** @return the number of user threads created during this execution */
119 unsigned int ModelExecution::get_num_threads() const
121 return priv->next_thread_id;
124 /** @return a sequence number for a new ModelAction */
125 modelclock_t ModelExecution::get_next_seq_num()
127 return ++priv->used_sequence_numbers;
131 * @brief Should the current action wake up a given thread?
133 * @param curr The current action
134 * @param thread The thread that we might wake up
135 * @return True, if we should wake up the sleeping thread; false otherwise
137 bool ModelExecution::should_wake_up(const ModelAction *curr, const Thread *thread) const
139 const ModelAction *asleep = thread->get_pending();
140 /* Don't allow partial RMW to wake anyone up */
143 /* Synchronizing actions may have been backtracked */
144 if (asleep->could_synchronize_with(curr))
146 /* All acquire/release fences and fence-acquire/store-release */
147 if (asleep->is_fence() && asleep->is_acquire() && curr->is_release())
149 /* Fence-release + store can awake load-acquire on the same location */
150 if (asleep->is_read() && asleep->is_acquire() && curr->same_var(asleep) && curr->is_write()) {
151 ModelAction *fence_release = get_last_fence_release(curr->get_tid());
152 if (fence_release && *(get_last_action(thread->get_id())) < *fence_release)
158 void ModelExecution::wake_up_sleeping_actions(ModelAction *curr)
160 for (unsigned int i = 0;i < get_num_threads();i++) {
161 Thread *thr = get_thread(int_to_id(i));
162 if (scheduler->is_sleep_set(thr)) {
163 if (should_wake_up(curr, thr))
164 /* Remove this thread from sleep set */
165 scheduler->remove_sleep(thr);
170 /** @brief Alert the model-checker that an incorrectly-ordered
171 * synchronization was made */
172 void ModelExecution::set_bad_synchronization()
174 priv->bad_synchronization = true;
177 bool ModelExecution::assert_bug(const char *msg)
179 priv->bugs.push_back(new bug_message(msg));
181 if (isfeasibleprefix()) {
188 /** @return True, if any bugs have been reported for this execution */
189 bool ModelExecution::have_bug_reports() const
191 return priv->bugs.size() != 0;
194 SnapVector<bug_message *> * ModelExecution::get_bugs() const
200 * Check whether the current trace has triggered an assertion which should halt
203 * @return True, if the execution should be aborted; false otherwise
205 bool ModelExecution::has_asserted() const
207 return priv->asserted;
211 * Trigger a trace assertion which should cause this execution to be halted.
212 * This can be due to a detected bug or due to an infeasibility that should
215 void ModelExecution::set_assert()
217 priv->asserted = true;
221 * Check if we are in a deadlock. Should only be called at the end of an
222 * execution, although it should not give false positives in the middle of an
223 * execution (there should be some ENABLED thread).
225 * @return True if program is in a deadlock; false otherwise
227 bool ModelExecution::is_deadlocked() const
229 bool blocking_threads = false;
230 for (unsigned int i = 0;i < get_num_threads();i++) {
231 thread_id_t tid = int_to_id(i);
234 Thread *t = get_thread(tid);
235 if (!t->is_model_thread() && t->get_pending())
236 blocking_threads = true;
238 return blocking_threads;
242 * Check if this is a complete execution. That is, have all thread completed
243 * execution (rather than exiting because sleep sets have forced a redundant
246 * @return True if the execution is complete.
248 bool ModelExecution::is_complete_execution() const
250 for (unsigned int i = 0;i < get_num_threads();i++)
251 if (is_enabled(int_to_id(i)))
258 * Processes a read model action.
259 * @param curr is the read model action to process.
260 * @param rf_set is the set of model actions we can possibly read from
261 * @return True if processing this read updates the mo_graph.
263 void ModelExecution::process_read(ModelAction *curr, SnapVector<ModelAction *> * rf_set)
265 SnapVector<const ModelAction *> * priorset = new SnapVector<const ModelAction *>();
268 int index = fuzzer->selectWrite(curr, rf_set);
269 ModelAction *rf = (*rf_set)[index];
273 bool canprune = false;
274 if (r_modification_order(curr, rf, priorset, &canprune)) {
275 for(unsigned int i=0;i<priorset->size();i++) {
276 mo_graph->addEdge((*priorset)[i], rf);
279 get_thread(curr)->set_return_value(curr->get_return_value());
281 if (canprune && curr->get_type() == ATOMIC_READ) {
282 int tid = id_to_int(curr->get_tid());
283 (*obj_thrd_map.get(curr->get_location()))[tid].pop_back();
288 (*rf_set)[index] = rf_set->back();
294 * Processes a lock, trylock, or unlock model action. @param curr is
295 * the read model action to process.
297 * The try lock operation checks whether the lock is taken. If not,
298 * it falls to the normal lock operation case. If so, it returns
301 * The lock operation has already been checked that it is enabled, so
302 * it just grabs the lock and synchronizes with the previous unlock.
304 * The unlock operation has to re-enable all of the threads that are
305 * waiting on the lock.
307 * @return True if synchronization was updated; false otherwise
309 bool ModelExecution::process_mutex(ModelAction *curr)
311 cdsc::mutex *mutex = curr->get_mutex();
312 struct cdsc::mutex_state *state = NULL;
315 state = mutex->get_state();
317 switch (curr->get_type()) {
318 case ATOMIC_TRYLOCK: {
319 bool success = !state->locked;
320 curr->set_try_lock(success);
322 get_thread(curr)->set_return_value(0);
325 get_thread(curr)->set_return_value(1);
327 //otherwise fall into the lock case
329 if (curr->get_cv()->getClock(state->alloc_tid) <= state->alloc_clock)
330 assert_bug("Lock access before initialization");
331 state->locked = get_thread(curr);
332 ModelAction *unlock = get_last_unlock(curr);
333 //synchronize with the previous unlock statement
334 if (unlock != NULL) {
335 synchronize(unlock, curr);
341 case ATOMIC_UNLOCK: {
342 //TODO: FIX WAIT SITUATION...WAITS CAN SPURIOUSLY FAIL...TIMED WAITS SHOULD PROBABLY JUST BE THE SAME AS NORMAL WAITS...THINK ABOUT PROBABILITIES THOUGH....AS IN TIMED WAIT MUST FAIL TO GUARANTEE PROGRESS...NORMAL WAIT MAY FAIL...SO NEED NORMAL WAIT TO WORK CORRECTLY IN THE CASE IT SPURIOUSLY FAILS AND IN THE CASE IT DOESN'T... TIMED WAITS MUST EVENMTUALLY RELEASE...
344 /* wake up the other threads */
345 for (unsigned int i = 0;i < get_num_threads();i++) {
346 Thread *t = get_thread(int_to_id(i));
347 Thread *curr_thrd = get_thread(curr);
348 if (t->waiting_on() == curr_thrd && t->get_pending()->is_lock())
352 /* unlock the lock - after checking who was waiting on it */
353 state->locked = NULL;
355 if (!curr->is_wait())
356 break;/* The rest is only for ATOMIC_WAIT */
360 case ATOMIC_NOTIFY_ALL: {
361 action_list_t *waiters = get_safe_ptr_action(&condvar_waiters_map, curr->get_location());
362 //activate all the waiting threads
363 for (action_list_t::iterator rit = waiters->begin();rit != waiters->end();rit++) {
364 scheduler->wake(get_thread(*rit));
369 case ATOMIC_NOTIFY_ONE: {
370 action_list_t *waiters = get_safe_ptr_action(&condvar_waiters_map, curr->get_location());
371 if (waiters->size() != 0) {
372 Thread * thread = fuzzer->selectNotify(waiters);
373 scheduler->wake(thread);
385 * Process a write ModelAction
386 * @param curr The ModelAction to process
387 * @return True if the mo_graph was updated or promises were resolved
389 void ModelExecution::process_write(ModelAction *curr)
392 w_modification_order(curr);
395 get_thread(curr)->set_return_value(VALUE_NONE);
399 * Process a fence ModelAction
400 * @param curr The ModelAction to process
401 * @return True if synchronization was updated
403 bool ModelExecution::process_fence(ModelAction *curr)
406 * fence-relaxed: no-op
407 * fence-release: only log the occurence (not in this function), for
408 * use in later synchronization
409 * fence-acquire (this function): search for hypothetical release
411 * fence-seq-cst: MO constraints formed in {r,w}_modification_order
413 bool updated = false;
414 if (curr->is_acquire()) {
415 action_list_t *list = &action_trace;
416 action_list_t::reverse_iterator rit;
417 /* Find X : is_read(X) && X --sb-> curr */
418 for (rit = list->rbegin();rit != list->rend();rit++) {
419 ModelAction *act = *rit;
422 if (act->get_tid() != curr->get_tid())
424 /* Stop at the beginning of the thread */
425 if (act->is_thread_start())
427 /* Stop once we reach a prior fence-acquire */
428 if (act->is_fence() && act->is_acquire())
432 /* read-acquire will find its own release sequences */
433 if (act->is_acquire())
436 /* Establish hypothetical release sequences */
437 ClockVector *cv = get_hb_from_write(act);
438 if (curr->get_cv()->merge(cv))
446 * @brief Process the current action for thread-related activity
448 * Performs current-action processing for a THREAD_* ModelAction. Proccesses
449 * may include setting Thread status, completing THREAD_FINISH/THREAD_JOIN
450 * synchronization, etc. This function is a no-op for non-THREAD actions
451 * (e.g., ATOMIC_{READ,WRITE,RMW,LOCK}, etc.)
453 * @param curr The current action
454 * @return True if synchronization was updated or a thread completed
456 bool ModelExecution::process_thread_action(ModelAction *curr)
458 bool updated = false;
460 switch (curr->get_type()) {
461 case THREAD_CREATE: {
462 thrd_t *thrd = (thrd_t *)curr->get_location();
463 struct thread_params *params = (struct thread_params *)curr->get_value();
464 Thread *th = new Thread(get_next_id(), thrd, params->func, params->arg, get_thread(curr));
465 curr->set_thread_operand(th);
467 th->set_creation(curr);
470 case PTHREAD_CREATE: {
471 (*(uint32_t *)curr->get_location()) = pthread_counter++;
473 struct pthread_params *params = (struct pthread_params *)curr->get_value();
474 Thread *th = new Thread(get_next_id(), NULL, params->func, params->arg, get_thread(curr));
475 curr->set_thread_operand(th);
477 th->set_creation(curr);
479 if ( pthread_map.size() < pthread_counter )
480 pthread_map.resize( pthread_counter );
481 pthread_map[ pthread_counter-1 ] = th;
486 Thread *blocking = curr->get_thread_operand();
487 ModelAction *act = get_last_action(blocking->get_id());
488 synchronize(act, curr);
489 updated = true; /* trigger rel-seq checks */
493 Thread *blocking = curr->get_thread_operand();
494 ModelAction *act = get_last_action(blocking->get_id());
495 synchronize(act, curr);
496 updated = true; /* trigger rel-seq checks */
497 break; // WL: to be add (modified)
500 case THREAD_FINISH: {
501 Thread *th = get_thread(curr);
502 /* Wake up any joining threads */
503 for (unsigned int i = 0;i < get_num_threads();i++) {
504 Thread *waiting = get_thread(int_to_id(i));
505 if (waiting->waiting_on() == th &&
506 waiting->get_pending()->is_thread_join())
507 scheduler->wake(waiting);
510 updated = true; /* trigger rel-seq checks */
524 * Initialize the current action by performing one or more of the following
525 * actions, as appropriate: merging RMWR and RMWC/RMW actions, stepping forward
526 * in the NodeStack, manipulating backtracking sets, allocating and
527 * initializing clock vectors, and computing the promises to fulfill.
529 * @param curr The current action, as passed from the user context; may be
530 * freed/invalidated after the execution of this function, with a different
531 * action "returned" its place (pass-by-reference)
532 * @return True if curr is a newly-explored action; false otherwise
534 bool ModelExecution::initialize_curr_action(ModelAction **curr)
536 if ((*curr)->is_rmwc() || (*curr)->is_rmw()) {
537 ModelAction *newcurr = process_rmw(*curr);
543 ModelAction *newcurr = *curr;
545 newcurr->set_seq_number(get_next_seq_num());
546 node_stack->add_action(newcurr);
547 /* Always compute new clock vector */
548 newcurr->create_cv(get_parent_action(newcurr->get_tid()));
550 /* Assign most recent release fence */
551 newcurr->set_last_fence_release(get_last_fence_release(newcurr->get_tid()));
553 return true; /* This was a new ModelAction */
558 * @brief Establish reads-from relation between two actions
560 * Perform basic operations involved with establishing a concrete rf relation,
561 * including setting the ModelAction data and checking for release sequences.
563 * @param act The action that is reading (must be a read)
564 * @param rf The action from which we are reading (must be a write)
566 * @return True if this read established synchronization
569 void ModelExecution::read_from(ModelAction *act, ModelAction *rf)
572 ASSERT(rf->is_write());
574 act->set_read_from(rf);
575 if (act->is_acquire()) {
576 ClockVector *cv = get_hb_from_write(rf);
579 act->get_cv()->merge(cv);
584 * @brief Synchronizes two actions
586 * When A synchronizes with B (or A --sw-> B), B inherits A's clock vector.
587 * This function performs the synchronization as well as providing other hooks
588 * for other checks along with synchronization.
590 * @param first The left-hand side of the synchronizes-with relation
591 * @param second The right-hand side of the synchronizes-with relation
592 * @return True if the synchronization was successful (i.e., was consistent
593 * with the execution order); false otherwise
595 bool ModelExecution::synchronize(const ModelAction *first, ModelAction *second)
597 if (*second < *first) {
598 set_bad_synchronization();
601 return second->synchronize_with(first);
605 * @brief Check whether a model action is enabled.
607 * Checks whether an operation would be successful (i.e., is a lock already
608 * locked, or is the joined thread already complete).
610 * For yield-blocking, yields are never enabled.
612 * @param curr is the ModelAction to check whether it is enabled.
613 * @return a bool that indicates whether the action is enabled.
615 bool ModelExecution::check_action_enabled(ModelAction *curr) {
616 if (curr->is_lock()) {
617 cdsc::mutex *lock = curr->get_mutex();
618 struct cdsc::mutex_state *state = lock->get_state();
621 } else if (curr->is_thread_join()) {
622 Thread *blocking = curr->get_thread_operand();
623 if (!blocking->is_complete()) {
632 * This is the heart of the model checker routine. It performs model-checking
633 * actions corresponding to a given "current action." Among other processes, it
634 * calculates reads-from relationships, updates synchronization clock vectors,
635 * forms a memory_order constraints graph, and handles replay/backtrack
636 * execution when running permutations of previously-observed executions.
638 * @param curr The current action to process
639 * @return The ModelAction that is actually executed; may be different than
642 ModelAction * ModelExecution::check_current_action(ModelAction *curr)
645 bool second_part_of_rmw = curr->is_rmwc() || curr->is_rmw();
646 bool newly_explored = initialize_curr_action(&curr);
650 wake_up_sleeping_actions(curr);
652 /* Add the action to lists before any other model-checking tasks */
653 if (!second_part_of_rmw && curr->get_type() != NOOP)
654 add_action_to_lists(curr);
656 SnapVector<ModelAction *> * rf_set = NULL;
657 /* Build may_read_from set for newly-created actions */
658 if (newly_explored && curr->is_read())
659 rf_set = build_may_read_from(curr);
661 process_thread_action(curr);
663 if (curr->is_read() && !second_part_of_rmw) {
664 process_read(curr, rf_set);
667 ASSERT(rf_set == NULL);
670 if (curr->is_write())
673 if (curr->is_fence())
676 if (curr->is_mutex_op())
683 * This is the strongest feasibility check available.
684 * @return whether the current trace (partial or complete) must be a prefix of
687 bool ModelExecution::isfeasibleprefix() const
689 return !is_infeasible();
693 * Print disagnostic information about an infeasible execution
694 * @param prefix A string to prefix the output with; if NULL, then a default
695 * message prefix will be provided
697 void ModelExecution::print_infeasibility(const char *prefix) const
701 if (priv->bad_synchronization)
702 ptr += sprintf(ptr, "[bad sw ordering]");
704 model_print("%s: %s", prefix ? prefix : "Infeasible", buf);
708 * Check if the current partial trace is infeasible. Does not check any
709 * end-of-execution flags, which might rule out the execution. Thus, this is
710 * useful only for ruling an execution as infeasible.
711 * @return whether the current partial trace is infeasible.
713 bool ModelExecution::is_infeasible() const
715 return priv->bad_synchronization;
718 /** Close out a RMWR by converting previous RMWR into a RMW or READ. */
719 ModelAction * ModelExecution::process_rmw(ModelAction *act) {
720 ModelAction *lastread = get_last_action(act->get_tid());
721 lastread->process_rmw(act);
723 mo_graph->addRMWEdge(lastread->get_reads_from(), lastread);
729 * @brief Updates the mo_graph with the constraints imposed from the current
732 * Basic idea is the following: Go through each other thread and find
733 * the last action that happened before our read. Two cases:
735 * -# The action is a write: that write must either occur before
736 * the write we read from or be the write we read from.
737 * -# The action is a read: the write that that action read from
738 * must occur before the write we read from or be the same write.
740 * @param curr The current action. Must be a read.
741 * @param rf The ModelAction or Promise that curr reads from. Must be a write.
742 * @return True if modification order edges were added; false otherwise
745 bool ModelExecution::r_modification_order(ModelAction *curr, const ModelAction *rf, SnapVector<const ModelAction *> * priorset, bool * canprune)
747 SnapVector<action_list_t> *thrd_lists = obj_thrd_map.get(curr->get_location());
749 ASSERT(curr->is_read());
751 /* Last SC fence in the current thread */
752 ModelAction *last_sc_fence_local = get_last_seq_cst_fence(curr->get_tid(), NULL);
754 int tid = curr->get_tid();
755 ModelAction *prev_same_thread = NULL;
756 /* Iterate over all threads */
757 for (i = 0;i < thrd_lists->size();i++, tid = (((unsigned int)(tid+1)) == thrd_lists->size()) ? 0 : tid + 1) {
758 /* Last SC fence in thread tid */
759 ModelAction *last_sc_fence_thread_local = NULL;
761 last_sc_fence_thread_local = get_last_seq_cst_fence(int_to_id(tid), NULL);
763 /* Last SC fence in thread tid, before last SC fence in current thread */
764 ModelAction *last_sc_fence_thread_before = NULL;
765 if (last_sc_fence_local)
766 last_sc_fence_thread_before = get_last_seq_cst_fence(int_to_id(tid), last_sc_fence_local);
768 //Only need to iterate if either hb has changed for thread in question or SC fence after last operation...
769 if (prev_same_thread != NULL &&
770 (prev_same_thread->get_cv()->getClock(tid) == curr->get_cv()->getClock(tid)) &&
771 (last_sc_fence_thread_local == NULL || *last_sc_fence_thread_local < *prev_same_thread)) {
775 /* Iterate over actions in thread, starting from most recent */
776 action_list_t *list = &(*thrd_lists)[tid];
777 action_list_t::reverse_iterator rit;
778 for (rit = list->rbegin();rit != list->rend();rit++) {
779 ModelAction *act = *rit;
784 /* Don't want to add reflexive edges on 'rf' */
785 if (act->equals(rf)) {
786 if (act->happens_before(curr))
792 if (act->is_write()) {
793 /* C++, Section 29.3 statement 5 */
794 if (curr->is_seqcst() && last_sc_fence_thread_local &&
795 *act < *last_sc_fence_thread_local) {
796 if (mo_graph->checkReachable(rf, act))
798 priorset->push_back(act);
801 /* C++, Section 29.3 statement 4 */
802 else if (act->is_seqcst() && last_sc_fence_local &&
803 *act < *last_sc_fence_local) {
804 if (mo_graph->checkReachable(rf, act))
806 priorset->push_back(act);
809 /* C++, Section 29.3 statement 6 */
810 else if (last_sc_fence_thread_before &&
811 *act < *last_sc_fence_thread_before) {
812 if (mo_graph->checkReachable(rf, act))
814 priorset->push_back(act);
820 * Include at most one act per-thread that "happens
823 if (act->happens_before(curr)) {
825 if (last_sc_fence_local == NULL ||
826 (*last_sc_fence_local < *prev_same_thread)) {
827 prev_same_thread = act;
830 if (act->is_write()) {
831 if (mo_graph->checkReachable(rf, act))
833 priorset->push_back(act);
835 const ModelAction *prevrf = act->get_reads_from();
836 if (!prevrf->equals(rf)) {
837 if (mo_graph->checkReachable(rf, prevrf))
839 priorset->push_back(prevrf);
841 if (act->get_tid() == curr->get_tid()) {
842 //Can prune curr from obj list
855 * Updates the mo_graph with the constraints imposed from the current write.
857 * Basic idea is the following: Go through each other thread and find
858 * the lastest action that happened before our write. Two cases:
860 * (1) The action is a write => that write must occur before
863 * (2) The action is a read => the write that that action read from
864 * must occur before the current write.
866 * This method also handles two other issues:
868 * (I) Sequential Consistency: Making sure that if the current write is
869 * seq_cst, that it occurs after the previous seq_cst write.
871 * (II) Sending the write back to non-synchronizing reads.
873 * @param curr The current action. Must be a write.
874 * @param send_fv A vector for stashing reads to which we may pass our future
875 * value. If NULL, then don't record any future values.
876 * @return True if modification order edges were added; false otherwise
878 void ModelExecution::w_modification_order(ModelAction *curr)
880 SnapVector<action_list_t> *thrd_lists = obj_thrd_map.get(curr->get_location());
882 ASSERT(curr->is_write());
884 if (curr->is_seqcst()) {
885 /* We have to at least see the last sequentially consistent write,
886 so we are initialized. */
887 ModelAction *last_seq_cst = get_last_seq_cst_write(curr);
888 if (last_seq_cst != NULL) {
889 mo_graph->addEdge(last_seq_cst, curr);
893 /* Last SC fence in the current thread */
894 ModelAction *last_sc_fence_local = get_last_seq_cst_fence(curr->get_tid(), NULL);
896 /* Iterate over all threads */
897 for (i = 0;i < thrd_lists->size();i++) {
898 /* Last SC fence in thread i, before last SC fence in current thread */
899 ModelAction *last_sc_fence_thread_before = NULL;
900 if (last_sc_fence_local && int_to_id((int)i) != curr->get_tid())
901 last_sc_fence_thread_before = get_last_seq_cst_fence(int_to_id(i), last_sc_fence_local);
903 /* Iterate over actions in thread, starting from most recent */
904 action_list_t *list = &(*thrd_lists)[i];
905 action_list_t::reverse_iterator rit;
906 bool force_edge = false;
907 for (rit = list->rbegin();rit != list->rend();rit++) {
908 ModelAction *act = *rit;
911 * 1) If RMW and it actually read from something, then we
912 * already have all relevant edges, so just skip to next
915 * 2) If RMW and it didn't read from anything, we should
916 * whatever edge we can get to speed up convergence.
918 * 3) If normal write, we need to look at earlier actions, so
919 * continue processing list.
922 if (curr->is_rmw()) {
923 if (curr->get_reads_from() != NULL)
931 /* C++, Section 29.3 statement 7 */
932 if (last_sc_fence_thread_before && act->is_write() &&
933 *act < *last_sc_fence_thread_before) {
934 mo_graph->addEdge(act, curr, force_edge);
939 * Include at most one act per-thread that "happens
942 if (act->happens_before(curr)) {
944 * Note: if act is RMW, just add edge:
946 * The following edge should be handled elsewhere:
947 * readfrom(act) --mo--> act
950 mo_graph->addEdge(act, curr, force_edge);
951 else if (act->is_read()) {
952 //if previous read accessed a null, just keep going
953 mo_graph->addEdge(act->get_reads_from(), curr, force_edge);
956 } else if (act->is_read() && !act->could_synchronize_with(curr) &&
957 !act->same_thread(curr)) {
958 /* We have an action that:
959 (1) did not happen before us
960 (2) is a read and we are a write
961 (3) cannot synchronize with us
962 (4) is in a different thread
964 that read could potentially read from our write. Note that
965 these checks are overly conservative at this point, we'll
966 do more checks before actually removing the
977 * Arbitrary reads from the future are not allowed. Section 29.3 part 9 places
978 * some constraints. This method checks one the following constraint (others
979 * require compiler support):
981 * If X --hb-> Y --mo-> Z, then X should not read from Z.
982 * If X --hb-> Y, A --rf-> Y, and A --mo-> Z, then X should not read from Z.
984 bool ModelExecution::mo_may_allow(const ModelAction *writer, const ModelAction *reader)
986 SnapVector<action_list_t> *thrd_lists = obj_thrd_map.get(reader->get_location());
988 /* Iterate over all threads */
989 for (i = 0;i < thrd_lists->size();i++) {
990 const ModelAction *write_after_read = NULL;
992 /* Iterate over actions in thread, starting from most recent */
993 action_list_t *list = &(*thrd_lists)[i];
994 action_list_t::reverse_iterator rit;
995 for (rit = list->rbegin();rit != list->rend();rit++) {
996 ModelAction *act = *rit;
998 /* Don't disallow due to act == reader */
999 if (!reader->happens_before(act) || reader == act)
1001 else if (act->is_write())
1002 write_after_read = act;
1003 else if (act->is_read() && act->get_reads_from() != NULL)
1004 write_after_read = act->get_reads_from();
1007 if (write_after_read && write_after_read != writer && mo_graph->checkReachable(write_after_read, writer))
1014 * Computes the clock vector that happens before propagates from this write.
1016 * @param rf The action that might be part of a release sequence. Must be a
1018 * @return ClockVector of happens before relation.
1021 ClockVector * ModelExecution::get_hb_from_write(ModelAction *rf) const {
1022 SnapVector<ModelAction *> * processset = NULL;
1023 for ( ;rf != NULL;rf = rf->get_reads_from()) {
1024 ASSERT(rf->is_write());
1025 if (!rf->is_rmw() || (rf->is_acquire() && rf->is_release()) || rf->get_rfcv() != NULL)
1027 if (processset == NULL)
1028 processset = new SnapVector<ModelAction *>();
1029 processset->push_back(rf);
1032 int i = (processset == NULL) ? 0 : processset->size();
1034 ClockVector * vec = NULL;
1036 if (rf->get_rfcv() != NULL) {
1037 vec = rf->get_rfcv();
1038 } else if (rf->is_acquire() && rf->is_release()) {
1040 } else if (rf->is_release() && !rf->is_rmw()) {
1042 } else if (rf->is_release()) {
1043 //have rmw that is release and doesn't have a rfcv
1044 (vec = new ClockVector(vec, NULL))->merge(rf->get_cv());
1047 //operation that isn't release
1048 if (rf->get_last_fence_release()) {
1050 vec = rf->get_last_fence_release()->get_cv();
1052 (vec=new ClockVector(vec, NULL))->merge(rf->get_last_fence_release()->get_cv());
1058 rf = (*processset)[i];
1062 if (processset != NULL)
1068 * Performs various bookkeeping operations for the current ModelAction. For
1069 * instance, adds action to the per-object, per-thread action vector and to the
1070 * action trace list of all thread actions.
1072 * @param act is the ModelAction to add.
1074 void ModelExecution::add_action_to_lists(ModelAction *act)
1076 int tid = id_to_int(act->get_tid());
1077 ModelAction *uninit = NULL;
1079 action_list_t *list = get_safe_ptr_action(&obj_map, act->get_location());
1080 if (list->empty() && act->is_atomic_var()) {
1081 uninit = get_uninitialized_action(act);
1082 uninit_id = id_to_int(uninit->get_tid());
1083 list->push_front(uninit);
1085 list->push_back(act);
1087 action_trace.push_back(act);
1089 action_trace.push_front(uninit);
1091 SnapVector<action_list_t> *vec = get_safe_ptr_vect_action(&obj_thrd_map, act->get_location());
1092 if (tid >= (int)vec->size())
1093 vec->resize(priv->next_thread_id);
1094 (*vec)[tid].push_back(act);
1096 (*vec)[uninit_id].push_front(uninit);
1098 if ((int)thrd_last_action.size() <= tid)
1099 thrd_last_action.resize(get_num_threads());
1100 thrd_last_action[tid] = act;
1102 thrd_last_action[uninit_id] = uninit;
1104 if (act->is_fence() && act->is_release()) {
1105 if ((int)thrd_last_fence_release.size() <= tid)
1106 thrd_last_fence_release.resize(get_num_threads());
1107 thrd_last_fence_release[tid] = act;
1110 if (act->is_wait()) {
1111 void *mutex_loc = (void *) act->get_value();
1112 get_safe_ptr_action(&obj_map, mutex_loc)->push_back(act);
1114 SnapVector<action_list_t> *vec = get_safe_ptr_vect_action(&obj_thrd_map, mutex_loc);
1115 if (tid >= (int)vec->size())
1116 vec->resize(priv->next_thread_id);
1117 (*vec)[tid].push_back(act);
1122 * @brief Get the last action performed by a particular Thread
1123 * @param tid The thread ID of the Thread in question
1124 * @return The last action in the thread
1126 ModelAction * ModelExecution::get_last_action(thread_id_t tid) const
1128 int threadid = id_to_int(tid);
1129 if (threadid < (int)thrd_last_action.size())
1130 return thrd_last_action[id_to_int(tid)];
1136 * @brief Get the last fence release performed by a particular Thread
1137 * @param tid The thread ID of the Thread in question
1138 * @return The last fence release in the thread, if one exists; NULL otherwise
1140 ModelAction * ModelExecution::get_last_fence_release(thread_id_t tid) const
1142 int threadid = id_to_int(tid);
1143 if (threadid < (int)thrd_last_fence_release.size())
1144 return thrd_last_fence_release[id_to_int(tid)];
1150 * Gets the last memory_order_seq_cst write (in the total global sequence)
1151 * performed on a particular object (i.e., memory location), not including the
1153 * @param curr The current ModelAction; also denotes the object location to
1155 * @return The last seq_cst write
1157 ModelAction * ModelExecution::get_last_seq_cst_write(ModelAction *curr) const
1159 void *location = curr->get_location();
1160 action_list_t *list = obj_map.get(location);
1161 /* Find: max({i in dom(S) | seq_cst(t_i) && isWrite(t_i) && samevar(t_i, t)}) */
1162 action_list_t::reverse_iterator rit;
1163 for (rit = list->rbegin();(*rit) != curr;rit++)
1165 rit++; /* Skip past curr */
1166 for ( ;rit != list->rend();rit++)
1167 if ((*rit)->is_write() && (*rit)->is_seqcst())
1173 * Gets the last memory_order_seq_cst fence (in the total global sequence)
1174 * performed in a particular thread, prior to a particular fence.
1175 * @param tid The ID of the thread to check
1176 * @param before_fence The fence from which to begin the search; if NULL, then
1177 * search for the most recent fence in the thread.
1178 * @return The last prior seq_cst fence in the thread, if exists; otherwise, NULL
1180 ModelAction * ModelExecution::get_last_seq_cst_fence(thread_id_t tid, const ModelAction *before_fence) const
1182 /* All fences should have location FENCE_LOCATION */
1183 action_list_t *list = obj_map.get(FENCE_LOCATION);
1188 action_list_t::reverse_iterator rit = list->rbegin();
1191 for (;rit != list->rend();rit++)
1192 if (*rit == before_fence)
1195 ASSERT(*rit == before_fence);
1199 for (;rit != list->rend();rit++)
1200 if ((*rit)->is_fence() && (tid == (*rit)->get_tid()) && (*rit)->is_seqcst())
1206 * Gets the last unlock operation performed on a particular mutex (i.e., memory
1207 * location). This function identifies the mutex according to the current
1208 * action, which is presumed to perform on the same mutex.
1209 * @param curr The current ModelAction; also denotes the object location to
1211 * @return The last unlock operation
1213 ModelAction * ModelExecution::get_last_unlock(ModelAction *curr) const
1215 void *location = curr->get_location();
1217 action_list_t *list = obj_map.get(location);
1218 /* Find: max({i in dom(S) | isUnlock(t_i) && samevar(t_i, t)}) */
1219 action_list_t::reverse_iterator rit;
1220 for (rit = list->rbegin();rit != list->rend();rit++)
1221 if ((*rit)->is_unlock() || (*rit)->is_wait())
1226 ModelAction * ModelExecution::get_parent_action(thread_id_t tid) const
1228 ModelAction *parent = get_last_action(tid);
1230 parent = get_thread(tid)->get_creation();
1235 * Returns the clock vector for a given thread.
1236 * @param tid The thread whose clock vector we want
1237 * @return Desired clock vector
1239 ClockVector * ModelExecution::get_cv(thread_id_t tid) const
1241 ModelAction *firstaction=get_parent_action(tid);
1242 return firstaction != NULL ? firstaction->get_cv() : NULL;
1245 bool valequals(uint64_t val1, uint64_t val2, int size) {
1248 return ((uint8_t)val1) == ((uint8_t)val2);
1250 return ((uint16_t)val1) == ((uint16_t)val2);
1252 return ((uint32_t)val1) == ((uint32_t)val2);
1262 * Build up an initial set of all past writes that this 'read' action may read
1263 * from, as well as any previously-observed future values that must still be valid.
1265 * @param curr is the current ModelAction that we are exploring; it must be a
1268 SnapVector<ModelAction *> * ModelExecution::build_may_read_from(ModelAction *curr)
1270 SnapVector<action_list_t> *thrd_lists = obj_thrd_map.get(curr->get_location());
1272 ASSERT(curr->is_read());
1274 ModelAction *last_sc_write = NULL;
1276 if (curr->is_seqcst())
1277 last_sc_write = get_last_seq_cst_write(curr);
1279 SnapVector<ModelAction *> * rf_set = new SnapVector<ModelAction *>();
1281 /* Iterate over all threads */
1282 for (i = 0;i < thrd_lists->size();i++) {
1283 /* Iterate over actions in thread, starting from most recent */
1284 action_list_t *list = &(*thrd_lists)[i];
1285 action_list_t::reverse_iterator rit;
1286 for (rit = list->rbegin();rit != list->rend();rit++) {
1287 ModelAction *act = *rit;
1289 /* Only consider 'write' actions */
1290 if (!act->is_write()) {
1291 if (act != curr && act->is_read() && act->happens_before(curr)) {
1292 ModelAction *tmp = act->get_reads_from();
1293 if (((unsigned int) id_to_int(tmp->get_tid()))==i)
1304 /* Don't consider more than one seq_cst write if we are a seq_cst read. */
1305 bool allow_read = true;
1307 if (curr->is_seqcst() && (act->is_seqcst() || (last_sc_write != NULL && act->happens_before(last_sc_write))) && act != last_sc_write)
1310 /* Need to check whether we will have two RMW reading from the same value */
1311 if (curr->is_rmwr()) {
1312 /* It is okay if we have a failing CAS */
1313 if (!curr->is_rmwrcas() ||
1314 valequals(curr->get_value(), act->get_value(), curr->getSize())) {
1315 //Need to make sure we aren't the second RMW
1316 CycleNode * node = mo_graph->getNode_noCreate(act);
1317 if (node != NULL && node->getRMW() != NULL) {
1318 //we are the second RMW
1325 /* Only add feasible reads */
1326 rf_set->push_back(act);
1329 /* Include at most one act per-thread that "happens before" curr */
1330 if (act->happens_before(curr))
1335 if (DBG_ENABLED()) {
1336 model_print("Reached read action:\n");
1338 model_print("End printing read_from_past\n");
1344 * @brief Get an action representing an uninitialized atomic
1346 * This function may create a new one or try to retrieve one from the NodeStack
1348 * @param curr The current action, which prompts the creation of an UNINIT action
1349 * @return A pointer to the UNINIT ModelAction
1351 ModelAction * ModelExecution::get_uninitialized_action(const ModelAction *curr) const
1353 Node *node = curr->get_node();
1354 ModelAction *act = node->get_uninit_action();
1356 act = new ModelAction(ATOMIC_UNINIT, std::memory_order_relaxed, curr->get_location(), params->uninitvalue, model_thread);
1357 node->set_uninit_action(act);
1359 act->create_cv(NULL);
1363 static void print_list(const action_list_t *list)
1365 action_list_t::const_iterator it;
1367 model_print("------------------------------------------------------------------------------------\n");
1368 model_print("# t Action type MO Location Value Rf CV\n");
1369 model_print("------------------------------------------------------------------------------------\n");
1371 unsigned int hash = 0;
1373 for (it = list->begin();it != list->end();it++) {
1374 const ModelAction *act = *it;
1375 if (act->get_seq_number() > 0)
1377 hash = hash^(hash<<3)^((*it)->hash());
1379 model_print("HASH %u\n", hash);
1380 model_print("------------------------------------------------------------------------------------\n");
1383 #if SUPPORT_MOD_ORDER_DUMP
1384 void ModelExecution::dumpGraph(char *filename) const
1387 sprintf(buffer, "%s.dot", filename);
1388 FILE *file = fopen(buffer, "w");
1389 fprintf(file, "digraph %s {\n", filename);
1390 mo_graph->dumpNodes(file);
1391 ModelAction **thread_array = (ModelAction **)model_calloc(1, sizeof(ModelAction *) * get_num_threads());
1393 for (action_list_t::const_iterator it = action_trace.begin();it != action_trace.end();it++) {
1394 ModelAction *act = *it;
1395 if (act->is_read()) {
1396 mo_graph->dot_print_node(file, act);
1397 mo_graph->dot_print_edge(file,
1398 act->get_reads_from(),
1400 "label=\"rf\", color=red, weight=2");
1402 if (thread_array[act->get_tid()]) {
1403 mo_graph->dot_print_edge(file,
1404 thread_array[id_to_int(act->get_tid())],
1406 "label=\"sb\", color=blue, weight=400");
1409 thread_array[act->get_tid()] = act;
1411 fprintf(file, "}\n");
1412 model_free(thread_array);
1417 /** @brief Prints an execution trace summary. */
1418 void ModelExecution::print_summary() const
1420 #if SUPPORT_MOD_ORDER_DUMP
1421 char buffername[100];
1422 sprintf(buffername, "exec%04u", get_execution_number());
1423 mo_graph->dumpGraphToFile(buffername);
1424 sprintf(buffername, "graph%04u", get_execution_number());
1425 dumpGraph(buffername);
1428 model_print("Execution trace %d:", get_execution_number());
1429 if (isfeasibleprefix()) {
1430 if (scheduler->all_threads_sleeping())
1431 model_print(" SLEEP-SET REDUNDANT");
1432 if (have_bug_reports())
1433 model_print(" DETECTED BUG(S)");
1435 print_infeasibility(" INFEASIBLE");
1438 print_list(&action_trace);
1444 * Add a Thread to the system for the first time. Should only be called once
1446 * @param t The Thread to add
1448 void ModelExecution::add_thread(Thread *t)
1450 unsigned int i = id_to_int(t->get_id());
1451 if (i >= thread_map.size())
1452 thread_map.resize(i + 1);
1454 if (!t->is_model_thread())
1455 scheduler->add_thread(t);
1459 * @brief Get a Thread reference by its ID
1460 * @param tid The Thread's ID
1461 * @return A Thread reference
1463 Thread * ModelExecution::get_thread(thread_id_t tid) const
1465 unsigned int i = id_to_int(tid);
1466 if (i < thread_map.size())
1467 return thread_map[i];
1472 * @brief Get a reference to the Thread in which a ModelAction was executed
1473 * @param act The ModelAction
1474 * @return A Thread reference
1476 Thread * ModelExecution::get_thread(const ModelAction *act) const
1478 return get_thread(act->get_tid());
1482 * @brief Get a Thread reference by its pthread ID
1483 * @param index The pthread's ID
1484 * @return A Thread reference
1486 Thread * ModelExecution::get_pthread(pthread_t pid) {
1492 uint32_t thread_id = x.v;
1493 if (thread_id < pthread_counter + 1) return pthread_map[thread_id];
1498 * @brief Check if a Thread is currently enabled
1499 * @param t The Thread to check
1500 * @return True if the Thread is currently enabled
1502 bool ModelExecution::is_enabled(Thread *t) const
1504 return scheduler->is_enabled(t);
1508 * @brief Check if a Thread is currently enabled
1509 * @param tid The ID of the Thread to check
1510 * @return True if the Thread is currently enabled
1512 bool ModelExecution::is_enabled(thread_id_t tid) const
1514 return scheduler->is_enabled(tid);
1518 * @brief Select the next thread to execute based on the curren action
1520 * RMW actions occur in two parts, and we cannot split them. And THREAD_CREATE
1521 * actions should be followed by the execution of their child thread. In either
1522 * case, the current action should determine the next thread schedule.
1524 * @param curr The current action
1525 * @return The next thread to run, if the current action will determine this
1526 * selection; otherwise NULL
1528 Thread * ModelExecution::action_select_next_thread(const ModelAction *curr) const
1530 /* Do not split atomic RMW */
1531 if (curr->is_rmwr())
1532 return get_thread(curr);
1533 /* Follow CREATE with the created thread */
1534 /* which is not needed, because model.cc takes care of this */
1535 if (curr->get_type() == THREAD_CREATE)
1536 return curr->get_thread_operand();
1537 if (curr->get_type() == PTHREAD_CREATE) {
1538 return curr->get_thread_operand();
1544 * Takes the next step in the execution, if possible.
1545 * @param curr The current step to take
1546 * @return Returns the next Thread to run, if any; NULL if this execution
1549 Thread * ModelExecution::take_step(ModelAction *curr)
1551 Thread *curr_thrd = get_thread(curr);
1552 ASSERT(curr_thrd->get_state() == THREAD_READY);
1554 ASSERT(check_action_enabled(curr)); /* May have side effects? */
1555 curr = check_current_action(curr);
1558 if (curr_thrd->is_blocked() || curr_thrd->is_complete())
1559 scheduler->remove_thread(curr_thrd);
1561 return action_select_next_thread(curr);
1564 Fuzzer * ModelExecution::getFuzzer() {