model: unify JOIN- and LOCK-related sleep/wake code

[model-checker.git] / action.h

diff --git a/action.h b/action.h
index f83aec9583e230fd9fddbf10676b7b73113faa8e..2bf01dce092b71d1a0fa37bc82a29802036e9d1c 100644 (file)
--- a/action.h
+++ b/action.h
@@ -24,7 +24,12 @@ using std::memory_order_seq_cst;
                hence by iteself does not indicate no value. */
 
 #define VALUE_NONE 1234567890
+
+/** A special value to represent a successful trylock */
+
 #define VALUE_TRYSUCCESS 1
+
+/** A special value to represent a failed trylock */
 #define VALUE_TRYFAILED 0
 
 /** @brief Represents an action type, identifying one of several types of
@@ -42,10 +47,10 @@ typedef enum action_type {
        ATOMIC_RMWC,          /**< Convert an atomic RMW action into a READ */
        ATOMIC_INIT,          /**< Initialization of an atomic object (e.g.,
                               *   atomic_init()) */
-       ATOMIC_FENCE,
-       ATOMIC_LOCK,
-       ATOMIC_TRYLOCK,
-       ATOMIC_UNLOCK
+       ATOMIC_FENCE,         /**< A fence action */
+       ATOMIC_LOCK,          /**< A lock action */
+       ATOMIC_TRYLOCK,       /**< A trylock action */
+       ATOMIC_UNLOCK         /**< An unlock action */
 } action_type_t;
 
 /* Forward declaration */
@@ -59,7 +64,7 @@ class ModelAction {
 public:
        ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE);
        ~ModelAction();
-       void print(void) const;
+       void print(bool print_cv = true) const;
 
        thread_id_t get_tid() const { return tid; }
        action_type get_type() const { return type; }
@@ -98,7 +103,7 @@ public:
        void create_cv(const ModelAction *parent = NULL);
        ClockVector * get_cv() const { return cv; }
        void read_from(const ModelAction *act);
-       void synchronize_with(const ModelAction *act);
+       bool synchronize_with(const ModelAction *act);
 
        bool has_synchronized_with(const ModelAction *act) const;
        bool happens_before(const ModelAction *act) const;