action.h

   1 /** @file action.h
   2  *  @brief Models actions taken by threads.
   3  */
   4
   5 #ifndef __ACTION_H__
   6 #define __ACTION_H__
   7
   8 #include <cstddef>
   9 #include <inttypes.h>
  10
  11 #include "mymemory.h"
  12 #include "memoryorder.h"
  13 #include "modeltypes.h"
  14
  15 class ClockVector;
  16 class Thread;
  17 class Promise;
  18
  19 namespace std {
  20         class mutex;
  21 }
  22
  23 using std::memory_order;
  24 using std::memory_order_relaxed;
  25 using std::memory_order_acquire;
  26 using std::memory_order_release;
  27 using std::memory_order_acq_rel;
  28 using std::memory_order_seq_cst;
  29
  30 /** Note that this value can be legitimately used by a program, and
  31  *  hence by iteself does not indicate no value. */
  32 #define VALUE_NONE 0xdeadbeef
  33
  34 /** A special value to represent a successful trylock */
  35 #define VALUE_TRYSUCCESS 1
  36
  37 /** A special value to represent a failed trylock */
  38 #define VALUE_TRYFAILED 0
  39
  40 /** @brief Represents an action type, identifying one of several types of
  41  * ModelAction */
  42 typedef enum action_type {
  43         MODEL_FIXUP_RELSEQ,   /**< Special ModelAction: finalize a release
  44                                *   sequence */
  45         THREAD_CREATE,        /**< A thread creation action */
  46         THREAD_START,         /**< First action in each thread */
  47         THREAD_YIELD,         /**< A thread yield action */
  48         THREAD_JOIN,          /**< A thread join action */
  49         THREAD_FINISH,        /**< A thread completion action */
  50         ATOMIC_UNINIT,        /**< Represents an uninitialized atomic */
  51         ATOMIC_READ,          /**< An atomic read action */
  52         ATOMIC_WRITE,         /**< An atomic write action */
  53         ATOMIC_RMWR,          /**< The read part of an atomic RMW action */
  54         ATOMIC_RMW,           /**< The write part of an atomic RMW action */
  55         ATOMIC_RMWC,          /**< Convert an atomic RMW action into a READ */
  56         ATOMIC_INIT,          /**< Initialization of an atomic object (e.g.,
  57                                *   atomic_init()) */
  58         ATOMIC_FENCE,         /**< A fence action */
  59         ATOMIC_LOCK,          /**< A lock action */
  60         ATOMIC_TRYLOCK,       /**< A trylock action */
  61         ATOMIC_UNLOCK,        /**< An unlock action */
  62         ATOMIC_NOTIFY_ONE,    /**< A notify_one action */
  63         ATOMIC_NOTIFY_ALL,    /**< A notify all action */
  64         ATOMIC_WAIT           /**< A wait action */
  65 } action_type_t;
  66
  67 /* Forward declaration */
  68 class Node;
  69 class ClockVector;
  70
  71 /**
  72  * The ModelAction class encapsulates an atomic action.
  73  */
  74 class ModelAction {
  75 public:
  76         ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE, Thread *thread = NULL);
  77         ~ModelAction();
  78         void print() const;
  79
  80         thread_id_t get_tid() const { return tid; }
  81         action_type get_type() const { return type; }
  82         memory_order get_mo() const { return order; }
  83         void * get_location() const { return location; }
  84         modelclock_t get_seq_number() const { return seq_number; }
  85         uint64_t get_value() const { return value; }
  86         uint64_t get_reads_from_value() const;
  87         uint64_t get_write_value() const;
  88         uint64_t get_return_value() const;
  89         const ModelAction * get_reads_from() const { return reads_from; }
  90         Promise * get_reads_from_promise() const { return reads_from_promise; }
  91         std::mutex * get_mutex() const;
  92
  93         Node * get_node() const;
  94         void set_node(Node *n) { node = n; }
  95
  96         void set_read_from(const ModelAction *act);
  97         void set_read_from_promise(Promise *promise);
  98
  99         /** Store the most recent fence-release from the same thread
 100          *  @param fence The fence-release that occured prior to this */
 101         void set_last_fence_release(const ModelAction *fence) { last_fence_release = fence; }
 102         /** @return The most recent fence-release from the same thread */
 103         const ModelAction * get_last_fence_release() const { return last_fence_release; }
 104
 105         void copy_from_new(ModelAction *newaction);
 106         void set_seq_number(modelclock_t num);
 107         void set_try_lock(bool obtainedlock);
 108         bool is_thread_start() const;
 109         bool is_relseq_fixup() const;
 110         bool is_mutex_op() const;
 111         bool is_lock() const;
 112         bool is_trylock() const;
 113         bool is_unlock() const;
 114         bool is_wait() const;
 115         bool is_notify() const;
 116         bool is_notify_one() const;
 117         bool is_success_lock() const;
 118         bool is_failed_trylock() const;
 119         bool is_atomic_var() const;
 120         bool is_uninitialized() const;
 121         bool is_read() const;
 122         bool is_write() const;
 123         bool is_yield() const;
 124         bool could_be_write() const;
 125         bool is_rmwr() const;
 126         bool is_rmwc() const;
 127         bool is_rmw() const;
 128         bool is_fence() const;
 129         bool is_initialization() const;
 130         bool is_relaxed() const;
 131         bool is_acquire() const;
 132         bool is_release() const;
 133         bool is_seqcst() const;
 134         bool same_var(const ModelAction *act) const;
 135         bool same_thread(const ModelAction *act) const;
 136         bool is_conflicting_lock(const ModelAction *act) const;
 137         bool could_synchronize_with(const ModelAction *act) const;
 138
 139         Thread * get_thread_operand() const;
 140
 141         void create_cv(const ModelAction *parent = NULL);
 142         ClockVector * get_cv() const { return cv; }
 143         bool synchronize_with(const ModelAction *act);
 144
 145         bool has_synchronized_with(const ModelAction *act) const;
 146         bool happens_before(const ModelAction *act) const;
 147
 148         inline bool operator <(const ModelAction& act) const {
 149                 return get_seq_number() < act.get_seq_number();
 150         }
 151         inline bool operator >(const ModelAction& act) const {
 152                 return get_seq_number() > act.get_seq_number();
 153         }
 154
 155         void process_rmw(ModelAction * act);
 156         void copy_typeandorder(ModelAction * act);
 157
 158         void set_sleep_flag() { sleep_flag=true; }
 159         bool get_sleep_flag() { return sleep_flag; }
 160         unsigned int hash() const;
 161
 162         bool equals(const ModelAction *x) const { return this == x; }
 163         bool equals(const Promise *x) const { return false; }
 164
 165         bool may_read_from(const ModelAction *write) const;
 166         bool may_read_from(const Promise *promise) const;
 167         MEMALLOC
 168 private:
 169
 170         /** Type of action (read, write, thread create, thread yield, thread join) */
 171         action_type type;
 172
 173         /** The memory order for this operation. */
 174         memory_order order;
 175
 176         /** A pointer to the memory location for this action. */
 177         void *location;
 178
 179         /** The thread id that performed this action. */
 180         thread_id_t tid;
 181
 182         /** The value written (for write or RMW; undefined for read) */
 183         uint64_t value;
 184
 185         /** The action that this action reads from. Only valid for reads */
 186         const ModelAction *reads_from;
 187
 188         /** The promise that this action reads from. Only valid for reads */
 189         Promise *reads_from_promise;
 190
 191         /** The last fence release from the same thread */
 192         const ModelAction *last_fence_release;
 193
 194         /** A back reference to a Node in NodeStack, if this ModelAction is
 195          * saved on the NodeStack. */
 196         Node *node;
 197
 198         modelclock_t seq_number;
 199
 200         /** The clock vector stored with this action; only needed if this
 201          * action is a store release? */
 202         ClockVector *cv;
 203
 204         bool sleep_flag;
 205 };
 206
 207 #endif /* __ACTION_H__ */