2 * @brief Models actions taken by threads.
12 #include "memoryorder.h"
13 #include "modeltypes.h"
14 #include "mypthread.h"
15 #include "classlist.h"
21 using std::memory_order;
22 using std::memory_order_relaxed;
23 using std::memory_order_consume;
24 using std::memory_order_acquire;
25 using std::memory_order_release;
26 using std::memory_order_acq_rel;
27 using std::memory_order_seq_cst;
30 * @brief A recognizable don't-care value for use in the ModelAction::value
33 * Note that this value can be legitimately used by a program, and hence by
34 * iteself does not indicate no value.
36 #define VALUE_NONE 0xdeadbeef
39 * @brief The "location" at which a fence occurs
41 * We need a non-zero memory location to associate with fences, since our hash
42 * tables don't handle NULL-pointer keys. HACK: Hopefully this doesn't collide
43 * with any legitimate memory locations.
45 #define FENCE_LOCATION ((void *)0x7)
47 /** @brief Represents an action type, identifying one of several types of
49 typedef enum action_type {
50 THREAD_CREATE, // < A thread creation action
51 THREAD_START, // < First action in each thread
52 THREAD_YIELD, // < A thread yield action
53 THREAD_JOIN, // < A thread join action
54 THREAD_FINISH, // < A thread completion action
55 PTHREAD_CREATE, // < A pthread creation action
56 PTHREAD_JOIN, // < A pthread join action
57 ATOMIC_UNINIT, // < Represents an uninitialized atomic
58 ATOMIC_READ, // < An atomic read action
59 ATOMIC_WRITE, // < An atomic write action
60 ATOMIC_RMWR, // < The read part of an atomic RMW action
61 ATOMIC_RMWRCAS, // < The read part of an atomic RMW action
62 ATOMIC_RMW, // < The write part of an atomic RMW action
63 ATOMIC_RMWC, // < Convert an atomic RMW action into a READ
64 ATOMIC_INIT, // < Initialization of an atomic object (e.g., atomic_init())
65 ATOMIC_FENCE, // < A fence action
66 ATOMIC_LOCK, // < A lock action
67 ATOMIC_TRYLOCK, // < A trylock action
68 ATOMIC_UNLOCK, // < An unlock action
69 ATOMIC_NOTIFY_ONE, // < A notify_one action
70 ATOMIC_NOTIFY_ALL, // < A notify all action
71 ATOMIC_WAIT, // < A wait action
72 ATOMIC_ANNOTATION, // < An annotation action to pass information to a trace analysis
73 NOOP // no operation, which returns control to scheduler
78 * @brief Represents a single atomic action
80 * A ModelAction is always allocated as non-snapshotting, because it is used in
81 * multiple executions during backtracking. Except for fake uninitialized
82 * (ATOMIC_UNINIT) ModelActions, each action is assigned a unique sequence
87 ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE, Thread *thread = NULL);
88 ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value, int size);
89 ModelAction(action_type_t type, const char * position, memory_order order, void *loc, uint64_t value = VALUE_NONE, Thread *thread = NULL);
93 thread_id_t get_tid() const { return tid; }
94 action_type get_type() const { return type; }
95 memory_order get_mo() const { return order; }
96 memory_order get_original_mo() const { return original_order; }
97 void set_mo(memory_order order) { this->order = order; }
98 void * get_location() const { return location; }
99 const char * get_position() const { return position; }
100 modelclock_t get_seq_number() const { return seq_number; }
101 uint64_t get_value() const { return value; }
102 uint64_t get_reads_from_value() const;
103 uint64_t get_write_value() const;
104 uint64_t get_return_value() const;
105 const ModelAction * get_reads_from() const { return reads_from; }
106 cdsc::mutex * get_mutex() const;
108 Node * get_node() const;
109 void set_node(Node *n) { node = n; }
111 void set_read_from(const ModelAction *act);
113 /** Store the most recent fence-release from the same thread
114 * @param fence The fence-release that occured prior to this */
115 void set_last_fence_release(const ModelAction *fence) { last_fence_release = fence; }
116 /** @return The most recent fence-release from the same thread */
117 const ModelAction * get_last_fence_release() const { return last_fence_release; }
119 void copy_from_new(ModelAction *newaction);
120 void set_seq_number(modelclock_t num);
121 void set_try_lock(bool obtainedlock);
122 bool is_thread_start() const;
123 bool is_thread_join() const;
124 bool is_mutex_op() const;
125 bool is_lock() const;
126 bool is_trylock() const;
127 bool is_unlock() const;
128 bool is_wait() const;
129 bool is_notify() const;
130 bool is_notify_one() const;
131 bool is_success_lock() const;
132 bool is_failed_trylock() const;
133 bool is_atomic_var() const;
134 bool is_uninitialized() const;
135 bool is_read() const;
136 bool is_write() const;
137 bool is_yield() const;
138 bool could_be_write() const;
139 bool is_rmwr() const;
140 bool is_rmwrcas() const;
141 bool is_rmwc() const;
143 bool is_fence() const;
144 bool is_initialization() const;
145 bool is_annotation() const;
146 bool is_relaxed() const;
147 bool is_acquire() const;
148 bool is_release() const;
149 bool is_seqcst() const;
150 bool same_var(const ModelAction *act) const;
151 bool same_thread(const ModelAction *act) const;
152 bool is_conflicting_lock(const ModelAction *act) const;
153 bool could_synchronize_with(const ModelAction *act) const;
155 Thread * get_thread_operand() const;
156 void create_cv(const ModelAction *parent = NULL);
157 ClockVector * get_cv() const { return cv; }
158 bool synchronize_with(const ModelAction *act);
160 bool has_synchronized_with(const ModelAction *act) const;
161 bool happens_before(const ModelAction *act) const;
163 inline bool operator <(const ModelAction& act) const {
164 return get_seq_number() < act.get_seq_number();
166 inline bool operator >(const ModelAction& act) const {
167 return get_seq_number() > act.get_seq_number();
170 void process_rmw(ModelAction * act);
171 void copy_typeandorder(ModelAction * act);
172 unsigned int hash() const;
173 bool equals(const ModelAction *x) const { return this == x; }
174 void set_value(uint64_t val) { value = val; }
176 /* to accomodate pthread create and join */
177 Thread * thread_operand;
178 void set_thread_operand(Thread *th) { thread_operand = th; }
181 const char * get_type_str() const;
182 const char * get_mo_str() const;
184 /** @brief A pointer to the memory location for this action. */
187 /** @brief A pointer to the source line for this atomic action. */
188 const char * position;
192 * @brief The store that this action reads from
194 * Only valid for reads
196 const ModelAction *reads_from;
200 /** @brief The last fence release from the same thread */
201 const ModelAction *last_fence_release;
204 * @brief A back reference to a Node in NodeStack
206 * Only set if this ModelAction is saved on the NodeStack. (A
207 * ModelAction can be thrown away before it ever enters the NodeStack.)
212 * @brief The clock vector for this operation
214 * Technically, this is only needed for potentially synchronizing
215 * (e.g., non-relaxed) operations, but it is very handy to have these
216 * vectors for all operations.
220 /** @brief The value written (for write or RMW; undefined for read) */
223 /** @brief Type of action (read, write, RMW, fence, thread create, etc.) */
226 /** @brief The memory order for this operation. */
229 /** @brief The original memory order parameter for this operation. */
230 memory_order original_order;
232 /** @brief The thread id that performed this action. */
236 * @brief The sequence number of this action
238 * Except for ATOMIC_UNINIT actions, this number should be unique and
239 * should represent the action's position in the execution order.
241 modelclock_t seq_number;
244 #endif /* __ACTION_H__ */