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 #include "mymemory.h"
  10 #include "threads.h"
  11 #include "modeltypes.h"
  12 #include "stl-model.h"
  13 #include "context.h"
  14 #include "classlist.h"
  15 #include "pthread.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         static int swap(Thread *t, Thread *t2);
  53
  54         thread_state get_state() const { return state; }
  55         void set_state(thread_state s);
  56         thread_id_t get_id() const;
  57         thrd_t get_thrd_t() const { return *user_thread; }
  58         Thread * get_parent() const { return parent; }
  59
  60         void set_creation(ModelAction *act) { creation = act; }
  61         ModelAction * get_creation() const { return creation; }
  62
  63         /**
  64          * Set a return value for the last action in this thread (e.g., for an
  65          * atomic read).
  66          * @param value The value to return
  67          */
  68         void set_return_value(uint64_t value) { last_action_val = value; }
  69
  70         /**
  71          * Retrieve a return value for the last action in this thread. Used,
  72          * for instance, for an atomic read to return the 'read' value. Should
  73          * be called from a user context.
  74          * @return The value 'returned' by the action
  75          */
  76         uint64_t get_return_value() const { return last_action_val; }
  77
  78         /** @set and get the return value from pthread functions */
  79         void set_pthread_return(void *ret) { pthread_return = ret; }
  80         void * get_pthread_return() { return pthread_return; }
  81
  82         /** @return True if this thread is finished executing */
  83         bool is_complete() const { return state == THREAD_COMPLETED; }
  84
  85         /** @return True if this thread is blocked */
  86         bool is_blocked() const { return state == THREAD_BLOCKED; }
  87
  88         /** @return The pending (next) ModelAction for this Thread
  89          *  @see Thread::pending */
  90         ModelAction * get_pending() const { return pending; }
  91
  92         /** @brief Set the pending (next) ModelAction for this Thread
  93          *  @param act The pending ModelAction
  94          *  @see Thread::pending */
  95         void set_pending(ModelAction *act) { pending = act; }
  96
  97         bool just_woken_up() { return wakeup_state; }
  98         void set_wakeup_state(bool state) { wakeup_state = state; }
  99
 100         Thread * waiting_on() const;
 101         bool is_waiting_on(const Thread *t) const;
 102
 103         bool is_model_thread() const { return model_thread; }
 104
 105         friend void thread_startup();
 106 #ifdef TLS
 107         friend void setup_context();
 108         friend void * helper_thread(void *);
 109         friend void finalize_helper_thread();
 110 #endif
 111
 112         /**
 113          * Intentionally NOT allocated with MODELALLOC or SNAPSHOTALLOC.
 114          * Threads should be allocated on the user's normal (snapshotting) heap
 115          * to allow their allocation/deallocation to follow the same pattern as
 116          * the rest of the backtracked/replayed program.
 117          */
 118         void * operator new(size_t size) {
 119                 return Thread_malloc(size);
 120         }
 121         void operator delete(void *p, size_t size) {
 122                 Thread_free(p);
 123         }
 124         void * operator new[](size_t size) {
 125                 return Thread_malloc(size);
 126         }
 127         void operator delete[](void *p, size_t size) {
 128                 Thread_free(p);
 129         }
 130 #ifdef TLS
 131         void setTLS(char *_tls) { tls = _tls;}
 132 #endif
 133 private:
 134         int create_context();
 135
 136         /** @brief The parent Thread which created this Thread */
 137         Thread * const parent;
 138
 139         /** @brief The THREAD_CREATE ModelAction which created this Thread */
 140         ModelAction *creation;
 141
 142         /**
 143          * @brief The next ModelAction to be run by this Thread
 144          *
 145          * This action should be kept updated by the ModelChecker, so that we
 146          * always know what the next ModelAction's memory_order, action type,
 147          * and location are.
 148          */
 149         ModelAction *pending;
 150
 151         /** @brief True if this thread was just woken up */
 152         bool wakeup_state;
 153
 154         void (*start_routine)(void *);
 155         void *(*pstart_routine)(void *);
 156
 157         void *arg;
 158         ucontext_t context;
 159         void *stack;
 160 #ifdef TLS
 161         void * helper_stack;
 162 public:
 163         char *tls;
 164         ucontext_t helpercontext;
 165         pthread_mutex_t mutex;
 166         pthread_mutex_t mutex2;
 167         pthread_t thread;
 168 private:
 169 #endif
 170         thrd_t *user_thread;
 171         thread_id_t id;
 172         thread_state state;
 173
 174         /**
 175          * The value returned by the last action in this thread
 176          * @see Thread::set_return_value()
 177          * @see Thread::get_return_value()
 178          */
 179         uint64_t last_action_val;
 180
 181         /** the value return from pthread functions */
 182         void * pthread_return;
 183
 184         /** @brief Is this Thread a special model-checker thread? */
 185         const bool model_thread;
 186 };
 187
 188 #ifdef TLS
 189 uintptr_t get_tls_addr();
 190 void tlsdestructor(void *v);
 191 #endif
 192
 193 Thread * thread_current();
 194 void thread_startup();
 195 void initMainThread();
 196
 197 static inline thread_id_t thrd_to_id(thrd_t t)
 198 {
 199         return t.priv->get_id();
 200 }
 201
 202 /**
 203  * @brief Map a zero-based integer index to a unique thread ID
 204  *
 205  * This is the inverse of id_to_int
 206  */
 207 static inline thread_id_t int_to_id(int i)
 208 {
 209         return i;
 210 }
 211
 212 /**
 213  * @brief Map a unique thread ID to a zero-based integer index
 214  *
 215  * This is the inverse of int_to_id
 216  */
 217 static inline int id_to_int(thread_id_t id)
 218 {
 219         return id;
 220 }
 221
 222 int real_pthread_mutex_init(pthread_mutex_t *__mutex, const pthread_mutexattr_t *__mutexattr);
 223 int real_pthread_mutex_lock (pthread_mutex_t *__mutex);
 224 int real_pthread_mutex_unlock (pthread_mutex_t *__mutex);
 225 int real_pthread_create (pthread_t *__restrict __newthread, const pthread_attr_t *__restrict __attr, void *(*__start_routine)(void *), void *__restrict __arg);
 226 int real_pthread_join (pthread_t __th, void ** __thread_return);
 227 void real_pthread_exit (void * value_ptr) __attribute__((noreturn));
 228 void real_init_all();
 229
 230 #endif  /* __THREADS_MODEL_H__ */