X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=threads.cc;h=26975799f0adc03ce8ca4e0ad6e391aad0e37d96;hb=6c42e6f6e00d6283bce4e9086b111b4b78509ded;hp=399472c9ac60b5b578ea0af88ea05bcf7da06c9f;hpb=5e3720f6a6dccf2af670e4ab30660130f2a57c8f;p=c11tester.git

diff --git a/threads.cc b/threads.cc
index 399472c9..26975799 100644
--- a/threads.cc
+++ b/threads.cc
@@ -2,7 +2,6 @@
  *  @brief Thread functions.
  */
 
-
 #include "libthreads.h"
 #include "common.h"
 #include "threads.h"
@@ -10,18 +9,20 @@
 /* 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)
 {
 	ASSERT(model);
@@ -35,8 +36,8 @@ Thread * thread_current(void)
  * @todo We should make the START event always immediately follow the
  * CREATE event, so we don't get redundant traces...
  */
-
-void thread_startup() {
+void thread_startup()
+{
 	Thread * curr_thread = thread_current();
 
 	/* Add dummy "start" action, just to create a first clock vector */
@@ -46,6 +47,11 @@ void thread_startup() {
 	curr_thread->start_routine(curr_thread->arg);
 }
 
+/** Create a thread context for a new thread so we can use
+ *  setcontext/getcontext/swapcontext to swap it out.
+ *  @return 0 on success.
+ */
+
 int Thread::create_context()
 {
 	int ret;
@@ -65,16 +71,34 @@ 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 current context
+ * @param ctxt Context to switch to
+ * @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 t Thread representing the current context
+ * @param ctxt Context to switch to
+ * @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(ucontext_t *ctxt, Thread *t)
 {
 	return swapcontext(ctxt, &t->context);
 }
 
+
+/** Terminate a thread and free its stack. */
 void Thread::complete()
 {
 	if (state != THREAD_COMPLETED) {
@@ -85,6 +109,12 @@ void Thread::complete()
 	}
 }
 
+/** Create a new thread.
+ *  Takes the following parameters:
+ *  @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) :
 	start_routine(func),
 	arg(a),
@@ -110,6 +140,8 @@ Thread::~Thread()
 	model->remove_thread(this);
 }
 
+/** Return the thread_id_t corresponding to this Thread object. */
+
 thread_id_t Thread::get_id()
 {
 	return id;