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()),
24 num_feasible_executions(0),
27 action_trace(new action_list_t()),
28 thread_map(new HashTable<int, Thread *, int>()),
29 obj_map(new HashTable<const void *, action_list_t, uintptr_t, 4>()),
30 obj_thrd_map(new HashTable<void *, std::vector<action_list_t>, uintptr_t, 4 >()),
31 promises(new std::vector<Promise *>()),
32 futurevalues(new std::vector<struct PendingFutureValue>()),
33 lazy_sync_with_release(new HashTable<void *, std::list<ModelAction *>, uintptr_t, 4>()),
34 thrd_last_action(new std::vector<ModelAction *>(1)),
35 node_stack(new NodeStack()),
36 mo_graph(new CycleGraph()),
37 failed_promise(false),
38 too_many_reads(false),
41 /* Allocate this "size" on the snapshotting heap */
42 priv = (struct model_snapshot_members *)calloc(1, sizeof(*priv));
43 /* First thread created will have id INITIAL_THREAD_ID */
44 priv->next_thread_id = INITIAL_THREAD_ID;
46 lazy_sync_size = &priv->lazy_sync_size;
49 /** @brief Destructor */
50 ModelChecker::~ModelChecker()
52 for (int i = 0; i < get_num_threads(); i++)
53 delete thread_map->get(i);
60 for (unsigned int i = 0; i < promises->size(); i++)
61 delete (*promises)[i];
64 delete lazy_sync_with_release;
66 delete thrd_last_action;
73 * Restores user program to initial state and resets all model-checker data
76 void ModelChecker::reset_to_initial_state()
78 DEBUG("+++ Resetting to initial state +++\n");
79 node_stack->reset_execution();
80 failed_promise = false;
81 too_many_reads = false;
83 snapshotObject->backTrackBeforeStep(0);
86 /** @returns a thread ID for a new Thread */
87 thread_id_t ModelChecker::get_next_id()
89 return priv->next_thread_id++;
92 /** @returns the number of user threads created during this execution */
93 int ModelChecker::get_num_threads()
95 return priv->next_thread_id;
98 /** @returns a sequence number for a new ModelAction */
99 modelclock_t ModelChecker::get_next_seq_num()
101 return ++priv->used_sequence_numbers;
105 * @brief Choose the next thread to execute.
107 * This function chooses the next thread that should execute. It can force the
108 * adjacency of read/write portions of a RMW action, force THREAD_CREATE to be
109 * followed by a THREAD_START, or it can enforce execution replay/backtracking.
110 * The model-checker may have no preference regarding the next thread (i.e.,
111 * when exploring a new execution ordering), in which case this will return
113 * @param curr The current ModelAction. This action might guide the choice of
115 * @return The next thread to run. If the model-checker has no preference, NULL.
117 Thread * ModelChecker::get_next_thread(ModelAction *curr)
121 /* Do not split atomic actions. */
123 return thread_current();
124 /* The THREAD_CREATE action points to the created Thread */
125 else if (curr->get_type() == THREAD_CREATE)
126 return (Thread *)curr->get_location();
128 /* Have we completed exploring the preselected path? */
132 /* Else, we are trying to replay an execution */
133 ModelAction *next = node_stack->get_next()->get_action();
135 if (next == diverge) {
136 Node *nextnode = next->get_node();
137 /* Reached divergence point */
138 if (nextnode->increment_promise()) {
139 /* The next node will try to satisfy a different set of promises. */
140 tid = next->get_tid();
141 node_stack->pop_restofstack(2);
142 } else if (nextnode->increment_read_from()) {
143 /* The next node will read from a different value. */
144 tid = next->get_tid();
145 node_stack->pop_restofstack(2);
146 } else if (nextnode->increment_future_value()) {
147 /* The next node will try to read from a different future value. */
148 tid = next->get_tid();
149 node_stack->pop_restofstack(2);
151 /* Make a different thread execute for next step */
152 Node *node = nextnode->get_parent();
153 tid = node->get_next_backtrack();
154 node_stack->pop_restofstack(1);
156 DEBUG("*** Divergence point ***\n");
159 tid = next->get_tid();
161 DEBUG("*** ModelChecker chose next thread = %d ***\n", tid);
162 ASSERT(tid != THREAD_ID_T_NONE);
163 return thread_map->get(id_to_int(tid));
167 * Queries the model-checker for more executions to explore and, if one
168 * exists, resets the model-checker state to execute a new execution.
170 * @return If there are more executions to explore, return true. Otherwise,
173 bool ModelChecker::next_execution()
178 if (isfinalfeasible())
179 num_feasible_executions++;
181 if (isfinalfeasible() || DBG_ENABLED())
184 if ((diverge = get_next_backtrack()) == NULL)
188 printf("Next execution will diverge at:\n");
192 reset_to_initial_state();
196 ModelAction * ModelChecker::get_last_conflict(ModelAction *act)
198 action_type type = act->get_type();
208 /* linear search: from most recent to oldest */
209 action_list_t *list = obj_map->get_safe_ptr(act->get_location());
210 action_list_t::reverse_iterator rit;
211 for (rit = list->rbegin(); rit != list->rend(); rit++) {
212 ModelAction *prev = *rit;
213 if (act->is_synchronizing(prev))
219 void ModelChecker::set_backtracking(ModelAction *act)
223 Thread *t = get_thread(act);
225 prev = get_last_conflict(act);
229 node = prev->get_node()->get_parent();
231 while (!node->is_enabled(t))
234 /* Check if this has been explored already */
235 if (node->has_been_explored(t->get_id()))
238 /* Cache the latest backtracking point */
239 if (!priv->next_backtrack || *prev > *priv->next_backtrack)
240 priv->next_backtrack = prev;
242 /* If this is a new backtracking point, mark the tree */
243 if (!node->set_backtrack(t->get_id()))
245 DEBUG("Setting backtrack: conflict = %d, instead tid = %d\n",
246 prev->get_tid(), t->get_id());
254 * Returns last backtracking point. The model checker will explore a different
255 * path for this point in the next execution.
256 * @return The ModelAction at which the next execution should diverge.
258 ModelAction * ModelChecker::get_next_backtrack()
260 ModelAction *next = priv->next_backtrack;
261 priv->next_backtrack = NULL;
266 * Processes a read or rmw model action.
267 * @param curr is the read model action to process.
268 * @param second_part_of_rmw is boolean that is true is this is the second action of a rmw.
269 * @return True if processing this read updates the mo_graph.
271 bool ModelChecker::process_read(ModelAction *curr, bool second_part_of_rmw)
274 bool updated = false;
276 const ModelAction *reads_from = curr->get_node()->get_read_from();
277 if (reads_from != NULL) {
278 mo_graph->startChanges();
280 value = reads_from->get_value();
281 bool r_status = false;
283 if (!second_part_of_rmw) {
285 r_status = r_modification_order(curr, reads_from);
289 if (!second_part_of_rmw&&!isfeasible()&&(curr->get_node()->increment_read_from()||curr->get_node()->increment_future_value())) {
290 mo_graph->rollbackChanges();
291 too_many_reads = false;
295 curr->read_from(reads_from);
296 mo_graph->commitChanges();
298 } else if (!second_part_of_rmw) {
299 /* Read from future value */
300 value = curr->get_node()->get_future_value();
301 modelclock_t expiration = curr->get_node()->get_future_value_expiration();
302 curr->read_from(NULL);
303 Promise *valuepromise = new Promise(curr, value, expiration);
304 promises->push_back(valuepromise);
306 get_thread(curr)->set_return_value(value);
312 * Process a write ModelAction
313 * @param curr The ModelAction to process
314 * @return True if the mo_graph was updated or promises were resolved
316 bool ModelChecker::process_write(ModelAction *curr)
318 bool updated_mod_order = w_modification_order(curr);
319 bool updated_promises = resolve_promises(curr);
321 if (promises->size() == 0) {
322 for (unsigned int i = 0; i<futurevalues->size(); i++) {
323 struct PendingFutureValue pfv = (*futurevalues)[i];
324 if (pfv.act->get_node()->add_future_value(pfv.value, pfv.expiration) &&
325 (!priv->next_backtrack || *pfv.act > *priv->next_backtrack))
326 priv->next_backtrack = pfv.act;
328 futurevalues->resize(0);
331 mo_graph->commitChanges();
332 get_thread(curr)->set_return_value(VALUE_NONE);
333 return updated_mod_order || updated_promises;
337 * This is the heart of the model checker routine. It performs model-checking
338 * actions corresponding to a given "current action." Among other processes, it
339 * calculates reads-from relationships, updates synchronization clock vectors,
340 * forms a memory_order constraints graph, and handles replay/backtrack
341 * execution when running permutations of previously-observed executions.
343 * @param curr The current action to process
344 * @return The next Thread that must be executed. May be NULL if ModelChecker
345 * makes no choice (e.g., according to replay execution, combining RMW actions,
348 Thread * ModelChecker::check_current_action(ModelAction *curr)
350 bool second_part_of_rmw = false;
354 if (curr->is_rmwc() || curr->is_rmw()) {
355 ModelAction *tmp = process_rmw(curr);
356 second_part_of_rmw = true;
359 compute_promises(curr);
361 ModelAction *tmp = node_stack->explore_action(curr);
363 /* Discard duplicate ModelAction; use action from NodeStack */
364 /* First restore type and order in case of RMW operation */
366 tmp->copy_typeandorder(curr);
368 /* If we have diverged, we need to reset the clock vector. */
370 tmp->create_cv(get_parent_action(tmp->get_tid()));
376 * Perform one-time actions when pushing new ModelAction onto
379 curr->create_cv(get_parent_action(curr->get_tid()));
380 /* Build may_read_from set */
382 build_reads_from_past(curr);
383 if (curr->is_write())
384 compute_promises(curr);
388 /* Thread specific actions */
389 switch (curr->get_type()) {
390 case THREAD_CREATE: {
391 Thread *th = (Thread *)curr->get_location();
392 th->set_creation(curr);
396 Thread *waiting, *blocking;
397 waiting = get_thread(curr);
398 blocking = (Thread *)curr->get_location();
399 if (!blocking->is_complete()) {
400 blocking->push_wait_list(curr);
401 scheduler->sleep(waiting);
405 case THREAD_FINISH: {
406 Thread *th = get_thread(curr);
407 while (!th->wait_list_empty()) {
408 ModelAction *act = th->pop_wait_list();
409 Thread *wake = get_thread(act);
410 scheduler->wake(wake);
416 check_promises(NULL, curr->get_cv());
423 /* Add current action to lists before work_queue loop */
424 if (!second_part_of_rmw)
425 add_action_to_lists(curr);
427 work_queue_t work_queue(1, CheckCurrWorkEntry(curr));
429 while (!work_queue.empty()) {
430 WorkQueueEntry work = work_queue.front();
431 work_queue.pop_front();
434 case WORK_CHECK_CURR_ACTION: {
435 ModelAction *act = work.action;
436 bool updated = false;
437 if (act->is_read() && process_read(act, second_part_of_rmw))
440 if (act->is_write() && process_write(act))
444 work_queue.push_back(CheckRelSeqWorkEntry(act->get_location()));
447 case WORK_CHECK_RELEASE_SEQ:
448 resolve_release_sequences(work.location, &work_queue);
450 case WORK_CHECK_MO_EDGES:
451 /** @todo Perform follow-up mo_graph checks */
458 check_curr_backtracking(curr);
460 set_backtracking(curr);
462 return get_next_thread(curr);
465 void ModelChecker::check_curr_backtracking(ModelAction * curr) {
466 Node *currnode = curr->get_node();
467 Node *parnode = currnode->get_parent();
469 if ((!parnode->backtrack_empty() ||
470 !currnode->read_from_empty() ||
471 !currnode->future_value_empty() ||
472 !currnode->promise_empty())
473 && (!priv->next_backtrack ||
474 *curr > *priv->next_backtrack)) {
475 priv->next_backtrack = curr;
479 bool ModelChecker::promises_expired() {
480 for (unsigned int promise_index = 0; promise_index < promises->size(); promise_index++) {
481 Promise *promise = (*promises)[promise_index];
482 if (promise->get_expiration()<priv->used_sequence_numbers) {
489 /** @returns whether the current partial trace must be a prefix of a
491 bool ModelChecker::isfeasibleprefix() {
492 return promises->size() == 0 && *lazy_sync_size == 0;
495 /** @returns whether the current partial trace is feasible. */
496 bool ModelChecker::isfeasible() {
497 return !mo_graph->checkForRMWViolation() && isfeasibleotherthanRMW();
500 /** @returns whether the current partial trace is feasible other than
501 * multiple RMW reading from the same store. */
502 bool ModelChecker::isfeasibleotherthanRMW() {
503 return !mo_graph->checkForCycles() && !failed_promise && !too_many_reads && !promises_expired();
506 /** Returns whether the current completed trace is feasible. */
507 bool ModelChecker::isfinalfeasible() {
508 return isfeasible() && promises->size() == 0;
511 /** Close out a RMWR by converting previous RMWR into a RMW or READ. */
512 ModelAction * ModelChecker::process_rmw(ModelAction *act) {
513 int tid = id_to_int(act->get_tid());
514 ModelAction *lastread = get_last_action(tid);
515 lastread->process_rmw(act);
516 if (act->is_rmw() && lastread->get_reads_from()!=NULL) {
517 mo_graph->addRMWEdge(lastread->get_reads_from(), lastread);
518 mo_graph->commitChanges();
524 * Checks whether a thread has read from the same write for too many times
525 * without seeing the effects of a later write.
528 * 1) there must a different write that we could read from that would satisfy the modification order,
529 * 2) we must have read from the same value in excess of maxreads times, and
530 * 3) that other write must have been in the reads_from set for maxreads times.
532 * If so, we decide that the execution is no longer feasible.
534 void ModelChecker::check_recency(ModelAction *curr) {
535 if (params.maxreads != 0) {
536 if (curr->get_node()->get_read_from_size() <= 1)
539 //Must make sure that execution is currently feasible... We could
540 //accidentally clear by rolling back
544 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
545 int tid = id_to_int(curr->get_tid());
548 if ((int)thrd_lists->size() <= tid)
551 action_list_t *list = &(*thrd_lists)[tid];
553 action_list_t::reverse_iterator rit = list->rbegin();
555 for (; (*rit) != curr; rit++)
557 /* go past curr now */
560 action_list_t::reverse_iterator ritcopy = rit;
561 //See if we have enough reads from the same value
563 for (; count < params.maxreads; rit++,count++) {
564 if (rit==list->rend())
566 ModelAction *act = *rit;
569 if (act->get_reads_from() != curr->get_reads_from())
571 if (act->get_node()->get_read_from_size() <= 1)
575 for (int i = 0; i<curr->get_node()->get_read_from_size(); i++) {
577 const ModelAction * write = curr->get_node()->get_read_from_at(i);
578 //Need a different write
579 if (write==curr->get_reads_from())
582 /* Test to see whether this is a feasible write to read from*/
583 mo_graph->startChanges();
584 r_modification_order(curr, write);
585 bool feasiblereadfrom = isfeasible();
586 mo_graph->rollbackChanges();
588 if (!feasiblereadfrom)
592 bool feasiblewrite = true;
593 //new we need to see if this write works for everyone
595 for (int loop = count; loop>0; loop--,rit++) {
596 ModelAction *act=*rit;
597 bool foundvalue = false;
598 for (int j = 0; j<act->get_node()->get_read_from_size(); j++) {
599 if (act->get_node()->get_read_from_at(i)==write) {
605 feasiblewrite = false;
610 too_many_reads = true;
618 * Updates the mo_graph with the constraints imposed from the current
621 * Basic idea is the following: Go through each other thread and find
622 * the lastest action that happened before our read. Two cases:
624 * (1) The action is a write => that write must either occur before
625 * the write we read from or be the write we read from.
627 * (2) The action is a read => the write that that action read from
628 * must occur before the write we read from or be the same write.
630 * @param curr The current action. Must be a read.
631 * @param rf The action that curr reads from. Must be a write.
632 * @return True if modification order edges were added; false otherwise
634 bool ModelChecker::r_modification_order(ModelAction *curr, const ModelAction *rf)
636 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
639 ASSERT(curr->is_read());
641 /* Iterate over all threads */
642 for (i = 0; i < thrd_lists->size(); i++) {
643 /* Iterate over actions in thread, starting from most recent */
644 action_list_t *list = &(*thrd_lists)[i];
645 action_list_t::reverse_iterator rit;
646 for (rit = list->rbegin(); rit != list->rend(); rit++) {
647 ModelAction *act = *rit;
650 * Include at most one act per-thread that "happens
651 * before" curr. Don't consider reflexively.
653 if (act->happens_before(curr) && act != curr) {
654 if (act->is_write()) {
656 mo_graph->addEdge(act, rf);
660 const ModelAction *prevreadfrom = act->get_reads_from();
661 if (prevreadfrom != NULL && rf != prevreadfrom) {
662 mo_graph->addEdge(prevreadfrom, rf);
674 /** This method fixes up the modification order when we resolve a
675 * promises. The basic problem is that actions that occur after the
676 * read curr could not property add items to the modification order
679 * So for each thread, we find the earliest item that happens after
680 * the read curr. This is the item we have to fix up with additional
681 * constraints. If that action is write, we add a MO edge between
682 * the Action rf and that action. If the action is a read, we add a
683 * MO edge between the Action rf, and whatever the read accessed.
685 * @param curr is the read ModelAction that we are fixing up MO edges for.
686 * @param rf is the write ModelAction that curr reads from.
690 void ModelChecker::post_r_modification_order(ModelAction *curr, const ModelAction *rf)
692 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
694 ASSERT(curr->is_read());
696 /* Iterate over all threads */
697 for (i = 0; i < thrd_lists->size(); i++) {
698 /* Iterate over actions in thread, starting from most recent */
699 action_list_t *list = &(*thrd_lists)[i];
700 action_list_t::reverse_iterator rit;
701 ModelAction *lastact = NULL;
703 /* Find last action that happens after curr */
704 for (rit = list->rbegin(); rit != list->rend(); rit++) {
705 ModelAction *act = *rit;
706 if (curr->happens_before(act)) {
712 /* Include at most one act per-thread that "happens before" curr */
713 if (lastact != NULL) {
714 if (lastact->is_read()) {
715 const ModelAction *postreadfrom = lastact->get_reads_from();
716 if (postreadfrom != NULL&&rf != postreadfrom)
717 mo_graph->addEdge(rf, postreadfrom);
718 } else if (rf != lastact) {
719 mo_graph->addEdge(rf, lastact);
727 * Updates the mo_graph with the constraints imposed from the current write.
729 * Basic idea is the following: Go through each other thread and find
730 * the lastest action that happened before our write. Two cases:
732 * (1) The action is a write => that write must occur before
735 * (2) The action is a read => the write that that action read from
736 * must occur before the current write.
738 * This method also handles two other issues:
740 * (I) Sequential Consistency: Making sure that if the current write is
741 * seq_cst, that it occurs after the previous seq_cst write.
743 * (II) Sending the write back to non-synchronizing reads.
745 * @param curr The current action. Must be a write.
746 * @return True if modification order edges were added; false otherwise
748 bool ModelChecker::w_modification_order(ModelAction *curr)
750 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
753 ASSERT(curr->is_write());
755 if (curr->is_seqcst()) {
756 /* We have to at least see the last sequentially consistent write,
757 so we are initialized. */
758 ModelAction *last_seq_cst = get_last_seq_cst(curr);
759 if (last_seq_cst != NULL) {
760 mo_graph->addEdge(last_seq_cst, curr);
765 /* Iterate over all threads */
766 for (i = 0; i < thrd_lists->size(); i++) {
767 /* Iterate over actions in thread, starting from most recent */
768 action_list_t *list = &(*thrd_lists)[i];
769 action_list_t::reverse_iterator rit;
770 for (rit = list->rbegin(); rit != list->rend(); rit++) {
771 ModelAction *act = *rit;
774 * Include at most one act per-thread that "happens
775 * before" curr. Only consider reflexively if curr is
778 if (act->happens_before(curr) && (act != curr || curr->is_rmw())) {
780 * Note: if act is RMW, just add edge:
782 * The following edge should be handled elsewhere:
783 * readfrom(act) --mo--> act
785 if (act->is_write()) {
786 //RMW shouldn't have an edge to themselves
788 mo_graph->addEdge(act, curr);
789 } else if (act->is_read() && act->get_reads_from() != NULL)
790 mo_graph->addEdge(act->get_reads_from(), curr);
793 } else if (act->is_read() && !act->is_synchronizing(curr) &&
794 !act->same_thread(curr)) {
795 /* We have an action that:
796 (1) did not happen before us
797 (2) is a read and we are a write
798 (3) cannot synchronize with us
799 (4) is in a different thread
801 that read could potentially read from our write.
803 if (thin_air_constraint_may_allow(curr, act)) {
805 (curr->is_rmw() && act->is_rmw() && curr->get_reads_from()==act->get_reads_from() && isfeasibleotherthanRMW())) {
806 struct PendingFutureValue pfv = {curr->get_value(),curr->get_seq_number()+params.maxfuturedelay,act};
807 futurevalues->push_back(pfv);
817 /** Arbitrary reads from the future are not allowed. Section 29.3
818 * part 9 places some constraints. This method checks one result of constraint
819 * constraint. Others require compiler support. */
821 bool ModelChecker::thin_air_constraint_may_allow(const ModelAction * writer, const ModelAction *reader) {
822 if (!writer->is_rmw())
825 if (!reader->is_rmw())
828 for (const ModelAction *search = writer->get_reads_from(); search != NULL; search = search->get_reads_from()) {
831 if (search->get_tid() == reader->get_tid() &&
832 search->happens_before(reader))
840 * Finds the head(s) of the release sequence(s) containing a given ModelAction.
841 * The ModelAction under consideration is expected to be taking part in
842 * release/acquire synchronization as an object of the "reads from" relation.
843 * Note that this can only provide release sequence support for RMW chains
844 * which do not read from the future, as those actions cannot be traced until
845 * their "promise" is fulfilled. Similarly, we may not even establish the
846 * presence of a release sequence with certainty, as some modification order
847 * constraints may be decided further in the future. Thus, this function
848 * "returns" two pieces of data: a pass-by-reference vector of @a release_heads
849 * and a boolean representing certainty.
851 * @todo Finish lazy updating, when promises are fulfilled in the future
852 * @param rf The action that might be part of a release sequence. Must be a
854 * @param release_heads A pass-by-reference style return parameter. After
855 * execution of this function, release_heads will contain the heads of all the
856 * relevant release sequences, if any exists
857 * @return true, if the ModelChecker is certain that release_heads is complete;
860 bool ModelChecker::release_seq_head(const ModelAction *rf,
861 std::vector< const ModelAction *, MyAlloc<const ModelAction *> > *release_heads) const
864 /* read from future: need to settle this later */
865 return false; /* incomplete */
868 ASSERT(rf->is_write());
870 if (rf->is_release())
871 release_heads->push_back(rf);
873 /* We need a RMW action that is both an acquire and release to stop */
874 /** @todo Need to be smarter here... In the linux lock
875 * example, this will run to the beginning of the program for
877 if (rf->is_acquire() && rf->is_release())
878 return true; /* complete */
879 return release_seq_head(rf->get_reads_from(), release_heads);
881 if (rf->is_release())
882 return true; /* complete */
884 /* else relaxed write; check modification order for contiguous subsequence
885 * -> rf must be same thread as release */
886 int tid = id_to_int(rf->get_tid());
887 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(rf->get_location());
888 action_list_t *list = &(*thrd_lists)[tid];
889 action_list_t::const_reverse_iterator rit;
891 /* Find rf in the thread list */
892 rit = std::find(list->rbegin(), list->rend(), rf);
893 ASSERT(rit != list->rend());
895 /* Find the last write/release */
896 for (; rit != list->rend(); rit++)
897 if ((*rit)->is_release())
899 if (rit == list->rend()) {
900 /* No write-release in this thread */
901 return true; /* complete */
903 ModelAction *release = *rit;
905 ASSERT(rf->same_thread(release));
908 for (unsigned int i = 0; i < thrd_lists->size(); i++) {
909 if (id_to_int(rf->get_tid()) == (int)i)
911 list = &(*thrd_lists)[i];
913 /* Can we ensure no future writes from this thread may break
914 * the release seq? */
915 bool future_ordered = false;
917 for (rit = list->rbegin(); rit != list->rend(); rit++) {
918 const ModelAction *act = *rit;
919 if (!act->is_write())
921 /* Reach synchronization -> this thread is complete */
922 if (act->happens_before(release))
924 if (rf->happens_before(act)) {
925 future_ordered = true;
929 /* Check modification order */
930 if (mo_graph->checkReachable(rf, act)) {
932 future_ordered = true;
935 if (mo_graph->checkReachable(act, release))
936 /* act --mo--> release */
938 if (mo_graph->checkReachable(release, act) &&
939 mo_graph->checkReachable(act, rf)) {
940 /* release --mo-> act --mo--> rf */
941 return true; /* complete */
946 return false; /* This thread is uncertain */
950 release_heads->push_back(release);
955 * A public interface for getting the release sequence head(s) with which a
956 * given ModelAction must synchronize. This function only returns a non-empty
957 * result when it can locate a release sequence head with certainty. Otherwise,
958 * it may mark the internal state of the ModelChecker so that it will handle
959 * the release sequence at a later time, causing @a act to update its
960 * synchronization at some later point in execution.
961 * @param act The 'acquire' action that may read from a release sequence
962 * @param release_heads A pass-by-reference return parameter. Will be filled
963 * with the head(s) of the release sequence(s), if they exists with certainty.
964 * @see ModelChecker::release_seq_head
966 void ModelChecker::get_release_seq_heads(ModelAction *act,
967 std::vector< const ModelAction *, MyAlloc<const ModelAction *> > *release_heads)
969 const ModelAction *rf = act->get_reads_from();
971 complete = release_seq_head(rf, release_heads);
973 /* add act to 'lazy checking' list */
974 std::list<ModelAction *> *list;
975 list = lazy_sync_with_release->get_safe_ptr(act->get_location());
976 list->push_back(act);
982 * Attempt to resolve all stashed operations that might synchronize with a
983 * release sequence for a given location. This implements the "lazy" portion of
984 * determining whether or not a release sequence was contiguous, since not all
985 * modification order information is present at the time an action occurs.
987 * @param location The location/object that should be checked for release
988 * sequence resolutions
989 * @param work_queue The work queue to which to add work items as they are
991 * @return True if any updates occurred (new synchronization, new mo_graph
994 bool ModelChecker::resolve_release_sequences(void *location, work_queue_t *work_queue)
996 std::list<ModelAction *> *list;
997 list = lazy_sync_with_release->getptr(location);
1001 bool updated = false;
1002 std::list<ModelAction *>::iterator it = list->begin();
1003 while (it != list->end()) {
1004 ModelAction *act = *it;
1005 const ModelAction *rf = act->get_reads_from();
1006 std::vector< const ModelAction *, MyAlloc<const ModelAction *> > release_heads;
1008 complete = release_seq_head(rf, &release_heads);
1009 for (unsigned int i = 0; i < release_heads.size(); i++) {
1010 if (!act->has_synchronized_with(release_heads[i])) {
1012 act->synchronize_with(release_heads[i]);
1017 /* Re-check act for mo_graph edges */
1018 work_queue->push_back(MOEdgeWorkEntry(act));
1020 /* propagate synchronization to later actions */
1021 action_list_t::reverse_iterator it = action_trace->rbegin();
1022 while ((*it) != act) {
1023 ModelAction *propagate = *it;
1024 if (act->happens_before(propagate)) {
1025 propagate->synchronize_with(act);
1026 /* Re-check 'propagate' for mo_graph edges */
1027 work_queue->push_back(MOEdgeWorkEntry(propagate));
1032 it = list->erase(it);
1033 (*lazy_sync_size)--;
1038 // If we resolved promises or data races, see if we have realized a data race.
1039 if (checkDataRaces()) {
1047 * Performs various bookkeeping operations for the current ModelAction. For
1048 * instance, adds action to the per-object, per-thread action vector and to the
1049 * action trace list of all thread actions.
1051 * @param act is the ModelAction to add.
1053 void ModelChecker::add_action_to_lists(ModelAction *act)
1055 int tid = id_to_int(act->get_tid());
1056 action_trace->push_back(act);
1058 obj_map->get_safe_ptr(act->get_location())->push_back(act);
1060 std::vector<action_list_t> *vec = obj_thrd_map->get_safe_ptr(act->get_location());
1061 if (tid >= (int)vec->size())
1062 vec->resize(priv->next_thread_id);
1063 (*vec)[tid].push_back(act);
1065 if ((int)thrd_last_action->size() <= tid)
1066 thrd_last_action->resize(get_num_threads());
1067 (*thrd_last_action)[tid] = act;
1070 ModelAction * ModelChecker::get_last_action(thread_id_t tid)
1072 int nthreads = get_num_threads();
1073 if ((int)thrd_last_action->size() < nthreads)
1074 thrd_last_action->resize(nthreads);
1075 return (*thrd_last_action)[id_to_int(tid)];
1079 * Gets the last memory_order_seq_cst write (in the total global sequence)
1080 * performed on a particular object (i.e., memory location), not including the
1082 * @param curr The current ModelAction; also denotes the object location to
1084 * @return The last seq_cst write
1086 ModelAction * ModelChecker::get_last_seq_cst(ModelAction *curr)
1088 void *location = curr->get_location();
1089 action_list_t *list = obj_map->get_safe_ptr(location);
1090 /* Find: max({i in dom(S) | seq_cst(t_i) && isWrite(t_i) && samevar(t_i, t)}) */
1091 action_list_t::reverse_iterator rit;
1092 for (rit = list->rbegin(); rit != list->rend(); rit++)
1093 if ((*rit)->is_write() && (*rit)->is_seqcst() && (*rit) != curr)
1098 ModelAction * ModelChecker::get_parent_action(thread_id_t tid)
1100 ModelAction *parent = get_last_action(tid);
1102 parent = get_thread(tid)->get_creation();
1107 * Returns the clock vector for a given thread.
1108 * @param tid The thread whose clock vector we want
1109 * @return Desired clock vector
1111 ClockVector * ModelChecker::get_cv(thread_id_t tid)
1113 return get_parent_action(tid)->get_cv();
1117 * Resolve a set of Promises with a current write. The set is provided in the
1118 * Node corresponding to @a write.
1119 * @param write The ModelAction that is fulfilling Promises
1120 * @return True if promises were resolved; false otherwise
1122 bool ModelChecker::resolve_promises(ModelAction *write)
1124 bool resolved = false;
1126 for (unsigned int i = 0, promise_index = 0; promise_index < promises->size(); i++) {
1127 Promise *promise = (*promises)[promise_index];
1128 if (write->get_node()->get_promise(i)) {
1129 ModelAction *read = promise->get_action();
1130 read->read_from(write);
1131 if (read->is_rmw()) {
1132 mo_graph->addRMWEdge(write, read);
1134 //First fix up the modification order for actions that happened
1136 r_modification_order(read, write);
1137 //Next fix up the modification order for actions that happened
1139 post_r_modification_order(read, write);
1140 promises->erase(promises->begin() + promise_index);
1149 * Compute the set of promises that could potentially be satisfied by this
1150 * action. Note that the set computation actually appears in the Node, not in
1152 * @param curr The ModelAction that may satisfy promises
1154 void ModelChecker::compute_promises(ModelAction *curr)
1156 for (unsigned int i = 0; i < promises->size(); i++) {
1157 Promise *promise = (*promises)[i];
1158 const ModelAction *act = promise->get_action();
1159 if (!act->happens_before(curr) &&
1161 !act->is_synchronizing(curr) &&
1162 !act->same_thread(curr) &&
1163 promise->get_value() == curr->get_value()) {
1164 curr->get_node()->set_promise(i);
1169 /** Checks promises in response to change in ClockVector Threads. */
1170 void ModelChecker::check_promises(ClockVector *old_cv, ClockVector *merge_cv)
1172 for (unsigned int i = 0; i < promises->size(); i++) {
1173 Promise *promise = (*promises)[i];
1174 const ModelAction *act = promise->get_action();
1175 if ((old_cv == NULL || !old_cv->synchronized_since(act)) &&
1176 merge_cv->synchronized_since(act)) {
1177 //This thread is no longer able to send values back to satisfy the promise
1178 int num_synchronized_threads = promise->increment_threads();
1179 if (num_synchronized_threads == get_num_threads()) {
1180 //Promise has failed
1181 failed_promise = true;
1189 * Build up an initial set of all past writes that this 'read' action may read
1190 * from. This set is determined by the clock vector's "happens before"
1192 * @param curr is the current ModelAction that we are exploring; it must be a
1195 void ModelChecker::build_reads_from_past(ModelAction *curr)
1197 std::vector<action_list_t> *thrd_lists = obj_thrd_map->get_safe_ptr(curr->get_location());
1199 ASSERT(curr->is_read());
1201 ModelAction *last_seq_cst = NULL;
1203 /* Track whether this object has been initialized */
1204 bool initialized = false;
1206 if (curr->is_seqcst()) {
1207 last_seq_cst = get_last_seq_cst(curr);
1208 /* We have to at least see the last sequentially consistent write,
1209 so we are initialized. */
1210 if (last_seq_cst != NULL)
1214 /* Iterate over all threads */
1215 for (i = 0; i < thrd_lists->size(); i++) {
1216 /* Iterate over actions in thread, starting from most recent */
1217 action_list_t *list = &(*thrd_lists)[i];
1218 action_list_t::reverse_iterator rit;
1219 for (rit = list->rbegin(); rit != list->rend(); rit++) {
1220 ModelAction *act = *rit;
1222 /* Only consider 'write' actions */
1223 if (!act->is_write())
1226 /* Don't consider more than one seq_cst write if we are a seq_cst read. */
1227 if (!curr->is_seqcst()|| (!act->is_seqcst() && (last_seq_cst==NULL||!act->happens_before(last_seq_cst))) || act == last_seq_cst) {
1228 DEBUG("Adding action to may_read_from:\n");
1229 if (DBG_ENABLED()) {
1233 curr->get_node()->add_read_from(act);
1236 /* Include at most one act per-thread that "happens before" curr */
1237 if (act->happens_before(curr)) {
1245 /** @todo Need a more informative way of reporting errors. */
1246 printf("ERROR: may read from uninitialized atomic\n");
1249 if (DBG_ENABLED() || !initialized) {
1250 printf("Reached read action:\n");
1252 printf("Printing may_read_from\n");
1253 curr->get_node()->print_may_read_from();
1254 printf("End printing may_read_from\n");
1257 ASSERT(initialized);
1260 static void print_list(action_list_t *list)
1262 action_list_t::iterator it;
1264 printf("---------------------------------------------------------------------\n");
1267 for (it = list->begin(); it != list->end(); it++) {
1270 printf("---------------------------------------------------------------------\n");
1273 void ModelChecker::print_summary()
1276 printf("Number of executions: %d\n", num_executions);
1277 printf("Number of feasible executions: %d\n", num_feasible_executions);
1278 printf("Total nodes created: %d\n", node_stack->get_total_nodes());
1280 #if SUPPORT_MOD_ORDER_DUMP
1282 char buffername[100];
1283 sprintf(buffername, "exec%u",num_executions);
1284 mo_graph->dumpGraphToFile(buffername);
1287 if (!isfinalfeasible())
1288 printf("INFEASIBLE EXECUTION!\n");
1289 print_list(action_trace);
1294 * Add a Thread to the system for the first time. Should only be called once
1296 * @param t The Thread to add
1298 void ModelChecker::add_thread(Thread *t)
1300 thread_map->put(id_to_int(t->get_id()), t);
1301 scheduler->add_thread(t);
1304 void ModelChecker::remove_thread(Thread *t)
1306 scheduler->remove_thread(t);
1310 * Switch from a user-context to the "master thread" context (a.k.a. system
1311 * context). This switch is made with the intention of exploring a particular
1312 * model-checking action (described by a ModelAction object). Must be called
1313 * from a user-thread context.
1314 * @param act The current action that will be explored. Must not be NULL.
1315 * @return Return status from the 'swap' call (i.e., success/fail, 0/-1)
1317 int ModelChecker::switch_to_master(ModelAction *act)
1320 Thread *old = thread_current();
1321 set_current_action(act);
1322 old->set_state(THREAD_READY);
1323 return Thread::swap(old, &system_context);
1327 * Takes the next step in the execution, if possible.
1328 * @return Returns true (success) if a step was taken and false otherwise.
1330 bool ModelChecker::take_step() {
1331 Thread *curr, *next;
1336 curr = thread_current();
1338 if (curr->get_state() == THREAD_READY) {
1339 ASSERT(priv->current_action);
1341 priv->nextThread = check_current_action(priv->current_action);
1342 priv->current_action = NULL;
1343 if (!curr->is_blocked() && !curr->is_complete())
1344 scheduler->add_thread(curr);
1349 next = scheduler->next_thread(priv->nextThread);
1351 /* Infeasible -> don't take any more steps */
1356 next->set_state(THREAD_RUNNING);
1357 DEBUG("(%d, %d)\n", curr ? curr->get_id() : -1, next ? next->get_id() : -1);
1359 /* next == NULL -> don't take any more steps */
1362 /* Return false only if swap fails with an error */
1363 return (Thread::swap(&system_context, next) == 0);
1366 /** Runs the current execution until threre are no more steps to take. */
1367 void ModelChecker::finish_execution() {
1370 while (take_step());