nodestack: add read_from_promises backtracking
[model-checker.git] / nodestack.cc
index 708ec3d0f5fa3da43a563228ef53c4b6e72475dd..3cde3456bb9363bc08f2549035166b6f7fe3bd15 100644 (file)
@@ -8,6 +8,7 @@
 #include "common.h"
 #include "model.h"
 #include "threads-model.h"
+#include "modeltypes.h"
 
 /**
  * @brief Node constructor
@@ -23,8 +24,9 @@
  * @param nthreads The number of threads which exist at this point in the
  * execution trace.
  */
-Node::Node(ModelAction *act, Node *par, int nthreads, Node *prevfairness)
-       : action(act),
+Node::Node(ModelAction *act, Node *par, int nthreads, Node *prevfairness) :
+       read_from_status(READ_FROM_PAST),
+       action(act),
        parent(par),
        num_threads(nthreads),
        explored_children(num_threads),
@@ -32,8 +34,10 @@ Node::Node(ModelAction *act, Node *par, int nthreads, Node *prevfairness)
        fairness(num_threads),
        numBacktracks(0),
        enabled_array(NULL),
-       may_read_from(),
-       read_from_index(0),
+       read_from_past(),
+       read_from_past_idx(0),
+       read_from_promises(),
+       read_from_promise_idx(-1),
        future_values(),
        future_index(-1),
        relseq_break_writes(),
@@ -89,7 +93,7 @@ Node::~Node()
 }
 
 /** Prints debugging info for the ModelAction associated with this Node */
-void Node::print()
+void Node::print() const
 {
        action->print();
        model_print("          backtrack: %s", backtrack_empty() ? "empty" : "non-empty ");
@@ -97,28 +101,27 @@ void Node::print()
                if (backtrack[i] == true)
                        model_print("[%d]", i);
        model_print("\n");
+
+       model_print("          read from past: %s", read_from_past_empty() ? "empty" : "non-empty ");
+       for (int i = read_from_past_idx + 1; i < (int)read_from_past.size(); i++)
+               model_print("[%d]", read_from_past[i]->get_seq_number());
+       model_print("\n");
+
+       model_print("          read-from promises: %s", read_from_promise_empty() ? "empty" : "non-empty ");
+       for (int i = read_from_promise_idx + 1; i < (int)read_from_promises.size(); i++)
+               model_print("[%d]", read_from_promises[i]->get_seq_number());
+       model_print("\n");
+
        model_print("          future values: %s", future_value_empty() ? "empty" : "non-empty ");
        for (int i = future_index + 1; i < (int)future_values.size(); i++)
                model_print("[%#" PRIx64 "]", future_values[i].value);
        model_print("\n");
 
-       model_print("          read-from: %s", read_from_empty() ? "empty" : "non-empty ");
-       for (int i = read_from_index + 1; i < (int)may_read_from.size(); i++)
-               model_print("[%d]", may_read_from[i]->get_seq_number());
-       model_print("\n");
-
        model_print("          promises: %s\n", promise_empty() ? "empty" : "non-empty");
        model_print("          misc: %s\n", misc_empty() ? "empty" : "non-empty");
        model_print("          rel seq break: %s\n", relseq_break_empty() ? "empty" : "non-empty");
 }
 
