2 * @brief Models actions taken by threads.
13 #include "memoryorder.h"
14 #include "modeltypes.h"
18 using std::memory_order;
19 using std::memory_order_relaxed;
20 using std::memory_order_acquire;
21 using std::memory_order_release;
22 using std::memory_order_acq_rel;
23 using std::memory_order_seq_cst;
25 /** Note that this value can be legitimately used by a program, and
26 hence by iteself does not indicate no value. */
28 #define VALUE_NONE 1234567890
30 /** A special value to represent a successful trylock */
32 #define VALUE_TRYSUCCESS 1
34 /** A special value to represent a failed trylock */
35 #define VALUE_TRYFAILED 0
37 /** @brief Represents an action type, identifying one of several types of
39 typedef enum action_type {
40 MODEL_FIXUP_RELSEQ, /**< Special ModelAction: finalize a release
42 THREAD_CREATE, /**< A thread creation action */
43 THREAD_START, /**< First action in each thread */
44 THREAD_YIELD, /**< A thread yield action */
45 THREAD_JOIN, /**< A thread join action */
46 THREAD_FINISH, /**< A thread completion action */
47 ATOMIC_READ, /**< An atomic read action */
48 ATOMIC_WRITE, /**< An atomic write action */
49 ATOMIC_RMWR, /**< The read part of an atomic RMW action */
50 ATOMIC_RMW, /**< The write part of an atomic RMW action */
51 ATOMIC_RMWC, /**< Convert an atomic RMW action into a READ */
52 ATOMIC_INIT, /**< Initialization of an atomic object (e.g.,
54 ATOMIC_FENCE, /**< A fence action */
55 ATOMIC_LOCK, /**< A lock action */
56 ATOMIC_TRYLOCK, /**< A trylock action */
57 ATOMIC_UNLOCK /**< An unlock action */
60 /* Forward declaration */
65 * The ModelAction class encapsulates an atomic action.
69 ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE);
73 thread_id_t get_tid() const { return tid; }
74 action_type get_type() const { return type; }
75 memory_order get_mo() const { return order; }
76 void * get_location() const { return location; }
77 modelclock_t get_seq_number() const { return seq_number; }
78 uint64_t get_value() const { return value; }
79 const ModelAction * get_reads_from() const { return reads_from; }
81 Node * get_node() const { return node; }
82 void set_node(Node *n) { node = n; }
84 void copy_from_new(ModelAction *newaction);
85 void set_seq_number(modelclock_t num);
86 void set_try_lock(bool obtainedlock);
87 bool is_relseq_fixup() const;
88 bool is_mutex_op() const;
90 bool is_trylock() const;
91 bool is_unlock() const;
92 bool is_success_lock() const;
93 bool is_failed_trylock() const;
95 bool is_write() const;
99 bool is_fence() const;
100 bool is_initialization() const;
101 bool is_acquire() const;
102 bool is_release() const;
103 bool is_seqcst() const;
104 bool same_var(const ModelAction *act) const;
105 bool same_thread(const ModelAction *act) const;
106 bool is_conflicting_lock(const ModelAction *act) const;
107 bool could_synchronize_with(const ModelAction *act) const;
109 void create_cv(const ModelAction *parent = NULL);
110 ClockVector * get_cv() const { return cv; }
111 bool read_from(const ModelAction *act);
112 bool synchronize_with(const ModelAction *act);
114 bool has_synchronized_with(const ModelAction *act) const;
115 bool happens_before(const ModelAction *act) const;
117 inline bool operator <(const ModelAction& act) const {
118 return get_seq_number() < act.get_seq_number();
120 inline bool operator >(const ModelAction& act) const {
121 return get_seq_number() > act.get_seq_number();
124 void process_rmw(ModelAction * act);
125 void copy_typeandorder(ModelAction * act);
130 /** Type of action (read, write, thread create, thread yield, thread join) */
133 /** The memory order for this operation. */
136 /** A pointer to the memory location for this action. */
139 /** The thread id that performed this action. */
142 /** The value written (for write or RMW; undefined for read) */
145 /** The action that this action reads from. Only valid for reads */
146 const ModelAction *reads_from;
148 /** A back reference to a Node in NodeStack, if this ModelAction is
149 * saved on the NodeStack. */
152 modelclock_t seq_number;
154 /** The clock vector stored with this action; only needed if this
155 * action is a store release? */
159 typedef std::list<ModelAction *> action_list_t;
161 #endif /* __ACTION_H__ */