1 /** @file threads-model.h
2 * @brief Model Checker Thread class.
5 #ifndef __THREADS_MODEL_H__
6 #define __THREADS_MODEL_H__
13 #include "modeltypes.h"
14 #include "stl-model.h"
16 struct thread_params {
21 /** @brief Represents the state of a user Thread */
22 typedef enum thread_state {
23 /** Thread was just created and hasn't run yet */
25 /** Thread is running */
27 /** Thread is not currently running but is ready to run */
30 * Thread is waiting on another action (e.g., thread completion, lock
34 /** Thread has completed its execution */
40 /** @brief A Thread is created for each user-space thread */
43 Thread(thread_id_t tid);
44 Thread(thrd_t *t, void (*func)(void *), void *a, Thread *parent);
48 static int swap(ucontext_t *ctxt, Thread *t);
49 static int swap(Thread *t, ucontext_t *ctxt);
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; }
57 void set_creation(ModelAction *act) { creation = act; }
58 ModelAction * get_creation() const { return creation; }
61 * Set a return value for the last action in this thread (e.g., for an
63 * @param value The value to return
65 void set_return_value(uint64_t value) { last_action_val = value; }
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
73 uint64_t get_return_value() const { return last_action_val; }
75 /** @return True if this thread is finished executing */
76 bool is_complete() const { return state == THREAD_COMPLETED; }
78 /** @return True if this thread is blocked */
79 bool is_blocked() const { return state == THREAD_BLOCKED; }
81 /** @return True if no threads are waiting on this Thread */
82 bool wait_list_empty() const { return wait_list.empty(); }
85 * Add a ModelAction to the waiting list for this thread.
86 * @param t The ModelAction to add. Must be a JOIN.
88 void push_wait_list(ModelAction *act) { wait_list.push_back(act); }
90 unsigned int num_wait_list() const {
91 return wait_list.size();
94 ModelAction * get_waiter(unsigned int i) const {
98 /** @return The pending (next) ModelAction for this Thread
99 * @see Thread::pending */
100 ModelAction * get_pending() const { return pending; }
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; }
107 Thread * waiting_on() const;
108 bool is_waiting_on(const Thread *t) const;
111 * Remove one ModelAction from the waiting list
112 * @return The ModelAction that was removed from the waiting list
114 ModelAction * pop_wait_list() {
115 ModelAction *ret = wait_list.front();
116 wait_list.pop_back();
120 bool is_model_thread() const { return model_thread; }
122 friend void thread_startup();
125 * Intentionally NOT allocated with MODELALLOC or SNAPSHOTALLOC.
126 * Threads should be allocated on the user's normal (snapshotting) heap
127 * to allow their allocation/deallocation to follow the same pattern as
128 * the rest of the backtracked/replayed program.
130 void * operator new(size_t size) {
131 return Thread_malloc(size);
133 void operator delete(void *p, size_t size) {
136 void * operator new[](size_t size) {
137 return Thread_malloc(size);
139 void operator delete[](void *p, size_t size) {
143 int create_context();
145 /** @brief The parent Thread which created this Thread */
146 Thread * const parent;
148 /** @brief The THREAD_CREATE ModelAction which created this Thread */
149 ModelAction *creation;
152 * @brief The next ModelAction to be run by this Thread
154 * This action should be kept updated by the ModelChecker, so that we
155 * always know what the next ModelAction's memory_order, action type,
158 ModelAction *pending;
160 void (*start_routine)(void *);
169 * A list of ModelActions waiting on this Thread. Particularly, this
170 * list is used for thread joins, where another Thread waits for this
173 SnapVector<ModelAction *> wait_list;
176 * The value returned by the last action in this thread
177 * @see Thread::set_return_value()
178 * @see Thread::get_return_value()
180 uint64_t last_action_val;
182 /** @brief Is this Thread a special model-checker thread? */
183 const bool model_thread;
186 Thread * thread_current();
188 static inline thread_id_t thrd_to_id(thrd_t t)
190 return t.priv->get_id();
194 * @brief Map a zero-based integer index to a unique thread ID
196 * This is the inverse of id_to_int
198 static inline thread_id_t int_to_id(int i)
204 * @brief Map a unique thread ID to a zero-based integer index
206 * This is the inverse of int_to_id
208 static inline int id_to_int(thread_id_t id)
213 #endif /* __THREADS_MODEL_H__ */