-/** @brief Prints info about may_read_from set */
-void Node::print_may_read_from()
-{
-       for (unsigned int i = 0; i < may_read_from.size(); i++)
-               may_read_from[i]->print();
-}
-
 /**
  * Sets a promise to explore meeting with the given node.
  * @param i is the promise index.
@@ -163,7 +166,7 @@ bool Node::increment_promise()
                                //sending our value to two rmws... not going to work..try next combination
                                continue;
                        }
-                       promises[i] = (promises[i] & PROMISE_RMW) |PROMISE_FULFILLED;
+                       promises[i] = (promises[i] & PROMISE_RMW) | PROMISE_FULFILLED;
                        while (i > 0) {
                                i--;
                                if ((promises[i] & PROMISE_MASK) == PROMISE_FULFILLED)
@@ -187,9 +190,9 @@ bool Node::promise_empty() const
        for (int i = promises.size() - 1; i >= 0; i--) {
                if (promises[i] == PROMISE_UNFULFILLED)
                        return false;
-               if (!fulfilledrmw && ((promises[i]&PROMISE_MASK) == PROMISE_UNFULFILLED))
+               if (!fulfilledrmw && ((promises[i] & PROMISE_MASK) == PROMISE_UNFULFILLED))
                        return false;
-               if (promises[i] == (PROMISE_FULFILLED|PROMISE_RMW))
+               if (promises[i] == (PROMISE_FULFILLED | PROMISE_RMW))
                        fulfilledrmw = true;
        }
        return true;
@@ -215,54 +218,6 @@ bool Node::misc_empty() const
        return (misc_index + 1) >= misc_max;
 }
 
-/**
- * Adds a value from a weakly ordered future write to backtrack to. This
- * operation may "fail" if the future value has already been run (within some
- * sloppiness window of this expiration), or if the futurevalues set has
- * reached its maximum.
- * @see model_params.maxfuturevalues
- *
- * @param value is the value to backtrack to.
- * @return True if the future value was successully added; false otherwise
- */
-bool Node::add_future_value(uint64_t value, modelclock_t expiration)
-{
-       int idx = -1; /* Highest index where value is found */
-       for (unsigned int i = 0; i < future_values.size(); i++) {
-               if (future_values[i].value == value) {
-                       if (expiration <= future_values[i].expiration)
-                               return false;
-                       idx = i;
-               }
-       }
-       if (idx > future_index) {
-               /* Future value hasn't been explored; update expiration */
-               future_values[idx].expiration = expiration;
-               return true;
-       } else if (idx >= 0 && expiration <= future_values[idx].expiration + model->params.expireslop) {
-               /* Future value has been explored and is within the "sloppy" window */
-               return false;
-       }
-
-       /* Limit the size of the future-values set */
-       if (model->params.maxfuturevalues > 0 &&
-                       (int)future_values.size() >= model->params.maxfuturevalues)
-               return false;
-
-       struct future_value newfv = {value, expiration};
-       future_values.push_back(newfv);
-       return true;
-}
-
-/**
- * Checks whether the future_values set for this node is empty.
- * @return true if the future_values set is empty.
- */
-bool Node::future_value_empty() const
-{
-       return ((future_index + 1) >= ((int)future_values.size()));
-}
-
 /**
  * Checks if the Thread associated with this thread ID has been explored from
  * this Node already.
@@ -285,15 +240,6 @@ bool Node::backtrack_empty() const
        return (numBacktracks == 0);
 }
 
-/**
- * Checks whether the readsfrom set for this node is empty.
- * @return true if the readsfrom set is empty.
- */
-bool Node::read_from_empty() const
-{
-       return ((read_from_index + 1) >= may_read_from.size());
-}
-
 /**
  * Mark the appropriate backtracking information for exploring a thread choice.
  * @param act The ModelAction to explore
@@ -345,6 +291,14 @@ thread_id_t Node::get_next_backtrack()
        return int_to_id(i);
 }
 
+void Node::clear_backtracking()
+{
+       for (unsigned int i = 0; i < backtrack.size(); i++)
+               backtrack[i] = false;
+       for (unsigned int i = 0; i < explored_children.size(); i++)
+               explored_children[i] = false;
+}
+
 bool Node::is_enabled(Thread *t) const
 {
        int thread_id = id_to_int(t->get_id());
@@ -371,64 +325,239 @@ bool Node::has_priority(thread_id_t tid) const
        return fairness[id_to_int(tid)].priority;
 }
 
+/*********************************** read from ********************************/
+
 /**
- * Add an action to the may_read_from set.
- * @param act is the action to add
+ * Get the current state of the may-read-from set iteration
+ * @return The read-from type we should currently be checking (past or future)
  */
-void Node::add_read_from(const ModelAction *act)
+read_from_type_t Node::get_read_from_status()
 {
-       may_read_from.push_back(act);
+       if (read_from_status == READ_FROM_PAST && read_from_past.empty())
+               increment_read_from();
+       return read_from_status;
 }
 
 /**
- * Gets the next 'future_value' from this Node. Only valid for a node where
- * this->action is a 'read'.
- * @return The first element in future_values
+ * Iterate one step in the may-read-from iteration. This includes a step in
+ * reading from the either the past or the future.
+ * @return True if there is a new read-from to explore; false otherwise
  */
