X-Git-Url: http://plrg.eecs.uci.edu/git/?p=c11tester.git;a=blobdiff_plain;f=threads.cc;h=d1929cd7ad5e6e3c3a781e813d8583a39e94e12d;hp=cc939318938170da4712191ab7ea7bd20e78140b;hb=e16b141f84421c9823e9208240d2ba6eed4d87d9;hpb=b01017897db7a4000d3f6f024e0b3800d0f10790 diff --git a/threads.cc b/threads.cc index cc939318..d1929cd7 100644 --- a/threads.cc +++ b/threads.cc @@ -1,30 +1,72 @@ -#include +/** @file threads.cc + * @brief Thread functions. + */ + +#include -#include "libthreads.h" -#include "schedule.h" +#include +#include "mutex.h" #include "common.h" -#include "threads.h" +#include "threads-model.h" +#include "action.h" /* global "model" object */ #include "model.h" -#define STACK_SIZE (1024 * 1024) - +/** Allocate a stack for a new thread. */ static void * stack_allocate(size_t size) { - return userMalloc(size); + return Thread_malloc(size); } +/** Free a stack for a terminated thread. */ static void stack_free(void *stack) { - userFree(stack); + Thread_free(stack); } +/** + * @brief Get the current Thread + * + * Must be called from a user context + * + * @return The currently executing thread + */ Thread * thread_current(void) { - return model->scheduler->get_current_thread(); + ASSERT(model); + return model->get_current_thread(); } +/** + * Provides a startup wrapper for each thread, allowing some initial + * model-checking data to be recorded. This method also gets around makecontext + * not being 64-bit clean + */ +void thread_startup() +{ + Thread * curr_thread = thread_current(); + + /* Add dummy "start" action, just to create a first clock vector */ + model->switch_to_master(new ModelAction(THREAD_START, std::memory_order_seq_cst, curr_thread)); + + /* Call the actual thread function */ + if (curr_thread->start_routine != NULL) { + curr_thread->start_routine(curr_thread->arg); + } else if (curr_thread->pstart_routine != NULL) { + // set pthread return value + void *retval = curr_thread->pstart_routine(curr_thread->arg); + curr_thread->set_pthread_return(retval); + } + /* Finish thread properly */ + model->switch_to_master(new ModelAction(THREAD_FINISH, std::memory_order_seq_cst, curr_thread)); +} + +/** + * Create a thread context for a new thread so we can use + * setcontext/getcontext/swapcontext to swap it out. + * @return 0 on success; otherwise, non-zero error condition + */ int Thread::create_context() { int ret; @@ -39,128 +81,185 @@ int Thread::create_context() context.uc_stack.ss_size = STACK_SIZE; context.uc_stack.ss_flags = 0; context.uc_link = model->get_system_context(); - makecontext(&context, start_routine, 1, arg); + makecontext(&context, thread_startup, 0); return 0; } +/** + * Swaps the current context to another thread of execution. This form switches + * from a user Thread to a system context. + * @param t Thread representing the currently-running thread. The current + * context is saved here. + * @param ctxt Context to which we will swap. Must hold a valid system context. + * @return Does not return, unless we return to Thread t's context. See + * swapcontext(3) (returns 0 for success, -1 for failure). + */ int Thread::swap(Thread *t, ucontext_t *ctxt) { - return swapcontext(&t->context, ctxt); + t->set_state(THREAD_READY); + return model_swapcontext(&t->context, ctxt); } +/** + * Swaps the current context to another thread of execution. This form switches + * from a system context to a user Thread. + * @param ctxt System context variable to which to save the current context. + * @param t Thread to which we will swap. Must hold a valid user context. + * @return Does not return, unless we return to the system context (ctxt). See + * swapcontext(3) (returns 0 for success, -1 for failure). + */ int Thread::swap(ucontext_t *ctxt, Thread *t) { - return swapcontext(ctxt, &t->context); + t->set_state(THREAD_RUNNING); + return model_swapcontext(ctxt, &t->context); } + +/** Terminate a thread and free its stack. */ void Thread::complete() { - if (state != THREAD_COMPLETED) { - DEBUG("completed thread %d\n", get_id()); - state = THREAD_COMPLETED; - if (stack) - stack_free(stack); - } + ASSERT(!is_complete()); + DEBUG("completed thread %d\n", id_to_int(get_id())); + state = THREAD_COMPLETED; + if (stack) + stack_free(stack); } -void * Thread::operator new(size_t size) { - return userMalloc(size); +/** + * @brief Construct a new model-checker Thread + * + * A model-checker Thread is used for accounting purposes only. It will never + * have its own stack, and it should never be inserted into the Scheduler. + * + * @param tid The thread ID to assign + */ +Thread::Thread(thread_id_t tid) : + parent(NULL), + creation(NULL), + pending(NULL), + start_routine(NULL), + arg(NULL), + stack(NULL), + user_thread(NULL), + id(tid), + state(THREAD_READY), /* Thread is always ready? */ + last_action_val(0), + model_thread(true) +{ + memset(&context, 0, sizeof(context)); } -void Thread::operator delete(void *ptr) { - userFree(ptr); +/** + * Construct a new thread. + * @param t The thread identifier of the newly created thread. + * @param func The function that the thread will call. + * @param a The parameter to pass to this function. + */ +Thread::Thread(thread_id_t tid, thrd_t *t, void (*func)(void *), void *a, Thread *parent) : + parent(parent), + creation(NULL), + pending(NULL), + start_routine(func), + pstart_routine(NULL), + arg(a), + user_thread(t), + id(tid), + state(THREAD_CREATED), + last_action_val(VALUE_NONE), + model_thread(false) +{ + int ret; + + /* Initialize state */ + ret = create_context(); + if (ret) + model_print("Error in create_context\n"); + + user_thread->priv = this; // WL } -Thread::Thread(thrd_t *t, void (*func)(), void *a) { +/** + * Construct a new thread for pthread. + * @param t The thread identifier of the newly created thread. + * @param func The function that the thread will call. + * @param a The parameter to pass to this function. + */ +Thread::Thread(thread_id_t tid, thrd_t *t, void *(*func)(void *), void *a, Thread *parent) : + parent(parent), + creation(NULL), + pending(NULL), + start_routine(NULL), + pstart_routine(func), + arg(a), + user_thread(t), + id(tid), + state(THREAD_CREATED), + last_action_val(VALUE_NONE), + model_thread(false) +{ int ret; - user_thread = t; - start_routine = func; - arg = a; - /* Initialize state */ ret = create_context(); if (ret) - printf("Error in create_context\n"); - - state = THREAD_CREATED; - id = model->get_next_id(); - *user_thread = id; - parent = thread_current(); + model_print("Error in create_context\n"); } + +/** Destructor */ Thread::~Thread() { - complete(); - model->remove_thread(this); + if (!is_complete()) + complete(); } -thread_id_t Thread::get_id() +/** @return The thread_id_t corresponding to this Thread object. */ +thread_id_t Thread::get_id() const { return id; } -/* - * Return 1 if found next thread, 0 otherwise +/** + * Set a thread's THREAD_* state (@see thread_state) + * @param s The state to enter */ -static int thread_system_next(void) -{ - Thread *curr, *next; - - curr = thread_current(); - if (curr) { - if (curr->get_state() == THREAD_READY) { - model->check_current_action(); - model->scheduler->add_thread(curr); - } else if (curr->get_state() == THREAD_RUNNING) - /* Stopped while running; i.e., completed */ - curr->complete(); - else - ASSERT(false); - } - next = model->scheduler->next_thread(); - if (next) - next->set_state(THREAD_RUNNING); - DEBUG("(%d, %d)\n", curr ? curr->get_id() : -1, next ? next->get_id() : -1); - if (!next) - return 1; - return Thread::swap(model->get_system_context(), next); +void Thread::set_state(thread_state s) +{ + ASSERT(s == THREAD_COMPLETED || state != THREAD_COMPLETED); + state = s; } -static void thread_wait_finish(void) +/** + * Get the Thread that this Thread is immediately waiting on + * @return The thread we are waiting on, if any; otherwise NULL + */ +Thread * Thread::waiting_on() const { - - DBG(); - - while (!thread_system_next()); + if (!pending) + return NULL; + + if (pending->get_type() == THREAD_JOIN) + return pending->get_thread_operand(); + else if (pending->get_type() == PTHREAD_JOIN) + return pending->get_thread_operand(); + else if (pending->is_lock()) + return (Thread *)pending->get_mutex()->get_state()->locked; + return NULL; } -/* - * Main system function +/** + * Check if this Thread is waiting (blocking) on a given Thread, directly or + * indirectly (via a chain of waiting threads) + * + * @param t The Thread on which we may be waiting + * @return True if we are waiting on Thread t; false otherwise */ -int main() +bool Thread::is_waiting_on(const Thread *t) const { - thrd_t user_thread; - ucontext_t main_context; - - model = new ModelChecker(); - - if (getcontext(&main_context)) - return 1; - - model->set_system_context(&main_context); - - do { - /* Start user program */ - model->add_thread(new Thread(&user_thread, &user_main, NULL)); - - /* Wait for all threads to complete */ - thread_wait_finish(); - } while (model->next_execution()); - - delete model; - - DEBUG("Exiting\n"); - return 0; + Thread *wait; + for (wait = waiting_on(); wait != NULL; wait = wait->waiting_on()) + if (wait == t) + return true; + return false; }