model: schedule appropriate fence backtracking points
[c11tester.git] / nodestack.cc
index 4a6a26d5e2e7078ee74ab0636f7353d86f29f4e0..b2ef73cac30108fab56745f89b0542a186fc6410 100644 (file)
@@ -1,7 +1,14 @@
+#define __STDC_FORMAT_MACROS
+#include <inttypes.h>
+
+#include <string.h>
+
 #include "nodestack.h"
 #include "action.h"
 #include "common.h"
 #include "model.h"
+#include "threads-model.h"
+#include "modeltypes.h"
 
 /**
  * @brief Node constructor
  * @param nthreads The number of threads which exist at this point in the
  * execution trace.
  */
-Node::Node(ModelAction *act, Node *par, int nthreads)
+Node::Node(ModelAction *act, Node *par, int nthreads, Node *prevfairness)
        : action(act),
        parent(par),
        num_threads(nthreads),
        explored_children(num_threads),
        backtrack(num_threads),
+       fairness(num_threads),
        numBacktracks(0),
+       enabled_array(NULL),
        may_read_from(),
        read_from_index(0),
        future_values(),
-       future_index(-1)
+       future_index(-1),
+       relseq_break_writes(),
+       relseq_break_index(0),
+       misc_index(0),
+       misc_max(0)
 {
-       if (act)
-               act->set_node(this);
+       ASSERT(act);
+       act->set_node(this);
+       int currtid = id_to_int(act->get_tid());
+       int prevtid = prevfairness ? id_to_int(prevfairness->action->get_tid()) : 0;
+
+       if (model->params.fairwindow != 0) {
+               for (int i = 0; i < num_threads; i++) {
+                       ASSERT(i < ((int)fairness.size()));
+                       struct fairness_info *fi = &fairness[i];
+                       struct fairness_info *prevfi = (parent && i < parent->get_num_threads()) ? &parent->fairness[i] : NULL;
+                       if (prevfi) {
+                               *fi = *prevfi;
+                       }
+                       if (parent && parent->is_enabled(int_to_id(i))) {
+                               fi->enabled_count++;
+                       }
+                       if (i == currtid) {
+                               fi->turns++;
+                               fi->priority = false;
+                       }
+                       /* Do window processing */
+                       if (prevfairness != NULL) {
+                               if (prevfairness->parent->is_enabled(int_to_id(i)))
+                                       fi->enabled_count--;
+                               if (i == prevtid) {
+                                       fi->turns--;
+                               }
+                               /* Need full window to start evaluating
+                                * conditions
+                                * If we meet the enabled count and have no
+                                * turns, give us priority */
+                               if ((fi->enabled_count >= model->params.enabledcount) &&
+                                               (fi->turns == 0))
+                                       fi->priority = true;
+                       }
+               }
+       }
 }
 
 /** @brief Node desctructor */
 Node::~Node()
 {
-       if (action)
-               delete action;
+       delete action;
+       if (enabled_array)
+               model_free(enabled_array);
 }
 
 /** Prints debugging info for the ModelAction associated with this Node */
