2 * @brief Models actions taken by threads.
13 #include "clockvector.h"
14 #include "memoryorder.h"
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;
23 /** Note that this value can be legitimately used by a program, and
24 hence by iteself does not indicate no value. */
26 #define VALUE_NONE 1234567890
28 /** A special value to represent a successful trylock */
30 #define VALUE_TRYSUCCESS 1
32 /** A special value to represent a failed trylock */
33 #define VALUE_TRYFAILED 0
35 /** @brief Represents an action type, identifying one of several types of
37 typedef enum action_type {
38 THREAD_CREATE, /**< A thread creation action */
39 THREAD_START, /**< First action in each thread */
40 THREAD_YIELD, /**< A thread yield action */
41 THREAD_JOIN, /**< A thread join action */
42 THREAD_FINISH, /**< A thread completion action */
43 ATOMIC_READ, /**< An atomic read action */
44 ATOMIC_WRITE, /**< An atomic write action */
45 ATOMIC_RMWR, /**< The read part of an atomic RMW action */
46 ATOMIC_RMW, /**< The write part of an atomic RMW action */
47 ATOMIC_RMWC, /**< Convert an atomic RMW action into a READ */
48 ATOMIC_INIT, /**< Initialization of an atomic object (e.g.,
50 ATOMIC_FENCE, /**< A fence action */
51 ATOMIC_LOCK, /**< A lock action */
52 ATOMIC_TRYLOCK, /**< A trylock action */
53 ATOMIC_UNLOCK /**< An unlock action */
56 /* Forward declaration */
61 * The ModelAction class encapsulates an atomic action.
65 ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE);
67 void print(bool print_cv = true) const;
69 thread_id_t get_tid() const { return tid; }
70 action_type get_type() const { return type; }
71 memory_order get_mo() const { return order; }
72 void * get_location() const { return location; }
73 modelclock_t get_seq_number() const { return seq_number; }
74 uint64_t get_value() const { return value; }
75 const ModelAction * get_reads_from() const { return reads_from; }
77 Node * get_node() const { return node; }
78 void set_node(Node *n) { node = n; }
80 void copy_from_new(ModelAction *newaction);
81 void set_seq_number(modelclock_t num);
82 void set_try_lock(bool obtainedlock);
83 bool is_mutex_op() const;
85 bool is_trylock() const;
86 bool is_unlock() const;
87 bool is_success_lock() const;
88 bool is_failed_trylock() const;
90 bool is_write() const;
94 bool is_fence() const;
95 bool is_initialization() const;
96 bool is_acquire() const;
97 bool is_release() const;
98 bool is_seqcst() const;
99 bool same_var(const ModelAction *act) const;
100 bool same_thread(const ModelAction *act) const;
101 bool is_conflicting_lock(const ModelAction *act) const;
102 bool is_synchronizing(const ModelAction *act) const;
104 void create_cv(const ModelAction *parent = NULL);
105 ClockVector * get_cv() const { return cv; }
106 void read_from(const ModelAction *act);
107 bool synchronize_with(const ModelAction *act);
109 bool has_synchronized_with(const ModelAction *act) const;
110 bool happens_before(const ModelAction *act) const;
112 inline bool operator <(const ModelAction& act) const {
113 return get_seq_number() < act.get_seq_number();
115 inline bool operator >(const ModelAction& act) const {
116 return get_seq_number() > act.get_seq_number();
119 void process_rmw(ModelAction * act);
120 void copy_typeandorder(ModelAction * act);
125 /** Type of action (read, write, thread create, thread yield, thread join) */
128 /** The memory order for this operation. */
131 /** A pointer to the memory location for this action. */
134 /** The thread id that performed this action. */
137 /** The value written (for write or RMW; undefined for read) */
140 /** The action that this action reads from. Only valid for reads */
141 const ModelAction *reads_from;
143 /** A back reference to a Node in NodeStack, if this ModelAction is
144 * saved on the NodeStack. */
147 modelclock_t seq_number;
149 /** The clock vector stored with this action; only needed if this
150 * action is a store release? */
154 typedef std::list<ModelAction *> action_list_t;
156 #endif /* __ACTION_H__ */