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 <list>
   9 #include <cstddef>
  10
  11 #include "threads.h"
  12 #include "mymemory.h"
  13 #include "clockvector.h"
  14 #include "memoryorder.h"
  15
  16 using std::memory_order;
  17 using std::memory_order_relaxed;
  18 using std::memory_order_acquire;
  19 using std::memory_order_release;
  20 using std::memory_order_acq_rel;
  21 using std::memory_order_seq_cst;
  22
  23 /** Note that this value can be legitimately used by a program, and
  24                 hence by iteself does not indicate no value. */
  25
  26 #define VALUE_NONE 1234567890
  27 #define VALUE_TRYSUCCESS 1
  28 #define VALUE_TRYFAILED 0
  29
  30 /** @brief Represents an action type, identifying one of several types of
  31  * ModelAction */
  32 typedef enum action_type {
  33         THREAD_CREATE,        /**< A thread creation action */
  34         THREAD_START,         /**< First action in each thread */
  35         THREAD_YIELD,         /**< A thread yield action */
  36         THREAD_JOIN,          /**< A thread join action */
  37         THREAD_FINISH,        /**< A thread completion action */
  38         ATOMIC_READ,          /**< An atomic read action */
  39         ATOMIC_WRITE,         /**< An atomic write action */
  40         ATOMIC_RMWR,          /**< The read part of an atomic RMW action */
  41         ATOMIC_RMW,           /**< The write part of an atomic RMW action */
  42         ATOMIC_RMWC,          /**< Convert an atomic RMW action into a READ */
  43         ATOMIC_INIT,          /**< Initialization of an atomic object (e.g.,
  44                                *   atomic_init()) */
  45         ATOMIC_FENCE,
  46         ATOMIC_LOCK,
  47         ATOMIC_TRYLOCK,
  48         ATOMIC_UNLOCK
  49 } action_type_t;
  50
  51 /* Forward declaration */
  52 class Node;
  53 class ClockVector;
  54
  55 /**
  56  * The ModelAction class encapsulates an atomic action.
  57  */
  58 class ModelAction {
  59 public:
  60         ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE);
  61         ~ModelAction();
  62         void print(void) const;
  63
  64         thread_id_t get_tid() const { return tid; }
  65         action_type get_type() const { return type; }
  66         memory_order get_mo() const { return order; }
  67         void * get_location() const { return location; }
  68         modelclock_t get_seq_number() const { return seq_number; }
  69         uint64_t get_value() const { return value; }
  70         const ModelAction * get_reads_from() const { return reads_from; }
  71
  72         Node * get_node() const { return node; }
  73         void set_node(Node *n) { node = n; }
  74
  75         bool is_success_lock() const;
  76         bool is_failed_trylock() const;
  77         bool is_read() const;
  78         bool is_write() const;
  79         bool is_rmwr() const;
  80         bool is_rmwc() const;
  81         bool is_rmw() const;
  82         bool is_fence() const;
  83         bool is_initialization() const;
  84         bool is_acquire() const;
  85         bool is_release() const;
  86         bool is_seqcst() const;
  87         bool same_var(const ModelAction *act) const;
  88         bool same_thread(const ModelAction *act) const;
  89         bool is_synchronizing(const ModelAction *act) const;
  90
  91         void create_cv(const ModelAction *parent = NULL);
  92         ClockVector * get_cv() const { return cv; }
  93         void read_from(const ModelAction *act);
  94         void synchronize_with(const ModelAction *act);
  95
  96         bool has_synchronized_with(const ModelAction *act) const;
  97         bool happens_before(const ModelAction *act) const;
  98
  99         inline bool operator <(const ModelAction& act) const {
 100                 return get_seq_number() < act.get_seq_number();
 101         }
 102         inline bool operator >(const ModelAction& act) const {
 103                 return get_seq_number() > act.get_seq_number();
 104         }
 105
 106         void process_rmw(ModelAction * act);
 107         void copy_typeandorder(ModelAction * act);
 108
 109         MEMALLOC
 110 private:
 111
 112         /** Type of action (read, write, thread create, thread yield, thread join) */
 113         action_type type;
 114
 115         /** The memory order for this operation. */
 116         memory_order order;
 117
 118         /** A pointer to the memory location for this action. */
 119         void *location;
 120
 121         /** The thread id that performed this action. */
 122         thread_id_t tid;
 123
 124         /** The value written (for write or RMW; undefined for read) */
 125         uint64_t value;
 126
 127         /** The action that this action reads from. Only valid for reads */
 128         const ModelAction *reads_from;
 129
 130         /** A back reference to a Node in NodeStack, if this ModelAction is
 131          * saved on the NodeStack. */
 132         Node *node;
 133
 134         modelclock_t seq_number;
 135
 136         /** The clock vector stored with this action; only needed if this
 137          * action is a store release? */
 138         ClockVector *cv;
 139 };
 140
 141 typedef std::list<ModelAction *> action_list_t;
 142
 143 #endif /* __ACTION_H__ */