blank lines, spacing, etc.
[c11tester.git] / nodestack.cc
index 5a65821188fa0698de88a3c03684abea0f12adc8..02f5a89ef17fa320a4fed704e95a924fba0b5132 100644 (file)
@@ -25,7 +25,9 @@ Node::Node(ModelAction *act, Node *par, int nthreads)
        backtrack(num_threads),
        numBacktracks(0),
        may_read_from(),
-       read_from_index(0)
+       read_from_index(0),
+       future_values(),
+       future_index(-1)
 {
        if (act)
                act->set_node(this);
@@ -55,6 +57,76 @@ void Node::print_may_read_from()
                (*it)->print();
 }
 
+/**
+ * Sets a promise to explore meeting with the given node.
+ * @param i is the promise index.
+ */
+void Node::set_promise(uint32_t i) {
+       if (i>=promises.size())
+               promises.resize(i+1,0);
+       promises[i]=1;
+}
+
+/**
+ * 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(uint32_t i) {
+       return (i<promises.size())&&(promises[i]==2);
+}
+
+/**
+ * Increments to the next combination of promises.
+ * @return true if we have a valid combination.
+ */
+bool Node::increment_promise() {
+       for (unsigned int i=0;i<promises.size();i++) {
+               if (promises[i]==1) {
+                       promises[i]=2;
+                       while (i>0) {
+                               i--;
+                               if (promises[i]==2)
+                                       promises[i]=1;
+                       }
+                       return true;
+               }
+       }
+       return false;
+}
+
+/**
+ * Returns whether the promise set is empty.
+ * @return true if we have explored all promise combinations.
+ */
+bool Node::promise_empty() {
+       for (unsigned int i=0;i<promises.size();i++)
+               if (promises[i]==1)
+                       return false;
+       return true;
+}
+
+/**
+ * Adds a value from a weakly ordered future write to backtrack to.
+ * @param value is the value to backtrack to.
+ */
+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;
+
+       future_values.push_back(value);
+       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() {
+       return ((future_index+1)>=future_values.size());
+}
+
 /**
  * Checks if the Thread associated with this thread ID has been explored from
  * this Node already.
@@ -77,12 +149,16 @@ bool Node::backtrack_empty()
        return (numBacktracks == 0);
 }
 
-bool Node::readsfrom_empty() {
+/**
+ * Checks whether the readsfrom set for this node is empty.
+ * @return true if the readsfrom set is empty.
+ */
+bool Node::read_from_empty() {
        return ((read_from_index+1)>=may_read_from.size());
 }
 
 /**
- * Mark the appropriate backtracking infromation for exploring a thread choice.
+ * Mark the appropriate backtracking information for exploring a thread choice.
  * @param act The ModelAction to explore
  */
 void Node::explore_child(ModelAction *act)
@@ -109,7 +185,7 @@ bool Node::set_backtrack(thread_id_t id)
 
 thread_id_t Node::get_next_backtrack()
 {
-       /* TODO: find next backtrack */
+       /** @todo Find next backtrack */
        unsigned int i;
        for (i = 0; i < backtrack.size(); i++)
                if (backtrack[i] == true)
@@ -136,23 +212,46 @@ void Node::add_read_from(const ModelAction *act)
        may_read_from.push_back(act);
 }
 
+/**
+ * Gets the next 'future_value' 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());
+       return future_values[future_index];
+}
+
 /**
  * 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() {
-       ASSERT(read_from_index<may_read_from.size());
-       return may_read_from[read_from_index];
+       if (read_from_index<may_read_from.size())
+               return may_read_from[read_from_index];
+       else
+               return NULL;
 }
 
+/**
+ * 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());
 }
 
+/**
+ * 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() {
+       future_index++;
+       return (future_index<future_values.size());
+}
+
 void Node::explore(thread_id_t tid)
 {
        int i = id_to_int(tid);
@@ -164,7 +263,7 @@ void Node::explore(thread_id_t tid)
 }
 
 static void clear_node_list(node_list_t *list, node_list_t::iterator start,
-                                              node_list_t::iterator end)
+                                               node_list_t::iterator end)
 {
        node_list_t::iterator it;
 
@@ -220,7 +319,14 @@ ModelAction * NodeStack::explore_action(ModelAction *act)
        return NULL;
 }
 
-
+/**
+ * Empties the stack of all trailing nodes after a given position and calls the
+ * destructor for each. This function is provided an offset which determines
+ * how many nodes (relative to the current replay state) to save before popping
+ * the stack.
+ * @param numAhead gives the number of Nodes (including this Node) to skip over
+ * before removing nodes.
+ */
 void NodeStack::pop_restofstack(int numAhead)
 {
        /* Diverging from previous execution; clear out remainder of list */
@@ -230,7 +336,6 @@ void NodeStack::pop_restofstack(int numAhead)
        clear_node_list(&node_list, it, node_list.end());
 }
 
-
 Node * NodeStack::get_head()
 {
        if (node_list.empty())