add a missing line

[c11tester.git] / nodestack.h

diff --git a/nodestack.h b/nodestack.h
index 11440e5ae5680af381842c3ef81e637dd0e16ee9..fa356d0e9ae666db61bb993423b7b915df2c815b 100644 (file)
--- a/nodestack.h
+++ b/nodestack.h
@@ -1,81 +1,83 @@
 /** @file nodestack.h
  *  @brief Stack of operations for use in backtracking.
-*/
+ */
 
 #ifndef __NODESTACK_H__
 #define __NODESTACK_H__
 
-#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;
+#include <inttypes.h>
 
+#include "mymemory.h"
+#include "schedule.h"
+#include "stl-model.h"
+#include "classlist.h"
+
+/**
+ * @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 *par = NULL, int nthreads = 1);
+       Node(ModelAction *act);
        ~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);
-       thread_id_t get_next_backtrack();
-       bool is_enabled(Thread *t);
-       ModelAction * get_action() { return action; }
-
-       /** @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(ModelAction *act);
 
-       void print();
+       ModelAction * get_action() const { return action; }
+       void set_uninit_action(ModelAction *act) { uninit_action = act; }
+       ModelAction * get_uninit_action() const { return uninit_action; }
+       void print() const;
 
        MEMALLOC
 private:
-       void explore(thread_id_t tid);
+       ModelAction * const action;
 
-       ModelAction *action;
-       Node *parent;
-       int num_threads;
-       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. */
-       action_set_t may_read_from;
+       /** @brief ATOMIC_UNINIT action which was created at this Node */
+       ModelAction *uninit_action;
 };
 
-typedef std::list<class Node *, MyAlloc< class Node * > > node_list_t;
+typedef ModelVector<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();
        ~NodeStack();
+
+       void register_engine(const ModelExecution *exec);
        ModelAction * explore_action(ModelAction *act);
-       Node * get_head();
-       Node * get_next();
+       Node * get_head() const;
+       Node * get_next() const;
        void reset_execution();
-
-       int get_total_nodes() { return total_nodes; }
-
-       void print();
+       void full_reset();
+       void print() const;
 
        MEMALLOC
 private:
        node_list_t node_list;
-       node_list_t::iterator iter;
-
-       int total_nodes;
+       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
+        *
+        * This index is relative to node_list. The index should point to the
+        * current head Node. It is negative when the list is empty.
+        */
+       int head_idx;
 };
 
-#endif /* __NODESTACK_H__ */
+#endif /* __NODESTACK_H__ */