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