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
  10 #include "mymemory.h"
  11 #include <threads.h>
  12 #include "modeltypes.h"
  13 #include "stl-model.h"
  14 #include "context.h"
  15
  16 struct thread_params {
  17         thrd_start_t func;
  18         void *arg;
  19 };
  20
  21 /** @brief Represents the state of a user Thread */
  22 typedef enum thread_state {
  23         /** Thread was just created and hasn't run yet */
  24         THREAD_CREATED,
  25         /** Thread is running */
  26         THREAD_RUNNING,
  27         /** Thread is not currently running but is ready to run */
  28         THREAD_READY,
  29         /**
  30          * Thread is waiting on another action (e.g., thread completion, lock
  31          * release, etc.)
  32          */
  33         THREAD_BLOCKED,
  34         /** Thread has completed its execution */
  35         THREAD_COMPLETED
  36 } thread_state;
  37
  38 class ModelAction;
  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         ~Thread();
  47         void complete();
  48
  49         static int swap(ucontext_t *ctxt, Thread *t);
  50         static int swap(Thread *t, ucontext_t *ctxt);
  51
  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; }
  57
  58         void set_creation(ModelAction *act) { creation = act; }
  59         ModelAction * get_creation() const { return creation; }
  60
  61         /**
  62          * Set a return value for the last action in this thread (e.g., for an
  63          * atomic read).
  64          * @param value The value to return
  65          */
  66         void set_return_value(uint64_t value) { last_action_val = value; }
  67
  68         /**
  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
  73          */
  74         uint64_t get_return_value() const { return last_action_val; }
  75
  76         /** @return True if this thread is finished executing */
  77         bool is_complete() const { return state == THREAD_COMPLETED; }
  78
  79         /** @return True if this thread is blocked */
  80         bool is_blocked() const { return state == THREAD_BLOCKED; }
  81
  82         /** @return The pending (next) ModelAction for this Thread
  83          *  @see Thread::pending */
  84         ModelAction * get_pending() const { return pending; }
  85
  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; }
  90
  91         Thread * waiting_on() const;
  92         bool is_waiting_on(const Thread *t) const;
  93
  94         bool is_model_thread() const { return model_thread; }
  95
  96         friend void thread_startup();
  97
  98         /**
  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.
 103          */
 104         void * operator new(size_t size) {
 105                 return Thread_malloc(size);
 106         }
 107         void operator delete(void *p, size_t size) {
 108                 Thread_free(p);
 109         }
 110         void * operator new[](size_t size) {
 111                 return Thread_malloc(size);
 112         }
 113         void operator delete[](void *p, size_t size) {
 114                 Thread_free(p);
 115         }
 116 private:
 117         int create_context();
 118
 119         /** @brief The parent Thread which created this Thread */
 120         Thread * const parent;
 121
 122         /** @brief The THREAD_CREATE ModelAction which created this Thread */
 123         ModelAction *creation;
 124
 125         /**
 126          * @brief The next ModelAction to be run by this Thread
 127          *
 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,
 130          * and location are.
 131          */
 132         ModelAction *pending;
 133
 134         void (*start_routine)(void *);
 135         void *(*pstart_routine)(void *);
 136         void *arg;
 137         ucontext_t context;
 138         void *stack;
 139         thrd_t *user_thread;
 140         thread_id_t id;
 141         thread_state state;
 142
 143         /**
 144          * The value returned by the last action in this thread
 145          * @see Thread::set_return_value()
 146          * @see Thread::get_return_value()
 147          */
 148         uint64_t last_action_val;
 149
 150         /** @brief Is this Thread a special model-checker thread? */
 151         const bool model_thread;
 152 };
 153
 154 Thread * thread_current();
 155
 156 static inline thread_id_t thrd_to_id(thrd_t t)
 157 {
 158         return t.priv->get_id();
 159 }
 160
 161 /**
 162  * @brief Map a zero-based integer index to a unique thread ID
 163  *
 164  * This is the inverse of id_to_int
 165  */
 166 static inline thread_id_t int_to_id(int i)
 167 {
 168         return i;
 169 }
 170
 171 /**
 172  * @brief Map a unique thread ID to a zero-based integer index
 173  *
 174  * This is the inverse of int_to_id
 175  */
 176 static inline int id_to_int(thread_id_t id)
 177 {
 178         return id;
 179 }
 180
 181 #endif /* __THREADS_MODEL_H__ */