1 /** @file threads-model.h
2 * @brief Model Checker Thread class.
5 #ifndef __THREADS_MODEL_H__
6 #define __THREADS_MODEL_H__
11 #include "modeltypes.h"
12 #include "stl-model.h"
14 #include "classlist.h"
16 #include <sys/epoll.h>
18 struct thread_params {
23 /** @brief Represents the state of a user Thread */
24 typedef enum thread_state {
25 /** Thread was just created and hasn't run yet */
27 /** Thread is running */
29 /** Thread is not currently running but is ready to run */
32 * Thread is waiting on another action (e.g., thread completion, lock
36 /** Thread has completed its execution */
42 /** @brief A Thread is created for each user-space thread */
45 Thread(thread_id_t tid);
46 Thread(thread_id_t tid, thrd_t *t, void (*func)(void *), void *a, Thread *parent);
47 Thread(thread_id_t tid, thrd_t *t, void *(*func)(void *), void *a, Thread *parent);
53 static int swap(ucontext_t *ctxt, Thread *t);
54 static int swap(Thread *t, ucontext_t *ctxt);
55 static int swap(Thread *t, Thread *t2);
57 thread_state get_state() const { return state; }
58 void set_state(thread_state s);
59 thread_id_t get_id() const;
60 thrd_t get_thrd_t() const { return *user_thread; }
61 Thread * get_parent() const { return parent; }
63 void set_creation(ModelAction *act) { creation = act; }
64 ModelAction * get_creation() const { return creation; }
67 * Set a return value for the last action in this thread (e.g., for an
69 * @param value The value to return
71 void set_return_value(uint64_t value) { last_action_val = value; }
74 * Retrieve a return value for the last action in this thread. Used,
75 * for instance, for an atomic read to return the 'read' value. Should
76 * be called from a user context.
77 * @return The value 'returned' by the action
79 uint64_t get_return_value() const { return last_action_val; }
81 /** @set and get the return value from pthread functions */
82 void set_pthread_return(void *ret) { pthread_return = ret; }
83 void * get_pthread_return() { return pthread_return; }
85 /** @return True if this thread is finished executing */
86 bool is_complete() const { return state == THREAD_COMPLETED || state == THREAD_FREED; }
88 /** @return True if this thread has finished and its resources have been freed */
89 bool is_freed() const { return state == THREAD_FREED; }
91 /** @return True if this thread is blocked */
92 bool is_blocked() const { return state == THREAD_BLOCKED; }
94 /** @return The pending (next) ModelAction for this Thread
95 * @see Thread::pending */
96 ModelAction * get_pending() const { return pending; }
98 /** @brief Set the pending (next) ModelAction for this Thread
99 * @param act The pending ModelAction
100 * @see Thread::pending */
101 void set_pending(ModelAction *act) { pending = act; }
103 bool just_woken_up() { return wakeup_state; }
104 void set_wakeup_state(bool state) { wakeup_state = state; }
106 Thread * waiting_on() const;
107 bool is_waiting_on(const Thread *t) const;
109 bool is_model_thread() const { return model_thread; }
111 void * get_stack_addr() { return stack; }
112 ClockVector * get_acq_fence_cv() { return acq_fence_cv; }
114 friend void thread_startup();
116 friend void setup_context();
117 friend void * helper_thread(void *);
118 friend void finalize_helper_thread();
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.
127 void * operator new(size_t size) {
128 return Thread_malloc(size);
130 void operator delete(void *p, size_t size) {
133 void * operator new[](size_t size) {
134 return Thread_malloc(size);
136 void operator delete[](void *p, size_t size) {
140 void setTLS(char *_tls) { tls = _tls;}
143 int create_context();
145 /** @brief The parent Thread which created this Thread */
146 Thread * const parent;
148 /** @brief Acquire fence cv */
149 ClockVector *acq_fence_cv;
151 /** @brief The THREAD_CREATE ModelAction which created this Thread */
152 ModelAction *creation;
155 * @brief The next ModelAction to be run by this Thread
157 * This action should be kept updated by the ModelChecker, so that we
158 * always know what the next ModelAction's memory_order, action type,
161 ModelAction *pending;
163 /** @brief True if this thread was just woken up */
166 void (*start_routine)(void *);
167 void *(*pstart_routine)(void *);
177 ucontext_t helpercontext;
178 pthread_mutex_t mutex;
179 pthread_mutex_t mutex2;
188 * The value returned by the last action in this thread
189 * @see Thread::set_return_value()
190 * @see Thread::get_return_value()
192 uint64_t last_action_val;
194 /** the value return from pthread functions */
195 void * pthread_return;
197 /** @brief Is this Thread a special model-checker thread? */
198 const bool model_thread;
202 uintptr_t get_tls_addr();
203 void tlsdestructor(void *v);
206 Thread * thread_current();
207 thread_id_t thread_current_id();
208 void thread_startup();
209 void initMainThread();
211 static inline thread_id_t thrd_to_id(thrd_t t)
213 return t.priv->get_id();
217 * @brief Map a zero-based integer index to a unique thread ID
219 * This is the inverse of id_to_int
221 static inline thread_id_t int_to_id(int i)
227 * @brief Map a unique thread ID to a zero-based integer index
229 * This is the inverse of int_to_id
231 static inline int id_to_int(thread_id_t id)
236 int real_epoll_wait(int epfd, struct epoll_event *events, int maxevents, int timeout);
237 int real_pthread_mutex_init(pthread_mutex_t *__mutex, const pthread_mutexattr_t *__mutexattr);
238 int real_pthread_mutex_lock (pthread_mutex_t *__mutex);
239 int real_pthread_mutex_unlock (pthread_mutex_t *__mutex);
240 int real_pthread_create (pthread_t *__restrict __newthread, const pthread_attr_t *__restrict __attr, void *(*__start_routine)(void *), void *__restrict __arg);
241 int real_pthread_join (pthread_t __th, void ** __thread_return);
242 void real_pthread_exit (void * value_ptr) __attribute__((noreturn));
243 void real_init_all();
245 #endif /* __THREADS_MODEL_H__ */