trivial changes

[c11tester.git] / action.h

diff --git a/action.h b/action.h
index 9ba9c6320203c2b264a5ebf4fd13ed896e563582..4903f37b7720c4116943f5c542bcfa06ae92c8a8 100644 (file)
--- a/action.h
+++ b/action.h
@@ -1,10 +1,17 @@
+/** @file action.h
+ *  @brief Models actions taken by threads.
+ */
+
 #ifndef __ACTION_H__
 #define __ACTION_H__
 
 #include <list>
+#include <cstddef>
 
 #include "threads.h"
 #include "libatomic.h"
+#include "mymemory.h"
+#include "clockvector.h"
 
 #define VALUE_NONE -1
 
@@ -13,35 +20,49 @@ typedef enum action_type {
        THREAD_YIELD,
        THREAD_JOIN,
        ATOMIC_READ,
-       ATOMIC_WRITE
+       ATOMIC_WRITE,
+       ATOMIC_RMW
 } action_type_t;
 
 /* Forward declaration */
-class TreeNode;
 class Node;
+class ClockVector;
 
+/**
+ * The ModelAction class encapsulates an atomic action.
+ */
 class ModelAction {
 public:
-       ModelAction(action_type_t type, memory_order order, void *loc, int value);
-       void print(void);
+       ModelAction(action_type_t type, memory_order order, void *loc, int value = VALUE_NONE);
+       ~ModelAction();
+       void print(void) const;
 
-       thread_id_t get_tid() { return tid; }
-       action_type get_type() { return type; }
-       memory_order get_mo() { return order; }
-       void * get_location() { return location; }
-       int get_seq_number() const { return seq_number; }
+       thread_id_t get_tid() const { return tid; }
+       action_type get_type() const { return type; }
+       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; }
 
-       TreeNode * get_treenode() { return treenode; }
-       void set_node(TreeNode *n) { treenode = n; }
+       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_acquire() const;
+       bool is_release() const;
+       bool is_seqcst() const;
+       bool same_var(const ModelAction *act) const;
+       bool same_thread(const ModelAction *act) const;
+       bool is_synchronizing(const ModelAction *act) const;
+
+       void create_cv(const ModelAction *parent = NULL);
+       ClockVector * get_cv() const { return cv; }
+       void read_from(const ModelAction *act);
 
-       bool is_read();
-       bool is_write();
-       bool is_acquire();
-       bool is_release();
-       bool same_var(ModelAction *act);
-       bool same_thread(ModelAction *act);
-       bool is_dependent(ModelAction *act);
+       bool happens_before(const ModelAction *act) const;
 
        inline bool operator <(const ModelAction& act) const {
                return get_seq_number() < act.get_seq_number();
@@ -49,17 +70,37 @@ public:
        inline bool operator >(const ModelAction& act) const {
                return get_seq_number() > act.get_seq_number();
        }
+
+       MEMALLOC
 private:
+
+       /** Type of action (read, write, thread create, thread yield, thread join) */
        action_type type;
+
+       /** The memory order for this operation. */
        memory_order order;
+
+       /** A pointer to the memory location for this action. */
        void *location;
+
+       /** 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;
-       TreeNode *treenode;
+
+       /** A back reference to a Node in NodeStack, if this ModelAction is
+        * saved on the NodeStack. */
        Node *node;
-       int seq_number;
+       
+       modelclock_t seq_number;
+
+       /** The clock vector stored with this action; only needed if this
+        * action is a store release? */
+       ClockVector *cv;
 };
 
-typedef std::list<class ModelAction *> action_list_t;
+typedef std::list<ModelAction *> action_list_t;
 
 #endif /* __ACTION_H__ */