model: group snapshottable ModelChecker members in struct
[c11tester.git] / model.cc
index 6ded3f5d0ee1edeeb5f7b5e711a8f91396fd9523..43530fe12c25e2ecafa4af78cbb5eb3008b6190d 100644 (file)
--- a/model.cc
+++ b/model.cc
@@ -1,4 +1,5 @@
 #include <stdio.h>
+#include <algorithm>
 
 #include "model.h"
 #include "action.h"
@@ -9,6 +10,7 @@
 #include "clockvector.h"
 #include "cyclegraph.h"
 #include "promise.h"
+#include "datarace.h"
 
 #define INITIAL_THREAD_ID      0
 
@@ -18,14 +20,9 @@ ModelChecker *model;
 ModelChecker::ModelChecker(struct model_params params) :
        /* Initialize default scheduler */
        scheduler(new Scheduler()),
-       /* First thread created will have id INITIAL_THREAD_ID */
-       next_thread_id(INITIAL_THREAD_ID),
-       used_sequence_numbers(0),
        num_executions(0),
        params(params),
-       current_action(NULL),
        diverge(NULL),
-       nextThread(THREAD_ID_T_NONE),
        action_trace(new action_list_t()),
        thread_map(new HashTable<int, Thread *, int>()),
        obj_map(new HashTable<const void *, action_list_t, uintptr_t, 4>()),
@@ -34,10 +31,14 @@ ModelChecker::ModelChecker(struct model_params params) :
        lazy_sync_with_release(new HashTable<void *, std::list<ModelAction *>, uintptr_t, 4>()),
        thrd_last_action(new std::vector<ModelAction *>(1)),
        node_stack(new NodeStack()),
-       next_backtrack(NULL),
        mo_graph(new CycleGraph()),
-       failed_promise(false)
+       failed_promise(false),
+       asserted(false)
 {
+       /* Allocate this "size" on the snapshotting heap */
+       priv = (struct model_snapshot_members *)calloc(1, sizeof(*priv));
+       /* First thread created will have id INITIAL_THREAD_ID */
+       priv->next_thread_id = INITIAL_THREAD_ID;
 }
 
 /** @brief Destructor */
@@ -71,52 +72,27 @@ void ModelChecker::reset_to_initial_state()
 {
        DEBUG("+++ Resetting to initial state +++\n");
        node_stack->reset_execution();
-       current_action = NULL;
-       next_thread_id = INITIAL_THREAD_ID;
-       used_sequence_numbers = 0;
-       nextThread = 0;
-       next_backtrack = NULL;
        failed_promise = false;
+       reset_asserted();
        snapshotObject->backTrackBeforeStep(0);
 }
 
 /** @returns a thread ID for a new Thread */
 thread_id_t ModelChecker::get_next_id()
 {
-       return next_thread_id++;
+       return priv->next_thread_id++;
 }
 
 /** @returns the number of user threads created during this execution */
 int ModelChecker::get_num_threads()
 {
-       return next_thread_id;
+       return priv->next_thread_id;
 }
 
 /** @returns a sequence number for a new ModelAction */
 modelclock_t ModelChecker::get_next_seq_num()
 {
-       return ++used_sequence_numbers;
-}
-
-/**
- * Performs the "scheduling" for the model-checker. That is, it checks if the
- * model-checker has selected a "next thread to run" and returns it, if
- * available. This function should be called from the Scheduler routine, where
- * the Scheduler falls back to a default scheduling routine if needed.
- *
- * @return The next thread chosen by the model-checker. If the model-checker
- * makes no selection, retuns NULL.
- */
-Thread * ModelChecker::schedule_next_thread()
-{
-       Thread *t;
-       if (nextThread == THREAD_ID_T_NONE)
-               return NULL;
-       t = thread_map->get(id_to_int(nextThread));
-
-       ASSERT(t != NULL);
-
-       return t;
+       return ++priv->used_sequence_numbers;
 }
 
 /**
@@ -126,13 +102,13 @@ Thread * ModelChecker::schedule_next_thread()
  * from the backtracking set. Otherwise, simply returns the next thread in the
  * sequence that is being replayed.
  */
