model: schedule appropriate fence backtracking points
[c11tester.git] / threads-model.h
1 /** @file threads-model.h
2  *  @brief Model Checker Thread class.
3  */
4
5 #ifndef __THREADS_MODEL_H__
6 #define __THREADS_MODEL_H__
7
8 #include <ucontext.h>
9 #include <stdint.h>
10 #include <vector>
11
12 #include "mymemory.h"
13 #include <threads.h>
14 #include "modeltypes.h"
15
16 struct thread_params {
17         thrd_start_t func;
18         void *arg;
19 };
20
21 /** @brief Represents the state of a user Thread */
22 typedef enum thread_state {
23         /** Thread was just created and hasn't run yet */
24         THREAD_CREATED,
25         /** Thread is running */
26         THREAD_RUNNING,
27         /** Thread is not currently running but is ready to run */
28         THREAD_READY,
29         /**
30          * Thread is waiting on another action (e.g., thread completion, lock
31          * release, etc.)
32          */
33         THREAD_BLOCKED,
34         /** Thread has completed its execution */
35         THREAD_COMPLETED
36 } thread_state;
37
38 class ModelAction;
39
40 /** @brief A Thread is created for each user-space thread */
41 class Thread {
42 public:
43         Thread(thread_id_t tid);
44         Thread(thrd_t *t, void (*func)(void *), void *a);
45         ~Thread();
46         void complete();
47
48         static int swap(ucontext_t *ctxt, Thread *t);
49         static int swap(Thread *t, ucontext_t *ctxt);
50
51         thread_state get_state() const { return state; }
52         void set_state(thread_state s);
53         thread_id_t get_id() const;
54         thrd_t get_thrd_t() const { return *user_thread; }
55         Thread * get_parent() const { return parent; }
56
57         void set_creation(ModelAction *act) { creation = act; }
58         ModelAction * get_creation() const { return creation; }
59
60         /**
61          * Set a return value for the last action in this thread (e.g., for an
62          * atomic read).
63          * @param value The value to return
64          */
65         void set_return_value(uint64_t value) { last_action_val = value; }
66
67         /**
68          * Retrieve a return value for the last action in this thread. Used,
69          * for instance, for an atomic read to return the 'read' value. Should
70          * be called from a user context.
71          * @return The value 'returned' by the action
72          */
73         uint64_t get_return_value() const { return last_action_val; }
74
75         /** @return True if this thread is finished executing */
76         bool is_complete() const { return state == THREAD_COMPLETED; }
77
78         /** @return True if this thread is blocked */
79         bool is_blocked() const { return state == THREAD_BLOCKED; }
80
81         /** @return True if no threads are waiting on this Thread */
82         bool wait_list_empty() const { return wait_list.empty(); }
83
84         /**
85          * Add a ModelAction to the waiting list for this thread.
86          * @param t The ModelAction to add. Must be a JOIN.
87          */
88         void push_wait_list(ModelAction *act) { wait_list.push_back(act); }
89
90         unsigned int num_wait_list() const {
91                 return wait_list.size();
92         }
93
94         ModelAction * get_waiter(unsigned int i) const {
95                 return wait_list[i];
96         }
97
98         /** @return The pending (next) ModelAction for this Thread
99          *  @see Thread::pending */
100         ModelAction * get_pending() const { return pending; }
101
102         /** @brief Set the pending (next) ModelAction for this Thread
103          *  @param act The pending ModelAction
104          *  @see Thread::pending */
105         void set_pending(ModelAction *act) { pending = act; }
106
107         /**
108          * Remove one ModelAction from the waiting list
109          * @return The ModelAction that was removed from the waiting list
110          */
111         ModelAction * pop_wait_list() {
112                 ModelAction *ret = wait_list.front();
113                 wait_list.pop_back();
114                 return ret;
115         }
116
117         bool is_model_thread() const { return model_thread; }
118
119         friend void thread_startup();
120
121         /**
122          * Intentionally NOT allocated with MODELALLOC or SNAPSHOTALLOC.
123          * Threads should be allocated on the user's normal (snapshotting) heap
124          * to allow their allocation/deallocation to follow the same pattern as
125          * the rest of the backtracked/replayed program.
126          */
127 private:
128         int create_context();
129
130         /** @brief The parent Thread which created this Thread */
131         Thread *parent;
132
133         /** @brief The THREAD_CREATE ModelAction which created this Thread */
134         ModelAction *creation;
135
136         /**
137          * @brief The next ModelAction to be run by this Thread
138          *
139          * This action should be kept updated by the ModelChecker, so that we
140          * always know what the next ModelAction's memory_order, action type,
141          * and location are.
142          */
143         ModelAction *pending;
144
145         void (*start_routine)(void *);
146         void *arg;
147         ucontext_t context;
148         void *stack;
149         thrd_t *user_thread;
150         thread_id_t id;
151         thread_state state;
152
153         /**
154          * A list of ModelActions waiting on this Thread. Particularly, this
155          * list is used for thread joins, where another Thread waits for this
156          * Thread to complete
157          */
158         std::vector< ModelAction *, SnapshotAlloc<ModelAction *> > wait_list;
159
160         /**
161          * The value returned by the last action in this thread
162          * @see Thread::set_return_value()
163          * @see Thread::get_return_value()
164          */
165         uint64_t last_action_val;
166
167         /** @brief Is this Thread a special model-checker thread? */
168         const bool model_thread;
169 };
170
171 Thread * thread_current();
172
173 static inline thread_id_t thrd_to_id(thrd_t t)
174 {
175         return t.priv->get_id();
176 }
177
178 /**
179  * @brief Map a zero-based integer index to a unique thread ID
180  *
181  * This is the inverse of id_to_int
182  */
183 static inline thread_id_t int_to_id(int i)
184 {
185         return i;
186 }
187
188 /**
189  * @brief Map a unique thread ID to a zero-based integer index
190  *
191  * This is the inverse of int_to_id
192  */
193 static inline int id_to_int(thread_id_t id)
194 {
195         return id;
196 }
197
198 #endif /* __THREADS_MODEL_H__ */