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 #include "pthread.h"
  15
  16 /* Forward declarations */
  17 class ClockVector;
  18 class Thread;
  19
  20 namespace cdsc {
  21         class mutex;
  22 }
  23
  24 using std::memory_order;
  25 using std::memory_order_relaxed;
  26 using std::memory_order_consume;
  27 using std::memory_order_acquire;
  28 using std::memory_order_release;
  29 using std::memory_order_acq_rel;
  30 using std::memory_order_seq_cst;
  31
  32 /**
  33  * @brief A recognizable don't-care value for use in the ModelAction::value
  34  * field
  35  *
  36  * Note that this value can be legitimately used by a program, and hence by
  37  * iteself does not indicate no value.
  38  */
  39 #define VALUE_NONE 0xdeadbeef
  40
  41 /**
  42  * @brief The "location" at which a fence occurs
  43  *
  44  * We need a non-zero memory location to associate with fences, since our hash
  45  * tables don't handle NULL-pointer keys. HACK: Hopefully this doesn't collide
  46  * with any legitimate memory locations.
  47  */
  48 #define FENCE_LOCATION ((void *)0x7)
  49
  50 /** @brief Represents an action type, identifying one of several types of
  51  * ModelAction */
  52 typedef enum action_type {
  53         THREAD_CREATE,        /**< A thread creation action */
  54         THREAD_START,         /**< First action in each thread */
  55         THREAD_YIELD,         /**< A thread yield action */
  56         THREAD_JOIN,          /**< A thread join action */
  57         THREAD_FINISH,        /**< A thread completion action */
  58         PTHREAD_CREATE,       /**< A pthread creation action */
  59         PTHREAD_JOIN,         /**< A pthread join action */
  60
  61         ATOMIC_UNINIT,        /**< Represents an uninitialized atomic */
  62         ATOMIC_READ,          /**< An atomic read action */
  63         ATOMIC_WRITE,         /**< An atomic write action */
  64         ATOMIC_RMWR,          /**< The read part of an atomic RMW action */
  65         ATOMIC_RMW,           /**< The write part of an atomic RMW action */
  66         ATOMIC_RMWC,          /**< Convert an atomic RMW action into a READ */
  67         ATOMIC_INIT,          /**< Initialization of an atomic object (e.g.,
  68                                *   atomic_init()) */
  69         ATOMIC_FENCE,         /**< A fence action */
  70         ATOMIC_LOCK,          /**< A lock action */
  71         ATOMIC_TRYLOCK,       /**< A trylock action */
  72         ATOMIC_UNLOCK,        /**< An unlock action */
  73         ATOMIC_NOTIFY_ONE,    /**< A notify_one action */
  74         ATOMIC_NOTIFY_ALL,    /**< A notify all action */
  75         ATOMIC_WAIT,          /**< A wait action */
  76         ATOMIC_ANNOTATION,     /**< An annotation action to pass information
  77                                                                                                          to a trace analysis */
  78         NOOP
  79 } action_type_t;
  80
  81 /* Forward declaration */
  82 class Node;
  83 class ClockVector;
  84
  85 /**
  86  * @brief Represents a single atomic action
  87  *
  88  * A ModelAction is always allocated as non-snapshotting, because it is used in
  89  * multiple executions during backtracking. Except for fake uninitialized
  90  * (ATOMIC_UNINIT) ModelActions, each action is assigned a unique sequence
  91  * number.
  92  */
  93 class ModelAction {
  94 public:
  95         ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE, Thread *thread = NULL);
  96         ~ModelAction();
  97         void print() const;
  98
  99         thread_id_t get_tid() const { return tid; }
 100         action_type get_type() const { return type; }
 101         memory_order get_mo() const { return order; }
 102         memory_order get_original_mo() const { return original_order; }
 103         void set_mo(memory_order order) { this->order = order; }
 104         void * get_location() const { return location; }
 105         modelclock_t get_seq_number() const { return seq_number; }
 106         uint64_t get_value() const { return value; }
 107         uint64_t get_reads_from_value() const;
 108         uint64_t get_write_value() const;
 109         uint64_t get_return_value() const;
 110         const ModelAction * get_reads_from() const { return reads_from; }
 111         cdsc::mutex * get_mutex() const;
 112
 113         Node * get_node() const;
 114         void set_node(Node *n) { node = n; }
 115
 116         void set_read_from(const ModelAction *act);
 117
 118         /** Store the most recent fence-release from the same thread
 119          *  @param fence The fence-release that occured prior to this */
 120         void set_last_fence_release(const ModelAction *fence) { last_fence_release = fence; }
 121         /** @return The most recent fence-release from the same thread */
 122         const ModelAction * get_last_fence_release() const { return last_fence_release; }
 123
 124         void copy_from_new(ModelAction *newaction);
 125         void set_seq_number(modelclock_t num);
 126         void set_try_lock(bool obtainedlock);
 127         bool is_thread_start() const;
 128         bool is_thread_join() 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
 184         MEMALLOC
 185
 186         void set_value(uint64_t val) { value = val; }
 187
 188         /* to accomodate pthread create and join */
 189         Thread * thread_operand;
 190         void set_thread_operand(Thread *th) { thread_operand = th; }
 191 private:
 192
 193         const char * get_type_str() const;
 194         const char * get_mo_str() const;
 195
 196         /** @brief Type of action (read, write, RMW, fence, thread create, etc.) */
 197         action_type type;
 198
 199         /** @brief The memory order for this operation. */
 200         memory_order order;
 201
 202         /** @brief The original memory order parameter for this operation. */
 203         memory_order original_order;
 204
 205         /** @brief A pointer to the memory location for this action. */
 206         void *location;
 207
 208         /** @brief The thread id that performed this action. */
 209         thread_id_t tid;
 210
 211         /** @brief The value written (for write or RMW; undefined for read) */
 212         uint64_t value;
 213
 214         /**
 215          * @brief The store that this action reads from
 216          *
 217          * Only valid for reads
 218          */
 219         const ModelAction *reads_from;
 220
 221         /** @brief The last fence release from the same thread */
 222         const ModelAction *last_fence_release;
 223
 224         /**
 225          * @brief A back reference to a Node in NodeStack
 226          *
 227          * Only set if this ModelAction is saved on the NodeStack. (A
 228          * ModelAction can be thrown away before it ever enters the NodeStack.)
 229          */
 230         Node *node;
 231
 232         /**
 233          * @brief The sequence number of this action
 234          *
 235          * Except for ATOMIC_UNINIT actions, this number should be unique and
 236          * should represent the action's position in the execution order.
 237          */
 238         modelclock_t seq_number;
 239
 240         /**
 241          * @brief The clock vector for this operation
 242          *
 243          * Technically, this is only needed for potentially synchronizing
 244          * (e.g., non-relaxed) operations, but it is very handy to have these
 245          * vectors for all operations.
 246          */
 247         ClockVector *cv;
 248
 249         bool sleep_flag;
 250 };
 251
 252 #endif /* __ACTION_H__ */