From 1dbc6ce8102e79ead8c3ae09214126abab1b5c51 Mon Sep 17 00:00:00 2001
From: Brian Demsky <bdemsky@uci.edu>
Date: Fri, 20 Jul 2012 19:12:20 -0700
Subject: [PATCH 1/1] move more configurables and add documentation

---
 common.h   |  7 +------
 config.h   | 27 +++++++++++++++++++++++++--
 snapshot.h | 10 +---------
 threads.cc | 23 ++++++++++++++++++++---
 4 files changed, 47 insertions(+), 20 deletions(-)

diff --git a/common.h b/common.h
index 0db1cfe1..9794a92e 100644
--- a/common.h
+++ b/common.h
@@ -6,12 +6,7 @@
 #define __COMMON_H__
 
 #include <stdio.h>
-
-/*
-#ifndef CONFIG_DEBUG
-#define CONFIG_DEBUG
-#endif
-*/
+#include "config.h"
 
 #ifdef CONFIG_DEBUG
 #define DEBUG(fmt, ...) do { printf("*** %25s(): line %-4d *** " fmt, __func__, __LINE__, ##__VA_ARGS__); } while (0)
diff --git a/config.h b/config.h
index 62bc92b5..1d0b6380 100644
--- a/config.h
+++ b/config.h
@@ -5,16 +5,39 @@
 #ifndef CONFIG_H
 #define CONFIG_H
 
+/** Turn on debugging. */
+/*		#ifndef CONFIG_DEBUG
+		#define CONFIG_DEBUG
+		#endif
+*/
+
+
 /** Do we have a 48 bit virtual address (64 bit machine) or 32 bit addresses.
  * Set to 1 for 48-bit, 0 for 32-bit. */
 #ifndef BIT48
-
 #ifdef _LP64
 #define BIT48 1
 #else
 #define BIT48 0
 #endif
-
 #endif /* BIT48 */
 
+/** Snapshotting configurables */
+
+/** If USE_MPROTECT_SNAPSHOT=1, then snapshot by using mmap() and mprotect()
+ * If USE_MPROTECT_SNAPSHOT=0, then snapshot by using fork() */
+#define USE_MPROTECT_SNAPSHOT 1
+
+/** Size of signal stack */
+#define SIGSTACKSIZE 32768
+
+/** Page size configuration */
+#define PAGESIZE 4096
+
+/** Thread parameters */
+
+/* Size of stack to allocate for a thread. */
+#define STACK_SIZE (1024 * 1024)
+
+
 #endif
diff --git a/snapshot.h b/snapshot.h
index e41eb9c9..f8995923 100644
--- a/snapshot.h
+++ b/snapshot.h
@@ -6,15 +6,7 @@
 #define _SNAPSHOT_H
 
 #include "snapshot-interface.h"
-
-#define PAGESIZE 4096
-
-/* If USE_MPROTECT_SNAPSHOT=1, then snapshot by using mmap() and mprotect()
-   If USE_MPROTECT_SNAPSHOT=0, then snapshot by using fork() */
-#define USE_MPROTECT_SNAPSHOT 1
-
-/* Size of signal stack */
-#define SIGSTACKSIZE 32768
+#include "config.h"
 
 void addMemoryRegionToSnapShot( void * ptr, unsigned int numPages );
 snapshot_id takeSnapshot( );
diff --git a/threads.cc b/threads.cc
index 399472c9..cde331db 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);
@@ -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;
@@ -75,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) {
@@ -85,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),
@@ -110,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;
-- 
2.34.1