-thread_id_t ModelChecker::get_next_replay_thread()
+Thread * ModelChecker::get_next_replay_thread()
 {
        thread_id_t tid;
 
        /* Have we completed exploring the preselected path? */
        if (diverge == NULL)
-               return THREAD_ID_T_NONE;
+               return NULL;
 
        /* Else, we are trying to replay an execution */
        ModelAction *next = node_stack->get_next()->get_action();
@@ -164,7 +140,8 @@ thread_id_t ModelChecker::get_next_replay_thread()
                tid = next->get_tid();
        }
        DEBUG("*** ModelChecker chose next thread = %d ***\n", tid);
-       return tid;
+       ASSERT(tid != THREAD_ID_T_NONE);
+       return thread_map->get(id_to_int(tid));
 }
 
 /**
@@ -183,7 +160,7 @@ bool ModelChecker::next_execution()
        if (isfinalfeasible() || DBG_ENABLED())
                print_summary();
 
-       if ((diverge = model->get_next_backtrack()) == NULL)
+       if ((diverge = get_next_backtrack()) == NULL)
                return false;
 
        if (DBG_ENABLED()) {
@@ -191,7 +168,7 @@ bool ModelChecker::next_execution()
                diverge->print();
        }
 
-       model->reset_to_initial_state();
+       reset_to_initial_state();
        return true;
 }
 
@@ -238,8 +215,8 @@ void ModelChecker::set_backtracking(ModelAction *act)
                return;
 
        /* Cache the latest backtracking point */
-       if (!next_backtrack || *prev > *next_backtrack)
-               next_backtrack = prev;
+       if (!priv->next_backtrack || *prev > *priv->next_backtrack)
+               priv->next_backtrack = prev;
 
        /* If this is a new backtracking point, mark the tree */
        if (!node->set_backtrack(t->get_id()))
@@ -259,20 +236,28 @@ void ModelChecker::set_backtracking(ModelAction *act)
  */
 ModelAction * ModelChecker::get_next_backtrack()
 {
-       ModelAction *next = next_backtrack;
-       next_backtrack = NULL;
+       ModelAction *next = priv->next_backtrack;
+       priv->next_backtrack = NULL;
        return next;
 }
 
-void ModelChecker::check_current_action(void)
+/**
+ * This is the heart of the model checker routine. It performs model-checking
+ * actions corresponding to a given "current action." Among other processes, it
+ * calculates reads-from relationships, updates synchronization clock vectors,
+ * forms a memory_order constraints graph, and handles replay/backtrack
+ * execution when running permutations of previously-observed executions.
+ *
+ * @param curr The current action to process
+ * @return The next Thread that must be executed. May be NULL if ModelChecker
+ * makes no choice (e.g., according to replay execution, combining RMW actions,
+ * etc.)
+ */
+Thread * ModelChecker::check_current_action(ModelAction *curr)
 {
-       ModelAction *curr = this->current_action;
        bool already_added = false;
-       this->current_action = NULL;
-       if (!curr) {
-               DEBUG("trying to push NULL action...\n");
-               return;
-       }
+
+       ASSERT(curr);
 
        if (curr->is_rmwc() || curr->is_rmw()) {
                ModelAction *tmp = process_rmw(curr);
@@ -311,6 +296,19 @@ void ModelChecker::check_current_action(void)
        if (curr->get_type() == THREAD_CREATE) {
                Thread *th = (Thread *)curr->get_location();
                th->set_creation(curr);
+       } else if (curr->get_type() == THREAD_JOIN) {
+               Thread *wait, *join;
+               wait = get_thread(curr->get_tid());
+               join = (Thread *)curr->get_location();
+               if (!join->is_complete())
+                       scheduler->wait(wait, join);
+       } else if (curr->get_type() == THREAD_FINISH) {
+               Thread *th = get_thread(curr->get_tid());
+               while (!th->wait_list_empty()) {
+                       Thread *wake = th->pop_wait_list();
+                       scheduler->wake(wake);
+               }
+               th->complete();
        }
 
        /* Deal with new thread */
@@ -338,7 +336,7 @@ void ModelChecker::check_current_action(void)
                }
        } else if (curr->is_write()) {
                if (w_modification_order(curr))
-                       updated = true;;
+                       updated = true;
                if (resolve_promises(curr))
                        updated = true;
        }
