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"
17 struct thread_params {
22 /** @brief Represents the state of a user Thread */
23 typedef enum thread_state {
24 /** Thread was just created and hasn't run yet */
26 /** Thread is running */
28 /** Thread is not currently running but is ready to run */
31 * Thread is waiting on another action (e.g., thread completion, lock
35 /** Thread has completed its execution */
40 /** @brief A Thread is created for each user-space thread */
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);
50 static int swap(ucontext_t *ctxt, Thread *t);
51 static int swap(Thread *t, ucontext_t *ctxt);
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; }
59 void set_creation(ModelAction *act) { creation = act; }
60 ModelAction * get_creation() const { return creation; }
63 * Set a return value for the last action in this thread (e.g., for an
65 * @param value The value to return
67 void set_return_value(uint64_t value) { last_action_val = value; }
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
75 uint64_t get_return_value() const { return last_action_val; }
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; }
81 /** @return True if this thread is finished executing */
82 bool is_complete() const { return state == THREAD_COMPLETED; }
84 /** @return True if this thread is blocked */
85 bool is_blocked() const { return state == THREAD_BLOCKED; }
87 /** @return The pending (next) ModelAction for this Thread
88 * @see Thread::pending */
89 ModelAction * get_pending() const { return pending; }
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; }
96 bool just_woken_up() { return wakeup_state; }
97 void set_wakeup_state(bool state) { wakeup_state = state; }
99 Thread * waiting_on() const;
100 bool is_waiting_on(const Thread *t) const;
102 bool is_model_thread() const { return model_thread; }
104 void * get_stack_addr() { return stack; }
106 friend void thread_startup();
108 friend void setup_context();
109 friend void * helper_thread(void *);
110 friend void finalize_helper_thread();
114 * Intentionally NOT allocated with MODELALLOC or SNAPSHOTALLOC.
115 * Threads should be allocated on the user's normal (snapshotting) heap
116 * to allow their allocation/deallocation to follow the same pattern as
117 * the rest of the backtracked/replayed program.
119 void * operator new(size_t size) {
120 return Thread_malloc(size);
122 void operator delete(void *p, size_t size) {
125 void * operator new[](size_t size) {
126 return Thread_malloc(size);
128 void operator delete[](void *p, size_t size) {
132 void setTLS(char *_tls) { tls = _tls;}
135 int create_context();
137 /** @brief The parent Thread which created this Thread */
138 Thread * const parent;
140 /** @brief The THREAD_CREATE ModelAction which created this Thread */
141 ModelAction *creation;
144 * @brief The next ModelAction to be run by this Thread
146 * This action should be kept updated by the ModelChecker, so that we
147 * always know what the next ModelAction's memory_order, action type,
150 ModelAction *pending;
152 /** @brief True if this thread was just woken up */
155 void (*start_routine)(void *);
156 void *(*pstart_routine)(void *);
166 ucontext_t helpercontext;
167 pthread_mutex_t mutex;
168 pthread_mutex_t mutex2;
177 * The value returned by the last action in this thread
178 * @see Thread::set_return_value()
179 * @see Thread::get_return_value()
181 uint64_t last_action_val;
183 /** the value return from pthread functions */
184 void * pthread_return;
186 /** @brief Is this Thread a special model-checker thread? */
187 const bool model_thread;
191 uintptr_t get_tls_addr();
192 void tlsdestructor(void *v);
195 Thread * thread_current();
196 void thread_startup();
197 void initMainThread();
199 static inline thread_id_t thrd_to_id(thrd_t t)
201 return t.priv->get_id();
205 * @brief Map a zero-based integer index to a unique thread ID
207 * This is the inverse of id_to_int
209 static inline thread_id_t int_to_id(int i)
215 * @brief Map a unique thread ID to a zero-based integer index
217 * This is the inverse of int_to_id
219 static inline int id_to_int(thread_id_t id)
224 int real_pthread_mutex_init(pthread_mutex_t *__mutex, const pthread_mutexattr_t *__mutexattr);
225 int real_pthread_mutex_lock (pthread_mutex_t *__mutex);
226 int real_pthread_mutex_unlock (pthread_mutex_t *__mutex);
227 int real_pthread_create (pthread_t *__restrict __newthread, const pthread_attr_t *__restrict __attr, void *(*__start_routine)(void *), void *__restrict __arg);
228 int real_pthread_join (pthread_t __th, void ** __thread_return);
229 void real_pthread_exit (void * value_ptr) __attribute__((noreturn));
230 void real_init_all();
232 #endif /* __THREADS_MODEL_H__ */