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         void * get_location() const { return location; }
 100         modelclock_t get_seq_number() const { return seq_number; }
 101         uint64_t get_value() const { return value; }
 102         uint64_t get_reads_from_value() const;
 103         uint64_t get_write_value() const;
 104         uint64_t get_return_value() const;
 105         const ModelAction * get_reads_from() const { return reads_from; }
 106         Promise * get_reads_from_promise() const { return reads_from_promise; }
 107         std::mutex * get_mutex() const;
 108
 109         Node * get_node() const;
 110         void set_node(Node *n) { node = n; }
 111
 112         void set_read_from(const ModelAction *act);
 113         void set_read_from_promise(Promise *promise);
 114
 115         /** Store the most recent fence-release from the same thread
 116          *  @param fence The fence-release that occured prior to this */
 117         void set_last_fence_release(const ModelAction *fence) { last_fence_release = fence; }
 118         /** @return The most recent fence-release from the same thread */
 119         const ModelAction * get_last_fence_release() const { return last_fence_release; }
 120
 121         void copy_from_new(ModelAction *newaction);
 122         void set_seq_number(modelclock_t num);
 123         void set_try_lock(bool obtainedlock);
 124         bool is_thread_start() const;
 125         bool is_thread_join() const;
 126         bool is_relseq_fixup() const;
 127         bool is_mutex_op() const;
 128         bool is_lock() const;
 129         bool is_trylock() const;
 130         bool is_unlock() const;
 131         bool is_wait() const;
 132         bool is_notify() const;
 133         bool is_notify_one() const;
 134         bool is_success_lock() const;
 135         bool is_failed_trylock() const;
 136         bool is_atomic_var() const;
 137         bool is_uninitialized() const;
 138         bool is_read() const;
 139         bool is_write() const;
 140         bool is_yield() const;
 141         bool could_be_write() const;
 142         bool is_rmwr() const;
 143         bool is_rmwc() const;
 144         bool is_rmw() const;
 145         bool is_fence() const;
 146         bool is_initialization() const;
 147         bool is_annotation() const;
 148         bool is_relaxed() const;
 149         bool is_acquire() const;
 150         bool is_release() const;
 151         bool is_seqcst() const;
 152         bool same_var(const ModelAction *act) const;
 153         bool same_thread(const ModelAction *act) const;
 154         bool is_conflicting_lock(const ModelAction *act) const;
 155         bool could_synchronize_with(const ModelAction *act) const;
 156
 157         Thread * get_thread_operand() const;
 158
 159         void create_cv(const ModelAction *parent = NULL);
 160         ClockVector * get_cv() const { return cv; }
 161         bool synchronize_with(const ModelAction *act);
 162
 163         bool has_synchronized_with(const ModelAction *act) const;
 164         bool happens_before(const ModelAction *act) const;
 165
 166         inline bool operator <(const ModelAction& act) const {
 167                 return get_seq_number() < act.get_seq_number();
 168         }
 169         inline bool operator >(const ModelAction& act) const {
 170                 return get_seq_number() > act.get_seq_number();
 171         }
 172
 173         void process_rmw(ModelAction * act);
 174         void copy_typeandorder(ModelAction * act);
 175
 176         void set_sleep_flag() { sleep_flag=true; }
 177         bool get_sleep_flag() { return sleep_flag; }
 178         unsigned int hash() const;
 179
 180         bool equals(const ModelAction *x) const { return this == x; }
 181         bool equals(const Promise *x) const { return false; }
 182
 183         bool may_read_from(const ModelAction *write) const;
 184         bool may_read_from(const Promise *promise) const;
 185         MEMALLOC
 186 private:
 187
 188         const char * get_type_str() const;
 189         const char * get_mo_str() const;
 190
 191         /** @brief Type of action (read, write, RMW, fence, thread create, etc.) */
 192         action_type type;
 193
 194         /** @brief The memory order for this operation. */
 195         memory_order order;
 196
 197         /** @brief A pointer to the memory location for this action. */
 198         void *location;
 199
 200         /** @brief The thread id that performed this action. */
 201         thread_id_t tid;
 202
 203         /** @brief The value written (for write or RMW; undefined for read) */
 204         uint64_t value;
 205
 206         /**
 207          * @brief The store that this action reads from
 208          *
 209          * Only valid for reads
 210          */
 211         const ModelAction *reads_from;
 212
 213         /**
 214          * @brief The promise that this action reads from
 215          *
 216          * Only valid for reads
 217          */
 218         Promise *reads_from_promise;
 219
 220         /** @brief The last fence release from the same thread */
 221         const ModelAction *last_fence_release;
 222
 223         /**
 224          * @brief A back reference to a Node in NodeStack
 225          *
 226          * Only set if this ModelAction is saved on the NodeStack. (A
 227          * ModelAction can be thrown away before it ever enters the NodeStack.)
 228          */
 229         Node *node;
 230
 231         /**
 232          * @brief The sequence number of this action
 233          *
 234          * Except for ATOMIC_UNINIT actions, this number should be unique and
 235          * should represent the action's position in the execution order.
 236          */
 237         modelclock_t seq_number;
 238
 239         /**
 240          * @brief The clock vector for this operation
 241          *
 242          * Technically, this is only needed for potentially synchronizing
 243          * (e.g., non-relaxed) operations, but it is very handy to have these
 244          * vectors for all operations.
 245          */
 246         ClockVector *cv;
 247
 248         bool sleep_flag;
 249 };
 250
 251 #endif /* __ACTION_H__ */