-struct future_value Node::get_future_value() const
+bool Node::increment_read_from()
 {
-       ASSERT(future_index >= 0 && future_index < ((int)future_values.size()));
-       return future_values[future_index];
+       promises.clear();
+       if (increment_read_from_past()) {
+              read_from_status = READ_FROM_PAST;
+              return true;
+       } else if (increment_read_from_promise()) {
+               read_from_status = READ_FROM_PROMISE;
+               return true;
+       } else if (increment_future_value()) {
+               read_from_status = READ_FROM_FUTURE;
+               return true;
+       }
+       read_from_status = READ_FROM_NONE;
+       return false;
+}
+
+/**
+ * @return True if there are any new read-froms to explore
+ */
+bool Node::read_from_empty() const
+{
+       return read_from_past_empty() && future_value_empty();
+}
+
+/**
+ * Get the total size of the may-read-from set, including both past and future
+ * values
+ * @return The size of may-read-from
+ */
+unsigned int Node::read_from_size() const
+{
+       return read_from_past.size() + future_values.size();
 }
 
-int Node::get_read_from_size() const
+/******************************* end read from ********************************/
+
+/****************************** read from past ********************************/
+
+/** @brief Prints info about read_from_past set */
+void Node::print_read_from_past()
 {
-       return may_read_from.size();
+       for (unsigned int i = 0; i < read_from_past.size(); i++)
+               read_from_past[i]->print();
 }
 
-const ModelAction * Node::get_read_from_at(int i) const
+/**
+ * Add an action to the read_from_past set.
+ * @param act is the action to add
+ */
+void Node::add_read_from_past(const ModelAction *act)
 {
-       return may_read_from[i];
+       read_from_past.push_back(act);
 }
 
 /**
- * Gets the next 'may_read_from' action from this Node. Only valid for a node
+ * Gets the next 'read_from_past' action from this Node. Only valid for a node
  * where this->action is a 'read'.
- * @return The first element in may_read_from
+ * @return The first element in read_from_past
  */
-const ModelAction * Node::get_read_from() const
+const ModelAction * Node::get_read_from_past() const
 {
-       if (read_from_index < may_read_from.size())
-               return may_read_from[read_from_index];
+       if (read_from_past_idx < read_from_past.size())
+               return read_from_past[read_from_past_idx];
        else
                return NULL;
 }
 
+const ModelAction * Node::get_read_from_past(int i) const
+{
+       return read_from_past[i];
+}
+
+int Node::get_read_from_past_size() const
+{
+       return read_from_past.size();
+}
+
+/**
+ * Checks whether the readsfrom set for this node is empty.
+ * @return true if the readsfrom set is empty.
+ */
+bool Node::read_from_past_empty() const
+{
+       return ((read_from_past_idx + 1) >= read_from_past.size());
+}
+
 /**
  * Increments the index into the readsfrom set to explore the next item.
  * @return Returns false if we have explored all items.
  */