@@ -352,25 +350,31 @@ void ModelChecker::check_current_action(void)
        if (!already_added)
                add_action_to_lists(curr);
 
-       /** @todo Is there a better interface for setting the next thread rather
-                than this field/convoluted approach?  Perhaps like just returning
-                it or something? */
-
-       /* Do not split atomic actions. */
-       if (curr->is_rmwr())
-               nextThread = thread_current()->get_id();
-       else
-               nextThread = get_next_replay_thread();
-
        Node *currnode = curr->get_node();
        Node *parnode = currnode->get_parent();
 
        if (!parnode->backtrack_empty() || !currnode->read_from_empty() ||
                  !currnode->future_value_empty() || !currnode->promise_empty())
-               if (!next_backtrack || *curr > *next_backtrack)
-                       next_backtrack = curr;
+               if (!priv->next_backtrack || *curr > *priv->next_backtrack)
+                       priv->next_backtrack = curr;
 
        set_backtracking(curr);
+
+       /* Do not split atomic actions. */
+       if (curr->is_rmwr())
+               return thread_current();
+       /* The THREAD_CREATE action points to the created Thread */
+       else if (curr->get_type() == THREAD_CREATE)
+               return (Thread *)curr->get_location();
+       else
+               return get_next_replay_thread();
+}
+
+/** @returns whether the current partial trace must be a prefix of a
+ * feasible trace. */
+
+bool ModelChecker::isfeasibleprefix() {
+       return promises->size()==0;
 }
 
 /** @returns whether the current partial trace is feasible. */
@@ -520,8 +524,8 @@ bool ModelChecker::w_modification_order(ModelAction *curr)
                                   that read could potentially read from our write.
                                 */
                                if (act->get_node()->add_future_value(curr->get_value()) &&
-                                               (!next_backtrack || *act > *next_backtrack))
-                                       next_backtrack = act;
+                                               (!priv->next_backtrack || *act > *priv->next_backtrack))
+                                       priv->next_backtrack = act;
                        }
                }
        }
@@ -576,9 +580,8 @@ bool ModelChecker::release_seq_head(const ModelAction *rf,
        action_list_t::const_reverse_iterator rit;
 
        /* Find rf in the thread list */
-       for (rit = list->rbegin(); rit != list->rend(); rit++)
-               if (*rit == rf)
-                       break;
+       rit = std::find(list->rbegin(), list->rend(), rf);
+       ASSERT(rit != list->rend());
 
        /* Find the last write/release */
        for (; rit != list->rend(); rit++)
@@ -597,6 +600,11 @@ bool ModelChecker::release_seq_head(const ModelAction *rf,
                if (id_to_int(rf->get_tid()) == (int)i)
                        continue;
                list = &(*thrd_lists)[i];
+
+               /* Can we ensure no future writes from this thread may break
+                * the release seq? */
+               bool future_ordered = false;
+
                for (rit = list->rbegin(); rit != list->rend(); rit++) {
                        const ModelAction *act = *rit;
                        if (!act->is_write())
@@ -604,13 +612,17 @@ bool ModelChecker::release_seq_head(const ModelAction *rf,
                        /* Reach synchronization -> this thread is complete */
                        if (act->happens_before(release))
                                break;
-                       if (rf->happens_before(act))
+                       if (rf->happens_before(act)) {
+                               future_ordered = true;
                                continue;
+                       }
 
                        /* Check modification order */
-                       if (mo_graph->checkReachable(rf, act))
+                       if (mo_graph->checkReachable(rf, act)) {
                                /* rf --mo--> act */
+                               future_ordered = true;
                                continue;
+                       }
                        if (mo_graph->checkReachable(act, release))
                                /* act --mo--> release */
                                break;
@@ -621,6 +633,8 @@ bool ModelChecker::release_seq_head(const ModelAction *rf,
                        }
                        certain = false;
                }
+               if (!future_ordered)
+                       return false; /* This thread is uncertain */
        }
 
        if (certain)
@@ -703,6 +717,11 @@ bool ModelChecker::resolve_release_sequences(void *location)
                        it++;
        }
 
+       // If we resolved promises or data races, see if we have realized a data race.
+       if (checkDataRaces()) {
+               set_assert();
+       }
+
        return updated;
 }
 
