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