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
27 #define VALUE_TRYSUCCESS 1
28 #define VALUE_TRYFAILED 0
30 /** @brief Represents an action type, identifying one of several types of
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.,
51 /* Forward declaration */
56 * The ModelAction class encapsulates an atomic action.
60 ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE);
62 void print(void) const;
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; }
72 Node * get_node() const { return node; }
73 void set_node(Node *n) { node = n; }
75 void set_try_lock(bool obtainedlock);
76 bool is_mutex_op() const;
78 bool is_trylock() const;
79 bool is_unlock() const;
80 bool is_success_lock() const;
81 bool is_failed_trylock() const;
83 bool is_write() const;
87 bool is_fence() const;
88 bool is_initialization() const;
89 bool is_acquire() const;
90 bool is_release() const;
91 bool is_seqcst() const;
92 bool same_var(const ModelAction *act) const;
93 bool same_thread(const ModelAction *act) const;
94 bool is_synchronizing(const ModelAction *act) const;
96 void create_cv(const ModelAction *parent = NULL);
97 ClockVector * get_cv() const { return cv; }
98 void read_from(const ModelAction *act);
99 void synchronize_with(const ModelAction *act);
101 bool has_synchronized_with(const ModelAction *act) const;
102 bool happens_before(const ModelAction *act) const;
104 inline bool operator <(const ModelAction& act) const {
105 return get_seq_number() < act.get_seq_number();
107 inline bool operator >(const ModelAction& act) const {
108 return get_seq_number() > act.get_seq_number();
111 void process_rmw(ModelAction * act);
112 void copy_typeandorder(ModelAction * act);
117 /** Type of action (read, write, thread create, thread yield, thread join) */
120 /** The memory order for this operation. */
123 /** A pointer to the memory location for this action. */
126 /** The thread id that performed this action. */
129 /** The value written (for write or RMW; undefined for read) */
132 /** The action that this action reads from. Only valid for reads */
133 const ModelAction *reads_from;
135 /** A back reference to a Node in NodeStack, if this ModelAction is
136 * saved on the NodeStack. */
139 modelclock_t seq_number;
141 /** The clock vector stored with this action; only needed if this
142 * action is a store release? */
146 typedef std::list<ModelAction *> action_list_t;
148 #endif /* __ACTION_H__ */