@@ -722,7 +741,7 @@ void ModelChecker::add_action_to_lists(ModelAction *act)
 
        std::vector<action_list_t> *vec = obj_thrd_map->get_safe_ptr(act->get_location());
        if (tid >= (int)vec->size())
-               vec->resize(next_thread_id);
+               vec->resize(priv->next_thread_id);
        (*vec)[tid].push_back(act);
 
        if ((int)thrd_last_action->size() <= tid)
@@ -794,6 +813,7 @@ bool ModelChecker::resolve_promises(ModelAction *write)
                } else
                        promise_index++;
        }
+
        return resolved;
 }
 
@@ -828,7 +848,7 @@ void ModelChecker::check_promises(ClockVector *old_cv, ClockVector *merge_cv)
                                merge_cv->synchronized_since(act)) {
                        //This thread is no longer able to send values back to satisfy the promise
                        int num_synchronized_threads = promise->increment_threads();
-                       if (num_synchronized_threads == model->get_num_threads()) {
+                       if (num_synchronized_threads == get_num_threads()) {
                                //Promise has failed
                                failed_promise = true;
                                return;
@@ -957,10 +977,7 @@ void ModelChecker::remove_thread(Thread *t)
  * context). This switch is made with the intention of exploring a particular
  * model-checking action (described by a ModelAction object). Must be called
  * from a user-thread context.
- * @param act The current action that will be explored. May be NULL, although
- * there is little reason to switch to the model-checker without an action to
- * explore (note: act == NULL is sometimes used as a hack to allow a thread to
- * yield control without performing any progress; see thrd_join()).
+ * @param act The current action that will be explored. Must not be NULL.
  * @return Return status from the 'swap' call (i.e., success/fail, 0/-1)
  */
 int ModelChecker::switch_to_master(ModelAction *act)
@@ -979,19 +996,22 @@ int ModelChecker::switch_to_master(ModelAction *act)
 bool ModelChecker::take_step() {
        Thread *curr, *next;
 
+       if (has_asserted())
+               return false;
+
        curr = thread_current();
        if (curr) {
                if (curr->get_state() == THREAD_READY) {
-                       check_current_action();
-                       scheduler->add_thread(curr);
-               } else if (curr->get_state() == THREAD_RUNNING) {
-                       /* Stopped while running; i.e., completed */
-                       curr->complete();
+                       ASSERT(priv->current_action);
+                       priv->nextThread = check_current_action(priv->current_action);
+                       priv->current_action = NULL;
+                       if (!curr->is_blocked() && !curr->is_complete())
+                               scheduler->add_thread(curr);
                } else {
                        ASSERT(false);
                }
        }
-       next = scheduler->next_thread();
+       next = scheduler->next_thread(priv->nextThread);
 
        /* Infeasible -> don't take any more steps */
        if (!isfeasible())