model: factor out 'tid' calculation
[c11tester.git] / action.h
index f9c6d417084e62d39956ad1b1775c236b7bc48b8..3e4480419c03941413307ebba6a6e27a77372109 100644 (file)
--- a/action.h
+++ b/action.h
 
 #define VALUE_NONE -1
 
+/** @brief Represents an action type, identifying one of several types of
+ * ModelAction */
 typedef enum action_type {
-       THREAD_CREATE,
-       THREAD_YIELD,
-       THREAD_JOIN,
-       ATOMIC_READ,
-       ATOMIC_WRITE,
-       ATOMIC_RMW,
-       ATOMIC_INIT
+       THREAD_CREATE,        /**< A thread creation action */
+       THREAD_START,         /**< First action in each thread */
+       THREAD_YIELD,         /**< A thread yield action */
+       THREAD_JOIN,          /**< A thread join action */
+       ATOMIC_READ,          /**< An atomic read action */
+       ATOMIC_WRITE,         /**< An atomic write action */
+       ATOMIC_RMW,           /**< An atomic read-modify-write action */
+       ATOMIC_INIT           /**< Initialization of an atomic object (e.g.,
+                              *   atomic_init()) */
 } action_type_t;
 
 /* Forward declaration */
@@ -87,7 +91,7 @@ private:
 
        /** The thread id that performed this action. */
        thread_id_t tid;
-       
+
        /** The value read or written (if RMW, then the value written). This
         * should probably be something longer. */
        int value;
@@ -95,7 +99,7 @@ private:
        /** A back reference to a Node in NodeStack, if this ModelAction is
         * saved on the NodeStack. */
        Node *node;
-       
+
        modelclock_t seq_number;
 
        /** The clock vector stored with this action; only needed if this