-void Node::print()
+void Node::print() const
 {
-       if (action)
-               action->print();
-       else
-               printf("******** empty action ********\n");
+       action->print();
+       model_print("          backtrack: %s", backtrack_empty() ? "empty" : "non-empty ");
+       for (int i = 0; i < (int)backtrack.size(); i++)
+               if (backtrack[i] == true)
+                       model_print("[%d]", i);
+       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()
 {
-       readfrom_set_t::iterator it;
-       for (it = may_read_from.begin(); it != may_read_from.end(); it++)
-               (*it)->print();
+       for (unsigned int i = 0; i < may_read_from.size(); i++)
+               may_read_from[i]->print();
 }
 
-void Node::set_promise(uint32_t i) {
-       if (i>=promises.size())
-               promises.resize(i+1,0);
-       promises[i]=1;
+/**
+ * Sets a promise to explore meeting with the given node.
+ * @param i is the promise index.
+ */
+void Node::set_promise(unsigned int i, bool is_rmw)
+{
+       if (i >= promises.size())
+               promises.resize(i + 1, PROMISE_IGNORE);
+       if (promises[i] == PROMISE_IGNORE) {
+               promises[i] = PROMISE_UNFULFILLED;
+               if (is_rmw)
+                       promises[i] |= PROMISE_RMW;
+       }
 }
 
-bool Node::get_promise(uint32_t i) {
-       return (promises[i]==2);
+/**
+ * Looks up whether a given promise should be satisfied by this node.
+ * @param i The promise index.
+ * @return true if the promise should be satisfied by the given model action.
+ */
+bool Node::get_promise(unsigned int i) const
+{
+       return (i < promises.size()) && ((promises[i] & PROMISE_MASK) == PROMISE_FULFILLED);
 }
 
-bool Node::increment_promises() {
-       for (unsigned int i=0;i<promises.size();i++) {
-               if (promises[i]==1) {
-                       promises[i]=2;
-                       while (i>0) {
+/**
+ * Increments to the next combination of promises.
+ * @return true if we have a valid combination.
+ */
+bool Node::increment_promise()
+{
+       DBG();
+       unsigned int rmw_count = 0;
+       for (unsigned int i = 0; i < promises.size(); i++) {
+               if (promises[i] == (PROMISE_RMW|PROMISE_FULFILLED))
+                       rmw_count++;
+       }
+
+       for (unsigned int i = 0; i < promises.size(); i++) {
+               if ((promises[i] & PROMISE_MASK) == PROMISE_UNFULFILLED) {
+                       if ((rmw_count > 0) && (promises[i] & PROMISE_RMW)) {
+                               //sending our value to two rmws... not going to work..try next combination
+                               continue;
+                       }
+                       promises[i] = (promises[i] & PROMISE_RMW) | PROMISE_FULFILLED;
+                       while (i > 0) {
                                i--;
-                               if (promises[i]==2)
-                                       promises[i]=1;
+                               if ((promises[i] & PROMISE_MASK) == PROMISE_FULFILLED)
+                                       promises[i] = (promises[i] & PROMISE_RMW) | PROMISE_UNFULFILLED;
                        }
                        return true;
+               } else if (promises[i] == (PROMISE_RMW|PROMISE_FULFILLED)) {
+                       rmw_count--;
                }
        }
        return false;
 }
 
-bool Node::promises_empty() {
-       for (unsigned int i=0;i<promises.size();i++)
-               if (promises[i]==1)
+/**
+ * Returns whether the promise set is empty.
+ * @return true if we have explored all promise combinations.
+ */
+bool Node::promise_empty() const
+{
+       bool fulfilledrmw = false;
+       for (int i = promises.size() - 1; i >= 0; i--) {
+               if (promises[i] == PROMISE_UNFULFILLED)
+                       return false;
+               if (!fulfilledrmw && ((promises[i] & PROMISE_MASK) == PROMISE_UNFULFILLED))
                        return false;
+               if (promises[i] == (PROMISE_FULFILLED | PROMISE_RMW))
+                       fulfilledrmw = true;
+       }
        return true;
 }
 
+void Node::set_misc_max(int i)
+{
+       misc_max = i;
+}
+
+int Node::get_misc() const
+{
+       return misc_index;
+}
+
+bool Node::increment_misc()
+{
+       return (misc_index < misc_max) && ((++misc_index) < misc_max);
+}
+
+bool Node::misc_empty() const
+{
+       return (misc_index + 1) >= misc_max;
+}
+
 /**
- * Adds a value from a weakly ordered future write to backtrack to.
+ * 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;
+       }
 
-bool Node::add_future_value(uint64_t value) {
-       for(unsigned int i=0;i<future_values.size();i++)
-               if (future_values[i]==value)
-                       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(value);
+       future_values.push_back(fv);
        return true;
 }
 
-/** 
+/**
  * Checks whether the future_values set for this node is empty.
  * @return true if the future_values set is empty.
  */
-
-bool Node::futurevalues_empty() {
-       return ((future_index+1)>=future_values.size());
+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.
@@ -120,7 +273,7 @@ bool Node::futurevalues_empty() {
  * @return true if this thread choice has been explored already, false
  * otherwise
  */
-bool Node::has_been_explored(thread_id_t tid)
+bool Node::has_been_explored(thread_id_t tid) const
 {
        int id = id_to_int(tid);
        return explored_children[id];
@@ -130,28 +283,35 @@ bool Node::has_been_explored(thread_id_t tid)
  * Checks if the backtracking set is empty.
  * @return true if the backtracking set is empty
  */
-bool Node::backtrack_empty()
+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::readsfrom_empty() {
-       return ((read_from_index+1)>=may_read_from.size());
+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
  */
-void Node::explore_child(ModelAction *act)
+void Node::explore_child(ModelAction *act, enabled_type_t *is_enabled)
 {
+       if (!enabled_array)
+               enabled_array = (enabled_type_t *)model_malloc(sizeof(enabled_type_t) * num_threads);
+       if (is_enabled != NULL)
+               memcpy(enabled_array, is_enabled, sizeof(enabled_type_t) * num_threads);
+       else {
+               for (int i = 0; i < num_threads; i++)
+                       enabled_array[i] = THREAD_DISABLED;
+       }
+
        explore(act->get_tid());
 }
 
@@ -165,6 +325,7 @@ void Node::explore_child(ModelAction *act)
 bool Node::set_backtrack(thread_id_t id)
 {
        int i = id_to_int(id);
+       ASSERT(i < ((int)backtrack.size()));
        if (backtrack[i])
                return false;
        backtrack[i] = true;
@@ -187,9 +348,30 @@ thread_id_t Node::get_next_backtrack()
        return int_to_id(i);
 }
 
-bool Node::is_enabled(Thread *t)
+bool Node::is_enabled(Thread *t) const
 {
-       return id_to_int(t->get_id()) < num_threads;
+       int thread_id = id_to_int(t->get_id());
+       return thread_id < num_threads && (enabled_array[thread_id] != THREAD_DISABLED);
+}
+
+enabled_type_t Node::enabled_status(thread_id_t tid) const
+{
+       int thread_id = id_to_int(tid);
+       if (thread_id < num_threads)
+               return enabled_array[thread_id];
+       else
+               return THREAD_DISABLED;
+}
+
+bool Node::is_enabled(thread_id_t tid) const
+{
+       int thread_id = id_to_int(tid);
+       return thread_id < num_threads && (enabled_array[thread_id] != THREAD_DISABLED);
+}
+
+bool Node::has_priority(thread_id_t tid) const
+{
+       return fairness[id_to_int(tid)].priority;
 }
 
 /**
@@ -202,25 +384,34 @@ void Node::add_read_from(const ModelAction *act)
 }
 
 /**
- * Gets the next 'future_value' value from this Node. Only valid for a node
- * where this->action is a 'read'.
+ * 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
  */
-
-uint64_t Node::get_future_value() {
-       ASSERT(future_index<future_values.size());
+struct future_value Node::get_future_value() const
+{
+       ASSERT(future_index >= 0 && future_index < ((int)future_values.size()));
        return future_values[future_index];
 }
 
+int Node::get_read_from_size() const
+{
+       return may_read_from.size();
+}
+
+const ModelAction * Node::get_read_from_at(int i) const
+{
+       return may_read_from[i];
+}
+
 /**
  * Gets the next 'may_read_from' action from this Node. Only valid for a node
  * where this->action is a 'read'.
- * @todo Perform reads_from backtracking/replay properly, so that this function
- * may remove elements from may_read_from
  * @return The first element in may_read_from
  */
-const ModelAction * Node::get_read_from() {
-       if (read_from_index<may_read_from.size())
+const ModelAction * Node::get_read_from() const
+{
+       if (read_from_index < may_read_from.size())
                return may_read_from[read_from_index];
        else
                return NULL;
@@ -230,24 +421,89 @@ const ModelAction * Node::get_read_from() {
  * 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() {
-       read_from_index++;
-       return (read_from_index<may_read_from.size());
+bool Node::increment_read_from()
+{
+       DBG();
+       promises.clear();
+       if (read_from_index < may_read_from.size()) {
+               read_from_index++;
+               return read_from_index < may_read_from.size();
+       }
+       return false;
 }
 
 /**
  * Increments the index into the future_values set to explore the next item.
  * @return Returns false if we have explored all values.
  */
+bool Node::increment_future_value()
+{
+       DBG();
+       promises.clear();
+       if (future_index < ((int)future_values.size())) {
+               future_index++;
+               return (future_index < ((int)future_values.size()));
+       }
+       return false;
+}
 
-bool Node::increment_future_values() {
-       future_index++;
-       return (future_index<future_values.size());
+/**
+ * Add a write ModelAction to the set of writes that may break the release
+ * sequence. This is used during replay exploration of pending release
+ * sequences. This Node must correspond to a release sequence fixup action.
+ *
+ * @param write The write that may break the release sequence. NULL means we
+ * allow the release sequence to synchronize.
+ */
+void Node::add_relseq_break(const ModelAction *write)
+{
+       relseq_break_writes.push_back(write);
+}
+
+/**
+ * Get the write that may break the current pending release sequence,
+ * according to the replay / divergence pattern.
+ *
+ * @return A write that may break the release sequence. If NULL, that means
+ * the release sequence should not be broken.
+ */
+const ModelAction * Node::get_relseq_break() const
+{
+       if (relseq_break_index < (int)relseq_break_writes.size())
+               return relseq_break_writes[relseq_break_index];
+       else
+               return NULL;
+}
+
+/**
+ * Increments the index into the relseq_break_writes set to explore the next
+ * item.
+ * @return Returns false if we have explored all values.
+ */
+bool Node::increment_relseq_break()
+{
+       DBG();
+       promises.clear();
+       if (relseq_break_index < ((int)relseq_break_writes.size())) {
+               relseq_break_index++;
+               return (relseq_break_index < ((int)relseq_break_writes.size()));
+       }
+       return false;
+}
+
+/**
+ * @return True if all writes that may break the release sequence have been
+ * explored
+ */
+bool Node::relseq_break_empty() const
+{
+       return ((relseq_break_index + 1) >= ((int)relseq_break_writes.size()));
 }
 
 void Node::explore(thread_id_t tid)
 {
        int i = id_to_int(tid);
+       ASSERT(i < ((int)backtrack.size()));
        if (backtrack[i]) {
                backtrack[i] = false;
                numBacktracks--;
@@ -255,60 +511,58 @@ void Node::explore(thread_id_t tid)
        explored_children[i] = true;
 }
 
-static void clear_node_list(node_list_t *list, node_list_t::iterator start,
-                                              node_list_t::iterator end)
+NodeStack::NodeStack() :
+       node_list(),
+       head_idx(-1),
+       total_nodes(0)
 {
-       node_list_t::iterator it;
-
-       for (it = start; it != end; it++)
-               delete (*it);
-       list->erase(start, end);
-}
-
-NodeStack::NodeStack()
-       : total_nodes(0)
-{
-       node_list.push_back(new Node());
        total_nodes++;
-       iter = node_list.begin();
 }
 
 NodeStack::~NodeStack()
 {
-       clear_node_list(&node_list, node_list.begin(), node_list.end());
+       for (unsigned int i = 0; i < node_list.size(); i++)
+               delete node_list[i];
 }
 
-void NodeStack::print()
+void NodeStack::print() const
 {
-       node_list_t::iterator it;
-       printf("............................................\n");
-       printf("NodeStack printing node_list:\n");
-       for (it = node_list.begin(); it != node_list.end(); it++) {
-               if (it == this->iter)
-                       printf("vvv following action is the current iterator vvv\n");
-               (*it)->print();
+       model_print("............................................\n");
+       model_print("NodeStack printing node_list:\n");
+       for (unsigned int it = 0; it < node_list.size(); it++) {
+               if ((int)it == this->head_idx)
+                       model_print("vvv following action is the current iterator vvv\n");
+               node_list[it]->print();
        }
-       printf("............................................\n");
+       model_print("............................................\n");
 }
 
-ModelAction * NodeStack::explore_action(ModelAction *act)
+/** Note: The is_enabled set contains what actions were enabled when
+ *  act was chosen. */
+ModelAction * NodeStack::explore_action(ModelAction *act, enabled_type_t *is_enabled)
 {
        DBG();
 
-       ASSERT(!node_list.empty());
-       node_list_t::iterator it=iter;
-       it++;
-
-       if (it != node_list.end()) {
-               iter++;
-               return (*iter)->get_action();
+       if ((head_idx + 1) < (int)node_list.size()) {
+               head_idx++;
+               return node_list[head_idx]->get_action();
        }
 
        /* Record action */
-       get_head()->explore_child(act);
-       node_list.push_back(new Node(act, get_head(), model->get_num_threads()));
+       Node *head = get_head();
+       Node *prevfairness = NULL;
+       if (head) {
+               head->explore_child(act, is_enabled);
+               if (model->params.fairwindow != 0 && head_idx > (int)model->params.fairwindow)
+                       prevfairness = node_list[head_idx - model->params.fairwindow];
+       }
+
+       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++;
-       iter++;
+       head_idx++;
        return NULL;
 }
 
@@ -323,35 +577,34 @@ ModelAction * NodeStack::explore_action(ModelAction *act)
 void NodeStack::pop_restofstack(int numAhead)
 {
        /* Diverging from previous execution; clear out remainder of list */
-       node_list_t::iterator it = iter;
-       while (numAhead--)
-               it++;
-       clear_node_list(&node_list, it, node_list.end());
+       unsigned int it = head_idx + numAhead;
+       for (unsigned int i = it; i < node_list.size(); i++)
+               delete node_list[i];
+       node_list.resize(it);
 }
 
-Node * NodeStack::get_head()
+Node * NodeStack::get_head() const
 {
-       if (node_list.empty())
+       if (node_list.empty() || head_idx < 0)
                return NULL;
-       return *iter;
+       return node_list[head_idx];
 }
 
-Node * NodeStack::get_next()
+Node * NodeStack::get_next() const
 {
-       node_list_t::iterator it = iter;
        if (node_list.empty()) {
                DEBUG("Empty\n");
                return NULL;
        }
-       it++;
-       if (it == node_list.end()) {
+       unsigned int it = head_idx + 1;
+       if (it == node_list.size()) {
                DEBUG("At end\n");
                return NULL;
        }
-       return *it;
+       return node_list[it];
 }
 
 void NodeStack::reset_execution()
 {
-       iter = node_list.begin();
+       head_idx = -1;
 }