threads.cc

   1 /** @file threads.cc
   2  *  @brief Thread functions.
   3  */
   4
   5 #include <string.h>
   6
   7 #include <threads.h>
   8 #include "common.h"
   9 #include "threads-model.h"
  10
  11 /* global "model" object */
  12 #include "model.h"
  13
  14 /** Allocate a stack for a new thread. */
  15 static void * stack_allocate(size_t size)
  16 {
  17         return snapshot_malloc(size);
  18 }
  19
  20 /** Free a stack for a terminated thread. */
  21 static void stack_free(void *stack)
  22 {
  23         snapshot_free(stack);
  24 }
  25
  26 /** Return the currently executing thread. */
  27 Thread * thread_current(void)
  28 {
  29         ASSERT(model);
  30         return model->get_current_thread();
  31 }
  32
  33 /**
  34  * Provides a startup wrapper for each thread, allowing some initial
  35  * model-checking data to be recorded. This method also gets around makecontext
  36  * not being 64-bit clean
  37  */
  38 void thread_startup()
  39 {
  40         Thread * curr_thread = thread_current();
  41
  42         /* Add dummy "start" action, just to create a first clock vector */
  43         model->switch_to_master(new ModelAction(THREAD_START, std::memory_order_seq_cst, curr_thread));
  44
  45         /* Call the actual thread function */
  46         curr_thread->start_routine(curr_thread->arg);
  47
  48         /* Finish thread properly */
  49         model->switch_to_master(new ModelAction(THREAD_FINISH, std::memory_order_seq_cst, curr_thread));
  50 }
  51
  52 /**
  53  * Create a thread context for a new thread so we can use
  54  * setcontext/getcontext/swapcontext to swap it out.
  55  * @return 0 on success; otherwise, non-zero error condition
  56  */
  57 int Thread::create_context()
  58 {
  59         int ret;
  60
  61         ret = getcontext(&context);
  62         if (ret)
  63                 return ret;
  64
  65         /* Initialize new managed context */
  66         stack = stack_allocate(STACK_SIZE);
  67         context.uc_stack.ss_sp = stack;
  68         context.uc_stack.ss_size = STACK_SIZE;
  69         context.uc_stack.ss_flags = 0;
  70         context.uc_link = model->get_system_context();
  71         makecontext(&context, thread_startup, 0);
  72
  73         return 0;
  74 }
  75
  76 /**
  77  * Swaps the current context to another thread of execution. This form switches
  78  * from a user Thread to a system context.
  79  * @param t Thread representing the currently-running thread. The current
  80  * context is saved here.
  81  * @param ctxt Context to which we will swap. Must hold a valid system context.
  82  * @return Does not return, unless we return to Thread t's context. See
  83  * swapcontext(3) (returns 0 for success, -1 for failure).
  84  */
  85 int Thread::swap(Thread *t, ucontext_t *ctxt)
  86 {
  87         t->set_state(THREAD_READY);
  88         return swapcontext(&t->context, ctxt);
  89 }
  90
  91 /**
  92  * Swaps the current context to another thread of execution. This form switches
  93  * from a system context to a user Thread.
  94  * @param ctxt System context variable to which to save the current context.
  95  * @param t Thread to which we will swap. Must hold a valid user context.
  96  * @return Does not return, unless we return to the system context (ctxt). See
  97  * swapcontext(3) (returns 0 for success, -1 for failure).
  98  */
  99 int Thread::swap(ucontext_t *ctxt, Thread *t)
 100 {
 101         t->set_state(THREAD_RUNNING);
 102         return swapcontext(ctxt, &t->context);
 103 }
 104
 105
 106 /** Terminate a thread and free its stack. */
 107 void Thread::complete()
 108 {
 109         ASSERT(!is_complete());
 110         DEBUG("completed thread %d\n", id_to_int(get_id()));
 111         state = THREAD_COMPLETED;
 112         if (stack)
 113                 stack_free(stack);
 114 }
 115
 116 /**
 117  * @brief Construct a new model-checker Thread
 118  *
 119  * A model-checker Thread is used for accounting purposes only. It will never
 120  * have its own stack, and it should never be inserted into the Scheduler.
 121  *
 122  * @param tid The thread ID to assign
 123  */
 124 Thread::Thread(thread_id_t tid) :
 125         parent(NULL),
 126         creation(NULL),
 127         pending(NULL),
 128         start_routine(NULL),
 129         arg(NULL),
 130         stack(NULL),
 131         user_thread(NULL),
 132         id(tid),
 133         state(THREAD_READY), /* Thread is always ready? */
 134         wait_list(),
 135         last_action_val(0),
 136         model_thread(true)
 137 {
 138         memset(&context, 0, sizeof(context));
 139 }
 140
 141 /**
 142  * Construct a new thread.
 143  * @param t The thread identifier of the newly created thread.
 144  * @param func The function that the thread will call.
 145  * @param a The parameter to pass to this function.
 146  */
 147 Thread::Thread(thrd_t *t, void (*func)(void *), void *a) :
 148         creation(NULL),
 149         pending(NULL),
 150         start_routine(func),
 151         arg(a),
 152         user_thread(t),
 153         state(THREAD_CREATED),
 154         wait_list(),
 155         last_action_val(VALUE_NONE),
 156         model_thread(false)
 157 {
 158         int ret;
 159
 160         /* Initialize state */
 161         ret = create_context();
 162         if (ret)
 163                 model_print("Error in create_context\n");
 164
 165         id = model->get_next_id();
 166         user_thread->priv = this;
 167         parent = thread_current();
 168 }
 169
 170 /** Destructor */
 171 Thread::~Thread()
 172 {
 173         if (!is_complete())
 174                 complete();
 175         model->remove_thread(this);
 176 }
 177
 178 /** @return The thread_id_t corresponding to this Thread object. */
 179 thread_id_t Thread::get_id() const
 180 {
 181         return id;
 182 }
 183
 184 /**
 185  * Set a thread's THREAD_* state (@see thread_state)
 186  * @param s The state to enter
 187  */
 188 void Thread::set_state(thread_state s)
 189 {
 190         ASSERT(s == THREAD_COMPLETED || state != THREAD_COMPLETED);
 191         state = s;
 192 }