execution: bugfix - resolved promises should propagate synchronization
[cdsspec-compiler.git] / nodestack.h
index 47c0272f95fa917e8710235fa0d56b02194a4d08..f26100bad0e359459bf18263009028aa8a28f4e0 100644 (file)
@@ -5,13 +5,13 @@
 #ifndef __NODESTACK_H__
 #define __NODESTACK_H__
 
-#include "stl_wrappers.h"
 #include <cstddef>
 #include <inttypes.h>
 
 #include "mymemory.h"
 #include "schedule.h"
 #include "promise.h"
+#include "stl-model.h"
 
 class ModelAction;
 class Thread;
@@ -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;
@@ -112,6 +120,8 @@ public:
        bool increment_relseq_break();
        bool relseq_break_empty() const;
 
+       bool increment_behaviors();
+
        void print() const;
 
        MEMALLOC
@@ -125,17 +135,20 @@ 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;
 
        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;
 
@@ -143,19 +156,19 @@ 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;
@@ -163,7 +176,7 @@ private:
        int * yield_data;
 };
 
-typedef model_vector< Node * > node_list_t;
+typedef ModelVector<Node *> node_list_t;
 
 /**
  * @brief A stack of nodes
@@ -177,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;
@@ -190,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
         *