X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=blobdiff_plain;f=threads.cc;h=39f049541d69184cc012bcd042f2400208863a3a;hp=37b0f1a87ee6fb9ac975a84c8df9adf018d808c5;hb=b8f97b8e63effbd3b3de6bbf51d79f9da76b4085;hpb=c400af2b7dfb87ce64c86f2d2b6a37d02421b263

diff --git a/threads.cc b/threads.cc
index 37b0f1a..39f0495 100644
--- a/threads.cc
+++ b/threads.cc
@@ -1,3 +1,7 @@
+/** @file threads.cc
+ *  @brief Thread functions.
+ */
+
 #include "libthreads.h"
 #include "common.h"
 #include "threads.h"
@@ -5,30 +9,51 @@
 /* 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 malloc(size);
 }
 
+/** Free a stack for a terminated thread. */
 static void stack_free(void *stack)
 {
 	free(stack);
 }
 
+/** Return the currently executing thread. */
 Thread * thread_current(void)
 {
-	return model->scheduler->get_current_thread();
+	ASSERT(model);
+	return model->get_current_thread();
 }
 
-/* This method just gets around makecontext not being 64-bit clean */
-
-void thread_startup() {
+/**
+ * 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
+ * @todo We should make the START event always immediately follow the
+ * CREATE event, so we don't get redundant traces...
+ */
+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 */
 	curr_thread->start_routine(curr_thread->arg);
+
+	/* 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;
@@ -48,19 +73,38 @@ int Thread::create_context()
 	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);
 }
 
+/**
+ * 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);
 }
 
+
+/** Terminate a thread and free its stack. */
 void Thread::complete()
 {
-	if (state != THREAD_COMPLETED) {
+	if (!is_complete()) {
 		DEBUG("completed thread %d\n", get_id());
 		state = THREAD_COMPLETED;
 		if (stack)
@@ -68,30 +112,41 @@ void Thread::complete()
 	}
 }
 
-Thread::Thread(thrd_t *t, void (*func)(void *), void *a) {
+/**
+ * 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(thrd_t *t, void (*func)(void *), void *a) :
+	pending(NULL),
+	start_routine(func),
+	arg(a),
+	user_thread(t),
+	state(THREAD_CREATED),
+	wait_list(),
+	last_action_val(VALUE_NONE)
+{
 	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();
 }
 
+/** Destructor */
 Thread::~Thread()
 {
 	complete();
 	model->remove_thread(this);
 }
 
+/** @return The thread_id_t corresponding to this Thread object. */
 thread_id_t Thread::get_id()
 {
 	return id;