blank lines, spacing, etc.

[c11tester.git] / nodestack.cc

diff --git a/nodestack.cc b/nodestack.cc
index 4ece1820ab86b35baad7c6ec1c7ee18b1a19c61b..02f5a89ef17fa320a4fed704e95a924fba0b5132 100644 (file)
--- a/nodestack.cc
+++ b/nodestack.cc
@@ -57,16 +57,29 @@ 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 (promises[i]==2);
+       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) {
@@ -82,6 +95,10 @@ bool Node::increment_promise() {
        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)
@@ -93,7 +110,6 @@ bool Node::promise_empty() {
  * 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)
@@ -103,16 +119,14 @@ bool Node::add_future_value(uint64_t 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.
@@ -135,7 +149,6 @@ bool Node::backtrack_empty()
        return (numBacktracks == 0);
 }
 
-
 /**
  * Checks whether the readsfrom set for this node is empty.
  * @return true if the readsfrom set is empty.
@@ -144,8 +157,6 @@ bool Node::read_from_empty() {
        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
@@ -206,7 +217,6 @@ void Node::add_read_from(const ModelAction *act)
  * 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];
@@ -215,8 +225,6 @@ uint64_t Node::get_future_value() {
 /**
  * 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() {
@@ -239,7 +247,6 @@ bool Node::increment_read_from() {
  * 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());
@@ -256,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;