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 /* Forward declarations */
  16 class ClockVector;
  17 class Thread;
  18 class Promise;
  19
  20 namespace std {
  21         class mutex;
  22 }
  23
  24 using std::memory_order;
  25 using std::memory_order_relaxed;
  26 using std::memory_order_acquire;
  27 using std::memory_order_release;
  28 using std::memory_order_acq_rel;
  29 using std::memory_order_seq_cst;
  30
  31 /**
  32  * @brief A recognizable don't-care value for use in the ModelAction::value
  33  * field
  34  *
  35  * Note that this value can be legitimately used by a program, and hence by
  36  * iteself does not indicate no value.
  37  */
  38 #define VALUE_NONE 0xdeadbeef
  39
  40 /**
  41  * @brief The "location" at which a fence occurs
  42  *
  43  * We need a non-zero memory location to associate with fences, since our hash
  44  * tables don't handle NULL-pointer keys. HACK: Hopefully this doesn't collide
  45  * with any legitimate memory locations.
  46  */
  47 #define FENCE_LOCATION ((void *)0x7)
  48
  49 /** @brief Represents an action type, identifying one of several types of
  50  * ModelAction */
  51 typedef enum action_type {
  52         MODEL_FIXUP_RELSEQ,   /**< Special ModelAction: finalize a release
  53                                *   sequence */
  54         THREAD_CREATE,        /**< A thread creation action */
  55         THREAD_START,         /**< First action in each thread */
  56         THREAD_YIELD,         /**< A thread yield action */
  57         THREAD_JOIN,          /**< A thread join action */
  58         THREAD_FINISH,        /**< A thread completion action */
  59         ATOMIC_UNINIT,        /**< Represents an uninitialized atomic */
  60         ATOMIC_READ,          /**< An atomic read action */
  61         ATOMIC_WRITE,         /**< An atomic write action */
  62         ATOMIC_RMWR,          /**< The read part of an atomic RMW action */
  63         ATOMIC_RMW,           /**< The write part of an atomic RMW action */
  64         ATOMIC_RMWC,          /**< Convert an atomic RMW action into a READ */
  65         ATOMIC_INIT,          /**< Initialization of an atomic object (e.g.,
  66                                *   atomic_init()) */
  67         ATOMIC_FENCE,         /**< A fence action */
  68         ATOMIC_LOCK,          /**< A lock action */
  69         ATOMIC_TRYLOCK,       /**< A trylock action */
  70         ATOMIC_UNLOCK,        /**< An unlock action */
  71         ATOMIC_NOTIFY_ONE,    /**< A notify_one action */
  72         ATOMIC_NOTIFY_ALL,    /**< A notify all action */
  73         ATOMIC_WAIT,          /**< A wait action */
  74         ATOMIC_ANNOTATION     /**< An annotation action to pass information
  75                                                                                                          to a trace analysis */
  76 } action_type_t;
  77
  78 /* Forward declaration */
  79 class Node;
  80 class ClockVector;
  81
  82 /**
  83  * @brief Represents a single atomic action
  84  *
  85  * A ModelAction is always allocated as non-snapshotting, because it is used in
  86  * multiple executions during backtracking. Except for fake uninitialized
  87  * (ATOMIC_UNINIT) ModelActions, each action is assigned a unique sequence
  88  * number.
  89  */
  90 class ModelAction {
  91 public:
  92         ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE, Thread *thread = NULL);
  93         ~ModelAction();
  94         void print() const;
  95
  96         thread_id_t get_tid() const { return tid; }
  97         action_type get_type() const { return type; }
  98         memory_order get_mo() const { return order; }
  99         memory_order get_original_mo() const { return original_order; }
 100         void set_mo(memory_order order) { this->order = order; }
 101         void * get_location() const { return location; }
 102         modelclock_t get_seq_number() const { return seq_number; }
 103         uint64_t get_value() const { return value; }
 104         uint64_t get_reads_from_value() const;
 105         uint64_t get_write_value() const;
 106         uint64_t get_return_value() const;
 107         const ModelAction * get_reads_from() const { return reads_from; }
 108         Promise * get_reads_from_promise() const { return reads_from_promise; }
 109         std::mutex * get_mutex() const;
 110
 111         Node * get_node() const;
 112         void set_node(Node *n) { node = n; }
 113
 114         void set_read_from(const ModelAction *act);
 115         void set_read_from_promise(Promise *promise);
 116
 117         /** Store the most recent fence-release from the same thread
 118          *  @param fence The fence-release that occured prior to this */
 119         void set_last_fence_release(const ModelAction *fence) { last_fence_release = fence; }
 120         /** @return The most recent fence-release from the same thread */
 121         const ModelAction * get_last_fence_release() const { return last_fence_release; }
 122
 123         void copy_from_new(ModelAction *newaction);
 124         void set_seq_number(modelclock_t num);
 125         void set_try_lock(bool obtainedlock);
 126         bool is_thread_start() const;
 127         bool is_thread_join() const;
 128         bool is_relseq_fixup() const;
 129         bool is_mutex_op() const;
 130         bool is_lock() const;
 131         bool is_trylock() const;
 132         bool is_unlock() const;
 133         bool is_wait() const;
 134         bool is_notify() const;
 135         bool is_notify_one() const;
 136         bool is_success_lock() const;
 137         bool is_failed_trylock() const;
 138         bool is_atomic_var() const;
 139         bool is_uninitialized() const;
 140         bool is_read() const;
 141         bool is_write() const;
 142         bool is_yield() const;
 143         bool could_be_write() const;
 144         bool is_rmwr() const;
 145         bool is_rmwc() const;
 146         bool is_rmw() const;
 147         bool is_fence() const;
 148         bool is_initialization() const;
 149         bool is_annotation() const;
 150         bool is_relaxed() const;
 151         bool is_acquire() const;
 152         bool is_release() const;
 153         bool is_seqcst() const;
 154         bool same_var(const ModelAction *act) const;
 155         bool same_thread(const ModelAction *act) const;
 156         bool is_conflicting_lock(const ModelAction *act) const;
 157         bool could_synchronize_with(const ModelAction *act) const;
 158
 159         Thread * get_thread_operand() const;
 160
 161         void create_cv(const ModelAction *parent = NULL);
 162         ClockVector * get_cv() const { return cv; }
 163         bool synchronize_with(const ModelAction *act);
 164
 165         bool has_synchronized_with(const ModelAction *act) const;
 166         bool happens_before(const ModelAction *act) const;
 167
 168         inline bool operator <(const ModelAction& act) const {
 169                 return get_seq_number() < act.get_seq_number();
 170         }
 171         inline bool operator >(const ModelAction& act) const {
 172                 return get_seq_number() > act.get_seq_number();
 173         }
 174
 175         void process_rmw(ModelAction * act);
 176         void copy_typeandorder(ModelAction * act);
 177
 178         void set_sleep_flag() { sleep_flag=true; }
 179         bool get_sleep_flag() { return sleep_flag; }
 180         unsigned int hash() const;
 181
 182         bool equals(const ModelAction *x) const { return this == x; }
 183         bool equals(const Promise *x) const { return false; }
 184
 185         bool may_read_from(const ModelAction *write) const;
 186         bool may_read_from(const Promise *promise) const;
 187         MEMALLOC
 188 private:
 189
 190         const char * get_type_str() const;
 191         const char * get_mo_str() const;
 192
 193         /** @brief Type of action (read, write, RMW, fence, thread create, etc.) */
 194         action_type type;
 195
 196         /** @brief The memory order for this operation. */
 197         memory_order order;
 198
 199         /** @brief The original memory order parameter for this operation. */
 200         memory_order original_order;
 201
 202         /** @brief A pointer to the memory location for this action. */
 203         void *location;
 204
 205         /** @brief The thread id that performed this action. */
 206         thread_id_t tid;
 207
 208         /** @brief The value written (for write or RMW; undefined for read) */
 209         uint64_t value;
 210
 211         /**
 212          * @brief The store that this action reads from
 213          *
 214          * Only valid for reads
 215          */
 216         const ModelAction *reads_from;
 217
 218         /**
 219          * @brief The promise that this action reads from
 220          *
 221          * Only valid for reads
 222          */
 223         Promise *reads_from_promise;
 224
 225         /** @brief The last fence release from the same thread */
 226         const ModelAction *last_fence_release;
 227
 228         /**
 229          * @brief A back reference to a Node in NodeStack
 230          *
 231          * Only set if this ModelAction is saved on the NodeStack. (A
 232          * ModelAction can be thrown away before it ever enters the NodeStack.)
 233          */
 234         Node *node;
 235
 236         /**
 237          * @brief The sequence number of this action
 238          *
 239          * Except for ATOMIC_UNINIT actions, this number should be unique and
 240          * should represent the action's position in the execution order.
 241          */
 242         modelclock_t seq_number;
 243
 244         /**
 245          * @brief The clock vector for this operation
 246          *
 247          * Technically, this is only needed for potentially synchronizing
 248          * (e.g., non-relaxed) operations, but it is very handy to have these
 249          * vectors for all operations.
 250          */
 251         ClockVector *cv;
 252
 253         bool sleep_flag;
 254 };
 255
 256 #endif /* __ACTION_H__ */