2 * @brief Models actions taken by threads.
12 #include "memoryorder.h"
13 #include "modeltypes.h"
16 /* Forward declarations */
25 using std::memory_order;
26 using std::memory_order_relaxed;
27 using std::memory_order_consume;
28 using std::memory_order_acquire;
29 using std::memory_order_release;
30 using std::memory_order_acq_rel;
31 using std::memory_order_seq_cst;
34 * @brief A recognizable don't-care value for use in the ModelAction::value
37 * Note that this value can be legitimately used by a program, and hence by
38 * iteself does not indicate no value.
40 #define VALUE_NONE 0xdeadbeef
43 * @brief The "location" at which a fence occurs
45 * We need a non-zero memory location to associate with fences, since our hash
46 * tables don't handle NULL-pointer keys. HACK: Hopefully this doesn't collide
47 * with any legitimate memory locations.
49 #define FENCE_LOCATION ((void *)0x7)
51 /** @brief Represents an action type, identifying one of several types of
53 typedef enum action_type {
54 MODEL_FIXUP_RELSEQ, /**< Special ModelAction: finalize a release
56 THREAD_CREATE, /**< A thread creation action */
57 THREAD_START, /**< First action in each thread */
58 THREAD_YIELD, /**< A thread yield action */
59 THREAD_JOIN, /**< A thread join action */
60 THREAD_FINISH, /**< A thread completion action */
61 PTHREAD_CREATE, /**< A pthread creation action */
62 PTHREAD_JOIN, /**< A pthread join action */
64 ATOMIC_UNINIT, /**< Represents an uninitialized atomic */
65 ATOMIC_READ, /**< An atomic read action */
66 ATOMIC_WRITE, /**< An atomic write action */
67 ATOMIC_RMWR, /**< The read part of an atomic RMW action */
68 ATOMIC_RMW, /**< The write part of an atomic RMW action */
69 ATOMIC_RMWC, /**< Convert an atomic RMW action into a READ */
70 ATOMIC_INIT, /**< Initialization of an atomic object (e.g.,
72 ATOMIC_FENCE, /**< A fence action */
73 ATOMIC_LOCK, /**< A lock action */
74 ATOMIC_TRYLOCK, /**< A trylock action */
75 ATOMIC_UNLOCK, /**< An unlock action */
76 ATOMIC_NOTIFY_ONE, /**< A notify_one action */
77 ATOMIC_NOTIFY_ALL, /**< A notify all action */
78 ATOMIC_WAIT, /**< A wait action */
79 ATOMIC_ANNOTATION, /**< An annotation action to pass information
80 to a trace analysis */
84 /* Forward declaration */
89 * @brief Represents a single atomic action
91 * A ModelAction is always allocated as non-snapshotting, because it is used in
92 * multiple executions during backtracking. Except for fake uninitialized
93 * (ATOMIC_UNINIT) ModelActions, each action is assigned a unique sequence
98 ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE, Thread *thread = NULL);
102 thread_id_t get_tid() const { return tid; }
103 action_type get_type() const { return type; }
104 memory_order get_mo() const { return order; }
105 memory_order get_original_mo() const { return original_order; }
106 void set_mo(memory_order order) { this->order = order; }
107 void * get_location() const { return location; }
108 modelclock_t get_seq_number() const { return seq_number; }
109 uint64_t get_value() const { return value; }
110 uint64_t get_reads_from_value() const;
111 uint64_t get_write_value() const;
112 uint64_t get_return_value() const;
113 const ModelAction * get_reads_from() const { return reads_from; }
114 Promise * get_reads_from_promise() const { return reads_from_promise; }
115 cdsc::mutex * get_mutex() const;
117 Node * get_node() const;
118 void set_node(Node *n) { node = n; }
120 void set_read_from(const ModelAction *act);
121 void set_read_from_promise(Promise *promise);
123 /** Store the most recent fence-release from the same thread
124 * @param fence The fence-release that occured prior to this */
125 void set_last_fence_release(const ModelAction *fence) { last_fence_release = fence; }
126 /** @return The most recent fence-release from the same thread */
127 const ModelAction * get_last_fence_release() const { return last_fence_release; }
129 void copy_from_new(ModelAction *newaction);
130 void set_seq_number(modelclock_t num);
131 void set_try_lock(bool obtainedlock);
132 bool is_thread_start() const;
133 bool is_thread_join() const;
134 bool is_relseq_fixup() const;
135 bool is_mutex_op() const;
136 bool is_lock() const;
137 bool is_trylock() const;
138 bool is_unlock() const;
139 bool is_wait() const;
140 bool is_notify() const;
141 bool is_notify_one() const;
142 bool is_success_lock() const;
143 bool is_failed_trylock() const;
144 bool is_atomic_var() const;
145 bool is_uninitialized() const;
146 bool is_read() const;
147 bool is_write() const;
148 bool is_yield() const;
149 bool could_be_write() const;
150 bool is_rmwr() const;
151 bool is_rmwc() const;
153 bool is_fence() const;
154 bool is_initialization() const;
155 bool is_annotation() const;
156 bool is_relaxed() const;
157 bool is_acquire() const;
158 bool is_release() const;
159 bool is_seqcst() const;
160 bool same_var(const ModelAction *act) const;
161 bool same_thread(const ModelAction *act) const;
162 bool is_conflicting_lock(const ModelAction *act) const;
163 bool could_synchronize_with(const ModelAction *act) const;
165 Thread * get_thread_operand() const;
167 void create_cv(const ModelAction *parent = NULL);
168 ClockVector * get_cv() const { return cv; }
169 bool synchronize_with(const ModelAction *act);
171 bool has_synchronized_with(const ModelAction *act) const;
172 bool happens_before(const ModelAction *act) const;
174 inline bool operator <(const ModelAction& act) const {
175 return get_seq_number() < act.get_seq_number();
177 inline bool operator >(const ModelAction& act) const {
178 return get_seq_number() > act.get_seq_number();
181 void process_rmw(ModelAction * act);
182 void copy_typeandorder(ModelAction * act);
184 void set_sleep_flag() { sleep_flag=true; }
185 bool get_sleep_flag() { return sleep_flag; }
186 unsigned int hash() const;
188 bool equals(const ModelAction *x) const { return this == x; }
189 bool equals(const Promise *x) const { return false; }
191 bool may_read_from(const ModelAction *write) const;
192 bool may_read_from(const Promise *promise) const;
195 void set_value(uint64_t val) { value = val; }
197 /* to accomodate pthread create and join */
198 Thread * thread_operand;
199 void set_thread_operand(Thread *th) { thread_operand = th; }
202 const char * get_type_str() const;
203 const char * get_mo_str() const;
205 /** @brief Type of action (read, write, RMW, fence, thread create, etc.) */
208 /** @brief The memory order for this operation. */
211 /** @brief The original memory order parameter for this operation. */
212 memory_order original_order;
214 /** @brief A pointer to the memory location for this action. */
217 /** @brief The thread id that performed this action. */
220 /** @brief The value written (for write or RMW; undefined for read) */
224 * @brief The store that this action reads from
226 * Only valid for reads
228 const ModelAction *reads_from;
231 * @brief The promise that this action reads from
233 * Only valid for reads
235 Promise *reads_from_promise;
237 /** @brief The last fence release from the same thread */
238 const ModelAction *last_fence_release;
241 * @brief A back reference to a Node in NodeStack
243 * Only set if this ModelAction is saved on the NodeStack. (A
244 * ModelAction can be thrown away before it ever enters the NodeStack.)
249 * @brief The sequence number of this action
251 * Except for ATOMIC_UNINIT actions, this number should be unique and
252 * should represent the action's position in the execution order.
254 modelclock_t seq_number;
257 * @brief The clock vector for this operation
259 * Technically, this is only needed for potentially synchronizing
260 * (e.g., non-relaxed) operations, but it is very handy to have these
261 * vectors for all operations.
268 #endif /* __ACTION_H__ */