X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=nodestack.h;h=f26100bad0e359459bf18263009028aa8a28f4e0;hb=1f2a30ddc8f38f3f45d62d169b766c0c38364ecd;hp=8573e9f3ded52b3ed4d1c789633d6c3b0c32311d;hpb=38dfa065a8c9404427bcd954b37cf343aa4f9ea8;p=model-checker.git

diff --git a/nodestack.h b/nodestack.h
index 8573e9f..f26100b 100644
--- a/nodestack.h
+++ b/nodestack.h
@@ -22,11 +22,18 @@ struct fairness_info {
 	bool priority;
 };
 
+/**
+ * @brief Types of read-from relations
+ *
+ * Our "may-read-from" set is composed of multiple types of reads, and we have
+ * to iterate through all of them in the backtracking search. This enumeration
+ * helps to identify which type of read-from we are currently observing.
+ */
 typedef enum {
-	READ_FROM_PAST,
-	READ_FROM_PROMISE,
-	READ_FROM_FUTURE,
-	READ_FROM_NONE,
+	READ_FROM_PAST, /**< @brief Read from a prior, existing store */
+	READ_FROM_PROMISE, /**< @brief Read from an existing promised future value */
+	READ_FROM_FUTURE, /**< @brief Read from a newly-asserted future value */
+	READ_FROM_NONE, /**< @brief A NULL state, which should not be reached */
 } read_from_type_t;
 
 #define YIELD_E 1
@@ -47,7 +54,8 @@ typedef enum {
  */
 class Node {
 public:
-	Node(ModelAction *act, Node *par, int nthreads, Node *prevfairness);
+	Node(const struct model_params *params, ModelAction *act, Node *par,
+			int nthreads, Node *prevfairness);
 	~Node();
 	/* return true = thread choice has already been explored */
 	bool has_been_explored(thread_id_t tid) const;
@@ -127,9 +135,12 @@ private:
 	bool future_value_empty() const;
 	bool increment_future_value();
 	read_from_type_t read_from_status;
+	const struct model_params * get_params() const { return params; }
 
 	ModelAction * const action;
 
+	const struct model_params * const params;
+
 	/** @brief ATOMIC_UNINIT action which was created at this Node */
 	ModelAction *uninit_action;
 
@@ -179,6 +190,9 @@ class NodeStack {
 public:
 	NodeStack();
 	~NodeStack();
+
+	void register_engine(const ModelExecution *exec);
+
 	ModelAction * explore_action(ModelAction *act, enabled_type_t * is_enabled);
 	Node * get_head() const;
 	Node * get_next() const;
@@ -192,6 +206,11 @@ public:
 private:
 	node_list_t node_list;
 
+	const struct model_params * get_params() const;
+
+	/** @brief The model-checker execution object */
+	const ModelExecution *execution;
+
 	/**
 	 * @brief the index position of the current head Node
 	 *