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 * @brief Choose the next thread to execute.
105 * This function chooses the next thread that should execute. It can force the
106 * adjacency of read/write portions of a RMW action, force THREAD_CREATE to be
107 * followed by a THREAD_START, or it can enforce execution replay/backtracking.
108 * The model-checker may have no preference regarding the next thread (i.e.,
109 * when exploring a new execution ordering), in which case this will return
111 * @param curr The current ModelAction. This action might guide the choice of
113 * @return The next thread to run. If the model-checker has no preference, NULL.
115 Thread * ModelChecker::get_next_thread(ModelAction *curr)
119 /* Do not split atomic actions. */
121 return thread_current();
122 /* The THREAD_CREATE action points to the created Thread */
123 else if (curr->get_type() == THREAD_CREATE)
124 return (Thread *)curr->get_location();
126 /* Have we completed exploring the preselected path? */
130 /* Else, we are trying to replay an execution */
131 ModelAction *next = node_stack->get_next()->get_action();
133 if (next == diverge) {
134 Node *nextnode = next->get_node();
135 /* Reached divergence point */
136 if (nextnode->increment_promise()) {
137 /* The next node will try to satisfy a different set of promises. */
138 tid = next->get_tid();
139 node_stack->pop_restofstack(2);
140 } else if (nextnode->increment_read_from()) {
141 /* The next node will read from a different value. */
142 tid = next->get_tid();
143 node_stack->pop_restofstack(2);
144 } else if (nextnode->increment_future_value()) {
145 /* The next node will try to read from a different future value. */
146 tid = next->get_tid();
147 node_stack->pop_restofstack(2);
149 /* Make a different thread execute for next step */
150 Node *node = nextnode->get_parent();
151 tid = node->get_next_backtrack();
152 node_stack->pop_restofstack(1);
154 DEBUG("*** Divergence point ***\n");
157 tid = next->get_tid();
159 DEBUG("*** ModelChecker chose next thread = %d ***\n", tid);
160 ASSERT(tid != THREAD_ID_T_NONE);
161 return thread_map->get(id_to_int(tid));
165 * Queries the model-checker for more executions to explore and, if one
166 * exists, resets the model-checker state to execute a new execution.
168 * @return If there are more executions to explore, return true. Otherwise,
171 bool ModelChecker::next_execution()
177 if (isfinalfeasible() || DBG_ENABLED())
180 if ((diverge = get_next_backtrack()) == NULL)
184 printf("Next execution will diverge at:\n");
188 reset_to_initial_state();
192 ModelAction * ModelChecker::get_last_conflict(ModelAction *act)
194 action_type type = act->get_type();
204 /* linear search: from most recent to oldest */
205 action_list_t *list = obj_map->get_safe_ptr(act->get_location());
206 action_list_t::reverse_iterator rit;
207 for (rit = list->rbegin(); rit != list->rend(); rit++) {
208 ModelAction *prev = *rit;
209 if (act->is_synchronizing(prev))
215 void ModelChecker::set_backtracking(ModelAction *act)
219 Thread *t = get_thread(act);
221 prev = get_last_conflict(act);
225 node = prev->get_node()->get_parent();
227 while (!node->is_enabled(t))
230 /* Check if this has been explored already */
231 if (node->has_been_explored(t->get_id()))
234 /* Cache the latest backtracking point */
235 if (!priv->next_backtrack || *prev > *priv->next_backtrack)
236 priv->next_backtrack = prev;
238 /* If this is a new backtracking point, mark the tree */
239 if (!node->set_backtrack(t->get_id()))
241 DEBUG("Setting backtrack: conflict = %d, instead tid = %d\n",
242 prev->get_tid(), t->get_id());
250 * Returns last backtracking point. The model checker will explore a different
251 * path for this point in the next execution.
252 * @return The ModelAction at which the next execution should diverge.
254 ModelAction * ModelChecker::get_next_backtrack()
256 ModelAction *next = priv->next_backtrack;
257 priv->next_backtrack = NULL;
262 * Processes a read or rmw model action.
263 * @param curr is the read model action to process.
264 * @param th is the thread
265 * @param second_part_of_rmw is boolean that is true is this is the second action of a rmw.
266 * @return True if processing this read updates the mo_graph.
269 bool ModelChecker::process_read(ModelAction *curr, Thread * th, bool second_part_of_rmw) {
273 const ModelAction *reads_from = curr->get_node()->get_read_from();
274 if (reads_from != NULL) {
275 mo_graph->startChanges();
277 value = reads_from->get_value();
278 /* Assign reads_from, perform release/acquire synchronization */
279 curr->read_from(reads_from);
280 if (!second_part_of_rmw) {
281 check_recency(curr,false);
284 bool r_status=r_modification_order(curr,reads_from);
286 if (!second_part_of_rmw&&!isfeasible()&&(curr->get_node()->increment_read_from()||!curr->get_node()->future_value_empty())) {
287 mo_graph->rollbackChanges();
288 too_many_reads=false;
292 mo_graph->commitChanges();
295 /* Read from future value */
296 value = curr->get_node()->get_future_value();
297 modelclock_t expiration = curr->get_node()->get_future_value_expiration();
298 curr->read_from(NULL);
299 Promise *valuepromise = new Promise(curr, value, expiration);
300 promises->push_back(valuepromise);
302 th->set_return_value(value);
308 * This is the heart of the model checker routine. It performs model-checking
309 * actions corresponding to a given "current action." Among other processes, it
310 * calculates reads-from relationships, updates synchronization clock vectors,
311 * forms a memory_order constraints graph, and handles replay/backtrack
312 * execution when running permutations of previously-observed executions.
314 * @param curr The current action to process
315 * @return The next Thread that must be executed. May be NULL if ModelChecker
316 * makes no choice (e.g., according to replay execution, combining RMW actions,
319 Thread * ModelChecker::check_current_action(ModelAction *curr)
321 bool second_part_of_rmw = false;
325 if (curr->is_rmwc() || curr->is_rmw()) {
326 ModelAction *tmp = process_rmw(curr);
327 second_part_of_rmw = true;
330 compute_promises(curr);
332 ModelAction *tmp = node_stack->explore_action(curr);
334 /* Discard duplicate ModelAction; use action from NodeStack */
335 /* First restore type and order in case of RMW operation */
337 tmp->copy_typeandorder(curr);
339 /* If we have diverged, we need to reset the clock vector. */
341 tmp->create_cv(get_parent_action(tmp->get_tid()));
347 * Perform one-time actions when pushing new ModelAction onto
350 curr->create_cv(get_parent_action(curr->get_tid()));
351 /* Build may_read_from set */
353 build_reads_from_past(curr);
354 if (curr->is_write())
355 compute_promises(curr);
359 /* Thread specific actions */
360 switch(curr->get_type()) {
361 case THREAD_CREATE: {
362 Thread *th = (Thread *)curr->get_location();
363 th->set_creation(curr);
367 Thread *waiting, *blocking;
368 waiting = get_thread(curr);
369 blocking = (Thread *)curr->get_location();
370 if (!blocking->is_complete()) {
371 blocking->push_wait_list(curr);
372 scheduler->sleep(waiting);
376 case THREAD_FINISH: {
377 Thread *th = get_thread(curr);
378 while (!th->wait_list_empty()) {
379 ModelAction *act = th->pop_wait_list();
380 Thread *wake = get_thread(act);
381 scheduler->wake(wake);
387 check_promises(NULL, curr->get_cv());
394 Thread *th = get_thread(curr);
396 bool updated = false;
397 if (curr->is_read()) {
398 updated=process_read(curr, th, second_part_of_rmw);
401 if (curr->is_write()) {
402 bool updated_mod_order=w_modification_order(curr);
403 bool updated_promises=resolve_promises(curr);
404 updated=updated_mod_order|updated_promises;
406 mo_graph->commitChanges();
407 th->set_return_value(VALUE_NONE);
411 resolve_release_sequences(curr->get_location());
413 /* Add action to list. */
414 if (!second_part_of_rmw)
415 add_action_to_lists(curr);
417 check_curr_backtracking(curr);
419 set_backtracking(curr);
421 return get_next_thread(curr);
424 void ModelChecker::check_curr_backtracking(ModelAction * curr) {
425 Node *currnode = curr->get_node();
426 Node *parnode = currnode->get_parent();
428 if ((!parnode->backtrack_empty() ||
429 !currnode->read_from_empty() ||
430 !currnode->future_value_empty() ||
431 !currnode->promise_empty())
432 && (!priv->next_backtrack ||
433 *curr > *priv->next_backtrack)) {
434 priv->next_backtrack = curr;
439 bool ModelChecker::promises_expired() {
440 for (unsigned int promise_index = 0; promise_index < promises->size(); promise_index++) {
441 Promise *promise = (*promises)[promise_index];
442 if (promise->get_expiration()<priv->used_sequence_numbers) {
449 /** @returns whether the current partial trace must be a prefix of a
451 bool ModelChecker::isfeasibleprefix() {
452 return promises->size() == 0 && *lazy_sync_size == 0;
455 /** @returns whether the current partial trace is feasible. */
456 bool ModelChecker::isfeasible() {
457 return !mo_graph->checkForCycles() && !failed_promise && !too_many_reads && !promises_expired();
460 /** Returns whether the current completed trace is feasible. */
461 bool ModelChecker::isfinalfeasible() {
462 return isfeasible() && promises->size() == 0;
465 /** Close out a RMWR by converting previous RMWR into a RMW or READ. */
466 ModelAction * ModelChecker::process_rmw(ModelAction *act) {
467 int tid = id_to_int(act->get_tid());
468 ModelAction *lastread = get_last_action(tid);
469 lastread->process_rmw(act);
470 if (act->is_rmw() && lastread->get_reads_from()!=NULL) {
471 mo_graph->addRMWEdge(lastread->get_reads_from(), lastread);
472 mo_graph->commitChanges();
478 * Checks whether a thread has read from the same write for too many times
479 * without seeing the effects of a later write.
482 * 1) there must a different write that we could read from that would satisfy the modification order,
483 * 2) we must have read from the same value in excess of maxreads times, and
484 * 3) that other write must have been in the reads_from set for maxreads times.
486 * If so, we decide that the execution is no longer feasible.
488 void ModelChecker::check_recency(ModelAction *curr, bool already_added) {
489 if (params.maxreads != 0) {
490 if (curr->get_node()->get_read_from_size() <= 1)
493 //Must make sure that execution is currently feasible... We could
494 //accidentally clear by rolling back
498 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
499 int tid = id_to_int(curr->get_tid());
502 if ((int)thrd_lists->size() <= tid)
505 action_list_t *list = &(*thrd_lists)[tid];
507 action_list_t::reverse_iterator rit = list->rbegin();
510 for (; (*rit) != curr; rit++)
512 /* go past curr now */
516 action_list_t::reverse_iterator ritcopy=rit;
517 //See if we have enough reads from the same value
519 for (; count < params.maxreads; rit++,count++) {
520 if (rit==list->rend())
522 ModelAction *act = *rit;
525 if (act->get_reads_from() != curr->get_reads_from())
527 if (act->get_node()->get_read_from_size() <= 1)
531 for (int i=0;i<curr->get_node()->get_read_from_size();i++) {
533 const ModelAction * write=curr->get_node()->get_read_from_at(i);
534 //Need a different write
535 if (write==curr->get_reads_from())
538 /* Test to see whether this is a feasible write to read from*/
539 mo_graph->startChanges();
540 r_modification_order(curr, write);
541 bool feasiblereadfrom=isfeasible();
542 mo_graph->rollbackChanges();
544 if (!feasiblereadfrom)
548 bool feasiblewrite=true;
549 //new we need to see if this write works for everyone
551 for (int loop=count;loop>0;loop--,rit++) {
552 ModelAction *act=*rit;
553 bool foundvalue=false;
554 for(int j=0;j<act->get_node()->get_read_from_size();j++) {
555 if (act->get_node()->get_read_from_at(i)==write) {
566 too_many_reads = true;
574 * Updates the mo_graph with the constraints imposed from the current read.
575 * @param curr The current action. Must be a read.
576 * @param rf The action that curr reads from. Must be a write.
577 * @return True if modification order edges were added; false otherwise
579 bool ModelChecker::r_modification_order(ModelAction *curr, const ModelAction *rf)
581 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
584 ASSERT(curr->is_read());
586 /* Iterate over all threads */
587 for (i = 0; i < thrd_lists->size(); i++) {
588 /* Iterate over actions in thread, starting from most recent */
589 action_list_t *list = &(*thrd_lists)[i];
590 action_list_t::reverse_iterator rit;
591 for (rit = list->rbegin(); rit != list->rend(); rit++) {
592 ModelAction *act = *rit;
594 /* Include at most one act per-thread that "happens before" curr */
595 if (act->happens_before(curr)) {
596 if (act->is_read()) {
597 const ModelAction *prevreadfrom = act->get_reads_from();
598 if (prevreadfrom != NULL && rf != prevreadfrom) {
599 mo_graph->addEdge(prevreadfrom, rf);
602 } else if (rf != act) {
603 mo_graph->addEdge(act, rf);
614 /** Updates the mo_graph with the constraints imposed from the current read. */
615 void ModelChecker::post_r_modification_order(ModelAction *curr, const ModelAction *rf)
617 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
619 ASSERT(curr->is_read());
621 /* Iterate over all threads */
622 for (i = 0; i < thrd_lists->size(); i++) {
623 /* Iterate over actions in thread, starting from most recent */
624 action_list_t *list = &(*thrd_lists)[i];
625 action_list_t::reverse_iterator rit;
626 ModelAction *lastact = NULL;
628 /* Find last action that happens after curr */
629 for (rit = list->rbegin(); rit != list->rend(); rit++) {
630 ModelAction *act = *rit;
631 if (curr->happens_before(act)) {
637 /* Include at most one act per-thread that "happens before" curr */
638 if (lastact != NULL) {
639 if (lastact->is_read()) {
640 const ModelAction *postreadfrom = lastact->get_reads_from();
641 if (postreadfrom != NULL&&rf != postreadfrom)
642 mo_graph->addEdge(rf, postreadfrom);
643 } else if (rf != lastact) {
644 mo_graph->addEdge(rf, lastact);
652 * Updates the mo_graph with the constraints imposed from the current write.
653 * @param curr The current action. Must be a write.
654 * @return True if modification order edges were added; false otherwise
656 bool ModelChecker::w_modification_order(ModelAction *curr)
658 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
661 ASSERT(curr->is_write());
663 if (curr->is_seqcst()) {
664 /* We have to at least see the last sequentially consistent write,
665 so we are initialized. */
666 ModelAction *last_seq_cst = get_last_seq_cst(curr->get_location());
667 if (last_seq_cst != NULL) {
668 mo_graph->addEdge(last_seq_cst, curr);
673 /* Iterate over all threads */
674 for (i = 0; i < thrd_lists->size(); i++) {
675 /* Iterate over actions in thread, starting from most recent */
676 action_list_t *list = &(*thrd_lists)[i];
677 action_list_t::reverse_iterator rit;
678 for (rit = list->rbegin(); rit != list->rend(); rit++) {
679 ModelAction *act = *rit;
681 /* Include at most one act per-thread that "happens before" curr */
682 if (act->happens_before(curr)) {
684 * Note: if act is RMW, just add edge:
686 * The following edge should be handled elsewhere:
687 * readfrom(act) --mo--> act
689 if (act->is_write()) {
690 //RMW shouldn't have an edge to themselves
692 mo_graph->addEdge(act, curr);
693 } else if (act->is_read() && act->get_reads_from() != NULL)
694 mo_graph->addEdge(act->get_reads_from(), curr);
697 } else if (act->is_read() && !act->is_synchronizing(curr) &&
698 !act->same_thread(curr)) {
699 /* We have an action that:
700 (1) did not happen before us
701 (2) is a read and we are a write
702 (3) cannot synchronize with us
703 (4) is in a different thread
705 that read could potentially read from our write.
707 if (isfeasible() && act->get_node()->add_future_value(curr->get_value(), curr->get_seq_number()+params.maxfuturedelay) &&
708 (!priv->next_backtrack || *act > *priv->next_backtrack))
709 priv->next_backtrack = act;
718 * Finds the head(s) of the release sequence(s) containing a given ModelAction.
719 * The ModelAction under consideration is expected to be taking part in
720 * release/acquire synchronization as an object of the "reads from" relation.
721 * Note that this can only provide release sequence support for RMW chains
722 * which do not read from the future, as those actions cannot be traced until
723 * their "promise" is fulfilled. Similarly, we may not even establish the
724 * presence of a release sequence with certainty, as some modification order
725 * constraints may be decided further in the future. Thus, this function
726 * "returns" two pieces of data: a pass-by-reference vector of @a release_heads
727 * and a boolean representing certainty.
729 * @todo Finish lazy updating, when promises are fulfilled in the future
730 * @param rf The action that might be part of a release sequence. Must be a
732 * @param release_heads A pass-by-reference style return parameter. After
733 * execution of this function, release_heads will contain the heads of all the
734 * relevant release sequences, if any exists
735 * @return true, if the ModelChecker is certain that release_heads is complete;
738 bool ModelChecker::release_seq_head(const ModelAction *rf,
739 std::vector<const ModelAction *> *release_heads) const
741 ASSERT(rf->is_write());
743 /* read from future: need to settle this later */
744 return false; /* incomplete */
746 if (rf->is_release())
747 release_heads->push_back(rf);
749 /* We need a RMW action that is both an acquire and release to stop */
750 /** @todo Need to be smarter here... In the linux lock
751 * example, this will run to the beginning of the program for
753 if (rf->is_acquire() && rf->is_release())
754 return true; /* complete */
755 return release_seq_head(rf->get_reads_from(), release_heads);
757 if (rf->is_release())
758 return true; /* complete */
760 /* else relaxed write; check modification order for contiguous subsequence
761 * -> rf must be same thread as release */
762 int tid = id_to_int(rf->get_tid());
763 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(rf->get_location());
764 action_list_t *list = &(*thrd_lists)[tid];
765 action_list_t::const_reverse_iterator rit;
767 /* Find rf in the thread list */
768 rit = std::find(list->rbegin(), list->rend(), rf);
769 ASSERT(rit != list->rend());
771 /* Find the last write/release */
772 for (; rit != list->rend(); rit++)
773 if ((*rit)->is_release())
775 if (rit == list->rend()) {
776 /* No write-release in this thread */
777 return true; /* complete */
779 ModelAction *release = *rit;
781 ASSERT(rf->same_thread(release));
784 for (unsigned int i = 0; i < thrd_lists->size(); i++) {
785 if (id_to_int(rf->get_tid()) == (int)i)
787 list = &(*thrd_lists)[i];
789 /* Can we ensure no future writes from this thread may break
790 * the release seq? */
791 bool future_ordered = false;
793 for (rit = list->rbegin(); rit != list->rend(); rit++) {
794 const ModelAction *act = *rit;
795 if (!act->is_write())
797 /* Reach synchronization -> this thread is complete */
798 if (act->happens_before(release))
800 if (rf->happens_before(act)) {
801 future_ordered = true;
805 /* Check modification order */
806 if (mo_graph->checkReachable(rf, act)) {
808 future_ordered = true;
811 if (mo_graph->checkReachable(act, release))
812 /* act --mo--> release */
814 if (mo_graph->checkReachable(release, act) &&
815 mo_graph->checkReachable(act, rf)) {
816 /* release --mo-> act --mo--> rf */
817 return true; /* complete */
822 return false; /* This thread is uncertain */
826 release_heads->push_back(release);
831 * A public interface for getting the release sequence head(s) with which a
832 * given ModelAction must synchronize. This function only returns a non-empty
833 * result when it can locate a release sequence head with certainty. Otherwise,
834 * it may mark the internal state of the ModelChecker so that it will handle
835 * the release sequence at a later time, causing @a act to update its
836 * synchronization at some later point in execution.
837 * @param act The 'acquire' action that may read from a release sequence
838 * @param release_heads A pass-by-reference return parameter. Will be filled
839 * with the head(s) of the release sequence(s), if they exists with certainty.
840 * @see ModelChecker::release_seq_head
842 void ModelChecker::get_release_seq_heads(ModelAction *act,
843 std::vector<const ModelAction *> *release_heads)
845 const ModelAction *rf = act->get_reads_from();
847 complete = release_seq_head(rf, release_heads);
849 /* add act to 'lazy checking' list */
850 std::list<ModelAction *> *list;
851 list = lazy_sync_with_release->get_safe_ptr(act->get_location());
852 list->push_back(act);
858 * Attempt to resolve all stashed operations that might synchronize with a
859 * release sequence for a given location. This implements the "lazy" portion of
860 * determining whether or not a release sequence was contiguous, since not all
861 * modification order information is present at the time an action occurs.
863 * @param location The location/object that should be checked for release
864 * sequence resolutions
865 * @return True if any updates occurred (new synchronization, new mo_graph edges)
867 bool ModelChecker::resolve_release_sequences(void *location)
869 std::list<ModelAction *> *list;
870 list = lazy_sync_with_release->getptr(location);
874 bool updated = false;
875 std::list<ModelAction *>::iterator it = list->begin();
876 while (it != list->end()) {
877 ModelAction *act = *it;
878 const ModelAction *rf = act->get_reads_from();
879 std::vector<const ModelAction *> release_heads;
881 complete = release_seq_head(rf, &release_heads);
882 for (unsigned int i = 0; i < release_heads.size(); i++) {
883 if (!act->has_synchronized_with(release_heads[i])) {
885 act->synchronize_with(release_heads[i]);
890 /* propagate synchronization to later actions */
891 action_list_t::reverse_iterator it = action_trace->rbegin();
892 while ((*it) != act) {
893 ModelAction *propagate = *it;
894 if (act->happens_before(propagate))
895 /** @todo new mo_graph edges along with
896 * this synchronization? */
897 propagate->synchronize_with(act);
901 it = list->erase(it);
907 // If we resolved promises or data races, see if we have realized a data race.
908 if (checkDataRaces()) {
916 * Performs various bookkeeping operations for the current ModelAction. For
917 * instance, adds action to the per-object, per-thread action vector and to the
918 * action trace list of all thread actions.
920 * @param act is the ModelAction to add.
922 void ModelChecker::add_action_to_lists(ModelAction *act)
924 int tid = id_to_int(act->get_tid());
925 action_trace->push_back(act);
927 obj_map->get_safe_ptr(act->get_location())->push_back(act);
929 std::vector<action_list_t> *vec = obj_thrd_map->get_safe_ptr(act->get_location());
930 if (tid >= (int)vec->size())
931 vec->resize(priv->next_thread_id);
932 (*vec)[tid].push_back(act);
934 if ((int)thrd_last_action->size() <= tid)
935 thrd_last_action->resize(get_num_threads());
936 (*thrd_last_action)[tid] = act;
939 ModelAction * ModelChecker::get_last_action(thread_id_t tid)
941 int nthreads = get_num_threads();
942 if ((int)thrd_last_action->size() < nthreads)
943 thrd_last_action->resize(nthreads);
944 return (*thrd_last_action)[id_to_int(tid)];
948 * Gets the last memory_order_seq_cst action (in the total global sequence)
949 * performed on a particular object (i.e., memory location).
950 * @param location The object location to check
951 * @return The last seq_cst action performed
953 ModelAction * ModelChecker::get_last_seq_cst(const void *location)
955 action_list_t *list = obj_map->get_safe_ptr(location);
956 /* Find: max({i in dom(S) | seq_cst(t_i) && isWrite(t_i) && samevar(t_i, t)}) */
957 action_list_t::reverse_iterator rit;
958 for (rit = list->rbegin(); rit != list->rend(); rit++)
959 if ((*rit)->is_write() && (*rit)->is_seqcst())
964 ModelAction * ModelChecker::get_parent_action(thread_id_t tid)
966 ModelAction *parent = get_last_action(tid);
968 parent = get_thread(tid)->get_creation();
973 * Returns the clock vector for a given thread.
974 * @param tid The thread whose clock vector we want
975 * @return Desired clock vector
977 ClockVector * ModelChecker::get_cv(thread_id_t tid)
979 return get_parent_action(tid)->get_cv();
983 * Resolve a set of Promises with a current write. The set is provided in the
984 * Node corresponding to @a write.
985 * @param write The ModelAction that is fulfilling Promises
986 * @return True if promises were resolved; false otherwise
988 bool ModelChecker::resolve_promises(ModelAction *write)
990 bool resolved = false;
991 for (unsigned int i = 0, promise_index = 0; promise_index < promises->size(); i++) {
992 Promise *promise = (*promises)[promise_index];
993 if (write->get_node()->get_promise(i)) {
994 ModelAction *read = promise->get_action();
995 read->read_from(write);
996 if (read->is_rmw()) {
997 mo_graph->addRMWEdge(write, read);
999 r_modification_order(read, write);
1000 post_r_modification_order(read, write);
1001 promises->erase(promises->begin() + promise_index);
1011 * Compute the set of promises that could potentially be satisfied by this
1012 * action. Note that the set computation actually appears in the Node, not in
1014 * @param curr The ModelAction that may satisfy promises
1016 void ModelChecker::compute_promises(ModelAction *curr)
1018 for (unsigned int i = 0; i < promises->size(); i++) {
1019 Promise *promise = (*promises)[i];
1020 const ModelAction *act = promise->get_action();
1021 if (!act->happens_before(curr) &&
1023 !act->is_synchronizing(curr) &&
1024 !act->same_thread(curr) &&
1025 promise->get_value() == curr->get_value()) {
1026 curr->get_node()->set_promise(i);
1031 /** Checks promises in response to change in ClockVector Threads. */
1032 void ModelChecker::check_promises(ClockVector *old_cv, ClockVector *merge_cv)
1034 for (unsigned int i = 0; i < promises->size(); i++) {
1035 Promise *promise = (*promises)[i];
1036 const ModelAction *act = promise->get_action();
1037 if ((old_cv == NULL || !old_cv->synchronized_since(act)) &&
1038 merge_cv->synchronized_since(act)) {
1039 //This thread is no longer able to send values back to satisfy the promise
1040 int num_synchronized_threads = promise->increment_threads();
1041 if (num_synchronized_threads == get_num_threads()) {
1042 //Promise has failed
1043 failed_promise = true;
1051 * Build up an initial set of all past writes that this 'read' action may read
1052 * from. This set is determined by the clock vector's "happens before"
1054 * @param curr is the current ModelAction that we are exploring; it must be a
1057 void ModelChecker::build_reads_from_past(ModelAction *curr)
1059 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
1061 ASSERT(curr->is_read());
1063 ModelAction *last_seq_cst = NULL;
1065 /* Track whether this object has been initialized */
1066 bool initialized = false;
1068 if (curr->is_seqcst()) {
1069 last_seq_cst = get_last_seq_cst(curr->get_location());
1070 /* We have to at least see the last sequentially consistent write,
1071 so we are initialized. */
1072 if (last_seq_cst != NULL)
1076 /* Iterate over all threads */
1077 for (i = 0; i < thrd_lists->size(); i++) {
1078 /* Iterate over actions in thread, starting from most recent */
1079 action_list_t *list = &(*thrd_lists)[i];
1080 action_list_t::reverse_iterator rit;
1081 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1082 ModelAction *act = *rit;
1084 /* Only consider 'write' actions */
1085 if (!act->is_write())
1088 /* Don't consider more than one seq_cst write if we are a seq_cst read. */
1089 if (!curr->is_seqcst()|| (!act->is_seqcst() && (last_seq_cst==NULL||!act->happens_before(last_seq_cst))) || act == last_seq_cst) {
1090 DEBUG("Adding action to may_read_from:\n");
1091 if (DBG_ENABLED()) {
1095 curr->get_node()->add_read_from(act);
1098 /* Include at most one act per-thread that "happens before" curr */
1099 if (act->happens_before(curr)) {
1107 /** @todo Need a more informative way of reporting errors. */
1108 printf("ERROR: may read from uninitialized atomic\n");
1111 if (DBG_ENABLED() || !initialized) {
1112 printf("Reached read action:\n");
1114 printf("Printing may_read_from\n");
1115 curr->get_node()->print_may_read_from();
1116 printf("End printing may_read_from\n");
1119 ASSERT(initialized);
1122 static void print_list(action_list_t *list)
1124 action_list_t::iterator it;
1126 printf("---------------------------------------------------------------------\n");
1129 for (it = list->begin(); it != list->end(); it++) {
1132 printf("---------------------------------------------------------------------\n");
1135 void ModelChecker::print_summary()
1138 printf("Number of executions: %d\n", num_executions);
1139 printf("Total nodes created: %d\n", node_stack->get_total_nodes());
1143 if (!isfinalfeasible())
1144 printf("INFEASIBLE EXECUTION!\n");
1145 print_list(action_trace);
1150 * Add a Thread to the system for the first time. Should only be called once
1152 * @param t The Thread to add
1154 void ModelChecker::add_thread(Thread *t)
1156 thread_map->put(id_to_int(t->get_id()), t);
1157 scheduler->add_thread(t);
1160 void ModelChecker::remove_thread(Thread *t)
1162 scheduler->remove_thread(t);
1166 * Switch from a user-context to the "master thread" context (a.k.a. system
1167 * context). This switch is made with the intention of exploring a particular
1168 * model-checking action (described by a ModelAction object). Must be called
1169 * from a user-thread context.
1170 * @param act The current action that will be explored. Must not be NULL.
1171 * @return Return status from the 'swap' call (i.e., success/fail, 0/-1)
1173 int ModelChecker::switch_to_master(ModelAction *act)
1176 Thread *old = thread_current();
1177 set_current_action(act);
1178 old->set_state(THREAD_READY);
1179 return Thread::swap(old, &system_context);
1183 * Takes the next step in the execution, if possible.
1184 * @return Returns true (success) if a step was taken and false otherwise.
1186 bool ModelChecker::take_step() {
1187 Thread *curr, *next;
1192 curr = thread_current();
1194 if (curr->get_state() == THREAD_READY) {
1195 ASSERT(priv->current_action);
1196 priv->nextThread = check_current_action(priv->current_action);
1197 priv->current_action = NULL;
1198 if (!curr->is_blocked() && !curr->is_complete())
1199 scheduler->add_thread(curr);
1204 next = scheduler->next_thread(priv->nextThread);
1206 /* Infeasible -> don't take any more steps */
1211 next->set_state(THREAD_RUNNING);
1212 DEBUG("(%d, %d)\n", curr ? curr->get_id() : -1, next ? next->get_id() : -1);
1214 /* next == NULL -> don't take any more steps */
1217 /* Return false only if swap fails with an error */
1218 return (Thread::swap(&system_context, next) == 0);
1221 /** Runs the current execution until threre are no more steps to take. */
1222 void ModelChecker::finish_execution() {
1225 while (take_step());