-bool Node::increment_read_from()
+bool Node::increment_read_from_past()
 {
        DBG();
-       promises.clear();
-       if (read_from_index < may_read_from.size()) {
-               read_from_index++;
-               return read_from_index < may_read_from.size();
+       if (read_from_past_idx < read_from_past.size()) {
+               read_from_past_idx++;
+               return read_from_past_idx < read_from_past.size();
+       }
+       return false;
+}
+
+/************************** end read from past ********************************/
+
+/***************************** read_from_promises *****************************/
+
+/**
+ * Add an action to the read_from_promises set.
+ * @param reader The read which generated the Promise; we use the ModelAction
+ * instead of the Promise because the Promise does not last across executions
+ */
+void Node::add_read_from_promise(const ModelAction *reader)
+{
+       read_from_promises.push_back(reader);
+}
+
+/**
+ * Gets the next 'read-from-promise' from this Node. Only valid for a node
+ * where this->action is a 'read'.
+ * @return The current element in read_from_promises
+ */
+const Promise * Node::get_read_from_promise() const
+{
+       if (read_from_promise_idx < 0 || read_from_promise_idx >= ((int)read_from_promises.size()))
+               return NULL;
+       return read_from_promises[read_from_promise_idx]->get_reads_from_promise();
+}
+
+/**
+ * Checks whether the read_from_promises set for this node is empty.
+ * @return true if the read_from_promises set is empty.
+ */
+bool Node::read_from_promise_empty() const
+{
+       return ((read_from_promise_idx + 1) >= ((int)read_from_promises.size()));
+}
+
+/**
+ * Increments the index into the read_from_promises set to explore the next item.
+ * @return Returns false if we have explored all promises.
+ */
+bool Node::increment_read_from_promise()
+{
+       DBG();
+       if (read_from_promise_idx < ((int)read_from_promises.size())) {
+               read_from_promise_idx++;
+               return (read_from_promise_idx < ((int)read_from_promises.size()));
        }
        return false;
 }
 
+/************************* end read_from_promises *****************************/
+
+/****************************** future values *********************************/
+
+/**
+ * Adds a value from a weakly ordered future write to backtrack to. This
+ * operation may "fail" if the future value has already been run (within some
+ * sloppiness window of this expiration), or if the futurevalues set has
+ * reached its maximum.
+ * @see model_params.maxfuturevalues
+ *
+ * @param value is the value to backtrack to.
+ * @return True if the future value was successully added; false otherwise
+ */
+bool Node::add_future_value(struct future_value fv)
+{
+       uint64_t value = fv.value;
+       modelclock_t expiration = fv.expiration;
+       thread_id_t tid = fv.tid;
+       int idx = -1; /* Highest index where value is found */
+       for (unsigned int i = 0; i < future_values.size(); i++) {
+               if (future_values[i].value == value && future_values[i].tid == tid) {
+                       if (expiration <= future_values[i].expiration)
+                               return false;
+                       idx = i;
+               }
+       }
+       if (idx > future_index) {
+               /* Future value hasn't been explored; update expiration */
+               future_values[idx].expiration = expiration;
+               return true;
+       } else if (idx >= 0 && expiration <= future_values[idx].expiration + model->params.expireslop) {
+               /* Future value has been explored and is within the "sloppy" window */
+               return false;
+       }
+
+       /* Limit the size of the future-values set */
+       if (model->params.maxfuturevalues > 0 &&
+                       (int)future_values.size() >= model->params.maxfuturevalues)
+               return false;
+
+       future_values.push_back(fv);
+       return true;
+}
+
+/**
+ * Gets the next 'future_value' from this Node. Only valid for a node where
+ * this->action is a 'read'.
+ * @return The first element in future_values
+ */
+struct future_value Node::get_future_value() const
+{
+       ASSERT(future_index >= 0 && future_index < ((int)future_values.size()));
+       return future_values[future_index];
+}
+
+/**
+ * Checks whether the future_values set for this node is empty.
+ * @return true if the future_values set is empty.
+ */
+bool Node::future_value_empty() const
+{
+       return ((future_index + 1) >= ((int)future_values.size()));
+}
+
 /**
  * Increments the index into the future_values set to explore the next item.
  * @return Returns false if we have explored all values.
@@ -436,7 +565,6 @@ bool Node::increment_read_from()
 bool Node::increment_future_value()
 {
        DBG();
-       promises.clear();
        if (future_index < ((int)future_values.size())) {
                future_index++;
                return (future_index < ((int)future_values.size()));
@@ -444,6 +572,8 @@ bool Node::increment_future_value()
        return false;
 }
 
+/************************** end future values *********************************/
+
 /**
  * Add a write ModelAction to the set of writes that may break the release
  * sequence. This is used during replay exploration of pending release
@@ -553,7 +683,11 @@ ModelAction * NodeStack::explore_action(ModelAction *act, enabled_type_t *is_ena
                if (model->params.fairwindow != 0 && head_idx > (int)model->params.fairwindow)
                        prevfairness = node_list[head_idx - model->params.fairwindow];
        }
-       node_list.push_back(new Node(act, head, model->get_num_threads(), prevfairness));
+
+       int next_threads = model->get_num_threads();
+       if (act->get_type() == THREAD_CREATE)
+               next_threads++;
+       node_list.push_back(new Node(act, head, next_threads, prevfairness));
        total_nodes++;
        head_idx++;
        return NULL;
@@ -574,6 +708,7 @@ void NodeStack::pop_restofstack(int numAhead)
        for (unsigned int i = it; i < node_list.size(); i++)
                delete node_list[i];
        node_list.resize(it);
+       node_list.back()->clear_backtracking();
 }
 
 Node * NodeStack::get_head() const