2 * @brief Stack of operations for use in backtracking.
5 #ifndef __NODESTACK_H__
6 #define __NODESTACK_H__
20 * A flag used for the promise counting/combination problem within a node,
21 * denoting whether a particular Promise is
22 * <ol><li>@b applicable: can be satisfied by this Node's ModelAction and</li>
23 * <li>@b fulfilled: satisfied by this Node's ModelAction under the current
24 * configuration.</li></ol>
27 #define PROMISE_IGNORE 0 /**< This promise is inapplicable; ignore it */
28 #define PROMISE_UNFULFILLED 1 /**< This promise is applicable but unfulfilled */
29 #define PROMISE_FULFILLED 2 /**< This promise is applicable and fulfilled */
30 #define PROMISE_MASK 0xf
31 #define PROMISE_RMW 0x10
33 typedef int promise_t;
35 struct fairness_info {
36 unsigned int enabled_count;
48 * @brief A single node in a NodeStack
50 * Represents a single node in the NodeStack. Each Node is associated with up
51 * to one action and up to one parent node. A node holds information
52 * regarding the last action performed (the "associated action"), the thread
53 * choices that have been explored (explored_children) and should be explored
54 * (backtrack), and the actions that the last action may read from.
58 Node(ModelAction *act, Node *par, int nthreads, Node *prevfairness);
60 /* return true = thread choice has already been explored */
61 bool has_been_explored(thread_id_t tid) const;
62 /* return true = backtrack set is empty */
63 bool backtrack_empty() const;
65 void clear_backtracking();
66 void explore_child(ModelAction *act, enabled_type_t *is_enabled);
67 /* return false = thread was already in backtrack */
68 bool set_backtrack(thread_id_t id);
69 thread_id_t get_next_backtrack();
70 bool is_enabled(Thread *t) const;
71 bool is_enabled(thread_id_t tid) const;
72 enabled_type_t enabled_status(thread_id_t tid) const;
74 ModelAction * get_action() const { return action; }
75 bool has_priority(thread_id_t tid) const;
76 int get_num_threads() const { return num_threads; }
77 /** @return the parent Node to this Node; that is, the action that
78 * occurred previously in the stack. */
79 Node * get_parent() const { return parent; }
81 read_from_type_t get_read_from_status();
82 bool increment_read_from();
83 bool read_from_empty() const;
84 unsigned int read_from_size() const;
86 void print_read_from_past();
87 void add_read_from_past(const ModelAction *act);
88 const ModelAction * get_read_from_past() const;
89 const ModelAction * get_read_from_past(int i) const;
90 int get_read_from_past_size() const;
92 bool add_future_value(struct future_value fv);
93 struct future_value get_future_value() const;
95 void set_promise(unsigned int i, bool is_rmw);
96 bool get_promise(unsigned int i) const;
97 bool increment_promise();
98 bool promise_empty() const;
99 enabled_type_t *get_enabled_array() {return enabled_array;}
101 void set_misc_max(int i);
102 int get_misc() const;
103 bool increment_misc();
104 bool misc_empty() const;
106 void add_relseq_break(const ModelAction *write);
107 const ModelAction * get_relseq_break() const;
108 bool increment_relseq_break();
109 bool relseq_break_empty() const;
115 void explore(thread_id_t tid);
117 bool read_from_past_empty() const;
118 bool increment_read_from_past();
119 bool future_value_empty() const;
120 bool increment_future_value();
121 read_from_type_t read_from_status;
123 ModelAction * const action;
125 const int num_threads;
126 std::vector< bool, ModelAlloc<bool> > explored_children;
127 std::vector< bool, ModelAlloc<bool> > backtrack;
128 std::vector< struct fairness_info, ModelAlloc< struct fairness_info> > fairness;
130 enabled_type_t *enabled_array;
133 * The set of past ModelActions that this the action at this Node may
134 * read from. Only meaningful if this Node represents a 'read' action.
136 std::vector< const ModelAction *, ModelAlloc< const ModelAction * > > read_from_past;
137 unsigned int read_from_past_idx;
139 std::vector< struct future_value, ModelAlloc<struct future_value> > future_values;
140 std::vector< promise_t, ModelAlloc<promise_t> > promises;
143 std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > relseq_break_writes;
144 int relseq_break_index;
150 typedef std::vector< Node *, ModelAlloc< Node * > > node_list_t;
153 * @brief A stack of nodes
155 * Holds a Node linked-list that can be used for holding backtracking,
156 * may-read-from, and replay information. It is used primarily as a
157 * stack-like structure, in that backtracking points and replay nodes are
158 * only removed from the top (most recent).
164 ModelAction * explore_action(ModelAction *act, enabled_type_t * is_enabled);
165 Node * get_head() const;
166 Node * get_next() const;
167 void reset_execution();
168 void pop_restofstack(int numAhead);
169 int get_total_nodes() { return total_nodes; }
175 node_list_t node_list;
178 * @brief the index position of the current head Node
180 * This index is relative to node_list. The index should point to the
181 * current head Node. It is negative when the list is empty.
188 #endif /* __NODESTACK_H__ */