nodestack: register ModelExecution class w/in NodeStack
[c11tester.git] / nodestack.h
index f478db2841917edd170cd7d0649c5acdbd6a23ef..1a8bbbe9f371cc2bef422ec2218e96f989fb28a8 100644 (file)
@@ -5,13 +5,13 @@
 #ifndef __NODESTACK_H__
 #define __NODESTACK_H__
 
-#include <vector>
 #include <cstddef>
 #include <inttypes.h>
 
 #include "mymemory.h"
 #include "schedule.h"
 #include "promise.h"
+#include "stl-model.h"
 
 class ModelAction;
 class Thread;
@@ -22,13 +22,27 @@ 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
+#define YIELD_D 2
+#define YIELD_S 4
+#define YIELD_P 8
+#define YIELD_INDEX(tid1, tid2, num_threads) (tid1*num_threads+tid2)
+
+
 /**
  * @brief A single node in a NodeStack
  *
@@ -57,7 +71,12 @@ public:
        enabled_type_t enabled_status(thread_id_t tid) const;
 
        ModelAction * get_action() const { return action; }
+       void set_uninit_action(ModelAction *act) { uninit_action = act; }
+       ModelAction * get_uninit_action() const { return uninit_action; }
+
        bool has_priority(thread_id_t tid) const;
+       void update_yield(Scheduler *);
+       bool has_priority_over(thread_id_t tid, thread_id_t tid2) const;
        int get_num_threads() const { return num_threads; }
        /** @return the parent Node to this Node; that is, the action that
         * occurred previously in the stack. */
@@ -76,6 +95,8 @@ public:
 
        void add_read_from_promise(const ModelAction *reader);
        Promise * get_read_from_promise() const;
+       Promise * get_read_from_promise(int i) const;
+       int get_read_from_promise_size() const;
 
        bool add_future_value(struct future_value fv);
        struct future_value get_future_value() const;
@@ -98,12 +119,14 @@ public:
        bool increment_relseq_break();
        bool relseq_break_empty() const;
 
+       bool increment_behaviors();
+
        void print() const;
 
        MEMALLOC
 private:
        void explore(thread_id_t tid);
-
+       int get_yield_data(int tid1, int tid2) const;
        bool read_from_past_empty() const;
        bool increment_read_from_past();
        bool read_from_promise_empty() const;
@@ -113,11 +136,15 @@ private:
        read_from_type_t read_from_status;
 
        ModelAction * const action;
+
+       /** @brief ATOMIC_UNINIT action which was created at this Node */
+       ModelAction *uninit_action;
+
        Node * const parent;
        const int num_threads;
-       std::vector< bool, ModelAlloc<bool> > explored_children;
-       std::vector< bool, ModelAlloc<bool> > backtrack;
-       std::vector< struct fairness_info, ModelAlloc< struct fairness_info> > fairness;
+       ModelVector<bool> explored_children;
+       ModelVector<bool> backtrack;
+       ModelVector<struct fairness_info> fairness;
        int numBacktracks;
        enabled_type_t *enabled_array;
 
@@ -125,26 +152,27 @@ private:
         * The set of past ModelActions that this the action at this Node may
         * read from. Only meaningful if this Node represents a 'read' action.
         */
-       std::vector< const ModelAction *, ModelAlloc< const ModelAction * > > read_from_past;
+       ModelVector<const ModelAction *> read_from_past;
        unsigned int read_from_past_idx;
 
-       std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > read_from_promises;
+       ModelVector<const ModelAction *> read_from_promises;
        int read_from_promise_idx;
 
-       std::vector< struct future_value, ModelAlloc<struct future_value> > future_values;
+       ModelVector<struct future_value> future_values;
        int future_index;
 
-       std::vector< bool, ModelAlloc<bool> > resolve_promise;
+       ModelVector<bool> resolve_promise;
        int resolve_promise_idx;
 
-       std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > relseq_break_writes;
+       ModelVector<const ModelAction *> relseq_break_writes;
        int relseq_break_index;
 
        int misc_index;
        int misc_max;
+       int * yield_data;
 };
 
-typedef std::vector< Node *, ModelAlloc< Node * > > node_list_t;
+typedef ModelVector<Node *> node_list_t;
 
 /**
  * @brief A stack of nodes
@@ -158,6 +186,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;
@@ -171,6 +202,9 @@ public:
 private:
        node_list_t node_list;
 
+       /** @brief The model-checker execution object */
+       const ModelExecution *execution;
+
        /**
         * @brief the index position of the current head Node
         *