threads: construct Thread only with a given "parent"

[c11tester.git] / threads-model.h

diff --git a/threads-model.h b/threads-model.h
index 8b165d541394a8fcc23089e354b9c1b8c48da4f4..2cd09ab53739de7d327de3e5758af6b7ba66465d 100644 (file)
--- a/threads-model.h
+++ b/threads-model.h
@@ -13,6 +13,11 @@
 #include <threads.h>
 #include "modeltypes.h"
 
+struct thread_params {
+       thrd_start_t func;
+       void *arg;
+};
+
 /** @brief Represents the state of a user Thread */
 typedef enum thread_state {
        /** Thread was just created and hasn't run yet */
@@ -36,21 +41,21 @@ class ModelAction;
 class Thread {
 public:
        Thread(thread_id_t tid);
-       Thread(thrd_t *t, void (*func)(void *), void *a);
+       Thread(thrd_t *t, void (*func)(void *), void *a, Thread *parent);
        ~Thread();
        void complete();
 
        static int swap(ucontext_t *ctxt, Thread *t);
        static int swap(Thread *t, ucontext_t *ctxt);
 
-       thread_state get_state() { return state; }
-       void set_state(thread_state s) { state = s; }
-       thread_id_t get_id();
-       thrd_t get_thrd_t() { return *user_thread; }
-       Thread * get_parent() { return parent; }
+       thread_state get_state() const { return state; }
+       void set_state(thread_state s);
+       thread_id_t get_id() const;
+       thrd_t get_thrd_t() const { return *user_thread; }
+       Thread * get_parent() const { return parent; }
 
        void set_creation(ModelAction *act) { creation = act; }
-       ModelAction * get_creation() { return creation; }
+       ModelAction * get_creation() const { return creation; }
 
        /**
         * Set a return value for the last action in this thread (e.g., for an
@@ -65,16 +70,16 @@ public:
         * be called from a user context.
         * @return The value 'returned' by the action
         */
-       uint64_t get_return_value() { return last_action_val; }
+       uint64_t get_return_value() const { return last_action_val; }
 
        /** @return True if this thread is finished executing */
-       bool is_complete() { return state == THREAD_COMPLETED; }
+       bool is_complete() const { return state == THREAD_COMPLETED; }
 
        /** @return True if this thread is blocked */
-       bool is_blocked() { return state == THREAD_BLOCKED; }
+       bool is_blocked() const { return state == THREAD_BLOCKED; }
 
        /** @return True if no threads are waiting on this Thread */
-       bool wait_list_empty() { return wait_list.empty(); }
+       bool wait_list_empty() const { return wait_list.empty(); }
 
        /**
         * Add a ModelAction to the waiting list for this thread.
@@ -82,16 +87,23 @@ public:
         */
        void push_wait_list(ModelAction *act) { wait_list.push_back(act); }
 
-       unsigned int num_wait_list() {
+       unsigned int num_wait_list() const {
                return wait_list.size();
        }
 
-       ModelAction * get_waiter(unsigned int i) {
+       ModelAction * get_waiter(unsigned int i) const {
                return wait_list[i];
        }
 
-       ModelAction * get_pending() { return pending; }
+       /** @return The pending (next) ModelAction for this Thread
+        *  @see Thread::pending */
+       ModelAction * get_pending() const { return pending; }
+
+       /** @brief Set the pending (next) ModelAction for this Thread
+        *  @param act The pending ModelAction
+        *  @see Thread::pending */
        void set_pending(ModelAction *act) { pending = act; }
+
        /**
         * Remove one ModelAction from the waiting list
         * @return The ModelAction that was removed from the waiting list
@@ -102,7 +114,7 @@ public:
                return ret;
        }
 
-       bool is_model_thread() { return model_thread; }
+       bool is_model_thread() const { return model_thread; }
 
        friend void thread_startup();
 
@@ -114,10 +126,22 @@ public:
         */
 private:
        int create_context();
-       Thread *parent;
+
+       /** @brief The parent Thread which created this Thread */
+       Thread * const parent;
+
+       /** @brief The THREAD_CREATE ModelAction which created this Thread */
        ModelAction *creation;
 
+       /**
+        * @brief The next ModelAction to be run by this Thread
+        *
+        * This action should be kept updated by the ModelChecker, so that we
+        * always know what the next ModelAction's memory_order, action type,
+        * and location are.
+        */
        ModelAction *pending;
+
        void (*start_routine)(void *);
        void *arg;
        ucontext_t context;
@@ -148,14 +172,24 @@ Thread * thread_current();
 
 static inline thread_id_t thrd_to_id(thrd_t t)
 {
-       return t;
+       return t.priv->get_id();
 }
 
+/**
+ * @brief Map a zero-based integer index to a unique thread ID
+ *
+ * This is the inverse of id_to_int
+ */
 static inline thread_id_t int_to_id(int i)
 {
        return i;
 }
 
+/**
+ * @brief Map a unique thread ID to a zero-based integer index
+ *
+ * This is the inverse of int_to_id
+ */
 static inline int id_to_int(thread_id_t id)
 {
        return id;