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 } action_type_t;
  44
  45 /* Forward declaration */
  46 class Node;
  47 class ClockVector;
  48
  49 /**
  50  * The ModelAction class encapsulates an atomic action.
  51  */
  52 class ModelAction {
  53 public:
  54         ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE);
  55         ~ModelAction();
  56         void print(void) const;
  57
  58         thread_id_t get_tid() const { return tid; }
  59         action_type get_type() const { return type; }
  60         memory_order get_mo() const { return order; }
  61         void * get_location() const { return location; }
  62         modelclock_t get_seq_number() const { return seq_number; }
  63         uint64_t get_value() const { return value; }
  64         const ModelAction * get_reads_from() const { return reads_from; }
  65
  66         Node * get_node() const { return node; }
  67         void set_node(Node *n) { node = n; }
  68
  69         bool is_read() const;
  70         bool is_write() const;
  71         bool is_rmwr() const;
  72         bool is_rmwc() const;
  73         bool is_rmw() const;
  74         bool is_initialization() const;
  75         bool is_acquire() const;
  76         bool is_release() const;
  77         bool is_seqcst() const;
  78         bool same_var(const ModelAction *act) const;
  79         bool same_thread(const ModelAction *act) const;
  80         bool is_synchronizing(const ModelAction *act) const;
  81
  82         void create_cv(const ModelAction *parent = NULL);
  83         ClockVector * get_cv() const { return cv; }
  84         void read_from(const ModelAction *act);
  85         void synchronize_with(const ModelAction *act);
  86
  87         bool has_synchronized_with(const ModelAction *act) const;
  88         bool happens_before(const ModelAction *act) const;
  89
  90         inline bool operator <(const ModelAction& act) const {
  91                 return get_seq_number() < act.get_seq_number();
  92         }
  93         inline bool operator >(const ModelAction& act) const {
  94                 return get_seq_number() > act.get_seq_number();
  95         }
  96
  97         void process_rmw(ModelAction * act);
  98         void copy_typeandorder(ModelAction * act);
  99
 100         MEMALLOC
 101 private:
 102
 103         /** Type of action (read, write, thread create, thread yield, thread join) */
 104         action_type type;
 105
 106         /** The memory order for this operation. */
 107         memory_order order;
 108
 109         /** A pointer to the memory location for this action. */
 110         void *location;
 111
 112         /** The thread id that performed this action. */
 113         thread_id_t tid;
 114
 115         /** The value written (for write or RMW; undefined for read) */
 116         uint64_t value;
 117
 118         /** The action that this action reads from. Only valid for reads */
 119         const ModelAction *reads_from;
 120
 121         /** A back reference to a Node in NodeStack, if this ModelAction is
 122          * saved on the NodeStack. */
 123         Node *node;
 124
 125         modelclock_t seq_number;
 126
 127         /** The clock vector stored with this action; only needed if this
 128          * action is a store release? */
 129         ClockVector *cv;
 130 };
 131
 132 typedef std::list<ModelAction *> action_list_t;
 133
 134 #endif /* __ACTION_H__ */