nodestack.h

   1 /** @file nodestack.h
   2  *  @brief Stack of operations for use in backtracking.
   3 */
   4
   5 #ifndef __NODESTACK_H__
   6 #define __NODESTACK_H__
   7
   8 #include <vector>
   9 #include <cstddef>
  10 #include <inttypes.h>
  11
  12 #include "mymemory.h"
  13 #include "schedule.h"
  14 #include "promise.h"
  15
  16 class ModelAction;
  17 class Thread;
  18
  19 struct fairness_info {
  20         unsigned int enabled_count;
  21         unsigned int turns;
  22         bool priority;
  23 };
  24
  25 typedef enum {
  26         READ_FROM_PAST,
  27         READ_FROM_PROMISE,
  28         READ_FROM_FUTURE,
  29         READ_FROM_NONE,
  30 } read_from_type_t;
  31
  32 /**
  33  * @brief A single node in a NodeStack
  34  *
  35  * Represents a single node in the NodeStack. Each Node is associated with up
  36  * to one action and up to one parent node. A node holds information
  37  * regarding the last action performed (the "associated action"), the thread
  38  * choices that have been explored (explored_children) and should be explored
  39  * (backtrack), and the actions that the last action may read from.
  40  */
  41 class Node {
  42 public:
  43         Node(ModelAction *act, Node *par, int nthreads, Node *prevfairness);
  44         ~Node();
  45         /* return true = thread choice has already been explored */
  46         bool has_been_explored(thread_id_t tid) const;
  47         /* return true = backtrack set is empty */
  48         bool backtrack_empty() const;
  49
  50         void clear_backtracking();
  51         void explore_child(ModelAction *act, enabled_type_t *is_enabled);
  52         /* return false = thread was already in backtrack */
  53         bool set_backtrack(thread_id_t id);
  54         thread_id_t get_next_backtrack();
  55         bool is_enabled(Thread *t) const;
  56         bool is_enabled(thread_id_t tid) const;
  57         enabled_type_t enabled_status(thread_id_t tid) const;
  58
  59         ModelAction * get_action() const { return action; }
  60         bool has_priority(thread_id_t tid) const;
  61         int get_num_threads() const { return num_threads; }
  62         /** @return the parent Node to this Node; that is, the action that
  63          * occurred previously in the stack. */
  64         Node * get_parent() const { return parent; }
  65
  66         read_from_type_t get_read_from_status();
  67         bool increment_read_from();
  68         bool read_from_empty() const;
  69         unsigned int read_from_size() const;
  70
  71         void print_read_from_past();
  72         void add_read_from_past(const ModelAction *act);
  73         const ModelAction * get_read_from_past() const;
  74         const ModelAction * get_read_from_past(int i) const;
  75         int get_read_from_past_size() const;
  76
  77         void add_read_from_promise(const ModelAction *reader);
  78         Promise * get_read_from_promise() const;
  79
  80         bool add_future_value(struct future_value fv);
  81         struct future_value get_future_value() const;
  82
  83         void set_promise(unsigned int i);
  84         bool get_promise(unsigned int i) const;
  85         bool increment_promise();
  86         bool promise_empty() const;
  87         void clear_promise_resolutions();
  88
  89         enabled_type_t *get_enabled_array() {return enabled_array;}
  90
  91         void set_misc_max(int i);
  92         int get_misc() const;
  93         bool increment_misc();
  94         bool misc_empty() const;
  95
  96         void add_relseq_break(const ModelAction *write);
  97         const ModelAction * get_relseq_break() const;
  98         bool increment_relseq_break();
  99         bool relseq_break_empty() const;
 100
 101         void print() const;
 102
 103         MEMALLOC
 104 private:
 105         void explore(thread_id_t tid);
 106
 107         bool read_from_past_empty() const;
 108         bool increment_read_from_past();
 109         bool read_from_promise_empty() const;
 110         bool increment_read_from_promise();
 111         bool future_value_empty() const;
 112         bool increment_future_value();
 113         read_from_type_t read_from_status;
 114
 115         ModelAction * const action;
 116         Node * const parent;
 117         const int num_threads;
 118         std::vector< bool, ModelAlloc<bool> > explored_children;
 119         std::vector< bool, ModelAlloc<bool> > backtrack;
 120         std::vector< struct fairness_info, ModelAlloc< struct fairness_info> > fairness;
 121         int numBacktracks;
 122         enabled_type_t *enabled_array;
 123
 124         /**
 125          * The set of past ModelActions that this the action at this Node may
 126          * read from. Only meaningful if this Node represents a 'read' action.
 127          */
 128         std::vector< const ModelAction *, ModelAlloc< const ModelAction * > > read_from_past;
 129         unsigned int read_from_past_idx;
 130
 131         std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > read_from_promises;
 132         int read_from_promise_idx;
 133
 134         std::vector< struct future_value, ModelAlloc<struct future_value> > future_values;
 135         int future_index;
 136
 137         std::vector< bool, ModelAlloc<bool> > resolve_promise;
 138         int resolve_promise_idx;
 139
 140         std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > relseq_break_writes;
 141         int relseq_break_index;
 142
 143         int misc_index;
 144         int misc_max;
 145 };
 146
 147 typedef std::vector< Node *, ModelAlloc< Node * > > node_list_t;
 148
 149 /**
 150  * @brief A stack of nodes
 151  *
 152  * Holds a Node linked-list that can be used for holding backtracking,
 153  * may-read-from, and replay information. It is used primarily as a
 154  * stack-like structure, in that backtracking points and replay nodes are
 155  * only removed from the top (most recent).
 156  */
 157 class NodeStack {
 158 public:
 159         NodeStack();
 160         ~NodeStack();
 161         ModelAction * explore_action(ModelAction *act, enabled_type_t * is_enabled);
 162         Node * get_head() const;
 163         Node * get_next() const;
 164         void reset_execution();
 165         void pop_restofstack(int numAhead);
 166         int get_total_nodes() { return total_nodes; }
 167
 168         void print() const;
 169
 170         MEMALLOC
 171 private:
 172         node_list_t node_list;
 173
 174         /**
 175          * @brief the index position of the current head Node
 176          *
 177          * This index is relative to node_list. The index should point to the
 178          * current head Node. It is negative when the list is empty.
 179          */
 180         int head_idx;
 181
 182         int total_nodes;
 183 };
 184
 185 #endif /* __NODESTACK_H__ */