nodestack: add support functions for check_recency() w/ Promises
[model-checker.git] / nodestack.h
index 6cd8cfd30806c7463d6710e5251041bf4b64cd81..3cffac9c9b2219905020262302f4c580f9f03784 100644 (file)
@@ -5,33 +5,29 @@
 #ifndef __NODESTACK_H__
 #define __NODESTACK_H__
 
-#include <list>
 #include <vector>
 #include <cstddef>
-#include "threads.h"
+#include <inttypes.h>
+
 #include "mymemory.h"
-#include "clockvector.h"
+#include "schedule.h"
+#include "promise.h"
 
 class ModelAction;
+class Thread;
 
-/**
- * A flag used for the promise counting/combination problem within a node,
- * denoting whether a particular Promise is
- * <ol><li>@b applicable: can be satisfied by this Node's ModelAction and</li>
- * <li>@b fulfilled: satisfied by this Node's ModelAction under the current
- * configuration.</li></ol>
- */
-typedef enum {
-       PROMISE_IGNORE = 0, /**< This promise is inapplicable; ignore it */
-       PROMISE_UNFULFILLED, /**< This promise is applicable but unfulfilled */
-       PROMISE_FULFILLED /**< This promise is applicable and fulfilled */
-} promise_t;
-
-struct future_value {
-       uint64_t value;
-       modelclock_t expiration;
+struct fairness_info {
+       unsigned int enabled_count;
+       unsigned int turns;
+       bool priority;
 };
 
+typedef enum {
+       READ_FROM_PAST,
+       READ_FROM_PROMISE,
+       READ_FROM_FUTURE,
+       READ_FROM_NONE,
+} read_from_type_t;
 
 /**
  * @brief A single node in a NodeStack
@@ -44,69 +40,113 @@ struct future_value {
  */
 class Node {
 public:
-       Node(ModelAction *act = NULL, Node *par = NULL, int nthreads = 1, bool *enabled_array = NULL);
+       Node(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);
+       bool has_been_explored(thread_id_t tid) const;
        /* return true = backtrack set is empty */
-       bool backtrack_empty();
+       bool backtrack_empty() const;
 
-       void explore_child(ModelAction *act);
+       void clear_backtracking();
+       void explore_child(ModelAction *act, enabled_type_t *is_enabled);
        /* 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; }
+       bool is_enabled(Thread *t) const;
+       bool is_enabled(thread_id_t tid) const;
+       enabled_type_t enabled_status(thread_id_t tid) const;
 
+       ModelAction * get_action() const { return action; }
+       bool has_priority(thread_id_t tid) 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. */
        Node * get_parent() const { return parent; }
 
-       bool add_future_value(uint64_t value, modelclock_t expiration);
-       uint64_t get_future_value();
-       modelclock_t get_future_value_expiration();
-       bool increment_future_value();
-       bool future_value_empty();
-
-       void add_read_from(const ModelAction *act);
-       const ModelAction * get_read_from();
+       read_from_type_t get_read_from_status();
        bool increment_read_from();
-       bool read_from_empty();
-       int get_read_from_size();
-       const ModelAction * get_read_from_at(int i);
+       bool read_from_empty() const;
+       unsigned int read_from_size() const;
+
+       void print_read_from_past();
+       void add_read_from_past(const ModelAction *act);
+       const ModelAction * get_read_from_past() const;
+       const ModelAction * get_read_from_past(int i) const;
+       int get_read_from_past_size() const;
+
+       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;
 
        void set_promise(unsigned int i);
-       bool get_promise(unsigned int i);
+       bool get_promise(unsigned int i) const;
        bool increment_promise();
-       bool promise_empty();
+       bool promise_empty() const;
+       void clear_promise_resolutions();
+
+       enabled_type_t *get_enabled_array() {return enabled_array;}
+
+       void set_misc_max(int i);
+       int get_misc() const;
+       bool increment_misc();
+       bool misc_empty() const;
 
-       void print();
-       void print_may_read_from();
+       void add_relseq_break(const ModelAction *write);
+       const ModelAction * get_relseq_break() const;
+       bool increment_relseq_break();
+       bool relseq_break_empty() const;
+
+       void print() const;
 
        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;
+       bool read_from_past_empty() const;
+       bool increment_read_from_past();
+       bool read_from_promise_empty() const;
+       bool increment_read_from_promise();
+       bool future_value_empty() const;
+       bool increment_future_value();
+       read_from_type_t read_from_status;
+
+       ModelAction * const 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;
        int numBacktracks;
-       bool *enabled_array;
+       enabled_type_t *enabled_array;
 
-       /** The set of ModelActions that this the action at this Node may read
-        *  from. Only meaningful if this Node represents a 'read' action. */
-       std::vector< const ModelAction *, MyAlloc< const ModelAction * > > may_read_from;
+       /**
+        * 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;
+       unsigned int read_from_past_idx;
 
-       unsigned int read_from_index;
+       std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > read_from_promises;
+       int read_from_promise_idx;
 
-       std::vector< struct future_value, MyAlloc<struct future_value> > future_values;
-       std::vector< promise_t, MyAlloc<promise_t> > promises;
-       unsigned int future_index;
+       std::vector< struct future_value, ModelAlloc<struct future_value> > future_values;
+       int future_index;
+
+       std::vector< bool, ModelAlloc<bool> > resolve_promise;
+       int resolve_promise_idx;
+
+       std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > relseq_break_writes;
+       int relseq_break_index;
+
+       int misc_index;
+       int misc_max;
 };
 
-typedef std::list< Node *, MyAlloc< Node * > > node_list_t;
+typedef std::vector< Node *, ModelAlloc< Node * > > node_list_t;
 
 /**
  * @brief A stack of nodes
@@ -120,19 +160,26 @@ class NodeStack {
 public:
        NodeStack();
        ~NodeStack();
-       ModelAction * explore_action(ModelAction *act, bool * enabled);
-       Node * get_head();
-       Node * get_next();
+       ModelAction * explore_action(ModelAction *act, enabled_type_t * is_enabled);
+       Node * get_head() const;
+       Node * get_next() const;
        void reset_execution();
        void pop_restofstack(int numAhead);
        int get_total_nodes() { return total_nodes; }
 
-       void print();
+       void print() const;
 
        MEMALLOC
 private:
        node_list_t node_list;
-       node_list_t::iterator iter;
+
+       /**
+        * @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;
 
        int total_nodes;
 };