X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=nodestack.h;h=ad63d4dfc999f3ee5beec28c258c9facf5c8d9b0;hb=87d1cbc6f5149794253614a9f4b435ccd339e04e;hp=74ac245f3b3b00331a3328482d7c21c47bdc7cdb;hpb=f3ef22bef8d339c7d45b7d7232cdcf183a0b7776;p=model-checker.git

diff --git a/nodestack.h b/nodestack.h
index 74ac245..ad63d4d 100644
--- a/nodestack.h
+++ b/nodestack.h
@@ -7,18 +7,26 @@
 
 #include <list>
 #include <vector>
-#include <set>
 #include <cstddef>
 #include "threads.h"
 #include "mymemory.h"
 
 class ModelAction;
 
-typedef std::set< ModelAction *, std::less< ModelAction *>, MyAlloc< ModelAction * > > action_set_t;
-
+typedef std::list< const ModelAction *, MyAlloc< const ModelAction * > > readfrom_set_t;
+
+/**
+ * @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, int nthreads = 1);
+	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);
@@ -31,15 +39,22 @@ public:
 	bool is_enabled(Thread *t);
 	ModelAction * get_action() { return action; }
 
-	void add_read_from(ModelAction *act);
+	/** @return the parent Node to this Node; that is, the action that
+	 * occurred previously in the stack. */
+	Node * get_parent() const { return parent; }
+
+	void add_read_from(const ModelAction *act);
+	const ModelAction * get_next_read_from();
 
 	void print();
+	void print_may_read_from();
 
 	MEMALLOC
 private:
 	void explore(thread_id_t tid);
 
 	ModelAction *action;
+	Node *parent;
 	int num_threads;
 	std::vector< bool, MyAlloc<bool> > explored_children;
 	std::vector< bool, MyAlloc<bool> > backtrack;
@@ -47,11 +62,19 @@ private:
 
 	/** The set of ModelActions that this the action at this Node may read
 	 *  from. Only meaningful if this Node represents a 'read' action. */
-	action_set_t may_read_from;
+	readfrom_set_t may_read_from;
 };
 
-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();
@@ -60,7 +83,7 @@ public:
 	Node * get_head();
 	Node * get_next();
 	void reset_execution();
-
+	void pop_restofstack();
 	int get_total_nodes() { return total_nodes; }
 
 	void print();