1 /** @file threads-model.h
2 * @brief Model Checker Thread class.
5 #ifndef __THREADS_MODEL_H__
6 #define __THREADS_MODEL_H__
12 #include "modeltypes.h"
13 #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(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);
49 static int swap(ucontext_t *ctxt, Thread *t);
50 static int swap(Thread *t, ucontext_t *ctxt);
52 thread_state get_state() const { return state; }
53 void set_state(thread_state s);
54 thread_id_t get_id() const;
55 thrd_t get_thrd_t() const { return *user_thread; }
56 Thread * get_parent() const { return parent; }
58 void set_creation(ModelAction *act) { creation = act; }
59 ModelAction * get_creation() const { return creation; }
62 * Set a return value for the last action in this thread (e.g., for an
64 * @param value The value to return
66 void set_return_value(uint64_t value) { last_action_val = value; }
69 * Retrieve a return value for the last action in this thread. Used,
70 * for instance, for an atomic read to return the 'read' value. Should
71 * be called from a user context.
72 * @return The value 'returned' by the action
74 uint64_t get_return_value() const { return last_action_val; }
76 /** @return True if this thread is finished executing */
77 bool is_complete() const { return state == THREAD_COMPLETED; }
79 /** @return True if this thread is blocked */
80 bool is_blocked() const { return state == THREAD_BLOCKED; }
82 /** @return The pending (next) ModelAction for this Thread
83 * @see Thread::pending */
84 ModelAction * get_pending() const { return pending; }
86 /** @brief Set the pending (next) ModelAction for this Thread
87 * @param act The pending ModelAction
88 * @see Thread::pending */
89 void set_pending(ModelAction *act) { pending = act; }
91 Thread * waiting_on() const;
92 bool is_waiting_on(const Thread *t) const;
94 bool is_model_thread() const { return model_thread; }
96 friend void thread_startup();
99 * Intentionally NOT allocated with MODELALLOC or SNAPSHOTALLOC.
100 * Threads should be allocated on the user's normal (snapshotting) heap
101 * to allow their allocation/deallocation to follow the same pattern as
102 * the rest of the backtracked/replayed program.
104 void * operator new(size_t size) {
105 return Thread_malloc(size);
107 void operator delete(void *p, size_t size) {
110 void * operator new[](size_t size) {
111 return Thread_malloc(size);
113 void operator delete[](void *p, size_t size) {
117 int create_context();
119 /** @brief The parent Thread which created this Thread */
120 Thread * const parent;
122 /** @brief The THREAD_CREATE ModelAction which created this Thread */
123 ModelAction *creation;
126 * @brief The next ModelAction to be run by this Thread
128 * This action should be kept updated by the ModelChecker, so that we
129 * always know what the next ModelAction's memory_order, action type,
132 ModelAction *pending;
134 void (*start_routine)(void *);
135 void *(*pstart_routine)(void *);
144 * The value returned by the last action in this thread
145 * @see Thread::set_return_value()
146 * @see Thread::get_return_value()
148 uint64_t last_action_val;
150 /** @brief Is this Thread a special model-checker thread? */
151 const bool model_thread;
154 Thread * thread_current();
156 static inline thread_id_t thrd_to_id(thrd_t t)
158 return t.priv->get_id();
162 * @brief Map a zero-based integer index to a unique thread ID
164 * This is the inverse of id_to_int
166 static inline thread_id_t int_to_id(int i)
172 * @brief Map a unique thread ID to a zero-based integer index
174 * This is the inverse of int_to_id
176 static inline int id_to_int(thread_id_t id)
181 #endif /* __THREADS_MODEL_H__ */