model: add get_last_seq_cst_fence
[c11tester.git] / nodestack.h
index 3a0ee74cf0c47a3717997d7a47c04d0a9b824b4f..986b9c9df4be85f15d57cbf13f46d62626a3c35d 100644 (file)
+/** @file nodestack.h
+ *  @brief Stack of operations for use in backtracking.
+*/
+
 #ifndef __NODESTACK_H__
 #define __NODESTACK_H__
 
 #include <list>
 #include <vector>
 #include <cstddef>
-#include "threads.h"
+#include <inttypes.h>
+
 #include "mymemory.h"
+#include "modeltypes.h"
+#include "schedule.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>
+ */
+
+#define        PROMISE_IGNORE 0 /**< This promise is inapplicable; ignore it */
+#define        PROMISE_UNFULFILLED 1 /**< This promise is applicable but unfulfilled */
+#define        PROMISE_FULFILLED 2 /**< This promise is applicable and fulfilled */
+#define PROMISE_MASK 0xf
+#define PROMISE_RMW 0x10
+
+typedef int promise_t;
+
+struct future_value {
+       uint64_t value;
+       modelclock_t expiration;
+};
+
+struct fairness_info {
+       unsigned int enabled_count;
+       unsigned int turns;
+       bool priority;
+};
 
+
+/**
+ * @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 *parent = NULL);
+       Node(ModelAction *act = NULL, Node *par = NULL, int nthreads = 2, Node *prevfairness = NULL);
        ~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);
+
+       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);
+       bool is_enabled(thread_id_t tid);
+       enabled_type_t enabled_status(thread_id_t tid);
+
        ModelAction * get_action() { return action; }
+       bool has_priority(thread_id_t tid);
+       int get_num_threads() {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; }
 
-       void print();
+       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();
+       bool increment_read_from();
+       bool read_from_empty();
+       int get_read_from_size();
+       const ModelAction * get_read_from_at(int i);
+
+       void set_promise(unsigned int i, bool is_rmw);
+       bool get_promise(unsigned int i);
+       bool increment_promise();
+       bool promise_empty();
+       enabled_type_t *get_enabled_array() {return enabled_array;}
 
-       static int get_total_nodes() { return total_nodes; }
+       void set_misc_max(int i);
+       int get_misc();
+       bool increment_misc();
+       bool misc_empty();
+
+       void add_relseq_break(const ModelAction *write);
+       const ModelAction * get_relseq_break();
+       bool increment_relseq_break();
+       bool relseq_break_empty();
+
+       void print();
+       void print_may_read_from();
 
        MEMALLOC
 private:
        void explore(thread_id_t tid);
 
-       static int total_nodes;
        ModelAction *action;
+       Node *parent;
        int num_threads;
-       std::vector<bool> explored_children;
-       std::vector<bool> backtrack;
+       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;
+       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 *, ModelAlloc< const ModelAction * > > may_read_from;
+
+       unsigned int read_from_index;
+
+       std::vector< struct future_value, ModelAlloc<struct future_value> > future_values;
+       std::vector< promise_t, ModelAlloc<promise_t> > promises;
+       int future_index;
+
+       std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > relseq_break_writes;
+       int relseq_break_index;
+
+       int misc_index;
+       int misc_max;
 };
 
-typedef std::list<class Node *> node_list_t;
+typedef std::vector< Node *, ModelAlloc< 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();
-       ModelAction * explore_action(ModelAction *act);
+       ModelAction * explore_action(ModelAction *act, enabled_type_t * is_enabled);
        Node * get_head();
        Node * get_next();
        void reset_execution();
+       void pop_restofstack(int numAhead);
+       int get_total_nodes() { return total_nodes; }
 
        void print();
 
        MEMALLOC
 private:
        node_list_t node_list;
-       node_list_t::iterator iter;
+       unsigned int iter;
+
+       int total_nodes;
 };
 
 #endif /* __NODESTACK_H__ */