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(thrd_t *t, void (*func)(void *), void *a, Thread *parent);
  45         ~Thread();
  46         void complete();
  47
  48         static int swap(ucontext_t *ctxt, Thread *t);
  49         static int swap(Thread *t, ucontext_t *ctxt);
  50
  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; }
  56
  57         void set_creation(ModelAction *act) { creation = act; }
  58         ModelAction * get_creation() const { return creation; }
  59
  60         /**
  61          * Set a return value for the last action in this thread (e.g., for an
  62          * atomic read).
  63          * @param value The value to return
  64          */
  65         void set_return_value(uint64_t value) { last_action_val = value; }
  66
  67         /**
  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
  72          */
  73         uint64_t get_return_value() const { return last_action_val; }
  74
  75         /** @return True if this thread is finished executing */
  76         bool is_complete() const { return state == THREAD_COMPLETED; }
  77
  78         /** @return True if this thread is blocked */
  79         bool is_blocked() const { return state == THREAD_BLOCKED; }
  80
  81         /** @return The pending (next) ModelAction for this Thread
  82          *  @see Thread::pending */
  83         ModelAction * get_pending() const { return pending; }
  84
  85         /** @brief Set the pending (next) ModelAction for this Thread
  86          *  @param act The pending ModelAction
  87          *  @see Thread::pending */
  88         void set_pending(ModelAction *act) { pending = act; }
  89
  90         Thread * waiting_on() const;
  91         bool is_waiting_on(const Thread *t) const;
  92
  93         bool is_model_thread() const { return model_thread; }
  94
  95         friend void thread_startup();
  96
  97         /**
  98          * Intentionally NOT allocated with MODELALLOC or SNAPSHOTALLOC.
  99          * Threads should be allocated on the user's normal (snapshotting) heap
 100          * to allow their allocation/deallocation to follow the same pattern as
 101          * the rest of the backtracked/replayed program.
 102          */
 103         void * operator new(size_t size) {
 104                 return Thread_malloc(size);
 105         }
 106         void operator delete(void *p, size_t size) {
 107                 Thread_free(p);
 108         }
 109         void * operator new[](size_t size) {
 110                 return Thread_malloc(size);
 111         }
 112         void operator delete[](void *p, size_t size) {
 113                 Thread_free(p);
 114         }
 115 private:
 116         int create_context();
 117
 118         /** @brief The parent Thread which created this Thread */
 119         Thread * const parent;
 120
 121         /** @brief The THREAD_CREATE ModelAction which created this Thread */
 122         ModelAction *creation;
 123
 124         /**
 125          * @brief The next ModelAction to be run by this Thread
 126          *
 127          * This action should be kept updated by the ModelChecker, so that we
 128          * always know what the next ModelAction's memory_order, action type,
 129          * and location are.
 130          */
 131         ModelAction *pending;
 132
 133         void (*start_routine)(void *);
 134         void *arg;
 135         ucontext_t context;
 136         void *stack;
 137         thrd_t *user_thread;
 138         thread_id_t id;
 139         thread_state state;
 140
 141         /**
 142          * The value returned by the last action in this thread
 143          * @see Thread::set_return_value()
 144          * @see Thread::get_return_value()
 145          */
 146         uint64_t last_action_val;
 147
 148         /** @brief Is this Thread a special model-checker thread? */
 149         const bool model_thread;
 150 };
 151
 152 Thread * thread_current();
 153
 154 static inline thread_id_t thrd_to_id(thrd_t t)
 155 {
 156         return t.priv->get_id();
 157 }
 158
 159 /**
 160  * @brief Map a zero-based integer index to a unique thread ID
 161  *
 162  * This is the inverse of id_to_int
 163  */
 164 static inline thread_id_t int_to_id(int i)
 165 {
 166         return i;
 167 }
 168
 169 /**
 170  * @brief Map a unique thread ID to a zero-based integer index
 171  *
 172  * This is the inverse of int_to_id
 173  */
 174 static inline int id_to_int(thread_id_t id)
 175 {
 176         return id;
 177 }
 178
 179 #endif /* __THREADS_MODEL_H__ */