model: add support for modification orders

[model-checker.git] / action.h

diff --git a/action.h b/action.h
index 0200111df387e586c4346c1858c0f139a6c6f4ce..36c72079b165a6a7462d5a32698e61dbdef12dbd 100644 (file)
--- a/action.h
+++ b/action.h
@@ -13,15 +13,23 @@
 #include "mymemory.h"
 #include "clockvector.h"
 
-#define VALUE_NONE -1
+/** Note that this value can be legitimately used by a program, and
+               hence by iteself does not indicate no value. */
 
+#define VALUE_NONE 1234567890
+
+/** @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
+       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 */
@@ -33,7 +41,7 @@ class ClockVector;
  */
 class ModelAction {
 public:
-       ModelAction(action_type_t type, memory_order order, void *loc, int value = VALUE_NONE);
+       ModelAction(action_type_t type, memory_order order, void *loc, uint64_t value = VALUE_NONE);
        ~ModelAction();
        void print(void) const;
 
@@ -42,15 +50,16 @@ public:
        memory_order get_mo() const { return order; }
        void * get_location() const { return location; }
        modelclock_t get_seq_number() const { return seq_number; }
-       int get_value() const { return value; }
+       uint64_t get_value() const { return value; }
+       const ModelAction * get_reads_from() const { return reads_from; }
 
        Node * get_node() const { return node; }
        void set_node(Node *n) { node = n; }
-       void set_value(int val) { value = val; }
 
        bool is_read() const;
        bool is_write() const;
        bool is_rmw() const;
+       bool is_initialization() const;
        bool is_acquire() const;
        bool is_release() const;
        bool is_seqcst() const;
@@ -58,11 +67,11 @@ public:
        bool same_thread(const ModelAction *act) const;
        bool is_synchronizing(const ModelAction *act) const;
 
-       void create_cv(ModelAction *parent = NULL);
+       void create_cv(const ModelAction *parent = NULL);
        ClockVector * get_cv() const { return cv; }
-       void read_from(ModelAction *act);
+       void read_from(const ModelAction *act);
 
-       bool happens_before(ModelAction *act);
+       bool happens_before(const ModelAction *act) const;
 
        inline bool operator <(const ModelAction& act) const {
                return get_seq_number() < act.get_seq_number();
@@ -85,15 +94,18 @@ 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;
+       uint64_t value;
+
+       /** The action that this action reads from. Only valid for reads */
+       const ModelAction *reads_from;
 
        /** 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
@@ -101,6 +113,6 @@ private:
        ClockVector *cv;
 };
 
-typedef std::list<class ModelAction *> action_list_t;
+typedef std::list<ModelAction *> action_list_t;
 
 #endif /* __ACTION_H__ */