8 #include "snapshot-interface.h"
10 #include "clockvector.h"
11 #include "cyclegraph.h"
15 #define INITIAL_THREAD_ID 0
19 /** @brief Constructor */
20 ModelChecker::ModelChecker(struct model_params params) :
21 /* Initialize default scheduler */
22 scheduler(new Scheduler()),
26 action_trace(new action_list_t()),
27 thread_map(new HashTable<int, Thread *, int>()),
28 obj_map(new HashTable<const void *, action_list_t, uintptr_t, 4>()),
29 obj_thrd_map(new HashTable<void *, std::vector<action_list_t>, uintptr_t, 4 >()),
30 promises(new std::vector<Promise *>()),
31 lazy_sync_with_release(new HashTable<void *, std::list<ModelAction *>, uintptr_t, 4>()),
32 thrd_last_action(new std::vector<ModelAction *>(1)),
33 node_stack(new NodeStack()),
34 mo_graph(new CycleGraph()),
35 failed_promise(false),
36 too_many_reads(false),
39 /* Allocate this "size" on the snapshotting heap */
40 priv = (struct model_snapshot_members *)calloc(1, sizeof(*priv));
41 /* First thread created will have id INITIAL_THREAD_ID */
42 priv->next_thread_id = INITIAL_THREAD_ID;
44 lazy_sync_size = &priv->lazy_sync_size;
47 /** @brief Destructor */
48 ModelChecker::~ModelChecker()
50 for (int i = 0; i < get_num_threads(); i++)
51 delete thread_map->get(i);
58 for (unsigned int i = 0; i < promises->size(); i++)
59 delete (*promises)[i];
62 delete lazy_sync_with_release;
64 delete thrd_last_action;
71 * Restores user program to initial state and resets all model-checker data
74 void ModelChecker::reset_to_initial_state()
76 DEBUG("+++ Resetting to initial state +++\n");
77 node_stack->reset_execution();
78 failed_promise = false;
79 too_many_reads = false;
81 snapshotObject->backTrackBeforeStep(0);
84 /** @returns a thread ID for a new Thread */
85 thread_id_t ModelChecker::get_next_id()
87 return priv->next_thread_id++;
90 /** @returns the number of user threads created during this execution */
91 int ModelChecker::get_num_threads()
93 return priv->next_thread_id;
96 /** @returns a sequence number for a new ModelAction */
97 modelclock_t ModelChecker::get_next_seq_num()
99 return ++priv->used_sequence_numbers;
103 * Choose the next thread in the replay sequence.
105 * If the replay sequence has reached the 'diverge' point, returns a thread
106 * from the backtracking set. Otherwise, simply returns the next thread in the
107 * sequence that is being replayed.
109 Thread * ModelChecker::get_next_replay_thread()
113 /* Have we completed exploring the preselected path? */
117 /* Else, we are trying to replay an execution */
118 ModelAction *next = node_stack->get_next()->get_action();
120 if (next == diverge) {
121 Node *nextnode = next->get_node();
122 /* Reached divergence point */
123 if (nextnode->increment_promise()) {
124 /* The next node will try to satisfy a different set of promises. */
125 tid = next->get_tid();
126 node_stack->pop_restofstack(2);
127 } else if (nextnode->increment_read_from()) {
128 /* The next node will read from a different value. */
129 tid = next->get_tid();
130 node_stack->pop_restofstack(2);
131 } else if (nextnode->increment_future_value()) {
132 /* The next node will try to read from a different future value. */
133 tid = next->get_tid();
134 node_stack->pop_restofstack(2);
136 /* Make a different thread execute for next step */
137 Node *node = nextnode->get_parent();
138 tid = node->get_next_backtrack();
139 node_stack->pop_restofstack(1);
141 DEBUG("*** Divergence point ***\n");
144 tid = next->get_tid();
146 DEBUG("*** ModelChecker chose next thread = %d ***\n", tid);
147 ASSERT(tid != THREAD_ID_T_NONE);
148 return thread_map->get(id_to_int(tid));
152 * Queries the model-checker for more executions to explore and, if one
153 * exists, resets the model-checker state to execute a new execution.
155 * @return If there are more executions to explore, return true. Otherwise,
158 bool ModelChecker::next_execution()
164 if (isfinalfeasible() || DBG_ENABLED())
167 if ((diverge = get_next_backtrack()) == NULL)
171 printf("Next execution will diverge at:\n");
175 reset_to_initial_state();
179 ModelAction * ModelChecker::get_last_conflict(ModelAction *act)
181 action_type type = act->get_type();
191 /* linear search: from most recent to oldest */
192 action_list_t *list = obj_map->get_safe_ptr(act->get_location());
193 action_list_t::reverse_iterator rit;
194 for (rit = list->rbegin(); rit != list->rend(); rit++) {
195 ModelAction *prev = *rit;
196 if (act->is_synchronizing(prev))
202 void ModelChecker::set_backtracking(ModelAction *act)
206 Thread *t = get_thread(act->get_tid());
208 prev = get_last_conflict(act);
212 node = prev->get_node()->get_parent();
214 while (!node->is_enabled(t))
217 /* Check if this has been explored already */
218 if (node->has_been_explored(t->get_id()))
221 /* Cache the latest backtracking point */
222 if (!priv->next_backtrack || *prev > *priv->next_backtrack)
223 priv->next_backtrack = prev;
225 /* If this is a new backtracking point, mark the tree */
226 if (!node->set_backtrack(t->get_id()))
228 DEBUG("Setting backtrack: conflict = %d, instead tid = %d\n",
229 prev->get_tid(), t->get_id());
237 * Returns last backtracking point. The model checker will explore a different
238 * path for this point in the next execution.
239 * @return The ModelAction at which the next execution should diverge.
241 ModelAction * ModelChecker::get_next_backtrack()
243 ModelAction *next = priv->next_backtrack;
244 priv->next_backtrack = NULL;
249 * This is the heart of the model checker routine. It performs model-checking
250 * actions corresponding to a given "current action." Among other processes, it
251 * calculates reads-from relationships, updates synchronization clock vectors,
252 * forms a memory_order constraints graph, and handles replay/backtrack
253 * execution when running permutations of previously-observed executions.
255 * @param curr The current action to process
256 * @return The next Thread that must be executed. May be NULL if ModelChecker
257 * makes no choice (e.g., according to replay execution, combining RMW actions,
260 Thread * ModelChecker::check_current_action(ModelAction *curr)
262 bool second_part_of_rmw = false;
266 if (curr->is_rmwc() || curr->is_rmw()) {
267 ModelAction *tmp = process_rmw(curr);
268 second_part_of_rmw = true;
272 ModelAction *tmp = node_stack->explore_action(curr);
274 /* Discard duplicate ModelAction; use action from NodeStack */
275 /* First restore type and order in case of RMW operation */
277 tmp->copy_typeandorder(curr);
279 /* If we have diverged, we need to reset the clock vector. */
281 tmp->create_cv(get_parent_action(tmp->get_tid()));
287 * Perform one-time actions when pushing new ModelAction onto
290 curr->create_cv(get_parent_action(curr->get_tid()));
291 /* Build may_read_from set */
293 build_reads_from_past(curr);
294 if (curr->is_write())
295 compute_promises(curr);
299 /* Assign 'creation' parent */
300 if (curr->get_type() == THREAD_CREATE) {
301 Thread *th = (Thread *)curr->get_location();
302 th->set_creation(curr);
303 } else if (curr->get_type() == THREAD_JOIN) {
305 wait = get_thread(curr->get_tid());
306 join = (Thread *)curr->get_location();
307 if (!join->is_complete())
308 scheduler->wait(wait, join);
309 } else if (curr->get_type() == THREAD_FINISH) {
310 Thread *th = get_thread(curr->get_tid());
311 while (!th->wait_list_empty()) {
312 Thread *wake = th->pop_wait_list();
313 scheduler->wake(wake);
318 /* Deal with new thread */
319 if (curr->get_type() == THREAD_START)
320 check_promises(NULL, curr->get_cv());
322 /* Assign reads_from values */
323 Thread *th = get_thread(curr->get_tid());
324 uint64_t value = VALUE_NONE;
325 bool updated = false;
326 if (curr->is_read()) {
328 const ModelAction *reads_from = curr->get_node()->get_read_from();
329 if (reads_from != NULL) {
330 value = reads_from->get_value();
331 /* Assign reads_from, perform release/acquire synchronization */
332 curr->read_from(reads_from);
333 if (!second_part_of_rmw)
334 check_recency(curr,false);
336 bool r_status=r_modification_order(curr,reads_from);
338 if (!second_part_of_rmw&&!isfeasible()&&(curr->get_node()->increment_read_from()||!curr->get_node()->future_value_empty())) {
339 mo_graph->rollbackChanges();
340 too_many_reads=false;
344 mo_graph->commitChanges();
347 /* Read from future value */
348 value = curr->get_node()->get_future_value();
349 curr->read_from(NULL);
350 Promise *valuepromise = new Promise(curr, value);
351 promises->push_back(valuepromise);
355 } else if (curr->is_write()) {
356 if (w_modification_order(curr))
358 if (resolve_promises(curr))
360 mo_graph->commitChanges();
364 resolve_release_sequences(curr->get_location());
366 th->set_return_value(value);
368 /* Add action to list. */
369 if (!second_part_of_rmw)
370 add_action_to_lists(curr);
372 Node *currnode = curr->get_node();
373 Node *parnode = currnode->get_parent();
375 if (!parnode->backtrack_empty() || !currnode->read_from_empty() ||
376 !currnode->future_value_empty() || !currnode->promise_empty())
377 if (!priv->next_backtrack || *curr > *priv->next_backtrack)
378 priv->next_backtrack = curr;
380 set_backtracking(curr);
382 /* Do not split atomic actions. */
384 return thread_current();
385 /* The THREAD_CREATE action points to the created Thread */
386 else if (curr->get_type() == THREAD_CREATE)
387 return (Thread *)curr->get_location();
389 return get_next_replay_thread();
392 /** @returns whether the current partial trace must be a prefix of a
394 bool ModelChecker::isfeasibleprefix() {
395 return promises->size() == 0 && *lazy_sync_size == 0;
398 /** @returns whether the current partial trace is feasible. */
399 bool ModelChecker::isfeasible() {
400 return !mo_graph->checkForCycles() && !failed_promise && !too_many_reads;
403 /** Returns whether the current completed trace is feasible. */
404 bool ModelChecker::isfinalfeasible() {
405 return isfeasible() && promises->size() == 0;
408 /** Close out a RMWR by converting previous RMWR into a RMW or READ. */
409 ModelAction * ModelChecker::process_rmw(ModelAction *act) {
410 int tid = id_to_int(act->get_tid());
411 ModelAction *lastread = get_last_action(tid);
412 lastread->process_rmw(act);
414 mo_graph->addRMWEdge(lastread->get_reads_from(), lastread);
419 * Checks whether a thread has read from the same write for too many times
420 * without seeing the effects of a later write.
423 * 1) there must a different write that we could read from that would satisfy the modification order,
424 * 2) we must have read from the same value in excess of maxreads times, and
425 * 3) that other write must have been in the reads_from set for maxreads times.
427 * If so, we decide that the execution is no longer feasible.
429 void ModelChecker::check_recency(ModelAction *curr, bool already_added) {
430 if (params.maxreads != 0) {
431 if (curr->get_node()->get_read_from_size() <= 1)
434 //Must make sure that execution is currently feasible... We could
435 //accidentally clear by rolling back
439 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
440 int tid = id_to_int(curr->get_tid());
443 if ((int)thrd_lists->size() <= tid)
446 action_list_t *list = &(*thrd_lists)[tid];
448 action_list_t::reverse_iterator rit = list->rbegin();
450 if (!already_added) {
451 for (; (*rit) != curr; rit++)
453 /* go past curr now */
457 action_list_t::reverse_iterator ritcopy=rit;
458 //See if we have enough reads from the same value
460 for (; count < params.maxreads; rit++,count++) {
461 if (rit==list->rend())
463 ModelAction *act = *rit;
466 if (act->get_reads_from() != curr->get_reads_from())
468 if (act->get_node()->get_read_from_size() <= 1)
472 for (int i=0;i<curr->get_node()->get_read_from_size();i++) {
474 const ModelAction * write=curr->get_node()->get_read_from_at(i);
475 //Need a different write
476 if (write==curr->get_reads_from())
479 /* Test to see whether this is a feasible write to read from*/
480 r_modification_order(curr, write);
481 bool feasiblereadfrom=isfeasible();
482 mo_graph->rollbackChanges();
484 if (!feasiblereadfrom)
488 bool feasiblewrite=true;
489 //new we need to see if this write works for everyone
491 for (int loop=count;loop>0;loop--,rit++) {
492 ModelAction *act=*rit;
493 bool foundvalue=false;
494 for(int j=0;j<act->get_node()->get_read_from_size();j++) {
495 if (act->get_node()->get_read_from_at(i)==write) {
506 too_many_reads = true;
514 * Updates the mo_graph with the constraints imposed from the current read.
515 * @param curr The current action. Must be a read.
516 * @param rf The action that curr reads from. Must be a write.
517 * @return True if modification order edges were added; false otherwise
519 bool ModelChecker::r_modification_order(ModelAction *curr, const ModelAction *rf)
521 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
524 ASSERT(curr->is_read());
526 /* Iterate over all threads */
527 for (i = 0; i < thrd_lists->size(); i++) {
528 /* Iterate over actions in thread, starting from most recent */
529 action_list_t *list = &(*thrd_lists)[i];
530 action_list_t::reverse_iterator rit;
531 for (rit = list->rbegin(); rit != list->rend(); rit++) {
532 ModelAction *act = *rit;
534 /* Include at most one act per-thread that "happens before" curr */
535 if (act->happens_before(curr)) {
536 if (act->is_read()) {
537 const ModelAction *prevreadfrom = act->get_reads_from();
538 if (prevreadfrom != NULL && rf != prevreadfrom) {
539 mo_graph->addEdge(prevreadfrom, rf);
542 } else if (rf != act) {
543 mo_graph->addEdge(act, rf);
554 /** Updates the mo_graph with the constraints imposed from the current read. */
555 void ModelChecker::post_r_modification_order(ModelAction *curr, const ModelAction *rf)
557 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
559 ASSERT(curr->is_read());
561 /* Iterate over all threads */
562 for (i = 0; i < thrd_lists->size(); i++) {
563 /* Iterate over actions in thread, starting from most recent */
564 action_list_t *list = &(*thrd_lists)[i];
565 action_list_t::reverse_iterator rit;
566 ModelAction *lastact = NULL;
568 /* Find last action that happens after curr */
569 for (rit = list->rbegin(); rit != list->rend(); rit++) {
570 ModelAction *act = *rit;
571 if (curr->happens_before(act)) {
577 /* Include at most one act per-thread that "happens before" curr */
578 if (lastact != NULL) {
579 if (lastact->is_read()) {
580 const ModelAction *postreadfrom = lastact->get_reads_from();
581 if (postreadfrom != NULL&&rf != postreadfrom)
582 mo_graph->addEdge(rf, postreadfrom);
583 } else if (rf != lastact) {
584 mo_graph->addEdge(rf, lastact);
592 * Updates the mo_graph with the constraints imposed from the current write.
593 * @param curr The current action. Must be a write.
594 * @return True if modification order edges were added; false otherwise
596 bool ModelChecker::w_modification_order(ModelAction *curr)
598 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
601 ASSERT(curr->is_write());
603 if (curr->is_seqcst()) {
604 /* We have to at least see the last sequentially consistent write,
605 so we are initialized. */
606 ModelAction *last_seq_cst = get_last_seq_cst(curr->get_location());
607 if (last_seq_cst != NULL) {
608 mo_graph->addEdge(last_seq_cst, curr);
613 /* Iterate over all threads */
614 for (i = 0; i < thrd_lists->size(); i++) {
615 /* Iterate over actions in thread, starting from most recent */
616 action_list_t *list = &(*thrd_lists)[i];
617 action_list_t::reverse_iterator rit;
618 for (rit = list->rbegin(); rit != list->rend(); rit++) {
619 ModelAction *act = *rit;
621 /* Include at most one act per-thread that "happens before" curr */
622 if (act->happens_before(curr)) {
624 mo_graph->addEdge(act->get_reads_from(), curr);
626 mo_graph->addEdge(act, curr);
629 } else if (act->is_read() && !act->is_synchronizing(curr) &&
630 !act->same_thread(curr)) {
631 /* We have an action that:
632 (1) did not happen before us
633 (2) is a read and we are a write
634 (3) cannot synchronize with us
635 (4) is in a different thread
637 that read could potentially read from our write.
639 if (act->get_node()->add_future_value(curr->get_value()) &&
640 (!priv->next_backtrack || *act > *priv->next_backtrack))
641 priv->next_backtrack = act;
650 * Finds the head(s) of the release sequence(s) containing a given ModelAction.
651 * The ModelAction under consideration is expected to be taking part in
652 * release/acquire synchronization as an object of the "reads from" relation.
653 * Note that this can only provide release sequence support for RMW chains
654 * which do not read from the future, as those actions cannot be traced until
655 * their "promise" is fulfilled. Similarly, we may not even establish the
656 * presence of a release sequence with certainty, as some modification order
657 * constraints may be decided further in the future. Thus, this function
658 * "returns" two pieces of data: a pass-by-reference vector of @a release_heads
659 * and a boolean representing certainty.
661 * @todo Finish lazy updating, when promises are fulfilled in the future
662 * @param rf The action that might be part of a release sequence. Must be a
664 * @param release_heads A pass-by-reference style return parameter. After
665 * execution of this function, release_heads will contain the heads of all the
666 * relevant release sequences, if any exists
667 * @return true, if the ModelChecker is certain that release_heads is complete;
670 bool ModelChecker::release_seq_head(const ModelAction *rf,
671 std::vector<const ModelAction *> *release_heads) const
673 ASSERT(rf->is_write());
675 /* read from future: need to settle this later */
676 return false; /* incomplete */
678 if (rf->is_release())
679 release_heads->push_back(rf);
681 /* We need a RMW action that is both an acquire and release to stop */
682 /** @todo Need to be smarter here... In the linux lock
683 * example, this will run to the beginning of the program for
685 if (rf->is_acquire() && rf->is_release())
686 return true; /* complete */
687 return release_seq_head(rf->get_reads_from(), release_heads);
689 if (rf->is_release())
690 return true; /* complete */
692 /* else relaxed write; check modification order for contiguous subsequence
693 * -> rf must be same thread as release */
694 int tid = id_to_int(rf->get_tid());
695 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(rf->get_location());
696 action_list_t *list = &(*thrd_lists)[tid];
697 action_list_t::const_reverse_iterator rit;
699 /* Find rf in the thread list */
700 rit = std::find(list->rbegin(), list->rend(), rf);
701 ASSERT(rit != list->rend());
703 /* Find the last write/release */
704 for (; rit != list->rend(); rit++)
705 if ((*rit)->is_release())
707 if (rit == list->rend()) {
708 /* No write-release in this thread */
709 return true; /* complete */
711 ModelAction *release = *rit;
713 ASSERT(rf->same_thread(release));
716 for (unsigned int i = 0; i < thrd_lists->size(); i++) {
717 if (id_to_int(rf->get_tid()) == (int)i)
719 list = &(*thrd_lists)[i];
721 /* Can we ensure no future writes from this thread may break
722 * the release seq? */
723 bool future_ordered = false;
725 for (rit = list->rbegin(); rit != list->rend(); rit++) {
726 const ModelAction *act = *rit;
727 if (!act->is_write())
729 /* Reach synchronization -> this thread is complete */
730 if (act->happens_before(release))
732 if (rf->happens_before(act)) {
733 future_ordered = true;
737 /* Check modification order */
738 if (mo_graph->checkReachable(rf, act)) {
740 future_ordered = true;
743 if (mo_graph->checkReachable(act, release))
744 /* act --mo--> release */
746 if (mo_graph->checkReachable(release, act) &&
747 mo_graph->checkReachable(act, rf)) {
748 /* release --mo-> act --mo--> rf */
749 return true; /* complete */
754 return false; /* This thread is uncertain */
758 release_heads->push_back(release);
763 * A public interface for getting the release sequence head(s) with which a
764 * given ModelAction must synchronize. This function only returns a non-empty
765 * result when it can locate a release sequence head with certainty. Otherwise,
766 * it may mark the internal state of the ModelChecker so that it will handle
767 * the release sequence at a later time, causing @a act to update its
768 * synchronization at some later point in execution.
769 * @param act The 'acquire' action that may read from a release sequence
770 * @param release_heads A pass-by-reference return parameter. Will be filled
771 * with the head(s) of the release sequence(s), if they exists with certainty.
772 * @see ModelChecker::release_seq_head
774 void ModelChecker::get_release_seq_heads(ModelAction *act,
775 std::vector<const ModelAction *> *release_heads)
777 const ModelAction *rf = act->get_reads_from();
779 complete = release_seq_head(rf, release_heads);
781 /* add act to 'lazy checking' list */
782 std::list<ModelAction *> *list;
783 list = lazy_sync_with_release->get_safe_ptr(act->get_location());
784 list->push_back(act);
790 * Attempt to resolve all stashed operations that might synchronize with a
791 * release sequence for a given location. This implements the "lazy" portion of
792 * determining whether or not a release sequence was contiguous, since not all
793 * modification order information is present at the time an action occurs.
795 * @param location The location/object that should be checked for release
796 * sequence resolutions
797 * @return True if any updates occurred (new synchronization, new mo_graph edges)
799 bool ModelChecker::resolve_release_sequences(void *location)
801 std::list<ModelAction *> *list;
802 list = lazy_sync_with_release->getptr(location);
806 bool updated = false;
807 std::list<ModelAction *>::iterator it = list->begin();
808 while (it != list->end()) {
809 ModelAction *act = *it;
810 const ModelAction *rf = act->get_reads_from();
811 std::vector<const ModelAction *> release_heads;
813 complete = release_seq_head(rf, &release_heads);
814 for (unsigned int i = 0; i < release_heads.size(); i++) {
815 if (!act->has_synchronized_with(release_heads[i])) {
817 act->synchronize_with(release_heads[i]);
822 /* propagate synchronization to later actions */
823 action_list_t::reverse_iterator it = action_trace->rbegin();
824 while ((*it) != act) {
825 ModelAction *propagate = *it;
826 if (act->happens_before(propagate))
827 /** @todo new mo_graph edges along with
828 * this synchronization? */
829 propagate->synchronize_with(act);
833 it = list->erase(it);
839 // If we resolved promises or data races, see if we have realized a data race.
840 if (checkDataRaces()) {
848 * Performs various bookkeeping operations for the current ModelAction. For
849 * instance, adds action to the per-object, per-thread action vector and to the
850 * action trace list of all thread actions.
852 * @param act is the ModelAction to add.
854 void ModelChecker::add_action_to_lists(ModelAction *act)
856 int tid = id_to_int(act->get_tid());
857 action_trace->push_back(act);
859 obj_map->get_safe_ptr(act->get_location())->push_back(act);
861 std::vector<action_list_t> *vec = obj_thrd_map->get_safe_ptr(act->get_location());
862 if (tid >= (int)vec->size())
863 vec->resize(priv->next_thread_id);
864 (*vec)[tid].push_back(act);
866 if ((int)thrd_last_action->size() <= tid)
867 thrd_last_action->resize(get_num_threads());
868 (*thrd_last_action)[tid] = act;
871 ModelAction * ModelChecker::get_last_action(thread_id_t tid)
873 int nthreads = get_num_threads();
874 if ((int)thrd_last_action->size() < nthreads)
875 thrd_last_action->resize(nthreads);
876 return (*thrd_last_action)[id_to_int(tid)];
880 * Gets the last memory_order_seq_cst action (in the total global sequence)
881 * performed on a particular object (i.e., memory location).
882 * @param location The object location to check
883 * @return The last seq_cst action performed
885 ModelAction * ModelChecker::get_last_seq_cst(const void *location)
887 action_list_t *list = obj_map->get_safe_ptr(location);
888 /* Find: max({i in dom(S) | seq_cst(t_i) && isWrite(t_i) && samevar(t_i, t)}) */
889 action_list_t::reverse_iterator rit;
890 for (rit = list->rbegin(); rit != list->rend(); rit++)
891 if ((*rit)->is_write() && (*rit)->is_seqcst())
896 ModelAction * ModelChecker::get_parent_action(thread_id_t tid)
898 ModelAction *parent = get_last_action(tid);
900 parent = get_thread(tid)->get_creation();
905 * Returns the clock vector for a given thread.
906 * @param tid The thread whose clock vector we want
907 * @return Desired clock vector
909 ClockVector * ModelChecker::get_cv(thread_id_t tid)
911 return get_parent_action(tid)->get_cv();
915 * Resolve a set of Promises with a current write. The set is provided in the
916 * Node corresponding to @a write.
917 * @param write The ModelAction that is fulfilling Promises
918 * @return True if promises were resolved; false otherwise
920 bool ModelChecker::resolve_promises(ModelAction *write)
922 bool resolved = false;
923 for (unsigned int i = 0, promise_index = 0; promise_index < promises->size(); i++) {
924 Promise *promise = (*promises)[promise_index];
925 if (write->get_node()->get_promise(i)) {
926 ModelAction *read = promise->get_action();
927 read->read_from(write);
928 r_modification_order(read, write);
929 post_r_modification_order(read, write);
930 promises->erase(promises->begin() + promise_index);
940 * Compute the set of promises that could potentially be satisfied by this
941 * action. Note that the set computation actually appears in the Node, not in
943 * @param curr The ModelAction that may satisfy promises
945 void ModelChecker::compute_promises(ModelAction *curr)
947 for (unsigned int i = 0; i < promises->size(); i++) {
948 Promise *promise = (*promises)[i];
949 const ModelAction *act = promise->get_action();
950 if (!act->happens_before(curr) &&
952 !act->is_synchronizing(curr) &&
953 !act->same_thread(curr) &&
954 promise->get_value() == curr->get_value()) {
955 curr->get_node()->set_promise(i);
960 /** Checks promises in response to change in ClockVector Threads. */
961 void ModelChecker::check_promises(ClockVector *old_cv, ClockVector *merge_cv)
963 for (unsigned int i = 0; i < promises->size(); i++) {
964 Promise *promise = (*promises)[i];
965 const ModelAction *act = promise->get_action();
966 if ((old_cv == NULL || !old_cv->synchronized_since(act)) &&
967 merge_cv->synchronized_since(act)) {
968 //This thread is no longer able to send values back to satisfy the promise
969 int num_synchronized_threads = promise->increment_threads();
970 if (num_synchronized_threads == get_num_threads()) {
972 failed_promise = true;
980 * Build up an initial set of all past writes that this 'read' action may read
981 * from. This set is determined by the clock vector's "happens before"
983 * @param curr is the current ModelAction that we are exploring; it must be a
986 void ModelChecker::build_reads_from_past(ModelAction *curr)
988 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
990 ASSERT(curr->is_read());
992 ModelAction *last_seq_cst = NULL;
994 /* Track whether this object has been initialized */
995 bool initialized = false;
997 if (curr->is_seqcst()) {
998 last_seq_cst = get_last_seq_cst(curr->get_location());
999 /* We have to at least see the last sequentially consistent write,
1000 so we are initialized. */
1001 if (last_seq_cst != NULL)
1005 /* Iterate over all threads */
1006 for (i = 0; i < thrd_lists->size(); i++) {
1007 /* Iterate over actions in thread, starting from most recent */
1008 action_list_t *list = &(*thrd_lists)[i];
1009 action_list_t::reverse_iterator rit;
1010 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1011 ModelAction *act = *rit;
1013 /* Only consider 'write' actions */
1014 if (!act->is_write())
1017 /* Don't consider more than one seq_cst write if we are a seq_cst read. */
1018 if (!act->is_seqcst() || !curr->is_seqcst() || act == last_seq_cst) {
1019 DEBUG("Adding action to may_read_from:\n");
1020 if (DBG_ENABLED()) {
1024 curr->get_node()->add_read_from(act);
1027 /* Include at most one act per-thread that "happens before" curr */
1028 if (act->happens_before(curr)) {
1036 /** @todo Need a more informative way of reporting errors. */
1037 printf("ERROR: may read from uninitialized atomic\n");
1040 if (DBG_ENABLED() || !initialized) {
1041 printf("Reached read action:\n");
1043 printf("Printing may_read_from\n");
1044 curr->get_node()->print_may_read_from();
1045 printf("End printing may_read_from\n");
1048 ASSERT(initialized);
1051 static void print_list(action_list_t *list)
1053 action_list_t::iterator it;
1055 printf("---------------------------------------------------------------------\n");
1058 for (it = list->begin(); it != list->end(); it++) {
1061 printf("---------------------------------------------------------------------\n");
1064 void ModelChecker::print_summary()
1067 printf("Number of executions: %d\n", num_executions);
1068 printf("Total nodes created: %d\n", node_stack->get_total_nodes());
1072 if (!isfinalfeasible())
1073 printf("INFEASIBLE EXECUTION!\n");
1074 print_list(action_trace);
1079 * Add a Thread to the system for the first time. Should only be called once
1081 * @param t The Thread to add
1083 void ModelChecker::add_thread(Thread *t)
1085 thread_map->put(id_to_int(t->get_id()), t);
1086 scheduler->add_thread(t);
1089 void ModelChecker::remove_thread(Thread *t)
1091 scheduler->remove_thread(t);
1095 * Switch from a user-context to the "master thread" context (a.k.a. system
1096 * context). This switch is made with the intention of exploring a particular
1097 * model-checking action (described by a ModelAction object). Must be called
1098 * from a user-thread context.
1099 * @param act The current action that will be explored. Must not be NULL.
1100 * @return Return status from the 'swap' call (i.e., success/fail, 0/-1)
1102 int ModelChecker::switch_to_master(ModelAction *act)
1105 Thread *old = thread_current();
1106 set_current_action(act);
1107 old->set_state(THREAD_READY);
1108 return Thread::swap(old, &system_context);
1112 * Takes the next step in the execution, if possible.
1113 * @return Returns true (success) if a step was taken and false otherwise.
1115 bool ModelChecker::take_step() {
1116 Thread *curr, *next;
1121 curr = thread_current();
1123 if (curr->get_state() == THREAD_READY) {
1124 ASSERT(priv->current_action);
1125 priv->nextThread = check_current_action(priv->current_action);
1126 priv->current_action = NULL;
1127 if (!curr->is_blocked() && !curr->is_complete())
1128 scheduler->add_thread(curr);
1133 next = scheduler->next_thread(priv->nextThread);
1135 /* Infeasible -> don't take any more steps */
1140 next->set_state(THREAD_RUNNING);
1141 DEBUG("(%d, %d)\n", curr ? curr->get_id() : -1, next ? next->get_id() : -1);
1143 /* next == NULL -> don't take any more steps */
1146 /* Return false only if swap fails with an error */
1147 return (Thread::swap(&system_context, next) == 0);
1150 /** Runs the current execution until threre are no more steps to take. */
1151 void ModelChecker::finish_execution() {
1154 while (take_step());