X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=blobdiff_plain;f=nodestack.h;h=6c9779497e71f96e0621b37e762fbb199bd0556c;hp=bd64c4aa859d64f7a2eddcf9282ac9fbb5b1ed16;hb=a6681ee1cceb6df1fe8ea0e524687a11c94ee3f0;hpb=9fd8ac15f03e8ca01a20563e06c44b8b93090892

diff --git a/nodestack.h b/nodestack.h
index bd64c4a..6c97794 100644
--- a/nodestack.h
+++ b/nodestack.h
@@ -1,3 +1,7 @@
+/** @file nodestack.h
+ *  @brief Stack of operations for use in backtracking.
+*/
+
 #ifndef __NODESTACK_H__
 #define __NODESTACK_H__
 
@@ -6,17 +10,47 @@
 #include <cstddef>
 #include "threads.h"
 #include "mymemory.h"
+#include "clockvector.h"
 
 class ModelAction;
 
+/**
+ * A flag used for the promise counting/combination problem within a node,
+ * denoting whether a particular Promise is
+ * <ol><li>@b applicable: can be satisfied by this Node's ModelAction and</li>
+ * <li>@b fulfilled: satisfied by this Node's ModelAction under the current
+ * configuration.</li></ol>
+ */
+typedef enum {
+	PROMISE_IGNORE = 0, /**< This promise is inapplicable; ignore it */
+	PROMISE_UNFULFILLED, /**< This promise is applicable but unfulfilled */
+	PROMISE_FULFILLED /**< This promise is applicable and fulfilled */
+} promise_t;
+
+struct future_value {
+	uint64_t value;
+	modelclock_t expiration;
+};
+
+
+/**
+ * @brief A single node in a NodeStack
+ *
+ * Represents a single node in the NodeStack. Each Node is associated with up
+ * to one action and up to one parent node. A node holds information
+ * regarding the last action performed (the "associated action"), the thread
+ * choices that have been explored (explored_children) and should be explored
+ * (backtrack), and the actions that the last action may read from.
+ */
 class Node {
 public:
-	Node(ModelAction *act = NULL, Node *parent = NULL);
+	Node(ModelAction *act = NULL, Node *par = NULL, int nthreads = 1);
 	~Node();
 	/* return true = thread choice has already been explored */
 	bool has_been_explored(thread_id_t tid);
 	/* return true = backtrack set is empty */
 	bool backtrack_empty();
+
 	void explore_child(ModelAction *act);
 	/* return false = thread was already in backtrack */
 	bool set_backtrack(thread_id_t id);
@@ -24,23 +58,63 @@ public:
 	bool is_enabled(Thread *t);
 	ModelAction * get_action() { return action; }
 
-	void print();
+	/** @return the parent Node to this Node; that is, the action that
+	 * occurred previously in the stack. */
+	Node * get_parent() const { return parent; }
+
+	bool add_future_value(uint64_t value, modelclock_t expiration);
+	uint64_t get_future_value();
+	modelclock_t get_future_value_expiration();
+	bool increment_future_value();
+	bool future_value_empty();
 
-	static int get_total_nodes() { return total_nodes; }
+	void add_read_from(const ModelAction *act);
+	const ModelAction * get_read_from();
+	bool increment_read_from();
+	bool read_from_empty();
+	int get_read_from_size();
+	const ModelAction * get_read_from_at(int i);
+
+	void set_promise(unsigned int i);
+	bool get_promise(unsigned int i);
+	bool increment_promise();
+	bool promise_empty();
+
+	void print();
+	void print_may_read_from();
 
 	MEMALLOC
 private:
 	void explore(thread_id_t tid);
 
-	static int total_nodes;
 	ModelAction *action;
+	Node *parent;
 	int num_threads;
-	std::vector<bool> explored_children;
-	std::vector<bool> backtrack;
+	std::vector< bool, MyAlloc<bool> > explored_children;
+	std::vector< bool, MyAlloc<bool> > backtrack;
+	int numBacktracks;
+
+	/** The set of ModelActions that this the action at this Node may read
+	 *  from. Only meaningful if this Node represents a 'read' action. */
+	std::vector< const ModelAction *, MyAlloc< const ModelAction * > > may_read_from;
+
+	unsigned int read_from_index;
+
+	std::vector< struct future_value, MyAlloc<struct future_value> > future_values;
+	std::vector< promise_t, MyAlloc<promise_t> > promises;
+	unsigned int future_index;
 };
 
-typedef std::list<class Node *, MyAlloc< class Node * > > node_list_t;
+typedef std::list< Node *, MyAlloc< Node * > > node_list_t;
 
+/**
+ * @brief A stack of nodes
+ *
+ * Holds a Node linked-list that can be used for holding backtracking,
+ * may-read-from, and replay information. It is used primarily as a
+ * stack-like structure, in that backtracking points and replay nodes are
+ * only removed from the top (most recent).
+ */
 class NodeStack {
 public:
 	NodeStack();
@@ -49,6 +123,8 @@ public:
 	Node * get_head();
 	Node * get_next();
 	void reset_execution();
+	void pop_restofstack(int numAhead);
+	int get_total_nodes() { return total_nodes; }
 
 	void print();
 
@@ -56,6 +132,8 @@ public:
 private:
 	node_list_t node_list;
 	node_list_t::iterator iter;
+
+	int total_nodes;
 };
 
 #endif /* __NODESTACK_H__ */