X-Git-Url: http://plrg.eecs.uci.edu/git/?p=c11tester.git;a=blobdiff_plain;f=threads.h;h=0f39a836f49efae34c63415f433e37715a43d258;hp=b592804db95959445d5c4f967f449121e2d59bad;hb=38dbc133c5e2712828cf13e17d05331d2b48dcf2;hpb=1d6c949fef3b5da936f8499dde464f8df634267a

diff --git a/threads.h b/threads.h
index b592804d..0f39a836 100644
--- a/threads.h
+++ b/threads.h
@@ -1,3 +1,7 @@
+/** @file threads.h
+ *  @brief Model Checker Thread class.
+ */
+
 #ifndef __THREADS_H__
 #define __THREADS_H__
 
@@ -9,16 +13,28 @@ typedef int thread_id_t;
 
 #define THREAD_ID_T_NONE	-1
 
+/** @brief Represents the state of a user Thread */
 typedef enum thread_state {
+	/** Thread was just created and hasn't run yet */
 	THREAD_CREATED,
+	/** Thread is running */
 	THREAD_RUNNING,
+	/**
+	 * Thread has yielded to the model-checker but is ready to run. Used
+	 * during an action that caused a context switch to the model-checking
+	 * context.
+	 */
 	THREAD_READY,
+	/** Thread has completed its execution */
 	THREAD_COMPLETED
 } thread_state;
 
+class ModelAction;
+
+/** @brief A Thread is created for each user-space thread */
 class Thread {
 public:
-	Thread(thrd_t *t, void (*func)(), void *a);
+	Thread(thrd_t *t, void (*func)(void *), void *a);
 	~Thread();
 	void complete();
 
@@ -30,18 +46,47 @@ public:
 	thread_id_t get_id();
 	thrd_t get_thrd_t() { return *user_thread; }
 	Thread * get_parent() { return parent; }
-  MEMALLOC
+
+	void set_creation(ModelAction *act) { creation = act; }
+	ModelAction * get_creation() { return creation; }
+
+	/**
+	 * Set a return value for the last action in this thread (e.g., for an
+	 * atomic read).
+	 * @param value The value to return
+	 */
+	void set_return_value(int value) { last_action_val = value; }
+
+	/**
+	 * Retrieve a return value for the last action in this thread. Used,
+	 * for instance, for an atomic read to return the 'read' value. Should
+	 * be called from a user context.
+	 * @return The value 'returned' by the action
+	 */
+	int get_return_value() { return last_action_val; }
+
+	friend void thread_startup();
+
+	SNAPSHOTALLOC
 private:
 	int create_context();
 	Thread *parent;
+	ModelAction *creation;
 
-	void (*start_routine)();
+	void (*start_routine)(void *);
 	void *arg;
 	ucontext_t context;
 	void *stack;
 	thrd_t *user_thread;
 	thread_id_t id;
 	thread_state state;
+
+	/**
+	 * The value returned by the last action in this thread
+	 * @see Thread::set_return_value()
+	 * @see Thread::get_return_value()
+	 */
+	int last_action_val;
 };
 
 Thread * thread_current();