4c40bd9bf9a4554ed7c984158334f359346031c5
[c11tester.git] / action.h
1 /** @file action.h
2  *  @brief Models actions taken by threads.
3  */
4
5 #ifndef __ACTION_H__
6 #define __ACTION_H__
7
8 #include <list>
9 #include <cstddef>
10 #include <inttypes.h>
11
12 #include "mymemory.h"
13 #include "memoryorder.h"
14 #include "modeltypes.h"
15
16 class ClockVector;
17 class Thread;
18
19 using std::memory_order;
20 using std::memory_order_relaxed;
21 using std::memory_order_acquire;
22 using std::memory_order_release;
23 using std::memory_order_acq_rel;
24 using std::memory_order_seq_cst;
25
26 /** Note that this value can be legitimately used by a program, and
27                 hence by iteself does not indicate no value. */
28
29 #define VALUE_NONE 0xdeadbeef
30
31 /** A special value to represent a successful trylock */
32
33 #define VALUE_TRYSUCCESS 1
34
35 /** A special value to represent a failed trylock */
36 #define VALUE_TRYFAILED 0
37
38 /** @brief Represents an action type, identifying one of several types of
39  * ModelAction */
40 typedef enum action_type {
41         MODEL_FIXUP_RELSEQ,   /**< Special ModelAction: finalize a release
42                                *   sequence */
43         THREAD_CREATE,        /**< A thread creation action */
44         THREAD_START,         /**< First action in each thread */
45         THREAD_YIELD,         /**< A thread yield action */
46         THREAD_JOIN,          /**< A thread join action */
47         THREAD_FINISH,        /**< A thread completion action */
48         ATOMIC_READ,          /**< An atomic read action */
49         ATOMIC_WRITE,         /**< An atomic write action */
50         ATOMIC_RMWR,          /**< The read part of an atomic RMW action */
51         ATOMIC_RMW,           /**< The write part of an atomic RMW action */
52         ATOMIC_RMWC,          /**< Convert an atomic RMW action into a READ */
53         ATOMIC_INIT,          /**< Initialization of an atomic object (e.g.,
54                                *   atomic_init()) */
55         ATOMIC_FENCE,         /**< A fence action */
56         ATOMIC_LOCK,          /**< A lock action */
57         ATOMIC_TRYLOCK,       /**< A trylock action */
58         ATOMIC_UNLOCK,        /**< An unlock action */
59         ATOMIC_NOTIFY_ONE,    /**< A notify_one action */
60         ATOMIC_NOTIFY_ALL,    /**< A notify all action */
61         ATOMIC_WAIT           /**< A wait action */
62 } action_type_t;
63
64 /* Forward declaration */
65 class Node;
66 class ClockVector;
67
68 /**
69  * The ModelAction class encapsulates an atomic action.
70  */
71 class ModelAction {
72 public:
73         ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE, Thread *thread = NULL);
74         ~ModelAction();
75         void print() const;
76
77         thread_id_t get_tid() const { return tid; }
78         action_type get_type() const { return type; }
79         memory_order get_mo() const { return order; }
80         void * get_location() const { return location; }
81         modelclock_t get_seq_number() const { return seq_number; }
82         uint64_t get_value() const { return value; }
83         const ModelAction * get_reads_from() const { return reads_from; }
84
85         Node * get_node() const { return node; }
86         void set_node(Node *n) { node = n; }
87
88         /** Store the most recent fence-release from the same thread
89          *  @param fence The fence-release that occured prior to this */
90         void set_last_fence_release(const ModelAction *fence) { last_fence_release = fence; }
91         /** @return The most recent fence-release from the same thread */
92         const ModelAction * get_last_fence_release() const { return last_fence_release; }
93
94         void copy_from_new(ModelAction *newaction);
95         void set_seq_number(modelclock_t num);
96         void set_try_lock(bool obtainedlock);
97         bool is_relseq_fixup() const;
98         bool is_mutex_op() const;
99         bool is_lock() const;
100         bool is_trylock() const;
101         bool is_unlock() const;
102         bool is_wait() const;
103         bool is_notify() const;
104         bool is_notify_one() const;
105         bool is_success_lock() const;
106         bool is_failed_trylock() const;
107         bool is_read() const;
108         bool is_write() const;
109         bool could_be_write() const;
110         bool is_rmwr() const;
111         bool is_rmwc() const;
112         bool is_rmw() const;
113         bool is_fence() const;
114         bool is_initialization() const;
115         bool is_relaxed() const;
116         bool is_acquire() const;
117         bool is_release() const;
118         bool is_seqcst() const;
119         bool same_var(const ModelAction *act) const;
120         bool same_thread(const ModelAction *act) const;
121         bool is_conflicting_lock(const ModelAction *act) const;
122         bool could_synchronize_with(const ModelAction *act) const;
123
124         void create_cv(const ModelAction *parent = NULL);
125         ClockVector * get_cv() const { return cv; }
126         bool read_from(const ModelAction *act);
127         bool synchronize_with(const ModelAction *act);
128
129         bool has_synchronized_with(const ModelAction *act) const;
130         bool happens_before(const ModelAction *act) const;
131
132         inline bool operator <(const ModelAction& act) const {
133                 return get_seq_number() < act.get_seq_number();
134         }
135         inline bool operator >(const ModelAction& act) const {
136                 return get_seq_number() > act.get_seq_number();
137         }
138
139         void process_rmw(ModelAction * act);
140         void copy_typeandorder(ModelAction * act);
141
142         void set_sleep_flag() { sleep_flag=true; }
143         bool get_sleep_flag() { return sleep_flag; }
144         unsigned int hash() const;
145
146         MEMALLOC
147 private:
148
149         /** Type of action (read, write, thread create, thread yield, thread join) */
150         action_type type;
151
152         /** The memory order for this operation. */
153         memory_order order;
154
155         /** A pointer to the memory location for this action. */
156         void *location;
157
158         /** The thread id that performed this action. */
159         thread_id_t tid;
160
161         /** The value written (for write or RMW; undefined for read) */
162         uint64_t value;
163
164         /** The action that this action reads from. Only valid for reads */
165         const ModelAction *reads_from;
166
167         /** The last fence release from the same thread */
168         const ModelAction *last_fence_release;
169
170         /** A back reference to a Node in NodeStack, if this ModelAction is
171          * saved on the NodeStack. */
172         Node *node;
173
174         modelclock_t seq_number;
175
176         /** The clock vector stored with this action; only needed if this
177          * action is a store release? */
178         ClockVector *cv;
179
180         bool sleep_flag;
181 };
182
183 typedef std::list< ModelAction *, SnapshotAlloc<ModelAction *> > action_list_t;
184
185 #endif /* __ACTION_H__ */