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 /**
  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>
  25  */
  26
  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
  32
  33 typedef int promise_t;
  34
  35 struct fairness_info {
  36         unsigned int enabled_count;
  37         unsigned int turns;
  38         bool priority;
  39 };
  40
  41 /**
  42  * @brief A single node in a NodeStack
  43  *
  44  * Represents a single node in the NodeStack. Each Node is associated with up
  45  * to one action and up to one parent node. A node holds information
  46  * regarding the last action performed (the "associated action"), the thread
  47  * choices that have been explored (explored_children) and should be explored
  48  * (backtrack), and the actions that the last action may read from.
  49  */
  50 class Node {
  51 public:
  52         Node(ModelAction *act, Node *par, int nthreads, Node *prevfairness);
  53         ~Node();
  54         /* return true = thread choice has already been explored */
  55         bool has_been_explored(thread_id_t tid) const;
  56         /* return true = backtrack set is empty */
  57         bool backtrack_empty() const;
  58
  59         void explore_child(ModelAction *act, enabled_type_t *is_enabled);
  60         /* return false = thread was already in backtrack */
  61         bool set_backtrack(thread_id_t id);
  62         thread_id_t get_next_backtrack();
  63         bool is_enabled(Thread *t) const;
  64         bool is_enabled(thread_id_t tid) const;
  65         enabled_type_t enabled_status(thread_id_t tid) const;
  66
  67         ModelAction * get_action() const { return action; }
  68         bool has_priority(thread_id_t tid) const;
  69         int get_num_threads() const { return num_threads; }
  70         /** @return the parent Node to this Node; that is, the action that
  71          * occurred previously in the stack. */
  72         Node * get_parent() const { return parent; }
  73
  74         bool add_future_value(struct future_value& fv);
  75         struct future_value get_future_value() const;
  76         bool increment_future_value();
  77         bool future_value_empty() const;
  78
  79         void add_read_from(const ModelAction *act);
  80         const ModelAction * get_read_from() const;
  81         bool increment_read_from();
  82         bool read_from_empty() const;
  83         int get_read_from_size() const;
  84         const ModelAction * get_read_from_at(int i) const;
  85
  86         void set_promise(unsigned int i, bool is_rmw);
  87         bool get_promise(unsigned int i) const;
  88         bool increment_promise();
  89         bool promise_empty() const;
  90         enabled_type_t *get_enabled_array() {return enabled_array;}
  91
  92         void set_misc_max(int i);
  93         int get_misc() const;
  94         bool increment_misc();
  95         bool misc_empty() const;
  96
  97         void add_relseq_break(const ModelAction *write);
  98         const ModelAction * get_relseq_break() const;
  99         bool increment_relseq_break();
 100         bool relseq_break_empty() const;
 101
 102         void print() const;
 103         void print_may_read_from();
 104
 105         MEMALLOC
 106 private:
 107         void explore(thread_id_t tid);
 108
 109         ModelAction * const action;
 110         Node * const parent;
 111         const int num_threads;
 112         std::vector< bool, ModelAlloc<bool> > explored_children;
 113         std::vector< bool, ModelAlloc<bool> > backtrack;
 114         std::vector< struct fairness_info, ModelAlloc< struct fairness_info> > fairness;
 115         int numBacktracks;
 116         enabled_type_t *enabled_array;
 117
 118         /** The set of ModelActions that this the action at this Node may read
 119          *  from. Only meaningful if this Node represents a 'read' action. */
 120         std::vector< const ModelAction *, ModelAlloc< const ModelAction * > > may_read_from;
 121
 122         unsigned int read_from_index;
 123
 124         std::vector< struct future_value, ModelAlloc<struct future_value> > future_values;
 125         std::vector< promise_t, ModelAlloc<promise_t> > promises;
 126         int future_index;
 127
 128         std::vector< const ModelAction *, ModelAlloc<const ModelAction *> > relseq_break_writes;
 129         int relseq_break_index;
 130
 131         int misc_index;
 132         int misc_max;
 133 };
 134
 135 typedef std::vector< Node *, ModelAlloc< Node * > > node_list_t;
 136
 137 /**
 138  * @brief A stack of nodes
 139  *
 140  * Holds a Node linked-list that can be used for holding backtracking,
 141  * may-read-from, and replay information. It is used primarily as a
 142  * stack-like structure, in that backtracking points and replay nodes are
 143  * only removed from the top (most recent).
 144  */
 145 class NodeStack {
 146 public:
 147         NodeStack();
 148         ~NodeStack();
 149         ModelAction * explore_action(ModelAction *act, enabled_type_t * is_enabled);
 150         Node * get_head() const;
 151         Node * get_next() const;
 152         void reset_execution();
 153         void pop_restofstack(int numAhead);
 154         int get_total_nodes() { return total_nodes; }
 155
 156         void print() const;
 157
 158         MEMALLOC
 159 private:
 160         node_list_t node_list;
 161
 162         /**
 163          * @brief the index position of the current head Node
 164          *
 165          * This index is relative to node_list. The index should point to the
 166          * current head Node. It is negative when the list is empty.
 167          */
 168         int head_idx;
 169
 170         int total_nodes;
 171 };
 172
 173 #endif /* __NODESTACK_H__ */