move more configurables and add documentation

[c11tester.git] / threads.cc

diff --git a/threads.cc b/threads.cc
index ba7b54730781369fd6c17ec9f4bc492d660b3843..cde331dbfad0dde86f33394639ced4f374418fd0 100644 (file)
--- 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,31 +9,49 @@
 /* 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);
        return model->scheduler->get_current_thread();
 }
 
-/* This method just gets around makecontext not being 64-bit clean */
+/**
+ * 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);
 }
 
+/** 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;
@@ -59,6 +81,9 @@ 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) {
@@ -69,6 +94,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),
@@ -94,6 +125,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;